1 #LyX 2.2 created this file. For more info see http://www.lyx.org/
8 % DO NOT ALTER THIS PREAMBLE!!!
10 % This preamble is designed to ensure that the manual prints
11 % out as advertised. If you mess with this preamble,
12 % parts of the manual may not print out as expected. If you
13 % have problems LaTeXing this file, please contact
14 % the documentation team
15 % email: lyx-docs@lists.lyx.org
21 % set fonts for nicer pdf view
22 \IfFileExists{lmodern.sty}
23 {\usepackage{lmodern}}{}
25 \fi % end if pdflatex is used
27 % the pages of the TOC are numbered roman
28 % and a PDF-bookmark for the TOC is added
30 \let\myTOC\tableofcontents
31 \renewcommand{\tableofcontents}{%
32 \pdfbookmark[1]{\contentsname}{}
35 \pagenumbering{arabic}}
37 % extra space for tables
38 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
40 \options fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
41 \use_default_options false
49 \maintain_unincluded_children false
52 InsetLayout Flex:MenuItem
61 \newcommand*{\menuitem}[1]{{\sffamily #1}}
67 \language_package default
70 \font_roman "default" "default"
71 \font_sans "default" "default"
72 \font_typewriter "default" "default"
73 \font_math "auto" "auto"
74 \font_default_family default
75 \use_non_tex_fonts false
78 \font_sf_scale 100 100
79 \font_tt_scale 100 100
81 \default_output_format default
83 \bibtex_command default
84 \index_command default
88 \pdf_title "LyX's Additional Features manual"
89 \pdf_author "LyX Team"
90 \pdf_subject "LyX's additional features documentation"
91 \pdf_keywords "LyX, Documentation, Additional"
93 \pdf_bookmarksnumbered true
94 \pdf_bookmarksopen false
95 \pdf_bookmarksopenlevel 1
100 \pdf_pdfusetitle false
101 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
104 \use_package amsmath 1
105 \use_package amssymb 1
106 \use_package cancel 0
108 \use_package mathdots 1
109 \use_package mathtools 0
110 \use_package mhchem 1
111 \use_package stackrel 0
112 \use_package stmaryrd 0
113 \use_package undertilde 0
115 \cite_engine_type default
119 \paperorientation portrait
123 \notefontcolor #0000ff
130 \paragraph_separation indent
131 \paragraph_indentation default
132 \quotes_language english
135 \paperpagestyle headings
136 \tracking_changes false
137 \output_changes false
146 Additional \SpecialChar LyX
150 \begin_layout Subtitle
155 by the \SpecialChar LyX
160 \begin_layout Plain Layout
162 Principal maintainer of this file is
167 If you have comments or error corrections, please send them to the \SpecialChar LyX
170 \begin_inset Flex Code
173 \begin_layout Plain Layout
175 <lyx-docs@lists.lyx.org>
188 \begin_layout Standard
189 \begin_inset CommandInset toc
190 LatexCommand tableofcontents
197 \begin_layout Chapter
201 \begin_layout Standard
202 This manual is essentially Part II of the
204 User's Guide\SpecialChar endofsentence
207 The reason for separating the two documents is simple: the
211 is already quite lengthy, and it contains information on all of the basic
212 features one needs to know in order to prepare most documents.
213 However, the \SpecialChar LyX
214 Team has worked to make \SpecialChar LyX
215 extensible through various configuration
216 files and external packages.
217 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
219 create a layout file (or module) for it without having to alter \SpecialChar LyX
221 We've already had contributions of several new features this way, and some
222 of them are documented here.
223 There are also some more `advanced' features, such as how to control the
224 presentation of bibliographies and how to work with multi-part documents,
225 that are not covered in the
229 and are discussed here.
232 \begin_layout Standard
233 This manual also documents some special features, like fax support, version
234 control, and SGML support, which require additional software to work properly.
235 There is also a chapter on \SpecialChar LyX
237 And lastly, there's a chapter of \SpecialChar LaTeX
238 tools and tips, things you can use to
239 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
241 After all, \SpecialChar LyX
246 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
250 \begin_layout Standard
251 If you haven't read the
255 yet, you are definitely in the wrong manual.
260 is the first place to go, since it describes the notation and format of
262 You should also be thoroughly familiar with the
266 and all of the basic features of \SpecialChar LyX
267 before attempting to read this one.
270 \begin_layout Standard
271 Since many of the topics in this manual depend heavily on \SpecialChar LyX
273 with \SpecialChar LaTeX
274 , this first chapter covers the inner workings of \SpecialChar LyX
277 to generate exactly the \SpecialChar LaTeX
279 It is obviously for more seasoned \SpecialChar LyX
283 \begin_layout Chapter
285 and \SpecialChar LaTeX
289 \begin_layout Section
291 Uses \SpecialChar LaTeX
295 \begin_layout Standard
296 This chapter is for both \SpecialChar TeX
297 -nicians and the \SpecialChar LaTeX
299 In it, we'll explain how \SpecialChar LyX
300 and \SpecialChar LaTeX
301 work together to produce printable output.
302 This is the only place in any of the manuals where we assume you know something
303 about \SpecialChar LaTeX
307 \begin_layout Standard
308 At one time, \SpecialChar LyX
310 \begin_inset Quotes eld
313 WYSIWYM frontend to \SpecialChar LaTeX
315 \begin_inset Quotes erd
318 but that's no longer true.
319 There are frontends to \SpecialChar LaTeX
324 \begin_layout Plain Layout
325 Some familar ones are \SpecialChar TeX
326 maker and kile, on Linux, and \SpecialChar TeX
328 There are also the \SpecialChar LaTeX
329 modes for vi and emacs, of course.
334 These are basically text editors with the ability to run \SpecialChar LaTeX
336 errors in the file you're editing.
337 Although \SpecialChar LyX
346 run \SpecialChar LaTeX
347 , and it also indicates errors in the file, it also does much, much
349 For one thing, you don't need to know \SpecialChar LaTeX
350 to use \SpecialChar LyX
353 has added its own extensions to \SpecialChar LaTeX
355 Try the following sometime: select
356 \begin_inset Flex MenuItem
359 \begin_layout Plain Layout
360 Export\SpecialChar menuseparator
368 \begin_inset Flex MenuItem
371 \begin_layout Plain Layout
378 \begin_inset Flex MenuItem
381 \begin_layout Plain Layout
382 View\SpecialChar menuseparator
392 ), then look at the preamble of the resulting
393 \begin_inset Flex Code
396 \begin_layout Plain Layout
403 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
405 These macros are defined automatically, according to the features you use
409 \begin_layout Standard
410 There are several commands that automatically invoke \SpecialChar LaTeX
415 \begin_layout Itemize
416 \begin_inset Flex MenuItem
419 \begin_layout Plain Layout
420 Document\SpecialChar menuseparator
429 \begin_layout Itemize
430 \begin_inset Flex MenuItem
433 \begin_layout Plain Layout
434 Document\SpecialChar menuseparator
443 \begin_layout Itemize
444 \begin_inset Flex MenuItem
447 \begin_layout Plain Layout
448 File\SpecialChar menuseparator
457 \begin_layout Itemize
458 \begin_inset Flex MenuItem
461 \begin_layout Plain Layout
462 File\SpecialChar menuseparator
471 \begin_layout Standard
472 They will only invoke \SpecialChar LaTeX
473 if the file has changed since the last time \SpecialChar LaTeX
479 \begin_layout Standard
480 When \SpecialChar LyX
481 runs \SpecialChar LaTeX
482 on the file you're editing, it performs these steps:
485 \begin_layout Enumerate
486 Convert the document to \SpecialChar LaTeX
487 and save to a file with the extension
488 \begin_inset Flex Code
491 \begin_layout Plain Layout
498 \begin_inset Flex Code
501 \begin_layout Plain Layout
510 \begin_layout Enumerate
511 Run \SpecialChar LaTeX
513 \begin_inset Flex Code
516 \begin_layout Plain Layout
522 file (maybe several times), and run any other commands (such as
523 \begin_inset Flex Code
526 \begin_layout Plain Layout
533 \begin_inset Flex Code
536 \begin_layout Plain Layout
542 ) needed to compile the \SpecialChar LaTeX
546 \begin_layout Enumerate
547 If there are any errors, show the error log.
550 \begin_layout Standard
551 If you have run \SpecialChar LaTeX
553 \begin_inset Flex MenuItem
556 \begin_layout Plain Layout
559 \SpecialChar menuseparator
568 then runs a DVI viewer to display the DVI-file.
570 \begin_inset Flex MenuItem
573 \begin_layout Plain Layout
576 \SpecialChar menuseparator
585 performs further steps:
588 \begin_layout Itemize
590 \begin_inset Flex Code
593 \begin_layout Plain Layout
599 to convert the DVI file to PostScript.
602 \begin_layout Itemize
603 Run a PostScript viewer, such as
604 \begin_inset Flex Code
607 \begin_layout Plain Layout
613 , to display the PostScript file.
616 \begin_layout Standard
618 does similar things when viewing, or exporting, other formats.
621 \begin_layout Section
622 Translating \SpecialChar LaTeX
623 files into \SpecialChar LyX
627 \begin_layout Standard
628 You can import a \SpecialChar LaTeX
629 file into \SpecialChar LyX
631 \begin_inset Flex MenuItem
634 \begin_layout Plain Layout
635 File\SpecialChar menuseparator
636 Import\SpecialChar menuseparator
643 command in \SpecialChar LyX
645 This will call a program named
646 \begin_inset Flex Code
649 \begin_layout Plain Layout
655 which will create a file
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
666 \begin_inset Flex Code
669 \begin_layout Plain Layout
677 will then open that file.
681 \begin_layout Plain Layout
682 \begin_inset Flex Code
685 \begin_layout Plain Layout
691 can also be run from the command line, of course.
699 \begin_layout Standard
700 \begin_inset Flex Code
703 \begin_layout Plain Layout
709 will translate most legal \SpecialChar LaTeX
710 , but not everything.
711 It will put things it doesn't understand into \SpecialChar TeX
712 code, so after translating
714 \begin_inset Flex Code
717 \begin_layout Plain Layout
723 , you can look for \SpecialChar TeX
724 code and hand-edit it until it looks right.
727 \begin_layout Standard
728 If you don't know what \SpecialChar TeX
729 code is, read the next section.
732 \begin_layout Section
733 \begin_inset CommandInset label
735 name "sec:Inserting-TeX-Code"
739 Inserting \SpecialChar TeX
740 Code into \SpecialChar LyX
744 \begin_layout Standard
745 Anything you can do in \SpecialChar LaTeX
746 you can do in \SpecialChar LyX
747 , for a very simple reason: You can
748 always insert \SpecialChar TeX
749 code into any \SpecialChar LyX
752 cannot, and will never be able to, display every possible \SpecialChar LaTeX
754 If ever you need to insert \SpecialChar LaTeX
755 commands into your \SpecialChar LyX
756 document, you can use the
758 \begin_inset Flex Code
761 \begin_layout Plain Layout
768 box, which you can insert into your document with
769 \begin_inset Flex MenuItem
772 \begin_layout Plain Layout
773 Insert\SpecialChar menuseparator
783 or the keyboard shortcut
792 \begin_layout Standard
793 Here's an example of inserting \SpecialChar LaTeX
794 commands in a \SpecialChar LyX
796 The code looks like this:
799 \begin_layout LyX-Code
803 \begin_inset Newline newline
809 \begin_inset Newline newline
812 This is an example of a minipage environment.
814 \begin_inset Newline newline
817 can put nearly everything in it, even (non-floating)
818 \begin_inset Newline newline
823 \begin_inset Newline newline
829 \begin_inset Newline newline
833 \begin_inset Newline newline
839 \begin_inset Newline newline
845 \begin_inset Newline newline
851 \begin_inset Newline newline
856 \begin_inset Newline newline
862 \begin_inset Newline newline
868 \begin_inset Newline newline
874 \begin_inset Newline newline
882 \begin_layout LyX-Code
886 \begin_layout Standard
888 \begin_inset Flex Code
891 \begin_layout Plain Layout
898 box containing this text is directly after this paragraph.
899 Those of you reading the manual in \SpecialChar LyX
900 will only see the \SpecialChar TeX
902 Those reading a printed version of the manuals will see the actual results:
903 \begin_inset VSpace bigskip
909 \begin_layout Standard
913 \begin_layout Plain Layout
920 \begin_layout Plain Layout
927 \begin_layout Plain Layout
929 This is an example of a minipage environment.
930 You can put nearly everything in it, even (non-floating) figures and tables.
934 \begin_layout Plain Layout
941 \begin_layout Plain Layout
946 \begin_layout Plain Layout
953 \begin_layout Plain Layout
960 \begin_layout Plain Layout
967 \begin_layout Plain Layout
973 \begin_layout Plain Layout
980 \begin_layout Plain Layout
987 \begin_layout Plain Layout
994 \begin_layout Plain Layout
1004 \begin_inset VSpace bigskip
1010 \begin_layout Standard
1011 In addition to using \SpecialChar TeX
1012 code, you can also create a separate file containing
1013 some complex \SpecialChar LaTeX
1014 structure and then use
1015 \begin_inset Flex MenuItem
1018 \begin_layout Plain Layout
1019 Insert\SpecialChar menuseparator
1021 \begin_inset space ~
1029 to include your file (you should select the type
1030 \begin_inset Flex Code
1033 \begin_layout Plain Layout
1040 We recommend that you only do this if you have a
1041 \begin_inset Flex Code
1044 \begin_layout Plain Layout
1055 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1059 \begin_layout Standard
1060 There are a few last points to emphasize:
1063 \begin_layout Itemize
1069 check if your \SpecialChar LaTeX
1073 \begin_layout Itemize
1074 Beware of reinventing the wheel.
1077 \begin_layout Standard
1078 On that last point, \SpecialChar LyX
1079 does have quite a few features tucked into it, and
1081 Be sure to check the manuals to make sure that \SpecialChar LyX
1082 doesn't have such-and-such
1083 feature before you decide you have to do it by hand.
1084 Moreover, there are numerous \SpecialChar LaTeX
1085 packages out there to do all sorts of things,
1086 from labels to envelopes to fancy multipage tables.
1088 \begin_inset CommandInset href
1091 target "http://www.ctan.org/"
1098 \begin_layout Standard
1099 If you do need to do some wild and fancy things within your document, be
1100 sure to check out a good \SpecialChar LaTeX
1101 book for assistance.
1102 There are a number of them listed in the bibliography of the
1109 \begin_layout Section
1111 and the \SpecialChar LaTeX
1115 \begin_layout Subsection
1116 About the \SpecialChar LaTeX
1120 \begin_layout Standard
1121 If you already know \SpecialChar LaTeX
1122 , there is no need to explain here what the preamble
1124 If you don't, the following will give you some ideas—we recommend again
1125 that you consult a \SpecialChar LaTeX
1126 book for further information.
1127 In any case, you should read the points below, because they explain what
1128 you can do and what you don't need to do in the \SpecialChar LaTeX
1129 preamble of a \SpecialChar LyX
1133 \begin_layout Standard
1134 The \SpecialChar LaTeX
1135 preamble comes at the very beginning of a document,
1143 \begin_layout Itemize
1144 Declare the document class.
1146 \begin_inset Newline newline
1150 already does this for you.
1151 If you're a seasoned \SpecialChar LaTeX
1152 -nician, and you have a custom document class you
1153 want to use, check out the
1155 Customization Manual
1157 for information on how to make \SpecialChar LyX
1161 \begin_layout Itemize
1162 Declare the usage of packages.
1164 \begin_inset Newline newline
1168 packages provide special commands, which are only available within a document
1169 when the package has been declared in the preamble.
1170 In addition to providing special commands, the inclusion of a package can
1171 change the document.
1172 For example, the package
1173 \begin_inset Flex Code
1176 \begin_layout Plain Layout
1182 forces all paragraphs to be indented.
1183 There are other packages for labels, envelopes, margins, etc.
1187 \begin_layout Itemize
1188 Set counters, variables, lengths and widths.
1190 \begin_inset Newline newline
1193 There are several \SpecialChar LaTeX
1194 counters and variables that
1198 be set globally from within the preamble in order to have the desired effect.
1199 (There are variables that you can set and reset inside the document, too.)
1200 Margins are a good example of something that must be set in the preamble.
1201 Another example is the label format for lists.
1202 You can actually set these just about anywhere, but it's best to do it
1203 just once, inside the preamble.
1206 \begin_layout Itemize
1207 Declare user defined commands (with
1208 \begin_inset Flex Code
1211 \begin_layout Plain Layout
1220 \begin_inset Flex Code
1223 \begin_layout Plain Layout
1232 \begin_inset Newline newline
1235 These are abbreviations for \SpecialChar LaTeX
1236 commands which appear very often inside a document.
1237 Although the preamble is a good place to declare such commands, they
1241 be declared anywhere (before they are used for the first time, of course).
1242 This can be useful if there is a lot of raw \SpecialChar LaTeX
1243 code in your document, which
1244 normally should not be the case.
1247 \begin_layout Standard
1249 adds its own set of definitions to the preamble of the
1250 \begin_inset Flex Code
1253 \begin_layout Plain Layout
1260 This makes \SpecialChar LaTeX
1261 files generated by \SpecialChar LyX
1265 \begin_layout Subsection
1266 Changing the Preamble
1269 \begin_layout Standard
1270 The commands which \SpecialChar LyX
1271 adds to the preamble of a \SpecialChar LaTeX
1272 file are fixed; you can't
1273 change them without patching \SpecialChar LyX
1275 You can, however, add your own stuff to the preamble by selecting
1276 \begin_inset Flex MenuItem
1279 \begin_layout Plain Layout
1282 \begin_inset space ~
1291 \begin_inset Flex MenuItem
1294 \begin_layout Plain Layout
1295 Document\SpecialChar menuseparator
1303 adds anything in the
1304 \begin_inset Flex MenuItem
1307 \begin_layout Plain Layout
1313 dialog to its own built-in preamble.
1314 Before adding your own declarations in the preamble, you should make sure
1315 that \SpecialChar LyX
1316 doesn't already support what you want to do.
1317 (Remember what we said about reinventing the wheel?) Also,
1319 make sure your preamble code is correct
1323 doesn't check it for you.
1324 If there is an error, you're likely to get an error like
1325 \begin_inset Quotes eld
1329 \begin_inset Flex Code
1332 \begin_layout Plain Layout
1341 \begin_inset Quotes erd
1345 If you see this error, check your preamble.
1348 \begin_layout Subsection
1352 \begin_layout Standard
1353 Here are some examples of what you can add to a preamble, and what they
1357 \begin_layout Subsubsection
1361 \begin_layout Standard
1362 There are two variables under \SpecialChar LaTeX
1363 that control page position:
1364 \begin_inset Flex Code
1367 \begin_layout Plain Layout
1376 \begin_inset Flex Code
1379 \begin_layout Plain Layout
1388 Their names should be self-explanatory.
1389 These variables are useful if you think for a moment about computer labels.
1390 Sometimes, the size of a print medium and the area of the medium that you
1391 can actually print on aren't the same.
1393 \begin_inset Flex Code
1396 \begin_layout Plain Layout
1405 \begin_inset Flex Code
1408 \begin_layout Plain Layout
1419 \begin_layout Standard
1420 The default values for
1421 \begin_inset Flex Code
1424 \begin_layout Plain Layout
1433 \begin_inset Flex Code
1436 \begin_layout Plain Layout
1445 \begin_inset space \thinspace{}
1449 \begin_inset space \thinspace{}
1453 \begin_inset space \space{}
1456 the page isn't shifted.
1457 Unfortunately, some DVI drivers always seem to shift the page.
1458 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1459 If you're using \SpecialChar LyX
1460 on a system that you don't personally maintain, and your
1461 sysadmin is a doofus,
1462 \begin_inset Flex Code
1465 \begin_layout Plain Layout
1474 \begin_inset Flex Code
1477 \begin_layout Plain Layout
1486 Suppose your left and top margins are always 0.5
1487 \begin_inset space \thinspace{}
1491 You can add this to the preamble:
1494 \begin_layout LyX-Code
1502 \begin_layout LyX-Code
1510 \begin_layout Standard
1511 and your margins should now be correct.
1514 \begin_layout Subsubsection
1518 \begin_layout Standard
1519 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1520 There's a rather nice package, available at your nearest CTAN archive,
1521 for printing sheets of labels:
1522 \begin_inset Flex Code
1525 \begin_layout Plain Layout
1532 Now, your system may not have this package installed by default.
1533 We leave that up to you to check.
1534 You'll also want to read the documentation for it; we're not going to do
1536 Since this is an example, however, we'll give you an example of how you
1540 \begin_layout Standard
1541 First, make sure you're using the
1542 \begin_inset Flex Code
1545 \begin_layout Plain Layout
1552 Next, you need to put the following in your preamble:
1555 \begin_layout LyX-Code
1561 \begin_layout LyX-Code
1567 \begin_layout LyX-Code
1573 \begin_layout LyX-Code
1579 \begin_layout LyX-Code
1585 \begin_layout LyX-Code
1591 \begin_layout LyX-Code
1597 \begin_layout Standard
1598 This sets things up for Avery label sheets, stock #5360.
1599 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1602 \begin_inset Flex Code
1605 \begin_layout Plain Layout
1614 \begin_inset Flex Code
1617 \begin_layout Plain Layout
1625 around each label text.
1626 This and other special features of
1627 \begin_inset Flex Code
1630 \begin_layout Plain Layout
1636 are explained in its documentation.
1639 \begin_layout Standard
1640 Someday, someone may write a \SpecialChar LyX
1641 layout file to support this package directly.
1642 Maybe that someone is you.
1645 \begin_layout Subsubsection
1646 Example #3: Paragraph Indentation
1649 \begin_layout Standard
1650 Americans are trained to indent the first line of
1655 As with all of their other weird quirks, most Americans will whine and
1656 moan until they can have their way and indent the first line of all paragraphs.
1665 \begin_layout Standard
1666 Of course, this behavior isn't standard typography.
1667 In books, you typically only indent the first line of a paragraph
1671 it follows another one.
1672 The idea behind indenting the first line of a paragraph is to distinguish
1673 neighboring paragraphs from one another.
1674 If there is no previous paragraph—for example, if it follows a figure or
1675 is the first paragraph in a section—then there is no need for indentation.
1679 \begin_layout Standard
1680 If you're a typical American (we're still joking!), though, you don't care
1681 about such esoteric things; you want your indentation! Add this to the
1685 \begin_layout LyX-Code
1688 usepackage{indentfirst}
1691 \begin_layout Standard
1692 If your \SpecialChar TeX
1693 distribution isn't braindead, you'll have this package, and all
1694 of your paragraphs will get the indentation the Founding Fathers intended
1698 \begin_layout Subsubsection
1699 Example #4: This Document
1702 \begin_layout Standard
1703 You can also check out the preamble of this document to get an idea of some
1704 of the advanced things you can do.
1707 \begin_layout Section
1709 and \SpecialChar LaTeX
1713 \begin_layout Standard
1714 When \SpecialChar LyX
1715 calls \SpecialChar LaTeX
1716 , it tells \SpecialChar LaTeX
1717 to blithely ignore any errors and keep going.
1718 It then uses the logfile from the \SpecialChar LaTeX
1719 run to do a post-mortem.
1720 After analyzing the logfile, \SpecialChar LyX
1721 displays a dialog listing the errors.
1722 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1724 where the error occurred.
1728 \begin_layout Plain Layout
1730 Analyzing the logfile is a tough job, and \SpecialChar LyX
1731 doesn't always go to the right
1733 There are also cases where \SpecialChar LaTeX
1734 reports the error on one line, but the actual
1736 This is not unlike forgetting a closing brace in a program: You'll get
1737 an error, but only later.
1745 \begin_layout Standard
1746 Some folks also like to look at the log file directly: It is available from
1748 \begin_inset Flex MenuItem
1751 \begin_layout Plain Layout
1754 \SpecialChar menuseparator
1758 \begin_inset space ~
1767 There are some fairly common error messages and warnings.
1768 We'll cover those here.
1769 You should look at a good \SpecialChar LaTeX
1770 book for a complete listing.
1773 \begin_layout Itemize
1774 \begin_inset Flex Code
1777 \begin_layout Plain Layout
1785 \begin_inset Newline newline
1788 Anything beginning with these words is a warning message for the purpose
1790 \begin_inset Quotes eld
1794 \begin_inset Quotes erd
1797 the \SpecialChar LaTeX
1799 You'll get messages like this if you added or changed cross-references
1800 or bibliography entries, in which case, \SpecialChar LaTeX
1801 is trying to tell you that you
1802 need to make another run.
1803 You can by-and-large ignore these.
1806 \begin_layout Itemize
1807 \begin_inset Flex Code
1810 \begin_layout Plain Layout
1818 \begin_inset Newline newline
1821 Another warning message, this time about fonts which \SpecialChar LaTeX
1823 The rest of the message will often say something about a replacement font
1824 that \SpecialChar LaTeX
1826 You can safely ignore these, too.
1829 \begin_layout Itemize
1830 \begin_inset Flex Code
1833 \begin_layout Plain Layout
1842 \begin_inset Newline newline
1851 They are warnings about lines that were too long and run past the right
1853 Almost always, this is unnoticeable in the final output.
1854 (It can be just a point or two.) Or, only one or two characters extend past
1857 seems to generate at least one of these messages for just about any document
1859 \begin_inset Newline newline
1862 You can ignore these messages.
1863 Your eyes will tell you if there's a problem with something that's too
1864 wide; just look at the output.
1868 \begin_layout Plain Layout
1869 You can also enable the `draft' option in
1870 \begin_inset Flex MenuItem
1873 \begin_layout Plain Layout
1876 \SpecialChar menuseparator
1884 , and then \SpecialChar LaTeX
1885 will draw a black box in the margin of lines that are overfull.
1893 \begin_layout Itemize
1894 \begin_inset Flex Code
1897 \begin_layout Plain Layout
1906 \begin_inset Newline newline
1909 Not quite as common as its cousin.
1911 seems to like to print lines that are a bit too wide as opposed to ones
1912 that are a bit too narrow.
1913 We have no idea why.
1916 \begin_layout Itemize
1917 \begin_inset Flex Code
1920 \begin_layout Plain Layout
1929 \begin_inset Flex Code
1932 \begin_layout Plain Layout
1941 \begin_inset Newline newline
1944 Warnings about troubles breaking the page.
1945 Once again, just look at the output.
1946 Your eyes will tell you where something has gone wrong.
1949 \begin_layout Itemize
1950 \begin_inset Flex Code
1953 \begin_layout Plain Layout
1956 \begin_inset Quotes els
1960 \begin_inset Quotes ers
1969 \begin_inset Newline newline
1973 \begin_inset Quotes eld
1977 \begin_inset Quotes erd
1980 isn't installed on this system.
1981 This usually appears because some package your document needs isn't installed.
1982 If you didn't touch the preamble or didn't use the
1983 \begin_inset Flex Code
1986 \begin_layout Plain Layout
1994 command, then one of the packages \SpecialChar LyX
1995 tried to load is missing.
1997 \begin_inset Flex MenuItem
2000 \begin_layout Plain Layout
2001 Help\SpecialChar menuseparator
2008 to get a list of packages that \SpecialChar LyX
2010 This file is updated whenever you reconfigure \SpecialChar LyX
2012 \begin_inset Flex MenuItem
2015 \begin_layout Plain Layout
2016 Tools\SpecialChar menuseparator
2022 ) and tells you which packages have been detected and what they do.
2023 \begin_inset Newline newline
2027 \begin_inset Flex Code
2030 \begin_layout Plain Layout
2038 command and the package in question isn't installed, then you'll need to
2039 install it yourself.
2042 \begin_layout Itemize
2043 \begin_inset Flex Code
2046 \begin_layout Plain Layout
2048 Error: Unknown option
2054 \begin_inset Newline newline
2057 Error messages beginning with this are trying to tell you that you specified
2058 a bad or undefined option to a package.
2059 Check the package's documentation.
2062 \begin_layout Itemize
2063 \begin_inset Flex Code
2066 \begin_layout Plain Layout
2067 Undefined control sequence
2073 \begin_inset Newline newline
2076 If you've inserted \SpecialChar LaTeX
2077 code into your document, but made a typo, you'll get
2079 You may have forgotten to load a package.
2080 In any case, this error message usually means that you used an undefined
2085 \begin_layout Standard
2086 There are other error and warning messages.
2087 Some are self-explanatory.
2088 These are usually \SpecialChar LaTeX
2090 Others are downright cryptic.
2091 These are usually \SpecialChar TeX
2092 error messages, and we really have
2096 what they mean or how to decipher them.
2100 \begin_layout Standard
2101 There's a general sequence you should follow if you get error messages:
2104 \begin_layout Enumerate
2105 Look at the \SpecialChar LaTeX
2106 code you inserted for typos.
2109 \begin_layout Enumerate
2110 If there are no typos, check that you used the command(s) correctly.
2113 \begin_layout Enumerate
2114 If you get a bunch of error boxes piled up at the very top of the document—and
2115 especially if you see a
2116 \begin_inset Quotes eld
2120 \begin_inset Flex Code
2123 \begin_layout Plain Layout
2132 \begin_inset Quotes erd
2135 error—it means that there are errors in the preamble.
2136 Start debugging your preamble.
2139 \begin_layout Enumerate
2140 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2142 document, the first suspect is your \SpecialChar LaTeX
2143 distribution itself.
2144 Check for missing packages and install them.
2147 \begin_layout Enumerate
2148 Okay, so there are no missing packages.
2149 Did you use any of the fine-tuning options in \SpecialChar LyX
2150 ? Specifically, did you
2154 any of them, like trying to manually insert lots of
2155 \begin_inset Flex Code
2158 \begin_layout Plain Layout
2160 \begin_inset space ~
2169 \begin_inset Flex Code
2172 \begin_layout Plain Layout
2179 \begin_inset Flex Code
2182 \begin_layout Plain Layout
2188 ? Did you try to kludge something together with these instead of using the
2189 appropriate paragraph environment?
2192 \begin_layout Enumerate
2193 All right, you didn't use any of the fine-tuning options, you played by
2195 Did you try to pull a fancy maneuver? Did you do something funky inside
2196 a table or an equation, like inserting a graphic into a table cell?
2199 \begin_layout Enumerate
2200 Do you have long sections of text where \SpecialChar LaTeX
2201 cannot find a place to break a
2202 line? By default, \SpecialChar LaTeX
2203 is rather strict about how much extra inter-word spacing
2204 it will add in order to break a line.
2205 Preferably, you should rework the paragraph to avoid the problem.
2208 \begin_layout Enumerate
2209 Did you go overboard with the nesting? \SpecialChar LyX
2210 (currently) doesn't check to make
2211 sure you're in the limits for nesting environments.
2212 If you nested a bunch of environments to the
2213 \begin_inset Formula $17^{\mathrm{th}}$
2216 level, that's the problem.
2217 (The limit in \SpecialChar LaTeX
2221 \begin_layout Enumerate
2222 Okay, you didn't get any error messages, but your output looks awful.
2223 If you have a table or figure that's too wide or long for the page, you
2225 \begin_inset Separator parbreak
2232 \begin_layout Enumerate
2233 rescale the figure so it fits.
2236 \begin_layout Enumerate
2237 trim down the table so it fits.
2241 \begin_layout Enumerate
2242 If something else is wrong with the output, and you didn't try to pull anything
2243 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2246 \begin_layout Standard
2247 If all this doesn't help—well, then
2251 you might have found a bug in \SpecialChar LyX
2256 \begin_layout Chapter
2260 \begin_layout Section
2261 Customizing Bibliographies with Bib\SpecialChar TeX
2265 \begin_layout Standard
2266 The most basic information about how to use Bib\SpecialChar TeX
2267 with \SpecialChar LyX
2271 Bibliography databases (Bib\SpecialChar TeX
2279 The following subsections explain special bibliography features supported
2284 \begin_layout Subsection
2285 Alternative Citation Styles
2288 \begin_layout Standard
2289 Standard Bib\SpecialChar TeX
2291 \begin_inset space \thinspace{}
2295 \begin_inset space \space{}
2299 \begin_inset Quotes eld
2303 \begin_inset Quotes erd
2306 ) to refer to a cited work.
2307 However, in many scientific disciplines, other citation styles are in use.
2308 The most common one is the author-year style (e.
2309 \begin_inset space \thinspace{}
2313 \begin_inset space \space{}
2317 \begin_inset Quotes eld
2321 \begin_inset Quotes erd
2326 supports two packages that provide this style,
2327 \begin_inset Flex Code
2330 \begin_layout Plain Layout
2337 \begin_inset Flex Code
2340 \begin_layout Plain Layout
2347 Both packages have their pros and cons, which cannot be listed in detail.
2348 If you only want to have simple author-year (or author-numerical) style,
2349 or if you want to use one of the countless style files for
2350 \begin_inset Flex Code
2353 \begin_layout Plain Layout
2359 , then the established
2360 \begin_inset Flex Code
2363 \begin_layout Plain Layout
2369 package is probably your choice.
2370 If you need special features like short title references, ibidem etc., you
2372 \begin_inset Flex Code
2375 \begin_layout Plain Layout
2384 \begin_layout Standard
2385 The handling of both packages in \SpecialChar LyX
2386 is basically the same.
2388 \begin_inset Flex MenuItem
2391 \begin_layout Plain Layout
2392 Document\SpecialChar menuseparator
2399 \begin_inset Flex MenuItem
2402 \begin_layout Plain Layout
2409 \begin_inset Flex MenuItem
2412 \begin_layout Plain Layout
2419 \begin_inset Flex MenuItem
2422 \begin_layout Plain Layout
2429 With both packages, you will get some extra features in the citation dialog
2430 and you can select the style of the reference (
2431 \begin_inset Quotes eld
2435 \begin_inset Quotes erd
2439 \begin_inset Quotes eld
2443 \begin_inset Quotes erd
2447 \begin_inset Quotes eld
2451 \begin_inset Quotes erd
2455 \begin_inset Quotes eld
2459 \begin_inset Quotes erd
2463 Note that both packages need specifically designed style files.
2464 They both ship their own, but there are lots of additional style files,
2465 and there is even an interactive style file builder
2469 \begin_layout Plain Layout
2471 \begin_inset Flex URL
2474 \begin_layout Plain Layout
2476 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2487 \begin_inset Flex Code
2490 \begin_layout Plain Layout
2499 \begin_layout Subsection
2500 Sectioned Bibliographies
2503 \begin_layout Standard
2504 Sometimes you might need to divide your bibliography into several sections.
2505 If you are for instance a historian, the possibility to separate sources
2506 and scientific works is most likely a
2507 \begin_inset Quotes eld
2511 \begin_inset Quotes erd
2515 Unfortunately, Bib\SpecialChar TeX
2516 itself does not allow you to do this.
2517 But with the help of some \SpecialChar LaTeX
2518 packages, Bib\SpecialChar TeX
2519 can be extended to fit your needs.
2522 \begin_layout Standard
2524 provides native support for one of these packages,
2532 \begin_layout Plain Layout
2534 \begin_inset Flex URL
2537 \begin_layout Plain Layout
2539 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2549 The advantage of this package (compared to other packages like
2553 ) is that you don't need to define new citation commands.
2554 Instead, you need to prepare different bibliographic databases which include
2555 the entries for the different sections of the bibliography.
2556 For example: If you want to divide your bibliography into the sections
2558 \begin_inset Quotes eld
2562 \begin_inset Quotes erd
2566 \begin_inset Quotes eld
2570 \begin_inset Quotes erd
2573 , you first need to create two bibliographic databases, e.
2574 \begin_inset space \thinspace{}
2578 \begin_inset space \space{}
2582 \begin_inset Flex Code
2585 \begin_layout Plain Layout
2592 \begin_inset Flex Code
2595 \begin_layout Plain Layout
2605 \begin_layout Standard
2607 \begin_inset Flex MenuItem
2610 \begin_layout Plain Layout
2611 Document\SpecialChar menuseparator
2618 \begin_inset Flex MenuItem
2621 \begin_layout Plain Layout
2628 \begin_inset Flex MenuItem
2631 \begin_layout Plain Layout
2632 Sectioned bibliography
2638 Now you can insert multiple Bib\SpecialChar TeX
2639 bibliographies, one for each section of
2641 Returning to our example: Insert the Bib\SpecialChar TeX
2643 \begin_inset Flex Code
2646 \begin_layout Plain Layout
2652 and a second one for the database
2653 \begin_inset Flex Code
2656 \begin_layout Plain Layout
2663 You are free to use the same or different styles for each section.
2664 Additionally, you can choose if the bibliography section should contain
2666 \begin_inset Quotes eld
2669 all cited references
2670 \begin_inset Quotes erd
2673 of the specified database(s) (which is the default),
2674 \begin_inset Quotes eld
2677 all uncited references
2678 \begin_inset Quotes erd
2682 \begin_inset Quotes eld
2686 \begin_inset Quotes erd
2690 This might be useful if you would like to separate your bibliography into
2692 \begin_inset Quotes eld
2696 \begin_inset Quotes erd
2700 \begin_inset Quotes eld
2704 \begin_inset Quotes erd
2708 \begin_inset Quotes eld
2712 \begin_inset Quotes erd
2716 The titles for the sections can be added as ordinary sections or subsections.
2718 \begin_inset Flex Code
2721 \begin_layout Plain Layout
2727 removes the bibliography title, you have to manually re-add that, too (as
2728 a chapter* or section*, for instance).
2731 \begin_layout Subsection
2732 Multiple Bibliographies
2735 \begin_layout Standard
2736 Multiple bibliographies, e.
2737 \begin_inset space \thinspace{}
2741 \begin_inset space \space{}
2744 a bibliography for each section or chapter of the document, are not supported
2745 by Bib\SpecialChar TeX
2748 \begin_inset Flex Code
2751 \begin_layout Plain Layout
2757 package, which is used for the creation of sectioned bibliographies in
2759 (see the previous section), provides an easy way to solve this task, if
2760 you are willing to use some
2761 \begin_inset Flex MenuItem
2764 \begin_layout Plain Layout
2772 \begin_inset space ~
2776 \begin_inset CommandInset ref
2778 reference "sec:Inserting-TeX-Code"
2786 \begin_layout Plain Layout
2787 An alternative approach is to use the
2788 \begin_inset Flex Code
2791 \begin_layout Plain Layout
2798 \begin_inset Flex Code
2801 \begin_layout Plain Layout
2807 package, respectively.
2815 \begin_layout Standard
2817 \begin_inset Flex MenuItem
2820 \begin_layout Plain Layout
2821 Document\SpecialChar menuseparator
2828 \begin_inset Flex MenuItem
2831 \begin_layout Plain Layout
2838 \begin_inset Flex MenuItem
2841 \begin_layout Plain Layout
2842 Sectioned bibliography
2848 In the document, you have to enclose the sections, which shall contain
2849 their own bibliography (including the Bib\SpecialChar TeX
2850 bibliography itself), between
2852 \begin_inset Flex Code
2855 \begin_layout Plain Layout
2864 \begin_inset Flex Code
2867 \begin_layout Plain Layout
2875 (those commands have to be inserted as \SpecialChar TeX
2877 The bibliography will contain all references that have been cited in the
2879 \begin_inset Flex Code
2882 \begin_layout Plain Layout
2893 If you are using this approach, then every citation reference has to be
2895 \begin_inset Flex Code
2898 \begin_layout Plain Layout
2906 \begin_inset Flex Code
2909 \begin_layout Plain Layout
2918 \begin_layout Section
2922 \begin_layout Subsection
2926 \begin_layout Standard
2927 When you are working on a large file with many sections, it is often convenient
2928 to break up the document into several files, or perhaps you have something
2929 where a table may change from time to time, but the preceding text does
2931 In these cases, you should seriously consider using multipart documents.
2932 For example, scientific papers often have five major sections: the introduction
2933 , observations, results, discussion, and conclusion.
2934 Each of these could be its own separate \SpecialChar LyX
2936 \begin_inset Quotes eld
2940 \begin_inset Quotes erd
2943 file which contains the title, authors, abstract, references, etc., plus
2944 the five included files.
2945 It is important to note that each of these files is a full \SpecialChar LyX
2947 can be formatted and printed on its own, as well as included in a master
2949 Each of these files must have the same document class, however—don't attempt
2950 to mix book classes with article classes.
2951 You may also include \SpecialChar LaTeX
2952 files; however, these files must not have their own
2954 \begin_inset space \thinspace{}
2958 \begin_inset space \space{}
2961 everything up to and including the
2962 \begin_inset Flex Code
2965 \begin_layout Plain Layout
2974 \begin_inset Flex Code
2977 \begin_layout Plain Layout
2985 line must be deleted) or else errors will be generated when you try to
2989 \begin_layout Standard
2991 allows you to include files quite easily with
2992 \begin_inset Flex MenuItem
2995 \begin_layout Plain Layout
2996 Insert\SpecialChar menuseparator
2998 \begin_inset space ~
3007 When you click on this selection a small box is inserted into the file
3008 at the current cursor location.
3009 Clicking on the box raises a dialog which allows you to select the file
3010 to be included, and the method of its inclusion.
3014 \begin_layout Standard
3015 The file selection box should by now be obvious.
3016 The three inclusion methods are
3017 \begin_inset Quotes eld
3021 \begin_inset Quotes erd
3025 \begin_inset Quotes eld
3029 \begin_inset Quotes erd
3033 \begin_inset Quotes eld
3037 \begin_inset Quotes erd
3041 The difference between
3042 \begin_inset Quotes eld
3046 \begin_inset Quotes erd
3050 \begin_inset Quotes eld
3054 \begin_inset Quotes erd
3057 is really only meaningful to \SpecialChar LaTeX
3058 perts, but the practical difference is that
3060 \begin_inset Quotes eld
3064 \begin_inset Quotes erd
3067 are typeset beginning on a new page, while files that are
3068 \begin_inset Quotes eld
3072 \begin_inset Quotes erd
3075 are typeset starting on the current page.
3078 \begin_layout Standard
3079 Generally, the master file is converted into a full \SpecialChar LaTeX
3080 file before typesetting,
3081 while the included files are converted to \SpecialChar LaTeX
3082 files that do not have all the
3083 preamble information.
3086 \begin_layout Standard
3088 \begin_inset Quotes eld
3092 \begin_inset Quotes erd
3095 included file allows you to include a file typeset exactly as it appears
3097 \begin_inset space \thinspace{}
3101 \begin_inset space \space{}
3105 \begin_inset Flex Code
3108 \begin_layout Plain Layout
3114 mode, with the characters set in a fixed-width typewriter font.
3115 Normally, spaces in this file are invisible, though two consecutive spaces
3116 are conserved, unlike \SpecialChar LyX
3117 's normal treatment of spaces.
3118 However, setting the
3119 \begin_inset Flex MenuItem
3122 \begin_layout Plain Layout
3124 \begin_inset space ~
3128 \begin_inset space ~
3132 \begin_inset space ~
3140 checkbox typesets a mark to unambiguously define the presence of a space.
3144 \begin_layout Subsection
3145 Cross-References Between Files
3148 \begin_layout Standard
3149 \begin_inset Box Shadowbox
3159 height_special "totalheight"
3164 backgroundcolor "none"
3167 \begin_layout Plain Layout
3168 This section is somewhat out of date.
3169 Need to describe default master documents and how children are opened when
3179 \begin_layout Standard
3180 It is possible to set up cross-references between the different files.
3181 First, open all the files in question: let's call them A and B in a two
3182 file example, where B is included in A.
3183 Let's say you insert a label in A, then want to reference it in B.
3184 Open the cross-reference dialog whilst in document B, and you can select
3186 \begin_inset Quotes eld
3190 \begin_inset Quotes erd
3196 \begin_layout Subsection
3197 Bibliography Lists in all Subdocuments
3200 \begin_layout Standard
3201 \begin_inset Box Frameless
3211 height_special "totalheight"
3216 backgroundcolor "none"
3219 \begin_layout Plain Layout
3220 This section also needs updating.
3221 There is now material about this on the wiki, and it could be copied here.
3229 \begin_layout Standard
3230 Copy the bibliography list with all entries to all subdocuments and transform
3232 This way \SpecialChar LyX
3234 \begin_inset Flex Code
3237 \begin_layout Plain Layout
3243 -files and you can easily insert references without making the bibliography
3247 \begin_layout Standard
3248 As the bibliography list is in a comment, \SpecialChar LaTeX
3249 won't use it and the references
3250 will look like this: [?], instead of like this: [1].
3251 One solution is to use the \SpecialChar LaTeX
3253 \begin_inset Flex Code
3256 \begin_layout Plain Layout
3262 that will only include comments by processing the files separately.
3263 To do this, add in the \SpecialChar LaTeX
3264 preamble of every subdocument the following:
3267 \begin_layout LyX-Code
3273 \begin_layout LyX-Code
3276 includecomment{comment}
3279 \begin_layout Standard
3281 \begin_inset Flex URL
3284 \begin_layout Plain Layout
3286 http://wiki.lyx.org/FAQ/Unsorted#toc31
3294 \begin_layout Section
3299 \begin_layout Standard
3300 Users sometimes need to be able to
3301 \begin_inset Quotes eld
3305 \begin_inset Quotes erd
3309 file together with all the images (and other files) on which it depends,
3310 either for sending to a publisher or for sharing with a co-author.
3312 2.0 includes a Python script (
3313 \begin_inset Flex Code
3316 \begin_layout Plain Layout
3322 ) that automates this process.
3323 To use it, you must have either the
3324 \begin_inset Flex Code
3327 \begin_layout Plain Layout
3334 \begin_inset Flex Code
3337 \begin_layout Plain Layout
3343 python modules installed on your system.
3344 By default, the script prefers the
3345 \begin_inset Flex Code
3348 \begin_layout Plain Layout
3355 \begin_inset Flex Code
3358 \begin_layout Plain Layout
3364 format on Unix-like systems and the
3365 \begin_inset Flex Code
3368 \begin_layout Plain Layout
3377 \begin_layout Standard
3379 's configuration process will set the script up to export a `\SpecialChar LyX
3381 and this format will then be available under
3382 \begin_inset Flex Code
3385 \begin_layout Plain Layout
3386 File\SpecialChar menuseparator
3395 \begin_layout Standard
3396 Independently of the platform, the generation of a particular archive format
3397 can be forced by adding either the
3398 \begin_inset Flex Code
3401 \begin_layout Plain Layout
3408 \begin_inset Flex Code
3411 \begin_layout Plain Layout
3418 \begin_inset Flex Code
3421 \begin_layout Plain Layout
3428 \begin_inset Flex Code
3431 \begin_layout Plain Layout
3437 format) switch to the
3438 \begin_inset Flex Code
3441 \begin_layout Plain Layout
3443 \SpecialChar menuseparator
3451 \begin_inset Flex Code
3454 \begin_layout Plain Layout
3455 Tools\SpecialChar menuseparator
3456 Preferences\SpecialChar menuseparator
3457 File Handling\SpecialChar menuseparator
3464 (Make sure you add the switch after the script name, not before it.)
3467 \begin_layout Section
3468 Fancy Headers and Footers
3471 \begin_layout Standard
3472 The default page layout is rather plain; for an
3473 \begin_inset Flex Code
3476 \begin_layout Plain Layout
3482 document class, all you get is a centered page number at the bottom of
3484 This document uses KOMA-script's book class, so it appears to be a bit
3486 But to really put on a show, you need to set the document page style to
3488 \begin_inset Quotes eld
3492 \begin_inset Quotes erd
3495 , as mentioned in the
3500 This section describes the \SpecialChar LaTeX
3501 code you need to insert in your \SpecialChar LaTeX
3503 order to get the desired effects.
3506 \begin_layout Standard
3507 For more information on fancy headers, see the
3508 \begin_inset Flex Code
3511 \begin_layout Plain Layout
3517 package documentation.
3519 \begin_inset Flex URL
3522 \begin_layout Plain Layout
3524 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
3532 \begin_layout Standard
3533 The page header is divided into three fields, not surprisingly labeled
3534 \begin_inset Quotes eld
3538 \begin_inset Quotes erd
3542 \begin_inset Quotes eld
3546 \begin_inset Quotes erd
3550 \begin_inset Quotes eld
3554 \begin_inset Quotes erd
3558 The footer is also divided into these three fields.
3559 The \SpecialChar LaTeX
3560 commands to set these fields in the simplest manner are
3561 \begin_inset Flex Code
3564 \begin_layout Plain Layout
3573 \begin_inset Flex Code
3576 \begin_layout Plain Layout
3585 \begin_inset Flex Code
3588 \begin_layout Plain Layout
3597 \begin_inset Flex Code
3600 \begin_layout Plain Layout
3609 Suppose you wish to put your name in the upper left hand corner of each
3611 Simply insert the following command in the preamble:
3614 \begin_layout Standard
3623 \begin_layout Standard
3624 You will now see your name in the upper left.
3625 If a field has a default entry that you would like to get rid of (often
3626 the page number appears in the central footer) simply include a command
3627 with a blank argument, e.
3628 \begin_inset space \thinspace{}
3634 \begin_layout Standard
3642 \begin_layout Standard
3643 Let's get really fancy: lets put the section number with the word
3644 \begin_inset Quotes eld
3648 \begin_inset Quotes erd
3652 \begin_inset space \thinspace{}
3656 \begin_inset space \space{}
3659 Section 3) in the upper left, the page number (e.
3660 \begin_inset space \thinspace{}
3664 \begin_inset space \space{}
3667 Page 4) in the upper right, your name in the lower left, and the date in
3669 The following commands should now appear in the preamble:
3672 \begin_layout Standard
3682 \begin_layout Standard
3690 \begin_layout Standard
3700 \begin_layout Standard
3709 \begin_layout Standard
3717 \begin_layout Standard
3727 \begin_layout Standard
3729 \begin_inset Flex Code
3732 \begin_layout Plain Layout
3741 \begin_inset Flex Code
3744 \begin_layout Plain Layout
3752 access \SpecialChar LaTeX
3753 's section and page counters, and so print out the current section
3756 \begin_inset Flex Code
3759 \begin_layout Plain Layout
3767 simply prints out today's date.
3770 \begin_layout Standard
3771 The thicknesses of the horizontal rules drawn beneath the header and above
3772 the footer can also be modified.
3773 If you don't want one of the rules, set its thickness to 0.
3774 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
3780 \begin_inset Flex Code
3783 \begin_layout Plain Layout
3788 headrulewidth}{0.4pt}
3794 \begin_inset Flex Code
3797 \begin_layout Plain Layout
3802 footrulewidth}{0.4pt}
3807 to set the thicknesses.
3810 \begin_layout Standard
3811 You can switch the header/footer settings on and off for individual pages
3813 \begin_inset Flex Code
3816 \begin_layout Plain Layout
3819 thispagestyle{empty}
3825 \begin_inset Flex Code
3828 \begin_layout Plain Layout
3831 thispagestyle{plain}
3837 \begin_inset Flex Code
3840 \begin_layout Plain Layout
3843 thispagestyle{fancy}
3849 Simply insert them in the text on the page you want changed and mark them
3852 In fact, title pages are marked as plain by default, while following pages
3853 are marked fancy when using the global fancy setting.
3856 \begin_layout Standard
3857 As a final example, it is possible to include an image in the header or
3859 Suppose you want to put a company logo in the upper lefthand corner.
3860 You might try something like
3863 \begin_layout Standard
3872 includegraphics{logo.eps}}}
3875 \begin_layout Standard
3877 (you may need to preface this with
3878 \begin_inset Flex Code
3881 \begin_layout Plain Layout
3885 usepackage{graphics}
3890 if you don't include graphics elsewhere in your document).
3893 \begin_layout Section
3894 Itemize Bullet Selection
3895 \begin_inset CommandInset label
3904 \begin_layout Standard
3910 \begin_layout Subsection
3914 \begin_layout Standard
3916 provides 216 bullet shapes that can be accessed from a simple dialog.
3917 Using this dialog you can easily specify what bullet shape to use at each
3918 level of an itemized list.
3919 These settings are document-wide so you won't be able to specify different
3920 sets of bullets for different paragraphs.
3924 \begin_layout Plain Layout
3925 Well, actually you can but you'll have to do it by hand.
3933 \begin_layout Subsection
3937 \begin_layout Standard
3938 Open the dialog by selecting the
3939 \begin_inset Flex MenuItem
3942 \begin_layout Plain Layout
3943 Document\SpecialChar menuseparator
3949 menu item and then select the
3950 \begin_inset Flex MenuItem
3953 \begin_layout Plain Layout
3962 \begin_layout Standard
3963 The dialog provides you with a table of bullet shapes.
3964 A column of buttons on the left of the table provides access to the six
3965 different panels of bullet shapes.
3966 The row of buttons across the top is used to select which bullet depth
3968 A text entry under the table shows the currently selected bullet shape's
3970 equivalent and this can be edited if desired.
3971 If you do modify the text you will also need to specify any needed packages
3972 in the \SpecialChar LaTeX
3976 \begin_layout Standard
3977 The six panels are divided up by the packages they require.
3978 The following table shows the mappings from button name to \SpecialChar LaTeX
3980 \begin_inset Separator parbreak
3986 \begin_layout Standard
3988 \begin_inset Tabular
3989 <lyxtabular version="3" rows="7" columns="2">
3990 <features tabularvalignment="middle">
3991 <column alignment="center" valignment="top" width="0pt">
3992 <column alignment="center" valignment="top" width="0pt">
3994 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
3997 \begin_layout Plain Layout
4012 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4015 \begin_layout Plain Layout
4032 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4035 \begin_layout Plain Layout
4050 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4053 \begin_layout Plain Layout
4062 base \SpecialChar LaTeX
4070 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4073 \begin_layout Plain Layout
4088 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4091 \begin_layout Plain Layout
4108 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4111 \begin_layout Plain Layout
4126 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4129 \begin_layout Plain Layout
4146 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4149 \begin_layout Plain Layout
4164 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4167 \begin_layout Plain Layout
4184 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4187 \begin_layout Plain Layout
4202 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4205 \begin_layout Plain Layout
4222 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4225 \begin_layout Plain Layout
4240 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4243 \begin_layout Plain Layout
4266 \begin_layout Standard
4268 doesn't stop you using bullets from packages you don't have.
4269 If you get errors from \SpecialChar LaTeX
4270 when you try to view or print the file, then it
4271 is likely you are missing a package.
4275 \begin_layout Plain Layout
4277 doesn't restrict your use since you may be editing locally and exporting
4286 \begin_layout Subsection
4290 \begin_layout Standard
4291 Select which bullet depth you want to change then select the bullet shape
4293 Any changes will not be visible in \SpecialChar LyX
4294 , but are visible when viewing the document.
4297 \begin_layout Standard
4298 You can reset a bullet shape to the default simply by clicking your right
4299 mouse button on the appropriate bullet depth button.
4303 \begin_layout Plain Layout
4308 want to have multiple sets of paragraphs with different sets of bullets
4309 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4311 The bullet selection dialog can help though because it provides you with
4312 the \SpecialChar LaTeX
4313 code for a wide range of bullet shapes.
4314 To make your own custom paragraphs you have the following options:
4317 \begin_layout Plain Layout
4321 \begin_layout Plain Layout
4337 \begin_layout Plain Layout
4341 \begin_layout Plain Layout
4363 \begin_layout Itemize
4364 Use the \SpecialChar LaTeX
4366 \begin_inset Flex Code
4369 \begin_layout Plain Layout
4377 to specify a new bullet shape for a given depth.
4378 You'll also need to save the current bullet shape so you can restore it
4380 In this itemized list the following \SpecialChar LaTeX
4381 code was used to change the bullet
4382 used for the first depth.
4383 \begin_inset Separator parbreak
4390 \begin_layout LyX-Code
4400 \begin_layout LyX-Code
4417 \begin_layout Itemize
4418 Note that the itemize depth is specified in Roman numerals as part of the
4428 \begin_layout Itemize
4432 \begin_layout Plain Layout
4445 Specify each individual entry by starting each item with the bullet shape
4446 enclosed in square brackets and set as
4447 \begin_inset Flex MenuItem
4450 \begin_layout Plain Layout
4458 For example, this item was started with
4459 \begin_inset Flex Code
4462 \begin_layout Plain Layout
4477 \begin_layout Plain Layout
4481 \begin_layout Plain Layout
4497 \begin_layout Plain Layout
4498 You'll also need to revert the labelitem back to its previous setting for
4499 the global bullet shape settings to remain in effect.
4500 The way used here was:
4503 \begin_layout LyX-Code
4518 \begin_layout Chapter
4520 and the World Wide Web
4523 \begin_layout Standard
4525 has long supported the export of documents to various web-friendly formats,
4527 Before verson 2.0, however, HTML export was always accomplished by the use
4528 of external converters.
4532 \begin_layout Plain Layout
4533 For details on the use of external converters with \SpecialChar LyX
4538 section of the Customization manual.
4543 These fall into two large groups: there are converters that use \SpecialChar LaTeX
4545 intermediate format, such as
4546 \begin_inset Flex Code
4549 \begin_layout Plain Layout
4556 \begin_inset Flex Code
4559 \begin_layout Plain Layout
4566 \begin_inset Flex Code
4569 \begin_layout Plain Layout
4575 , relying upon \SpecialChar LyX
4576 to produce the \SpecialChar LaTeX
4577 ; and there is a converter that works directly
4580 \begin_inset Flex Code
4583 \begin_layout Plain Layout
4591 All of these have different advantages and disadvantages.
4595 \begin_layout Standard
4596 The \SpecialChar LaTeX
4597 -based converters have the advantage that, in principle, they know everythin
4598 g about the exported document that \SpecialChar LaTeX
4600 Such converters do not care, for example, if a certain block of code was
4601 produced by \SpecialChar LyX
4602 or was Evil Red Text.
4603 These converters know about
4604 \begin_inset Flex Code
4607 \begin_layout Plain Layout
4613 files, counters, and references, and can often make use of the
4614 \begin_inset Flex Code
4617 \begin_layout Plain Layout
4623 files generated by Bib\SpecialChar TeX
4625 On the other hand, \SpecialChar LaTeX
4626 is a very hard language to parse—it is sometimes said
4627 that only \SpecialChar TeX
4628 itself understands \SpecialChar TeX
4629 —and \SpecialChar LaTeX
4630 -based converters will often choke on
4631 what seem to be quite simple constructs; complex ones can throw them completely
4632 , and as of this writing, for example, the
4636 manual will not export with
4637 \begin_inset Flex Code
4640 \begin_layout Plain Layout
4646 , though the others will.
4647 The other issue concerns how math is handled.
4648 These converters typically convert the formulae into little pictures that
4649 are then linked from the HTML document.
4650 Since these are actually generated by \SpecialChar LaTeX
4651 , they are accurate.
4652 But they do not scale well, and just getting them to look as if they are
4653 actually meant to be in your document—so that the font sizes seem to be
4654 roughly the same—can be a challenge.
4657 \begin_layout Standard
4659 \begin_inset Flex Code
4662 \begin_layout Plain Layout
4670 \begin_inset CommandInset href
4672 name "http://elyxer.nongnu.org/"
4673 target "http://elyxer.nongnu.org/"
4677 ) solves some of these problems.
4678 In particular, the formulae it produces scale perfectly, since it renders
4679 math using a combination of HTML and CSS rather than converting the formulae
4681 But even moderately complex formula are rendered less well than with
4682 \begin_inset Flex Code
4685 \begin_layout Plain Layout
4691 ; this reflects the limitations of HTML.
4695 \begin_layout Plain Layout
4697 \begin_inset Flex Code
4700 \begin_layout Plain Layout
4707 can also use jsMath and MathJax for equations, but this setting is only
4708 available globally and requires one to have access to a server that runs
4714 More importantly (as of version 1.1.1, at least),
4715 \begin_inset Flex Code
4718 \begin_layout Plain Layout
4725 has limited support for math macros and no support for user-defined paragraph
4726 or character styles.
4727 These limitations make
4728 \begin_inset Flex Code
4731 \begin_layout Plain Layout
4738 unsuitable for many of the documents \SpecialChar LyX
4740 In principle, of course, these problems could be solved, but the \SpecialChar LyX
4742 have decided to follow a different path and have made \SpecialChar LyX
4744 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
4745 , DocBook, and plaintext.
4748 \begin_layout Standard
4749 As of this writing, XHTML output remains under development and should probably
4751 \begin_inset Quotes eld
4755 \begin_inset Quotes erd
4762 \begin_layout Plain Layout
4764 \begin_inset Flex Code
4767 \begin_layout Plain Layout
4768 development/HTML.notes
4773 , which can be found in the \SpecialChar LyX
4775 \begin_inset CommandInset href
4777 name "accessed online"
4778 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
4782 , usually contains up-to-date information about the state of XHTML output.
4783 See also the list of XHTML bugs on
4784 \begin_inset CommandInset href
4786 name "the bug tracker"
4787 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"
4796 Still, the developers have chosen this approach because it has several
4797 potential advantages over the other two.
4800 \begin_layout Standard
4801 These advantages are primarily due to the fact that the XHTML output routines,
4802 since they are part of \SpecialChar LyX
4803 , know everything \SpecialChar LyX
4804 knows about the document being
4809 \begin_layout Plain Layout
4810 Another advantage is that, since these routines are internal to \SpecialChar LyX
4812 immune to changes in \SpecialChar LyX
4813 's file format, or to changes in the semantics of
4819 So they know about the table of contents (as displayed in the outline),
4820 about the counters associated with different paragraph styles, and about
4821 user-defined styles.
4822 The XHTML output routines know what \SpecialChar LyX
4823 knows about internationalization,
4824 too, so they will output
4825 \begin_inset Quotes eld
4829 \begin_inset Quotes erd
4833 \begin_inset Quotes eld
4841 \begin_inset Quotes erd
4844 , depending upon the language in effect at the time.
4848 \begin_layout Standard
4849 Quite generally, the output routines know what \SpecialChar LyX
4850 knows about document layout,
4851 that is, about how the document is to be rendered on screen.
4852 We use this information when we output the document as XHTML.
4853 In particular, \SpecialChar LyX
4858 generates CSS style information corresponding to the layout information
4859 it uses to render the document on screen: if section headings are supposed
4860 to be sans-serif and bold as seen in \SpecialChar LyX
4861 , then (by default) they will be sans-seri
4862 f and bold when viewed in a web browser, too.
4863 And this is true not just for pre-defined styles, like Section, but for
4864 any style, including user-defined styles.
4865 Indeed, the XHTML output routines make no distinction between user-defined
4866 paragraph and character styles and \SpecialChar LyX
4867 's own pre-defined styles: in each case,
4868 everything \SpecialChar LyX
4869 knows about the styles is contained in the layout files.
4870 And much the same is true as regards pre-defined textual insets, such as
4871 footnotes, and various custom insets.
4875 \begin_layout Standard
4876 The result is that XHTML output can be customized and extended in exactly
4877 the same way \SpecialChar LaTeX
4878 output can be customized and extended: through layout files
4880 See chapter five of the
4884 manual for the details.
4887 \begin_layout Standard
4888 The remainder of this chapter contains more detailed information on XHTML
4889 output, its limitations, and ways to work around those limitations.
4892 \begin_layout Section
4893 Math Output in XHTML
4896 \begin_layout Standard
4898 offers four choices for how math is rendered.
4899 These have various advantages and disadvantages:
4902 \begin_layout Itemize
4904 \begin_inset Newline newline
4907 MathML is a dialect of XML designed specifically for mathematics on the
4908 web, and it typically renders very well in browsers that support it.
4909 The disadvantage is that not all browsers support MathML, and support is
4910 not complete even in the Gecko-based browsers, such as Firefox.
4911 \begin_inset Newline newline
4915 is unable to render a formula as MathML—for example, if the formula
4917 \begin_inset Flex Code
4920 \begin_layout Plain Layout
4926 package or ERT—then it will instead output the formula as an image.
4930 \begin_layout Itemize
4932 \begin_inset Newline newline
4936 \begin_inset Flex Code
4939 \begin_layout Plain Layout
4945 outputs math as HTML, styled by CSS.
4949 \begin_layout Plain Layout
4951 has borrowed some of the CSS for its HTML output from
4952 \begin_inset Flex Code
4955 \begin_layout Plain Layout
4966 For simple formulae, this can work quite well, though with more complicated
4967 formulae it tends to break down.
4968 Still, this method has the advantage that it is very widely supported and
4969 so it may be appropriate for documents that contain only a little, fairly
4971 \begin_inset Newline newline
4974 If Lyx is unable to render a formula as HTML—for example, if the formula
4976 \begin_inset Flex Code
4979 \begin_layout Plain Layout
4985 package or ERT—then it will instead output the formula as an image.
4989 \begin_layout Itemize
4991 \begin_inset Newline newline
4995 \begin_inset Flex Code
4998 \begin_layout Plain Layout
5005 will output formulae as images, the very same images, in fact, that are
5006 used for instant preview.
5010 \begin_layout Plain Layout
5011 Instant preview does
5015 have to be on for images to be output, however.
5020 The advantage to this method is that the images are simply generated by
5022 , so they are very accurate.
5023 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5024 so they do not scale terribly well, and one cannot copy them, etc.
5025 (As of this writing, there are also problems about equation numbering.
5027 \begin_inset CommandInset href
5030 target "http://www.lyx.org/trac/ticket/6894"
5035 \begin_inset Newline newline
5038 The size of the images can be controlled by setting the
5039 \begin_inset Quotes eld
5043 \begin_inset Quotes erd
5047 \begin_inset Flex MenuItem
5050 \begin_layout Plain Layout
5051 Document\SpecialChar menuseparator
5052 Settings\SpecialChar menuseparator
5062 \begin_layout Plain Layout
5063 For those who want to know, this controls the resolution of the image in
5064 dots per inch and is based upon a default of 75 dpi.
5070 \begin_inset Newline newline
5074 for some reason fails to create an image for a formula (e.g., if a required
5076 package is not installed), then it will fall back to outputing the raw
5081 \begin_layout Itemize
5084 \begin_inset Newline newline
5087 Finally, \SpecialChar LyX
5088 will happily output math as \SpecialChar LaTeX
5090 As well as being the output of last resort, this method can be used with
5092 \begin_inset CommandInset href
5095 target "http://www.math.union.edu/~dpvc/jsMath/"
5099 , which uses JavaScript to render \SpecialChar LaTeX
5100 embedded in HTML documents.
5102 wraps the \SpecialChar LaTeX
5104 \begin_inset Flex Code
5107 \begin_layout Plain Layout
5113 (for inline formulas) or
5114 \begin_inset Flex Code
5117 \begin_layout Plain Layout
5123 (for displayed formulas) with
5124 \begin_inset Flex Code
5127 \begin_layout Plain Layout
5133 , as is required for jsMath.
5136 \begin_layout Standard
5137 One of these output methods must be selected under
5138 \begin_inset Flex MenuItem
5141 \begin_layout Plain Layout
5142 Document\SpecialChar menuseparator
5143 Settings\SpecialChar menuseparator
5150 By default, \SpecialChar LyX
5152 This is a document-wide setting, therefore.
5155 \begin_layout Standard
5156 Eventually, \SpecialChar LyX
5157 will offer the user the option to select an alternate output
5158 method for a particular inset, say, one that isn't being rendered very
5163 \begin_layout Plain Layout
5164 That said, since \SpecialChar LyX
5165 falls back to images if the inset contains ERT, then one
5166 can force output as an image by putting some harmless ERT into the math,
5168 \begin_inset Formula $a=b\relax$
5179 \begin_layout Section
5180 Bibliography and Citations
5183 \begin_layout Standard
5184 XHTML output fully supports bibliographies and citations.
5188 \begin_layout Standard
5189 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5191 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5194 If you are using numerical citations, then \SpecialChar LyX
5195 will output numerical labels,
5196 such as [1] or [17], rather than simply showing the citation key in square
5197 brackets, as it does on-screen.
5198 If you are using author-year citations, then \SpecialChar LyX
5199 will add lowercase letters
5200 to the years, just as Bib\SpecialChar TeX
5201 does, if it finds more than one citation for
5202 a given author-year combination.
5203 The labels will be printed with the bibliography entries.
5204 Note that there is, at present, no way to customize the appearance of the
5205 labels, for example, to choose between square brackets and parentheses.
5208 \begin_layout Standard
5209 Bibliography output is handled by the same machinery that handles the presentati
5210 on of reference information in the citation dialog, so you will see in the
5211 XHTML output pretty much what you would see if you were to look at a given
5212 entry in the citation dialog.
5213 The formatting can be customized in your layout file or, preferably, in
5219 manual for the details.
5222 \begin_layout Standard
5223 The main defect at present is that cross-referenced information is printed
5224 with every entry with which it is associated.
5225 So you can see things like this:
5230 \begin_inset Quotes eld
5233 Context and Logical Form
5234 \begin_inset Quotes erd
5239 Language in Context: Selected Essays
5241 (Oxford: Oxford University Press, 2007), pp.
5247 \begin_inset Quotes eld
5250 Semantics in Context
5251 \begin_inset Quotes erd
5256 Language in Context: Selected Essays
5258 (Oxford: Oxford University Press, 2007), pp.
5262 \begin_layout Standard
5263 This should be fixed before long.
5266 \begin_layout Standard
5267 There is no support at present for sectioned bibliographies.
5268 If you have multiple bibliographies, then \SpecialChar LyX
5269 will print the same bibliography
5273 \begin_layout Section
5277 \begin_layout Standard
5279 will happily export indexes as XHTML, but with certain limitations at the
5283 \begin_layout Standard
5284 Index export will be most reliable when you do not attempt to use the fancy
5285 constructs that are described in the section on indexes in the
5293 \begin_layout Plain Layout
5294 The main issue here is that \SpecialChar LyX
5295 itself does not really handle these.
5296 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5302 We'll describe how they are handled using the subsection headings from
5306 \begin_layout Itemize
5307 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5308 makes an effort to support these,
5309 but the entries must be separated by
5310 \begin_inset Quotes eld
5314 \begin_inset Quotes erd
5317 , that is, there must be spaces around the exclamation point.
5318 This is because it is otherwise too difficult to check for escaped exclamation
5319 points, ones in math, and so forth.
5322 \begin_layout Itemize
5323 Page Ranges: There is no support at all for page ranges, since these make
5324 no sense with XHMTL.
5325 Instead, you will just get two index entries, one at either end.
5328 \begin_layout Itemize
5329 Cross-referencing: There is no support for cross-referencing.
5331 finds an entry containing the
5332 \begin_inset Quotes eld
5335 |see\SpecialChar ldots
5337 \begin_inset Quotes erd
5340 construct, it is just dropped, and the rest is treated as an ordinary index
5344 \begin_layout Itemize
5345 Index Entry Order: \SpecialChar LyX
5346 does support attempts to fix the sorting order.
5347 It will take what is before the first `@' it finds and use that for sorting,
5348 taking what follows the first `@' to be the actual entry.
5349 At present, \SpecialChar LyX
5350 does not check for escaped `@', so do not try to index email
5354 \begin_layout Itemize
5355 Index Entry Layout: You can format entries by using the text style dialog,
5356 or by using any other method available within \SpecialChar LyX
5358 There is no support for constructs like:
5359 \begin_inset Quotes eld
5363 \begin_inset Quotes erd
5367 Indeed, if \SpecialChar LyX
5368 finds a pipe symbol, `|', in an entry, it will delete it and
5369 everything that follows it.
5372 \begin_layout Itemize
5373 Multiple Indexes: There is no support for multiple indexes.
5374 Rather, all index entries will be printed as one large index.
5375 To avoid our printing several versions of the index, we print only the
5376 main index, so make sure you have one.
5379 \begin_layout Section
5380 Nomenclature and Glossary
5383 \begin_layout Standard
5384 There is at present no support for glossaries.
5385 Adding it would be fairly trivial, and welcome.
5388 \begin_layout Chapter
5389 The \SpecialChar LyX
5393 \begin_layout Section
5397 \begin_layout Standard
5398 The `\SpecialChar LyX
5399 server' allows other programs to talk to \SpecialChar LyX
5400 , invoke \SpecialChar LyX
5401 commands, and retrieve
5402 information about the \SpecialChar LyX
5404 This is only intended for advanced users, but they should find it useful.
5405 It is by writing to the \SpecialChar LyX
5406 server, for example, that bibliography managers,
5407 such as JabRef, are able to
5408 \begin_inset Quotes eld
5412 \begin_inset Quotes erd
5415 citations to \SpecialChar LyX
5419 \begin_layout Section
5420 Starting the \SpecialChar LyX
5424 \begin_layout Standard
5425 The \SpecialChar LyX
5426 server works through the use of a pair of named pipes.
5427 These are usually located in
5428 \begin_inset Flex Code
5431 \begin_layout Plain Layout
5437 , (except on Windows, where
5441 named pipes are special objects located in
5442 \begin_inset Flex Code
5445 \begin_layout Plain Layout
5457 ) and have the names
5458 \begin_inset Quotes eld
5462 \begin_inset Flex Code
5465 \begin_layout Plain Layout
5472 \begin_inset Quotes erd
5476 \begin_inset Quotes eld
5480 \begin_inset Flex Code
5483 \begin_layout Plain Layout
5490 \begin_inset Quotes erd
5494 External programs write into
5495 \begin_inset Flex Code
5498 \begin_layout Plain Layout
5504 and read back data from
5505 \begin_inset Flex Code
5508 \begin_layout Plain Layout
5515 The stem of the pipe names can be defined in the
5516 \begin_inset Flex MenuItem
5519 \begin_layout Plain Layout
5520 Tools\SpecialChar menuseparator
5527 \begin_inset Flex Code
5530 \begin_layout Plain Layout
5531 "/home/myhome/lyxpipe"
5537 \begin_inset Flex Code
5540 \begin_layout Plain Layout
5554 on Windows (where any working path instead of lyxpipe can be used, for
5556 \begin_inset Flex Code
5559 \begin_layout Plain Layout
5582 configure this manually in order for the server to start.
5585 \begin_layout Standard
5588 \begin_inset Flex Code
5591 \begin_layout Plain Layout
5598 \begin_inset Flex Code
5601 \begin_layout Plain Layout
5607 ' to create the pipes.
5608 If one of the pipes already exists, \SpecialChar LyX
5609 will assume that another \SpecialChar LyX
5611 is already running and will not start the server.
5612 On POSIX (Unix like) systems, if for some other reason, an unused
5613 \begin_inset Quotes eld
5617 \begin_inset Quotes erd
5620 pipe is left in existence when \SpecialChar LyX
5621 closes, then \SpecialChar LyX
5622 will try to delete it.
5623 If this fails for some reason, you will need to delete the pipes manually
5624 and then restart \SpecialChar LyX
5626 On Windows, pipes are deleted by the OS on program termination or crash,
5628 \begin_inset Quotes eld
5632 \begin_inset Quotes erd
5635 pipes should not be possible.
5638 \begin_layout Standard
5639 To have several \SpecialChar LyX
5640 processes with servers at the same time, you have to use
5641 different configurations, perhaps by using separate user directories, each
5643 \begin_inset Flex Code
5646 \begin_layout Plain Layout
5652 file, for each process.
5655 \begin_layout Standard
5656 If you are developing a client program, you might find it useful to enable
5657 debugging information from the \SpecialChar LyX
5659 Do this by starting \SpecialChar LyX
5661 \begin_inset Flex Code
5664 \begin_layout Plain Layout
5673 \begin_layout Standard
5674 You can find a complete example client written in C++ in the source distribution
5676 \begin_inset Flex Code
5679 \begin_layout Plain Layout
5680 development/lyxserver/server_monitor.cpp
5688 \begin_layout Standard
5689 Another useful tool is the command-line based client found in
5690 \begin_inset Flex Code
5693 \begin_layout Plain Layout
5694 src/client/lyxclient
5702 \begin_layout Section
5703 Normal communication
5706 \begin_layout Standard
5707 To issue a \SpecialChar LyX
5708 call, the client writes a line of ASCII text into the input
5710 This line has the following format:
5727 \begin_layout Description
5728 clientname is a name that the client can choose arbitrarily.
5729 Its only use is that \SpecialChar LyX
5730 will echo it if it sends an answer—so a client can
5731 dispatch results from different requesters.
5734 \begin_layout Description
5735 function is the function you want \SpecialChar LyX
5737 It is the same as the commands you'd use in the minibuffer.
5740 \begin_layout Description
5741 argument is an optional argument which is meaningful only to some functions
5743 \begin_inset Quotes eld
5747 \begin_inset Quotes erd
5750 LFUN will insert the argument as text at the cursor position).
5753 \begin_layout Standard
5754 The answer from \SpecialChar LyX
5755 will arrive in the output pipe and be of the form
5772 \begin_layout Standard
5781 are just echoed from the command request, while
5785 is more or less useful information filled according to how the command
5786 execution worked out.
5787 Some commands, such as
5788 \begin_inset Quotes eld
5792 \begin_inset Quotes erd
5795 , will return information about the internal state of \SpecialChar LyX
5797 return an empty data-response.
5798 This means that the command execution went fine.
5801 \begin_layout Standard
5802 In case of errors, the response from \SpecialChar LyX
5820 \begin_layout Standard
5825 should contain an explanation of why the command failed.
5828 \begin_layout Standard
5832 \begin_layout LyX-Code
5833 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
5834 \begin_inset Newline newline
5837 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
5838 \begin_inset Newline newline
5841 read a <~/.lyxpipe.out
5842 \begin_inset Newline newline
5848 \begin_layout Subsection
5849 AppleScript (Mac OS X)
5852 \begin_layout Standard
5853 Since \SpecialChar LyX
5854 2.1, \SpecialChar LyX
5855 supports basic interactions with AppleScript for normal communicatio
5856 n through the command run.
5857 This command takes a direct argument (the
5861 to perform) and an optional argument.
5862 It either returns the output of the function or triggers an error with
5863 the error message and code.
5866 \begin_layout Standard
5870 \begin_layout LyX-Code
5871 tell application "\SpecialChar LyX
5875 \begin_layout LyX-Code
5879 \begin_layout LyX-Code
5880 -- Stores the current file name into f
5883 \begin_layout LyX-Code
5884 set f to (run "server-get-filename" with argument "")
5887 \begin_layout LyX-Code
5888 on error the error_message number the error_number
5891 \begin_layout LyX-Code
5892 display dialog "Error: " & the error_number & ".
5896 \begin_layout LyX-Code
5897 & the error_message buttons {"OK"} default button 1
5900 \begin_layout LyX-Code
5904 \begin_layout LyX-Code
5908 \begin_layout Section
5912 \begin_layout Standard
5914 can notify clients of events going on asynchronously.
5915 Currently it will only do this if the user binds a key sequence with the
5917 \begin_inset Quotes eld
5921 \begin_inset Quotes erd
5925 The format of the string \SpecialChar LyX
5926 sends is as follows:
5930 \begin_inset Flex Code
5933 \begin_layout Plain Layout
5944 \begin_layout Standard
5949 is the printed representation of the key sequence that was actually typed
5953 \begin_layout Standard
5954 This mechanism can be used to extend \SpecialChar LyX
5955 's command set and implement macros.
5956 Bind some key sequence to
5957 \begin_inset Quotes eld
5961 \begin_inset Quotes erd
5965 Then start a client that listens on the output pipe, dispatches the command
5966 according to the sequence, and starts a function that may use \SpecialChar LyX
5969 requests to issue a command or a series of commands to \SpecialChar LyX
5973 \begin_layout Section
5974 The simple \SpecialChar LyX
5978 \begin_layout Standard
5980 implements a simple protocol that can be used for session management.
5981 All messages are of the form
5994 \begin_layout Standard
6000 \begin_inset Quotes eld
6004 \begin_inset Quotes erd
6008 \begin_inset Quotes eld
6012 \begin_inset Quotes erd
6017 \begin_inset Quotes eld
6021 \begin_inset Quotes erd
6024 is received from a client, \SpecialChar LyX
6025 will report back to inform the client that
6026 it's listening to it's messages, while
6027 \begin_inset Quotes eld
6031 \begin_inset Quotes erd
6034 sent from \SpecialChar LyX
6035 will inform clients that \SpecialChar LyX
6039 \begin_layout Section
6040 Reverse DVI/PDF search
6043 \begin_layout Standard
6044 Some DVI/PDF viewers
6048 \begin_layout Plain Layout
6049 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6050 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6059 facility (also called
6064 This means that you can tell \SpecialChar LyX
6065 to put the cursor to a specific line in the
6066 document by clicking at the respective position in the DVI/PDF output.
6067 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6069 This is done via the \SpecialChar LyX
6070 server either by using the named pipe (
6074 ), or the UNIX domain socket (
6078 ) that \SpecialChar LyX
6079 creates in its temporary directory (this is the way the
6080 \begin_inset Flex Code
6083 \begin_layout Plain Layout
6089 program communicates with \SpecialChar LyX
6091 In some cases, you need a helper script that mediates between the viewer
6092 and \SpecialChar LyX
6093 , in others, the viewer can communicate with \SpecialChar LyX
6095 This depends on the selected viewer and on your operating system.
6096 The same applies to the way viewers need to be configured and the way the
6097 reverse search is actually performed.
6098 In what follows, we will thus describe how to setup reverse search for
6100 Before we turn to this, though, we will explain what needs to be done generally
6101 to enable reverse search in the DVI/PDF output.
6104 \begin_layout Subsection
6106 \begin_inset CommandInset label
6108 name "subsec:rev-search"
6115 \begin_layout Standard
6116 In most cases \SpecialChar LyX
6117 will do the work for you by enabling the option
6118 \begin_inset Flex MenuItem
6121 \begin_layout Plain Layout
6122 Synchronize with Output
6128 \begin_inset Flex MenuItem
6131 \begin_layout Plain Layout
6132 Document\SpecialChar menuseparator
6133 Settings\SpecialChar menuseparator
6140 In such a case \SpecialChar LyX
6141 will automatically insert the necessary Sync\SpecialChar TeX
6143 PDF) or load the srcltx package (for DVI) respectively.
6144 This option can be easily reached also on
6145 \begin_inset Flex Code
6148 \begin_layout Plain Layout
6157 \begin_layout Standard
6158 If you need a different setting, you can select or input a custom macro
6159 from the drop down box just below
6160 \begin_inset Flex MenuItem
6163 \begin_layout Plain Layout
6164 Document\SpecialChar menuseparator
6165 Settings\SpecialChar menuseparator
6166 Output\SpecialChar menuseparator
6167 Synchronize with Output
6175 \begin_layout Standard
6176 Note that the method
6177 \begin_inset Flex Code
6180 \begin_layout Plain Layout
6188 enables gzip compression.
6189 If your viewer does not support it, you should instead use
6190 \begin_inset Flex Code
6193 \begin_layout Plain Layout
6204 \begin_layout Standard
6205 Please also note that including the
6206 \begin_inset Flex Code
6209 \begin_layout Plain Layout
6216 \begin_inset Flex Code
6219 \begin_layout Plain Layout
6225 sometimes has an undesired impact on the typesetting.
6226 Thus, you should switch output synchronization off for the final typesetting
6228 \begin_inset Flex Code
6231 \begin_layout Plain Layout
6238 \begin_inset Flex Code
6241 \begin_layout Plain Layout
6251 \begin_layout Standard
6252 In case you need some more special settings that are not covered by the
6253 automatic settings, read the next section about how to set up output synchroniz
6255 If the automatic setup suits your needs, you can readily jump to section
6256 \begin_inset space ~
6260 \begin_inset CommandInset ref
6262 reference "subsec:configuring-viewers"
6266 , where the necessary configuration steps in your viewer – needed both with
6267 the automatic and the manual setup – are described.
6270 \begin_layout Subsection
6274 \begin_layout Standard
6276 provides several different methods for reverse search.
6277 Some are built-in in the
6278 \begin_inset Flex Code
6281 \begin_layout Plain Layout
6287 program, some are provided by external packages.
6288 Your choice depends on whether your \SpecialChar LaTeX
6289 distribution already provides a given
6290 method (the built-in methods are rather new) and whether your viewer can
6292 The available methods are described in the following.
6295 \begin_layout Subsubsection*
6296 Built-in DVI-search via src-specials (DVI only)
6299 \begin_layout Standard
6300 This method provides the DVI file with the necessary information for reverse
6302 It is available in \SpecialChar LaTeX
6303 since quite some time (any somewhat recent \SpecialChar LaTeX
6305 should include it), and it works reliably.
6306 To enable it, change the
6307 \begin_inset Flex MenuItem
6310 \begin_layout Plain Layout
6321 \begin_inset Flex MenuItem
6324 \begin_layout Plain Layout
6335 \begin_inset Flex MenuItem
6338 \begin_layout Plain Layout
6339 Preferences\SpecialChar menuseparator
6340 File Handling\SpecialChar menuseparator
6347 \begin_inset Flex Code
6350 \begin_layout Plain Layout
6351 latex -src-specials $$i
6357 If this doesn't work, check if your \SpecialChar TeX
6358 engine needs different options (the
6359 syntax might differ in some distributions).
6362 \begin_layout Subsubsection*
6363 External Packages (PDFSync and scrltx)
6366 \begin_layout Standard
6375 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6377 In order to enable it, load the packages in the \SpecialChar LyX
6381 \begin_layout Itemize
6382 \begin_inset Flex Code
6385 \begin_layout Plain Layout
6393 for reverse PDF search,
6396 \begin_layout Itemize
6397 \begin_inset Flex Code
6400 \begin_layout Plain Layout
6403 usepackage[active]{srcltx}
6408 for reverse DVI search.
6411 \begin_layout Standard
6412 If you want to be able to perform both DVI and PDF reverse searches, you
6413 can also insert in the preamble the following lines
6416 \begin_layout LyX-Code
6420 \begin_inset Newline newline
6426 \begin_inset Newline newline
6432 \begin_inset Newline newline
6438 \begin_inset Newline newline
6443 usepackage[active]{srcltx}
6444 \begin_inset Newline newline
6452 \begin_layout Standard
6453 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6454 right package will be used.
6457 \begin_layout Standard
6458 Note that PDFSync might affect the output layout of your document.
6459 It is therefore advised to disable PDFsync for final documents.
6462 \begin_layout Subsubsection*
6463 Built-in reverse search via Sync\SpecialChar TeX
6467 \begin_layout Standard
6469 \begin_inset Flex Code
6472 \begin_layout Plain Layout
6478 have built-in support for both PDF and DVI reverse search.
6481 Sync\SpecialChar TeX
6484 facility is basically the result of the integration of the PDFSync package
6485 to the pdftex program and its merge with the
6490 You need at least \SpecialChar TeX
6491 Live 2008 or a recent Mik\SpecialChar TeX
6492 distribution in order to use
6497 \begin_layout Plain Layout
6498 For some reason, Mik\SpecialChar TeX
6499 does not understand/obey the command \SpecialChar LyX
6501 the preamble when you check the "Enable Forward/Reverse Search" button
6502 in the toolbar and does not generate the necessary info.
6505 \begin_layout Plain Layout
6506 The generation of the required info can be forced by changing the converter
6508 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
6509 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
6510 the -synctex=1 switch).
6515 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
6516 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
6520 \begin_layout Standard
6521 To enable Sync\SpecialChar TeX
6522 for DVI output, change the
6523 \begin_inset Flex MenuItem
6526 \begin_layout Plain Layout
6537 \begin_inset Flex MenuItem
6540 \begin_layout Plain Layout
6551 \begin_inset Flex MenuItem
6554 \begin_layout Plain Layout
6555 Preferences\SpecialChar menuseparator
6556 File Handling\SpecialChar menuseparator
6563 \begin_inset Flex Code
6566 \begin_layout Plain Layout
6567 latex -synctex=1 $$i
6572 , and for PDF output, change the
6573 \begin_inset Flex MenuItem
6576 \begin_layout Plain Layout
6581 (pdflatex) -> PDF (pdflatex)
6587 \begin_inset Flex Code
6590 \begin_layout Plain Layout
6591 pdflatex -synctex=1 $$i
6597 Check the documentation of your viewer whether the viewer needs to be configure
6598 d for the use with Sync\SpecialChar TeX
6603 \begin_layout Plain Layout
6604 Note that the option
6605 \begin_inset Flex Code
6608 \begin_layout Plain Layout
6614 option enables gzip compression.
6615 If your viewer does not support it, you should instead use
6616 \begin_inset Flex Code
6619 \begin_layout Plain Layout
6633 \begin_layout Subsection
6634 Configuring and using specific viewers
6635 \begin_inset CommandInset label
6637 name "subsec:configuring-viewers"
6644 \begin_layout Subsubsection*
6645 Xdvi (all platforms)
6648 \begin_layout Standard
6650 \begin_inset Flex Code
6653 \begin_layout Plain Layout
6659 , you don't need to do anything else for performing a reverse DVI search,
6661 already provides the necessary hooks for automatically using the
6662 \begin_inset Flex Code
6665 \begin_layout Plain Layout
6672 Just setup your document as described above (reverse search is triggered
6673 by Ctrl-click or Alt-click on Mac OSX, respectively).
6676 \begin_layout Standard
6677 However, if for whatever reason you want to use the named pipe instead of
6678 the socket for communicating with \SpecialChar LyX
6679 , simply change the DVI viewer in
6680 \begin_inset Flex MenuItem
6683 \begin_layout Plain Layout
6684 Preferences\SpecialChar menuseparator
6685 File Handling\SpecialChar menuseparator
6695 \begin_layout Plain Layout
6696 On Mac OSX you have to use
6697 \begin_inset Flex Code
6700 \begin_layout Plain Layout
6701 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
6712 \begin_inset Flex Code
6715 \begin_layout Plain Layout
6716 xdvi -editor "lyxeditor.sh %f %l"
6722 \begin_inset Flex Code
6725 \begin_layout Plain Layout
6731 is a suitable script.
6732 For example, a minimal shell script is the following one:
6735 \begin_layout LyX-Code
6737 \begin_inset Newline newline
6740 LYXPIPE="/path/to/lyxpipe"
6741 \begin_inset Newline newline
6744 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
6745 \begin_inset Newline newline
6748 echo "$COMMAND" > "${LYXPIPE}".in || exit
6749 \begin_inset Newline newline
6752 read TMP < "${LYXPIPE}".out || exit
6755 \begin_layout Standard
6757 \begin_inset Flex Code
6760 \begin_layout Plain Layout
6770 \begin_layout Plain Layout
6777 XServer pipe path specified in
6778 \begin_inset Flex MenuItem
6781 \begin_layout Plain Layout
6782 Preferences\SpecialChar menuseparator
6792 \begin_layout Plain Layout
6794 \begin_inset Flex Code
6797 \begin_layout Plain Layout
6803 folder of a source distribution you can find a
6804 \begin_inset Flex Code
6807 \begin_layout Plain Layout
6813 script which is able to locate the
6817 based on your preferences.
6825 \begin_layout Subsubsection*
6829 \begin_layout Standard
6831 \begin_inset Flex Code
6834 \begin_layout Plain Layout
6835 /Applications/MacDviX_Folder/calleditor.script
6840 , add the following lines:
6843 \begin_layout LyX-Code
6848 \begin_layout Plain Layout
6855 X.app/Contents/MacOS/lyxeditor "$2" $1
6856 \begin_inset Newline newline
6862 \begin_layout Standard
6863 Modify the lines accordingly if you install \SpecialChar LyX
6864 somewhere else than in the
6865 Applications folder.
6868 \begin_layout Standard
6869 Reverse search is triggered by Alt-click (OPTION-click).
6872 \begin_layout Subsubsection*
6876 \begin_layout Standard
6878 \begin_inset Flex Code
6881 \begin_layout Plain Layout
6882 open -a Skim.app $$i
6887 to the viewer setting in
6888 \begin_inset Flex MenuItem
6891 \begin_layout Plain Layout
6892 Preferences\SpecialChar menuseparator
6893 File Handling\SpecialChar menuseparator
6894 File formats\SpecialChar menuseparator
6901 \begin_inset Flex MenuItem
6904 \begin_layout Plain Layout
6905 Skim\SpecialChar menuseparator
6906 Preferences\SpecialChar menuseparator
6913 \begin_inset Flex MenuItem
6916 \begin_layout Plain Layout
6922 preset and enter command
6923 \begin_inset Flex MenuItem
6926 \begin_layout Plain Layout
6927 /Applications/\SpecialChar LyX
6928 .app/Contents/MacOS/lyxeditor
6936 \begin_layout Standard
6937 Reverse search is triggered by COMMAND-SHIFT-click
6940 \begin_layout Subsubsection*
6944 \begin_layout Standard
6946 \begin_inset Flex MenuItem
6949 \begin_layout Plain Layout
6950 Settings\SpecialChar menuseparator
6951 Configure Okular\SpecialChar menuseparator
6958 \begin_inset Quotes eld
6962 \begin_inset Quotes erd
6966 \begin_inset Flex Code
6969 \begin_layout Plain Layout
6978 \begin_layout Standard
6979 Reverse search is triggered by SHIFT-click.
6982 \begin_layout Subsubsection*
6986 \begin_layout Standard
6987 Qpdfview supports Sync\SpecialChar TeX
6988 since version 0.3.5.
6990 \begin_inset Flex MenuItem
6993 \begin_layout Plain Layout
6994 Edit\SpecialChar menuseparator
6995 Settings\SpecialChar menuseparator
7001 , click on the input field of the
7002 \begin_inset Quotes eld
7006 \begin_inset Quotes erd
7009 item and add the command
7010 \begin_inset Flex Code
7013 \begin_layout Plain Layout
7022 \begin_layout Standard
7023 Reverse search is triggered by double-click.
7026 \begin_layout Subsubsection*
7030 \begin_layout Standard
7031 Launch yap, choose its
7032 \begin_inset Flex MenuItem
7035 \begin_layout Plain Layout
7036 View\SpecialChar menuseparator
7043 \begin_inset Quotes eld
7047 \begin_inset Quotes erd
7052 \begin_inset Quotes eld
7055 New\SpecialChar ldots
7057 \begin_inset Quotes erd
7060 button and, in the window that opens, enter
7061 \begin_inset Quotes eld
7066 \begin_inset Quotes erd
7069 (or any other name you like) in the
7070 \begin_inset Quotes eld
7074 \begin_inset Quotes erd
7078 Now click on the button labeled
7079 \begin_inset Quotes eld
7084 \begin_inset Quotes erd
7087 to open a file dialog and navigate to the directory containing the batch
7089 \begin_inset Flex Code
7092 \begin_layout Plain Layout
7100 \begin_inset Flex Code
7103 \begin_layout Plain Layout
7109 and then specify the program arguments as
7110 \begin_inset Flex Code
7113 \begin_layout Plain Layout
7121 \begin_inset Flex Code
7124 \begin_layout Plain Layout
7130 wrapper is used for communicating with \SpecialChar LyX
7138 \begin_layout LyX-Code
7140 \begin_inset Newline newline
7143 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7152 \begin_inset Newline newline
7166 \begin_layout Standard
7167 Make sure that the \SpecialChar LyX
7168 Server pipe path you specified in \SpecialChar LyX
7170 \begin_inset Flex Code
7173 \begin_layout Plain Layout
7187 , otherwise change the
7188 \begin_inset Flex Code
7191 \begin_layout Plain Layout
7197 wrapper accordingly.
7200 \begin_layout Standard
7201 In yap, reverse search is triggered by double-click.
7204 \begin_layout Subsubsection*
7205 SumatraPDF (Windows)
7208 \begin_layout Standard
7209 In order to use SumatraPDF for inverse search, enter
7210 \begin_inset Flex Code
7213 \begin_layout Plain Layout
7214 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7219 in the viewer setting in
7220 \begin_inset Flex MenuItem
7223 \begin_layout Plain Layout
7224 Preferences\SpecialChar menuseparator
7225 File Handling\SpecialChar menuseparator
7226 File formats\SpecialChar menuseparator
7233 \begin_inset Flex Code
7236 \begin_layout Plain Layout
7242 is the previous wrapper.
7243 If SumatraPDF.exe is not in your command PATH, use its full file name.
7246 \begin_layout Standard
7247 Reverse search is triggered by double-click.
7250 \begin_layout Subsubsection*
7254 \begin_layout Standard
7255 First of all, make sure that yap is your default DVI viewer in the Windows
7256 environment, then launch it, choose its
7257 \begin_inset Flex MenuItem
7260 \begin_layout Plain Layout
7261 View\SpecialChar menuseparator
7268 \begin_inset Quotes eld
7272 \begin_inset Quotes erd
7277 \begin_inset Quotes eld
7280 New\SpecialChar ldots
7282 \begin_inset Quotes erd
7285 button and, in the window that opens, enter
7286 \begin_inset Quotes eld
7291 \begin_inset Quotes erd
7294 (or any other name you like) in the
7295 \begin_inset Quotes eld
7299 \begin_inset Quotes erd
7303 Now click on the button labeled
7304 \begin_inset Quotes eld
7309 \begin_inset Quotes erd
7312 to open a file dialog and navigate to the directory containing the
7313 \begin_inset Flex Code
7316 \begin_layout Plain Layout
7322 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7325 \begin_inset Flex Code
7328 \begin_layout Plain Layout
7334 and then specify the program arguments as
7335 \begin_inset Flex Code
7338 \begin_layout Plain Layout
7345 In this way, you will be using the
7349 for communicating with \SpecialChar LyX
7351 If, for whatever reason, you want to use the
7356 \begin_inset Flex Code
7359 \begin_layout Plain Layout
7365 option and be sure to specify the \SpecialChar LyX
7366 Server pipe path in the \SpecialChar LyX
7370 \begin_layout Standard
7371 In yap, reverse search is triggered by double-click.
7374 \begin_layout Subsubsection*
7378 \begin_layout Standard
7379 In order to use SumatraPDF for inverse search, enter
7380 \begin_inset Flex Code
7383 \begin_layout Plain Layout
7384 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7389 in the viewer setting in
7390 \begin_inset Flex MenuItem
7393 \begin_layout Plain Layout
7394 Preferences\SpecialChar menuseparator
7395 File Handling\SpecialChar menuseparator
7396 File formats\SpecialChar menuseparator
7403 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7405 \begin_inset Flex Code
7408 \begin_layout Plain Layout
7414 enables communication via the
7420 \begin_inset Flex Code
7423 \begin_layout Plain Layout
7429 option if you want to use the
7433 , and be sure to specify the \SpecialChar LyX
7434 Server pipe path in the \SpecialChar LyX
7438 \begin_layout Standard
7439 Reverse search is triggered by double-click.
7442 \begin_layout Section
7446 \begin_layout Standard
7447 Forward search is, as the name implies, in a sense the
7448 \begin_inset Quotes eld
7452 \begin_inset Quotes erd
7456 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7458 If forward search is set up (as described in what follows), you can put
7459 the cursor anywhere in your \SpecialChar LyX
7461 \begin_inset Flex MenuItem
7464 \begin_layout Plain Layout
7465 Navigate\SpecialChar menuseparator
7472 \begin_inset Flex MenuItem
7475 \begin_layout Plain Layout
7481 in the context menu via right mouse click), and then the viewer will jump
7482 to that position as well.
7483 This implies, of course, that your viewer supports this function.
7486 \begin_layout Standard
7487 To make forward search possible, you first need to provide the generated
7488 output PDF/DVI file with additional information about the \SpecialChar TeX
7490 This can be done via the methods described in the section
7491 \begin_inset CommandInset ref
7493 reference "subsec:rev-search"
7500 \begin_layout Standard
7501 Additionally, you need to configure \SpecialChar LyX
7502 for using your viewers in
7503 \begin_inset Flex MenuItem
7506 \begin_layout Plain Layout
7507 Tools\SpecialChar menuseparator
7508 Preferences\SpecialChar menuseparator
7509 Output\SpecialChar menuseparator
7516 We provide a range of tested configurations for some viewers, which you
7517 can select from the drop down list.
7518 If none of these configurations suits you, you have to find out and enter
7519 a suitable configuration yourself.
7520 The definition syntax uses the following placeholders:
7523 \begin_layout Itemize
7525 \begin_inset Flex Code
7528 \begin_layout Plain Layout
7537 \begin_layout Itemize
7539 \begin_inset Flex Code
7542 \begin_layout Plain Layout
7548 : name of the (temporary) exported .tex file (without path)
7551 \begin_layout Itemize
7553 \begin_inset Flex Code
7556 \begin_layout Plain Layout
7562 : name of the (temporary) exported .tex file (including path)
7565 \begin_layout Itemize
7567 \begin_inset Flex Code
7570 \begin_layout Plain Layout
7576 : name of the exported output file (either dvi or pdf, depending on which
7577 one exists in the temporary directory)
7580 \begin_layout Standard
7581 Note that only some of the viewers provide full forward search functionality,
7582 among them yap, xdvi, okular
7586 \begin_layout Plain Layout
7587 You might want to set
7588 \begin_inset Flex Code
7591 \begin_layout Plain Layout
7598 \begin_inset Flex MenuItem
7601 \begin_layout Plain Layout
7602 Tools\SpecialChar menuseparator
7603 Preferences\SpecialChar menuseparator
7604 File Handling\SpecialChar menuseparator
7606 \begin_inset space ~
7619 , qpdfview and SumatraPDF
7623 \begin_layout Plain Layout
7624 SumatraPDF can also use DDE commands through the external program CMCDDE
7626 \begin_inset CommandInset href
7628 target "ftp://ftp2.commence.com/pub/freebies/"
7638 While many of the widespread PDF viewers (most notably Adobe Reader) do
7639 not support forward search at all, some other viewers – e.
7640 \begin_inset space \thinspace{}
7644 evince and xpdf – allow at least to reload the document and jump to a specific
7645 page of the file, so you can at least navigate
7646 \begin_inset Quotes eld
7650 \begin_inset Quotes erd
7654 This latter functionality is provided by an external call of synctex (see
7655 the predefined example configurations).
7659 \begin_layout Standard
7660 Forward search works both with DVI and PDF output.
7662 simply checks which preview format you have used before (i.
7663 \begin_inset space \thinspace{}
7666 e., which format is already there in the temporary directory) and chooses
7667 the appropriate configuration for the respective format.
7670 \begin_layout Chapter
7671 Special Document Classes
7674 \begin_layout Section
7678 \begin_layout Standard
7684 \begin_layout Subsection
7688 \begin_layout Standard
7689 This section describes how \SpecialChar LyX
7690 can be used to write articles for submission
7691 to the scientific journal
7693 Astronomy and Astrophysics
7696 \begin_inset Flex URL
7699 \begin_layout Plain Layout
7701 http://www.edpsciences.fr/aa/
7706 ) using Version 5.01 of the document class
7711 This package can be downloaded from the ftp site
7714 \begin_layout Standard
7715 \begin_inset VSpace medskip
7721 \begin_layout Standard
7723 \begin_inset Flex URL
7726 \begin_layout Plain Layout
7728 ftp://ftp.edpsciences.org/pub/aa/readme.html
7736 \begin_layout Standard
7737 \begin_inset VSpace medskip
7743 \begin_layout Standard
7744 A manual comes together with that package, and this text is not meant to
7745 replace the original manual but is merely a short guide in how to realize
7746 the correct form of your paper.
7750 \begin_layout Standard
7751 Please note that the publisher of the journal was changed from Springer
7752 to EDP Sciences starting January 1, 2001.
7753 That change involved also some slight changes to the style files, namely
7754 the removal of the thesaurus command.
7755 The \SpecialChar LyX
7756 class aa supports the newest version of these style files, V 5.01.
7757 If you have an older version installed, please upgrade.
7758 For compatibility, the old (version 4) layout has been kept as
7763 Please refer to the comments in
7766 Dir/layouts/aapaper.layout
7771 \begin_layout Subsection
7775 \begin_layout Standard
7776 It is recommended you start from the example template distributed with \SpecialChar LyX
7778 If you are not using a template, note the following settings:
7781 \begin_layout Itemize
7788 Document\SpecialChar menuseparator
7791 dialog (OK, that one was obvious).
7794 \begin_layout Itemize
7795 Don't change the option
7798 \begin_inset space ~
7808 The whole layout is done by the macros, you shouldn't change anything.
7811 \begin_layout Subsection
7815 \begin_layout Standard
7816 First thing to enter is the header information.
7817 It consists of seven entries, of which some are optional.
7821 \begin_layout Itemize
7829 \begin_layout Itemize
7837 \begin_layout Itemize
7845 \begin_layout Itemize
7853 \begin_layout Itemize
7858 : [optional] if more than one author: whom to contact for offprint requests.
7861 \begin_layout Itemize
7866 : [optional] mail address for contacts.
7869 \begin_layout Itemize
7877 Received: <date>; Accepted <date>
7880 \begin_layout Standard
7881 There is no need to issue the
7887 command, this is done automatically by \SpecialChar LyX
7888 when the header is finished.
7889 Although the order of the single header entries doesn't matter it is advised
7890 to keep the above sequence, just to get the best optics and meets the layout
7891 of the real document.
7894 \begin_layout Standard
7895 If you want to place footnotes in the header block, e.
7896 \begin_inset space \thinspace{}
7900 \begin_inset space \space{}
7903 to state your present address, just use the standard footnote via the menu
7906 Insert\SpecialChar menuseparator
7911 will automagically use the term
7920 \begin_layout Standard
7921 In addition to these topics, the macros use three additional \SpecialChar LaTeX
7923 have no counterpart in \SpecialChar LyX
7927 \begin_layout Itemize
7934 to separate different names for more than one author and institute, respectivel
7938 \begin_layout Itemize
7945 to mark corresponding author/institute pairs.
7946 The institutes are numbered sequentially as they appear in the
7950 field, so you have to put a marker to each author.
7953 \begin_layout Itemize
7960 to supply an email address for fast contact.
7963 \begin_layout Standard
7964 In all cases, the appropriate command has to be entered in \SpecialChar LyX
7972 \begin_layout Subsection
7976 \begin_layout Standard
7977 The abstract should immediately follow the header block.
7978 With version 5 the abstract environment was changed to a command, and there
7979 is now a resctriction to only one paragraph.
7980 In addition, it should contain an entry with the keywords.
7981 This is not yet implemented for \SpecialChar LyX
7982 , therefore you have to enter the \SpecialChar LaTeX
7990 by hand and mark it as \SpecialChar LaTeX
7992 Refer to the example paper.
7995 \begin_layout Subsection
7996 Supported environments
7999 \begin_layout Standard
8000 The A&A paper layout supports the following environments for structuring
8004 \begin_layout Itemize
8010 \begin_layout Itemize
8016 \begin_layout Itemize
8022 \begin_layout Itemize
8028 \begin_layout Itemize
8034 \begin_layout Itemize
8040 \begin_layout Itemize
8046 \begin_layout Itemize
8052 \begin_layout Itemize
8058 \begin_layout Itemize
8064 \begin_layout Itemize
8070 \begin_layout Itemize
8077 \begin_layout Subsection
8078 Commands not supported by \SpecialChar LyX
8082 \begin_layout Standard
8083 Some commands are not yet supported by the
8087 layout for \SpecialChar LyX
8089 Some have already been mentioned.
8090 For the sake of completeness, they are listed all together here:
8093 \begin_layout Itemize
8101 \begin_layout Itemize
8109 \begin_layout Itemize
8117 \begin_layout Itemize
8125 \begin_layout Itemize
8133 \begin_layout Itemize
8141 \begin_layout Itemize
8149 \begin_layout Itemize
8157 \begin_layout Standard
8158 If you want to use any of these commands, you have to enter them yourself.
8161 Do not forget to mark them as \SpecialChar LaTeX
8165 \begin_layout Subsection
8166 Figure and Table Floats
8169 \begin_layout Standard
8171 provides support for the necessary float environments
8173 figure, figure*, table
8179 , therefore we won't tell much about it here.
8183 \begin_inset space ~
8189 Just remember that tables should be left-aligned.
8190 For that, select the table and change the alignment in
8192 Edit\SpecialChar menuseparator
8194 \begin_inset space ~
8200 \begin_layout Standard
8201 There is only one special thing: the figures with caption besides the figure.
8202 To create such a figure, you have to do the following:
8205 \begin_layout Enumerate
8206 Create a wide figure float:
8208 Insert\SpecialChar menuseparator
8209 Float\SpecialChar menuseparator
8212 , then right click in the figure and select
8218 \begin_inset space ~
8226 \begin_layout Enumerate
8227 Enter your caption text.
8230 \begin_layout Enumerate
8235 to move the cursor above the caption.
8238 \begin_layout Enumerate
8242 \begin_layout Enumerate
8243 Position the cursor behind the figure and insert a horizontal fill:
8245 Insert\SpecialChar menuseparator
8247 \begin_inset space ~
8250 Character\SpecialChar menuseparator
8252 \begin_inset space ~
8260 \begin_layout Enumerate
8261 Switch to \SpecialChar LaTeX
8265 \begin_inset space ~
8273 \begin_layout Enumerate
8283 Do not close the brace!
8286 \begin_layout Enumerate
8287 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8292 \begin_inset space ~
8304 \begin_layout Standard
8305 Also, refer to the figures in the example paper.
8308 \begin_layout Subsection
8312 \begin_layout Standard
8313 For submission, the paper has to be formated in a special double-spacing
8315 For this purpose, you have to give the option
8319 to the documentclass.
8320 This must be done using the extra class options field in the
8322 Document\SpecialChar menuseparator
8326 Just enter the string
8333 \begin_layout Subsection
8337 \begin_layout Standard
8342 directory contains an example paper written with \SpecialChar LyX
8344 It is the example paper from the original macro package, translated to
8347 Use it for inspiration, and compare the original \SpecialChar LaTeX
8348 code with \SpecialChar LyX
8352 \begin_layout Section
8357 \begin_layout Standard
8363 \begin_layout Subsection
8367 \begin_layout Standard
8369 is a set of macros produced by the American Astronomical Society to
8370 facilitate electronic manuscript submission to the three journals they
8371 publish: the Astrophysical Journal (including the Letters and Supplement),
8372 the Astronomical Journal, and the Publications of the Astronomical Society
8375 has proven to be an excellent tool for generating these documents, especially
8376 given its equation, citation, and figure handling capabilities.
8378 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8379 is the version described here, or higher.
8380 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8381 2.09 and are fundamentally
8382 incompatible with \SpecialChar LyX
8384 The AAS\SpecialChar TeX
8385 package may be downloaded from the AAS\SpecialChar TeX
8389 \begin_layout Standard
8390 \begin_inset VSpace medskip
8396 \begin_layout Standard
8398 \begin_inset Flex URL
8401 \begin_layout Plain Layout
8403 http://www.journals.uchicago.edu/AAS/AASTeX
8411 \begin_layout Standard
8412 \begin_inset VSpace medskip
8418 \begin_layout Standard
8419 A complete user guide is contained in that package and you should familiarize
8420 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8423 will not reduce the need to figure out all the AAS\SpecialChar TeX
8424 commands, it will only
8425 reduce the drudgery of typing everything in.
8426 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8428 completely to the requirements of the journal to which you are submitting
8432 \begin_layout Subsection
8433 Starting a New Paper
8436 \begin_layout Standard
8437 I strongly suggest that you start with the AAS\SpecialChar TeX
8441 File\SpecialChar menuseparator
8448 , enter the new file name, then choose the
8453 This will show the most common fields found in a manuscript.
8454 Simply overwrite the existing text (including the brackets,
8458 ) with the correct information.
8459 Many of the AAS\SpecialChar TeX
8460 commands and environments can be implemented directly in
8462 , but some cannot: most noticeably
8474 , which should stick out like a sore thumb if you actually just opened the
8476 For commands such as these, the \SpecialChar LaTeX
8477 code must be entered directly and marked
8479 Such commands are referred to as \SpecialChar TeX
8480 code, or Evil Red Text.
8481 I tried to minimize the amount of \SpecialChar TeX
8482 code needed in an AAS\SpecialChar TeX
8484 there is still a bit more required than any of us would like.
8487 \begin_layout Subsection
8488 Finishing Your Paper
8491 \begin_layout Standard
8492 When the paper is finished to your satisfaction and previews/prints correctly,
8494 \begin_inset Quotes eld
8498 \begin_inset Quotes erd
8501 actions which need to be done before you submit it to the journals.
8505 \begin_layout Enumerate
8506 Export your paper as a \SpecialChar LaTeX
8509 File\SpecialChar menuseparator
8510 Export\SpecialChar menuseparator
8518 \begin_layout Enumerate
8523 file with your favorite text editor
8524 \begin_inset Separator parbreak
8531 \begin_layout Enumerate
8532 remove the comment lines before the
8541 \begin_layout Enumerate
8546 usepackage...{fontenc}
8548 line if it appears (usually just after
8563 \begin_layout Enumerate
8564 remove everything between (and including) the
8576 commands, except for any commands you specifically put into the \SpecialChar LaTeX
8578 (which should appear immediately after the
8579 \begin_inset Quotes eld
8582 User specified \SpecialChar LaTeX
8584 \begin_inset Quotes erd
8595 \begin_layout Enumerate
8596 Run the resulting file through \SpecialChar LaTeX
8597 to make sure it still processes correctly.
8600 \begin_layout Enumerate
8601 Reread the journal requirements to make sure your filenames and formats
8605 \begin_layout Enumerate
8609 \begin_layout Subsection
8610 Comments On Specific Commands
8613 \begin_layout Standard
8614 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
8621 ) gives a good description of each.
8622 Thus it's probably easiest for me to go down the list as found in the guide
8623 and offer comments where necessary.
8624 So let's begin \SpecialChar ldots
8628 \begin_layout Subsubsection
8629 Things that work as expected
8632 \begin_layout Standard
8633 Because they work as you might expect, I simply list them and the section
8734 begin{thebibliography}
8742 (2.13.2), all the cite commands and their variations (2.13.2), the generic
8743 graphicx figure commands (2.14.1),
8767 (2.15.4, amongst other places),
8794 \begin_layout Standard
8795 The following style options also work correctly:
8816 Simply put them in the
8822 Layout\SpecialChar menuseparator
8828 \begin_layout Subsubsection
8829 Things that work, but require more comment
8832 \begin_layout Standard
8833 The following items work, but require a little more discussion:
8836 \begin_layout Itemize
8837 These items are reserved for use by the journal editors, but you can put
8838 them into the \SpecialChar LaTeX
8839 preamble if you feel compelled to do so:
8872 \begin_layout Itemize
8873 These items may be placed in the \SpecialChar LaTeX
8874 preamble, and are included as blanks in
8896 \begin_layout Itemize
8903 (2.3) – can only be used
8904 \begin_inset Quotes eld
8908 \begin_inset Quotes erd
8911 , not in the middle of a paragraph.
8912 Use \SpecialChar TeX
8913 code if you need to embed it.
8916 \begin_layout Itemize
8923 (2.3) – will have extra {} after it.
8924 This should not cause an error.
8927 \begin_layout Itemize
8934 (2.6) – can only be used
8935 \begin_inset Quotes eld
8939 \begin_inset Quotes erd
8942 , not in the middle of a paragraph.
8943 Use \SpecialChar TeX
8944 code if you need to embed it.
8947 \begin_layout Itemize
8954 (2.8) – can't insert a cross-reference tag, you must type the tag name by
8958 \begin_layout Itemize
8972 \begin_layout Itemize
8979 (2.9) – will have extra {} after it.
8980 This should not cause an error.
8983 \begin_layout Itemize
8990 (2.11) – will have extra {} after it.
8991 This should not cause an error.
8994 \begin_layout Itemize
9001 (2.14.2) – you can insert an optional filename argument by placing the cursor
9002 at the beginning of the text and selecting
9004 Insert\SpecialChar menuseparator
9009 \begin_inset Quotes eld
9013 \begin_inset Quotes erd
9016 inserts an optional argument of the type needed by
9023 Hopefully it will be renamed someday.
9026 \begin_layout Itemize
9039 for the catalog ID optional parameter
9042 \begin_layout Itemize
9055 for the catalog ID optional parameter
9058 \begin_layout Subsubsection
9059 Things not implemented, use \SpecialChar TeX
9063 \begin_layout Standard
9086 setcounter{equation}
9088 (2.12), Journal name abbreviations (2.13.4),
9124 (2.15.4, insert it as the first element in the lefthand cell after where
9126 Don't use any of \SpecialChar LyX
9127 's rules in the table),
9139 (2.15.5), much of Misc (2.17, except
9190 \begin_layout Subsubsection
9191 Things that cannot be implemented
9194 \begin_layout Standard
9196 at least in any meaningful sort of way, so I suggest ignoring them.
9197 They are the references environment (2.13.3), and the deluxetable environment
9199 If you really, really need to use deluxetable, I suggest editing it in
9200 a separate file with a text editor, then using
9202 Insert\SpecialChar menuseparator
9204 \begin_inset space ~
9209 to include it in your \SpecialChar LyX
9215 file to see an example of this.
9218 \begin_layout Subsection
9219 FAQs, Tips, Tricks, and Other Ruminations
9222 \begin_layout Subsubsection
9223 Getting \SpecialChar LyX
9224 and AAS\SpecialChar TeX
9228 \begin_layout Standard
9229 It can be a bit tricky to get \SpecialChar LyX
9230 to recognize a new layout and document class.
9231 When all else fails, do this:
9234 \begin_layout Enumerate
9235 Make certain that \SpecialChar LaTeX
9236 can find AAS\SpecialChar TeX
9238 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9240 directory completely unrelated to \SpecialChar LaTeX
9241 or AAS\SpecialChar TeX
9242 and run \SpecialChar LaTeX
9250 \begin_layout Enumerate
9255 appears in \SpecialChar LyX
9263 \begin_layout Enumerate
9266 Tools\SpecialChar menuseparator
9270 , then restart \SpecialChar LyX
9274 \begin_layout Enumerate
9275 Open a regular new file, not from a template.
9276 Does AAS\SpecialChar TeX
9277 appear in the class list in
9279 Document\SpecialChar menuseparator
9285 \begin_layout Standard
9286 If you get a warning from an existing AAS\SpecialChar TeX
9287 document about not being able
9288 to find the AAS\SpecialChar TeX
9289 layout or a message about
9290 \begin_inset Quotes eld
9293 You should not mix title layouts with normal ones
9294 \begin_inset Quotes erd
9297 , things haven't been installed correctly.
9300 \begin_layout Subsubsection
9302 error processing a table
9305 \begin_layout Standard
9307 , by default, attempts to center the table caption/title.
9308 This seems to produce a bad interaction in AAS\SpecialChar TeX
9309 so you should click somewhere
9310 in the caption/title, then select
9312 Edit\SpecialChar menuseparator
9314 \begin_inset space ~
9328 This took care of it for me.
9331 \begin_layout Subsubsection
9335 \begin_layout Standard
9336 A couple of things: 1) I have noticed some funny spacing in the reference
9337 entries in the text.
9338 When you enter the bibliography item data, make sure their is
9342 space between the last author and the parenthesis setting off the year;
9346 \begin_inset space \thinspace{}
9350 \begin_inset space \space{}
9364 2) Entering the references at all is not obvious.
9365 The easiest thing is to start typing your first reference at the end of
9366 the document, then mark it as type
9371 That will put a small gray box in front of what you just typed.
9372 Click on the box to fill in the rest of the information.
9373 For new references, go to the end of an existing reference and press return.
9374 That will create a new line with its own box, etc.
9377 \begin_layout Subsubsection
9381 \begin_layout Standard
9382 Even though AAS\SpecialChar TeX
9383 provides its own figure commands (
9389 , for example), I much prefer \SpecialChar LaTeX
9390 's standard figure commands (with the default
9399 \begin_inset space ~
9402 commands as \SpecialChar TeX
9403 code into a Figure Float box if you desire, but I never have
9404 much luck getting the layout right.
9405 With the standard graphics, \SpecialChar LyX
9410 usepackage{graphicx}
9412 command into the \SpecialChar LaTeX
9413 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9415 interspersing the figures in the text.
9416 I believe ApJ accepts figures exactly this way now; AJ might still use
9418 \begin_inset Quotes eld
9421 stack everything at the end
9422 \begin_inset Quotes erd
9428 \begin_layout Subsubsection
9429 Things I could have done, but didn't
9432 \begin_layout Standard
9434 \begin_inset Quotes eld
9438 \begin_inset Quotes erd
9441 things I could have implemented, but chose not to.
9442 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9444 even though it is double-spaced in the paper manuscript.
9445 Also, I chose not to make separate layouts for the preprint and preprint2
9447 Since I assume you will spend most of your time in the plain manuscript
9448 mode anyway, I decided not to chew up more disk space with this.
9452 \begin_layout Subsection
9456 \begin_layout Standard
9457 Your mileage may vary.
9458 I've now had papers published by both ApJ and AJ that have had 98% of the
9459 effort done in \SpecialChar LyX
9460 ; the last 2% was the \SpecialChar LaTeX
9461 post-processing and a few cleanups.
9462 I have had no trouble with the submission process, and I'm sure the journals
9463 were never aware that there might be a difference.
9464 So, go forth and publish!
9467 \begin_layout Section
9468 AMS \SpecialChar LaTeX
9472 \begin_layout Standard
9482 \begin_layout Standard
9483 \begin_inset VSpace bigskip
9489 \begin_layout Standard
9491 The AMS \SpecialChar LaTeX
9492 layouts are set up to conform to suggested styles for mathematical
9493 papers to be submitted to American Mathematical Society publications.
9494 The layouts are not tailored to a specific journal, but easily can be.
9495 You should refer to the AMS documentation for specific instructions for
9496 each journal (usually it will entail only changing a single line in the
9499 That documentation is available on the Web at
9500 \begin_inset Flex URL
9503 \begin_layout Plain Layout
9511 \begin_inset Flex URL
9514 \begin_layout Plain Layout
9516 ftp://ftp.ams.org/pub/tex/amslatex/
9522 These layouts are appropriate, and useful, for any mathematical writing.
9526 \begin_layout Standard
9527 There are two basic AMS \SpecialChar LaTeX
9531 \begin_layout Itemize
9532 amsart: The standard AMS article format.
9535 \begin_layout Itemize
9536 amsbook: the standard AMS book (really, monograph) format.
9540 \begin_layout Standard
9541 The layouts themselves contain only the minimum necessary to use the AMS
9543 They do not, in particular, contain any of the `theorem' environments used
9544 for setting theorems, lemmas, and the like.
9545 These are contained, instead, in the
9546 \begin_inset Flex Code
9549 \begin_layout Plain Layout
9555 module, which is loaded by default when you select one of the AMS classes.
9556 (It can also be used with other classes and can be removed, if you would
9557 rather use something else.) Less commonly used environments are in the
9558 \begin_inset Flex Code
9561 \begin_layout Plain Layout
9562 Theorems (AMS-Extended)
9567 module, which must be loaded manually.
9570 \begin_layout Standard
9571 By default, theorems and the like are numbered consecutively throughout
9572 the document, but this may be modified by loading the module
9573 \begin_inset Flex Code
9576 \begin_layout Plain Layout
9577 Theorems (Order by Section)
9582 or, if you are using
9583 \begin_inset Flex Code
9586 \begin_layout Plain Layout
9593 \begin_inset Flex Code
9596 \begin_layout Plain Layout
9597 Theorems (Order by Chapter)
9603 These will number the results as
9604 \begin_inset Formula $n.m$
9607 , where the first number refers to the section (or chapter) and the second
9608 refers to the total number of results so far in that section (or chapter).
9609 Many environments are also available unnumbered.
9610 These are indicated by an asterisk at the end.
9611 If you happen to want
9615 unnumbered results, the module
9616 \begin_inset Flex Code
9619 \begin_layout Plain Layout
9625 provides that option.
9628 \begin_layout Standard
9629 Note that these modules do not
9633 to be used with the AMS classes.
9634 It is perfectly possible to use the
9635 \begin_inset Flex Code
9638 \begin_layout Plain Layout
9644 module, and the others mentioned, with other classes, such as
9645 \begin_inset Flex Code
9648 \begin_layout Plain Layout
9655 \begin_inset Flex Code
9658 \begin_layout Plain Layout
9665 \begin_inset Flex Code
9668 \begin_layout Plain Layout
9677 \begin_layout Subsection
9678 What these layouts provide
9681 \begin_layout Standard
9682 There is a long list of included environments provided by these layouts.
9683 In AMS-\SpecialChar LaTeX
9684 , there is, in fact, an opportunity to define an unlimited variety
9685 of `theorem' environments.
9686 However, the AMS recommends the environments that are available in \SpecialChar LyX
9691 \begin_layout Standard
9692 The following environments—as well as the standard environments, such as
9694 \begin_inset Flex Noun
9697 \begin_layout Plain Layout
9704 \begin_inset Flex Noun
9707 \begin_layout Plain Layout
9714 \begin_inset Flex Noun
9717 \begin_layout Plain Layout
9724 \begin_inset Flex Noun
9727 \begin_layout Plain Layout
9734 \begin_inset Flex Noun
9737 \begin_layout Plain Layout
9744 \begin_inset Flex Code
9747 \begin_layout Plain Layout
9754 \begin_inset Flex Code
9757 \begin_layout Plain Layout
9766 \begin_layout Description
9767 Address This should be the author's permanent address.
9770 \begin_layout Description
9772 \begin_inset space ~
9775 Address This should be the author's temporary address at the time of submission,
9776 if different from the Address.
9779 \begin_layout Description
9780 Email Author's e-mail address
9783 \begin_layout Description
9784 URL Author's Web address, if desired.
9787 \begin_layout Description
9788 Keywords Key words or phrases used to identify specific topics discussed
9792 \begin_layout Description
9793 Subjectclass These refer to the AMS Subject Classifications, published and
9796 Mathematical Reviews
9799 These are also available online at the AMS cites listed above.
9802 \begin_layout Description
9806 \begin_layout Description
9810 \begin_layout Description
9814 \begin_layout Standard
9815 The following environments are provided by both the
9816 \begin_inset Flex Code
9819 \begin_layout Plain Layout
9826 \begin_inset Flex Code
9829 \begin_layout Plain Layout
9835 modules, in the latter case in both starred (unnumbered) and unstarred
9836 (numbered) versions.
9837 These same environments are provided only in the starred versions by the
9839 \begin_inset Flex Code
9842 \begin_layout Plain Layout
9851 \begin_layout Theorem
9852 This is typically used for the statements of major results.
9856 \begin_layout Corollary*
9857 This is used for statements which follow fairly directly from previous statement
9859 Again, these can be major results.
9864 These are smaller results needed to prove other statements.
9867 \begin_layout Proposition
9868 These are less major results which (hopefully) add to the general theory
9872 \begin_layout Conjecture
9873 These are statements provided without justification, which the author does
9874 not know how to prove, but which seem to be true (to the author, at least).
9877 \begin_layout Definition*
9878 Guess what this is for.
9879 The font is different for this environment than for the previous ones.
9883 \begin_layout Example*
9884 Used for examples illustrating proven results.
9887 \begin_layout Problem
9888 It's not really known what this is for.
9889 You should figure it out.
9892 \begin_layout Exercise*
9893 Write a description for this one.
9896 \begin_layout Remark
9897 This environment is also a type of theorem, usually a lesser sort of observation.
9900 \begin_layout Claim*
9901 Often used in the course of giving a proof of a larger result.
9905 Generally, these are used to break up long arguments, using specific instances
9911 The numbering scheme for cases is on its own, not together with other numbered
9917 At the end of this environment, a QED symbol (usually a square, but it can
9918 vary with different styles) is placed.
9919 If you want to have other environments within this one—for example, Case
9920 environments—and have the QED symbol appear only after them, then the other
9921 environments need to be nested within the proof environment.
9924 Nesting Environments
9930 for information on nesting.
9933 \begin_layout Standard
9934 And these environments are provided by
9935 \begin_inset Flex Code
9938 \begin_layout Plain Layout
9939 Theorems (AMS-Extended)
9947 \begin_layout Criterion*
9948 A required condition.
9951 \begin_layout Algorithm*
9952 A general procedure to be used.
9955 \begin_layout Axiom*
9956 This is a property or statement taken as true within the system being discussed.
9959 \begin_layout Condition*
9960 Sometimes used to state a condition assumed within the present context of
9965 Similar to a Remark.
9968 \begin_layout Notation*
9969 Used for the explanation of, yes, notation.
9972 \begin_layout Summary
9973 Do we really need to tell you?
9976 \begin_layout Acknowledgement*
9980 \begin_layout Conclusion*
9981 Sometimes used at the end of a long train of argument.
9985 Used in a way similar to Proposition, though perhaps lower on the scale.
9988 \begin_layout Standard
9989 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
9992 They need to be available on your system in order to use these environments.
9995 \begin_layout Section
10003 \begin_layout Standard
10009 \begin_layout Subsection
10013 \begin_layout Standard
10014 These are the layout files for some of the journals of the American Geophysical
10016 It is assumed that you have both the AGU's own class files and AGUplus
10017 installed (everything to be found at
10018 \begin_inset Flex URL
10021 \begin_layout Plain Layout
10023 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10031 \begin_layout Subsection
10035 \begin_layout Standard
10045 They are still called this in the \SpecialChar LyX
10046 GUI, though their \SpecialChar LaTeX
10059 \begin_layout Standard
10060 Newly defined styles are
10097 These are mostly manuscript attributes and defined in the AGU class documentati
10101 \begin_layout Standard
10102 I suspect this is still badly incomplete.
10105 \begin_layout Subsection
10109 \begin_layout Standard
10126 \begin_layout Subsection
10130 \begin_layout Itemize
10133 Journal of Geophysical Research
10142 \begin_layout Standard
10143 Add your own, it isn't so hard! Look at the
10154 \begin_layout Subsection
10155 Bugs and things to remember
10158 \begin_layout Standard
10159 In order to use the new layouts, you must remember to do the following for
10163 \begin_layout Enumerate
10169 This can be done in the
10171 Layout\SpecialChar menuseparator
10176 Document\SpecialChar menuseparator
10180 (AGU articles are always in English, right? So
10184 choose a language.)
10187 \begin_layout Enumerate
10192 into the document's
10197 (Yes, this is a bug.)
10200 \begin_layout Enumerate
10201 Make sure you use the
10205 bibliography style, by entering
10209 into the second field of the Bib\SpecialChar TeX
10211 None of the standard styles will do.
10214 \begin_layout Section
10218 \begin_layout Standard
10224 \begin_layout Subsection
10228 \begin_layout Standard
10229 Broadway is for writing plays.
10230 The format is more decorative than Hollywood, and much less standardized.
10231 This format should be suitable for workshops.
10234 \begin_layout Subsection
10238 \begin_layout Standard
10239 The same as in Hollywood.
10242 \begin_layout Subsection
10246 \begin_layout Standard
10251 names as labels then cross-reference the label to insert the name.
10252 The cross-reference dialog will show the current cast of characters.
10255 \begin_layout Subsection
10256 Paper size and Margins
10259 \begin_layout Standard
10260 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10263 \begin_layout Subsection
10267 \begin_layout Standard
10268 The following environments are available.
10269 You can use broadway.bind to get the bind keys shown at the right.
10272 \begin_layout Itemize
10276 \begin_inset Newline newline
10281 You should not have to use this, but it is here for anything that does not
10285 \begin_layout Itemize
10289 \begin_inset space \hfill{}
10293 \begin_inset Newline newline
10298 Used to describe stage setting and the action.
10299 First use of speaker names in all CAPs.
10302 \begin_layout Itemize
10306 \begin_inset space \hfill{}
10310 \begin_inset Newline newline
10315 Automatically numbered.
10316 On screen it will be arabic, but will print as Roman.
10319 \begin_layout Itemize
10323 \begin_inset space \hfill{}
10327 \begin_inset Newline newline
10337 It is just centered text.
10340 \begin_layout Itemize
10344 \begin_inset space \hfill{}
10348 \begin_inset Newline newline
10353 Not automatically numbered.
10354 You supply the number.
10355 This is because I couldn't figure out how.
10358 \begin_layout Itemize
10362 \begin_inset space \hfill{}
10366 \begin_inset Newline newline
10371 A special case of Narrative to describe the setting and action as the curtain
10375 \begin_layout Itemize
10379 \begin_inset space \hfill{}
10383 \begin_inset Newline newline
10388 The speaker's (actor's) title, centered in all CAPS.
10391 \begin_layout Itemize
10395 \begin_inset space \hfill{}
10399 \begin_inset Newline newline
10404 Instructions to the speaker.
10405 The parentheses are automatically inserted.
10406 The ( will appear on screen, but both will be in the printed play.
10407 This environment is only used within
10414 \begin_layout Itemize
10418 \begin_inset space \hfill{}
10422 \begin_inset Newline newline
10427 What the Speaker says.
10430 \begin_layout Itemize
10434 \begin_inset space \hfill{}
10438 \begin_inset Newline newline
10443 The curtain comes down.
10446 \begin_layout Itemize
10450 \begin_inset space \hfill{}
10456 \begin_layout Itemize
10460 \begin_inset space \hfill{}
10466 \begin_layout Itemize
10470 \begin_inset space \hfill{}
10476 \begin_layout Standard
10480 \begin_layout Section
10484 \begin_layout Standard
10489 can be used to type letters according to German conventions.
10490 A template file is included in
10492 .../lyx/share/templates
10494 for you to use as a starting point.
10497 \begin_layout Section
10505 \begin_layout Standard
10511 \begin_layout Subsection
10515 \begin_layout Standard
10516 This is the layout file for the European Geophysical Society journals.
10521 can be downloaded from the web site of the EGS under
10522 \begin_inset Flex URL
10525 \begin_layout Plain Layout
10535 \begin_layout Subsection
10539 \begin_layout Standard
10542 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
10550 The current layout file is unfortunately very unmodular and would benefit
10551 from using the various
10558 \begin_layout Section
10562 \begin_layout Standard
10563 See the \SpecialChar LyX
10569 It contains all infos you need.
10572 \begin_layout Section
10575 Foil\SpecialChar TeX
10579 \begin_inset CommandInset label
10588 \begin_layout Standard
10594 \begin_layout Subsection
10598 \begin_layout Standard
10599 This section describes how to use \SpecialChar LyX
10600 to make slides for overhead projectors.
10601 There are two document classes that can do this: the default slides class
10604 Foil\SpecialChar TeX
10608 This section documents the latter.
10611 \begin_layout Standard
10612 I'm going to say this again, nice and clear, so that there's no misunderstanding
10616 \begin_layout Standard
10617 \begin_inset VSpace bigskip
10623 \begin_layout Standard
10627 This section documents the class
10628 \begin_inset Quotes eld
10636 \begin_inset Quotes erd
10644 \begin_layout Standard
10645 \begin_inset VSpace bigskip
10651 \begin_layout Standard
10652 If you're looking for the documentation for
10653 \begin_inset Quotes eld
10661 \begin_inset Quotes erd
10664 , check out section
10665 \begin_inset space ~
10669 \begin_inset CommandInset ref
10671 reference "sec:slitex"
10676 If your machine doesn't have the
10681 \begin_inset Quotes eld
10689 \begin_inset Quotes erd
10692 ] installed, you'll probably have to use the default
10696 class, which isn't quite as good as
10701 \begin_layout Standard
10706 class is designed for use with version 2.1 of the
10711 class file which is now an integral part of \SpecialChar LaTeX2e
10715 \begin_layout Subsection
10719 \begin_layout Standard
10720 Obviously, to use this document class, you need to select
10721 \begin_inset Quotes eld
10729 \begin_inset Quotes erd
10739 \begin_inset space ~
10745 There are some settings in the
10748 \begin_inset space ~
10753 dialog that you should know about that are specific to this class:
10756 \begin_layout Itemize
10757 Don't change the options
10768 \begin_inset space ~
10774 They're ignored by the
10781 \begin_layout Itemize
10782 The default font size is 20
10783 \begin_inset space \thinspace{}
10786 pt with the other options being 17
10787 \begin_inset space \thinspace{}
10791 \begin_inset space \thinspace{}
10795 \begin_inset space \thinspace{}
10801 \begin_layout Itemize
10802 The default font is
10810 but all math equations are still typeset in the usual roman font.
10813 \begin_layout Itemize
10816 Foil\SpecialChar TeX
10819 supports A4 and Letter paper sizes as well as a special size for working
10821 \begin_inset space \thinspace{}
10825 It doesn't support A5, B5, legal or executive paper sizes.
10828 \begin_layout Itemize
10829 Don't bother changing the
10833 settings because they are ignored anyway.
10834 All floats appear where they are defined in the text.
10837 \begin_layout Itemize
10842 setting behaves a bit differently for this class.
10845 Foil\SpecialChar TeX
10848 provides extensive footer and header capabilities including a user-defined
10851 \begin_inset space ~
10855 \begin_inset CommandInset ref
10857 reference "sec:foilfoot"
10862 The title page is treated differently to all other pages in the document
10871 has the logo centered at the bottom of the page (if one is defined).
10872 The possible page style choices and what they do are as follows:
10873 \begin_inset Separator parbreak
10880 \begin_layout Labeling
10881 \labelwidthstring MMMMMMM
10888 The final output contains no page numbers, or other headers or footers
10889 (except footnotes of course).
10893 \begin_layout Labeling
10894 \labelwidthstring MMMMMMM
10901 The final output contains page numbers centered at the bottom of the page.
10902 No other headings or footers (other than footnotes).
10905 \begin_layout Labeling
10906 \labelwidthstring MMMMMMM
10911 Page numbers in lower right corner.
10912 Additional headers and footers are also shown.
10913 This is also the default.
10916 \begin_layout Labeling
10917 \labelwidthstring MMMMMMM
10922 Gives you access to the
10926 package although its use with
10928 Foil\SpecialChar TeX
10931 is discouraged by the writer of the
10933 Foil\SpecialChar TeX
10936 package because of some potential page layout clashes.
10940 \begin_layout Subsubsection
10944 \begin_layout Standard
10945 The following options may be used in the extra class options in the
10947 Document\SpecialChar menuseparator
10953 \begin_layout Labeling
10954 \labelwidthstring MMMMMMx
10959 This sets up the page layout for 7.33
10960 \begin_inset space \thinspace{}
10964 \begin_inset space \thinspace{}
10967 in paper, which is about the same aspect ratio as a 35
10968 \begin_inset space \thinspace{}
10971 mm slide, making it a bit easier to work with this medium.
10974 \begin_layout Labeling
10975 \labelwidthstring MMMMMMx
10980 Places a rule across the page below the header on every page except the
10984 \begin_layout Labeling
10985 \labelwidthstring MMMMMMx
10990 Places a rule across the page above the footer on every page except the
10994 \begin_layout Labeling
10995 \labelwidthstring MMMMMMx
11000 This is automatically set each time you create a new
11007 Foil\SpecialChar TeX
11010 to use the dvips driver to rotate those pages that are set as landscape
11014 \begin_layout Labeling
11015 \labelwidthstring MMMMMMx
11020 Simply changes the page dimensions to those of a landscape page but doesn't
11022 Thus if you use this option you need to use an external program to rotate
11023 each page or feed your paper through your printer as landscape.
11024 Note that this option effectively reverses the roles of the
11032 environments (don't worry these are described in the next section).
11035 \begin_layout Labeling
11036 \labelwidthstring MMMMMMx
11041 Equation numbers on the left.
11044 \begin_layout Labeling
11045 \labelwidthstring MMMMMMx
11050 Flush-left equations.
11053 \begin_layout Subsection
11054 Supported Environments
11057 \begin_layout Standard
11058 Most of the environments commonly supported in other classes are also supported
11064 There are several additional environments provided by
11066 Foil\SpecialChar TeX
11069 as well as a couple added by \SpecialChar LyX
11071 The following environments are shared with other classes:
11074 \begin_layout Standard
11075 \begin_inset Flex Multiple Columns
11078 \begin_layout Itemize
11084 \begin_layout Itemize
11090 \begin_layout Itemize
11096 \begin_layout Itemize
11102 \begin_layout Itemize
11108 \begin_layout Itemize
11115 \begin_layout Itemize
11121 \begin_layout Itemize
11127 \begin_layout Itemize
11133 \begin_layout Itemize
11139 \begin_layout Itemize
11145 \begin_layout Itemize
11151 \begin_layout Itemize
11157 \begin_layout Itemize
11163 \begin_layout Itemize
11169 \begin_layout Itemize
11175 \begin_layout Itemize
11181 \begin_layout Itemize
11192 \begin_layout Standard
11193 That is, all the major environments apart from the sectioning environments.
11194 Since foils are essentially self-contained sections, with a title and body,
11197 Foil\SpecialChar TeX
11200 provides specific commands for starting new foils and these are:
11203 \begin_layout Itemize
11209 \begin_layout Itemize
11215 \begin_layout Standard
11217 also provides slightly modified versions of these two environments called:
11220 \begin_layout Itemize
11226 \begin_layout Itemize
11229 ShortRotatefoilhead
11232 \begin_layout Standard
11233 and the differences will be explained in the next section.
11236 \begin_layout Standard
11237 Since foils are often used in presenting ideas or new theorems and such
11240 Foil\SpecialChar TeX
11243 also provides a comprehensive box of goodies for presenting them:
11246 \begin_layout Standard
11247 \begin_inset Flex Multiple Columns
11250 \begin_layout Itemize
11256 \begin_layout Itemize
11262 \begin_layout Itemize
11268 \begin_layout Itemize
11274 \begin_layout Itemize
11280 \begin_layout Itemize
11286 \begin_layout Itemize
11292 \begin_layout Itemize
11298 \begin_layout Itemize
11304 \begin_layout Itemize
11310 \begin_layout Itemize
11321 \begin_layout Standard
11322 The starred versions are unnumbered while the unstarred versions are numbered.
11323 There are also two list environments added by \SpecialChar LyX
11327 \begin_layout Itemize
11333 \begin_layout Itemize
11339 \begin_layout Standard
11342 Foil\SpecialChar TeX
11345 provides some powerful header and footer capabilities that are best set
11346 in the preamble although they may be set at any point in a document.
11347 If you want to change these settings in your document the best place to
11348 do so is at the very top of a foil, i.
11349 \begin_inset space \thinspace{}
11355 \begin_inset space \space{}
11360 straight after the foilhead.
11363 \begin_layout Standard
11364 For this purpose, the following command styles are provided [
11371 \begin_layout Standard
11372 \begin_inset Flex Multiple Columns
11375 \begin_layout Itemize
11379 \begin_inset space ~
11385 \begin_layout Itemize
11391 \begin_layout Itemize
11395 \begin_inset space ~
11401 \begin_layout Itemize
11405 \begin_inset space ~
11411 \begin_layout Itemize
11415 \begin_inset space ~
11421 \begin_inset Separator parbreak
11428 \begin_layout Plain Layout
11429 \begin_inset space ~
11441 \begin_layout Standard
11442 There are also a few commands provided by
11444 Foil\SpecialChar TeX
11447 that aren't directly supported by \SpecialChar LyX
11448 but I'll tell you what they do and how
11449 to use them in section
11450 \begin_inset space ~
11454 \begin_inset CommandInset ref
11456 reference "sec:unsuppfoils"
11463 \begin_layout Subsection
11464 Building a Set of Foils
11467 \begin_layout Standard
11468 This section will give a simple introduction to using the different environments
11469 to build a set of foils.
11470 If you want to see an example set of foils, take a look at the
11474 file you find in \SpecialChar LyX
11482 \begin_layout Subsubsection
11483 Give It a Title Page
11486 \begin_layout Standard
11487 Unlike other classes that provide
11507 creates the title on a page of its own.
11508 If you leave out the
11512 environment \SpecialChar LaTeX
11513 will substitute the current date (every time you regenerate
11517 \begin_layout Subsubsection
11521 \begin_layout Standard
11522 As I mentioned earlier, there are four ways of starting a new foil.
11523 For portrait foils you should use
11532 The difference between these two environments is the amount of space between
11533 the title of the foil (the foilhead) and the body of the foil.
11536 \begin_layout Standard
11537 Landscape foils are generated using the
11543 ShortRotatefoilhead
11546 Again the only difference is the spacing between foilhead and body.
11547 Both of the short versions have 0.5
11548 \begin_inset space ~
11551 inches less separation between the foilhead and the body.
11555 \begin_layout Standard
11556 One problem with the support for landscape foils is the requirement that
11557 you have to use the
11561 driver to generate the PostScript output otherwise the foils won't be rotated.
11562 It is possible to get landscape foils even if you haven't got the
11566 driver provided you can feed your foils sideways through your printer ;-)
11569 \begin_layout Subsubsection
11570 Theorems, Lemmas, Proofs and more
11573 \begin_layout Standard
11574 Due to a small bug in \SpecialChar LyX
11575 you can't have two of the same type of these environments
11576 directly following each other.
11577 They must be separated by something.
11578 If you try, you will just be extending the previous environment as if you
11579 had merged the two environments together.
11580 So, how do you get around this problem? The simplest option is to insert
11581 some text between the two environments or add a
11586 environment between the two with just a
11587 \begin_inset Quotes eld
11595 \begin_inset Quotes erd
11599 This will force \SpecialChar LyX
11600 to produce two separate environments and hence the correct
11603 An example is provided in the example file included with the \SpecialChar LyX
11605 Remember, this problem only occurs if you are trying to place two of the
11606 same type of theorem-like environments one directly after the other.
11609 \begin_layout Subsubsection
11613 \begin_layout Standard
11614 You get all the commonly supported list styles found in other classes as
11615 well as two new ones.
11616 I'll only describe the new ones here.
11617 If you want to find out more about the other list environments check out
11623 If you intend to use itemized lists you might also want to read about the
11627 \begin_inset space ~
11631 \begin_inset space ~
11636 dialog described above in section
11637 \begin_inset space ~
11641 \begin_inset CommandInset ref
11643 reference "sec:bullet"
11650 \begin_layout Standard
11651 The two new list styles,
11659 , are designed to make it easier for you to create lists of do's and don'ts
11660 or right and wrong by providing dedicated environments that use a tick
11661 or a cross as the label of the list.
11662 These lists are in fact dedicated variants of the
11667 They do however require that you have the
11671 packages installed.
11674 \begin_layout Subsubsection
11678 \begin_layout Standard
11681 Foil\SpecialChar TeX
11684 redefines the floating tables and figures so that they appear exactly where
11685 they are in the text rather than pushing them to the top of the page or
11686 to some user specified location.
11687 In fact if you change the float placement settings they are simply ignored.
11690 \begin_layout Subsubsection
11691 Page Headers and Footers
11692 \begin_inset CommandInset label
11694 name "sec:foilfoot"
11701 \begin_layout Standard
11705 \begin_inset space ~
11714 are two commands used to control the left-footer text string.
11715 The first is meant to allow you to include a graphic logo on your foils
11717 \begin_inset Quotes eld
11722 Foil\SpecialChar TeX
11726 \begin_inset Quotes erd
11730 While the second is meant to provide a classification for the audience,
11734 \begin_inset space \thinspace{}
11740 \begin_inset space \space{}
11744 It is empty by default.
11747 \begin_layout Standard
11748 The remaining page corners can be filled by
11751 \begin_inset space ~
11756 (which defaults to page numbers),
11759 \begin_inset space ~
11767 \begin_inset space ~
11775 \begin_layout Subsection
11778 Foil\SpecialChar TeX
11782 \begin_inset CommandInset label
11784 name "sec:unsuppfoils"
11791 \begin_layout Standard
11792 All the commands mentioned below need to be set in a
11802 within another environment.
11805 \begin_layout Subsubsection
11809 \begin_layout Standard
11810 All lengths are adjusted using the
11833 should be replaced by the name given to the length you want to change and
11838 is the length value.
11839 All lengths should be specified in units of length such as inches (
11851 ) or relative to some document or font-based length such as
11861 \begin_layout Standard
11862 It's possible to change the spacing between a foilhead and the body of the
11863 foil by adjusting the length specified by
11870 For example, to make
11875 \begin_inset space \space{}
11878 in closer to their bodies put the following in the preamble:
11884 foilheadskip}{-0.5in}
11887 \begin_layout Standard
11888 The spacings around floats can be adjusted by setting these lengths:
11891 \begin_layout Labeling
11892 \labelwidthstring MMMMMMMMMMM
11899 Separation between the text and the top of the float
11902 \begin_layout Labeling
11903 \labelwidthstring MMMMMMMMMMM
11910 Separation between the float and the caption
11913 \begin_layout Labeling
11914 \labelwidthstring MMMMMMMMMMM
11921 Separation between the caption and the following text
11924 \begin_layout Labeling
11925 \labelwidthstring MMMMMMMMMMM
11932 You can make the captions narrower than the surrounding text by adjusting
11934 Best done relative to
11943 \begin_layout Standard
11944 There are also several title page related lengths that you may find useful
11945 if you have a long title or several authors:
11948 \begin_layout Labeling
11949 \labelwidthstring MMMMMMMMMMM
11956 Separation from headers to
11961 \begin_layout Labeling
11962 \labelwidthstring MMMMMMMMMMM
11980 \begin_layout Labeling
11981 \labelwidthstring MMMMMMMMMMM
11995 \begin_layout Labeling
11996 \labelwidthstring MMMMMMMMMMM
12012 \begin_layout Labeling
12013 \labelwidthstring MMMMMMMMMMM
12029 \begin_layout Standard
12030 The last length related command affects all the list environments.
12041 a list environment then all the vertical spacing between the list items
12043 Note that this is a command not a length so it doesn't require
12049 like the stuff mentioned above.
12052 \begin_layout Subsubsection
12053 Headers and Footers
12056 \begin_layout Standard
12069 commands control whether the logo in the
12073 definition appear on a given page.
12080 in the preamble then none of the foils will have the logo on them.
12081 If you don't want the logo on a particular page place the
12087 directly after the foilhead of that page and the
12093 directly after the next foilhead.
12096 \begin_layout Standard
12097 If you decide to use the
12101 page style setting in the
12104 \begin_inset space ~
12109 dialog you should probably add
12119 to your preamble so headers and footers on landscape pages are correctly
12120 placed when rotated.
12121 This is due to some clashes between the page layouts provided by the
12132 \begin_layout Section
12133 Hollywood (Hollywood spec scripts)
12136 \begin_layout Standard
12142 \begin_layout Subsection
12146 \begin_layout Standard
12147 Getting the format of a Hollywood script right is a
12148 \begin_inset Quotes eld
12152 \begin_inset Quotes erd
12155 It is designed to make the readers focus on content and to be easy and
12156 familiar for the actors to read.
12157 Each page of a script should be one minute of film.
12158 Nothing goes in a script that you cannot see or hear on screen.
12159 The courier 12 pt font should be used throughout.
12163 \begin_layout Subsection
12167 \begin_layout Standard
12168 Speakers' lines should NEVER break in mid-sentence.
12169 If a speaker's lines continue over a page break, repeat the
12173 title followed by (Cont'd).
12176 \begin_layout Subsection
12180 \begin_layout Standard
12185 names as labels then cross-reference the label to insert the name.
12186 The cross-reference dialog will show the current cast of characters.
12187 You can use this to insert the speaker name in narratives also.
12190 \begin_layout Subsection
12191 Paper size and Margins
12194 \begin_layout Standard
12195 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12198 \begin_layout Subsection
12202 \begin_layout Standard
12203 The following environments are available.
12204 You can use hollywood.bind to get the bind keys shown at the right.
12207 \begin_layout Itemize
12211 \begin_inset Newline newline
12216 Used where nothing else works.
12220 \begin_layout Itemize
12226 \begin_inset space \hfill{}
12234 \begin_inset Newline newline
12237 Usually followed by something like
12238 \begin_inset Quotes eld
12241 on Sally waking up.
12242 \begin_inset Quotes erd
12248 \begin_layout Itemize
12252 \begin_inset space \hfill{}
12256 \begin_inset Newline newline
12261 Introduces a new INTERIOR camera set-up.
12262 Always followed by DAY or NIGHT, or something similar to define the lighting
12264 Everthing on this line in CAPS.
12267 \begin_layout Itemize
12271 \begin_inset space \hfill{}
12275 \begin_inset Newline newline
12280 Introduces a new EXTERIOR camera set-up.
12281 Everthing on this line in CAPS.
12284 \begin_layout Itemize
12288 \begin_inset space \hfill{}
12292 \begin_inset Newline newline
12297 The character speaking.
12300 \begin_layout Itemize
12304 \begin_inset space \hfill{}
12308 \begin_inset Newline newline
12313 Instructions to the speaker.
12314 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12316 Both will be printed.
12319 \begin_layout Itemize
12323 \begin_inset space \hfill{}
12327 \begin_inset Newline newline
12339 \begin_layout Itemize
12343 \begin_inset space \hfill{}
12347 \begin_inset Newline newline
12352 Camera movement instruction.
12354 \begin_inset space \thinspace{}
12358 \begin_inset space \space{}
12364 \begin_layout Itemize
12368 \begin_inset space \hfill{}
12374 \begin_layout Itemize
12378 \begin_inset space \hfill{}
12384 \begin_layout Itemize
12388 \begin_inset space \hfill{}
12394 \begin_layout Itemize
12398 \begin_inset space \hfill{}
12404 \begin_layout Subsection
12408 \begin_layout Itemize
12412 \begin_layout Itemize
12416 \begin_layout Itemize
12418 \begin_inset space \thinspace{}
12425 \begin_layout Itemize
12430 \begin_layout Itemize
12431 PAN — camera movement
12434 \begin_layout Itemize
12435 INSERT — cut to close-up of
12438 \begin_layout Section
12442 \begin_layout Standard
12445 Panayotis Papasotiriou
12448 \begin_layout Subsection
12452 \begin_layout Standard
12453 The ijmpc package is a set of macros that facilitates electronic manuscript
12456 International Journal of Modern Physics C
12459 Similarly, the ijmpd package is for creating manuscripts to be submitted
12462 International Journal of Modern Physics D
12465 Both journals are published by World Scientific.
12466 The corresponding document classes are named
12475 These files, together with instructions for the authors, can be downloaded
12477 \begin_inset Flex URL
12480 \begin_layout Plain Layout
12482 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12488 \begin_inset Flex URL
12491 \begin_layout Plain Layout
12493 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12499 Both packages are modified versions of the standard
12500 \begin_inset Quotes eld
12504 \begin_inset Quotes erd
12507 package, and they are almost (but not exactly) identical.
12508 Most of their features are supported by \SpecialChar LyX
12510 I have used \SpecialChar LyX
12511 successfully to write articles submitted to both journals
12512 without any problem.
12515 \begin_layout Subsection
12519 \begin_layout Standard
12520 As usual, the easiest way to write a paper is to start with a template.
12523 File\SpecialChar menuseparator
12542 This will give an (almost) empty document that includes the most common
12543 fields found in a manuscript.
12544 Simply overwrite the existing text (including the brackets,
12549 You should keep in mind the following remarks.
12552 \begin_layout Enumerate
12554 won't let you change the font size and the page style of the document,
12555 because such modifications are not allowed by both packages.
12558 \begin_layout Enumerate
12559 The language of the document should not be changed.
12560 Before previewing your paper, be sure that the babel package is not used.
12561 To do this, click on
12563 Tools\SpecialChar menuseparator
12574 checkbox in the language settings, and click on
12582 , if you wish to make this change permanent).
12585 \begin_layout Enumerate
12587 \begin_inset Quotes eld
12591 \begin_inset Quotes erd
12594 style must be used to define keywords.
12597 \begin_layout Enumerate
12598 The ijmpc package provides a style named
12599 \begin_inset Quotes eld
12602 Classification Codes
12603 \begin_inset Quotes erd
12606 , which can be used to define classification codes, such as PACS numbers.
12607 Note that this facility is not supported by the ijmpd package.
12610 \begin_layout Enumerate
12611 Several new environments are available:
12612 \begin_inset Quotes eld
12616 \begin_inset Quotes erd
12620 \begin_inset Quotes eld
12624 \begin_inset Quotes erd
12628 \begin_inset Quotes eld
12632 \begin_inset Quotes erd
12636 \begin_inset Quotes eld
12640 \begin_inset Quotes erd
12644 \begin_inset Quotes eld
12648 \begin_inset Quotes erd
12652 \begin_inset Quotes eld
12656 \begin_inset Quotes erd
12660 \begin_inset Quotes eld
12664 \begin_inset Quotes erd
12668 \begin_inset Quotes eld
12672 \begin_inset Quotes erd
12676 \begin_inset Quotes eld
12680 \begin_inset Quotes erd
12684 \begin_inset Quotes eld
12688 \begin_inset Quotes erd
12692 \begin_inset Quotes eld
12696 \begin_inset Quotes erd
12700 \begin_inset Quotes eld
12704 \begin_inset Quotes erd
12708 \begin_inset Quotes eld
12712 \begin_inset Quotes erd
12716 \begin_inset Quotes eld
12720 \begin_inset Quotes erd
12724 Their use is more or less obvious.
12726 supports all these environments; it will use the proper label, text style,
12727 and numbering scheme for each of them.
12730 \begin_layout Enumerate
12731 Both packages use basic citations; the natbib package should not be used.
12732 In \SpecialChar LyX
12733 , citation references are shown as usual; in the output, citations are
12734 shown as superscripts.
12735 If you want to use a citation as normal text, you should use the
12740 \begin_inset space \thinspace{}
12744 \begin_inset space \space{}
12748 \begin_inset Quotes eld
12752 \begin_inset space \space{}
12762 \begin_inset Quotes erd
12768 \begin_layout Enumerate
12770 \begin_inset Quotes eld
12774 \begin_inset Quotes erd
12777 section in both packages.
12778 To put acknowledgments, just use the
12779 \begin_inset Quotes eld
12783 \begin_inset Quotes erd
12789 \begin_layout Enumerate
12790 Appendices may be added to the paper,
12794 the Acknowledgments and
12800 provides a special environment, called
12801 \begin_inset Quotes eld
12805 \begin_inset Quotes erd
12808 which marks the beginning of the appendices.
12809 This environment should be left blank; it just sends a \SpecialChar LaTeX
12810 command, but nothing
12812 In \SpecialChar LyX
12814 \begin_inset Quotes eld
12818 \begin_inset Quotes erd
12821 is printed with blue letters, as a signal that all sections after that
12822 point are appendices.
12823 To write an appendix, use the
12824 \begin_inset Quotes eld
12828 \begin_inset Quotes erd
12833 will number each appendix with capital letters, as required by both journals.
12835 \begin_inset Quotes eld
12839 \begin_inset Quotes erd
12846 be present before the first appendix; if not, all appendices will be numbered
12847 as normal sections in the output.
12850 \begin_layout Enumerate
12851 The ijmpc and the ijmpd packages use the
12855 command to implement table captions.
12856 As a result, a table created by \SpecialChar LyX
12857 is printed correctly, but its caption
12859 However, you can use some \SpecialChar TeX
12860 code to overcome this problem, so that captions
12861 are printed as expected.
12862 To do so, create a float table as usual, remove the caption, and replace
12863 it with the \SpecialChar TeX
12874 (sic); you must also the \SpecialChar TeX
12879 immediately after the tabular material.
12880 Study the example table included in the template files to see how this
12881 trick is implemented.
12882 Alternatively, If you need table captions, you should implement the whole
12887 file, then include this file to the \SpecialChar LyX
12890 Insert\SpecialChar menuseparator
12891 File\SpecialChar menuseparator
12893 \begin_inset space ~
12899 Details on how to create a table float can be found in the files
12907 , included in the corresponding packages.
12910 \begin_layout Subsection
12911 Preparing a paper for submission
12914 \begin_layout Standard
12915 Before you submit your paper you must export the \SpecialChar LyX
12916 document as a \SpecialChar LaTeX
12919 File\SpecialChar menuseparator
12920 Export\SpecialChar menuseparator
12928 \begin_layout Plain Layout
12929 Actually you have the choice between \SpecialChar LaTeX
12930 (plain) and pdflatex.
12931 If you intend to use pdflatex to prepare the paper, you should use the
12932 pdflatex option so that included graphics are converted to PDF format,
12933 ready for use by pdflatex.
12938 , then make the following changes to the resulting
12945 \begin_layout Enumerate
12946 Remove the comment lines before the
12955 \begin_layout Enumerate
12956 Remove everything between (and including) the
12968 commands, except for any commands you specifically put into the \SpecialChar LaTeX
12972 \begin_layout Standard
12977 file should be saved and processed through \SpecialChar LaTeX
12978 as many times as necessary.
12979 You may also want to check the resulting
12986 \begin_layout Subsection
12987 Use of \SpecialChar TeX
12991 \begin_layout Standard
12992 The use of \SpecialChar TeX
12993 code is reduced to two commands, which must be placed at the
12994 top of the document.
12995 If you started writing your paper by using the
13003 template, the \SpecialChar TeX
13004 code needed is already in its place; you usually don't need
13006 You may only modify the first \SpecialChar TeX
13007 code to specify the information printed
13008 to the top of odd and even pages (authors' names and short paper's title,
13010 This \SpecialChar TeX
13011 code must have the form
13015 markboth{Authors' Names}{Short Paper's Title}
13020 \begin_layout Section
13024 \begin_layout Standard
13030 \begin_layout Subsection
13034 \begin_layout Standard
13035 The iopart package provides a document class to create electronic manuscript
13036 submission to the journals published by the Institute of Physics.
13037 Instructions for the authors how to create a paper using the iopart class
13038 can be downloaded together with the iopart package from the site
13039 \begin_inset Flex URL
13042 \begin_layout Plain Layout
13044 ftp://ftp.iop.org/pub/journals/latex2e
13052 \begin_layout Subsection
13056 \begin_layout Standard
13057 The easiest way to write a paper is to start with the file
13061 that is available in \SpecialChar LyX
13062 's examples files folder.
13063 Open this file, save it under a new name, and start writing.
13064 The example file explains how to use the special text environments.
13065 Here are the most important advices:
13068 \begin_layout Itemize
13069 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13072 Use AMS math package
13074 in the document settings under
13081 \begin_layout Itemize
13084 The title environment defines the kind of your paper.
13085 So use one of the following environments for the title:
13088 \begin_inset Separator parbreak
13095 \begin_layout Itemize
13104 \begin_layout Itemize
13113 \begin_layout Itemize
13119 for a Topical review
13122 \begin_layout Itemize
13131 \begin_layout Itemize
13140 \begin_layout Itemize
13146 for a Paper (same as Title)
13149 \begin_layout Itemize
13155 for a Preliminary communication
13158 \begin_layout Itemize
13164 for a Rapid communication
13167 \begin_layout Itemize
13173 for a Letter to the editor
13177 \begin_layout Itemize
13180 All title environments except of
13184 can have an optional short title.
13187 \begin_layout Itemize
13188 There is a general title environment
13192 which is not directly supported by the \SpecialChar LyX
13194 This can be used as \SpecialChar TeX
13195 code when your document doesn't fit into one of the
13199 \begin_layout Standard
13200 For more informations like hints for special table and formula formatting,
13201 look at the IOP author guidelines.
13204 \begin_layout Section
13208 \begin_layout Standard
13211 Panayotis Papasotiriou
13214 \begin_layout Subsection
13218 \begin_layout Standard
13219 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13220 that facilitates electronic manuscript submission to the journals they
13222 Most known of them (at least in my domain of interest) are
13224 Astrophysics and Space Science
13230 , but there are many others (see a complete list at
13231 \begin_inset Flex URL
13234 \begin_layout Plain Layout
13236 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13242 The Kluwer package may be downloaded from the site
13243 \begin_inset Flex URL
13246 \begin_layout Plain Layout
13248 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13254 A complete user guide is contained in that package (but it can also be
13255 downloaded separately).
13258 \begin_layout Standard
13260 supports many features of the package but not everything.
13261 However, the \SpecialChar TeX
13262 code needed is reduced to some
13263 \begin_inset Quotes eld
13267 \begin_inset Quotes erd
13270 commands of the package (see
13271 \begin_inset space ~
13275 \begin_inset CommandInset ref
13277 reference "subsec:kluwer_peculiarities"
13282 I have recently used \SpecialChar LyX
13283 to write an article submitted to the
13285 Astrophysics and Space Science
13287 without any problem.
13290 \begin_layout Subsection
13294 \begin_layout Standard
13295 The easiest way to write a paper is to start with the Kluwer template file.
13298 File\SpecialChar menuseparator
13310 This will give an (almost) empty document that includes the most common
13311 fields found in a manuscript and a short description of their use.
13312 As in most templates, simply overwrite the existing text (including the
13317 ) with the correct information.
13320 \begin_layout Subsection
13321 Preparing a paper for submission
13324 \begin_layout Standard
13325 As in the AAS\SpecialChar TeX
13326 package, before you submit your paper to a journal you must
13328 \begin_inset Quotes eld
13332 \begin_inset Quotes erd
13338 \begin_layout Enumerate
13339 Export your paper as a \SpecialChar LaTeX
13341 To do this, click on
13343 File\SpecialChar menuseparator
13344 Export\SpecialChar menuseparator
13352 \begin_layout Enumerate
13357 file with a text editor and make the following changes
13358 \begin_inset Separator parbreak
13365 \begin_layout Enumerate
13366 remove the comment lines before the
13375 \begin_layout Enumerate
13376 remove everything between (and including) the
13388 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13392 \begin_layout Standard
13401 \begin_layout Enumerate
13406 file through \SpecialChar LaTeX
13407 as many times as necessary (usually up to three).
13410 \begin_layout Enumerate
13416 \begin_inset space \thinspace{}
13420 \begin_inset space \space{}
13427 , and check if everything is OK (it should, if you didn't make any mistake).
13430 \begin_layout Subsection
13431 \begin_inset Quotes eld
13435 \begin_inset Quotes erd
13438 of the Kluwer package
13439 \begin_inset CommandInset label
13441 name "subsec:kluwer_peculiarities"
13448 \begin_layout Standard
13449 The Kluwer package has the following
13450 \begin_inset Quotes eld
13454 \begin_inset Quotes erd
13460 \begin_layout Enumerate
13461 It is possible to write multiple articles in the same \SpecialChar LaTeX
13466 \begin_layout Plain Layout
13467 I can't imagine any good reason to do this.
13473 Each article must be included in the environment
13474 \begin_inset Quotes eld
13478 \begin_inset Quotes erd
13482 Unfortunately, this environment cannot be omitted, even if you write just
13484 Therefore, each article starts with the command
13490 and, obviously, ends with the command
13497 Although this can be implemented in \SpecialChar LyX
13498 , I didn't included it, since it looks
13499 ugly and can confuse the novice user.
13500 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13503 \begin_inset Quotes eld
13508 \begin_inset Quotes erd
13514 \begin_layout Enumerate
13515 Information given at the beginning of the article (i.
13516 \begin_inset space \thinspace{}
13520 \begin_inset space \space{}
13523 title, subtitle, author, institution, running title, running author, abstract
13524 and keywords) must be included in an environment called
13525 \begin_inset Quotes eld
13529 \begin_inset Quotes erd
13533 This is not implemented in \SpecialChar LyX
13534 , so you must enter title, subtitle etc.
13535 \begin_inset space ~
13538 between two \SpecialChar TeX
13554 \begin_layout Enumerate
13555 According to the user manual, the label of each bibliography item must be
13579 \begin_layout Standard
13584 template takes care of all these
13585 \begin_inset Quotes eld
13589 \begin_inset Quotes erd
13593 If you start a new paper using this template you don't need to do anything
13598 \begin_layout Enumerate
13599 don't delete the \SpecialChar TeX
13600 code included in the template, and
13603 \begin_layout Enumerate
13604 copy the example bibliography item included in the template and modify it
13605 as necessary to enter new bibliography items.
13608 \begin_layout Section
13612 \begin_layout Standard
13618 \begin_layout Subsection
13622 \begin_layout Standard
13623 The \SpecialChar LyX
13626 article (koma-script)
13630 report (koma-script)
13648 correspond to the \SpecialChar LaTeX
13666 \begin_inset space ~
13669 of the Koma-Script family.
13670 They are replacements for the standard document classes
13686 , resp., and fit better to European typography conventions in a number of
13690 \begin_layout Itemize
13691 Standard character size is 11pt in
13693 article (koma-script)
13697 report (koma-script)
13705 letter (koma-script)
13710 \begin_layout Itemize
13711 Headings, labels of the description environment, and a number of elements
13714 letter (koma-script)
13716 document class are set in a bold sans serif font.
13720 \begin_layout Plain Layout
13721 There is a big difference between the bold sans serif old cm fonts and new
13722 ec fonts, especially in the appearance of headings.
13723 In comparison, the ec bold sans serif fonts look a bit thin.
13724 Here the \SpecialChar LaTeX
13733 helps to produce the
13734 \begin_inset Quotes eld
13738 \begin_inset Quotes erd
13741 appearance when using the ec fonts.
13746 The numbering of chapter headings is made in the same way as the numbering
13747 of section headings, that is without the extra line
13748 \begin_inset Quotes eld
13751 Chapter\SpecialChar ldots
13753 \begin_inset Quotes erd
13757 In addition, the appearance of the headings can be modified by using a
13758 number of options (in \SpecialChar LyX
13759 to be entered in the field
13762 \begin_inset space ~
13769 Layout\SpecialChar menuseparator
13776 \begin_layout Itemize
13777 The main means in the Koma-Script document classes to design the type area
13786 (in \SpecialChar LyX
13787 to be entered in the extra class options field in the dialog
13789 Document\SpecialChar menuseparator
13793 They make a clearer modification of page margins possible as do the options
13796 Document\SpecialChar menuseparator
13803 \begin_layout Itemize
13804 The \SpecialChar LaTeX
13805 document classes of the Koma-Script family define a number of additional
13807 Those part of it which makes sense in \SpecialChar LyX
13808 is implemented in corresponding
13812 \begin_layout Standard
13813 Detailed descriptions of the \SpecialChar LaTeX
13814 document classes of the Koma-Script family
13815 can be found in the Koma-Script documentation
13826 \begin_layout Subsection
13827 article (koma-script), report (koma-script), and book (koma-script)
13830 \begin_layout Standard
13831 The document classes
13833 article (koma-script)
13837 report (koma-script)
13847 are implemented in the layout files
13860 They contain all the paragraph types of the corresponding standard document
13873 , resp., partly modified, with the exception of the \SpecialChar LyX
13878 -type, which is replaced by the new
13882 -type having the same functionality.
13887 -Type there is a number of new paragraph types added.
13894 letter (koma-script)
13899 \begin_layout Itemize
13908 : are equivalents to
13916 , resp., additionally inserting an entry in the table of contents.
13925 are not contained in
13927 article (koma-script)
13932 \begin_layout Itemize
13941 : behave exactly as
13949 , resp., additionally clearing running heads.
13954 is not contained in
13956 article (koma-script)
13962 \begin_layout Plain Layout
13975 report (koma-script)
13977 , but since this is identical to
13981 , is has not been implemented in \SpecialChar LyX
13990 \begin_layout Itemize
13995 : generates a heading directly above the following paragraph in the standard
13996 character size without affecting the structure of the document.
13999 \begin_layout Itemize
14008 are special captions which respect the different space settings needed
14009 for captions placed above or below an element (if you follow strict typographic
14010 rules, you might want to place table captions always above the table).
14011 You can also use the class option
14015 , which will switch
14028 You need at least Koma-Script version 2.8q to use this.
14031 \begin_layout Itemize
14036 : can be used to set a bonmot, e.
14037 \begin_inset space \thinspace{}
14041 \begin_inset space \space{}
14044 at the beginning of a chapter.
14045 If you use the optional argument (
14047 Insert\SpecialChar menuseparator
14049 \begin_inset space ~
14054 ), you can insert the dictum's author there.
14055 Dictum and author are separated by a line.
14056 You need at least Koma-Script version 2.8q to use this.
14061 is not contained in
14063 article (koma-script)
14068 \begin_layout Standard
14069 The following types, together with the standard types
14081 , form the title area of the document.
14082 They must be entered ahead of the first
14083 \begin_inset Quotes eld
14087 \begin_inset Quotes erd
14094 \begin_layout Plain Layout
14095 The corresponding \SpecialChar LaTeX
14096 commands must appear before the
14107 When such a type is used more than once, the latter usage overwrites the
14108 former one, that means, for every type only the latest usage is valid.
14109 The order of the different types however has, like
14121 , no effect on the appearance of the produced document.
14124 \begin_layout Itemize
14129 : produces a centered paragraph above the ordinary title (
14141 ) for the subject of the document.
14144 \begin_layout Itemize
14149 : produces a centered paragraph below the ordinary title (
14161 ) for the publishers' name.
14164 \begin_layout Itemize
14171 report (koma-script)
14177 produces a centered paragraph on its own page behind the title page, or
14180 article (koma-script)
14182 produces a centered paragraph below the ordinary title (
14198 ) for a dedication.
14201 \begin_layout Itemize
14206 : produces a left aligned paragraph above the ordinary title (
14222 ) for a document`s head.
14225 \begin_layout Itemize
14230 : produces in a double-sided print in
14232 report (koma-script)
14238 a left-aligned paragraph at the top of the title page`s back or has no
14239 effect in a single-sided print or in
14241 article (koma-script)
14246 \begin_layout Itemize
14251 : produces in a double-sided print in
14253 report (koma-script)
14259 a left-aligned paragraph at the bottom of the title page`s back or has
14260 no effect in a single-sided print or in
14262 article (koma-script)
14267 \begin_layout Itemize
14272 : produces a special
14273 \begin_inset Quotes eld
14277 \begin_inset Quotes erd
14280 page ahead of the actual document containing a paragraph without special
14284 \begin_layout Standard
14285 The layout files for the document classes
14287 article (koma-script)
14291 report (koma-script)
14297 do include the file
14302 This is thought of as a place to define your own types.
14307 in your personal layout directory and edit the file!
14310 \begin_layout Subsection
14311 letter (koma-script)
14314 \begin_layout Standard
14318 letter (koma-script)
14320 is implemented in the layout file
14325 It contains all the paragraph types of the corresponding standard document
14330 , partly modified, with the exception of the \SpecialChar LyX
14344 type, which is replaced by the new
14349 In addition, it contains, in contrast to the standard document class, the
14368 Furthermore, there are a number of new letter specific types.
14371 \begin_layout Standard
14372 The appearance of the letter produced by this document class can be controlled
14373 by a number of \SpecialChar LaTeX
14374 commands, which you can put in the \SpecialChar LaTeX
14379 \begin_layout Plain Layout
14380 For example, the standard appearance of the letter`s heading, consisting
14381 of name and address, is quite self-willed.
14383 \begin_inset Quotes eld
14387 \begin_inset Quotes erd
14390 heading is produced by the following \SpecialChar LaTeX
14391 commands in the preamble:
14394 \begin_layout LyX-Code
14404 \begin_layout LyX-Code
14420 \begin_layout LyX-Code
14430 \begin_layout LyX-Code
14450 A detailed German description of such \SpecialChar LaTeX
14451 commands can be found in the Koma-Script
14457 With it, the letter's author can produce his personal letter layout.
14460 \begin_layout Standard
14469 define the beginning of the letter and must be used in every letter.
14470 To emphasize them in the \SpecialChar LyX
14471 document class, they are marked with the letter
14481 \begin_inset space ~
14484 in the left margin.
14485 It is possible to write any number of letters in one file.
14490 type produces a new letter using the same addressee and a
14494 type produces a new addressee.
14511 are ordinary paragraph types and can also be used several times in one
14512 and the same letter.
14515 \begin_layout Itemize
14520 : produces a paragraph for the addressee and implicitly defines the beginning
14524 \begin_layout Itemize
14529 : produces a paragraph for the form of address and implicitly produces a
14533 \begin_layout Itemize
14538 : produces a paragraph for a close.
14541 \begin_layout Itemize
14546 : produces a paragraph for a postscript.
14549 \begin_layout Itemize
14554 : produces a paragraph for a distribution list.
14557 \begin_layout Itemize
14562 : produces a paragraph for enclosures.
14565 \begin_layout Standard
14606 are input types provided with a label to enter information, which will
14607 be processed by the document class.
14611 \begin_layout Plain Layout
14612 It could be seen as a matter of inconsequence, that the types
14620 described above are not such input types as well.
14621 Because of the special meaning of those types, however, I have implemented
14622 them as ordinary paragraph types with a one letter mark in the left margin.
14623 Moreover, it would affect my feeling of symmetry, if the
14631 type had such a serious different appearance.
14636 The types must be used ahead of the corresponding
14643 \begin_layout Standard
14644 An implementation of these types in a WYSIWYG fashion does not seem to make
14645 sense, because the real appearance of the produced letter does not only
14646 depend on the usage of the particular type, but also on other factors.
14647 For example, a signature entered in the
14651 type will in the standard behavior appear in the produced letter only,
14652 when in the same letter also a
14657 The entered value of the
14661 type will in the standard behavior not appear in the produced letter at
14663 The possibility to design the letter`s heading freely is already indicated
14664 in a footnote above.
14667 \begin_layout Standard
14668 The input types can also be used as empty paragraphs.
14669 This makes sense e.
14670 \begin_inset space \thinspace{}
14674 \begin_inset space \space{}
14686 type is not used at all, in the standard behavior the value of the
14690 type is used as signature, whereas if an empty
14694 type is used, no signature value is defined.
14697 \begin_layout Standard
14698 By using the input types it is possible to write a letter template, containing
14699 filled input types with your personal dates (name, address, etc.) and empty
14700 input types for other dates you want to enter.
14703 \begin_layout Itemize
14708 : sender's name, in the standard behavior appears as a centered paragraph
14709 in small caps in the letter`s heading.
14712 \begin_layout Itemize
14717 : sender's signature, in the standard behavior appears below the
14726 type is used, the value of the
14730 type appears instead.
14733 \begin_layout Itemize
14738 : sender's address, in the standard behavior appears in a centered paragraph
14739 in the letter`s heading below the sender's name.
14742 \begin_layout Itemize
14747 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14758 \begin_layout Itemize
14763 : place of the letter`s making.
14766 \begin_layout Itemize
14771 : date of the letter`s making.
14780 , in the standard behavior, produce the place and the date in a right-aligned
14781 line below the addressee's field.
14786 type is used, neither place nor date appear, independent of the value of
14796 type is used, the date of the letter `s production is used.
14799 \begin_layout Itemize
14804 : sender`s back address, in the standard behavior appears above the addressee's
14805 field in a small sans serif font.
14808 \begin_layout Itemize
14813 : special mail information, in the standard behavior appears underlined
14814 above the addressee's field below the back address.
14817 \begin_layout Itemize
14822 : additional information, in the standard behavior appears on right side
14823 below the addressee`s field.
14826 \begin_layout Itemize
14831 : the letter's title, in the standard behavior appears in a big, bold, sans
14832 serif font above the subject.
14835 \begin_layout Itemize
14840 : the letter's subject, in the standard behavior appears in a bold font
14848 \begin_layout Standard
14869 produce a business letter like line above the
14873 line containing the fields
14874 \begin_inset Quotes eld
14878 \begin_inset Quotes erd
14882 \begin_inset Quotes eld
14886 \begin_inset Quotes erd
14890 \begin_inset Quotes eld
14894 \begin_inset Quotes erd
14898 \begin_inset Quotes eld
14902 \begin_inset Quotes erd
14906 \begin_inset Quotes eld
14910 \begin_inset Quotes erd
14914 \begin_inset Quotes eld
14918 \begin_inset Quotes erd
14922 For the date field, the value of the
14928 \begin_inset Quotes eld
14931 business letter types
14932 \begin_inset Quotes erd
14935 is used, the value of the
14939 type however does not appear, but only the \SpecialChar LaTeX
14947 The ordinary output of place and date in a right-aligned line below the
14948 addressee`s field is suppressed.
14949 The types are implemented as input types provided with a label and must
14950 be used ahead of the corresponding
14957 \begin_layout Itemize
14965 \begin_layout Itemize
14973 \begin_layout Itemize
14981 \begin_layout Itemize
14989 \begin_layout Itemize
14997 \begin_layout Subsection
14998 The new letter class: letter (koma-script v.2)
15001 \begin_layout Standard
15007 \begin_layout Standard
15008 \begin_inset VSpace medskip
15014 \begin_layout Standard
15016 Koma-Script version 2.8 has introduced a new letter class
15020 which supersedes the now unsupported
15025 It has — on the \SpecialChar LaTeX
15026 side — a completely new interface and is not compatible
15027 with the old class.
15028 Therefore, \SpecialChar LyX
15029 supports both, though it is recommended you use the new class.
15032 \begin_layout Standard
15033 This class covers the same functionality as
15035 letter (koma-script),
15038 The basic items are
15042 (receiver's address, same as
15046 in the old layout),
15059 will start a new letter (i.
15060 \begin_inset space \thinspace{}
15064 \begin_inset space \space{}
15067 you can write several letters per document).
15068 New elements are sender's
15084 and the possibility to use a
15090 Insert\SpecialChar menuseparator
15096 \begin_layout Standard
15097 The biggest improvement is, though, that the letter's layout is configurable
15098 to meet almost any needs.
15099 This can be done via the preamble or with a special style file (Letter
15100 Class Option, extension
15104 ), that will be read in as a class option.
15108 \begin_layout Plain Layout
15109 The KOMA package comes with some default
15114 There is, for instance, a
15118 file that follows german typesetting rules, or a
15122 that provides the default layout of the old
15127 The latter can be loaded with the class option
15136 ayout\SpecialChar menuseparator
15141 ocument\SpecialChar menuseparator
15153 template that is included in \SpecialChar LyX
15155 A detailed description is to be found in the Koma-Script documentation
15163 \begin_layout Subsection
15167 \begin_layout Standard
15168 Visualizing the Koma-Script document classes in \SpecialChar LyX
15169 , the \SpecialChar LyX
15170 internals cause some
15174 \begin_layout Itemize
15175 The chapter number of a
15179 type appears on a line of its own above the chapter heading instead of
15180 appearing in the same line ahead of it.
15181 The cause for that is the \SpecialChar LyX
15182 internal behavior for the labeltype
15186 in the layout file.
15189 \begin_layout Itemize
15190 The headings of the types
15198 are only put in the
15199 \begin_inset Quotes eld
15203 \begin_inset Quotes erd
15207 table of contents, but not in the \SpecialChar LyX
15208 table of contents (
15210 Document\SpecialChar menuseparator
15212 \begin_inset space ~
15216 \begin_inset space ~
15224 \begin_layout Itemize
15225 The paragraphs in a
15229 document class appear in a skip separation mode, not indented.
15230 This is the standard behavior, no special \SpecialChar LaTeX
15231 commands are needed for that.
15234 Document\SpecialChar menuseparator
15237 dialog the corresponding radio button indicates
15246 value always has the effect that extra \SpecialChar LaTeX
15247 commands are inserted in the document
15248 to produce the gap, which is not what is wanted in this case.
15251 \begin_layout Section
15255 \begin_layout Standard
15261 \begin_layout Subsection
15265 \begin_layout Standard
15266 Memoir is a very powerful and constantly evolving class.
15267 It has been designed with regard to fictional and non-fictional literature.
15268 Its aim is to let the user have maximum control over the typesetting of
15270 Memoir is based on the standard book class, but it can also emulate the
15271 article class (see below).
15274 \begin_layout Standard
15275 Peter Wilson, the developer of Memoir, is known as the author of lots of
15276 useful packages in the \SpecialChar LaTeX
15278 Most of them have been merged with Memoir.
15279 Therefore, it is much easier to layout the table of contents, appendices,
15280 chapter designs and such.
15282 , though, does not support all of these goodies natively.
15283 Some of them might be added to forthcoming releases
15287 \begin_layout Plain Layout
15288 You are invited to send suggestions to
15289 \begin_inset Flex URL
15292 \begin_layout Plain Layout
15294 lyx-devel@lists.lyx.org
15304 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15306 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15308 commands (\SpecialChar TeX
15313 \begin_layout Plain Layout
15318 \begin_layout Plain Layout
15328 \begin_inset space ~
15332 \begin_inset CommandInset ref
15334 reference "sec:Inserting-TeX-Code"
15344 In this section, we can only list those features that are natively supported
15345 by \SpecialChar LyX
15347 For detailed descriptions (and for the rest of features) we recommend you
15348 have a look at the detailed manual of the Memoir class
15352 \begin_layout Plain Layout
15357 \begin_layout Plain Layout
15367 \begin_inset Flex URL
15370 \begin_layout Plain Layout
15372 CTAN:/macros/latex/memoir/memman.pdf
15382 , which is not only a user guide for the class, but also both a comprehensive
15383 description on good typesetting and a superb example for good typesetting
15387 \begin_layout Subsection
15388 Basic features and restrictions
15391 \begin_layout Standard
15392 Memoir supports basically all features of the standard book classes.
15393 There are, however, some differences, as follows:
15396 \begin_layout Description
15398 \begin_inset space ~
15401 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15404 \begin_layout Description
15406 \begin_inset space ~
15409 style: The fancy page style is not supported, due to a command clash between
15410 Memoir and the fancyhdr package (they both define a command with the same
15411 name, which confuses \SpecialChar LaTeX
15413 Instead, Memoir comes with a number of its own page styles (see
15415 Layout\SpecialChar menuseparator
15416 Document\SpecialChar menuseparator
15418 \begin_inset space ~
15424 If you want to use these for the chapter pages, you have to use the command
15431 in the main text or in preamble (e.
15432 \begin_inset space \thinspace{}
15436 \begin_inset space \space{}
15443 chapterstyle{companion}
15448 \begin_layout Description
15449 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15450 optional argument in the standard classes.
15451 With this, you can specify an alternative version of the title for the
15452 table of contents and the headers (for instance, if the title is too long).
15453 In \SpecialChar LyX
15454 , you can do this via
15456 Insert\SpecialChar menuseparator
15458 \begin_inset space ~
15463 at the beginning of a chapter/section.
15464 Memoir features a second optional argument and thus separates the table
15465 of contents from the header.
15466 You can define three variants of a title with this: one for the main text,
15467 one for the table of contents, and one for the headers.
15468 Simply insert two optional arguments if you need this feature, the first
15469 one containing the short title for the Table of Contents, the second one
15470 containing an alternative short title for the headers.
15473 \begin_layout Description
15474 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15475 of contents, the list of figures and the list of table start a new page
15477 Memoir does not follow this route.
15478 You have to insert a page break yourself, if you want to have one.
15481 \begin_layout Description
15482 Titlepage: For some unknown reason, Memoir uses pagination on the title
15483 page (in the standard classes, title pages are
15484 \begin_inset Quotes eld
15488 \begin_inset Quotes erd
15492 If you want an empty title page, type
15496 aliaspagestyle{title}{empty}
15501 \begin_layout Description
15502 Article: With the class option
15508 Layout\SpecialChar menuseparator
15509 Document\SpecialChar menuseparator
15511 \begin_inset space ~
15516 ), you can emulate article style.
15517 That is, counters (footnotes, figures, tables etc.) will not be reset on
15518 new chapters, chapters don't start a new page (but are—in contrary to
15519 \begin_inset Quotes eld
15523 \begin_inset Quotes erd
15526 article classes—still allowed), parts, though, use their own page, as in
15530 \begin_layout Description
15531 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15532 font commands, which have been used in the old \SpecialChar LaTeX
15534 \begin_inset space \thinspace{}
15538 \begin_inset space \space{}
15554 It produces an error and stops \SpecialChar LaTeX
15555 whenever such a command appears.
15560 reallows the commands and spits out warnings instead (which does at least
15561 not stop \SpecialChar LaTeX
15563 Since a lot of packages and particularly Bib\SpecialChar TeX
15564 style files are still using
15565 those commands, we have decided to use this option by default.
15568 \begin_layout Subsection
15572 \begin_layout Standard
15573 We will only describe the features supported by \SpecialChar LyX
15574 (which is not much currently).
15575 Please consult the Memoir manual
15579 \begin_layout Plain Layout
15584 \begin_layout Plain Layout
15594 \begin_inset Flex URL
15597 \begin_layout Plain Layout
15599 CTAN:/macros/latex/memoir/memman.pdf
15612 \begin_layout Description
15613 Abstract: You may wonder why an abstract is an extra feature.
15614 Well, it is in book class.
15615 Usually books don't have abstracts.
15616 Memoir, however, has.
15617 You can use it wherever and how often you like.
15620 \begin_layout Description
15621 Chapterprecis: You may know this older typesetting style: The contents of
15622 a chapter are summarized below the title and also in the table of contents
15624 \begin_inset space \thinspace{}
15628 \begin_inset space \space{}
15633 Our hero arrives in Troia; he loses some friends; he finds others
15636 Chapterprecis does exactly this.
15637 It is therefore only sensible below a chapter.
15640 \begin_layout Description
15641 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15642 The epigraph environment provides an elegant way of typesetting such a
15644 The motto itself (text) and its author (source) are divided by a short
15646 Unfortunately, we have to fool \SpecialChar LyX
15647 a bit here again, since the environment
15648 needs two arguments (text and source).
15649 In this case, we have to use curly brackets (in \SpecialChar TeX
15650 mode) between the two
15661 <author of the slogan>.
15664 \begin_layout Description
15665 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15666 complex figurative poems).
15668 can only support a few of them.
15669 One is poemtitle, which is a centered title for poems, which will also
15670 be added to the table of contents (verse is the standard environment for
15672 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15674 because they have to be nested inside regular verse environments, which
15675 is not possible with \SpecialChar LyX
15679 \begin_layout Description
15680 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15683 \begin_layout Section
15684 Article (mwart), book (mwbk) and report (mwrep)
15685 \begin_inset Argument status
15688 \begin_layout Plain Layout
15701 \begin_layout Standard
15707 \begin_layout Standard
15708 The \SpecialChar LyX
15725 correspond to the \SpecialChar LaTeX
15739 They are replacements for the standard document classes
15751 , resp., and fit better to Polish typography conventions in a number of points.
15755 \begin_layout Standard
15759 \begin_layout Itemize
15760 Unnumbered titles (with star, e.
15761 \begin_inset space \thinspace{}
15765 \begin_inset space \space{}
15772 ) are added into table of contents,
15775 \begin_layout Itemize
15776 Additional page styles:
15777 \begin_inset Separator parbreak
15784 \begin_layout Description
15785 uheadings header with separated lines,
15788 \begin_layout Description
15789 myheadings custom header, contents headers via commands:
15804 \begin_layout Description
15805 myuheadings custom header with separated lines,
15808 \begin_layout Description
15809 outer page number is placed on outer side of page
15813 \begin_layout Itemize
15815 \begin_inset Separator parbreak
15822 \begin_layout Description
15823 rmheadings serif titles — default,
15826 \begin_layout Description
15827 sfheadings sansserif titles,
15830 \begin_layout Description
15831 authortitle on title page first placed is author next title — default,
15834 \begin_layout Description
15835 titleauthor on title page first placed is title next author,
15838 \begin_layout Description
15839 withmarginpar reserve place on page for margins.
15843 \begin_layout Section
15847 \begin_layout Standard
15852 provides an alternative to the standard
15857 It provides similar functionality, but you might prefer this layout with
15858 sans serif sections, headings, and more.
15861 \begin_layout Section
15862 Rev\SpecialChar TeX
15866 \begin_layout Standard
15872 \begin_layout Standard
15873 \begin_inset VSpace bigskip
15879 \begin_layout Standard
15884 \begin_inset space ~
15889 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
15891 \begin_inset Formula $\beta$
15894 release of May, 1999) class.
15897 \begin_layout Standard
15903 textclass, which works with Rev\SpecialChar TeX
15905 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
15907 That means that it doesn't interact very well with \SpecialChar LyX
15908 , which requires \SpecialChar LaTeX2e
15910 it has been kludged to work.
15911 Since Rev\SpecialChar TeX
15912 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
15917 Rev\SpecialChar TeX
15919 \begin_inset space ~
15924 textclass should also be pretty easy to use.
15927 \begin_layout Standard
15928 These documents are supposed to be used in
15932 to the Rev\SpecialChar TeX
15933 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
15935 and assume you'll know what to put in the preamble if necessary.
15938 \begin_layout Subsection
15942 \begin_layout Standard
15943 All you need to do is install Rev\SpecialChar TeX
15944 4, as described in the package's README
15946 The package can be found at The Rev\SpecialChar TeX
15948 \begin_inset Flex URL
15951 \begin_layout Plain Layout
15953 http://publish.aps.org/revtex4/
15959 Install it somewhere that \SpecialChar LaTeX
15961 Test it by trying to \SpecialChar LaTeX
15962 a short Rev\SpecialChar TeX
15963 4 document in some random directory (i.
15964 \begin_inset space \thinspace{}
15968 \begin_inset space \space{}
15971 not the directory where you installed the class file.) Then, if you reconfigure
15973 , it will find the class file and let you use the Rev\SpecialChar TeX
15977 \begin_layout Standard
15978 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
15987 \begin_inset space ~
15992 template, found in the templates directory.
15995 \begin_layout Subsection
15999 \begin_layout Standard
16000 Optional arguments to
16007 \begin_inset Quotes eld
16011 \begin_inset Quotes erd
16015 \begin_inset Quotes eld
16019 \begin_inset Quotes erd
16029 \begin_inset space ~
16037 \begin_inset space ~
16043 Remember that in Rev\SpecialChar TeX
16044 , at least one optional argument is required!
16047 \begin_layout Standard
16048 Other preamble matter, like
16055 \begin_inset space ~
16062 \begin_inset space ~
16067 dialog, also as usual.
16070 \begin_layout Subsection
16074 \begin_layout Standard
16075 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16077 For example, the Email layout corresponds to
16084 Note that (at least as of Rev\SpecialChar TeX
16093 layouts are exactly equivalent, so you shouldn't need to use both.
16097 \begin_layout Plain Layout
16098 In case you're curious, both were included so that
16102 would be able to translate both
16122 \begin_layout Subsection
16126 \begin_layout Standard
16127 There are a couple of important unique aspects of Rev\SpecialChar TeX
16128 4 which might cause
16129 bugs that will be even more confusing in \SpecialChar LyX
16133 \begin_layout Standard
16134 In Rev\SpecialChar TeX
16152 The \SpecialChar LyX
16153 equivalent is that there is a separate Thanks layout.
16158 write footnotes in the
16162 layout, or weird things may happen.
16163 See the Rev\SpecialChar TeX
16164 4 documentation for more details.
16167 \begin_layout Standard
16171 \begin_inset space ~
16179 \begin_inset space ~
16188 layouts must be placed
16196 layout and the corresponding
16213 , the \SpecialChar LaTeX
16217 \begin_layout Subsection
16221 \begin_layout Standard
16222 The main problem with this layout is that you can't use the optional arguments
16223 to layouts like Email and Title.
16224 (The problem is not unique to this layout; you can't use optional arguments
16225 to the Section layouts either.) This means that after you export that file
16226 to \SpecialChar LaTeX
16227 (which you'll need to do eventually to send it in to APS), you'll need
16228 to edit the \SpecialChar LaTeX
16229 file with a text editor to add the optional arguments to set,
16231 \begin_inset space \thinspace{}
16235 \begin_inset space \space{}
16238 the running title for the page headers.
16239 Lacking these layouts makes the
16245 (and the equivalent
16251 ) useless, so the corresponding layouts don't exist, and will have to be
16256 \begin_layout Plain Layout
16261 actually, \SpecialChar LyX
16262 1.3.0 supports some forms of optional arguments, but this layout
16263 has not been updated yet to take advantage of it.
16271 \begin_layout Section
16272 Springer Journals (
16279 \begin_layout Standard
16285 \begin_layout Subsection
16289 \begin_layout Standard
16290 These are the layout files for some of the journal formats used by Springer
16291 Verlag and listed on
16292 \begin_inset Flex URL
16295 \begin_layout Plain Layout
16297 http://www.springer.de/author/tex/help-journals.html
16302 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16304 It is a modular system: the things common to all journals are implemented
16309 , which journal-specific layout files (such as, e.
16310 \begin_inset space \thinspace{}
16314 \begin_inset space \space{}
16321 for Journal of Geodesy) can include.
16324 \begin_layout Standard
16325 This means that implementing support for any other Springer journal on this
16326 list is as simple as writing your own
16334 file following the outline given in
16342 \begin_layout Standard
16343 It is reasonably well tested only for the Journal of Geodesy.
16352 come with the standard \SpecialChar LyX
16354 Install the relevant class file (downloaded from Springer) in a proper
16355 directory, reconfigure \SpecialChar LaTeX
16356 (in the te\SpecialChar TeX
16361 , as root if necessary — doesn't \SpecialChar LyX
16362 take care of this?), reconfigure \SpecialChar LyX
16367 \begin_layout Subsection
16371 \begin_layout Standard
16372 A large number of theorem-like styles —
16384 \begin_layout Standard
16387 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16388 _Title, Author_Running, Institute,
16389 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16392 See the Springer class file documentation for details.
16395 \begin_layout Subsection
16399 \begin_layout Itemize
16411 \begin_layout Itemize
16414 Probability Theory and Related Fields
16420 — Jean-Marc Lasgouttes
16423 \begin_layout Standard
16424 Add your own, it isn't so hard!
16427 \begin_layout Subsection
16431 \begin_layout Standard
16432 These files are partly based on the older
16436 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16438 file from Springer.
16443 layout, are now defunct.
16444 Jean-Marc Lasgouttes helped out big in making me find my way around the
16446 layout file mechanism.
16449 \begin_layout Subsection
16453 \begin_layout Standard
16455 But probably less than in the old hacked-\SpecialChar LaTeX
16463 \begin_layout Standard
16465 \begin_inset space \thinspace{}
16468 g.: does not display the number for theorem-like layouts, just #.
16471 \begin_layout Section
16474 Sli\SpecialChar TeX
16478 \begin_inset CommandInset label
16487 \begin_layout Standard
16495 \begin_layout Subsection
16499 \begin_layout Standard
16500 This section describes how to use \SpecialChar LyX
16501 to make slides for overhead projectors.
16502 There are two document classes that can do this: the default slides class
16505 Foil\SpecialChar TeX
16509 This section documents the former.
16512 \begin_layout Standard
16513 I'm going to say this again, nice and clear, so that there's no misunderstanding
16517 \begin_layout Standard
16518 \begin_inset VSpace bigskip
16524 \begin_layout Standard
16528 This section documents the class
16529 \begin_inset Quotes eld
16537 \begin_inset Quotes erd
16545 \begin_layout Standard
16546 \begin_inset VSpace bigskip
16552 \begin_layout Standard
16553 If you're looking for the documentation for
16554 \begin_inset Quotes eld
16559 slides (Foil\SpecialChar TeX
16563 \begin_inset Quotes erd
16566 , check out section
16567 \begin_inset space ~
16571 \begin_inset CommandInset ref
16573 reference "sec:foiltex"
16583 \begin_inset Quotes eld
16588 slides (Foil\SpecialChar TeX
16592 \begin_inset Quotes erd
16595 ] is actually somewhat better than the default
16603 \begin_layout Plain Layout
16605 or so I've been told repeatedly by its advocates.
16606 Having never used it, I have no idea if this claim is true or not.
16611 which this section documents.
16614 \begin_layout Standard
16615 This class is the \SpecialChar LaTeX2e
16616 improvement of the old
16618 Sli\SpecialChar TeX
16622 Every \SpecialChar LaTeX2e
16623 distribution includes this class [which I'll just refer to as
16624 \begin_inset Quotes eld
16632 \begin_inset Quotes erd
16635 from now on], so you're bound to have it.
16636 As I noted earlier, there are other classes, such as
16640 , which also produce slides for overhead projectors and do a better job
16642 However, there are some things which
16646 can do which the others can't, such as generate overlays.
16647 Read on to learn more!
16650 \begin_layout Subsection
16652 \begin_inset CommandInset label
16654 name "sec:slidesetup"
16661 \begin_layout Standard
16662 Obviously, to use this document class, you need to select
16663 \begin_inset Quotes eld
16671 \begin_inset Quotes erd
16674 from the class list in the
16676 Document\SpecialChar menuseparator
16680 There are some other special things you should know about this class:
16683 \begin_layout Itemize
16684 Don't bother changing the options
16689 They're not supported by the
16696 \begin_layout Itemize
16700 \begin_inset space ~
16705 behaves a bit differently for this class.
16706 The possible choices and what they do are as follows:
16707 \begin_inset Separator parbreak
16714 \begin_layout Description
16719 The final output contains page numbers in the lower right corner.
16722 \begin_layout Description
16731 , but also prints out any time markers you've put in.
16732 This is the default.
16735 \begin_layout Description
16740 The final output contains no page numbers, time markers, or alignment markers.
16744 \begin_layout Itemize
16749 class has an extra option:
16755 \begin_inset Quotes eld
16763 \begin_inset Quotes erd
16766 in the extra class options.
16767 \begin_inset Separator parbreak
16774 \begin_layout Standard
16775 Using this options allows you to add time markers to
16781 \begin_inset space ~
16785 \begin_inset CommandInset ref
16787 reference "sec:slideNote"
16795 \begin_layout Standard
16796 You can also use the template file
16797 \begin_inset Quotes eld
16805 \begin_inset Quotes erd
16808 to automatically set up a document to use the
16814 File\SpecialChar menuseparator
16816 \begin_inset space ~
16820 \begin_inset space ~
16825 to open your new document].
16826 The template file also contains some examples of the special paragraph
16827 environments used by this class.
16828 I'll describe those next.
16831 \begin_layout Subsection
16832 Paragraph Environments
16835 \begin_layout Subsubsection
16836 Supported Environments
16839 \begin_layout Standard
16840 The first thing you'll notice when you start up a new
16844 document is the font size and type: it's the equivalent of the size
16845 \begin_inset Quotes eld
16853 \begin_inset Quotes erd
16859 \begin_inset space ~
16865 This is also what's used in the output.
16867 \begin_inset Quotes eld
16871 \begin_inset Quotes erd
16874 to remind you that this is a slide.
16875 Your final slides will use a larger font; ergo, you'll have less space.
16876 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16879 \begin_layout Standard
16880 The next thing that becomes obvious is the changes to the paragraph environment
16881 pull-down box [at the far-left end of the toolbar].
16882 Most of the paragraph environments you're used to seeing are missing.
16883 There are also five new ones.
16888 class itself only supports certain paragraph environments:
16891 \begin_layout Itemize
16897 \begin_layout Itemize
16903 \begin_layout Itemize
16909 \begin_layout Itemize
16915 \begin_layout Itemize
16921 \begin_layout Itemize
16927 \begin_layout Itemize
16933 \begin_layout Itemize
16939 \begin_layout Itemize
16945 \begin_layout Itemize
16952 \begin_layout Itemize
16958 \begin_layout Standard
16959 All of the other standard environments, including the section-heading environmen
16960 ts, aren't used in the
16967 \begin_layout Standard
16968 On the other hand, you'll notice the following new environments:
16971 \begin_layout Itemize
16977 \begin_layout Itemize
16983 \begin_layout Itemize
16989 \begin_layout Itemize
16995 \begin_layout Itemize
17001 \begin_layout Standard
17002 These five are kind of quirky, due to a
17003 \begin_inset Quotes eld
17007 \begin_inset Quotes erd
17010 in \SpecialChar LyX
17012 You see, \SpecialChar LyX
17013 doesn't permit you to nest any other paragraph environment into
17014 an empty environment.
17015 Now, that's fine and dandy, but it means that you wouldn't be able to start
17016 a slide with anything except plain text.
17017 To deal with this, I've performed a little
17018 \begin_inset Quotes eld
17023 \begin_inset Quotes erd
17029 \begin_layout Subsubsection
17030 Quirks of the New Environments
17031 \begin_inset CommandInset label
17033 name "sec:slideQuirk"
17040 \begin_layout Standard
17041 All five of the new paragraph environments are somewhat quirky due to inherent
17042 limitiations in the current version of \SpecialChar LyX
17044 As I just mentioned, \SpecialChar LyX
17045 forbids environments that begin with another environment.
17046 To get around this, the
17050 environment isn't a paragraph environment as described in the
17058 \begin_layout Standard
17059 You should consider
17072 \begin_inset Quotes eld
17075 pseudo-environments.
17076 \begin_inset Quotes erd
17079 They look like a section heading or a
17080 \begin_inset Quotes eld
17088 \begin_inset Quotes erd
17091 but really begin a [and, if necessary, end the previous] paragraph environment.
17101 \begin_inset Quotes eld
17105 \begin_inset Quotes erd
17108 These two perform some action.
17111 \begin_layout Standard
17112 A common feature of all five environments,
17132 , is a rather long-ish label.
17133 The text following this label — ordinarily the contents of the paragraph
17134 environment — is utterly irrelevant for
17156 completely ignores it.
17157 In fact, you can leave these five environments completely empty.
17161 \begin_layout Standard
17166 to put any text after the rather long-ish label, you might want to.
17167 This could be a short description of the contents of the
17172 In that case, enter your descriptive comment and hit
17176 as you normally would.
17179 \begin_layout Standard
17180 If, on the other hand, you don't want to enter any descriptive text, you'll
17181 hit another \SpecialChar LyX
17184 , like nature, abhors a vacuum, and will not let you start a new paragraph
17185 environment until you put something in the old one.
17189 \begin_layout Itemize
17190 Start entering the text that will
17218 \begin_layout Itemize
17219 Now move to the beginning of that paragraph.
17223 \begin_layout Itemize
17232 \begin_layout Itemize
17233 Finally, change this new, empty paragraph to a
17257 \begin_layout Standard
17258 Some future version of \SpecialChar LyX
17259 will, hopefully, resolve this quirkiness\SpecialChar ldots
17263 \begin_layout Subsection
17264 Making a Presentation with
17277 \begin_layout Subsubsection
17285 \begin_layout Standard
17286 If you're expecting this section to teach you how to actually make a presentatio
17287 n, you'll be sorely disappointed.
17288 Naturally, I'll describe all of the ways the
17292 class can assist you in preparing the materials for a presentation.
17293 Filling in the contents, however, is up to you.
17298 the \SpecialChar LyX
17302 \begin_layout Standard
17307 environment [in the manner described in section
17308 \begin_inset space ~
17312 \begin_inset CommandInset ref
17314 reference "sec:slideQuirk"
17318 ] tells \SpecialChar LyX
17319 to begin a new slide [duh].
17320 The label for this environment/
17321 \begin_inset Quotes erd
17325 \begin_inset Quotes erd
17329 \begin_inset Quotes eld
17333 \begin_inset Quotes erd
17336 in cool blue, followed by the label,
17337 \begin_inset Quotes eld
17341 \begin_inset Quotes erd
17345 Any text or paragraph environments that follow this one go on the new slide.
17349 \begin_layout Standard
17350 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17352 (this can be specified in the
17357 In fact, you'll want to, once you finish entering the contents of one slide.
17358 If you've entered more text than can physically fit on a slide, the extra
17359 overflows onto a new slide.
17360 I don't recommend doing this, however, since the overflow slide won't have
17361 any page number on it.
17362 Furthermore, it may interfere with any
17366 you've made to accompany the oversized
17373 \begin_layout Standard
17382 environments work the same way as the
17387 They both create an
17388 \begin_inset Quotes eld
17392 \begin_inset Quotes erd
17395 followed by a label [
17396 \begin_inset Quotes eld
17400 \begin_inset Quotes erd
17404 \begin_inset Quotes eld
17408 \begin_inset Quotes erd
17412 The color is a stunning magenta instead of blue, and the
17413 \begin_inset Quotes eld
17417 \begin_inset Quotes erd
17420 will look different, in style and in length.
17421 The label fonts of all three also differ from one another.
17424 \begin_layout Standard
17429 , if the contents of a
17437 exceed the physical size of a slide or sheet of paper, the extra will overflow
17439 Again, you should avoid this.
17440 It defeats the whole purpose of
17451 \begin_layout Subsubsection
17461 \begin_layout Standard
17466 is a slide that sits atop another slide.
17467 Perhaps you wish to discuss a figure on the main
17471 before displaying the text associated with it.
17472 One way to accomplish this is tape a flap of dark paper over the part of
17477 you want to display later.
17478 This method fails, however, if you wish to overlap one graph with another,
17480 You would then have to fumble while speaking to align the two separate,
17485 s to align the two graphs.
17490 environment in both cases makes life much easier.
17493 \begin_layout Standard
17498 receives the page number of its
17499 \begin_inset Quotes eld
17503 \begin_inset Quotes erd
17511 \begin_inset Quotes eld
17519 \begin_inset Quotes erd
17526 \begin_layout Plain Layout
17527 Presumably, mutliple
17532 \begin_inset Quotes eld
17540 \begin_inset Quotes erd
17544 \begin_inset Quotes eld
17552 \begin_inset Quotes erd
17556 \begin_inset Quotes eld
17564 \begin_inset Quotes erd
17568 \begin_inset space ~
17571 appended to the page number of the parent
17581 Clearly, you want the contents of both the
17589 to each fit on a single physical slide! You should probably consider an
17595 \begin_inset Quotes eld
17599 \begin_inset Quotes erd
17607 Indeed, the \SpecialChar LyX
17612 class provides a visual cue for this: the label at the start of an
17616 is shorter than that at the start of a
17621 Lastly, when you generate printable output, you'll find alignment markers
17622 in all four corners of both the
17626 page and its parent
17631 These will assist you in lining up the two physical slides.
17634 \begin_layout Standard
17635 The major problem in overlaying two slides is aligning the contents of the
17636 two transparencies.
17637 How much space should you leave for that graph on the second slide? Worse
17638 still, what if you want a graph and a sentence on second slide, but there
17639 is text on the main transparency that goes in between them? You could try
17640 and insert vertical space of the right size.
17641 The better way is to use
17652 \begin_layout Standard
17653 As their names imply,
17661 are two command-like paragraph environments that make all subsequent text
17662 invisible and visible, respectively.
17664 \begin_inset space ~
17668 \begin_inset CommandInset ref
17670 reference "sec:slideQuirk"
17674 that you don't place anything
17678 these two environments, however.
17683 , it inserts a centered, sky-blue label into the page reading
17684 \begin_inset Quotes eld
17687 <Invisible Text Follows>
17688 \begin_inset Quotes erd
17692 For paragraphs following this label, the parts of the
17700 ; it doesn't matter which] where they would be contain instead blank space.
17704 \begin_layout Standard
17709 , the corresponding centered label is
17710 \begin_inset Quotes eld
17713 <Visible Text Follows>
17714 \begin_inset Quotes erd
17718 Paragraphs following this label behave normally.
17719 Note that the beginning of a new
17731 automatically shuts off an
17736 It's therefore not necessary to use
17747 \begin_layout Standard
17748 By now, it should be obvious how to create overlay transparencies using
17749 the proper combination of
17768 \begin_layout Enumerate
17773 , including everything that will appear on it, whether on the main slide
17781 \begin_layout Enumerate
17782 Before each figure or paragraph that will appear only on the
17791 If necessary, insert a
17795 environment after the
17802 \begin_layout Enumerate
17807 immediately following the
17814 \begin_layout Enumerate
17815 Copy the contents of this
17826 \begin_layout Enumerate
17831 , change all of the
17842 \begin_layout Standard
17844 You've just made an
17851 \begin_layout Standard
17852 There's one problem with the way I've designed the \SpecialChar LyX
17857 class: you can't make text in the middle of a paragraph invisible, nor
17858 make text in the middle of an invisible paragraph visible again.
17859 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
17864 \begin_layout Plain Layout
17865 The commands of interest are:
17868 \begin_layout Itemize
17873 invisible \SpecialChar ldots
17877 \begin_layout Itemize
17882 visible \SpecialChar ldots
17886 \begin_layout Plain Layout
17888 and need to be marked as \SpecialChar TeX
17891 \begin_inset Quotes eld
17895 \begin_inset Quotes erd
17898 you wish to change goes in between the brackets [and after the
17911 If you don't know how to mark text as \SpecialChar TeX
17912 , see the appropriate section of
17925 \begin_layout Subsubsection
17935 \begin_inset CommandInset label
17937 name "sec:slideNote"
17944 \begin_layout Standard
17953 is associated with a
17954 \begin_inset Quotes eld
17958 \begin_inset Quotes erd
17966 Here, too, the \SpecialChar LyX
17971 class provides visual cues.
17976 is shorter than that of a
17980 [yet longer than that of an
17984 ] and, like the label of an
17988 is shockingly magenta.
17989 Additionally, the printed
17993 has the page number of its
17994 \begin_inset Quotes eld
17998 \begin_inset Quotes erd
18006 \begin_inset Quotes eld
18014 \begin_inset Quotes erd
18018 \begin_inset Quotes eld
18026 \begin_inset Quotes erd
18030 \begin_inset Quotes eld
18038 \begin_inset Quotes erd
18042 You can have multiple
18046 s associated with a single
18058 , you'll probably want to break up long
18062 s so that they fit on a single sheet of paper.
18065 \begin_layout Standard
18070 is obvious: it contains anything additional you might want to say about
18076 It could also be used as a sheet of reminders for a particular
18081 In the case of the latter, you might want to make use of time markers.
18082 Currently, the \SpecialChar LyX
18088 \begin_inset Quotes eld
18092 \begin_inset Quotes erd
18095 support for time markers, a
18097 Sli\SpecialChar TeX
18101 So, you'll have to resort to using the \SpecialChar LaTeX
18105 \begin_layout Standard
18106 To use time markers, you'll need to specify the extra class option
18107 \begin_inset Quotes eld
18115 \begin_inset Quotes erd
18119 \begin_inset space ~
18123 \begin_inset CommandInset ref
18125 reference "sec:slidesetup"
18130 This option turns on timing marks, which will appear in the lower-left-hand
18136 To set what appears in the time marker, you use the \SpecialChar LaTeX
18138 \begin_inset Quotes eld
18148 \begin_inset Quotes erd
18152 \begin_inset Quotes eld
18162 \begin_inset Quotes erd
18166 The arguments of both commands are time measured in seconds.
18168 \begin_inset Quotes eld
18178 \begin_inset Quotes erd
18181 sets the time marker to a given time.
18183 \begin_inset Quotes eld
18193 \begin_inset Quotes erd
18196 increments the time marker by the specified amount.
18197 Using time markers and
18201 s in this fashion, you can remind yourself how much time to spend on a particula
18209 \begin_layout Standard
18210 There's one last feature to describe.
18211 Clearly, you'd like to print out all of your
18219 s on transparencies while printing all of your
18236 with which it is associated.
18237 What's a person to do?
18240 \begin_layout Standard
18241 Luckily, there are two \SpecialChar LaTeX
18242 commands that allow you to select what to print
18244 Both must be placed into the preamble of your document.
18246 \begin_inset Quotes eld
18258 \begin_inset Quotes erd
18261 will cause the output to contain only the
18270 Correspondingly, the command
18271 \begin_inset Quotes eld
18283 \begin_inset Quotes erd
18286 prevents the output of anything but
18291 I'd advise placing both commands in the preamble and initially comment
18293 You can then preview your entire presentation as you write.
18294 When you're done writing, you can then uncomment one of the two to select
18295 what you want to print.
18296 I like to uncomment
18297 \begin_inset Quotes eld
18309 \begin_inset Quotes erd
18312 , print to a file with
18313 \begin_inset Quotes eld
18321 \begin_inset Quotes erd
18324 in its name, comment it back out, then uncomment
18325 \begin_inset Quotes eld
18337 \begin_inset Quotes erd
18341 \begin_inset Quotes eld
18349 \begin_inset Quotes erd
18353 I can then send either file to a printer, loading transparencies or plain
18354 paper as appropriate.
18357 \begin_layout Standard
18358 You can also provide other arguments to the
18359 \begin_inset Quotes eld
18369 \begin_inset Quotes erd
18373 \begin_inset Quotes eld
18383 \begin_inset Quotes erd
18387 See a good \SpecialChar LaTeX
18391 \begin_layout Subsection
18396 Class Template File
18399 \begin_layout Standard
18400 I have also provided a template file,
18401 \begin_inset Quotes eld
18409 \begin_inset Quotes erd
18417 To use it, begin your new presentation with
18422 ile\SpecialChar menuseparator
18424 \begin_inset space ~
18428 \begin_inset space ~
18438 Your new \SpecialChar LyX
18439 presentation file will contain an example
18460 additionally contain an example of the use of
18469 Lastly, the preamble will contain:
18472 \begin_layout LyX-Code
18473 % Uncomment to print out only slides and overlays
18476 \begin_layout LyX-Code
18480 \begin_layout LyX-Code
18486 \begin_inset Newline newline
18492 \begin_layout LyX-Code
18493 % Uncomment to print out only notes
18496 \begin_layout LyX-Code
18500 \begin_layout LyX-Code
18508 \begin_layout Standard
18509 One final thing: I created this class to support the \SpecialChar LaTeX2e
18511 \begin_inset Quotes eld
18516 Sli\SpecialChar TeX
18520 \begin_inset Quotes erd
18523 class, one of the built-in \SpecialChar LaTeX2e
18525 Neither I nor the rest of the \SpecialChar LyX
18526 Team endorse or oppose the use of this built-in
18528 It's here if you want it or need it.
18529 There exist other \SpecialChar LaTeX2e
18530 classes for creating presentations, such as the
18535 \begin_inset space ~
18539 \begin_inset CommandInset ref
18541 reference "sec:foiltex"
18546 \begin_inset Quotes eld
18554 \begin_inset Quotes erd
18557 package [present on some \SpecialChar TeX
18559 The latter is not yet supported under \SpecialChar LyX
18564 \begin_layout Plain Layout
18565 Perhaps you can take on the task\SpecialChar ldots
18571 I know nothing about these other classes.
18572 Try them out to see what sort of alternative they provide.
18575 \begin_layout Chapter
18577 Features needing Extra Software
18580 \begin_layout Section
18581 Checking \SpecialChar TeX
18585 \begin_layout Standard
18591 \begin_layout Subsection
18595 \begin_layout Standard
18604 \begin_layout Plain Layout
18609 is not yet available when you are using the \SpecialChar LaTeX
18610 distribution MiK\SpecialChar TeX
18616 , you'll find in the
18623 \begin_inset space ~
18634 \begin_inset Newline newline
18638 \begin_inset CommandInset href
18640 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18647 \begin_layout Standard
18650 Chk\SpecialChar TeX
18653 package is a program that was written by
18654 \begin_inset Flex Noun
18657 \begin_layout Plain Layout
18659 \begin_inset space ~
18667 in frustration because some constructs in \SpecialChar LaTeX
18668 are sometimes non-intuitive,
18669 and easy to forget.
18670 The program runs over your \SpecialChar LaTeX
18671 file, checks the integrity of the file, and
18672 flags some common errors.
18673 In other technical words, it is
18677 for \SpecialChar LaTeX
18681 \begin_layout Standard
18682 Well, what is a syntax checker doing in \SpecialChar LyX
18683 which is supposed to produce correct
18685 anyways? The answer is simple: Just as
18689 not only checks the
18693 of C programs, but also does
18697 checks for type-errors,
18699 Chk\SpecialChar TeX
18702 catches some common
18706 errors, in addition to the syntactical ones.
18709 Chk\SpecialChar TeX
18712 is capable of detecting several common errors, such as
18715 \begin_layout Itemize
18716 Ellipsis detection:
18717 \begin_inset Newline newline
18720 Use \SpecialChar ldots
18724 \begin_layout Itemize
18725 No space in front of/after parenthesis:
18726 \begin_inset Newline newline
18732 \begin_layout Itemize
18733 Enforcement of normal space after common abbreviations:
18734 \begin_inset Newline newline
18738 \begin_inset space \thinspace{}
18742 \begin_inset space \space{}
18745 is too wide spacing.
18748 \begin_layout Itemize
18749 Enforcement of end-of-sentence space when the last sentence ends with a
18751 \begin_inset Newline newline
18755 And this is wrong spacing.
18758 \begin_layout Itemize
18759 Space in front of labels and similar commands:
18760 \begin_inset Newline newline
18763 The label should stick right up to the text to avoid falling to a wrong
18766 \begin_inset CommandInset label
18776 \begin_layout Plain Layout
18777 This footnote is in danger of falling off to a wrong page
18782 The label is separated too much.
18785 \begin_layout Itemize
18786 Space in front of references, instead of hard spaces:
18787 \begin_inset Newline newline
18790 If you have bad luck, the text will break right between the referenced text
18791 and reference number, and that's a pity.
18793 \begin_inset CommandInset ref
18795 reference "sec:chktex"
18802 \begin_layout Itemize
18804 \begin_inset Quotes eld
18808 \begin_inset Quotes erd
18812 \begin_inset Formula $\times$
18816 \begin_inset Newline newline
18819 2x2 looks cheap compared to
18820 \begin_inset Formula $2\times2$
18826 \begin_layout Standard
18827 and more \SpecialChar ldots
18828 It is an invaluable tool when you are
18829 \begin_inset Quotes eld
18833 \begin_inset Quotes erd
18836 your document before printing, and you should run it right after the obligatory
18837 spelling check, and before you go fine tuning the typesetting.
18840 \begin_layout Subsection
18844 \begin_layout Standard
18845 If you have the program installed, usage is as simple as choosing
18847 Tools\SpecialChar menuseparator
18849 \begin_inset space ~
18855 This will make \SpecialChar LyX
18856 generate a \SpecialChar LaTeX
18857 file of your document, start
18859 Chk\SpecialChar TeX
18862 to check it, and then make \SpecialChar LyX
18864 \begin_inset Quotes eld
18868 \begin_inset Quotes erd
18871 with the warnings from
18873 Chk\SpecialChar TeX
18876 , if there were any.
18877 The warnings will be placed close to the point of the mistake, and you
18878 can quickly find them by using the
18880 Navigate\SpecialChar menuseparator
18883 menu item, or the shortcut key
18892 Open the error boxes by clicking on them with the mouse, or use the shortcut
18901 bindings, or the corresponding
18910 Read the warning and correct the mistake, if it is a mistake.
18911 If you have trouble understanding what the warning is about, you can safely
18913 Remember that there is a hidden layer between the document on screen and
18914 the technical details in invoking
18916 Chk\SpecialChar TeX
18919 , and this gap can make some warnings seem arcane or just plain silly.
18922 \begin_layout Standard
18923 This document is an excellent testing bed for the feature, and it should
18924 provide quite a few warnings for you to fiddle with.
18925 Since computers are only so smart, expect most of the warnings to be false
18929 \begin_layout Subsection
18930 How to fine tune it
18933 \begin_layout Standard
18934 Sometimes, you'll find that
18936 Chk\SpecialChar TeX
18939 makes more noise than suits your mood.
18940 Then you can choose not to use it, wait until your mood changes, or try
18943 Chk\SpecialChar TeX
18946 to get better along with you.
18949 \begin_layout Standard
18952 Chk\SpecialChar TeX
18959 very configurable and extensible, you should not expect to solve all problems
18962 Chk\SpecialChar TeX
18965 in \SpecialChar LyX
18967 Since \SpecialChar LyX
18968 has to generate a somewhat special \SpecialChar LaTeX
18969 file to be able to match the
18970 line numbers from the
18972 Chk\SpecialChar TeX
18979 \begin_layout Plain Layout
18980 You can inspect the specific output from
18986 Document\SpecialChar menuseparator
18989 \begin_inset space ~
19003 to the internal document structure, some of the warnings will not appear
19005 There are two things you can do about this:
19008 \begin_layout Itemize
19011 Chk\SpecialChar TeX
19014 invocation command line in
19015 \begin_inset Flex MenuItem
19018 \begin_layout Plain Layout
19019 Tools\SpecialChar menuseparator
19020 Preferences\SpecialChar menuseparator
19021 Output\SpecialChar menuseparator
19022 LaTeX\SpecialChar menuseparator
19030 Chk\SpecialChar TeX
19033 installation configuration file (usually with the file
19038 See below to learn what warnings can be enabled and disabled on the command
19042 \begin_layout Itemize
19043 Export your document as a raw \SpecialChar LaTeX
19046 File\SpecialChar menuseparator
19047 Export\SpecialChar menuseparator
19056 Invoked in this way, it can be a hassle to find the corresponding place
19057 in the document inside \SpecialChar LyX
19058 , but with a little patience, you should be able
19062 \begin_layout Standard
19063 Here follows the warning messages that can be enabled and disabled in
19072 to disable a warning, and
19076 to enable a warning.
19077 The emphasized entries are disabled by default, because the default is
19080 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19085 \begin_layout Standard
19086 Notice that you should only use the options that enable and disable warnings,
19087 because \SpecialChar LyX
19088 relies on some of the other command line parameters to be set
19089 in a specific way to have a chance to communicate with
19096 \begin_layout Enumerate
19100 Command terminated with space.
19103 \begin_layout Enumerate
19106 Non-breaking space (
19107 \begin_inset Quotes eld
19115 \begin_inset Quotes erd
19118 ) should have been used.
19121 \begin_layout Enumerate
19125 You should enclose the previous parenthesis with
19126 \begin_inset Quotes eld
19134 \begin_inset Quotes erd
19140 \begin_layout Enumerate
19143 Italic correction (
19144 \begin_inset Quotes eld
19154 \begin_inset Quotes erd
19157 ) found in non-italic buffer.
19160 \begin_layout Enumerate
19163 Italic correction (
19164 \begin_inset Quotes eld
19174 \begin_inset Quotes erd
19177 ) found more than once.
19180 \begin_layout Enumerate
19184 No italic correction (
19185 \begin_inset Quotes eld
19195 \begin_inset Quotes erd
19201 \begin_layout Enumerate
19205 \begin_inset Quotes eld
19213 \begin_inset Quotes erd
19217 \begin_inset Quotes eld
19225 \begin_inset Quotes erd
19231 \begin_layout Enumerate
19234 Wrong length of dash may have been used.
19237 \begin_layout Enumerate
19241 \begin_inset Quotes eld
19249 \begin_inset Quotes erd
19253 \begin_inset Quotes eld
19261 \begin_inset Quotes erd
19267 \begin_layout Enumerate
19271 \begin_inset Quotes eld
19279 \begin_inset Quotes erd
19285 \begin_layout Enumerate
19289 \begin_inset Quotes eld
19297 \begin_inset Quotes erd
19300 to achieve an ellipsis.
19303 \begin_layout Enumerate
19306 Inter-word spacing (
19307 \begin_inset Quotes eld
19317 \begin_inset Quotes eld
19320 ) should perhaps be used.
19323 \begin_layout Enumerate
19326 Inter-sentence spacing (
19327 \begin_inset Quotes eld
19337 \begin_inset Quotes erd
19340 ) should perhaps be used.
19343 \begin_layout Enumerate
19346 Could not find argument for command.
19349 \begin_layout Enumerate
19353 \begin_inset Quotes eld
19361 \begin_inset Quotes erd
19367 \begin_layout Enumerate
19370 Math mode still on at end of \SpecialChar LaTeX
19374 \begin_layout Enumerate
19378 \begin_inset Quotes eld
19386 \begin_inset Quotes erd
19389 doesn't match the number of
19390 \begin_inset Quotes eld
19398 \begin_inset Quotes erd
19404 \begin_layout Enumerate
19407 You should use either
19410 \begin_inset Quotes eld
19418 \begin_inset Quotes erd
19423 as an alternative to
19424 \begin_inset Quotes eld
19432 \begin_inset Quotes erd
19438 \begin_layout Enumerate
19445 " (ASCII 39) instead of "
19452 \begin_layout Enumerate
19455 User-specified pattern found.
19458 \begin_layout Enumerate
19461 This command might not be intended.
19464 \begin_layout Enumerate
19471 \begin_layout Enumerate
19489 \begin_layout Enumerate
19492 Delete this space to maintain correct page references.
19495 \begin_layout Enumerate
19499 You might wish to put this between a pair of
19500 \begin_inset Quotes eld
19508 \begin_inset Quotes erd
19514 \begin_layout Enumerate
19517 You ought to remove spaces in front of punctuation.
19520 \begin_layout Enumerate
19523 Could not execute \SpecialChar LaTeX
19527 \begin_layout Enumerate
19536 in front of small punctuation.
19539 \begin_layout Enumerate
19547 may look prettier here.
19550 \begin_layout Enumerate
19554 Multiple spaces detected in output.
19557 \begin_layout Enumerate
19560 This text may be ignored.
19563 \begin_layout Enumerate
19569 \begin_inset Quotes eld
19574 to begin quotation, not
19581 \begin_layout Enumerate
19588 to end quotation, not
19591 \begin_inset Quotes eld
19599 \begin_layout Enumerate
19605 \begin_layout Enumerate
19608 You should perhaps use
19609 \begin_inset Quotes eld
19617 \begin_inset Quotes erd
19623 \begin_layout Enumerate
19626 You should put a space in front of/after parenthesis.
19629 \begin_layout Enumerate
19632 You should avoid spaces in front of/after parenthesis.
19635 \begin_layout Enumerate
19639 You should not use punctuation in front of/after quotes.
19642 \begin_layout Enumerate
19645 Double space found.
19648 \begin_layout Enumerate
19651 You should put punctuation outside inner/inside display math mode.
19654 \begin_layout Enumerate
19657 You ought to not use primitive \SpecialChar TeX
19658 in \SpecialChar LaTeX
19662 \begin_layout Enumerate
19665 You should remove spaces in front of
19666 \begin_inset Quotes eld
19674 \begin_inset Quotes erd
19680 \begin_layout Enumerate
19683 \begin_inset Quotes eld
19691 \begin_inset Quotes erd
19694 is normally not followed by
19695 \begin_inset Quotes eld
19703 \begin_inset Quotes erd
19709 \begin_layout Standard
19710 In later versions of \SpecialChar LyX
19711 , we hope to provide a more complete interface to this
19712 tool (and it's smaller cousin
19716 ) to exploit the full power of it.
19717 But it's not exactly useless as it is now: go try it on one of your existing
19718 documents of a certain length and be surprised.
19721 \begin_layout Section
19722 Version Control in \SpecialChar LyX
19726 \begin_layout Standard
19729 Lars Gullik Bjønnes
19736 \begin_layout Subsection
19740 \begin_layout Standard
19742 supports some of the most basic RCS/CVS/SVN/GIT commands.
19743 If you need something a bit more sophisticated you will have to do that
19744 manually in a terminal.
19747 \begin_layout Standard
19748 Also note that CVS support is not as good as subversion support so we advise
19750 A good place to start learning Subversion is SVN Book
19754 \begin_layout Plain Layout
19755 \begin_inset CommandInset href
19757 target "http://svnbook.red-bean.com/"
19767 In the case of RCS you should read
19768 \begin_inset Quotes eld
19772 \begin_inset Quotes erd
19775 (a man file, read it with
19780 This file describes all the basic features of RCS.
19781 You should especially notice the comment about a RCS directory, and the
19782 notion of a master RCS file (the file ending in
19789 \begin_layout Standard
19790 Before you begin to use the version control features in \SpecialChar LyX
19792 familiar with RCS/CVS/SVN/GIT usage.
19793 The implementation in \SpecialChar LyX
19794 assumes a recent version of the GNU RCS or CVS/SVN
19795 package — no guarantees are made for older versions.
19796 Most of the log messages are not currently displayed after operations —
19797 you can check them in the Messages pane if unsure.
19798 Regular users of version control will appreciate VC toolbar, which can
19801 View\SpecialChar menuseparator
19802 Toolbars\SpecialChar menuseparator
19804 \begin_inset space ~
19812 \begin_layout Standard
19813 For introducing your own external commands consult vc-command in the manual
19814 of \SpecialChar LyX
19818 \begin_layout Standard
19819 It is strongly recommended to store documents in uncompressed format if
19820 using version control (uncheck
19822 Document\SpecialChar menuseparator
19825 if it is checked): Uncompressed LyX documents are text files and therefore
19826 for merging two different versions by version control systems.
19827 Compressed LyX documents are binary files, which cannot be merged by version
19831 \begin_layout Subsection
19832 RCS commands in \SpecialChar LyX
19836 \begin_layout Standard
19837 The following sections describe the RCS commands supported by \SpecialChar LyX
19839 You can find them in the
19841 File\SpecialChar menuseparator
19843 \begin_inset space ~
19850 was tested against RCS 5.7/5.8.
19853 \begin_layout Subsubsection
19859 \begin_layout Standard
19860 If your document is not under revision control, this is the only item shown
19862 And if it is under revision control, the
19866 item is not visible.
19870 \begin_layout Standard
19871 This command registers your document with RCS (unless you are under the
19872 directory managed by CVS)\SpecialChar endofsentence
19873 You are asked interactively to supply an initial
19874 description of the document.
19875 The document is now set in Read-Only mode and you have to
19878 \begin_inset space ~
19882 \begin_inset space ~
19886 \begin_inset space ~
19891 , before making any changes to it.
19892 A document under revision control has a
19893 \begin_inset Quotes eld
19896 [RCS:<version> <locker>]
19897 \begin_inset Quotes erd
19900 item tagged to the filename in the minibuffer.
19903 \begin_layout Standard
19904 RCS command that is run:
19906 ci -q -u -i -t-"<initial description>" <file-name>
19909 \begin_layout Standard
19914 to understand the switches.
19918 \begin_layout Subsubsection
19924 \begin_layout Standard
19925 When you are finished editing a file, you check in your changes.
19926 When you do this, you are asked for a description of the changes.
19927 This is stored in the history log.
19928 The version number is bumped, your changes are applied to the master RCS
19929 file, the document is unlocked and set to Read-Only mode.
19932 \begin_layout Standard
19935 ci -q -u -m"<description>" <file-name>
19938 \begin_layout Subsubsection
19944 \begin_layout Standard
19945 By doing this you lock the document so that only you can edit it.
19946 This will also make the document Read-Write only for you.
19947 You will usually continue editing for a while and when you are finished
19948 you check in your changes.
19949 The status line is changed to reflect that you have locked the file.
19952 \begin_layout Standard
19955 co -q -l <file-name>
19958 \begin_layout Subsubsection
19961 Revert To Repository Version
19964 \begin_layout Standard
19965 This will discard all changes made to the document since the last check
19967 You get a warning before changes are discarded.
19970 \begin_layout Standard
19973 co -f -u<version> <file-name>
19976 \begin_layout Subsubsection
19982 \begin_layout Standard
19983 This will create a copy of the current document.
19984 Since RCS does not support copy operations natively, the version history
19985 is not preserved, and the copy is added as a new file.
19986 It requires a clean document without any changes since the last checkin.
19987 You are asked for a file name and a description of the copy operation.
19988 After that the copy is created, both locally and in the repository.
19989 If the parent directories of the copied and original document differ, all
19990 relative paths of included files of the copy are adjusted (like in
19992 File\SpecialChar menuseparator
19997 Finally, the copy is loaded instead of the original document.
20000 \begin_layout Labeling
20001 \labelwidthstring 00.00.0000
20003 \begin_inset space ~
20007 \begin_inset space ~
20011 \begin_inset Newline newline
20015 \begin_inset Flex Code
20018 \begin_layout Plain Layout
20021 \begin_inset Quotes eld
20025 \begin_inset Quotes erd
20034 \begin_inset Flex Code
20037 \begin_layout Plain Layout
20040 \begin_inset Quotes eld
20044 \begin_inset Quotes erd
20053 \begin_inset Newline newline
20057 \begin_inset Flex Code
20060 \begin_layout Plain Layout
20064 \begin_inset Quotes eld
20068 \begin_inset Quotes erd
20079 \begin_layout Subsubsection
20085 \begin_layout Standard
20086 This makes as if the last check in never happened.
20087 No changes are made to the document loaded into \SpecialChar LyX
20088 , but the last version
20089 is removed from the master RCS file.
20092 \begin_layout Standard
20095 rcs -o<version> <file-name>
20098 \begin_layout Subsubsection
20104 \begin_layout Standard
20105 This shows the complete history of the RCS document.
20110 is shown in a browser.
20118 \begin_layout Subsubsection
20122 \begin_layout Standard
20124 supports RCS version number, author name, date and time of last commit.
20125 All those are extracted from
20127 rlog -r <file-name>
20131 \begin_inset CommandInset ref
20133 reference "subsec:VCS-Revision-Information"
20140 \begin_layout Subsection
20141 CVS commands in \SpecialChar LyX
20145 \begin_layout Standard
20146 A subset of CVS operations is supported by \SpecialChar LyX
20148 You can find the commands in the
20150 File\SpecialChar menuseparator
20152 \begin_inset space ~
20158 The version control system SVN is more powerful, so please use it instead
20159 of CVS if possible.
20162 \begin_layout Subsubsection
20168 \begin_layout Standard
20169 If you start from scratch with CVS you have to create your repository and
20170 checkout the working copy with external tools.
20171 If you're using a client-server setup you may need to login before doing
20172 the first repository checkout.
20175 \begin_layout Standard
20176 If your documents are under revision control and others are using the same
20177 repository problems arise when different changes to the same document at
20178 the same location happen.
20179 Standard CVS repositories don't operate with a file locking mechanism.
20180 This may be surprising, but conflicts only occur if people disagree on
20181 the proper content of the same part of a document.
20182 So, if co-workers are used to communicate regularly, these conflicts occur
20184 If they don't communicate they have a fundamental problem anyway.
20185 Nevertheless some people like to work with so called
20186 \begin_inset Quotes eld
20190 \begin_inset Quotes erd
20194 If they do so the working copy of all files is readonly when checked out
20195 first and the user starts editing after using a special command to make
20196 the working copy writable.
20197 When the changes are checked in the working copy returns to readonly state.
20198 With \SpecialChar LyX
20199 one has to edit the
20200 \begin_inset Flex Code
20203 \begin_layout Plain Layout
20209 file and add the line
20210 \begin_inset Flex Code
20213 \begin_layout Plain Layout
20219 to work with reserved checkouts.
20220 The benefit is the possibility to see who is using a writable copy of some
20222 It's not guaranteed only one user makes a copy writable.
20225 \begin_layout Standard
20227 tries to guess if you're using reserved or non-reserved checkouts.
20228 If your working copy is readonly or it is writable and an additional copy
20229 of your document exists in the CVS/Base sub-directory a reserved otherwise
20230 a non-reserved checkout is assumed.
20231 When a reserved checkout is detected you have to use
20232 \begin_inset Flex MenuItem
20235 \begin_layout Plain Layout
20241 to make your working copy writable if it's readonly.
20243 \begin_inset Flex MenuItem
20246 \begin_layout Plain Layout
20252 operation is possible and that makes your working copy readonly again after
20253 transferring your changes to the repository.
20256 \begin_layout Standard
20257 More information about CVS can be found here
20258 \begin_inset Flex URL
20261 \begin_layout Plain Layout
20263 http://www.nongnu.org/cvs
20269 \begin_inset Flex URL
20272 \begin_layout Plain Layout
20274 http://ximbiot.com/cvs
20282 \begin_layout Standard
20287 to understand the sub-commands and the switches mentioned below.
20290 \begin_layout Subsubsection
20296 \begin_layout Standard
20297 If your document is not under revision control, this is the only item shown
20299 And if it is under revision control, the
20306 item is not visible.
20310 \begin_layout Standard
20311 This command registers in CVS your document
20312 \begin_inset Flex Strong
20315 \begin_layout Plain Layout
20323 in the case you have already the documents directory under CVS control
20329 This means you have to create or checkout the archive by yourself using
20331 (In case you forget that step \SpecialChar LyX
20332 registers the document with RCS.)
20335 \begin_layout Standard
20336 Then you are asked interactively to supply an initial description of the
20338 Don't forget that registered file is not yet checked in.
20341 \begin_layout Standard
20342 CVS command that is run:
20344 cvs -q add -m"<entered message>" "<file-name>"
20347 \begin_layout Standard
20352 above and for all other CVS commands is an abbreviation for
20353 \begin_inset Quotes eld
20356 change the current working directory to file location and use the file name
20357 without path component as argument
20358 \begin_inset Quotes erd
20364 \begin_layout Subsubsection
20370 \begin_layout Standard
20371 When you are finished editing a file, you commit your changes.
20372 When you do this and you had changed the document, you are asked for a
20373 description of the changes.
20374 After that changes are written to the repository.
20375 In case you didn't change the document and a reserved checkout is detected
20376 the reservation made on
20377 \begin_inset Flex MenuItem
20380 \begin_layout Plain Layout
20389 \begin_layout Labeling
20390 \labelwidthstring 00.00.0000
20392 \begin_inset space ~
20396 \begin_inset space ~
20400 \begin_inset Newline newline
20404 \begin_inset Flex Code
20407 \begin_layout Plain Layout
20410 -q commit -m"<description>" "<file-name>"
20416 \begin_inset Newline newline
20420 \begin_inset Flex Code
20423 \begin_layout Plain Layout
20434 \begin_layout Subsubsection
20440 \begin_layout Standard
20441 When you are sharing a repository with others, you may have to incorporate
20442 their changes into your working copy.
20445 \begin_layout Standard
20448 cvs -q update "<file-name>"
20451 \begin_layout Standard
20452 If a readonly checkout is detected the working copy is made writable and
20456 \begin_layout Standard
20459 cvs -q edit "<file-name>"
20462 \begin_layout Subsubsection
20465 Revert To Repository Version
20468 \begin_layout Standard
20469 This will discard all changes made to the document since the last check
20471 You get a warning before changes are discarded.
20472 Firstly the file is deleted, secondly CVS update command is run.
20475 \begin_layout Standard
20478 cvs -q update "<file-name>"
20481 \begin_layout Standard
20482 If a reserved checkout is detected and the working copy has no changes only
20483 the reservation is undone.
20486 \begin_layout Standard
20489 cvs -q unedit "<file-name>"
20492 \begin_layout Subsubsection
20498 \begin_layout Standard
20499 This will create a copy of the current document.
20500 Since CVS does not support copy operations natively, the version history
20501 is not preserved, and the copy is added as a new file.
20502 It requires a clean document without any changes since the last checkin.
20503 You are asked for a file name and a description of the copy operation.
20504 After that the copy is created, both locally and in the repository.
20505 If the parent directories of the copied and original document differ, all
20506 relative paths of included files of the copy are adjusted (like in
20508 File\SpecialChar menuseparator
20513 Finally, the copy is loaded instead of the original document.
20516 \begin_layout Labeling
20517 \labelwidthstring 00.00.0000
20519 \begin_inset space ~
20523 \begin_inset space ~
20527 \begin_inset Newline newline
20531 \begin_inset Flex Code
20534 \begin_layout Plain Layout
20537 \begin_inset Quotes eld
20541 \begin_inset Quotes erd
20550 \begin_inset Flex Code
20553 \begin_layout Plain Layout
20556 \begin_inset Quotes eld
20560 \begin_inset Quotes erd
20569 \begin_inset Newline newline
20573 \begin_inset Flex Code
20576 \begin_layout Plain Layout
20580 \begin_inset Quotes eld
20584 \begin_inset Quotes erd
20595 \begin_layout Subsubsection
20601 \begin_layout Standard
20602 This will rename the current document.
20603 Since CVS does not support rename operations natively, the version history
20604 is not preserved, the renamed document is added as a new file, and the
20605 original document is deleted.
20606 It requires a clean document without any changes since the last checkin.
20607 You are asked for a file name and a description of the rename operation.
20608 After that the document is renamed, both locally and in the repository.
20609 If the parent directories of the new and old file names differ, all relative
20610 paths of included files are adjusted (like in
20612 File\SpecialChar menuseparator
20617 Finally, the document is reloaded using the new name.
20620 \begin_layout Labeling
20621 \labelwidthstring 00.00.0000
20623 \begin_inset space ~
20627 \begin_inset space ~
20631 \begin_inset Newline newline
20635 \begin_inset Flex Code
20638 \begin_layout Plain Layout
20641 \begin_inset Quotes eld
20645 \begin_inset Quotes erd
20654 \begin_inset Flex Code
20657 \begin_layout Plain Layout
20660 \begin_inset Quotes eld
20664 \begin_inset Quotes erd
20673 \begin_inset Newline newline
20677 \begin_inset Flex Code
20680 \begin_layout Plain Layout
20684 \begin_inset Quotes eld
20688 \begin_inset Quotes erd
20697 \begin_inset Newline newline
20701 \begin_inset Flex Code
20704 \begin_layout Plain Layout
20708 \begin_inset Quotes eld
20712 \begin_inset Quotes erd
20723 \begin_layout Subsubsection
20724 Update of the local directory checkout from repository
20727 \begin_layout Standard
20728 Once your documents gets more complex, containing sub-documents and pictures,
20730 \begin_inset Flex Code
20733 \begin_layout Plain Layout
20739 files and so on using version control becomes more complicated.
20741 supports updating the whole tree in which resides the document.
20742 This become especially useful once you cooperate with people which neither
20743 have detailed knowledge about CVS usage nor they have ambition to commit
20744 additional material to the repository.
20745 You have to organize the files structure so that all external files are
20746 in the same directory or subdirectories of the document.
20747 It's good practice anyway to store multipart documents in an extra directory.
20750 \begin_layout Standard
20752 \begin_inset Flex Code
20755 \begin_layout Plain Layout
20756 Update local directory from repository
20761 command updates the whole directory.
20762 If local changes are detected user is warned before update starts.
20763 In case of merge conflicts both versions of the conflicting document parts
20764 are placed in the final document.
20765 You have to review and correct the result of the merge.
20766 You'll find the conflicts enclosed in pairs of
20767 \begin_inset Flex Code
20770 \begin_layout Plain Layout
20777 \begin_inset Flex Code
20780 \begin_layout Plain Layout
20787 \begin_inset Flex Code
20790 \begin_layout Plain Layout
20797 The first part is your version as before the update operation with the
20798 document name prepended.
20799 The second one is the repository version with the version number after
20801 \begin_inset Flex Code
20804 \begin_layout Plain Layout
20813 \begin_layout Labeling
20814 \labelwidthstring 00.00.0000
20816 \begin_inset space ~
20820 \begin_inset space ~
20824 \begin_inset Newline newline
20828 \begin_inset Flex Code
20831 \begin_layout Plain Layout
20839 (Ask if changes are detected.)
20840 \begin_inset Newline newline
20844 \begin_inset Flex Code
20847 \begin_layout Plain Layout
20848 cd $path; cvs -q update
20858 \begin_layout Standard
20860 \begin_inset Flex Code
20863 \begin_layout Plain Layout
20869 stands for the path to the document.
20872 \begin_layout Subsubsection
20878 \begin_layout Standard
20879 This shows the complete history of the CVS document.
20882 cvs log "<file-name>"
20884 is shown in a browser.
20887 \begin_layout Subsubsection
20891 \begin_layout Standard
20893 supports CVS version number, author name, date and time of last commit.
20894 All those are extracted from
20896 cvs log -r <file-name>
20900 \begin_inset CommandInset ref
20902 reference "subsec:VCS-Revision-Information"
20909 \begin_layout Subsection
20910 SVN commands in \SpecialChar LyX
20914 \begin_layout Standard
20915 SVN is now partially supported by \SpecialChar LyX
20917 You can find the commands in the
20919 File\SpecialChar menuseparator
20921 \begin_inset space ~
20927 Please note that if you use password protected access to repository via
20928 ssh, you will be asked in terminal window.
20930 was tested against SVN 1.5, 1.6, 1.7 and 1.8
20934 \begin_layout Plain Layout
20935 Most of the commands will work with 1.4 too, see
20936 \begin_inset CommandInset ref
20938 reference "subsec:SVN-Repo-Update"
20943 There seems to be currently unresolved permissions problem under SVN 1.8
20944 with reverting changes when file is locked.
20952 \begin_layout Subsubsection
20958 \begin_layout Standard
20959 If your document is not under revision control, this is the only item shown
20961 And if it is under revision control, the
20968 item is not visible.
20971 \begin_layout Standard
20972 This command registers in SVN your document ONLY in case you have already
20973 the documents directory under SVN control (in particular
20978 This means you have to checkout the archive by yourself.
20981 \begin_layout Standard
20982 Then you are asked interactively to supply an initial description of the
20984 Don't forget that registered file is not yet commited.
20987 \begin_layout Standard
20988 SVN command that is run:
20991 \begin_inset Quotes eld
20995 \begin_inset Quotes erd
21001 \begin_layout Standard
21006 to understand the switches.
21009 \begin_layout Subsubsection
21015 \begin_layout Standard
21016 When you are finished editing a file, you commit your changes.
21017 When you do this, you are asked for a description of the changes.
21018 After that changes are commited.
21021 \begin_layout Standard
21026 \begin_layout Plain Layout
21027 In case locking is not enabled.
21029 \begin_inset CommandInset ref
21031 reference "subsec:SVN-File-Locking"
21042 svn commit -q -m"<description>" <file-name>
21045 \begin_layout Subsubsection
21051 \begin_layout Standard
21052 Updates the changes of this file from the repository.
21053 Be sure you understand SVN merging and conflicts resolving before using
21054 this function, because all conflicts has to be resolved manually by you!
21057 \begin_layout Standard
21062 \begin_layout Plain Layout
21070 svn update --non-interactive
21071 \begin_inset Quotes eld
21075 \begin_inset Quotes erd
21081 \begin_layout Subsubsection
21084 Revert To Repository Version
21087 \begin_layout Standard
21088 This will discard all changes made to the document since the last check
21090 You get a warning before changes are discarded.
21093 \begin_layout Standard
21097 \begin_inset Quotes eld
21101 \begin_inset Quotes erd
21107 \begin_layout Subsubsection
21113 \begin_layout Standard
21114 This will create a copy of the current document including the version history.
21115 It requires a clean document without any changes since the last checkin.
21116 You are asked for a file name and a description of the copy operation.
21117 After that the copy is created, both locally and in the repository.
21118 If the parent directories of the copied and original document differ, all
21119 relative paths of included files of the copy are adjusted (like in
21121 File\SpecialChar menuseparator
21126 Finally, the copy is loaded instead of the original document.
21129 \begin_layout Labeling
21130 \labelwidthstring 00.00.0000
21132 \begin_inset space ~
21136 \begin_inset space ~
21140 \begin_inset Newline newline
21144 \begin_inset Flex Code
21147 \begin_layout Plain Layout
21151 \begin_inset Quotes eld
21155 \begin_inset Quotes erd
21159 \begin_inset Quotes eld
21163 \begin_inset Quotes erd
21172 \begin_inset Newline newline
21176 \begin_inset Flex Code
21179 \begin_layout Plain Layout
21188 \begin_layout Subsubsection
21194 \begin_layout Standard
21195 This will rename the current document including the version history.
21196 It requires a clean document without any changes since the last checkin.
21197 You are asked for a file name and a description of the rename operation.
21198 After that the document is renamed, both locally and in the repository.
21199 If the parent directories of the new and old file names differ, all relative
21200 paths of included files are adjusted (like in
21202 File\SpecialChar menuseparator
21207 Finally, the document is reloaded using the new name.
21210 \begin_layout Labeling
21211 \labelwidthstring 00.00.0000
21213 \begin_inset space ~
21217 \begin_inset space ~
21221 \begin_inset Newline newline
21225 \begin_inset Flex Code
21228 \begin_layout Plain Layout
21232 \begin_inset Quotes eld
21236 \begin_inset Quotes erd
21240 \begin_inset Quotes eld
21244 \begin_inset Quotes erd
21253 \begin_inset Newline newline
21257 \begin_inset Flex Code
21260 \begin_layout Plain Layout
21269 \begin_layout Subsubsection
21270 \begin_inset CommandInset label
21272 name "subsec:SVN-Repo-Update"
21276 Update of the local directory checkout from repository
21280 \begin_layout Plain Layout
21281 Note that this command will work only with subversion
21282 \begin_inset Formula $\geqq1.5$
21293 \begin_layout Standard
21294 All the commands above have one shortcomming - they deal with the current
21296 Once your document contains pictures, includes external
21297 \begin_inset Flex Code
21300 \begin_layout Plain Layout
21306 files and so on administration becomes more complicated.
21308 now supports updating the whole tree in which resides the document
21312 \begin_layout Plain Layout
21313 One need to organize the files structure so that all external files are
21314 in the same directory or subdirectories of the document.
21321 This become especially useful once you cooperate with people which neither
21322 know about subversion management nor they have ambition to commit additional
21323 material to the repository.
21327 \begin_layout Standard
21328 \begin_inset Flex Code
21331 \begin_layout Plain Layout
21332 Update local directory from repository
21337 command updates the whole directory and in case of merge conflicts local
21338 version of the files are left, so no unintended data loss occurs.
21339 If local changes are detected user is warned before update starts.
21342 \begin_layout Labeling
21343 \labelwidthstring 00.00.0000
21345 \begin_inset space ~
21349 \begin_inset space ~
21353 \begin_inset Newline newline
21357 \begin_inset Flex Code
21360 \begin_layout Plain Layout
21366 (Ask if changes are detected.)
21367 \begin_inset Newline newline
21371 \begin_inset Flex Code
21374 \begin_layout Plain Layout
21375 svn update –accept mine-full $path
21383 \begin_layout Standard
21385 \begin_inset Flex Code
21388 \begin_layout Plain Layout
21394 stands for the path to the document.
21397 \begin_layout Subsubsection
21403 \begin_layout Standard
21404 This shows the complete history of the SVN document.
21408 \begin_inset Quotes eld
21412 \begin_inset Quotes erd
21417 is shown in a browser.
21420 \begin_layout Subsubsection
21422 \begin_inset CommandInset label
21424 name "subsec:SVN-File-Locking"
21431 \begin_layout Standard
21432 The file exchange through various revision control systems brings the problem
21433 of merge conflicts in case two different users try to edit the same (parts
21435 When such a conflict happens it needs manual resolving and one reasonable
21436 alternative is to provide some kind of locking mechanism, which guarantees
21437 that only one user is allowed to edit file at the given time.
21440 \begin_layout Standard
21441 SVN has two such mechanisms to provide mutual exclusivity for file access
21442 - locks and automatic setting of write permissions (see sec.
21444 \begin_inset CommandInset ref
21446 reference "subsec:Automatical-Locking-Property"
21451 \begin_inset Flex Code
21454 \begin_layout Plain Layout
21464 \begin_layout Plain Layout
21465 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21471 If this property is detected for a given document \SpecialChar LyX
21472 starts to use SVN locks
21473 for document editing automatically and the whole check-in/out mechanism
21474 switches to the same regimen as for RCS.
21475 This in particular means there are two different modes of file use in \SpecialChar LyX
21479 \begin_layout Itemize
21481 The loaded file is in the read-only mode.
21482 For editing on needs to check-out.
21487 consists of updating from the repository and gaining write lock.
21488 If the lock is not possible to obtain, we remain in unlocked state.
21491 \begin_layout Itemize
21493 The loaded file is in the 'normal' edit mode.
21494 No other user is allowed to edit the file.
21499 consists of commiting changes and releasing write-lock.
21500 If no changes have been made to the document, no commit will be produced
21504 \begin_layout Plain Layout
21505 Don't be puzzled by the fact that you will be asked for commit message anyway.
21510 and only the write-lock will be released.
21513 \begin_layout Standard
21517 \begin_layout Labeling
21518 \labelwidthstring 00.00.0000
21521 svn commit -q -m"<description>" "<file-name>"
21522 \begin_inset Newline newline
21525 svn unlock "<file-name>"
21528 \begin_layout Labeling
21529 \labelwidthstring 00.00.0000
21532 svn update "<file-name>"
21533 \begin_inset Newline newline
21536 svn lock "<file-name>"
21539 \begin_layout Subsubsection
21542 \begin_inset CommandInset label
21544 name "subsec:Automatical-Locking-Property"
21550 Automatic Locking Property
21553 \begin_layout Standard
21554 The above mentioned automatic setting of write permissions of the .lyx file
21560 ile\SpecialChar menuseparator
21566 \begin_inset space ~
21569 Control\SpecialChar menuseparator
21574 oggle locking property
21577 This command is active only when the file is not locked on the svn server
21579 you need to check-out before proceeding).
21582 \begin_layout Labeling
21583 \labelwidthstring 00.00.0000
21585 \begin_inset space ~
21591 \begin_layout Labeling
21592 \labelwidthstring 00.00.0000
21595 svn propset svn:needs-lock ON "<file-name>"
21598 \begin_layout Labeling
21599 \labelwidthstring 00.00.0000
21602 svn propdel svn:needs-lock "<file-name>"
21605 \begin_layout Subsubsection
21606 \begin_inset CommandInset label
21608 name "subsec:VCS-Revision-Information"
21612 Revision Information in Documents
21615 \begin_layout Standard
21616 There are more possibilities how to activate revision information in our
21620 \begin_layout Itemize
21623 \begin_inset Separator parbreak
21630 \begin_layout Itemize
21631 tree revision information (
21632 \begin_inset Flex Code
21635 \begin_layout Plain Layout
21642 The result is the output of the
21643 \begin_inset Flex Code
21646 \begin_layout Plain Layout
21652 command, the following table gives you an idea, how to read the results.
21655 \begin_layout Standard
21657 \begin_inset Tabular
21658 <lyxtabular version="3" rows="6" columns="2">
21659 <features tabularvalignment="middle">
21660 <column alignment="center" valignment="top">
21661 <column alignment="center" valignment="top">
21663 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21666 \begin_layout Plain Layout
21672 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21675 \begin_layout Plain Layout
21683 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21686 \begin_layout Plain Layout
21692 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21695 \begin_layout Plain Layout
21696 mixed revision working copy
21703 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21706 \begin_layout Plain Layout
21712 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21715 \begin_layout Plain Layout
21716 modified working copy
21723 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21726 \begin_layout Plain Layout
21732 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21735 \begin_layout Plain Layout
21736 switched working copy
21743 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
21746 \begin_layout Plain Layout
21752 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21755 \begin_layout Plain Layout
21756 partial working copy, from a sparse checkout
21763 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21766 \begin_layout Plain Layout
21772 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21775 \begin_layout Plain Layout
21776 mixed revision, modified, switched working copy
21789 \begin_layout Itemize
21790 file revision information.
21791 The result comes from parsing the output of
21792 \begin_inset Flex Code
21795 \begin_layout Plain Layout
21797 \begin_inset space ~
21801 \begin_inset space ~
21805 \begin_inset space ~
21814 Supported flags are:
21815 \begin_inset Separator parbreak
21822 \begin_layout Itemize
21823 version number of the last commit (
21824 \begin_inset Flex Code
21827 \begin_layout Plain Layout
21836 \begin_layout Itemize
21837 author of the last commit (
21838 \begin_inset Flex Code
21841 \begin_layout Plain Layout
21850 \begin_layout Itemize
21851 date of the last commit (
21852 \begin_inset Flex Code
21855 \begin_layout Plain Layout
21864 \begin_layout Itemize
21865 time of the last commit (
21866 \begin_inset Flex Code
21869 \begin_layout Plain Layout
21879 \begin_layout Standard
21880 You can obtain this info via InsetInfo (e.g.
21882 \begin_inset Flex Code
21885 \begin_layout Plain Layout
21886 info-insert buffer vcs-date
21892 The information will be available only when you have the file stored under
21893 svn managment (i.e.
21895 \begin_inset Flex Code
21898 \begin_layout Plain Layout
21904 directory is available with your document).
21908 \begin_layout Itemize
21909 Another—a hacking one—possibility is to use svn keywords
21913 \begin_layout Plain Layout
21914 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
21920 In short – you set file keywords property (e.g.
21923 svn propset svn:keywords 'Rev' file.lyx
21925 ) and then paste keyword \SpecialChar TeX
21930 \begin_layout Plain Layout
21931 This is an easy way how to ensure that \SpecialChar LyX
21932 won't break the line in the middle
21938 tag in your document (e.g.
21943 \begin_layout Plain Layout
21951 This way svn client will automatically substitute revision number (e.g.
21956 \begin_layout Plain Layout
21963 ) after each update and commit.
21964 There are more problems with this approach.
21965 Firstly, the '$' character is used in \SpecialChar TeX
21966 world for math equations, so any
21967 occurence of math formula
21968 \begin_inset Formula $Rev$
21972 \begin_inset Formula $Rev:59$
21975 in your \SpecialChar LyX
21977 Similarly for other keywords like Id, Date, Author, etc.
21978 Secondly svn output is dependent on your locales, so its very easy that
21979 svn would produce some problematic strings once Date is used.
21980 Thirdly you get the whole 'Rev: 59' string in your document instead of
21982 Until subversion implements user's custom keywords it will be hard to use
21983 this approach reliably or let \SpecialChar LyX
21984 to support it directly.
21987 \begin_layout Subsection
21988 SVN and Windows Environment
21991 \begin_layout Quote
21992 My inclination is to say that if the user cannot figure out the command
21993 line operations on their own fairly quickly, they would be well advised
21994 to use TortoiseSVN.
22000 \begin_layout Subsubsection
22004 \begin_layout Standard
22005 In addition to installing \SpecialChar LyX
22006 , and having access to a Subversion repository,
22007 the user will need to install the Subversion client program.
22008 A Windows installer for the client program is available from
22009 \begin_inset CommandInset href
22012 target "http://www.collab.net/nonav/downloads/subversion/"
22017 The user may also want to install
22018 \begin_inset CommandInset href
22021 target "http://tortoisesvn.tigris.org/"
22025 , which integrates Subversion operations into the context (rightclick) menu
22026 of Windows Explorer.
22027 Operations done outside \SpecialChar LyX
22028 will typically be more convenient using the Explorer
22030 Note that TortoiseSVN is not a replacement for the client program, which
22031 is what \SpecialChar LyX
22035 \begin_layout Subsubsection
22036 Bringing a document under Subversion control
22039 \begin_layout Standard
22040 Before a \SpecialChar LyX
22041 document can be brought under version control in Subversion, its
22042 parent directory needs to be under version control.
22043 If the document is being added to a project already in the repository,
22044 this is accomplished by checking the project out to the directory where
22045 the new document will be placed.
22046 If the project itself is not yet under version control (for instance, if
22047 this document starts a new project), the directory must be imported into
22049 This is done outside \SpecialChar LyX
22051 Both import and checkout are easily accomplished from the Explorer context
22052 menu using TortoiseSVN, or alternatively can be done using the command
22053 line client at a DOS prompt.
22054 The procedure for importing the project using TortoiseSVN is described
22055 below, assuming an existing repository and a new project being started
22063 For information on using the Subversion client program, run
22070 \begin_layout Enumerate
22077 in Windows Explorer, right click it, and select
22079 TortoiseSVN\SpecialChar menuseparator
22083 If necessary, adjust the URL for the repository, then click OK.
22086 \begin_layout Enumerate
22087 Right click the level of the repository under which you want to place the
22088 new project folder (typically the top level) and click
22092 Supply a name for the project folder and click OK.
22093 Add a message for the log file if desired, then click OK again.
22094 The new project folder should appear in the repository.
22095 Finally, click OK again to exit the repository browser.
22098 \begin_layout Enumerate
22099 Once again right click
22105 , this time selecting SVN Checkout\SpecialChar ldots
22106 Select the URL of the project folder
22107 you just created in the repository, and set the checkout directory to
22115 You will be warned about a non-empty folder; click OK to proceed.
22116 You should now have a
22127 \begin_layout Enumerate
22128 Create or open your document in \SpecialChar LyX
22131 File\SpecialChar menuseparator
22133 \begin_inset space ~
22136 Control\SpecialChar menuseparator
22140 Add a log message and click OK to commit the document to version control.
22143 \begin_layout Standard
22144 From this point onward, you should have full functionality in the
22146 File\SpecialChar menuseparator
22148 \begin_inset space ~
22154 You also have the option of checking the document in and out, viewing its
22156 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22157 client program from a command prompt.
22160 \begin_layout Subsubsection
22161 SSH tunnel used with SVN under Windows
22164 \begin_layout Standard
22165 Compared with Linux setting up an svn client to communicate over ssh under
22166 Windows is a rather troublesome task.
22167 We will at least offer some hints how to setup the client side but prior
22168 knowledge about ssh and the Windows command line is needed, also be prepared
22169 for a great deal of frustration\SpecialChar ldots
22173 \begin_layout Enumerate
22174 Get an svn client for windows, as described in the previous sections.
22175 When it is a fresh install run some svn command (e.g.
22177 \begin_inset Flex Code
22180 \begin_layout Plain Layout
22186 ) to create config files, which you will need to change later on.
22189 \begin_layout Enumerate
22190 Choose an ssh client for Windows.
22191 There are several possibilities, we will use the one from Putty tools
22195 \begin_layout Plain Layout
22196 \begin_inset Flex URL
22199 \begin_layout Plain Layout
22201 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22212 You will need to set the connection up so that the client doesn't ask for
22213 any password from you.
22214 To keep things easy we will use only keys without any additional password
22216 \begin_inset Separator parbreak
22223 \begin_layout Enumerate
22225 \begin_inset Flex Code
22228 \begin_layout Plain Layout
22235 Save your private .ppk key file and put the public one on the server side.
22236 If the SVN server runs on Linux, note that the format of the public key
22237 is not compatible with Linux openssh and you will need to direcly copy-paste
22240 Public key for pasting into OpenSSH authorized_keys file
22242 :” edit field into the server's
22243 \begin_inset Flex Code
22246 \begin_layout Plain Layout
22247 ~/.ssh/authorized_keys
22253 \begin_inset Flex Code
22256 \begin_layout Plain Layout
22265 \begin_layout Enumerate
22267 \begin_inset Flex Code
22270 \begin_layout Plain Layout
22277 In the SVN config file
22281 \begin_layout Plain Layout
22282 Exact path depends on Windows version, usually somewhere around
22283 \begin_inset Flex Code
22286 \begin_layout Plain Layout
22289 Documents and Settings
22303 \begin_inset Flex Code
22306 \begin_layout Plain Layout
22321 , section [tunnels], setup ssh command, e.g.
22323 \begin_inset Flex Code
22326 \begin_layout Plain Layout
22327 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22336 \begin_layout Plain Layout
22337 It will usually take a lot of time to get exact command right and it depends
22339 For example do not have some remote server saved as a default session in
22341 If things fail, try to connect via plink without SVN first.
22350 \begin_layout Enumerate
22351 Checkout the SVN archive, e.
22352 \begin_inset space \thinspace{}
22356 \begin_inset Newline newline
22360 \begin_inset Flex Code
22363 \begin_layout Plain Layout
22364 svn co svn+ssh://user@server/repository_path
22372 \begin_layout Subsubsection
22373 End-of-Line Conversions
22376 \begin_layout Standard
22377 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22379 use different line endings inside the .lyx files.
22380 This is not a problem as far as \SpecialChar LyX
22381 functionality is concerned, but the commit
22382 diffs will be huge and merge-conflicts prone.
22383 Fortunately SVN itself knows
22387 \begin_layout Plain Layout
22388 \begin_inset Flex URL
22391 \begin_layout Plain Layout
22393 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22403 how to deal with CR/LF problems when switching .lyx files to the
22404 \begin_inset Flex Code
22407 \begin_layout Plain Layout
22417 \begin_layout Plain Layout
22419 \begin_inset Flex Code
22422 \begin_layout Plain Layout
22423 svn propset svn:eol-style native FILE_NAME
22436 \begin_layout Subsection
22437 GIT commands in \SpecialChar LyX
22441 \begin_layout Standard
22442 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22444 You can find the commands in the
22446 File\SpecialChar menuseparator
22448 \begin_inset space ~
22454 Please note that if you use password protected access to repository via
22455 ssh, you will be asked in terminal window.
22457 was tested against GIT 1.7.
22461 \begin_layout Plain Layout
22462 Windows users please note that you need to ensure that git is on the path.
22463 This can be set from within \SpecialChar LyX
22466 Tools\SpecialChar menuseparator
22467 Preferences\SpecialChar menuseparator
22468 Paths\SpecialChar menuseparator
22479 \begin_layout Standard
22480 One big difference of GIT and the other supported version control systems
22481 is the distributed nature of GIT: With traditional version control systems
22482 there is one central server which hosts the repository.
22483 Users commit their changes to the server, and get updates made by other
22485 With GIT, users commit to a local repository.
22486 The local repository can be synchronized with one or more remote repositories
22488 \begin_inset Flex Code
22491 \begin_layout Plain Layout
22498 \begin_inset Flex Code
22501 \begin_layout Plain Layout
22509 does not interact in any way with remote GIT repositories.
22510 It works exclusively with the local repository in a very similar way as
22511 with a central CVS or SVN repository.
22512 If you use remote GIT repositories you need to do the
22513 \begin_inset Flex Code
22516 \begin_layout Plain Layout
22523 \begin_inset Flex Code
22526 \begin_layout Plain Layout
22532 operations with your favourite GIT client.
22535 \begin_layout Subsubsection
22541 \begin_layout Standard
22542 If your document is not under revision control, this is the only item shown
22544 And if it is under revision control, the
22551 item is not visible.
22554 \begin_layout Standard
22555 This command registers in GIT your document ONLY in case you have already
22556 the documents directory under GIT control (in particular
22561 This means you have to checkout the archive by yourself.
22564 \begin_layout Standard
22565 Then you are asked interactively to supply an initial description of the
22567 Don't forget that registered file is not yet commited.
22570 \begin_layout Standard
22571 GIT command that is run:
22574 \begin_inset Quotes eld
22578 \begin_inset Quotes erd
22584 \begin_layout Standard
22589 to understand the switches.
22592 \begin_layout Subsubsection
22598 \begin_layout Standard
22599 When you are finished editing a file, you commit your changes.
22600 When you do this, you are asked for a description of the changes.
22601 After that changes are commited.
22604 \begin_layout Standard
22607 git commit -q -m"<description>" <file-name>
22610 \begin_layout Subsubsection
22613 Revert To Repository Version
22616 \begin_layout Standard
22617 This will discard all changes made to the document since the last check
22619 You get a warning before changes are discarded.
22622 \begin_layout Standard
22626 \begin_inset Quotes eld
22630 \begin_inset Quotes erd
22636 \begin_layout Subsubsection
22642 \begin_layout Standard
22643 This will rename the current document including the version history.
22644 It requires a clean document without any changes since the last checkin.
22645 You are asked for a file name and a description of the rename operation.
22646 After that the document is renamed, both locally and in the repository.
22647 If the parent directories of the new and old file names differ, all relative
22648 paths of included files are adjusted (like in
22650 File\SpecialChar menuseparator
22655 Finally, the document is reloaded using the new name.
22658 \begin_layout Labeling
22659 \labelwidthstring 00.00.0000
22661 \begin_inset space ~
22665 \begin_inset space ~
22669 \begin_inset Newline newline
22673 \begin_inset Flex Code
22676 \begin_layout Plain Layout
22680 \begin_inset Quotes eld
22684 \begin_inset Quotes erd
22688 \begin_inset Quotes eld
22692 \begin_inset Quotes erd
22701 \begin_inset Newline newline
22705 \begin_inset Flex Code
22708 \begin_layout Plain Layout
22717 \begin_layout Subsubsection
22723 \begin_layout Standard
22724 This shows the complete history of the GIT document.
22728 \begin_inset Quotes eld
22732 \begin_inset Quotes erd
22737 is shown in a browser.
22740 \begin_layout Subsubsection
22744 \begin_layout Standard
22746 supports GIT hash number of the last commit to the file, author name, date
22747 and time of last commit.
22748 All those are extracted from
22750 git log -n 1 --pretty=format:%H%n%an%n%ai
22753 Tree version information is obtained via
22755 git describe --abbrev --dirty --long
22759 \begin_inset CommandInset ref
22761 reference "subsec:VCS-Revision-Information"
22768 \begin_layout Subsection
22772 \begin_layout Standard
22773 With the recent addition of the vc-command function \SpecialChar LyX
22774 power users are allowed
22775 to create their own commands for revision control.
22778 \begin_layout Standard
22779 As an example you can see how two TortoiseSVN commands could be integrated
22783 \begin_layout Description
22785 \begin_inset Flex Code
22788 \begin_layout Plain Layout
22789 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
22797 \begin_layout Description
22799 \begin_inset Flex Code
22802 \begin_layout Plain Layout
22803 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
22811 \begin_layout Subsection
22812 Version control and Document comparison
22815 \begin_layout Standard
22816 One of the typical uses of version control is to inspect the changes between
22817 revisions, usually by creating
22818 \begin_inset Flex Code
22821 \begin_layout Plain Layout
22828 While this is useful for plain text files, it is much less useful in the
22829 case of \SpecialChar LyX
22830 files, which have more a complicated structure.
22831 Hence we provide binding to the Document comparison feature.
22832 There are two ways of calling this feature - either by direct call of
22833 \begin_inset Flex Code
22836 \begin_layout Plain Layout
22843 function (for details see \SpecialChar LyX
22844 functions manual) or by icon/menu item
22845 \begin_inset Flex MenuItem
22848 \begin_layout Plain Layout
22849 Compare with older revision...
22855 One can either compare two chosen revisions of the document or he can simply
22856 compare the current version of edited text with older revisions (where
22858 \begin_inset Flex MenuItem
22861 \begin_layout Plain Layout
22867 ' revisions back means comparison of the edited file with last commited
22872 \begin_layout Standard
22873 This feature is supported for SVN and RCS though due to the more complicated
22874 versioning scheme of RCS there is a constraint – when addressing the revisions
22875 in dialog, numbers always point to the last number in RCS revision number,
22878 We don't currently support GIT addressing of revisions, one can just compare
22879 edited document with its revision X steps backs, where X is addressed as
22883 \begin_layout Section
22884 Literate Programming
22887 \begin_layout Standard
22892 (kayvan@sylvan.com)
22896 original documentation written by
22898 Edmar Wienskoski Jr.
22901 (edmar-w-jr@technologist.com)
22904 \begin_layout Subsection
22908 \begin_layout Standard
22909 The main purpose of this documentation is to show you how to use \SpecialChar LyX
22911 programming, where it is assumed that you are familiar with this programming
22912 technique, and know what
22913 \begin_inset Quotes eld
22917 \begin_inset Quotes erd
22921 \begin_inset Quotes eld
22925 \begin_inset Quotes erd
22929 If that is not the case, please follow the web links provided in the following
22931 There is a lot of good documentation out there covering old development
22932 history to the latest tools tips.
22935 \begin_layout Standard
22936 It is also assumed that you are familiar with \SpecialChar LyX
22937 itself to a point that you
22938 are comfortable changing your \SpecialChar LyX
22939 preferences, and X resources file.
22940 If that is not the case please refer to other \SpecialChar LyX
22941 documentation to cover your
22945 \begin_layout Subsection
22946 Literate Programming
22949 \begin_layout Standard
22950 From the Literate Programming FAQ:
22953 \begin_layout Quotation
22954 Literate programming is the combination of documentation and source together
22955 in a fashion suited for reading by human beings.
22956 In fact, literate programs should be enjoyable reading, even inviting!
22957 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
22958 and documentation in a single file.
22959 Literate programming tools then parse the file to produce either readable
22960 documentation or compilable source.
22961 The WEB style of literate programming was created by D.
22962 \begin_inset space \thinspace{}
22966 Knuth during the development of his \SpecialChar TeX
22967 typesetting software.
22971 \begin_layout Standard
22972 Another excerpt says:
22975 \begin_layout Quotation
22978 How is literate programming different from verbose commenting?
22981 \begin_layout Quotation
22982 There are three distinguishing characteristics.
22983 In order of importance, they are:
22984 \begin_inset Separator parbreak
22991 \begin_layout Itemize
22992 flexible order of elaboration
22995 \begin_layout Itemize
22996 automatic support for browsing
22999 \begin_layout Itemize
23000 typeset documentation, especially diagrams and mathematics
23004 \begin_layout Standard
23005 Now that I sparked your curiosity, take a look in the references.
23008 \begin_layout Subsubsection
23012 \begin_layout Standard
23013 The complete Literate Programming FAQ can be found at:
23016 \begin_layout Quote
23017 Literate Programming FAQ
23018 \begin_inset Flex URL
23021 \begin_layout Plain Layout
23023 http://www.literateprogramming.com/lpfaq.pdf
23031 \begin_layout Standard
23032 The FAQ lists 23 (twenty three!) different literate programming tools.
23033 Where some are specialized or
23034 \begin_inset Quotes eld
23038 \begin_inset Quotes erd
23041 for particular programming languages, while other have general scope.
23046 for my own use for several reasons:
23049 \begin_layout Itemize
23050 It can generate the documentation either in \SpecialChar LaTeX
23054 \begin_layout Itemize
23055 It has a open architecture, i.
23056 \begin_inset space \thinspace{}
23060 \begin_inset space \space{}
23063 it is easy to plug in new filters and to perform special processing that
23068 \begin_layout Itemize
23069 There is a good selection of filters available already (the HTML is one
23073 \begin_layout Itemize
23077 \begin_layout Standard
23078 The Noweb web page can be found at:
23081 \begin_layout Quote
23083 \begin_inset Flex URL
23086 \begin_layout Plain Layout
23088 http://www.cs.virginia.edu/~nr/noweb/
23096 \begin_layout Standard
23097 Starting from there you can reach many other interesting links and even
23098 some literate program examples.
23101 \begin_layout Subsection
23103 and Literate Programming with Noweb
23106 \begin_layout Standard
23107 The \SpecialChar LyX
23108 support for Literate Programming is provided by using the generic \SpecialChar LyX
23110 converters mechanism.
23111 This support is provided in a
23112 \begin_inset Quotes eld
23116 \begin_inset Quotes erd
23120 \begin_inset space \thinspace{}
23124 \begin_inset space \space{}
23127 you will be able to use this new \SpecialChar LyX
23128 feature with some other literate programming
23129 tool of your choice by just changing your \SpecialChar LyX
23133 \begin_layout Subsubsection
23134 Generating documents and code (weaving and tangling)
23137 \begin_layout Paragraph
23138 Using the noweb module
23141 \begin_layout Standard
23142 If you have installed Noweb and \SpecialChar LyX
23143 successfully, whenever you open a new document,
23144 after you have chosen its document class, use the Document->Settings menu
23146 \begin_inset Quotes eld
23150 \begin_inset Quotes erd
23154 If Noweb is correctly installed, when you click on the
23155 \begin_inset Quotes eld
23159 \begin_inset Quotes erd
23162 link, you will see the
23163 \begin_inset Quotes eld
23167 \begin_inset Quotes erd
23170 module in the available list and you can add it to your document.
23173 \begin_layout Paragraph
23177 \begin_layout Standard
23179 enables you to write code with a layout named
23180 \begin_inset Flex Noun
23183 \begin_layout Plain Layout
23190 Noweb delimits chunks like this:
23193 \begin_layout LyX-Code
23197 \begin_layout LyX-Code
23201 \begin_layout LyX-Code
23205 \begin_layout LyX-Code
23209 \begin_layout LyX-Code
23213 \begin_layout Standard
23214 The problem is that whatever is written in between the << and the
23218 must be taken literally, i.
23219 \begin_inset space \thinspace{}
23223 \begin_inset space \space{}
23227 should be prevented from making any special interpretation of what has
23229 This is also handled by
23230 \begin_inset Flex Noun
23233 \begin_layout Plain Layout
23239 , that works like a normal paragraph but has a free spacing capability.
23242 \begin_layout Standard
23243 As a special note, you can also use the
23244 \begin_inset Quotes eld
23248 \begin_inset Quotes erd
23251 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23255 \begin_layout LyX-Code
23259 \begin_layout LyX-Code
23260 def some_function(args):
23263 \begin_layout LyX-Code
23264 "This is the doc string for this function."
23267 \begin_layout LyX-Code
23268 print "My args: ", args
23271 \begin_layout LyX-Code
23272 @ %def some_function
23275 \begin_layout Standard
23276 For an example of this usage and the resulting cross-reference output, look
23277 at the Literate python program in
23279 LIBDIR/examples/listerrors.lyx
23281 which should make this all clear.
23284 \begin_layout Paragraph
23285 Generating the documentation
23288 \begin_layout Standard
23289 At this point you already have a new document file with a proper document
23290 class, and with some code and text on it.
23291 How do I print it? The answer is simple, you select
23293 View\SpecialChar menuseparator
23297 Just like you would do for a plain document.
23298 No special procedure is required.
23301 \begin_layout Standard
23302 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23306 \begin_layout Enumerate
23309 Update\SpecialChar menuseparator
23312 menu option is chosen, a \SpecialChar LaTeX
23315 \begin_inset Separator parbreak
23322 \begin_layout Standard
23323 If the document is of any literate class the generated file will be named
23324 with an extension name defined by the
23325 \begin_inset Quotes eld
23329 \begin_inset Quotes erd
23332 format (defined in the Preferences panel), otherwise the file will have
23341 \begin_layout Enumerate
23342 Note that the only difference so far is in the name of the file, no special
23343 processing is required by \SpecialChar LyX
23345 Given that you formatted the code using the
23346 \begin_inset Flex Noun
23349 \begin_layout Plain Layout
23355 layout that, by itself, takes care of the business.
23358 \begin_layout Enumerate
23359 If the document is of any literate class \SpecialChar LyX
23360 will then use the internal \SpecialChar LyX
23362 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23367 \begin_layout Plain Layout
23368 The converters are defined in the
23370 Tools\SpecialChar menuseparator
23374 \begin_inset Quotes eld
23378 \begin_inset Quotes erd
23390 manual for general information about converters.
23395 to generate the \SpecialChar LaTeX
23397 \begin_inset Separator parbreak
23404 \begin_layout Standard
23405 Otherwise it will just skip this step.
23409 \begin_layout Enumerate
23410 Finally, \SpecialChar LaTeX
23411 is invoked and the regular post processing continues as in a plain
23415 \begin_layout Standard
23416 Independence from a particular
23417 \begin_inset Quotes eld
23421 \begin_inset Quotes erd
23424 is easily achieved by changing the commands that are run by the various
23428 \begin_layout Paragraph
23429 Generating the code
23432 \begin_layout Standard
23433 When the build menu option is chosen or the corresponding button in the
23434 toolbar is pressed, a \SpecialChar LaTeX
23435 file is generated just like step 1 above.
23436 Next, \SpecialChar LyX
23442 This converter needs to be defined by the user and is not installed by
23443 default, though the Program format is.
23444 This converter (like any other converter) will have two parts:
23447 \begin_layout Enumerate
23448 The converter program itself.
23449 This program performs the conversion from the one format to the other (in
23450 this case, from the Noweb format to the Program pseudo-format).
23453 \begin_layout Enumerate
23454 The error log parser.
23455 This is a program whose sole purpose is to rewrite error messages in a
23456 format that \SpecialChar LyX
23458 This makes it possible for \SpecialChar LyX
23459 to place error boxes in the right places in
23463 \begin_layout Standard
23464 The first part, the
23465 \begin_inset Quotes eld
23469 \begin_inset Quotes erd
23472 setting, should be set to
23473 \begin_inset Newline newline
23477 \begin_inset Quotes eld
23485 \begin_inset Quotes erd
23489 \begin_inset Newline newline
23492 This basically means that \SpecialChar LyX
23494 \begin_inset Quotes eld
23498 \begin_inset Quotes erd
23501 (a program or script) with the name of the Noweb file (normally a file
23502 in the \SpecialChar LyX
23503 temp directory) and the directory path of the original \SpecialChar LyX
23508 \begin_layout Standard
23509 This is an implementation of
23510 \begin_inset Quotes eld
23514 \begin_inset Quotes erd
23517 that you can place in a directory on your path:
23520 \begin_layout Standard
23521 \begin_inset VSpace defskip
23527 \begin_layout Standard
23528 \begin_inset Newpage pagebreak
23534 \begin_layout Standard
23540 \begin_layout Standard
23546 \begin_layout Standard
23549 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23552 \begin_layout Standard
23553 \begin_inset VSpace defskip
23559 \begin_layout Standard
23560 The next part of the converter setting is the
23561 \begin_inset Quotes eld
23565 \begin_inset Quotes erd
23568 which is to be set to
23569 \begin_inset Newline newline
23573 \begin_inset Quotes eld
23578 parselog=$$s/scripts/listerrors
23581 \begin_inset Quotes erd
23585 \begin_inset Newline newline
23588 This will run any errors that are generated by the
23589 \begin_inset Quotes eld
23593 \begin_inset Quotes erd
23596 process through the
23597 \begin_inset Quotes eld
23601 \begin_inset Quotes erd
23607 \begin_layout Standard
23608 The build will normally take place in \SpecialChar LyX
23609 's temporary directory, so the files
23610 produced by the conversion will be in that directory.
23612 will copy out what it regards as the `main' file, but the
23616 conversion may produce several files, and so most of these would then be
23617 deleted when \SpecialChar LyX
23619 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23620 the build-script chunk can place the generated files in that location.
23623 \begin_layout Paragraph
23624 Build instructions in the document
23627 \begin_layout Standard
23628 The last piece of the integration between \SpecialChar LyX
23630 \begin_inset Quotes eld
23634 \begin_inset Quotes erd
23638 Generally, the instructions for building your program should be embedded
23639 in a chunk of its own.
23641 \begin_inset Quotes eld
23645 \begin_inset Quotes erd
23648 above uses the notangle command to look for this chunk (called
23649 \begin_inset Quotes eld
23653 \begin_inset Quotes erd
23656 ) and runs its contents through
23657 \begin_inset Quotes eld
23661 \begin_inset Quotes erd
23667 \begin_layout Standard
23668 Typically, such a chunk would look something like this:
23671 \begin_layout LyX-Code
23675 \begin_layout LyX-Code
23677 \begin_inset Newline newline
23680 if [ -z "${NOWEB_SOURCE}" ]
23681 \begin_inset Newline newline
23687 \begin_layout LyX-Code
23688 NOWEB_SOURCE=myfile.nw
23689 \begin_inset Newline newline
23693 \begin_inset Newline newline
23697 code to extract files ...
23698 use NOWEB_OUTPUT_DIR here ...]
23699 \begin_inset Newline newline
23703 code to compile files ...]
23704 \begin_inset Newline newline
23710 \begin_layout Standard
23713 LIBDIR/examples/listerrors.lyx
23717 LIBDIR/examples/Literate.lyx
23719 which implement two versions of the
23720 \begin_inset Quotes eld
23724 \begin_inset Quotes erd
23727 program for some illustrations of how all of these pieces go together or
23730 LIBDIR/examples/noweb2lyx.lyx.
23733 Interestingly, these three files show off the language-indepence of the
23735 literate programming support since they are written in Python, C and Perl
23739 \begin_layout Subsubsection
23740 Configuring \SpecialChar LyX
23744 \begin_layout Standard
23745 All the Literate Programming support is configured by the
23747 Tools\SpecialChar menuseparator
23751 \begin_inset Quotes eld
23755 \begin_inset Quotes erd
23759 The important parts are:
23762 \begin_layout Description
23764 \begin_inset space ~
23768 \begin_inset Quotes eld
23772 \begin_inset Quotes erd
23776 \begin_inset space ~
23779 format Set up via the File Formats tab, this is where the Noweb-specific
23789 , the file extension is set to
23794 This tells \SpecialChar LyX
23795 to create a file with a
23799 extension in the first step of the conversion process.
23802 \begin_layout Description
23804 \begin_inset space ~
23812 \begin_inset space ~
23815 format This is an empty format whose sole purpose is to be the endpoint
23816 of a conversion (which then allows us to set up a converter for it).
23819 \begin_layout Description
23829 This converter performs the
23830 \begin_inset Quotes eld
23834 \begin_inset Quotes erd
23837 of the literate document.
23838 For Noweb, it is set to
23839 \begin_inset Quotes eld
23844 noweave -delay -index $$i > $$o
23847 \begin_inset Quotes erd
23853 \begin_layout Description
23863 \begin_inset Quotes eld
23867 \begin_inset Quotes erd
23871 As stated above, the Converter is set to
23872 \begin_inset Quotes eld
23880 \begin_inset Quotes erd
23883 , with Flags set to
23884 \begin_inset Newline newline
23888 \begin_inset Quotes eld
23893 parselog=$$s/scripts/listerrors
23896 \begin_inset Quotes erd
23902 \begin_layout Subsubsection
23906 \begin_layout Standard
23907 There is also a new function implemented in the \SpecialChar LyX
23909 \begin_inset Quotes eld
23912 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
23916 \begin_layout Standard
23917 When debugging code with ddd/gdb, it is possible to invoke a text editor
23918 at the current execution position with a single key stroke.
23919 The default ddd configuration for that is shift-ctrl-V.
23920 It happens that you can define the editor command line invocation in ddd
23923 Edit\SpecialChar menuseparator
23924 Preferences\SpecialChar menuseparator
23927 dialog and changing the "Edit Sources" entry.
23930 \begin_layout Standard
23931 I take advantage of the newly created \SpecialChar LyX
23932 server function and this ddd feature,
23934 \begin_inset Quotes eld
23938 \begin_inset Quotes erd
23944 \begin_layout Standard
23945 \begin_inset VSpace defskip
23951 \begin_layout Standard
23954 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
23957 \begin_layout Standard
23958 \begin_inset VSpace defskip
23964 \begin_layout Standard
23965 With this, whenever you are using ddd and find a point in the program that
23966 you want to edit, you just press shift-ctrl-V (in the ddd window), and
23967 ddd will forward this information to \SpecialChar LyX
23968 through the \SpecialChar LyX
23969 server and then the
23971 window will show the same file with the cursor at the same position ddd
23973 No more guessing or long scrolling to locate a point in the program back
23977 \begin_layout Standard
23978 Note however that you must enable the \SpecialChar LyX
23979 server to get this feature working
23980 (it is disabled by default).
23981 You can enable it in
23993 ) by entering in the
23999 \begin_inset Quotes eld
24004 /home/<your-home-directory>/.lyx/lyxpipe
24007 \begin_inset Quotes erd
24013 \begin_layout Standard
24014 Read the \SpecialChar LyX
24015 server documentation in the
24017 Customization Manual
24019 for further information.
24022 \begin_layout Subsubsection
24026 \begin_layout Standard
24027 There are six new buttons that can be added to your \SpecialChar LyX
24029 Five of these buttons are short cuts to layout styles:
24052 The last one is a short cut to the
24053 \begin_inset Quotes eld
24057 \begin_inset Quotes erd
24064 \begin_layout Standard
24066 has a range of buttons that are available for tool bar customization.
24067 In my toolbar I like to combine the six short cuts above with two more:
24072 \SpecialChar menuseparator
24077 \SpecialChar menuseparator
24084 Document\SpecialChar menuseparator
24085 View\SpecialChar menuseparator
24089 Here is how it looks like:
24092 \begin_layout LyX-Code
24096 \begin_layout LyX-Code
24100 \begin_layout LyX-Code
24101 Icon "layout Standard"
24104 \begin_layout LyX-Code
24105 Icon "layout Section"
24108 \begin_layout LyX-Code
24109 Icon "layout \SpecialChar LaTeX
24113 \begin_layout LyX-Code
24114 Icon "layout \SpecialChar LyX
24118 \begin_layout LyX-Code
24119 Icon "layout Chunk"
24122 \begin_layout LyX-Code
24126 \begin_layout LyX-Code
24130 \begin_layout LyX-Code
24131 Icon "buffer-typeset"
24134 \begin_layout LyX-Code
24135 Icon "build-program"
24138 \begin_layout LyX-Code
24142 \begin_layout LyX-Code
24146 \begin_layout LyX-Code
24150 \begin_layout LyX-Code
24154 \begin_layout LyX-Code
24158 \begin_layout Subsubsection
24159 Colors customization
24162 \begin_layout Standard
24163 There are a number of colors in \SpecialChar LyX
24164 that can be customized in
24169 One of the things that bothers people is the \SpecialChar LaTeX
24171 The default color is red, since the chunks uses \SpecialChar LaTeX
24172 font, and there is a lot
24173 of chunks in literate documents, you may get tired of seeing everything
24175 You can change it by going to the tabs
24184 \begin_layout Standard
24185 The next thing is the visible presence of the newline character in the screen.
24186 You can choose the color of this particular character and make it blend
24188 I recommend you choosing a color that is close to the background but not
24189 equal, that way you still can see it is there, but it is not bothering
24193 \begin_layout Subsection
24198 \begin_layout Standard
24207 is documented in the
24211 example file and in the Sweave manual (menu
24213 Help\SpecialChar menuseparator
24219 \begin_layout Chapter
24223 \begin_layout Standard
24224 You can do everything with \SpecialChar LyX
24225 that you can do with \SpecialChar LaTeX
24227 However, \SpecialChar LyX
24228 cannot support every \SpecialChar LaTeX
24230 But you can always use \SpecialChar TeX
24232 This chapter shows you some more special things you might want to use.
24233 For other special things you can do with figures, tables, floats, boxes
24234 and notes, have a look at the
24237 \begin_inset space ~
24245 \begin_layout Section
24246 Multiple Text Columns
24249 \begin_layout Standard
24250 This feature is independent of the option
24252 Two-column document
24254 in the document settings under
24259 If you want to have 2
24260 \begin_inset space ~
24263 columns for the whole document, it is recommended to use the
24265 Two-column document
24268 For all other cases use this feature.
24271 \begin_layout Standard
24272 To use multiple text columns in your document, you have to load the module
24279 Document\SpecialChar menuseparator
24280 Settings\SpecialChar menuseparator
24283 ) and must have the \SpecialChar LaTeX
24291 \begin_layout Standard
24292 Footnotes within multiple columns will be placed at the bottom of the page
24293 and not under each column.
24294 Within the different columns you can use everything, with the limitation
24295 that for floats you need to use the float option
24302 \begin_layout Subsection
24306 \begin_layout Standard
24307 If you want to have 2
24308 \begin_inset space ~
24311 columns in your text, insert a multicolumn inset via the menu
24313 Insert\SpecialChar menuseparator
24315 \begin_inset space ~
24318 Insets\SpecialChar menuseparator
24320 \begin_inset space ~
24325 where the columns should start.
24326 Write all text that should be printed in 2
24327 \begin_inset space ~
24330 columns into this inset.
24333 \begin_layout Standard
24334 Here is an example:
24337 \begin_layout Standard
24339 \begin_inset Flex Multiple Columns
24342 \begin_layout Plain Layout
24347 The Adventure of the Empty House
24350 \begin_inset Newline newline
24353 by Sir Arthur Conan Doyle
24356 \begin_layout Plain Layout
24359 It was in the spring of the year 1894 that all London was interested, and
24360 the fashionable world dismayed, by the murder of the Honourable Ronald
24361 Adair under most unusual and inexplicable circumstances.
24362 The public has already learned those particulars of the crime which came
24363 out in the police investigation, but a good deal was suppressed upon that
24364 occasion, since the case for the prosecution was so overwhelmingly strong
24365 that it was not necessary to bring forward all the facts.
24366 Only now, at the end of nearly ten years, am I allowed to supply those
24367 missing links which make up the whole of that remarkable chain.
24368 The crime was of interest in itself, but that interest was as nothing to
24369 me compared to the inconceivable sequel, which afforded me the greatest
24370 shock and surprise of any event in my adventurous life.
24371 Even now, after this long interval, I find myself thrilling as I think
24372 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24373 ty which utterly submerged my mind.
24374 Let me say to that public, which has shown some interest in those glimpses
24375 which I have occasionally given them of the thoughts and actions of a very
24376 remarkable man, that they are not to blame me if I have not shared my knowledge
24377 with them, for I should have considered it my first duty to do so, had
24378 I not been barred by a positive prohibition from his own lips, which was
24379 only withdrawn upon the third of last month.
24387 \begin_layout Standard
24388 To get 3 or more columns, set the cursor into the multicolumn inset and
24391 Insert\SpecialChar menuseparator
24393 \begin_inset space ~
24397 \begin_inset space ~
24403 The number of the desired columns is written into that inset (for 3
24404 \begin_inset space ~
24408 \begin_inset Quotes eld
24412 \begin_inset Quotes erd
24416 \begin_inset Newline newline
24419 Here is an example with 3
24420 \begin_inset space ~
24426 \begin_layout Standard
24427 \begin_inset Flex Multiple Columns
24430 \begin_layout Plain Layout
24433 \begin_inset Argument 1
24436 \begin_layout Plain Layout
24442 It can be imagined that my close intimacy with Sherlock Holmes had interested
24443 me deeply in crime, and that after his disappearance I never failed to
24444 read with care the various problems which came before the public.
24445 And I even attempted, more than once, for my own private satisfaction,
24446 to employ his methods in their solution, though with indifferent success.
24447 There was none, however, which appealed to me like this tragedy of Ronald
24449 As I read the evidence at the inquest, which led up to a verdict of willful
24450 murder against some person or persons unknown, I realized more clearly
24451 than I had ever done the loss which the community had sustained by the
24452 death of Sherlock Holmes.
24453 There were points about this strange business which would, I was sure,
24454 have specially appealed to him, and the efforts of the police would have
24455 been supplemented, or more probably anticipated, by the trained observation
24456 and the alert mind of the first criminal agent in Europe.
24457 All day, as I drove upon my round, I turned over the case in my mind and
24458 found no explanation which appeared to me to be adequate.
24459 At the risk of telling a twice-told tale, I will recapitulate the facts
24460 as they were known to the public at the conclusion of the inquest.
24468 \begin_layout Standard
24469 You can have up to 10
24470 \begin_inset space ~
24473 columns if you want to, but that might not be very pleasant for the readers
24477 \begin_layout Standard
24478 \begin_inset Newpage newpage
24484 \begin_layout Subsection
24485 Columns inside Columns
24488 \begin_layout Standard
24489 You can also have columns inside columns:
24492 \begin_layout Standard
24493 \begin_inset Flex Multiple Columns
24496 \begin_layout Plain Layout
24499 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24500 at that time governor of one of the Australian colonies.
24501 Adair's mother had returned from Australia to undergo the operation for
24502 cataract, and she, her son Ronald, and her daughter Hilda were living together
24506 \begin_layout Plain Layout
24507 \begin_inset Flex Multiple Columns
24510 \begin_layout Plain Layout
24513 The youth moved in the best society–had, so far as was known, no enemies
24514 and no particular vices.
24515 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24516 had been broken off by mutual consent some months before, and there was
24517 no sign that it had left any very profound feeling behind it.
24518 For the rest {sic} the man's life moved in a narrow and conventional circle,
24519 for his habits were quiet and his nature unemotional.
24520 Yet it was upon this easy-going young aristocrat that death came, in most
24521 strange and unexpected form, between the hours of ten and eleven-twenty
24522 on the night of March 30, 1894.
24530 \begin_layout Plain Layout
24533 Ronald Adair was fond of cards–playing continually, but never for such stakes
24535 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24536 It was shown that, after dinner on the day of his death, he had played
24537 a rubber of whist at the latter club.
24538 He had also played there in the afternoon.
24543 The evidence of those who had played with him– Mr.
24544 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24545 and that there was a fairly equal fall of the cards.
24546 Adair might have lost five pounds, but not more.
24547 His fortune was a considerable one, and such a loss could not in any way
24549 He had played nearly every day at one club or other, but he was a cautious
24550 player, and usually rose a winner.
24551 It came out in evidence that, in partnership with Colonel Moran, he had
24552 actually won as much as four hundred and twenty pounds in a sitting, some
24553 weeks before, from Godfrey Milner and Lord Balmoral.
24554 So much for his recent history as it came out at the inquest.
24562 \begin_layout Subsection
24566 \begin_layout Standard
24567 The examples in this section show some more special features of multiple
24571 \begin_layout Standard
24572 For more features of multiple columns, have a look at the documentation
24573 of the \SpecialChar LaTeX
24579 \begin_inset CommandInset citation
24588 \begin_layout Subsubsection
24592 \begin_layout Standard
24593 To add a preface text for multiple columns, set the cursor into the multicolumn
24594 inset and use the menu
24596 Insert\SpecialChar menuseparator
24600 Write your preface text into that inset.
24601 \begin_inset Newline newline
24604 This is an example with some preface text:
24607 \begin_layout Standard
24608 \begin_inset VSpace bigskip
24614 \begin_layout Standard
24615 \begin_inset Flex Multiple Columns
24618 \begin_layout Plain Layout
24619 \begin_inset Argument 2
24622 \begin_layout Plain Layout
24623 And the story continues and continues and continues and continues\SpecialChar ldots
24631 On the evening of the crime, he returned from the club exactly at ten.
24632 His mother and sister were out spending the evening with a relation.
24633 The servant deposed that she heard him enter the front room on the second
24634 floor, generally used as his sitting-room.
24635 She had lit a fire there, and as it smoked she had opened the window.
24636 No sound was heard from the room until eleven-twenty, the hour of the return
24637 of Lady Maynooth and her daughter.
24638 Desiring to say good-night, she attempted to enter her son's room.
24639 The door was locked on the inside, and no answer could be got to their
24640 cries and knocking.
24641 Help was obtained, and the door forced.
24642 The unfortunate young man was found lying near the table.
24643 His head had been horribly mutilated by an expanding revolver bullet, but
24644 no weapon of any sort was to be found in the room.
24652 \begin_layout Standard
24653 You can also use a section heading as the preface if you use a section command
24654 as \SpecialChar TeX
24656 For example the command
24659 \begin_layout Standard
24664 subsection{subsection title}
24667 \begin_layout Standard
24668 creates a subsection.
24669 In this example the preface is a subsubsection:
24672 \begin_layout Standard
24673 \begin_inset Flex Multiple Columns
24676 \begin_layout Plain Layout
24677 \begin_inset Argument 2
24680 \begin_layout Plain Layout
24684 \begin_layout Plain Layout
24693 This is a subsubsection heading as a preface
24697 \begin_layout Plain Layout
24711 A minute examination of the circumstances served only to make the case more
24713 In the first place, no reason could be given why the young man should have
24714 fastened the door upon the inside.
24715 There was the possibility that the murderer had done this, and had afterwards
24716 escaped by the window.
24717 The drop was at least twenty feet, however, and a bed of crocuses in full
24719 Neither the flowers nor the earth showed any sign of having been disturbed,
24720 nor were there any marks upon the narrow strip of grass which separated
24721 the house from the road.
24722 Apparently, therefore, it was the young man himself who had fastened the
24724 But how did he come by his death? No one could have climbed up to the window
24725 without leaving traces.
24726 Suppose a man had fired through the window, he would indeed be a remarkable
24727 shot who could with a revolver inflict so deadly a wound.
24728 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24729 a hundred yards of the house.
24730 No one had heard a shot.
24738 \begin_layout Standard
24739 If there is less vertical space than 6
24740 \begin_inset space ~
24743 text lines is left on the page at the beginning of the multiple columns,
24744 a page break will be inserted before the multiple columns.
24745 Depending on the number of lines of the preface text, you might want to
24747 This is done by setting the cursor into the mulitcolumn inset behind the
24748 preface (if there is any) and using the menu
24750 Insert\SpecialChar menuseparator
24752 \begin_inset space ~
24756 \begin_inset space ~
24760 \begin_inset space ~
24766 Insert into that inset the amount of space like e.
24767 \begin_inset space \thinspace{}
24771 \begin_inset space \space{}
24775 \begin_inset Quotes eld
24779 \begin_inset Quotes erd
24783 \begin_inset Newline newline
24786 In this example the space is set to 7
24787 \begin_inset space ~
24790 text lines by using
24791 \begin_inset Quotes eld
24797 \begin_inset Quotes erd
24806 needs to be inserted as \SpecialChar TeX
24810 \begin_layout Standard
24811 \begin_inset Flex Multiple Columns
24814 \begin_layout Plain Layout
24815 \begin_inset Argument 3
24818 \begin_layout Plain Layout
24823 \begin_layout Plain Layout
24839 On the evening of the crime, he returned from the club exactly at ten.
24840 His mother and sister were out spending the evening with a relation.
24841 The servant deposed that she heard him enter the front room on the second
24842 floor, generally used as his sitting-room.
24843 She had lit a fire there, and as it smoked she had opened the window.
24844 No sound was heard from the room until eleven-twenty, the hour of the return
24845 of Lady Maynooth and her daughter.
24846 Desiring to say good-night, she attempted to enter her son's room.
24847 The door was locked on the inside, and no answer could be got to their
24848 cries and knocking.
24849 Help was obtained, and the door forced.
24850 The unfortunate young man was found lying near the table.
24851 His head had been horribly mutilated by an expanding revolver bullet, but
24852 no weapon of any sort was to be found in the room.
24860 \begin_layout Subsubsection
24864 \begin_layout Standard
24865 The amount of space before and after multiple columns can be changed by
24866 changing the length
24873 For example the command
24876 \begin_layout Standard
24886 \begin_layout Standard
24887 in \SpecialChar TeX
24888 Code changes its value to 3
24889 \begin_inset space \thinspace{}
24893 The change must be made before the multiple columns' start.
24894 The predefined value is 13
24895 \begin_inset space \thinspace{}
24901 \begin_layout Standard
24909 \begin_inset space \thinspace{}
24915 \begin_layout Standard
24919 \begin_layout Plain Layout
24925 multicolsep}{2.5cm}
24933 \begin_layout Standard
24934 \begin_inset Flex Multiple Columns
24937 \begin_layout Plain Layout
24940 All day I turned these facts over in my mind, endeavouring to hit upon some
24941 theory which could reconcile them all, and to find that line of least resistanc
24942 e which my poor friend had declared to be the starting-point of every investigat
24944 I confess that I made little progress.
24945 In the evening I strolled across the Park, and found myself about six o'clock
24946 at the Oxford Street end of Park Lane.
24947 A group of loafers upon the pavements, all staring up at a particular window,
24948 directed me to the house which I had come to see.
24949 A tall, thin man with coloured glasses, whom I strongly suspected of being
24950 a plain-clothes detective, was pointing out some theory of his own, while
24951 the others crowded round to listen to what he said.
24952 I got as near him as I could, but his observations seemed to me to be absurd,
24953 so I withdrew again in some disgust.
24954 As I did so I struck against an elderly, deformed man, who had been behind
24955 me, and I knocked down several books which he was carrying.
24963 \begin_layout Standard
24964 \begin_inset Note Greyedout
24967 \begin_layout Plain Layout
24972 The values you set with
24978 will be used for all following multiple columns until you change them again.
24986 \begin_layout Standard
24990 \begin_layout Plain Layout
25002 \begin_inset Note Note
25005 \begin_layout Plain Layout
25006 go back to the default
25014 \begin_layout Standard
25015 \begin_inset Newpage newpage
25021 \begin_layout Subsubsection
25025 \begin_layout Standard
25026 A column break can be forced by inserting the command
25032 as \SpecialChar TeX
25033 Code to that position in the text where the column should be broken.
25034 Note that this leads in most cases to whitespace in the text.
25035 \begin_inset Newline newline
25038 Here is an example:
25041 \begin_layout Standard
25042 \begin_inset Flex Multiple Columns
25045 \begin_layout Plain Layout
25048 \begin_inset Quotes eld
25051 You're surprised to see me, sir,
25052 \begin_inset Quotes erd
25055 said he, in a strange, croaking voice.
25058 \begin_layout Plain Layout
25061 I acknowledged that I was.
25064 \begin_layout Plain Layout
25067 \begin_inset Quotes eld
25070 Well, I've a conscience, sir, and when I chanced to see you go into this
25071 house, as I came hobbling after you, I thought to myself, I'll just step
25072 in and see that kind gentleman, and tell him that if I was a bit gruff
25073 in my manner there was not any harm meant, and that I am much obliged to
25074 him for picking up my books.
25075 \begin_inset Quotes erd
25081 \begin_layout Plain Layout
25084 \begin_inset Quotes eld
25087 You make too much of a trifle,
25088 \begin_inset Quotes erd
25093 \begin_inset Quotes eld
25096 May I ask how you knew who I was?
25097 \begin_inset Quotes erd
25100 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25104 \begin_layout Plain Layout
25116 \begin_layout Plain Layout
25119 \begin_inset Quotes eld
25122 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25123 you'll find my little bookshop at the corner of Church Street, and very
25124 happy to see you, I am sure.
25125 Maybe you collect yourself, sir.
25129 \begin_inset space ~
25142 –a bargain, every one of them.
25143 With five volumes you could just fill that gap on that second shelf.
25144 It looks untidy, does it not, sir?
25145 \begin_inset Quotes erd
25156 \begin_layout Subsubsection
25160 \begin_layout Standard
25161 The width of the columns is automatically calculated, but you can modify
25162 the space between the columns.
25163 This is done by changing the length
25170 Its predefined value is 10
25171 \begin_inset space \thinspace{}
25175 Here is an example where
25182 \begin_inset space \thinspace{}
25188 \begin_layout Standard
25192 \begin_layout Plain Layout
25206 \begin_layout Standard
25207 \begin_inset Flex Multiple Columns
25210 \begin_layout Plain Layout
25213 My observations of No.
25214 \begin_inset space \space{}
25217 427 Park Lane did little to clear up the problem in which I was interested.
25218 The house was separated from the street by a low wall and railing, the
25219 whole not more than five feet high.
25220 It was perfectly easy, therefore, for anyone to get into the garden, but
25221 the window was entirely inaccessible, since there was no water pipe or
25222 anything which could help the most active man to climb it.
25223 More puzzled than ever, I retraced my steps to Kensington.
25224 I had not been in my study five minutes when the maid entered to say that
25225 a person desired to see me.
25226 To my astonishment it was none other than my strange old book collector,
25227 his sharp, wizened face peering out from a frame of white hair, and his
25228 precious volumes, a dozen of them at least, wedged under his right arm.
25236 \begin_layout Standard
25240 \begin_layout Plain Layout
25252 \begin_inset Note Note
25255 \begin_layout Plain Layout
25256 go back to the default
25264 \begin_layout Subsubsection
25268 \begin_layout Standard
25269 Between the columns a rule with a width of the length
25276 If this rule width is set to 0
25277 \begin_inset space \thinspace{}
25280 pt (this is the default), the rule is suppressed.
25281 In the following example the rule is 2
25282 \begin_inset space \thinspace{}
25288 \begin_layout Standard
25292 \begin_layout Plain Layout
25298 columnseprule}{2pt}
25306 \begin_layout Standard
25307 \begin_inset Flex Multiple Columns
25310 \begin_layout Plain Layout
25313 \begin_inset Quotes eld
25316 You're surprised to see me, sir,
25317 \begin_inset Quotes erd
25320 said he, in a strange, croaking voice.
25323 \begin_layout Plain Layout
25326 I acknowledged that I was.
25329 \begin_layout Plain Layout
25332 \begin_inset Quotes eld
25335 Well, I've a conscience, sir, and when I chanced to see you go into this
25336 house, as I came hobbling after you, I thought to myself, I'll just step
25337 in and see that kind gentleman, and tell him that if I was a bit gruff
25338 in my manner there was not any harm meant, and that I am much obliged to
25339 him for picking up my books.
25340 \begin_inset Quotes erd
25346 \begin_layout Plain Layout
25349 \begin_inset Quotes eld
25352 You make too much of a trifle,
25353 \begin_inset Quotes erd
25358 \begin_inset Quotes eld
25361 May I ask how you knew who I was?
25362 \begin_inset Quotes erd
25368 \begin_layout Plain Layout
25371 \begin_inset Quotes eld
25374 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25375 you'll find my little bookshop at the corner of Church Street, and very
25376 happy to see you, I am sure.
25377 Maybe you collect yourself, sir.
25381 \begin_inset space ~
25394 –a bargain, every one of them.
25395 With five volumes you could just fill that gap on that second shelf.
25396 It looks untidy, does it not, sir?
25397 \begin_inset Quotes erd
25408 \begin_layout Standard
25409 \begin_inset VSpace defskip
25415 \begin_layout Standard
25416 The rule can be colored by redefining the command
25423 This is done by inserting the command
25424 \begin_inset Newline newline
25433 columnseprulecolor}{
25438 \begin_inset Newline newline
25441 as \SpecialChar TeX
25442 Code before the multicolumn inset.
25447 in this command by a color of your choice.
25448 You can use all pre- and self-defined colors.
25456 \begin_inset space ~
25461 for more information about pre- and self-defined colors.
25462 To go back to the default color insert the command
25463 \begin_inset Newline newline
25472 columnseprulecolor}{
25477 \begin_inset Newline newline
25480 Here is the example with a cyan rule and 1
25481 \begin_inset space \thinspace{}
25484 cm column separation:
25487 \begin_layout Standard
25491 \begin_layout Plain Layout
25500 \begin_layout Plain Layout
25506 columnseprulecolor}{
25516 \begin_layout Standard
25517 \begin_inset Flex Multiple Columns
25520 \begin_layout Plain Layout
25523 \begin_inset Quotes eld
25526 You're surprised to see me, sir,
25527 \begin_inset Quotes erd
25530 said he, in a strange, croaking voice.
25533 \begin_layout Plain Layout
25536 I acknowledged that I was.
25539 \begin_layout Plain Layout
25542 \begin_inset Quotes eld
25545 Well, I've a conscience, sir, and when I chanced to see you go into this
25546 house, as I came hobbling after you, I thought to myself, I'll just step
25547 in and see that kind gentleman, and tell him that if I was a bit gruff
25548 in my manner there was not any harm meant, and that I am much obliged to
25549 him for picking up my books.
25550 \begin_inset Quotes erd
25556 \begin_layout Plain Layout
25559 \begin_inset Quotes eld
25562 You make too much of a trifle,
25563 \begin_inset Quotes erd
25568 \begin_inset Quotes eld
25571 May I ask how you knew who I was?
25572 \begin_inset Quotes erd
25578 \begin_layout Plain Layout
25581 \begin_inset Quotes eld
25584 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25585 you'll find my little bookshop at the corner of Church Street, and very
25586 happy to see you, I am sure.
25587 Maybe you collect yourself, sir.
25591 \begin_inset space ~
25604 –a bargain, every one of them.
25605 With five volumes you could just fill that gap on that second shelf.
25606 It looks untidy, does it not, sir?
25607 \begin_inset Quotes erd
25618 \begin_layout Standard
25622 \begin_layout Plain Layout
25628 columnseprule}{0pt}
25631 \begin_layout Plain Layout
25637 columnseprulecolor}{
25645 \begin_inset Note Note
25648 \begin_layout Plain Layout
25649 go back to the default
25657 \begin_layout Section
25658 Non-standard Paragraph Shapes
25661 \begin_layout Standard
25664 as well as any other text processor uses by default rectangular paragraphs.
25665 For special cases like for example posters, invitation cards or poems you
25666 can modify the paragraph shape to one of your choice.
25667 This can be done by using the \SpecialChar LaTeX
25672 which is loaded by using in the document settings the module
25674 Custom paragraph shapes
25679 \begin_layout Subsection
25683 \begin_layout Standard
25688 provides the following shapes:
25691 \begin_layout Standard
25692 \begin_inset Tabular
25693 <lyxtabular version="3" rows="13" columns="3">
25694 <features booktabs="true" islongtable="true" longtabularalignment="center">
25695 <column alignment="center" valignment="middle" width="16col%">
25696 <column alignment="center" valignment="middle" width="40col%">
25697 <column alignment="center" valignment="middle" width="35col%">
25698 <row endhead="true">
25699 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25702 \begin_layout Plain Layout
25708 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25711 \begin_layout Plain Layout
25717 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25720 \begin_layout Plain Layout
25728 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25731 \begin_layout Plain Layout
25737 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25740 \begin_layout Plain Layout
25741 Circle with circular hole (in the size of a CD/DVD)
25746 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25749 \begin_layout Plain Layout
25750 Cannot be scaled, take care there is not too much text
25757 <cell alignment="center" valignment="top" topline="true" usebox="none">
25760 \begin_layout Plain Layout
25766 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25769 \begin_layout Plain Layout
25775 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25778 \begin_layout Plain Layout
25779 Fragile, calculation might fail
25786 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25789 \begin_layout Plain Layout
25795 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25798 \begin_layout Plain Layout
25799 Rhomboid (symbolizing a
25800 \begin_inset Quotes eld
25804 \begin_inset Quotes erd
25812 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25815 \begin_layout Plain Layout
25823 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25826 \begin_layout Plain Layout
25832 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25835 \begin_layout Plain Layout
25841 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25844 \begin_layout Plain Layout
25852 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25855 \begin_layout Plain Layout
25861 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25864 \begin_layout Plain Layout
25870 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25873 \begin_layout Plain Layout
25881 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25884 \begin_layout Plain Layout
25890 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25893 \begin_layout Plain Layout
25894 Nut for bolt (hexagon with circular hole)
25899 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25902 \begin_layout Plain Layout
25910 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25913 \begin_layout Plain Layout
25919 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25922 \begin_layout Plain Layout
25928 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25931 \begin_layout Plain Layout
25939 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25942 \begin_layout Plain Layout
25948 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25951 \begin_layout Plain Layout
25957 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25960 \begin_layout Plain Layout
25968 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25971 \begin_layout Plain Layout
25977 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
25980 \begin_layout Plain Layout
25986 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
25989 \begin_layout Plain Layout
25997 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26000 \begin_layout Plain Layout
26006 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26009 \begin_layout Plain Layout
26010 Normal/reversed rain drop
26015 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26018 \begin_layout Plain Layout
26019 Fragile, calculation might fail
26026 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26029 \begin_layout Plain Layout
26036 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26039 \begin_layout Plain Layout
26040 The \SpecialChar TeX
26046 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26049 \begin_layout Plain Layout
26057 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26060 \begin_layout Plain Layout
26062 \begin_inset Newline newline
26070 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26073 \begin_layout Plain Layout
26074 Triangles in different orientations
26079 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26082 \begin_layout Plain Layout
26096 \begin_layout Standard
26097 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26099 for environments in the toolbar.
26102 \begin_layout Standard
26103 \begin_inset Newpage newpage
26109 \begin_layout Standard
26110 Here is an example paragraph in the shape of a nut:
26113 \begin_layout Standard
26114 \begin_inset VSpace bigskip
26123 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26124 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26126 At vero eos et accusam et justo duo dolores et ea rebum.
26127 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26129 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26130 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26134 \begin_layout Standard
26135 \begin_inset VSpace bigskip
26141 \begin_layout Standard
26142 \begin_inset Note Greyedout
26145 \begin_layout Plain Layout
26150 : shapepar paragraphs cannot run over a page break.
26158 \begin_layout Standard
26159 \begin_inset VSpace bigskip
26165 \begin_layout Standard
26170 takes care that the shape will always be preserved, no matter how much
26171 text is in the paragraph.
26172 Therefore the paragraph size changes with the amount of contained text.
26173 This can lead to paragraph sizes exceeding the page margins.
26174 To demonstrate the size scaling, here is the same example paragraph but
26175 with twice as much text:
26178 \begin_layout Standard
26179 \begin_inset Newpage newpage
26188 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26189 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26191 At vero eos et accusam et justo duo dolores et ea rebum.
26192 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26194 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26195 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26197 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26198 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26200 At vero eos et accusam et justo duo dolores et ea rebum.
26201 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26203 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26204 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26208 \begin_layout Standard
26209 \begin_inset VSpace bigskip
26215 \begin_layout Standard
26216 An exception is the shape
26221 It cannot be scaled because it must fit the size of a CD/DVD.
26222 Therefore the amount of text that fits into the shape is limited.
26223 \begin_inset Newline newline
26234 shape are fragile, meaning that the calculation of their size can fail,
26235 depending on the amount of text.
26236 You will then get the \SpecialChar LaTeX
26238 \begin_inset Quotes eld
26241 Arithmetic overflow
26242 \begin_inset Quotes erd
26246 In this case one can try to remove or add some text; if nothing works one
26247 has to use another shape.
26250 \begin_layout Standard
26251 \begin_inset VSpace bigskip
26257 \begin_layout Standard
26258 For shapes with tips you will maybe see that \SpecialChar LaTeX
26259 's hyphenation routine fails
26260 for text in the tips.
26261 Therefore it is often necessary to add hyphenation points
26266 arg "specialchar-insert hyphenation"
26271 ) to the corresponding text parts.
26274 \begin_layout Standard
26275 \begin_inset VSpace bigskip
26281 \begin_layout Standard
26282 Shapepar paragraphs are either always centered or placed on the page so
26283 that their left border touches the left page margin.
26284 You can therefore not use the paragraph dialog to align such paragraphs.
26285 A solution is to put the paragraph into a minipage or parbox and align
26287 The problem is hereby to find the right width for the box.
26288 Because if it is too wide and you center the box, the paragraph is not
26289 centered too because it sticks at the left side of the box.
26290 So you might have to play a bit with the width until it fits.
26291 Here are two heart-shaped paragraphs, the first one is not aligned, the
26292 second one is right-aligned:
26295 \begin_layout Standard
26296 \begin_inset Newpage newpage
26302 \begin_layout Heart
26306 Lo\SpecialChar softhyphen
26307 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26308 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26310 At vero eos et accusam et justo duo dolores et ea rebum.
26311 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26315 \begin_layout Standard
26316 \begin_inset VSpace bigskip
26322 \begin_layout Standard
26325 \begin_inset Box Frameless
26335 height_special "totalheight"
26340 backgroundcolor "none"
26343 \begin_layout Heart
26347 Lo\SpecialChar softhyphen
26348 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26349 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26351 At vero eos et accusam et justo duo dolores et ea rebum.
26352 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26361 \begin_layout Subsection
26365 \begin_layout Standard
26366 You can define any shape you want.
26367 Doing this manually is a lot of work because every coordinate must be specified.
26368 But there is a way to let the computer calculate the coordinates:
26371 \begin_layout Enumerate
26372 Install the program
26373 \begin_inset CommandInset href
26376 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26383 \begin_layout Enumerate
26390 TeX/LaTeX\SpecialChar menuseparator
26391 Settings\SpecialChar menuseparator
26394 and select the font size you are using in your document.
26395 For example this document uses the size 12
26396 \begin_inset space \thinspace{}
26402 \begin_layout Enumerate
26406 \begin_layout Enumerate
26409 TeX/LaTeX\SpecialChar menuseparator
26412 to export the shape to coordinates.
26413 In the appearing dialog use either the outline of your shape for the coordinate
26414 s or the path itself.
26418 \begin_layout Plain Layout
26419 For more information see
26420 \begin_inset CommandInset href
26422 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26434 \begin_layout Standard
26435 The coordinates are written into a \SpecialChar TeX
26437 To use it for your \SpecialChar LyX
26441 \begin_layout Enumerate
26442 Place the cursor before the first character of your paragraph (or into a
26446 \begin_layout Enumerate
26447 Open in \SpecialChar LyX
26450 Insert\SpecialChar menuseparator
26451 File\SpecialChar menuseparator
26453 \begin_inset space ~
26458 , select the file and use
26467 \begin_layout Standard
26468 \begin_inset VSpace defskip
26474 \begin_layout Standard
26475 \begin_inset Note Greyedout
26478 \begin_layout Plain Layout
26483 : The changed shape only applies to the current paragraph; everything is
26484 reset to normal for the next paragraph.
26485 Therefore the shape definition file must be input into every paragraph
26486 with the desired shape.
26494 \begin_layout Standard
26495 \begin_inset VSpace bigskip
26501 \begin_layout Standard
26502 Here is an example:
26505 \begin_layout Standard
26506 \begin_inset VSpace bigskip
26512 \begin_layout Standard
26513 \begin_inset CommandInset include
26515 filename "SpecialParagraphShape.tex"
26521 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26522 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26524 At vero eos et accusam et justo duo dolores et ea rebum.
26525 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26527 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26528 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26532 \begin_layout Standard
26533 \begin_inset VSpace bigskip
26539 \begin_layout Standard
26544 to draw complexer shapes in
26548 you can draw the shape in a program of your choice and import the resulting
26554 Then you only need to draw a line or spline along the outline of the image.
26557 \begin_layout Standard
26558 \begin_inset VSpace bigskip
26564 \begin_layout Standard
26567 Custom paragraph shapes
26569 also provides the two commands
26577 which can be used to define custom shapes coordinate by coordinate.
26581 \begin_layout Plain Layout
26582 These commands are internally used for all shapes described here.
26587 For information how these styles are used and about further customization
26588 possibilities, have a look at the documentation of the package
26593 \begin_inset CommandInset citation
26602 \begin_layout Bibliography
26603 \begin_inset CommandInset bibitem
26604 LatexCommand bibitem
26609 Documentation of the \SpecialChar LaTeX
26611 \begin_inset CommandInset href
26614 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26621 \begin_layout Bibliography
26622 \begin_inset CommandInset bibitem
26623 LatexCommand bibitem
26628 Documentation of the \SpecialChar LaTeX
26630 \begin_inset CommandInset href
26633 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"