1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children false
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
53 \font_sf_scale 100 100
54 \font_tt_scale 100 100
56 \use_dash_ligatures true
58 \default_output_format pdf2
60 \bibtex_command default
61 \index_command default
65 \pdf_title "LyX's Additional Features manual"
66 \pdf_author "LyX Team"
67 \pdf_subject "LyX's additional features documentation"
68 \pdf_keywords "LyX, Documentation, Additional"
70 \pdf_bookmarksnumbered true
71 \pdf_bookmarksopen false
72 \pdf_bookmarksopenlevel 1
77 \pdf_pdfusetitle false
78 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
81 \use_package amsmath 1
82 \use_package amssymb 1
85 \use_package mathdots 1
86 \use_package mathtools 0
88 \use_package stackrel 0
89 \use_package stmaryrd 0
90 \use_package undertilde 0
92 \cite_engine_type default
96 \paperorientation portrait
100 \notefontcolor #0000ff
107 \paragraph_separation indent
108 \paragraph_indentation default
110 \quotes_style english
114 \paperpagestyle headings
115 \tracking_changes true
116 \output_changes false
120 \author -712698321 "Jürgen Spitzmüller"
126 Additional \SpecialChar LyX
130 \begin_layout Subtitle
135 by the \SpecialChar LyX
140 \begin_layout Plain Layout
142 Principal maintainer of this file is
147 If you have comments or error corrections, please send them to the \SpecialChar LyX
150 \begin_inset Flex Code
153 \begin_layout Plain Layout
155 <lyx-docs@lists.lyx.org>
168 \begin_layout Standard
169 \begin_inset CommandInset toc
170 LatexCommand tableofcontents
177 \begin_layout Chapter
181 \begin_layout Standard
182 This manual is essentially Part II of the
184 User's Guide\SpecialChar endofsentence
187 The reason for separating the two documents is simple: the
191 is already quite lengthy, and it contains information on all of the basic
192 features one needs to know in order to prepare most documents.
193 However, the \SpecialChar LyX
194 Team has worked to make \SpecialChar LyX
195 extensible through various configuration
196 files and external packages.
197 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
199 create a layout file (or module) for it without having to alter \SpecialChar LyX
201 We've already had contributions of several new features this way, and some
202 of them are documented here.
203 There are also some more `advanced' features, such as how to control the
204 presentation of bibliographies and how to work with multi-part documents,
205 that are not covered in the
209 and are discussed here.
212 \begin_layout Standard
213 This manual also documents some special features, like fax support, version
214 control, and SGML support, which require additional software to work properly.
215 There is also a chapter on \SpecialChar LyX
217 And lastly, there's a chapter of \SpecialChar LaTeX
218 tools and tips, things you can use to
219 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
221 After all, \SpecialChar LyX
226 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
230 \begin_layout Standard
231 If you haven't read the
235 yet, you are definitely in the wrong manual.
240 is the first place to go, since it describes the notation and format of
242 You should also be thoroughly familiar with the
246 and all of the basic features of \SpecialChar LyX
247 before attempting to read this one.
250 \begin_layout Standard
251 Since many of the topics in this manual depend heavily on \SpecialChar LyX
253 with \SpecialChar LaTeX
254 , this first chapter covers the inner workings of \SpecialChar LyX
257 to generate exactly the \SpecialChar LaTeX
259 It is obviously for more seasoned \SpecialChar LyX
263 \begin_layout Chapter
265 and \SpecialChar LaTeX
269 \begin_layout Section
271 Uses \SpecialChar LaTeX
275 \begin_layout Standard
276 This chapter is for both \SpecialChar TeX
277 -nicians and the \SpecialChar LaTeX
279 In it, we'll explain how \SpecialChar LyX
280 and \SpecialChar LaTeX
281 work together to produce printable output.
282 This is the only place in any of the manuals where we assume you know something
283 about \SpecialChar LaTeX
287 \begin_layout Standard
288 At one time, \SpecialChar LyX
290 \begin_inset Quotes eld
293 WYSIWYM frontend to \SpecialChar LaTeX
295 \begin_inset Quotes erd
298 but that's no longer true.
299 There are frontends to \SpecialChar LaTeX
304 \begin_layout Plain Layout
305 Some familar ones are \SpecialChar TeX
306 maker and kile, on Linux, and \SpecialChar TeX
308 There are also the \SpecialChar LaTeX
309 modes for vi and emacs, of course.
314 These are basically text editors with the ability to run \SpecialChar LaTeX
316 errors in the file you're editing.
317 Although \SpecialChar LyX
326 run \SpecialChar LaTeX
327 , and it also indicates errors in the file, it also does much, much
329 For one thing, you don't need to know \SpecialChar LaTeX
330 to use \SpecialChar LyX
333 has added its own extensions to \SpecialChar LaTeX
335 Try the following sometime: select
336 \begin_inset Flex Noun
339 \begin_layout Plain Layout
340 Export\SpecialChar menuseparator
347 \begin_inset Flex Noun
350 \begin_layout Plain Layout
357 \begin_inset Flex Noun
360 \begin_layout Plain Layout
361 View\SpecialChar menuseparator
371 ), then look at the preamble of the resulting
372 \begin_inset Flex Code
375 \begin_layout Plain Layout
382 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
384 These macros are defined automatically, according to the features you use
388 \begin_layout Standard
389 There are several commands that automatically invoke \SpecialChar LaTeX
394 \begin_layout Itemize
395 \begin_inset Flex Noun
398 \begin_layout Plain Layout
399 Document\SpecialChar menuseparator
408 \begin_layout Itemize
409 \begin_inset Flex Noun
412 \begin_layout Plain Layout
413 Document\SpecialChar menuseparator
422 \begin_layout Standard
423 They will only invoke \SpecialChar LaTeX
424 if the file has changed since the last time \SpecialChar LaTeX
430 \begin_layout Standard
431 When \SpecialChar LyX
432 runs \SpecialChar LaTeX
433 on the file you're editing, it performs these steps:
436 \begin_layout Enumerate
437 Convert the document to \SpecialChar LaTeX
438 and save to a file with the extension
439 \begin_inset Flex Code
442 \begin_layout Plain Layout
449 \begin_inset Flex Code
452 \begin_layout Plain Layout
461 \begin_layout Enumerate
462 Run \SpecialChar LaTeX
464 \begin_inset Flex Code
467 \begin_layout Plain Layout
473 file (maybe several times), and run any other commands (such as
474 \begin_inset Flex Code
477 \begin_layout Plain Layout
484 \begin_inset Flex Code
487 \begin_layout Plain Layout
493 ) needed to compile the \SpecialChar LaTeX
497 \begin_layout Enumerate
498 If there are any errors, show the error log.
501 \begin_layout Standard
502 If you have run \SpecialChar LaTeX
504 \begin_inset Flex Noun
507 \begin_layout Plain Layout
508 View\SpecialChar menuseparator
515 then runs a DVI viewer to display the DVI-file.
517 \begin_inset Flex Noun
520 \begin_layout Plain Layout
521 View\SpecialChar menuseparator
528 performs further steps:
531 \begin_layout Itemize
533 \begin_inset Flex Code
536 \begin_layout Plain Layout
542 to convert the DVI file to PostScript.
545 \begin_layout Itemize
546 Run a PostScript viewer, such as
547 \begin_inset Flex Code
550 \begin_layout Plain Layout
556 , to display the PostScript file.
559 \begin_layout Standard
561 does similar things when viewing, or exporting, other formats.
564 \begin_layout Section
565 Translating \SpecialChar LaTeX
566 files into \SpecialChar LyX
570 \begin_layout Standard
571 You can import a \SpecialChar LaTeX
572 file into \SpecialChar LyX
574 \begin_inset Flex Noun
577 \begin_layout Plain Layout
578 File\SpecialChar menuseparator
579 Import\SpecialChar menuseparator
585 command in \SpecialChar LyX
587 This will call a program named
588 \begin_inset Flex Code
591 \begin_layout Plain Layout
597 which will create a file
598 \begin_inset Flex Code
601 \begin_layout Plain Layout
608 \begin_inset Flex Code
611 \begin_layout Plain Layout
619 will then open that file.
623 \begin_layout Plain Layout
624 \begin_inset Flex Code
627 \begin_layout Plain Layout
633 can also be run from the command line, of course.
641 \begin_layout Standard
642 \begin_inset Flex Code
645 \begin_layout Plain Layout
651 will translate most legal \SpecialChar LaTeX
652 , but not everything.
653 It will put things it doesn't understand into \SpecialChar TeX
654 code, so after translating
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
665 , you can look for \SpecialChar TeX
666 code and hand-edit it until it looks right.
669 \begin_layout Standard
670 If you don't know what \SpecialChar TeX
671 code is, read the next section.
674 \begin_layout Section
675 \begin_inset CommandInset label
677 name "sec:Inserting-TeX-Code"
681 Inserting \SpecialChar TeX
682 Code into \SpecialChar LyX
686 \begin_layout Standard
687 Anything you can do in \SpecialChar LaTeX
688 you can do in \SpecialChar LyX
689 , for a very simple reason: You can
690 always insert \SpecialChar TeX
691 code into any \SpecialChar LyX
694 cannot, and will never be able to, display every possible \SpecialChar LaTeX
696 If ever you need to insert \SpecialChar LaTeX
697 commands into your \SpecialChar LyX
698 document, you can use the
700 \begin_inset Flex Code
703 \begin_layout Plain Layout
710 box, which you can insert into your document with
711 \begin_inset Flex Noun
714 \begin_layout Plain Layout
715 Insert\SpecialChar menuseparator
725 or the keyboard shortcut
734 \begin_layout Standard
735 Here's an example of inserting \SpecialChar LaTeX
736 commands in a \SpecialChar LyX
738 The code looks like this:
741 \begin_layout LyX-Code
745 \begin_inset Newline newline
751 \begin_inset Newline newline
754 This is an example of a minipage environment.
756 \begin_inset Newline newline
759 can put nearly everything in it, even (non-floating)
760 \begin_inset Newline newline
765 \begin_inset Newline newline
771 \begin_inset Newline newline
775 \begin_inset Newline newline
781 \begin_inset Newline newline
787 \begin_inset Newline newline
793 \begin_inset Newline newline
798 \begin_inset Newline newline
804 \begin_inset Newline newline
810 \begin_inset Newline newline
816 \begin_inset Newline newline
824 \begin_layout LyX-Code
828 \begin_layout Standard
830 \begin_inset Flex Code
833 \begin_layout Plain Layout
840 box containing this text is directly after this paragraph.
841 Those of you reading the manual in \SpecialChar LyX
842 will only see the \SpecialChar TeX
844 Those reading a printed version of the manuals will see the actual results:
845 \begin_inset VSpace bigskip
851 \begin_layout Standard
855 \begin_layout Plain Layout
862 \begin_layout Plain Layout
869 \begin_layout Plain Layout
871 This is an example of a minipage environment.
872 You can put nearly everything in it, even (non-floating) figures and tables.
876 \begin_layout Plain Layout
883 \begin_layout Plain Layout
888 \begin_layout Plain Layout
895 \begin_layout Plain Layout
902 \begin_layout Plain Layout
909 \begin_layout Plain Layout
915 \begin_layout Plain Layout
922 \begin_layout Plain Layout
929 \begin_layout Plain Layout
936 \begin_layout Plain Layout
946 \begin_inset VSpace bigskip
952 \begin_layout Standard
953 In addition to using \SpecialChar TeX
954 code, you can also create a separate file containing
955 some complex \SpecialChar LaTeX
956 structure and then use
957 \begin_inset Flex Noun
960 \begin_layout Plain Layout
961 Insert\SpecialChar menuseparator
971 to include your file (you should select the type
972 \begin_inset Flex Code
975 \begin_layout Plain Layout
982 We recommend that you only do this if you have a
983 \begin_inset Flex Code
986 \begin_layout Plain Layout
997 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1001 \begin_layout Standard
1002 There are a few last points to emphasize:
1005 \begin_layout Itemize
1011 check if your \SpecialChar LaTeX
1015 \begin_layout Itemize
1016 Beware of reinventing the wheel.
1019 \begin_layout Standard
1020 On that last point, \SpecialChar LyX
1021 does have quite a few features tucked into it, and
1023 Be sure to check the manuals to make sure that \SpecialChar LyX
1024 doesn't have such-and-such
1025 feature before you decide you have to do it by hand.
1026 Moreover, there are numerous \SpecialChar LaTeX
1027 packages out there to do all sorts of things,
1028 from labels to envelopes to fancy multipage tables.
1030 \begin_inset CommandInset href
1033 target "http://www.ctan.org/"
1041 \begin_layout Standard
1042 If you do need to do some wild and fancy things within your document, be
1043 sure to check out a good \SpecialChar LaTeX
1044 book for assistance.
1045 There are a number of them listed in the bibliography of the
1052 \begin_layout Section
1054 and the \SpecialChar LaTeX
1058 \begin_layout Subsection
1059 About the \SpecialChar LaTeX
1063 \begin_layout Standard
1064 If you already know \SpecialChar LaTeX
1065 , there is no need to explain here what the preamble
1067 If you don't, the following will give you some ideas—we recommend again
1068 that you consult a \SpecialChar LaTeX
1069 book for further information.
1070 In any case, you should read the points below, because they explain what
1071 you can do and what you don't need to do in the \SpecialChar LaTeX
1072 preamble of a \SpecialChar LyX
1076 \begin_layout Standard
1077 The \SpecialChar LaTeX
1078 preamble comes at the very beginning of a document,
1086 \begin_layout Itemize
1087 Declare the document class.
1089 \begin_inset Newline newline
1093 already does this for you.
1094 If you're a seasoned \SpecialChar LaTeX
1095 -nician, and you have a custom document class you
1096 want to use, check out the
1098 Customization Manual
1100 for information on how to make \SpecialChar LyX
1104 \begin_layout Itemize
1105 Declare the usage of packages.
1107 \begin_inset Newline newline
1111 packages provide special commands, which are only available within a document
1112 when the package has been declared in the preamble.
1113 In addition to providing special commands, the inclusion of a package can
1114 change the document.
1115 For example, the package
1116 \begin_inset Flex Code
1119 \begin_layout Plain Layout
1125 forces all paragraphs to be indented.
1126 There are other packages for labels, envelopes, margins, etc.
1130 \begin_layout Itemize
1131 Set counters, variables, lengths and widths.
1133 \begin_inset Newline newline
1136 There are several \SpecialChar LaTeX
1137 counters and variables that
1141 be set globally from within the preamble in order to have the desired effect.
1142 (There are variables that you can set and reset inside the document, too.)
1143 Margins are a good example of something that must be set in the preamble.
1144 Another example is the label format for lists.
1145 You can actually set these just about anywhere, but it's best to do it
1146 just once, inside the preamble.
1149 \begin_layout Itemize
1150 Declare user defined commands (with
1151 \begin_inset Flex Code
1154 \begin_layout Plain Layout
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1175 \begin_inset Newline newline
1178 These are abbreviations for \SpecialChar LaTeX
1179 commands which appear very often inside a document.
1180 Although the preamble is a good place to declare such commands, they
1184 be declared anywhere (before they are used for the first time, of course).
1185 This can be useful if there is a lot of raw \SpecialChar LaTeX
1186 code in your document, which
1187 normally should not be the case.
1190 \begin_layout Standard
1192 adds its own set of definitions to the preamble of the
1193 \begin_inset Flex Code
1196 \begin_layout Plain Layout
1203 This makes \SpecialChar LaTeX
1204 files generated by \SpecialChar LyX
1208 \begin_layout Subsection
1209 Changing the Preamble
1212 \begin_layout Standard
1213 The commands which \SpecialChar LyX
1214 adds to the preamble of a \SpecialChar LaTeX
1215 file are fixed; you can't
1216 change them without patching \SpecialChar LyX
1218 You can, however, add your own stuff to the preamble by selecting
1219 \begin_inset Flex Noun
1222 \begin_layout Plain Layout
1225 \begin_inset space ~
1234 \begin_inset Flex Noun
1237 \begin_layout Plain Layout
1238 Document\SpecialChar menuseparator
1246 adds anything in the
1247 \begin_inset Flex Noun
1250 \begin_layout Plain Layout
1256 dialog to its own built-in preamble.
1257 Before adding your own declarations in the preamble, you should make sure
1258 that \SpecialChar LyX
1259 doesn't already support what you want to do.
1260 (Remember what we said about reinventing the wheel?) Also,
1262 make sure your preamble code is correct
1266 doesn't check it for you.
1267 If there is an error, you're likely to get an error like
1268 \begin_inset Quotes eld
1272 \begin_inset Flex Code
1275 \begin_layout Plain Layout
1284 \begin_inset Quotes erd
1288 If you see this error, check your preamble.
1291 \begin_layout Subsection
1295 \begin_layout Standard
1296 Here are some examples of what you can add to a preamble, and what they
1300 \begin_layout Subsubsection
1304 \begin_layout Standard
1305 There are two variables under \SpecialChar LaTeX
1306 that control page position:
1307 \begin_inset Flex Code
1310 \begin_layout Plain Layout
1319 \begin_inset Flex Code
1322 \begin_layout Plain Layout
1331 Their names should be self-explanatory.
1332 These variables are useful if you think for a moment about computer labels.
1333 Sometimes, the size of a print medium and the area of the medium that you
1334 can actually print on aren't the same.
1336 \begin_inset Flex Code
1339 \begin_layout Plain Layout
1348 \begin_inset Flex Code
1351 \begin_layout Plain Layout
1362 \begin_layout Standard
1363 The default values for
1364 \begin_inset Flex Code
1367 \begin_layout Plain Layout
1376 \begin_inset Flex Code
1379 \begin_layout Plain Layout
1388 \begin_inset space \thinspace{}
1392 \begin_inset space \thinspace{}
1396 \begin_inset space \space{}
1399 the page isn't shifted.
1400 Unfortunately, some DVI drivers always seem to shift the page.
1401 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1402 If you're using \SpecialChar LyX
1403 on a system that you don't personally maintain, and your
1404 sysadmin is a doofus,
1405 \begin_inset Flex Code
1408 \begin_layout Plain Layout
1417 \begin_inset Flex Code
1420 \begin_layout Plain Layout
1429 Suppose your left and top margins are always 0.5
1430 \begin_inset space \thinspace{}
1434 You can add this to the preamble:
1437 \begin_layout LyX-Code
1445 \begin_layout LyX-Code
1453 \begin_layout Standard
1454 and your margins should now be correct.
1457 \begin_layout Subsubsection
1461 \begin_layout Standard
1462 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1463 There's a rather nice package, available at your nearest CTAN archive,
1464 for printing sheets of labels:
1465 \begin_inset Flex Code
1468 \begin_layout Plain Layout
1475 Now, your system may not have this package installed by default.
1476 We leave that up to you to check.
1477 You'll also want to read the documentation for it; we're not going to do
1479 Since this is an example, however, we'll give you an example of how you
1483 \begin_layout Standard
1484 First, make sure you're using the
1485 \begin_inset Flex Code
1488 \begin_layout Plain Layout
1495 Next, you need to put the following in your preamble:
1498 \begin_layout LyX-Code
1504 \begin_layout LyX-Code
1510 \begin_layout LyX-Code
1516 \begin_layout LyX-Code
1522 \begin_layout LyX-Code
1528 \begin_layout LyX-Code
1534 \begin_layout LyX-Code
1540 \begin_layout Standard
1541 This sets things up for Avery label sheets, stock #5360.
1542 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1545 \begin_inset Flex Code
1548 \begin_layout Plain Layout
1557 \begin_inset Flex Code
1560 \begin_layout Plain Layout
1568 around each label text.
1569 This and other special features of
1570 \begin_inset Flex Code
1573 \begin_layout Plain Layout
1579 are explained in its documentation.
1582 \begin_layout Standard
1583 Someday, someone may write a \SpecialChar LyX
1584 layout file to support this package directly.
1585 Maybe that someone is you.
1588 \begin_layout Subsubsection
1589 Example #3: Paragraph Indentation
1592 \begin_layout Standard
1593 Americans are trained to indent the first line of
1598 As with all of their other weird quirks, most Americans will whine and
1599 moan until they can have their way and indent the first line of all paragraphs.
1608 \begin_layout Standard
1609 Of course, this behavior isn't standard typography.
1610 In books, you typically only indent the first line of a paragraph
1614 it follows another one.
1615 The idea behind indenting the first line of a paragraph is to distinguish
1616 neighboring paragraphs from one another.
1617 If there is no previous paragraph—for example, if it follows a figure or
1618 is the first paragraph in a section—then there is no need for indentation.
1622 \begin_layout Standard
1623 If you're a typical American (we're still joking!), though, you don't care
1624 about such esoteric things; you want your indentation! Add this to the
1628 \begin_layout LyX-Code
1631 usepackage{indentfirst}
1634 \begin_layout Standard
1635 If your \SpecialChar TeX
1636 distribution isn't braindead, you'll have this package, and all
1637 of your paragraphs will get the indentation the Founding Fathers intended
1641 \begin_layout Subsubsection
1642 Example #4: This Document
1645 \begin_layout Standard
1646 You can also check out the preamble of this document to get an idea of some
1647 of the advanced things you can do.
1650 \begin_layout Section
1652 and \SpecialChar LaTeX
1656 \begin_layout Standard
1657 When \SpecialChar LyX
1658 calls \SpecialChar LaTeX
1659 , it tells \SpecialChar LaTeX
1660 to blithely ignore any errors and keep going.
1661 It then uses the logfile from the \SpecialChar LaTeX
1662 run to do a post-mortem.
1663 After analyzing the logfile, \SpecialChar LyX
1664 displays a dialog listing the errors.
1665 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1667 where the error occurred.
1671 \begin_layout Plain Layout
1673 Analyzing the logfile is a tough job, and \SpecialChar LyX
1674 doesn't always go to the right
1676 There are also cases where \SpecialChar LaTeX
1677 reports the error on one line, but the actual
1679 This is not unlike forgetting a closing brace in a program: You'll get
1680 an error, but only later.
1688 \begin_layout Standard
1689 Some folks also like to look at the log file directly: It is available from
1691 \begin_inset Flex Noun
1694 \begin_layout Plain Layout
1695 Document\SpecialChar menuseparator
1697 \begin_inset space ~
1706 There are some fairly common error messages and warnings.
1707 We'll cover those here.
1708 You should look at a good \SpecialChar LaTeX
1709 book for a complete listing.
1712 \begin_layout Itemize
1713 \begin_inset Flex Code
1716 \begin_layout Plain Layout
1723 \begin_inset Newline newline
1726 Anything beginning with these words is a warning message for the purpose
1728 \begin_inset Quotes eld
1732 \begin_inset Quotes erd
1735 the \SpecialChar LaTeX
1737 You'll get messages like this if you added or changed cross-references
1738 or bibliography entries, in which case, \SpecialChar LaTeX
1739 is trying to tell you that you
1740 need to make another run.
1741 You can by-and-large ignore these.
1744 \begin_layout Itemize
1745 \begin_inset Flex Code
1748 \begin_layout Plain Layout
1755 \begin_inset Newline newline
1758 Another warning message, this time about fonts which \SpecialChar LaTeX
1760 The rest of the message will often say something about a replacement font
1761 that \SpecialChar LaTeX
1763 You can safely ignore these, too.
1766 \begin_layout Itemize
1767 \begin_inset Flex Code
1770 \begin_layout Plain Layout
1779 \begin_inset Newline newline
1788 They are warnings about lines that were too long and run past the right
1790 Almost always, this is unnoticeable in the final output.
1791 (It can be just a point or two.) Or, only one or two characters extend past
1794 seems to generate at least one of these messages for just about any document
1796 \begin_inset Newline newline
1799 You can ignore these messages.
1800 Your eyes will tell you if there's a problem with something that's too
1801 wide; just look at the output.
1805 \begin_layout Plain Layout
1806 You can also enable the `draft' option in
1807 \begin_inset Flex Noun
1810 \begin_layout Plain Layout
1811 Document\SpecialChar menuseparator
1817 , and then \SpecialChar LaTeX
1818 will draw a black box in the margin of lines that are overfull.
1826 \begin_layout Itemize
1827 \begin_inset Flex Code
1830 \begin_layout Plain Layout
1839 \begin_inset Newline newline
1842 Not quite as common as its cousin.
1844 seems to like to print lines that are a bit too wide as opposed to ones
1845 that are a bit too narrow.
1846 We have no idea why.
1849 \begin_layout Itemize
1850 \begin_inset Flex Code
1853 \begin_layout Plain Layout
1862 \begin_inset Flex Code
1865 \begin_layout Plain Layout
1874 \begin_inset Newline newline
1877 Warnings about troubles breaking the page.
1878 Once again, just look at the output.
1879 Your eyes will tell you where something has gone wrong.
1882 \begin_layout Itemize
1883 \begin_inset Flex Code
1886 \begin_layout Plain Layout
1888 \begin_inset Quotes els
1892 \begin_inset Quotes ers
1901 \begin_inset Newline newline
1905 \begin_inset Quotes eld
1909 \begin_inset Quotes erd
1912 isn't installed on this system.
1913 This usually appears because some package your document needs isn't installed.
1914 If you didn't touch the preamble or didn't use the
1915 \begin_inset Flex Code
1918 \begin_layout Plain Layout
1926 command, then one of the packages \SpecialChar LyX
1927 tried to load is missing.
1929 \begin_inset Flex Noun
1932 \begin_layout Plain Layout
1933 Help\SpecialChar menuseparator
1940 to get a list of packages that \SpecialChar LyX
1942 This file is updated whenever you reconfigure \SpecialChar LyX
1944 \begin_inset Flex Noun
1947 \begin_layout Plain Layout
1948 Tools\SpecialChar menuseparator
1954 ) and tells you which packages have been detected and what they do.
1955 \begin_inset Newline newline
1959 \begin_inset Flex Code
1962 \begin_layout Plain Layout
1970 command and the package in question isn't installed, then you'll need to
1971 install it yourself.
1974 \begin_layout Itemize
1975 \begin_inset Flex Code
1978 \begin_layout Plain Layout
1979 LaTeX Error: Unknown option
1985 \begin_inset Newline newline
1988 Error messages beginning with this are trying to tell you that you specified
1989 a bad or undefined option to a package.
1990 Check the package's documentation.
1993 \begin_layout Itemize
1994 \begin_inset Flex Code
1997 \begin_layout Plain Layout
1998 Undefined control sequence
2004 \begin_inset Newline newline
2007 If you've inserted \SpecialChar LaTeX
2008 code into your document, but made a typo, you'll get
2010 You may have forgotten to load a package.
2011 In any case, this error message usually means that you used an undefined
2016 \begin_layout Standard
2017 There are other error and warning messages.
2018 Some are self-explanatory.
2019 These are usually \SpecialChar LaTeX
2021 Others are downright cryptic.
2022 These are usually \SpecialChar TeX
2023 error messages, and we really have
2027 what they mean or how to decipher them.
2031 \begin_layout Standard
2032 There's a general sequence you should follow if you get error messages:
2035 \begin_layout Enumerate
2036 Look at the \SpecialChar LaTeX
2037 code you inserted for typos.
2040 \begin_layout Enumerate
2041 If there are no typos, check that you used the command(s) correctly.
2044 \begin_layout Enumerate
2045 If you get a bunch of error boxes piled up at the very top of the document—and
2046 especially if you see a
2047 \begin_inset Quotes eld
2051 \begin_inset Flex Code
2054 \begin_layout Plain Layout
2063 \begin_inset Quotes erd
2066 error—it means that there are errors in the preamble.
2067 Start debugging your preamble.
2070 \begin_layout Enumerate
2071 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2073 document, the first suspect is your \SpecialChar LaTeX
2074 distribution itself.
2075 Check for missing packages and install them.
2078 \begin_layout Enumerate
2079 Okay, so there are no missing packages.
2080 Did you use any of the fine-tuning options in \SpecialChar LyX
2081 ? Specifically, did you
2085 any of them, like trying to manually insert lots of
2086 \begin_inset Flex Code
2089 \begin_layout Plain Layout
2091 \begin_inset space ~
2100 \begin_inset Flex Code
2103 \begin_layout Plain Layout
2110 \begin_inset Flex Code
2113 \begin_layout Plain Layout
2119 ? Did you try to kludge something together with these instead of using the
2120 appropriate paragraph environment?
2123 \begin_layout Enumerate
2124 All right, you didn't use any of the fine-tuning options, you played by
2126 Did you try to pull a fancy maneuver? Did you do something funky inside
2127 a table or an equation, like inserting a graphic into a table cell?
2130 \begin_layout Enumerate
2131 Do you have long sections of text where \SpecialChar LaTeX
2132 cannot find a place to break a
2133 line? By default, \SpecialChar LaTeX
2134 is rather strict about how much extra inter-word spacing
2135 it will add in order to break a line.
2136 Preferably, you should rework the paragraph to avoid the problem.
2139 \begin_layout Enumerate
2140 Did you go overboard with the nesting? \SpecialChar LyX
2141 (currently) doesn't check to make
2142 sure you're in the limits for nesting environments.
2143 If you nested a bunch of environments to the
2144 \begin_inset Formula $17^{\mathrm{th}}$
2147 level, that's the problem.
2148 (The limit in \SpecialChar LaTeX
2152 \begin_layout Enumerate
2153 Okay, you didn't get any error messages, but your output looks awful.
2154 If you have a table or figure that's too wide or long for the page, you
2159 \begin_layout Enumerate
2160 rescale the figure so it fits.
2163 \begin_layout Enumerate
2164 trim down the table so it fits.
2168 \begin_layout Enumerate
2169 If something else is wrong with the output, and you didn't try to pull anything
2170 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2173 \begin_layout Standard
2174 If all this doesn't help—well, then
2178 you might have found a bug in \SpecialChar LyX
2183 \begin_layout Chapter
2187 \begin_layout Section
2188 Customizing Bibliographies with Bib\SpecialChar TeX
2190 \change_inserted -712698321 1485694846
2196 \begin_layout Standard
2197 The most basic information about how to use Bib\SpecialChar TeX
2199 \change_inserted -712698321 1485694851
2206 with \SpecialChar LyX
2207 is contained in the section
2209 Bibliography databases
2210 \change_deleted -712698321 1485694823
2211 (Bib\SpecialChar TeX
2221 The following subsections explain special bibliography features supported
2226 \begin_layout Subsection
2227 Alternative Citation Styles
2230 \begin_layout Standard
2231 Standard Bib\SpecialChar TeX
2233 \begin_inset space \thinspace{}
2237 \begin_inset space \space{}
2241 \begin_inset Quotes eld
2245 \begin_inset Quotes erd
2248 ) to refer to a cited work.
2249 However, in many scientific disciplines, other citation styles are in use.
2250 The most common one is the author-year style (e.
2251 \begin_inset space \thinspace{}
2255 \begin_inset space \space{}
2259 \begin_inset Quotes eld
2263 \begin_inset Quotes erd
2269 \change_deleted -712698321 1485694902
2271 \change_inserted -712698321 1485694902
2274 packages that provide this style,
2275 \change_inserted -712698321 1485694917
2277 \begin_inset Flex Code
2280 \begin_layout Plain Layout
2282 \change_inserted -712698321 1485694917
2293 \begin_inset Flex Code
2296 \begin_layout Plain Layout
2303 \change_inserted -712698321 1485696751
2307 \begin_inset Flex Code
2310 \begin_layout Plain Layout
2318 \change_deleted -712698321 1485695091
2320 \change_inserted -712698321 1485695093
2324 \change_deleted -712698321 1485695095
2326 \change_inserted -712698321 1485695095
2329 their pros and cons, which cannot be listed in detail.
2330 If you only want to have simple author-year (or author-numerical) style,
2331 or if you want to use one of the countless style files for
2332 \begin_inset Flex Code
2335 \begin_layout Plain Layout
2341 , then the established
2342 \begin_inset Flex Code
2345 \begin_layout Plain Layout
2351 package is probably your choice.
2353 \change_inserted -712698321 1485695152
2354 look for specific citation styles common in law studies
2355 \change_deleted -712698321 1485695162
2356 need special features like short title references, ibidem etc.
2358 , you might consider the
2359 \begin_inset Flex Code
2362 \begin_layout Plain Layout
2370 \change_inserted -712698321 1485695432
2371 If you want to have full control over the formatting or look for advanced
2372 features such as ibidem, footnote citations, full title citations, advanced
2373 date formats (such as 400 BC) or full localization to other languages than
2374 English, you should definitely consider
2375 \begin_inset Flex Code
2378 \begin_layout Plain Layout
2380 \change_inserted -712698321 1485695328
2386 , which exceeds all other packages in terms of features, but is also quite
2387 heavy and more resource-hungry.
2392 \begin_layout Standard
2394 \change_deleted -712698321 1485695449
2396 \change_inserted -712698321 1485695449
2399 packages in \SpecialChar LyX
2400 is basically the same.
2402 \begin_inset Flex Noun
2405 \begin_layout Plain Layout
2406 Document\SpecialChar menuseparator
2413 \begin_inset Flex Noun
2416 \begin_layout Plain Layout
2423 \change_deleted -712698321 1485695462
2425 \change_inserted -712698321 1485695559
2427 \begin_inset Flex Noun
2430 \begin_layout Plain Layout
2432 \change_inserted -712698321 1485695499
2439 \begin_inset Flex Noun
2442 \begin_layout Plain Layout
2444 \change_inserted -712698321 1485695527
2451 \begin_inset Flex Noun
2454 \begin_layout Plain Layout
2456 \change_inserted -712698321 1485695554
2457 Biblatex (Natbib mode)
2465 \begin_inset Flex Noun
2468 \begin_layout Plain Layout
2470 \change_inserted -712698321 1485695505
2479 \begin_inset Flex Noun
2482 \begin_layout Plain Layout
2484 \change_inserted -712698321 1485695511
2493 \change_inserted -712698321 1485695637
2495 \begin_inset space ~
2498 6.5.3 in the User's Guide for more information on these choices)
2502 \change_deleted -712698321 1485695643
2504 \change_inserted -712698321 1485695645
2507 packages, you will get some extra features in the citation dialog and you
2508 can select the style of the reference (
2509 \begin_inset Quotes eld
2513 \begin_inset Quotes erd
2517 \begin_inset Quotes eld
2521 \begin_inset Quotes erd
2525 \begin_inset Quotes eld
2529 \begin_inset Quotes erd
2533 \begin_inset Quotes eld
2537 \begin_inset Quotes erd
2542 \change_deleted -712698321 1485695659
2544 \change_inserted -712698321 1485695660
2548 \change_deleted -712698321 1485695663
2552 \change_inserted -712698321 1485695664
2555 specifically designed style files.
2557 \change_deleted -712698321 1485695676
2559 \change_inserted -712698321 1485695676
2562 ship their own, but there are lots of additional style files, and there
2563 is even an interactive style file builder
2567 \begin_layout Plain Layout
2569 \begin_inset Flex URL
2572 \begin_layout Plain Layout
2574 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2585 \begin_inset Flex Code
2588 \begin_layout Plain Layout
2597 \begin_layout Subsection
2599 \change_deleted -712698321 1486199102
2601 \change_inserted -712698321 1486199104
2607 \begin_layout Standard
2608 Sometimes you might need to divide your bibliography into several sections.
2609 If you are for instance a historian, the possibility to separate sources
2610 and scientific works is most likely a
2611 \begin_inset Quotes eld
2615 \begin_inset Quotes erd
2619 Unfortunately, Bib\SpecialChar TeX
2620 itself does not allow you to do this.
2621 But with the help of some \SpecialChar LaTeX
2622 packages, Bib\SpecialChar TeX
2623 can be extended to fit your needs.
2626 \begin_layout Standard
2628 provides native support for one of these packages,
2636 \begin_layout Plain Layout
2638 \begin_inset Flex URL
2641 \begin_layout Plain Layout
2643 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2653 The advantage of this package (compared to other packages
2654 \change_deleted -712698321 1485695727
2656 \change_inserted -712698321 1485695729
2663 ) is that you don't need to define new citation commands.
2664 Instead, you need to prepare different bibliographic databases which include
2665 the entries for the different sections of the bibliography.
2666 For example: If you want to divide your bibliography into the sections
2668 \begin_inset Quotes eld
2672 \begin_inset Quotes erd
2676 \begin_inset Quotes eld
2680 \begin_inset Quotes erd
2683 , you first need to create two bibliographic databases, e.
2684 \begin_inset space \thinspace{}
2688 \begin_inset space \space{}
2692 \begin_inset Flex Code
2695 \begin_layout Plain Layout
2702 \begin_inset Flex Code
2705 \begin_layout Plain Layout
2715 \begin_layout Standard
2717 \begin_inset Flex Noun
2720 \begin_layout Plain Layout
2721 Document\SpecialChar menuseparator
2728 \begin_inset Flex Noun
2731 \begin_layout Plain Layout
2738 \begin_inset Flex Noun
2741 \begin_layout Plain Layout
2743 \change_deleted -712698321 1486199132
2745 \change_inserted -712698321 1486199136
2754 Now you can insert multiple Bib\SpecialChar TeX
2755 bibliographies, one for each section of
2757 Returning to our example: Insert the Bib\SpecialChar TeX
2759 \begin_inset Flex Code
2762 \begin_layout Plain Layout
2768 and a second one for the database
2769 \begin_inset Flex Code
2772 \begin_layout Plain Layout
2779 You are free to use the same or different styles for each section.
2780 Additionally, you can choose if the bibliography section should contain
2782 \begin_inset Quotes eld
2785 all cited references
2786 \begin_inset Quotes erd
2789 of the specified database(s) (which is the default),
2790 \begin_inset Quotes eld
2793 all uncited references
2794 \begin_inset Quotes erd
2798 \begin_inset Quotes eld
2802 \begin_inset Quotes erd
2806 This might be useful if you would like to separate your bibliography into
2808 \begin_inset Quotes eld
2812 \begin_inset Quotes erd
2816 \begin_inset Quotes eld
2820 \begin_inset Quotes erd
2824 \begin_inset Quotes eld
2828 \begin_inset Quotes erd
2832 The titles for the sections can be added as ordinary sections or subsections.
2834 \begin_inset Flex Code
2837 \begin_layout Plain Layout
2843 removes the bibliography title, you have to manually re-add that, too (as
2844 a chapter* or section*, for instance).
2845 \change_inserted -712698321 1485695762
2849 \begin_layout Standard
2851 \change_inserted -712698321 1486200403
2856 , the procedure is a bit different.
2865 , the aforementioned
2866 \begin_inset Flex Noun
2869 \begin_layout Plain Layout
2871 \change_inserted -712698321 1486200382
2872 Subdivided bibliography
2877 option is disabled if you use
2886 provides its own means to generate subdivided bibliographies.
2887 You can either add keywords to bibliography entries via the
2888 \begin_inset Flex Code
2891 \begin_layout Plain Layout
2893 \change_inserted -712698321 1485696318
2901 entry option and then filter bibliography sections by keyword (by adding
2903 \begin_inset Flex Code
2906 \begin_layout Plain Layout
2908 \change_inserted -712698321 1485696306
2917 \begin_inset Flex Noun
2920 \begin_layout Plain Layout
2922 \change_inserted -712698321 1485696431
2930 field of the dialog that opens if you right-click on the
2931 \begin_inset Flex Noun
2934 \begin_layout Plain Layout
2936 \change_inserted -712698321 1485696518
2937 Biblatex Generated Bibliography
2944 button), or you can filter by entry types (such as
2953 \begin_inset space \thinspace{}
2958 \begin_inset Flex Code
2961 \begin_layout Plain Layout
2963 \change_inserted -712698321 1485696628
2970 \begin_inset Flex Code
2973 \begin_layout Plain Layout
2975 \change_inserted -712698321 1485696643
2982 \begin_inset Flex Noun
2985 \begin_layout Plain Layout
2987 \change_inserted -712698321 1485696667
2993 field, or you can create so-called
2994 \begin_inset Quotes eld
2997 Bibliography Categories
2998 \begin_inset Quotes erd
3001 to which you can assign individual entries.
3002 Please refer to the Biblatex manual, section
3004 Subdivided Bibliographies
3011 \begin_layout Subsection
3012 Multiple Bibliographies
3015 \begin_layout Standard
3016 Multiple bibliographies, e.
3017 \begin_inset space \thinspace{}
3021 \begin_inset space \space{}
3024 a bibliography for each
3025 \change_inserted -712698321 1486199441
3029 \change_inserted -712698321 1486231742
3033 \change_deleted -712698321 1486231742
3035 \change_inserted -712698321 1486199445
3037 \change_deleted -712698321 1486199447
3041 \change_inserted -712698321 1486231758
3042 or child (sub-document)
3044 of the document, are
3045 \change_deleted -712698321 1486199458
3047 \change_inserted -712698321 1486200433
3051 \change_inserted -712698321 1486231617
3054 In order to enable it, go to
3055 \begin_inset Flex Noun
3058 \begin_layout Plain Layout
3060 \change_inserted -712698321 1486199572
3061 Document\SpecialChar menuseparator
3062 Settings\SpecialChar menuseparator
3070 and select the relevant unit (e.
3071 \begin_inset space \thinspace{}
3075 \begin_inset Quotes eld
3079 \begin_inset Quotes erd
3083 \begin_inset Flex Noun
3086 \begin_layout Plain Layout
3088 \change_inserted -712698321 1486199553
3089 Multiple Bibliographies
3098 \change_deleted -712698321 1486199771
3099 by Bib\SpecialChar TeX
3102 \change_inserted -712698321 1486200569
3103 Then add a Bib(la)\SpecialChar TeX
3104 bibliography to each unit (e.
3105 \begin_inset space \thinspace{}
3108 g., section) of your document.
3109 In the output, a separate bibliography, containing only the references
3110 done in the current unit is generated.
3113 \begin_layout Standard
3115 \change_inserted -712698321 1486199829
3116 If you use Bib\SpecialChar TeX
3118 \change_deleted -712698321 1486199835
3120 \change_inserted -712698321 1486231520
3124 \change_inserted -712698321 1486231576
3126 \begin_inset Flex Code
3129 \begin_layout Plain Layout
3131 \change_inserted -712698321 1486231576
3142 \begin_inset Flex Code
3145 \begin_layout Plain Layout
3152 \change_deleted -712698321 1486231584
3153 , which is used for the creation of sectioned bibliographies in \SpecialChar LyX
3158 \change_inserted -712698321 1486231676
3159 is used to create multiple bibliographies.
3160 The former package is used if you select
3161 \begin_inset Quotes eld
3165 \begin_inset Quotes erd
3173 \begin_inset Flex Noun
3176 \begin_layout Plain Layout
3178 \change_inserted -712698321 1486231676
3179 Sectioned Bibliography
3188 \begin_inset Flex Code
3191 \begin_layout Plain Layout
3193 \change_inserted -712698321 1486231655
3200 \change_deleted -712698321 1486200505
3201 provides an easy way to solve this task, if you are willing to use some
3203 \begin_inset Flex Noun
3206 \begin_layout Plain Layout
3214 \begin_inset space ~
3218 \begin_inset CommandInset ref
3220 reference "sec:Inserting-TeX-Code"
3230 \begin_layout Plain Layout
3231 An alternative approach
3232 \change_inserted -712698321 1486199215
3233 , if you are willing to use some
3234 \begin_inset Flex Noun
3237 \begin_layout Plain Layout
3239 \change_inserted -712698321 1486199212
3247 \begin_inset space ~
3251 \begin_inset CommandInset ref
3253 reference "sec:Inserting-TeX-Code"
3260 \change_deleted -712698321 1486231820
3262 \begin_inset Flex Code
3265 \begin_layout Plain Layout
3274 \begin_inset Flex Code
3277 \begin_layout Plain Layout
3284 \change_deleted -712698321 1486231824
3293 \change_inserted -712698321 1486231646
3295 \change_deleted -712698321 1486202138
3299 \begin_layout Standard
3301 \change_deleted -712698321 1486202126
3303 \begin_inset Flex Noun
3306 \begin_layout Plain Layout
3307 Document\SpecialChar menuseparator
3314 \begin_inset Flex Noun
3317 \begin_layout Plain Layout
3324 \begin_inset Flex Noun
3327 \begin_layout Plain Layout
3328 Sectioned bibliography
3334 In the document, you have to enclose the sections, which shall contain
3335 their own bibliography (including the Bib\SpecialChar TeX
3336 bibliography itself), between
3338 \change_inserted -712698321 1486231702
3340 \begin_inset Flex Code
3343 \begin_layout Plain Layout
3345 \change_inserted -712698321 1486231702
3351 is used, \SpecialChar LyX
3352 encloses the specified units in
3353 \begin_inset Flex Code
3356 \begin_layout Plain Layout
3358 \change_inserted -712698321 1486201443
3367 \begin_inset Flex Code
3370 \begin_layout Plain Layout
3379 \begin_inset Flex Code
3382 \begin_layout Plain Layout
3391 \change_inserted -712698321 1486231697
3392 in order to create the units.
3393 Note that this approach has
3396 \change_inserted -712698321 1486231697
3399 \change_deleted -712698321 1486200476
3400 (those commands have to be inserted as \SpecialChar TeX
3402 The bibliography will contain all references that have been cited in the
3404 \begin_inset Flex Code
3407 \begin_layout Plain Layout
3418 If you are using this approach, then
3419 \change_inserted -712698321 1486231697
3422 every citation reference has to be inside some
3423 \begin_inset Flex Code
3426 \begin_layout Plain Layout
3434 \change_inserted -712698321 1486231697
3435 So citations outside a defined unit (e.
3436 \begin_inset space \thinspace{}
3439 g., before the first section if you use
3440 \begin_inset Quotes eld
3444 \begin_inset Quotes erd
3448 \begin_inset Quotes eld
3452 \begin_inset Quotes erd
3456 You can also create your own units by entering
3457 \begin_inset Flex Code
3460 \begin_layout Plain Layout
3462 \change_inserted -712698321 1486200131
3471 \begin_inset Flex Code
3474 \begin_layout Plain Layout
3476 \change_inserted -712698321 1486200131
3485 code (for instance to work around the mentioned limitation).
3487 \change_deleted -712698321 1486200476
3491 \begin_inset Flex Code
3494 \begin_layout Plain Layout
3502 \change_inserted -712698321 1486231697
3503 A second limitation is that
3504 \begin_inset Flex Code
3507 \begin_layout Plain Layout
3509 \change_inserted -712698321 1486200199
3515 always processes all references of a bibliography database, even if they
3517 This can result in odd labels (e.
3518 \begin_inset space \thinspace{}
3523 \begin_inset Quotes eld
3527 \begin_inset Quotes erd
3530 if two works of this author from 2014 are in the database, even if only
3534 \begin_layout Standard
3536 \change_inserted -712698321 1486204109
3542 \begin_inset Flex Code
3545 \begin_layout Plain Layout
3547 \change_inserted -712698321 1486202183
3555 option is used instead.
3556 If you need specific units, you can start them with the \SpecialChar TeX
3558 \begin_inset Flex Code
3561 \begin_layout Plain Layout
3563 \change_inserted -712698321 1485697716
3574 \begin_inset Flex Code
3577 \begin_layout Plain Layout
3579 \change_inserted -712698321 1485697724
3590 If you also want to control the end of the unit, use the environment
3591 \begin_inset Flex Code
3594 \begin_layout Plain Layout
3596 \change_inserted -712698321 1485697769
3606 \begin_inset Flex Code
3609 \begin_layout Plain Layout
3611 \change_inserted -712698321 1485697780
3621 \begin_inset Flex Code
3624 \begin_layout Plain Layout
3626 \change_inserted -712698321 1486201999
3635 In addition to the individual bibliography of the current unit,
3639 also provides an easy way to output all bibliographies, subsequently, at
3641 \begin_inset space \thinspace{}
3644 g., at the end of the document).
3646 \begin_inset Quotes eld
3650 \begin_inset Quotes erd
3653 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3659 manual for more information on this topic.
3664 \begin_layout Section
3668 \begin_layout Subsection
3672 \begin_layout Standard
3673 When you are working on a large file with many sections, it is often convenient
3674 to break up the document into several files, or perhaps you have something
3675 where a table may change from time to time, but the preceding text does
3677 In these cases, you should seriously consider using multipart documents.
3678 For example, scientific papers often have five major sections: the introduction
3679 , observations, results, discussion, and conclusion.
3680 Each of these could be its own separate \SpecialChar LyX
3682 \begin_inset Quotes eld
3686 \begin_inset Quotes erd
3689 file which contains the title, authors, abstract, references, etc., plus
3690 the five included files.
3691 It is important to note that each of these files is a full \SpecialChar LyX
3693 can be formatted and printed on its own, as well as included in a master
3695 Each of these files must have the same document class, however—don't attempt
3696 to mix book classes with article classes.
3697 You may also include \SpecialChar LaTeX
3698 files; however, these files must not have their own
3700 \begin_inset space \thinspace{}
3704 \begin_inset space \space{}
3707 everything up to and including the
3708 \begin_inset Flex Code
3711 \begin_layout Plain Layout
3720 \begin_inset Flex Code
3723 \begin_layout Plain Layout
3731 line must be deleted) or else errors will be generated when you try to
3735 \begin_layout Standard
3737 allows you to include files quite easily with
3738 \begin_inset Flex Noun
3741 \begin_layout Plain Layout
3742 Insert\SpecialChar menuseparator
3744 \begin_inset space ~
3753 When you click on this selection a small box is inserted into the file
3754 at the current cursor location.
3755 Clicking on the box raises a dialog which allows you to select the file
3756 to be included, and the method of its inclusion.
3760 \begin_layout Standard
3761 The file selection box should by now be obvious.
3762 The three inclusion methods are
3763 \begin_inset Quotes eld
3767 \begin_inset Quotes erd
3771 \begin_inset Quotes eld
3775 \begin_inset Quotes erd
3779 \begin_inset Quotes eld
3783 \begin_inset Quotes erd
3787 The difference between
3788 \begin_inset Quotes eld
3792 \begin_inset Quotes erd
3796 \begin_inset Quotes eld
3800 \begin_inset Quotes erd
3803 is really only meaningful to \SpecialChar LaTeX
3804 perts, but the practical difference is that
3806 \begin_inset Quotes eld
3810 \begin_inset Quotes erd
3813 are typeset beginning on a new page, while files that are
3814 \begin_inset Quotes eld
3818 \begin_inset Quotes erd
3821 are typeset starting on the current page.
3824 \begin_layout Standard
3825 Generally, the master file is converted into a full \SpecialChar LaTeX
3826 file before typesetting,
3827 while the included files are converted to \SpecialChar LaTeX
3828 files that do not have all the
3829 preamble information.
3832 \begin_layout Standard
3834 \begin_inset Quotes eld
3838 \begin_inset Quotes erd
3841 included file allows you to include a file typeset exactly as it appears
3843 \begin_inset space \thinspace{}
3847 \begin_inset space \space{}
3851 \begin_inset Flex Code
3854 \begin_layout Plain Layout
3860 mode, with the characters set in a fixed-width typewriter font.
3861 Normally, spaces in this file are invisible, though two consecutive spaces
3862 are conserved, unlike \SpecialChar LyX
3863 's normal treatment of spaces.
3864 However, setting the
3865 \begin_inset Flex Noun
3868 \begin_layout Plain Layout
3870 \begin_inset space ~
3874 \begin_inset space ~
3878 \begin_inset space ~
3886 checkbox typesets a mark to unambiguously define the presence of a space.
3890 \begin_layout Subsection
3891 Cross-References Between Files
3894 \begin_layout Standard
3895 \begin_inset Box Shadowbox
3905 height_special "totalheight"
3910 backgroundcolor "none"
3913 \begin_layout Plain Layout
3914 This section is somewhat out of date.
3915 Need to describe default master documents and how children are opened when
3925 \begin_layout Standard
3926 It is possible to set up cross-references between the different files.
3927 First, open all the files in question: let's call them A and B in a two
3928 file example, where B is included in A.
3929 Let's say you insert a label in A, then want to reference it in B.
3930 Open the cross-reference dialog whilst in document B, and you can select
3932 \begin_inset Quotes eld
3936 \begin_inset Quotes erd
3942 \begin_layout Subsection
3943 Bibliography Lists in all Subdocuments
3946 \begin_layout Standard
3947 \begin_inset Box Frameless
3957 height_special "totalheight"
3962 backgroundcolor "none"
3965 \begin_layout Plain Layout
3966 This section also needs updating.
3967 There is now material about this on the wiki, and it could be copied here.
3975 \begin_layout Standard
3976 Copy the bibliography list with all entries to all subdocuments and transform
3978 This way \SpecialChar LyX
3980 \begin_inset Flex Code
3983 \begin_layout Plain Layout
3989 -files and you can easily insert references without making the bibliography
3993 \begin_layout Standard
3994 As the bibliography list is in a comment, \SpecialChar LaTeX
3995 won't use it and the references
3996 will look like this: [?], instead of like this: [1].
3997 One solution is to use the \SpecialChar LaTeX
3999 \begin_inset Flex Code
4002 \begin_layout Plain Layout
4008 that will only include comments by processing the files separately.
4009 To do this, add in the \SpecialChar LaTeX
4010 preamble of every subdocument the following:
4013 \begin_layout LyX-Code
4019 \begin_layout LyX-Code
4022 includecomment{comment}
4025 \begin_layout Standard
4027 \begin_inset Flex URL
4030 \begin_layout Plain Layout
4032 http://wiki.lyx.org/FAQ/Unsorted#toc31
4040 \begin_layout Section
4045 \begin_layout Standard
4046 Users sometimes need to be able to
4047 \begin_inset Quotes eld
4051 \begin_inset Quotes erd
4055 file together with all the images (and other files) on which it depends,
4056 either for sending to a publisher or for sharing with a co-author.
4058 2.0 includes a Python script (
4059 \begin_inset Flex Code
4062 \begin_layout Plain Layout
4068 ) that automates this process.
4069 To use it, you must have either the
4070 \begin_inset Flex Code
4073 \begin_layout Plain Layout
4080 \begin_inset Flex Code
4083 \begin_layout Plain Layout
4089 python modules installed on your system.
4090 By default, the script prefers the
4091 \begin_inset Flex Code
4094 \begin_layout Plain Layout
4101 \begin_inset Flex Code
4104 \begin_layout Plain Layout
4110 format on Unix-like systems and the
4111 \begin_inset Flex Code
4114 \begin_layout Plain Layout
4123 \begin_layout Standard
4125 's configuration process will set the script up to export a `\SpecialChar LyX
4127 and this format will then be available under
4128 \begin_inset Flex Code
4131 \begin_layout Plain Layout
4132 File\SpecialChar menuseparator
4141 \begin_layout Standard
4142 Independently of the platform, the generation of a particular archive format
4143 can be forced by adding either the
4144 \begin_inset Flex Code
4147 \begin_layout Plain Layout
4154 \begin_inset Flex Code
4157 \begin_layout Plain Layout
4164 \begin_inset Flex Code
4167 \begin_layout Plain Layout
4174 \begin_inset Flex Code
4177 \begin_layout Plain Layout
4183 format) switch to the
4184 \begin_inset Flex Code
4187 \begin_layout Plain Layout
4189 \SpecialChar menuseparator
4197 \begin_inset Flex Code
4200 \begin_layout Plain Layout
4201 Tools\SpecialChar menuseparator
4202 Preferences\SpecialChar menuseparator
4203 File Handling\SpecialChar menuseparator
4210 (Make sure you add the switch after the script name, not before it.)
4213 \begin_layout Section
4214 Fancy Headers and Footers
4217 \begin_layout Standard
4218 The default page layout is rather plain; for an
4219 \begin_inset Flex Code
4222 \begin_layout Plain Layout
4228 document class, all you get is a centered page number at the bottom of
4230 This document uses KOMA-script's book class, so it appears to be a bit
4232 But to really put on a show, you need to set the document page style to
4234 \begin_inset Quotes eld
4238 \begin_inset Quotes erd
4241 , as mentioned in the
4246 This section describes the \SpecialChar LaTeX
4247 code you need to insert in your \SpecialChar LaTeX
4249 order to get the desired effects.
4252 \begin_layout Standard
4253 For more information on fancy headers, see the
4254 \begin_inset Flex Code
4257 \begin_layout Plain Layout
4263 package documentation.
4265 \begin_inset Flex URL
4268 \begin_layout Plain Layout
4270 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4278 \begin_layout Standard
4279 The page header is divided into three fields, not surprisingly labeled
4280 \begin_inset Quotes eld
4284 \begin_inset Quotes erd
4288 \begin_inset Quotes eld
4292 \begin_inset Quotes erd
4296 \begin_inset Quotes eld
4300 \begin_inset Quotes erd
4304 The footer is also divided into these three fields.
4305 The \SpecialChar LaTeX
4306 commands to set these fields in the simplest manner are
4307 \begin_inset Flex Code
4310 \begin_layout Plain Layout
4319 \begin_inset Flex Code
4322 \begin_layout Plain Layout
4331 \begin_inset Flex Code
4334 \begin_layout Plain Layout
4343 \begin_inset Flex Code
4346 \begin_layout Plain Layout
4355 Suppose you wish to put your name in the upper left hand corner of each
4357 Simply insert the following command in the preamble:
4360 \begin_layout Standard
4369 \begin_layout Standard
4370 You will now see your name in the upper left.
4371 If a field has a default entry that you would like to get rid of (often
4372 the page number appears in the central footer) simply include a command
4373 with a blank argument, e.
4374 \begin_inset space \thinspace{}
4380 \begin_layout Standard
4388 \begin_layout Standard
4389 Let's get really fancy: lets put the section number with the word
4390 \begin_inset Quotes eld
4394 \begin_inset Quotes erd
4398 \begin_inset space \thinspace{}
4402 \begin_inset space \space{}
4405 Section 3) in the upper left, the page number (e.
4406 \begin_inset space \thinspace{}
4410 \begin_inset space \space{}
4413 Page 4) in the upper right, your name in the lower left, and the date in
4415 The following commands should now appear in the preamble:
4418 \begin_layout Standard
4428 \begin_layout Standard
4436 \begin_layout Standard
4446 \begin_layout Standard
4455 \begin_layout Standard
4463 \begin_layout Standard
4473 \begin_layout Standard
4475 \begin_inset Flex Code
4478 \begin_layout Plain Layout
4487 \begin_inset Flex Code
4490 \begin_layout Plain Layout
4498 access \SpecialChar LaTeX
4499 's section and page counters, and so print out the current section
4502 \begin_inset Flex Code
4505 \begin_layout Plain Layout
4513 simply prints out today's date.
4516 \begin_layout Standard
4517 The thicknesses of the horizontal rules drawn beneath the header and above
4518 the footer can also be modified.
4519 If you don't want one of the rules, set its thickness to 0.
4520 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4526 \begin_inset Flex Code
4529 \begin_layout Plain Layout
4534 headrulewidth}{0.4pt}
4540 \begin_inset Flex Code
4543 \begin_layout Plain Layout
4548 footrulewidth}{0.4pt}
4553 to set the thicknesses.
4556 \begin_layout Standard
4557 You can switch the header/footer settings on and off for individual pages
4559 \begin_inset Flex Code
4562 \begin_layout Plain Layout
4565 thispagestyle{empty}
4571 \begin_inset Flex Code
4574 \begin_layout Plain Layout
4577 thispagestyle{plain}
4583 \begin_inset Flex Code
4586 \begin_layout Plain Layout
4589 thispagestyle{fancy}
4595 Simply insert them in the text on the page you want changed and mark them
4598 In fact, title pages are marked as plain by default, while following pages
4599 are marked fancy when using the global fancy setting.
4602 \begin_layout Standard
4603 As a final example, it is possible to include an image in the header or
4605 Suppose you want to put a company logo in the upper lefthand corner.
4606 You might try something like
4609 \begin_layout Standard
4618 includegraphics{logo.eps}}}
4621 \begin_layout Standard
4623 (you may need to preface this with
4624 \begin_inset Flex Code
4627 \begin_layout Plain Layout
4631 usepackage{graphics}
4636 if you don't include graphics elsewhere in your document).
4639 \begin_layout Section
4640 Itemize Bullet Selection
4641 \begin_inset CommandInset label
4650 \begin_layout Standard
4656 \begin_layout Subsection
4660 \begin_layout Standard
4662 provides 216 bullet shapes that can be accessed from a simple dialog.
4663 Using this dialog you can easily specify what bullet shape to use at each
4664 level of an itemized list.
4665 These settings are document-wide so you won't be able to specify different
4666 sets of bullets for different paragraphs.
4670 \begin_layout Plain Layout
4671 Well, actually you can but you'll have to do it by hand.
4679 \begin_layout Subsection
4683 \begin_layout Standard
4684 Open the dialog by selecting the
4685 \begin_inset Flex Noun
4688 \begin_layout Plain Layout
4689 Document\SpecialChar menuseparator
4695 menu item and then select the
4696 \begin_inset Flex Noun
4699 \begin_layout Plain Layout
4708 \begin_layout Standard
4709 The dialog provides you with a table of bullet shapes.
4710 A column of buttons on the left of the table provides access to the six
4711 different panels of bullet shapes.
4712 The row of buttons across the top is used to select which bullet depth
4714 A text entry under the table shows the currently selected bullet shape's
4716 equivalent and this can be edited if desired.
4717 If you do modify the text you will also need to specify any needed packages
4718 in the \SpecialChar LaTeX
4722 \begin_layout Standard
4723 The six panels are divided up by the packages they require.
4724 The following table shows the mappings from button name to \SpecialChar LaTeX
4728 \begin_layout Standard
4730 \begin_inset Tabular
4731 <lyxtabular version="3" rows="7" columns="2">
4732 <features tabularvalignment="middle">
4733 <column alignment="center" valignment="top" width="0pt">
4734 <column alignment="center" valignment="top" width="0pt">
4736 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4739 \begin_layout Plain Layout
4754 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4757 \begin_layout Plain Layout
4774 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4777 \begin_layout Plain Layout
4792 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4795 \begin_layout Plain Layout
4804 base \SpecialChar LaTeX
4812 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4815 \begin_layout Plain Layout
4830 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4833 \begin_layout Plain Layout
4850 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4853 \begin_layout Plain Layout
4868 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4871 \begin_layout Plain Layout
4888 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4891 \begin_layout Plain Layout
4906 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4909 \begin_layout Plain Layout
4926 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4929 \begin_layout Plain Layout
4944 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4947 \begin_layout Plain Layout
4964 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4967 \begin_layout Plain Layout
4982 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4985 \begin_layout Plain Layout
5008 \begin_layout Standard
5010 doesn't stop you using bullets from packages you don't have.
5011 If you get errors from \SpecialChar LaTeX
5012 when you try to view or print the file, then it
5013 is likely you are missing a package.
5017 \begin_layout Plain Layout
5019 doesn't restrict your use since you may be editing locally and exporting
5028 \begin_layout Subsection
5032 \begin_layout Standard
5033 Select which bullet depth you want to change then select the bullet shape
5035 Any changes will not be visible in \SpecialChar LyX
5036 , but are visible when viewing the document.
5039 \begin_layout Standard
5040 You can reset a bullet shape to the default simply by clicking your right
5041 mouse button on the appropriate bullet depth button.
5045 \begin_layout Plain Layout
5050 want to have multiple sets of paragraphs with different sets of bullets
5051 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
5053 The bullet selection dialog can help though because it provides you with
5054 the \SpecialChar LaTeX
5055 code for a wide range of bullet shapes.
5056 To make your own custom paragraphs you have the following options:
5059 \begin_layout Plain Layout
5063 \begin_layout Plain Layout
5079 \begin_layout Plain Layout
5083 \begin_layout Plain Layout
5105 \begin_layout Itemize
5106 Use the \SpecialChar LaTeX
5108 \begin_inset Flex Code
5111 \begin_layout Plain Layout
5119 to specify a new bullet shape for a given depth.
5120 You'll also need to save the current bullet shape so you can restore it
5122 In this itemized list the following \SpecialChar LaTeX
5123 code was used to change the bullet
5124 used for the first depth.
5128 \begin_layout LyX-Code
5138 \begin_layout LyX-Code
5155 \begin_layout Itemize
5156 Note that the itemize depth is specified in Roman numerals as part of the
5166 \begin_layout Itemize
5170 \begin_layout Plain Layout
5183 Specify each individual entry by starting each item with the bullet shape
5184 enclosed in square brackets and set as
5185 \begin_inset Flex Noun
5188 \begin_layout Plain Layout
5196 For example, this item was started with
5197 \begin_inset Flex Code
5200 \begin_layout Plain Layout
5215 \begin_layout Plain Layout
5219 \begin_layout Plain Layout
5235 \begin_layout Plain Layout
5236 You'll also need to revert the labelitem back to its previous setting for
5237 the global bullet shape settings to remain in effect.
5238 The way used here was:
5241 \begin_layout LyX-Code
5256 \begin_layout Chapter
5258 and the World Wide Web
5261 \begin_layout Standard
5263 has long supported the export of documents to various web-friendly formats,
5265 Before verson 2.0, however, HTML export was always accomplished by the use
5266 of external converters.
5270 \begin_layout Plain Layout
5271 For details on the use of external converters with \SpecialChar LyX
5276 section of the Customization manual.
5281 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5283 intermediate format, such as
5284 \begin_inset Flex Code
5287 \begin_layout Plain Layout
5294 \begin_inset Flex Code
5297 \begin_layout Plain Layout
5304 \begin_inset Flex Code
5307 \begin_layout Plain Layout
5313 , relying upon \SpecialChar LyX
5314 to produce the \SpecialChar LaTeX
5315 ; and there is a converter that works directly
5318 \begin_inset Flex Code
5321 \begin_layout Plain Layout
5329 All of these have different advantages and disadvantages.
5333 \begin_layout Standard
5334 The \SpecialChar LaTeX
5335 -based converters have the advantage that, in principle, they know everythin
5336 g about the exported document that \SpecialChar LaTeX
5338 Such converters do not care, for example, if a certain block of code was
5339 produced by \SpecialChar LyX
5340 or was Evil Red Text.
5341 These converters know about
5342 \begin_inset Flex Code
5345 \begin_layout Plain Layout
5351 files, counters, and references, and can often make use of the
5352 \begin_inset Flex Code
5355 \begin_layout Plain Layout
5361 files generated by Bib\SpecialChar TeX
5363 On the other hand, \SpecialChar LaTeX
5364 is a very hard language to parse—it is sometimes said
5365 that only \SpecialChar TeX
5366 itself understands \SpecialChar TeX
5367 —and \SpecialChar LaTeX
5368 -based converters will often choke on
5369 what seem to be quite simple constructs; complex ones can throw them completely
5370 , and as of this writing, for example, the
5374 manual will not export with
5375 \begin_inset Flex Code
5378 \begin_layout Plain Layout
5384 , though the others will.
5385 The other issue concerns how math is handled.
5386 These converters typically convert the formulae into little pictures that
5387 are then linked from the HTML document.
5388 Since these are actually generated by \SpecialChar LaTeX
5389 , they are accurate.
5390 But they do not scale well, and just getting them to look as if they are
5391 actually meant to be in your document—so that the font sizes seem to be
5392 roughly the same—can be a challenge.
5395 \begin_layout Standard
5397 \begin_inset Flex Code
5400 \begin_layout Plain Layout
5408 \begin_inset CommandInset href
5410 name "http://elyxer.nongnu.org/"
5411 target "http://elyxer.nongnu.org/"
5416 ) solves some of these problems.
5417 In particular, the formulae it produces scale perfectly, since it renders
5418 math using a combination of HTML and CSS rather than converting the formulae
5420 But even moderately complex formula are rendered less well than with
5421 \begin_inset Flex Code
5424 \begin_layout Plain Layout
5430 ; this reflects the limitations of HTML.
5434 \begin_layout Plain Layout
5436 \begin_inset Flex Code
5439 \begin_layout Plain Layout
5446 can also use jsMath and MathJax for equations, but this setting is only
5447 available globally and requires one to have access to a server that runs
5453 More importantly (as of version 1.1.1, at least),
5454 \begin_inset Flex Code
5457 \begin_layout Plain Layout
5464 has limited support for math macros and no support for user-defined paragraph
5465 or character styles.
5466 These limitations make
5467 \begin_inset Flex Code
5470 \begin_layout Plain Layout
5477 unsuitable for many of the documents \SpecialChar LyX
5479 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5481 have decided to follow a different path and have made \SpecialChar LyX
5483 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5484 , DocBook, and plaintext.
5487 \begin_layout Standard
5488 As of this writing, XHTML output remains under development and should probably
5490 \begin_inset Quotes eld
5494 \begin_inset Quotes erd
5501 \begin_layout Plain Layout
5503 \begin_inset Flex Code
5506 \begin_layout Plain Layout
5507 development/HTML.notes
5512 , which can be found in the \SpecialChar LyX
5514 \begin_inset CommandInset href
5516 name "accessed online"
5517 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5522 , usually contains up-to-date information about the state of XHTML output.
5523 See also the list of XHTML bugs on
5524 \begin_inset CommandInset href
5526 name "the bug tracker"
5527 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"
5537 Still, the developers have chosen this approach because it has several
5538 potential advantages over the other two.
5541 \begin_layout Standard
5542 These advantages are primarily due to the fact that the XHTML output routines,
5543 since they are part of \SpecialChar LyX
5544 , know everything \SpecialChar LyX
5545 knows about the document being
5550 \begin_layout Plain Layout
5551 Another advantage is that, since these routines are internal to \SpecialChar LyX
5553 immune to changes in \SpecialChar LyX
5554 's file format, or to changes in the semantics of
5560 So they know about the table of contents (as displayed in the outline),
5561 about the counters associated with different paragraph styles, and about
5562 user-defined styles.
5563 The XHTML output routines know what \SpecialChar LyX
5564 knows about internationalization,
5565 too, so they will output
5566 \begin_inset Quotes eld
5570 \begin_inset Quotes erd
5574 \begin_inset Quotes eld
5582 \begin_inset Quotes erd
5585 , depending upon the language in effect at the time.
5589 \begin_layout Standard
5590 Quite generally, the output routines know what \SpecialChar LyX
5591 knows about document layout,
5592 that is, about how the document is to be rendered on screen.
5593 We use this information when we output the document as XHTML.
5594 In particular, \SpecialChar LyX
5599 generates CSS style information corresponding to the layout information
5600 it uses to render the document on screen: if section headings are supposed
5601 to be sans-serif and bold as seen in \SpecialChar LyX
5602 , then (by default) they will be sans-seri
5603 f and bold when viewed in a web browser, too.
5604 And this is true not just for pre-defined styles, like Section, but for
5605 any style, including user-defined styles.
5606 Indeed, the XHTML output routines make no distinction between user-defined
5607 paragraph and character styles and \SpecialChar LyX
5608 's own pre-defined styles: in each case,
5609 everything \SpecialChar LyX
5610 knows about the styles is contained in the layout files.
5611 And much the same is true as regards pre-defined textual insets, such as
5612 footnotes, and various custom insets.
5616 \begin_layout Standard
5617 The result is that XHTML output can be customized and extended in exactly
5618 the same way \SpecialChar LaTeX
5619 output can be customized and extended: through layout files
5621 See chapter five of the
5625 manual for the details.
5628 \begin_layout Standard
5629 The remainder of this chapter contains more detailed information on XHTML
5630 output, its limitations, and ways to work around those limitations.
5633 \begin_layout Section
5634 Math Output in XHTML
5637 \begin_layout Standard
5639 offers four choices for how math is rendered.
5640 These have various advantages and disadvantages:
5643 \begin_layout Itemize
5645 \begin_inset Newline newline
5648 MathML is a dialect of XML designed specifically for mathematics on the
5649 web, and it typically renders very well in browsers that support it.
5650 The disadvantage is that not all browsers support MathML, and support is
5651 not complete even in the Gecko-based browsers, such as Firefox.
5652 \begin_inset Newline newline
5656 is unable to render a formula as MathML—for example, if the formula
5658 \begin_inset Flex Code
5661 \begin_layout Plain Layout
5667 package or ERT—then it will instead output the formula as an image.
5671 \begin_layout Itemize
5673 \begin_inset Newline newline
5677 \begin_inset Flex Code
5680 \begin_layout Plain Layout
5686 outputs math as HTML, styled by CSS.
5690 \begin_layout Plain Layout
5692 has borrowed some of the CSS for its HTML output from
5693 \begin_inset Flex Code
5696 \begin_layout Plain Layout
5707 For simple formulae, this can work quite well, though with more complicated
5708 formulae it tends to break down.
5709 Still, this method has the advantage that it is very widely supported and
5710 so it may be appropriate for documents that contain only a little, fairly
5712 \begin_inset Newline newline
5715 If Lyx is unable to render a formula as HTML—for example, if the formula
5717 \begin_inset Flex Code
5720 \begin_layout Plain Layout
5726 package or ERT—then it will instead output the formula as an image.
5730 \begin_layout Itemize
5732 \begin_inset Newline newline
5736 \begin_inset Flex Code
5739 \begin_layout Plain Layout
5746 will output formulae as images, the very same images, in fact, that are
5747 used for instant preview.
5751 \begin_layout Plain Layout
5752 Instant preview does
5756 have to be on for images to be output, however.
5761 The advantage to this method is that the images are simply generated by
5763 , so they are very accurate.
5764 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5765 so they do not scale terribly well, and one cannot copy them, etc.
5766 (As of this writing, there are also problems about equation numbering.
5768 \begin_inset CommandInset href
5771 target "http://www.lyx.org/trac/ticket/6894"
5777 \begin_inset Newline newline
5780 The size of the images can be controlled by setting the
5781 \begin_inset Quotes eld
5785 \begin_inset Quotes erd
5789 \begin_inset Flex Noun
5792 \begin_layout Plain Layout
5793 Document\SpecialChar menuseparator
5794 Settings\SpecialChar menuseparator
5804 \begin_layout Plain Layout
5805 For those who want to know, this controls the resolution of the image in
5806 dots per inch and is based upon a default of 75 dpi.
5812 \begin_inset Newline newline
5816 for some reason fails to create an image for a formula (e.g., if a required
5818 package is not installed), then it will fall back to outputing the raw
5823 \begin_layout Itemize
5826 \begin_inset Newline newline
5829 Finally, \SpecialChar LyX
5830 will happily output math as \SpecialChar LaTeX
5832 As well as being the output of last resort, this method can be used with
5834 \begin_inset CommandInset href
5837 target "http://www.math.union.edu/~dpvc/jsMath/"
5842 , which uses JavaScript to render \SpecialChar LaTeX
5843 embedded in HTML documents.
5845 wraps the \SpecialChar LaTeX
5847 \begin_inset Flex Code
5850 \begin_layout Plain Layout
5856 (for inline formulas) or
5857 \begin_inset Flex Code
5860 \begin_layout Plain Layout
5866 (for displayed formulas) with
5867 \begin_inset Flex Code
5870 \begin_layout Plain Layout
5876 , as is required for jsMath.
5879 \begin_layout Standard
5880 One of these output methods must be selected under
5881 \begin_inset Flex Noun
5884 \begin_layout Plain Layout
5885 Document\SpecialChar menuseparator
5886 Settings\SpecialChar menuseparator
5893 By default, \SpecialChar LyX
5895 This is a document-wide setting, therefore.
5898 \begin_layout Standard
5899 Eventually, \SpecialChar LyX
5900 will offer the user the option to select an alternate output
5901 method for a particular inset, say, one that isn't being rendered very
5906 \begin_layout Plain Layout
5907 That said, since \SpecialChar LyX
5908 falls back to images if the inset contains ERT, then one
5909 can force output as an image by putting some harmless ERT into the math,
5911 \begin_inset Formula $a=b\relax$
5922 \begin_layout Section
5923 Bibliography and Citations
5926 \begin_layout Standard
5927 XHTML output fully supports bibliographies and citations.
5931 \begin_layout Standard
5932 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5934 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5937 If you are using numerical citations, then \SpecialChar LyX
5938 will output numerical labels,
5939 such as [1] or [17], rather than simply showing the citation key in square
5940 brackets, as it does on-screen.
5941 If you are using author-year citations, then \SpecialChar LyX
5942 will add lowercase letters
5943 to the years, just as Bib\SpecialChar TeX
5944 does, if it finds more than one citation for
5945 a given author-year combination.
5946 The labels will be printed with the bibliography entries.
5947 Note that there is, at present, no way to customize the appearance of the
5948 labels, for example, to choose between square brackets and parentheses.
5951 \begin_layout Standard
5952 Bibliography output is handled by the same machinery that handles the presentati
5953 on of reference information in the citation dialog, so you will see in the
5954 XHTML output pretty much what you would see if you were to look at a given
5955 entry in the citation dialog.
5956 The formatting can be customized in your layout file or, preferably, in
5962 manual for the details.
5965 \begin_layout Standard
5966 The main defect at present is that cross-referenced information is printed
5967 with every entry with which it is associated.
5968 So you can see things like this:
5973 \begin_inset Quotes eld
5976 Context and Logical Form
5977 \begin_inset Quotes erd
5982 Language in Context: Selected Essays
5984 (Oxford: Oxford University Press, 2007), pp.
5990 \begin_inset Quotes eld
5993 Semantics in Context
5994 \begin_inset Quotes erd
5999 Language in Context: Selected Essays
6001 (Oxford: Oxford University Press, 2007), pp.
6005 \begin_layout Standard
6006 This should be fixed before long.
6009 \begin_layout Standard
6010 There is no support at present for sectioned bibliographies.
6011 If you have multiple bibliographies, then \SpecialChar LyX
6012 will print the same bibliography
6016 \begin_layout Section
6020 \begin_layout Standard
6022 will happily export indexes as XHTML, but with certain limitations at the
6026 \begin_layout Standard
6027 Index export will be most reliable when you do not attempt to use the fancy
6028 constructs that are described in the section on indexes in the
6036 \begin_layout Plain Layout
6037 The main issue here is that \SpecialChar LyX
6038 itself does not really handle these.
6039 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
6045 We'll describe how they are handled using the subsection headings from
6049 \begin_layout Itemize
6050 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
6051 makes an effort to support these,
6052 but the entries must be separated by
6053 \begin_inset Quotes eld
6057 \begin_inset Quotes erd
6060 , that is, there must be spaces around the exclamation point.
6061 This is because it is otherwise too difficult to check for escaped exclamation
6062 points, ones in math, and so forth.
6065 \begin_layout Itemize
6066 Page Ranges: There is no support at all for page ranges, since these make
6067 no sense with XHMTL.
6068 Instead, you will just get two index entries, one at either end.
6071 \begin_layout Itemize
6072 Cross-referencing: There is no support for cross-referencing.
6074 finds an entry containing the
6075 \begin_inset Quotes eld
6078 |see\SpecialChar ldots
6080 \begin_inset Quotes erd
6083 construct, it is just dropped, and the rest is treated as an ordinary index
6087 \begin_layout Itemize
6088 Index Entry Order: \SpecialChar LyX
6089 does support attempts to fix the sorting order.
6090 It will take what is before the first `@' it finds and use that for sorting,
6091 taking what follows the first `@' to be the actual entry.
6092 At present, \SpecialChar LyX
6093 does not check for escaped `@', so do not try to index email
6097 \begin_layout Itemize
6098 Index Entry Layout: You can format entries by using the text style dialog,
6099 or by using any other method available within \SpecialChar LyX
6101 There is no support for constructs like:
6102 \begin_inset Quotes eld
6106 \begin_inset Quotes erd
6110 Indeed, if \SpecialChar LyX
6111 finds a pipe symbol, `|', in an entry, it will delete it and
6112 everything that follows it.
6115 \begin_layout Itemize
6116 Multiple Indexes: There is no support for multiple indexes.
6117 Rather, all index entries will be printed as one large index.
6118 To avoid our printing several versions of the index, we print only the
6119 main index, so make sure you have one.
6122 \begin_layout Section
6123 Nomenclature and Glossary
6126 \begin_layout Standard
6127 There is at present no support for glossaries.
6128 Adding it would be fairly trivial, and welcome.
6131 \begin_layout Chapter
6132 The \SpecialChar LyX
6136 \begin_layout Section
6140 \begin_layout Standard
6141 The `\SpecialChar LyX
6142 server' allows other programs to talk to \SpecialChar LyX
6143 , invoke \SpecialChar LyX
6144 commands, and retrieve
6145 information about the \SpecialChar LyX
6147 This is only intended for advanced users, but they should find it useful.
6148 It is by writing to the \SpecialChar LyX
6149 server, for example, that bibliography managers,
6150 such as JabRef, are able to
6151 \begin_inset Quotes eld
6155 \begin_inset Quotes erd
6158 citations to \SpecialChar LyX
6162 \begin_layout Section
6163 Starting the \SpecialChar LyX
6167 \begin_layout Standard
6168 The \SpecialChar LyX
6169 server works through the use of a pair of named pipes.
6170 These are usually located in
6171 \begin_inset Flex Code
6174 \begin_layout Plain Layout
6180 , (except on Windows, where
6184 named pipes are special objects located in
6185 \begin_inset Flex Code
6188 \begin_layout Plain Layout
6200 ) and have the names
6201 \begin_inset Quotes eld
6205 \begin_inset Flex Code
6208 \begin_layout Plain Layout
6215 \begin_inset Quotes erd
6219 \begin_inset Quotes eld
6223 \begin_inset Flex Code
6226 \begin_layout Plain Layout
6233 \begin_inset Quotes erd
6237 External programs write into
6238 \begin_inset Flex Code
6241 \begin_layout Plain Layout
6247 and read back data from
6248 \begin_inset Flex Code
6251 \begin_layout Plain Layout
6258 The stem of the pipe names can be defined in the
6259 \begin_inset Flex Noun
6262 \begin_layout Plain Layout
6263 Tools\SpecialChar menuseparator
6270 \begin_inset Flex Code
6273 \begin_layout Plain Layout
6274 "/home/myhome/lyxpipe"
6280 \begin_inset Flex Code
6283 \begin_layout Plain Layout
6297 on Windows (where any working path instead of lyxpipe can be used, for
6299 \begin_inset Flex Code
6302 \begin_layout Plain Layout
6325 configure this manually in order for the server to start.
6328 \begin_layout Standard
6331 \begin_inset Flex Code
6334 \begin_layout Plain Layout
6341 \begin_inset Flex Code
6344 \begin_layout Plain Layout
6350 ' to create the pipes.
6351 If one of the pipes already exists, \SpecialChar LyX
6352 will assume that another \SpecialChar LyX
6354 is already running and will not start the server.
6355 On POSIX (Unix like) systems, if for some other reason, an unused
6356 \begin_inset Quotes eld
6360 \begin_inset Quotes erd
6363 pipe is left in existence when \SpecialChar LyX
6364 closes, then \SpecialChar LyX
6365 will try to delete it.
6366 If this fails for some reason, you will need to delete the pipes manually
6367 and then restart \SpecialChar LyX
6369 On Windows, pipes are deleted by the OS on program termination or crash,
6371 \begin_inset Quotes eld
6375 \begin_inset Quotes erd
6378 pipes should not be possible.
6381 \begin_layout Standard
6382 To have several \SpecialChar LyX
6383 processes with servers at the same time, you have to use
6384 different configurations, perhaps by using separate user directories, each
6386 \begin_inset Flex Code
6389 \begin_layout Plain Layout
6395 file, for each process.
6398 \begin_layout Standard
6399 If you are developing a client program, you might find it useful to enable
6400 debugging information from the \SpecialChar LyX
6402 Do this by starting \SpecialChar LyX
6404 \begin_inset Flex Code
6407 \begin_layout Plain Layout
6416 \begin_layout Standard
6417 You can find a complete example client written in C++ in the source distribution
6419 \begin_inset Flex Code
6422 \begin_layout Plain Layout
6423 development/lyxserver/server_monitor.cpp
6431 \begin_layout Standard
6432 Another useful tool is the command-line based client found in
6433 \begin_inset Flex Code
6436 \begin_layout Plain Layout
6437 src/client/lyxclient
6445 \begin_layout Section
6446 Normal communication
6449 \begin_layout Standard
6450 To issue a \SpecialChar LyX
6451 call, the client writes a line of ASCII text into the input
6453 This line has the following format:
6470 \begin_layout Description
6471 clientname is a name that the client can choose arbitrarily.
6472 Its only use is that \SpecialChar LyX
6473 will echo it if it sends an answer—so a client can
6474 dispatch results from different requesters.
6477 \begin_layout Description
6478 function is the function you want \SpecialChar LyX
6480 It is the same as the commands you'd use in the minibuffer.
6483 \begin_layout Description
6484 argument is an optional argument which is meaningful only to some functions
6486 \begin_inset Quotes eld
6490 \begin_inset Quotes erd
6493 LFUN will insert the argument as text at the cursor position).
6496 \begin_layout Standard
6497 The answer from \SpecialChar LyX
6498 will arrive in the output pipe and be of the form
6515 \begin_layout Standard
6524 are just echoed from the command request, while
6528 is more or less useful information filled according to how the command
6529 execution worked out.
6530 Some commands, such as
6531 \begin_inset Quotes eld
6535 \begin_inset Quotes erd
6538 , will return information about the internal state of \SpecialChar LyX
6540 return an empty data-response.
6541 This means that the command execution went fine.
6544 \begin_layout Standard
6545 In case of errors, the response from \SpecialChar LyX
6563 \begin_layout Standard
6568 should contain an explanation of why the command failed.
6571 \begin_layout Standard
6575 \begin_layout LyX-Code
6576 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6577 \begin_inset Newline newline
6580 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6581 \begin_inset Newline newline
6584 read a <~/.lyxpipe.out
6585 \begin_inset Newline newline
6591 \begin_layout Subsection
6592 AppleScript (Mac OS X)
6595 \begin_layout Standard
6596 Since \SpecialChar LyX
6597 2.1, \SpecialChar LyX
6598 supports basic interactions with AppleScript for normal communicatio
6599 n through the command run.
6600 This command takes a direct argument (the
6604 to perform) and an optional argument.
6605 It either returns the output of the function or triggers an error with
6606 the error message and code.
6609 \begin_layout Standard
6613 \begin_layout LyX-Code
6614 tell application "\SpecialChar LyX
6618 \begin_layout LyX-Code
6622 \begin_layout LyX-Code
6623 -- Stores the current file name into f
6626 \begin_layout LyX-Code
6627 set f to (run "server-get-filename" with argument "")
6630 \begin_layout LyX-Code
6631 on error the error_message number the error_number
6634 \begin_layout LyX-Code
6635 display dialog "Error: " & the error_number & ".
6639 \begin_layout LyX-Code
6640 & the error_message buttons {"OK"} default button 1
6643 \begin_layout LyX-Code
6647 \begin_layout LyX-Code
6651 \begin_layout Section
6655 \begin_layout Standard
6657 can notify clients of events going on asynchronously.
6658 Currently it will only do this if the user binds a key sequence with the
6660 \begin_inset Quotes eld
6664 \begin_inset Quotes erd
6668 The format of the string \SpecialChar LyX
6669 sends is as follows:
6673 \begin_inset Flex Code
6676 \begin_layout Plain Layout
6687 \begin_layout Standard
6692 is the printed representation of the key sequence that was actually typed
6696 \begin_layout Standard
6697 This mechanism can be used to extend \SpecialChar LyX
6698 's command set and implement macros.
6699 Bind some key sequence to
6700 \begin_inset Quotes eld
6704 \begin_inset Quotes erd
6708 Then start a client that listens on the output pipe, dispatches the command
6709 according to the sequence, and starts a function that may use \SpecialChar LyX
6712 requests to issue a command or a series of commands to \SpecialChar LyX
6716 \begin_layout Section
6717 The simple \SpecialChar LyX
6721 \begin_layout Standard
6723 implements a simple protocol that can be used for session management.
6724 All messages are of the form
6737 \begin_layout Standard
6743 \begin_inset Quotes eld
6747 \begin_inset Quotes erd
6751 \begin_inset Quotes eld
6755 \begin_inset Quotes erd
6760 \begin_inset Quotes eld
6764 \begin_inset Quotes erd
6767 is received from a client, \SpecialChar LyX
6768 will report back to inform the client that
6769 it's listening to it's messages, while
6770 \begin_inset Quotes eld
6774 \begin_inset Quotes erd
6777 sent from \SpecialChar LyX
6778 will inform clients that \SpecialChar LyX
6782 \begin_layout Section
6783 Reverse DVI/PDF search
6786 \begin_layout Standard
6787 Some DVI/PDF viewers
6791 \begin_layout Plain Layout
6792 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6793 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6802 facility (also called
6807 This means that you can tell \SpecialChar LyX
6808 to put the cursor to a specific line in the
6809 document by clicking at the respective position in the DVI/PDF output.
6810 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6812 This is done via the \SpecialChar LyX
6813 server either by using the named pipe (
6817 ), or the UNIX domain socket (
6821 ) that \SpecialChar LyX
6822 creates in its temporary directory (this is the way the
6823 \begin_inset Flex Code
6826 \begin_layout Plain Layout
6832 program communicates with \SpecialChar LyX
6834 In some cases, you need a helper script that mediates between the viewer
6835 and \SpecialChar LyX
6836 , in others, the viewer can communicate with \SpecialChar LyX
6838 This depends on the selected viewer and on your operating system.
6839 The same applies to the way viewers need to be configured and the way the
6840 reverse search is actually performed.
6841 In what follows, we will thus describe how to setup reverse search for
6843 Before we turn to this, though, we will explain what needs to be done generally
6844 to enable reverse search in the DVI/PDF output.
6847 \begin_layout Subsection
6849 \begin_inset CommandInset label
6851 name "subsec:rev-search"
6858 \begin_layout Standard
6859 In most cases \SpecialChar LyX
6860 will do the work for you by enabling the option
6861 \begin_inset Flex Noun
6864 \begin_layout Plain Layout
6865 Synchronize with Output
6871 \begin_inset Flex Noun
6874 \begin_layout Plain Layout
6875 Document\SpecialChar menuseparator
6876 Settings\SpecialChar menuseparator
6883 In such a case \SpecialChar LyX
6884 will automatically insert the necessary Sync\SpecialChar TeX
6886 PDF) or load the srcltx package (for DVI) respectively.
6887 This option can be easily reached also on
6888 \begin_inset Flex Code
6891 \begin_layout Plain Layout
6900 \begin_layout Standard
6901 If you need a different setting, you can select or input a custom macro
6902 from the drop down box just below
6903 \begin_inset Flex Noun
6906 \begin_layout Plain Layout
6907 Document\SpecialChar menuseparator
6908 Settings\SpecialChar menuseparator
6909 Output\SpecialChar menuseparator
6910 Synchronize with Output
6918 \begin_layout Standard
6919 Note that the method
6920 \begin_inset Flex Code
6923 \begin_layout Plain Layout
6931 enables gzip compression.
6932 If your viewer does not support it, you should instead use
6933 \begin_inset Flex Code
6936 \begin_layout Plain Layout
6947 \begin_layout Standard
6948 Please also note that including the
6949 \begin_inset Flex Code
6952 \begin_layout Plain Layout
6959 \begin_inset Flex Code
6962 \begin_layout Plain Layout
6968 sometimes has an undesired impact on the typesetting.
6969 Thus, you should switch output synchronization off for the final typesetting
6971 \begin_inset Flex Code
6974 \begin_layout Plain Layout
6981 \begin_inset Flex Code
6984 \begin_layout Plain Layout
6994 \begin_layout Standard
6995 In case you need some more special settings that are not covered by the
6996 automatic settings, read the next section about how to set up output synchroniz
6998 If the automatic setup suits your needs, you can readily jump to section
6999 \begin_inset space ~
7003 \begin_inset CommandInset ref
7005 reference "subsec:configuring-viewers"
7009 , where the necessary configuration steps in your viewer – needed both with
7010 the automatic and the manual setup – are described.
7013 \begin_layout Subsection
7017 \begin_layout Standard
7019 provides several different methods for reverse search.
7020 Some are built-in in the
7021 \begin_inset Flex Code
7024 \begin_layout Plain Layout
7030 program, some are provided by external packages.
7031 Your choice depends on whether your \SpecialChar LaTeX
7032 distribution already provides a given
7033 method (the built-in methods are rather new) and whether your viewer can
7035 The available methods are described in the following.
7038 \begin_layout Subsubsection*
7039 Built-in DVI-search via src-specials (DVI only)
7042 \begin_layout Standard
7043 This method provides the DVI file with the necessary information for reverse
7045 It is available in \SpecialChar LaTeX
7046 since quite some time (any somewhat recent \SpecialChar LaTeX
7048 should include it), and it works reliably.
7049 To enable it, change the
7050 \begin_inset Flex Noun
7053 \begin_layout Plain Layout
7064 \begin_inset Flex Noun
7067 \begin_layout Plain Layout
7078 \begin_inset Flex Noun
7081 \begin_layout Plain Layout
7082 Preferences\SpecialChar menuseparator
7083 File Handling\SpecialChar menuseparator
7090 \begin_inset Flex Code
7093 \begin_layout Plain Layout
7094 latex -src-specials $$i
7100 If this doesn't work, check if your \SpecialChar TeX
7101 engine needs different options (the
7102 syntax might differ in some distributions).
7105 \begin_layout Subsubsection*
7106 External Packages (PDFSync and scrltx)
7109 \begin_layout Standard
7118 provide reverse search facility for PDF output (via pdflatex) and DVI output,
7120 In order to enable it, load the packages in the \SpecialChar LyX
7124 \begin_layout Itemize
7125 \begin_inset Flex Code
7128 \begin_layout Plain Layout
7136 for reverse PDF search,
7139 \begin_layout Itemize
7140 \begin_inset Flex Code
7143 \begin_layout Plain Layout
7146 usepackage[active]{srcltx}
7151 for reverse DVI search.
7154 \begin_layout Standard
7155 If you want to be able to perform both DVI and PDF reverse searches, you
7156 can also insert in the preamble the following lines
7159 \begin_layout LyX-Code
7163 \begin_inset Newline newline
7169 \begin_inset Newline newline
7175 \begin_inset Newline newline
7181 \begin_inset Newline newline
7186 usepackage[active]{srcltx}
7187 \begin_inset Newline newline
7195 \begin_layout Standard
7196 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7197 right package will be used.
7200 \begin_layout Standard
7201 Note that PDFSync might affect the output layout of your document.
7202 It is therefore advised to disable PDFsync for final documents.
7205 \begin_layout Subsubsection*
7206 Built-in reverse search via Sync\SpecialChar TeX
7210 \begin_layout Standard
7212 \begin_inset Flex Code
7215 \begin_layout Plain Layout
7221 have built-in support for both PDF and DVI reverse search.
7224 Sync\SpecialChar TeX
7227 facility is basically the result of the integration of the PDFSync package
7228 to the pdftex program and its merge with the
7233 You need at least \SpecialChar TeX
7234 Live 2008 or a recent Mik\SpecialChar TeX
7235 distribution in order to use
7240 \begin_layout Plain Layout
7241 For some reason, Mik\SpecialChar TeX
7242 does not understand/obey the command \SpecialChar LyX
7244 the preamble when you check the "Enable Forward/Reverse Search" button
7245 in the toolbar and does not generate the necessary info.
7248 \begin_layout Plain Layout
7249 The generation of the required info can be forced by changing the converter
7251 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7252 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7253 the -synctex=1 switch).
7258 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
7259 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
7263 \begin_layout Standard
7264 To enable Sync\SpecialChar TeX
7265 for DVI output, change the
7266 \begin_inset Flex Noun
7269 \begin_layout Plain Layout
7280 \begin_inset Flex Noun
7283 \begin_layout Plain Layout
7294 \begin_inset Flex Noun
7297 \begin_layout Plain Layout
7298 Preferences\SpecialChar menuseparator
7299 File Handling\SpecialChar menuseparator
7306 \begin_inset Flex Code
7309 \begin_layout Plain Layout
7310 latex -synctex=1 $$i
7315 , and for PDF output, change the
7316 \begin_inset Flex Noun
7319 \begin_layout Plain Layout
7324 (pdflatex) -> PDF (pdflatex)
7330 \begin_inset Flex Code
7333 \begin_layout Plain Layout
7334 pdflatex -synctex=1 $$i
7340 Check the documentation of your viewer whether the viewer needs to be configure
7341 d for the use with Sync\SpecialChar TeX
7346 \begin_layout Plain Layout
7347 Note that the option
7348 \begin_inset Flex Code
7351 \begin_layout Plain Layout
7357 option enables gzip compression.
7358 If your viewer does not support it, you should instead use
7359 \begin_inset Flex Code
7362 \begin_layout Plain Layout
7376 \begin_layout Subsection
7377 Configuring and using specific viewers
7378 \begin_inset CommandInset label
7380 name "subsec:configuring-viewers"
7387 \begin_layout Subsubsection*
7388 Xdvi (all platforms)
7391 \begin_layout Standard
7393 \begin_inset Flex Code
7396 \begin_layout Plain Layout
7402 , you don't need to do anything else for performing a reverse DVI search,
7404 already provides the necessary hooks for automatically using the
7405 \begin_inset Flex Code
7408 \begin_layout Plain Layout
7415 Just setup your document as described above (reverse search is triggered
7416 by Ctrl-click or Alt-click on Mac OSX, respectively).
7419 \begin_layout Standard
7420 However, if for whatever reason you want to use the named pipe instead of
7421 the socket for communicating with \SpecialChar LyX
7422 , simply change the DVI viewer in
7423 \begin_inset Flex Noun
7426 \begin_layout Plain Layout
7427 Preferences\SpecialChar menuseparator
7428 File Handling\SpecialChar menuseparator
7438 \begin_layout Plain Layout
7439 On Mac OSX you have to use
7440 \begin_inset Flex Code
7443 \begin_layout Plain Layout
7444 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7455 \begin_inset Flex Code
7458 \begin_layout Plain Layout
7459 xdvi -editor "lyxeditor.sh %f %l"
7465 \begin_inset Flex Code
7468 \begin_layout Plain Layout
7474 is a suitable script.
7475 For example, a minimal shell script is the following one:
7478 \begin_layout LyX-Code
7480 \begin_inset Newline newline
7483 LYXPIPE="/path/to/lyxpipe"
7484 \begin_inset Newline newline
7487 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7488 \begin_inset Newline newline
7491 echo "$COMMAND" > "${LYXPIPE}".in || exit
7492 \begin_inset Newline newline
7495 read TMP < "${LYXPIPE}".out || exit
7498 \begin_layout Standard
7500 \begin_inset Flex Code
7503 \begin_layout Plain Layout
7509 is the LyXServer pipe path specified in
7510 \begin_inset Flex Noun
7513 \begin_layout Plain Layout
7514 Preferences\SpecialChar menuseparator
7524 \begin_layout Plain Layout
7526 \begin_inset Flex Code
7529 \begin_layout Plain Layout
7535 folder of a source distribution you can find a
7536 \begin_inset Flex Code
7539 \begin_layout Plain Layout
7545 script which is able to locate the
7549 based on your preferences.
7557 \begin_layout Subsubsection*
7561 \begin_layout Standard
7563 \begin_inset Flex Code
7566 \begin_layout Plain Layout
7567 /Applications/MacDviX_Folder/calleditor.script
7572 , add the following lines:
7575 \begin_layout LyX-Code
7576 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7577 \begin_inset Newline newline
7583 \begin_layout Standard
7584 Modify the lines accordingly if you install \SpecialChar LyX
7585 somewhere else than in the
7586 Applications folder.
7589 \begin_layout Standard
7590 Reverse search is triggered by Alt-click (OPTION-click).
7593 \begin_layout Subsubsection*
7597 \begin_layout Standard
7599 \begin_inset Flex Code
7602 \begin_layout Plain Layout
7603 open -a Skim.app $$i
7608 to the viewer setting in
7609 \begin_inset Flex Noun
7612 \begin_layout Plain Layout
7613 Preferences\SpecialChar menuseparator
7614 File Handling\SpecialChar menuseparator
7615 File formats\SpecialChar menuseparator
7622 \begin_inset Flex Noun
7625 \begin_layout Plain Layout
7626 Skim\SpecialChar menuseparator
7627 Preferences\SpecialChar menuseparator
7634 \begin_inset Flex Noun
7637 \begin_layout Plain Layout
7643 preset and enter command
7644 \begin_inset Flex Noun
7647 \begin_layout Plain Layout
7648 /Applications/\SpecialChar LyX
7649 .app/Contents/MacOS/lyxeditor
7657 \begin_layout Standard
7658 Reverse search is triggered by COMMAND-SHIFT-click
7661 \begin_layout Subsubsection*
7665 \begin_layout Standard
7667 \begin_inset Flex Noun
7670 \begin_layout Plain Layout
7671 Settings\SpecialChar menuseparator
7672 Configure Okular\SpecialChar menuseparator
7679 \begin_inset Quotes eld
7683 \begin_inset Quotes erd
7687 \begin_inset Flex Code
7690 \begin_layout Plain Layout
7699 \begin_layout Standard
7700 Reverse search is triggered by SHIFT-click.
7703 \begin_layout Subsubsection*
7707 \begin_layout Standard
7708 Qpdfview supports Sync\SpecialChar TeX
7709 since version 0.3.5.
7711 \begin_inset Flex Noun
7714 \begin_layout Plain Layout
7715 Edit\SpecialChar menuseparator
7716 Settings\SpecialChar menuseparator
7722 , click on the input field of the
7723 \begin_inset Quotes eld
7727 \begin_inset Quotes erd
7730 item and add the command
7731 \begin_inset Flex Code
7734 \begin_layout Plain Layout
7743 \begin_layout Standard
7744 Reverse search is triggered by double-click or, in more recent versions,
7748 \begin_layout Subsubsection*
7752 \begin_layout Standard
7753 Launch yap, choose its
7754 \begin_inset Flex Noun
7757 \begin_layout Plain Layout
7758 View\SpecialChar menuseparator
7765 \begin_inset Quotes eld
7769 \begin_inset Quotes erd
7774 \begin_inset Quotes eld
7777 New\SpecialChar ldots
7779 \begin_inset Quotes erd
7782 button and, in the window that opens, enter
7783 \begin_inset Quotes eld
7788 \begin_inset Quotes erd
7791 (or any other name you like) in the
7792 \begin_inset Quotes eld
7796 \begin_inset Quotes erd
7800 Now click on the button labeled
7801 \begin_inset Quotes eld
7806 \begin_inset Quotes erd
7809 to open a file dialog and navigate to the directory containing the batch
7811 \begin_inset Flex Code
7814 \begin_layout Plain Layout
7822 \begin_inset Flex Code
7825 \begin_layout Plain Layout
7831 and then specify the program arguments as
7832 \begin_inset Flex Code
7835 \begin_layout Plain Layout
7843 \begin_inset Flex Code
7846 \begin_layout Plain Layout
7852 wrapper is used for communicating with \SpecialChar LyX
7860 \begin_layout LyX-Code
7862 \begin_inset Newline newline
7865 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7874 \begin_inset Newline newline
7888 \begin_layout Standard
7889 Make sure that the \SpecialChar LyX
7890 Server pipe path you specified in \SpecialChar LyX
7892 \begin_inset Flex Code
7895 \begin_layout Plain Layout
7909 , otherwise change the
7910 \begin_inset Flex Code
7913 \begin_layout Plain Layout
7919 wrapper accordingly.
7922 \begin_layout Standard
7923 In yap, reverse search is triggered by double-click.
7926 \begin_layout Subsubsection*
7927 SumatraPDF (Windows)
7930 \begin_layout Standard
7931 In order to use SumatraPDF for inverse search, enter
7932 \begin_inset Flex Code
7935 \begin_layout Plain Layout
7936 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7941 in the viewer setting in
7942 \begin_inset Flex Noun
7945 \begin_layout Plain Layout
7946 Preferences\SpecialChar menuseparator
7947 File Handling\SpecialChar menuseparator
7948 File formats\SpecialChar menuseparator
7955 \begin_inset Flex Code
7958 \begin_layout Plain Layout
7964 is the previous wrapper.
7965 If SumatraPDF.exe is not in your command PATH, use its full file name.
7968 \begin_layout Standard
7969 Reverse search is triggered by double-click.
7972 \begin_layout Subsubsection*
7976 \begin_layout Standard
7977 First of all, make sure that yap is your default DVI viewer in the Windows
7978 environment, then launch it, choose its
7979 \begin_inset Flex Noun
7982 \begin_layout Plain Layout
7983 View\SpecialChar menuseparator
7990 \begin_inset Quotes eld
7994 \begin_inset Quotes erd
7999 \begin_inset Quotes eld
8002 New\SpecialChar ldots
8004 \begin_inset Quotes erd
8007 button and, in the window that opens, enter
8008 \begin_inset Quotes eld
8013 \begin_inset Quotes erd
8016 (or any other name you like) in the
8017 \begin_inset Quotes eld
8021 \begin_inset Quotes erd
8025 Now click on the button labeled
8026 \begin_inset Quotes eld
8031 \begin_inset Quotes erd
8034 to open a file dialog and navigate to the directory containing the
8035 \begin_inset Flex Code
8038 \begin_layout Plain Layout
8044 program (which is installed by default on Cygwin along with the \SpecialChar LyX
8047 \begin_inset Flex Code
8050 \begin_layout Plain Layout
8056 and then specify the program arguments as
8057 \begin_inset Flex Code
8060 \begin_layout Plain Layout
8067 In this way, you will be using the
8071 for communicating with \SpecialChar LyX
8073 If, for whatever reason, you want to use the
8078 \begin_inset Flex Code
8081 \begin_layout Plain Layout
8087 option and be sure to specify the \SpecialChar LyX
8088 Server pipe path in the \SpecialChar LyX
8092 \begin_layout Standard
8093 In yap, reverse search is triggered by double-click.
8096 \begin_layout Subsubsection*
8100 \begin_layout Standard
8101 In order to use SumatraPDF for inverse search, enter
8102 \begin_inset Flex Code
8105 \begin_layout Plain Layout
8106 SumatraPDF -inverse-search "lyxeditor -g %f %l"
8111 in the viewer setting in
8112 \begin_inset Flex Noun
8115 \begin_layout Plain Layout
8116 Preferences\SpecialChar menuseparator
8117 File Handling\SpecialChar menuseparator
8118 File formats\SpecialChar menuseparator
8125 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8127 \begin_inset Flex Code
8130 \begin_layout Plain Layout
8136 enables communication via the
8142 \begin_inset Flex Code
8145 \begin_layout Plain Layout
8151 option if you want to use the
8155 , and be sure to specify the \SpecialChar LyX
8156 Server pipe path in the \SpecialChar LyX
8160 \begin_layout Standard
8161 Reverse search is triggered by double-click.
8164 \begin_layout Section
8168 \begin_layout Standard
8169 Forward search is, as the name implies, in a sense the
8170 \begin_inset Quotes eld
8174 \begin_inset Quotes erd
8178 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8180 If forward search is set up (as described in what follows), you can put
8181 the cursor anywhere in your \SpecialChar LyX
8183 \begin_inset Flex Noun
8186 \begin_layout Plain Layout
8187 Navigate\SpecialChar menuseparator
8194 \begin_inset Flex Noun
8197 \begin_layout Plain Layout
8203 in the context menu via right mouse click), and then the viewer will jump
8204 to that position as well.
8205 This implies, of course, that your viewer supports this function.
8208 \begin_layout Standard
8209 To make forward search possible, you first need to provide the generated
8210 output PDF/DVI file with additional information about the \SpecialChar TeX
8212 This can be done via the methods described in the section
8213 \begin_inset CommandInset ref
8215 reference "subsec:rev-search"
8222 \begin_layout Standard
8223 Additionally, you need to configure \SpecialChar LyX
8224 for using your viewers in
8225 \begin_inset Flex Noun
8228 \begin_layout Plain Layout
8229 Tools\SpecialChar menuseparator
8230 Preferences\SpecialChar menuseparator
8231 Output\SpecialChar menuseparator
8238 We provide a range of tested configurations for some viewers, which you
8239 can select from the drop down list.
8240 If none of these configurations suits you, you have to find out and enter
8241 a suitable configuration yourself.
8242 The definition syntax uses the following placeholders:
8245 \begin_layout Itemize
8247 \begin_inset Flex Code
8250 \begin_layout Plain Layout
8259 \begin_layout Itemize
8261 \begin_inset Flex Code
8264 \begin_layout Plain Layout
8270 : name of the (temporary) exported .tex file (without path)
8273 \begin_layout Itemize
8275 \begin_inset Flex Code
8278 \begin_layout Plain Layout
8284 : name of the (temporary) exported .tex file (including path)
8287 \begin_layout Itemize
8289 \begin_inset Flex Code
8292 \begin_layout Plain Layout
8298 : name of the exported output file (either dvi or pdf, depending on which
8299 one exists in the temporary directory)
8302 \begin_layout Standard
8303 Note that only some of the viewers provide full forward search functionality,
8304 among them yap, xdvi, okular
8308 \begin_layout Plain Layout
8309 You might want to set
8310 \begin_inset Flex Code
8313 \begin_layout Plain Layout
8320 \begin_inset Flex Noun
8323 \begin_layout Plain Layout
8324 Tools\SpecialChar menuseparator
8325 Preferences\SpecialChar menuseparator
8326 File Handling\SpecialChar menuseparator
8328 \begin_inset space ~
8341 , qpdfview and SumatraPDF
8345 \begin_layout Plain Layout
8346 SumatraPDF can also use DDE commands through the external program CMCDDE
8348 \begin_inset CommandInset href
8350 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8361 While many of the widespread PDF viewers (most notably Adobe Reader) do
8362 not support forward search at all, some other viewers – e.
8363 \begin_inset space \thinspace{}
8367 evince and xpdf – allow at least to reload the document and jump to a specific
8368 page of the file, so you can at least navigate
8369 \begin_inset Quotes eld
8373 \begin_inset Quotes erd
8377 This latter functionality is provided by an external call of synctex (see
8378 the predefined example configurations).
8382 \begin_layout Standard
8383 Forward search works both with DVI and PDF output.
8385 simply checks which preview format you have used before (i.
8386 \begin_inset space \thinspace{}
8389 e., which format is already there in the temporary directory) and chooses
8390 the appropriate configuration for the respective format.
8393 \begin_layout Chapter
8394 Special Document Classes
8397 \begin_layout Section
8401 \begin_layout Standard
8407 \begin_layout Subsection
8411 \begin_layout Standard
8412 This section describes how \SpecialChar LyX
8413 can be used to write articles for submission
8414 to the scientific journal
8416 Astronomy and Astrophysics
8419 \begin_inset Flex URL
8422 \begin_layout Plain Layout
8424 http://www.edpsciences.fr/aa/
8429 ) using Version 5.01 of the document class
8434 This package can be downloaded from the ftp site
8437 \begin_layout Standard
8438 \begin_inset VSpace medskip
8444 \begin_layout Standard
8446 \begin_inset Flex URL
8449 \begin_layout Plain Layout
8451 ftp://ftp.edpsciences.org/pub/aa/readme.html
8459 \begin_layout Standard
8460 \begin_inset VSpace medskip
8466 \begin_layout Standard
8467 A manual comes together with that package, and this text is not meant to
8468 replace the original manual but is merely a short guide in how to realize
8469 the correct form of your paper.
8473 \begin_layout Standard
8474 Please note that the publisher of the journal was changed from Springer
8475 to EDP Sciences starting January 1, 2001.
8476 That change involved also some slight changes to the style files, namely
8477 the removal of the thesaurus command.
8478 The \SpecialChar LyX
8479 class aa supports the newest version of these style files, V 5.01.
8480 If you have an older version installed, please upgrade.
8481 For compatibility, the old (version 4) layout has been kept as
8486 Please refer to the comments in
8489 Dir/layouts/aapaper.layout
8494 \begin_layout Subsection
8498 \begin_layout Standard
8499 It is recommended you start from the example template distributed with \SpecialChar LyX
8501 If you are not using a template, note the following settings:
8504 \begin_layout Itemize
8511 Document\SpecialChar menuseparator
8514 dialog (OK, that one was obvious).
8517 \begin_layout Itemize
8518 Don't change the option
8521 \begin_inset space ~
8531 The whole layout is done by the macros, you shouldn't change anything.
8534 \begin_layout Subsection
8538 \begin_layout Standard
8539 First thing to enter is the header information.
8540 It consists of seven entries, of which some are optional.
8544 \begin_layout Itemize
8552 \begin_layout Itemize
8560 \begin_layout Itemize
8568 \begin_layout Itemize
8576 \begin_layout Itemize
8581 : [optional] if more than one author: whom to contact for offprint requests.
8584 \begin_layout Itemize
8589 : [optional] mail address for contacts.
8592 \begin_layout Itemize
8600 Received: <date>; Accepted <date>
8603 \begin_layout Standard
8604 There is no need to issue the
8610 command, this is done automatically by \SpecialChar LyX
8611 when the header is finished.
8612 Although the order of the single header entries doesn't matter it is advised
8613 to keep the above sequence, just to get the best optics and meets the layout
8614 of the real document.
8617 \begin_layout Standard
8618 If you want to place footnotes in the header block, e.
8619 \begin_inset space \thinspace{}
8623 \begin_inset space \space{}
8626 to state your present address, just use the standard footnote via the menu
8629 Insert\SpecialChar menuseparator
8634 will automagically use the term
8643 \begin_layout Standard
8644 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8646 have no counterpart in \SpecialChar LyX
8650 \begin_layout Itemize
8657 to separate different names for more than one author and institute, respectivel
8661 \begin_layout Itemize
8668 to mark corresponding author/institute pairs.
8669 The institutes are numbered sequentially as they appear in the
8673 field, so you have to put a marker to each author.
8676 \begin_layout Itemize
8683 to supply an email address for fast contact.
8686 \begin_layout Standard
8687 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8695 \begin_layout Subsection
8699 \begin_layout Standard
8700 The abstract should immediately follow the header block.
8701 With version 5 the abstract environment was changed to a command, and there
8702 is now a resctriction to only one paragraph.
8703 In addition, it should contain an entry with the keywords.
8704 This is not yet implemented for \SpecialChar LyX
8705 , therefore you have to enter the \SpecialChar LaTeX
8713 by hand and mark it as \SpecialChar LaTeX
8715 Refer to the example paper.
8718 \begin_layout Subsection
8719 Supported environments
8722 \begin_layout Standard
8723 The A&A paper layout supports the following environments for structuring
8727 \begin_layout Itemize
8733 \begin_layout Itemize
8739 \begin_layout Itemize
8745 \begin_layout Itemize
8751 \begin_layout Itemize
8757 \begin_layout Itemize
8763 \begin_layout Itemize
8769 \begin_layout Itemize
8775 \begin_layout Itemize
8781 \begin_layout Itemize
8787 \begin_layout Itemize
8793 \begin_layout Itemize
8800 \begin_layout Subsection
8801 Commands not supported by \SpecialChar LyX
8805 \begin_layout Standard
8806 Some commands are not yet supported by the
8810 layout for \SpecialChar LyX
8812 Some have already been mentioned.
8813 For the sake of completeness, they are listed all together here:
8816 \begin_layout Itemize
8824 \begin_layout Itemize
8832 \begin_layout Itemize
8840 \begin_layout Itemize
8848 \begin_layout Itemize
8856 \begin_layout Itemize
8864 \begin_layout Itemize
8872 \begin_layout Itemize
8880 \begin_layout Standard
8881 If you want to use any of these commands, you have to enter them yourself.
8884 Do not forget to mark them as \SpecialChar LaTeX
8888 \begin_layout Subsection
8889 Figure and Table Floats
8892 \begin_layout Standard
8894 provides support for the necessary float environments
8896 figure, figure*, table
8902 , therefore we won't tell much about it here.
8906 \begin_inset space ~
8912 Just remember that tables should be left-aligned.
8913 For that, select the table and change the alignment in
8915 Edit\SpecialChar menuseparator
8917 \begin_inset space ~
8923 \begin_layout Standard
8924 There is only one special thing: the figures with caption besides the figure.
8925 To create such a figure, you have to do the following:
8928 \begin_layout Enumerate
8929 Create a wide figure float:
8931 Insert\SpecialChar menuseparator
8932 Float\SpecialChar menuseparator
8935 , then right click in the figure and select
8938 \begin_inset space ~
8946 \begin_layout Enumerate
8947 Enter your caption text.
8950 \begin_layout Enumerate
8955 to move the cursor above the caption.
8958 \begin_layout Enumerate
8962 \begin_layout Enumerate
8963 Position the cursor behind the figure and insert a horizontal fill:
8965 Insert\SpecialChar menuseparator
8967 \begin_inset space ~
8970 Character\SpecialChar menuseparator
8972 \begin_inset space ~
8980 \begin_layout Enumerate
8981 Switch to \SpecialChar LaTeX
8985 \begin_inset space ~
8993 \begin_layout Enumerate
9003 Do not close the brace!
9006 \begin_layout Enumerate
9007 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
9012 \begin_inset space ~
9024 \begin_layout Standard
9025 Also, refer to the figures in the example paper.
9028 \begin_layout Subsection
9032 \begin_layout Standard
9033 For submission, the paper has to be formated in a special double-spacing
9035 For this purpose, you have to give the option
9039 to the documentclass.
9040 This must be done using the extra class options field in the
9042 Document\SpecialChar menuseparator
9046 Just enter the string
9053 \begin_layout Subsection
9057 \begin_layout Standard
9062 directory contains an example paper written with \SpecialChar LyX
9064 It is the example paper from the original macro package, translated to
9067 Use it for inspiration, and compare the original \SpecialChar LaTeX
9068 code with \SpecialChar LyX
9072 \begin_layout Section
9077 \begin_layout Standard
9083 \begin_layout Subsection
9087 \begin_layout Standard
9089 is a set of macros produced by the American Astronomical Society to
9090 facilitate electronic manuscript submission to the three journals they
9091 publish: the Astrophysical Journal (including the Letters and Supplement),
9092 the Astronomical Journal, and the Publications of the Astronomical Society
9095 has proven to be an excellent tool for generating these documents, especially
9096 given its equation, citation, and figure handling capabilities.
9098 requires version 5.0 (or higher) of these macros; preferably 5.2, which
9099 is the version described here, or higher.
9100 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9101 2.09 and are fundamentally
9102 incompatible with \SpecialChar LyX
9104 The AAS\SpecialChar TeX
9105 package may be downloaded from the AAS\SpecialChar TeX
9109 \begin_layout Standard
9110 \begin_inset VSpace medskip
9116 \begin_layout Standard
9118 \begin_inset Flex URL
9121 \begin_layout Plain Layout
9123 https://aas.org/aastex/aastex-downloads
9131 \begin_layout Standard
9132 \begin_inset VSpace medskip
9138 \begin_layout Standard
9139 A complete user guide is contained in that package and you should familiarize
9140 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9143 will not reduce the need to figure out all the AAS\SpecialChar TeX
9144 commands, it will only
9145 reduce the drudgery of typing everything in.
9146 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9148 completely to the requirements of the journal to which you are submitting
9152 \begin_layout Subsection
9153 Starting a New Paper
9156 \begin_layout Standard
9157 I strongly suggest that you start with the AAS\SpecialChar TeX
9161 File\SpecialChar menuseparator
9168 , enter the new file name, then choose the
9173 This will show the most common fields found in a manuscript.
9174 Simply overwrite the existing text (including the brackets,
9178 ) with the correct information.
9179 Many of the AAS\SpecialChar TeX
9180 commands and environments can be implemented directly in
9182 , but some cannot: most noticeably
9194 , which should stick out like a sore thumb if you actually just opened the
9196 For commands such as these, the \SpecialChar LaTeX
9197 code must be entered directly and marked
9199 Such commands are referred to as \SpecialChar TeX
9200 code, or Evil Red Text.
9201 I tried to minimize the amount of \SpecialChar TeX
9202 code needed in an AAS\SpecialChar TeX
9204 there is still a bit more required than any of us would like.
9207 \begin_layout Subsection
9208 Finishing Your Paper
9211 \begin_layout Standard
9212 When the paper is finished to your satisfaction and previews/prints correctly,
9214 \begin_inset Quotes eld
9218 \begin_inset Quotes erd
9221 actions which need to be done before you submit it to the journals.
9225 \begin_layout Enumerate
9226 Export your paper as a \SpecialChar LaTeX
9229 File\SpecialChar menuseparator
9230 Export\SpecialChar menuseparator
9238 \begin_layout Enumerate
9243 file with your favorite text editor
9247 \begin_layout Enumerate
9248 remove the comment lines before the
9257 \begin_layout Enumerate
9262 usepackage...{fontenc}
9264 line if it appears (usually just after
9279 \begin_layout Enumerate
9280 remove everything between (and including) the
9292 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9294 (which should appear immediately after the
9295 \begin_inset Quotes eld
9298 User specified \SpecialChar LaTeX
9300 \begin_inset Quotes erd
9311 \begin_layout Enumerate
9312 Run the resulting file through \SpecialChar LaTeX
9313 to make sure it still processes correctly.
9316 \begin_layout Enumerate
9317 Reread the journal requirements to make sure your filenames and formats
9321 \begin_layout Enumerate
9325 \begin_layout Subsection
9326 Comments On Specific Commands
9329 \begin_layout Standard
9330 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9337 ) gives a good description of each.
9338 Thus it's probably easiest for me to go down the list as found in the guide
9339 and offer comments where necessary.
9340 So let's begin \SpecialChar ldots
9344 \begin_layout Subsubsection
9345 Things that work as expected
9348 \begin_layout Standard
9349 Because they work as you might expect, I simply list them and the section
9450 begin{thebibliography}
9458 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9459 graphicx figure commands (2.14.1),
9483 (2.15.4, amongst other places),
9510 \begin_layout Standard
9511 The following style options also work correctly:
9532 Simply put them in the
9538 Layout\SpecialChar menuseparator
9544 \begin_layout Subsubsection
9545 Things that work, but require more comment
9548 \begin_layout Standard
9549 The following items work, but require a little more discussion:
9552 \begin_layout Itemize
9553 These items are reserved for use by the journal editors, but you can put
9554 them into the \SpecialChar LaTeX
9555 preamble if you feel compelled to do so:
9588 \begin_layout Itemize
9589 These items may be placed in the \SpecialChar LaTeX
9590 preamble, and are included as blanks in
9612 \begin_layout Itemize
9619 (2.3) – can only be used
9620 \begin_inset Quotes eld
9624 \begin_inset Quotes erd
9627 , not in the middle of a paragraph.
9628 Use \SpecialChar TeX
9629 code if you need to embed it.
9632 \begin_layout Itemize
9639 (2.3) – will have extra {} after it.
9640 This should not cause an error.
9643 \begin_layout Itemize
9650 (2.6) – can only be used
9651 \begin_inset Quotes eld
9655 \begin_inset Quotes erd
9658 , not in the middle of a paragraph.
9659 Use \SpecialChar TeX
9660 code if you need to embed it.
9663 \begin_layout Itemize
9670 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9674 \begin_layout Itemize
9688 \begin_layout Itemize
9695 (2.9) – will have extra {} after it.
9696 This should not cause an error.
9699 \begin_layout Itemize
9706 (2.11) – will have extra {} after it.
9707 This should not cause an error.
9710 \begin_layout Itemize
9717 (2.14.2) – you can insert an optional filename argument by placing the cursor
9718 at the beginning of the text and selecting
9720 Insert\SpecialChar menuseparator
9725 \begin_inset Quotes eld
9729 \begin_inset Quotes erd
9732 inserts an optional argument of the type needed by
9739 Hopefully it will be renamed someday.
9742 \begin_layout Itemize
9755 for the catalog ID optional parameter
9758 \begin_layout Itemize
9771 for the catalog ID optional parameter
9774 \begin_layout Subsubsection
9775 Things not implemented, use \SpecialChar TeX
9779 \begin_layout Standard
9802 setcounter{equation}
9804 (2.12), Journal name abbreviations (2.13.4),
9840 (2.15.4, insert it as the first element in the lefthand cell after where
9842 Don't use any of \SpecialChar LyX
9843 's rules in the table),
9855 (2.15.5), much of Misc (2.17, except
9906 \begin_layout Subsubsection
9907 Things that cannot be implemented
9910 \begin_layout Standard
9912 at least in any meaningful sort of way, so I suggest ignoring them.
9913 They are the references environment (2.13.3), and the deluxetable environment
9915 If you really, really need to use deluxetable, I suggest editing it in
9916 a separate file with a text editor, then using
9918 Insert\SpecialChar menuseparator
9920 \begin_inset space ~
9925 to include it in your \SpecialChar LyX
9931 file to see an example of this.
9934 \begin_layout Subsection
9935 FAQs, Tips, Tricks, and Other Ruminations
9938 \begin_layout Subsubsection
9939 Getting \SpecialChar LyX
9940 and AAS\SpecialChar TeX
9944 \begin_layout Standard
9945 It can be a bit tricky to get \SpecialChar LyX
9946 to recognize a new layout and document class.
9947 When all else fails, do this:
9950 \begin_layout Enumerate
9951 Make certain that \SpecialChar LaTeX
9952 can find AAS\SpecialChar TeX
9954 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9956 directory completely unrelated to \SpecialChar LaTeX
9957 or AAS\SpecialChar TeX
9958 and run \SpecialChar LaTeX
9966 \begin_layout Enumerate
9971 appears in \SpecialChar LyX
9979 \begin_layout Enumerate
9982 Tools\SpecialChar menuseparator
9986 , then restart \SpecialChar LyX
9990 \begin_layout Enumerate
9991 Open a regular new file, not from a template.
9992 Does AAS\SpecialChar TeX
9993 appear in the class list in
9995 Document\SpecialChar menuseparator
10001 \begin_layout Standard
10002 If you get a warning from an existing AAS\SpecialChar TeX
10003 document about not being able
10004 to find the AAS\SpecialChar TeX
10005 layout or a message about
10006 \begin_inset Quotes eld
10009 You should not mix title layouts with normal ones
10010 \begin_inset Quotes erd
10013 , things haven't been installed correctly.
10016 \begin_layout Subsubsection
10018 error processing a table
10021 \begin_layout Standard
10023 , by default, attempts to center the table caption/title.
10024 This seems to produce a bad interaction in AAS\SpecialChar TeX
10025 so you should click somewhere
10026 in the caption/title, then select
10028 Edit\SpecialChar menuseparator
10030 \begin_inset space ~
10044 This took care of it for me.
10047 \begin_layout Subsubsection
10051 \begin_layout Standard
10052 A couple of things: 1) I have noticed some funny spacing in the reference
10053 entries in the text.
10054 When you enter the bibliography item data, make sure their is
10058 space between the last author and the parenthesis setting off the year;
10062 \begin_inset space \thinspace{}
10066 \begin_inset space \space{}
10080 2) Entering the references at all is not obvious.
10081 The easiest thing is to start typing your first reference at the end of
10082 the document, then mark it as type
10087 That will put a small gray box in front of what you just typed.
10088 Click on the box to fill in the rest of the information.
10089 For new references, go to the end of an existing reference and press return.
10090 That will create a new line with its own box, etc.
10093 \begin_layout Subsubsection
10094 Including EPS files
10097 \begin_layout Standard
10098 Even though AAS\SpecialChar TeX
10099 provides its own figure commands (
10105 , for example), I much prefer \SpecialChar LaTeX
10106 's standard figure commands (with the default
10115 \begin_inset space ~
10118 commands as \SpecialChar TeX
10119 code into a Figure Float box if you desire, but I never have
10120 much luck getting the layout right.
10121 With the standard graphics, \SpecialChar LyX
10126 usepackage{graphicx}
10128 command into the \SpecialChar LaTeX
10129 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10131 interspersing the figures in the text.
10132 I believe ApJ accepts figures exactly this way now; AJ might still use
10134 \begin_inset Quotes eld
10137 stack everything at the end
10138 \begin_inset Quotes erd
10144 \begin_layout Subsubsection
10145 Things I could have done, but didn't
10148 \begin_layout Standard
10150 \begin_inset Quotes eld
10154 \begin_inset Quotes erd
10157 things I could have implemented, but chose not to.
10158 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10160 even though it is double-spaced in the paper manuscript.
10161 Also, I chose not to make separate layouts for the preprint and preprint2
10163 Since I assume you will spend most of your time in the plain manuscript
10164 mode anyway, I decided not to chew up more disk space with this.
10168 \begin_layout Subsection
10172 \begin_layout Standard
10173 Your mileage may vary.
10174 I've now had papers published by both ApJ and AJ that have had 98% of the
10175 effort done in \SpecialChar LyX
10176 ; the last 2% was the \SpecialChar LaTeX
10177 post-processing and a few cleanups.
10178 I have had no trouble with the submission process, and I'm sure the journals
10179 were never aware that there might be a difference.
10180 So, go forth and publish!
10183 \begin_layout Section
10184 AMS \SpecialChar LaTeX
10188 \begin_layout Standard
10198 \begin_layout Standard
10199 \begin_inset VSpace bigskip
10205 \begin_layout Standard
10207 The AMS \SpecialChar LaTeX
10208 layouts are set up to conform to suggested styles for mathematical
10209 papers to be submitted to American Mathematical Society publications.
10210 The layouts are not tailored to a specific journal, but easily can be.
10211 You should refer to the AMS documentation for specific instructions for
10212 each journal (usually it will entail only changing a single line in the
10215 That documentation is available on the Web at
10216 \begin_inset Flex URL
10219 \begin_layout Plain Layout
10227 \begin_inset Flex URL
10230 \begin_layout Plain Layout
10232 ftp://ftp.ams.org/pub/tex/amslatex/
10238 These layouts are appropriate, and useful, for any mathematical writing.
10242 \begin_layout Standard
10243 There are two basic AMS \SpecialChar LaTeX
10247 \begin_layout Itemize
10248 amsart: The standard AMS article format.
10251 \begin_layout Itemize
10252 amsbook: the standard AMS book (really, monograph) format.
10256 \begin_layout Standard
10257 The layouts themselves contain only the minimum necessary to use the AMS
10259 They do not, in particular, contain any of the `theorem' environments used
10260 for setting theorems, lemmas, and the like.
10261 These are contained, instead, in the
10262 \begin_inset Flex Code
10265 \begin_layout Plain Layout
10271 module, which is loaded by default when you select one of the AMS classes.
10272 (It can also be used with other classes and can be removed, if you would
10273 rather use something else.) Less commonly used environments are in the
10274 \begin_inset Flex Code
10277 \begin_layout Plain Layout
10278 Theorems (AMS-Extended)
10283 module, which must be loaded manually.
10286 \begin_layout Standard
10287 By default, theorems and the like are numbered consecutively throughout
10288 the document, but this may be modified by loading the module
10289 \begin_inset Flex Code
10292 \begin_layout Plain Layout
10293 Theorems (Order by Section)
10298 or, if you are using
10299 \begin_inset Flex Code
10302 \begin_layout Plain Layout
10309 \begin_inset Flex Code
10312 \begin_layout Plain Layout
10313 Theorems (Order by Chapter)
10319 These will number the results as
10320 \begin_inset Formula $n.m$
10323 , where the first number refers to the section (or chapter) and the second
10324 refers to the total number of results so far in that section (or chapter).
10325 Many environments are also available unnumbered.
10326 These are indicated by an asterisk at the end.
10327 If you happen to want
10331 unnumbered results, the module
10332 \begin_inset Flex Code
10335 \begin_layout Plain Layout
10341 provides that option.
10344 \begin_layout Standard
10345 Note that these modules do not
10349 to be used with the AMS classes.
10350 It is perfectly possible to use the
10351 \begin_inset Flex Code
10354 \begin_layout Plain Layout
10360 module, and the others mentioned, with other classes, such as
10361 \begin_inset Flex Code
10364 \begin_layout Plain Layout
10371 \begin_inset Flex Code
10374 \begin_layout Plain Layout
10381 \begin_inset Flex Code
10384 \begin_layout Plain Layout
10393 \begin_layout Subsection
10394 What these layouts provide
10397 \begin_layout Standard
10398 There is a long list of included environments provided by these layouts.
10399 In AMS-\SpecialChar LaTeX
10400 , there is, in fact, an opportunity to define an unlimited variety
10401 of `theorem' environments.
10402 However, the AMS recommends the environments that are available in \SpecialChar LyX
10407 \begin_layout Standard
10408 The following environments—as well as the standard environments, such as
10410 \begin_inset Flex Noun
10413 \begin_layout Plain Layout
10420 \begin_inset Flex Noun
10423 \begin_layout Plain Layout
10430 \begin_inset Flex Noun
10433 \begin_layout Plain Layout
10440 \begin_inset Flex Noun
10443 \begin_layout Plain Layout
10450 \begin_inset Flex Noun
10453 \begin_layout Plain Layout
10460 \begin_inset Flex Code
10463 \begin_layout Plain Layout
10470 \begin_inset Flex Code
10473 \begin_layout Plain Layout
10482 \begin_layout Description
10483 Address This should be the author's permanent address.
10486 \begin_layout Description
10488 \begin_inset space ~
10491 Address This should be the author's temporary address at the time of submission,
10492 if different from the Address.
10495 \begin_layout Description
10496 Email Author's e-mail address
10499 \begin_layout Description
10500 URL Author's Web address, if desired.
10503 \begin_layout Description
10504 Keywords Key words or phrases used to identify specific topics discussed
10508 \begin_layout Description
10509 Subjectclass These refer to the AMS Subject Classifications, published and
10512 Mathematical Reviews
10515 These are also available online at the AMS cites listed above.
10518 \begin_layout Description
10522 \begin_layout Description
10526 \begin_layout Description
10530 \begin_layout Standard
10531 The following environments are provided by both the
10532 \begin_inset Flex Code
10535 \begin_layout Plain Layout
10542 \begin_inset Flex Code
10545 \begin_layout Plain Layout
10551 modules, in the latter case in both starred (unnumbered) and unstarred
10552 (numbered) versions.
10553 These same environments are provided only in the starred versions by the
10555 \begin_inset Flex Code
10558 \begin_layout Plain Layout
10567 \begin_layout Theorem
10568 This is typically used for the statements of major results.
10572 \begin_layout Corollary*
10573 This is used for statements which follow fairly directly from previous statement
10575 Again, these can be major results.
10579 \begin_layout Lemma
10580 These are smaller results needed to prove other statements.
10583 \begin_layout Proposition
10584 These are less major results which (hopefully) add to the general theory
10588 \begin_layout Conjecture
10589 These are statements provided without justification, which the author does
10590 not know how to prove, but which seem to be true (to the author, at least).
10593 \begin_layout Definition*
10594 Guess what this is for.
10595 The font is different for this environment than for the previous ones.
10599 \begin_layout Example*
10600 Used for examples illustrating proven results.
10603 \begin_layout Problem
10604 It's not really known what this is for.
10605 You should figure it out.
10608 \begin_layout Exercise*
10609 Write a description for this one.
10612 \begin_layout Remark
10613 This environment is also a type of theorem, usually a lesser sort of observation.
10616 \begin_layout Claim*
10617 Often used in the course of giving a proof of a larger result.
10621 Generally, these are used to break up long arguments, using specific instances
10627 The numbering scheme for cases is on its own, not together with other numbered
10632 \begin_layout Proof
10633 At the end of this environment, a QED symbol (usually a square, but it can
10634 vary with different styles) is placed.
10635 If you want to have other environments within this one—for example, Case
10636 environments—and have the QED symbol appear only after them, then the other
10637 environments need to be nested within the proof environment.
10640 Nesting Environments
10646 for information on nesting.
10649 \begin_layout Standard
10650 And these environments are provided by
10651 \begin_inset Flex Code
10654 \begin_layout Plain Layout
10655 Theorems (AMS-Extended)
10663 \begin_layout Criterion*
10664 A required condition.
10667 \begin_layout Algorithm*
10668 A general procedure to be used.
10671 \begin_layout Axiom*
10672 This is a property or statement taken as true within the system being discussed.
10675 \begin_layout Condition*
10676 Sometimes used to state a condition assumed within the present context of
10680 \begin_layout Note*
10681 Similar to a Remark.
10684 \begin_layout Notation*
10685 Used for the explanation of, yes, notation.
10688 \begin_layout Summary
10689 Do we really need to tell you?
10692 \begin_layout Acknowledgement*
10696 \begin_layout Conclusion*
10697 Sometimes used at the end of a long train of argument.
10701 Used in a way similar to Proposition, though perhaps lower on the scale.
10704 \begin_layout Standard
10705 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10708 They need to be available on your system in order to use these environments.
10711 \begin_layout Section
10719 \begin_layout Standard
10725 \begin_layout Subsection
10729 \begin_layout Standard
10730 These are the layout files for some of the journals of the American Geophysical
10732 It is assumed that you have both the AGU's own class files and AGUplus
10733 installed (everything to be found at
10734 \begin_inset Flex URL
10737 \begin_layout Plain Layout
10739 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10747 \begin_layout Subsection
10751 \begin_layout Standard
10761 They are still called this in the \SpecialChar LyX
10762 GUI, though their \SpecialChar LaTeX
10775 \begin_layout Standard
10776 Newly defined styles are
10813 These are mostly manuscript attributes and defined in the AGU class documentati
10817 \begin_layout Standard
10818 I suspect this is still badly incomplete.
10821 \begin_layout Subsection
10825 \begin_layout Standard
10842 \begin_layout Subsection
10846 \begin_layout Itemize
10849 Journal of Geophysical Research
10858 \begin_layout Standard
10859 Add your own, it isn't so hard! Look at the
10870 \begin_layout Subsection
10871 Bugs and things to remember
10874 \begin_layout Standard
10875 In order to use the new layouts, you must remember to do the following for
10879 \begin_layout Enumerate
10885 This can be done in the
10887 Layout\SpecialChar menuseparator
10892 Document\SpecialChar menuseparator
10896 (AGU articles are always in English, right? So
10900 choose a language.)
10903 \begin_layout Enumerate
10908 into the document's
10913 (Yes, this is a bug.)
10916 \begin_layout Enumerate
10917 Make sure you use the
10921 bibliography style, by entering
10925 into the second field of the Bib\SpecialChar TeX
10927 None of the standard styles will do.
10930 \begin_layout Section
10934 \begin_layout Standard
10940 \begin_layout Subsection
10944 \begin_layout Standard
10945 Broadway is for writing plays.
10946 The format is more decorative than Hollywood, and much less standardized.
10947 This format should be suitable for workshops.
10950 \begin_layout Subsection
10954 \begin_layout Standard
10955 The same as in Hollywood.
10958 \begin_layout Subsection
10962 \begin_layout Standard
10967 names as labels then cross-reference the label to insert the name.
10968 The cross-reference dialog will show the current cast of characters.
10971 \begin_layout Subsection
10972 Paper size and Margins
10975 \begin_layout Standard
10976 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10979 \begin_layout Subsection
10983 \begin_layout Standard
10984 The following environments are available.
10985 You can use broadway.bind to get the bind keys shown at the right.
10988 \begin_layout Itemize
10992 \begin_inset Newline newline
10997 You should not have to use this, but it is here for anything that does not
11001 \begin_layout Itemize
11005 \begin_inset space \hfill{}
11009 \begin_inset Newline newline
11014 Used to describe stage setting and the action.
11015 First use of speaker names in all CAPs.
11018 \begin_layout Itemize
11022 \begin_inset space \hfill{}
11026 \begin_inset Newline newline
11031 Automatically numbered.
11032 On screen it will be arabic, but will print as Roman.
11035 \begin_layout Itemize
11039 \begin_inset space \hfill{}
11043 \begin_inset Newline newline
11053 It is just centered text.
11056 \begin_layout Itemize
11060 \begin_inset space \hfill{}
11064 \begin_inset Newline newline
11069 Not automatically numbered.
11070 You supply the number.
11071 This is because I couldn't figure out how.
11074 \begin_layout Itemize
11078 \begin_inset space \hfill{}
11082 \begin_inset Newline newline
11087 A special case of Narrative to describe the setting and action as the curtain
11091 \begin_layout Itemize
11095 \begin_inset space \hfill{}
11099 \begin_inset Newline newline
11104 The speaker's (actor's) title, centered in all CAPS.
11107 \begin_layout Itemize
11111 \begin_inset space \hfill{}
11115 \begin_inset Newline newline
11120 Instructions to the speaker.
11121 The parentheses are automatically inserted.
11122 The ( will appear on screen, but both will be in the printed play.
11123 This environment is only used within
11130 \begin_layout Itemize
11134 \begin_inset space \hfill{}
11138 \begin_inset Newline newline
11143 What the Speaker says.
11146 \begin_layout Itemize
11150 \begin_inset space \hfill{}
11154 \begin_inset Newline newline
11159 The curtain comes down.
11162 \begin_layout Itemize
11166 \begin_inset space \hfill{}
11172 \begin_layout Itemize
11176 \begin_inset space \hfill{}
11182 \begin_layout Itemize
11186 \begin_inset space \hfill{}
11192 \begin_layout Standard
11196 \begin_layout Section
11200 \begin_layout Standard
11205 can be used to type letters according to German conventions.
11206 A template file is included in
11208 .../lyx/share/templates
11210 for you to use as a starting point.
11213 \begin_layout Section
11221 \begin_layout Standard
11227 \begin_layout Subsection
11231 \begin_layout Standard
11232 This is the layout file for the European Geophysical Society journals.
11237 can be downloaded from the web site of the EGS under
11238 \begin_inset Flex URL
11241 \begin_layout Plain Layout
11251 \begin_layout Subsection
11255 \begin_layout Standard
11258 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
11266 The current layout file is unfortunately very unmodular and would benefit
11267 from using the various
11274 \begin_layout Section
11278 \begin_layout Standard
11279 See the \SpecialChar LyX
11285 It contains all infos you need.
11288 \begin_layout Section
11291 Foil\SpecialChar TeX
11295 \begin_inset CommandInset label
11304 \begin_layout Standard
11310 \begin_layout Subsection
11314 \begin_layout Standard
11315 This section describes how to use \SpecialChar LyX
11316 to make slides for overhead projectors.
11317 There are two document classes that can do this: the default slides class
11320 Foil\SpecialChar TeX
11324 This section documents the latter.
11327 \begin_layout Standard
11328 I'm going to say this again, nice and clear, so that there's no misunderstanding
11332 \begin_layout Standard
11333 \begin_inset VSpace bigskip
11339 \begin_layout Standard
11343 This section documents the class
11344 \begin_inset Quotes eld
11352 \begin_inset Quotes erd
11360 \begin_layout Standard
11361 \begin_inset VSpace bigskip
11367 \begin_layout Standard
11368 If you're looking for the documentation for
11369 \begin_inset Quotes eld
11377 \begin_inset Quotes erd
11380 , check out section
11381 \begin_inset space ~
11385 \begin_inset CommandInset ref
11387 reference "sec:slitex"
11392 If your machine doesn't have the
11400 installed, you'll probably have to use the default
11404 class, which isn't quite as good as
11409 \begin_layout Standard
11414 class is designed for use with version
11415 \begin_inset space ~
11423 class file which is now an integral part of \SpecialChar LaTeX2e
11427 \begin_layout Subsection
11431 \begin_layout Standard
11432 Obviously, to use this document class, you need to select
11443 \begin_inset space ~
11449 There are some settings in the
11452 \begin_inset space ~
11457 dialog that you should know about that are specific to this class:
11460 \begin_layout Itemize
11461 Don't change the options
11472 \begin_inset space ~
11478 They're ignored by the
11485 \begin_layout Itemize
11486 The default font size is 20
11487 \begin_inset space \thinspace{}
11490 pt with the other options being 17
11491 \begin_inset space \thinspace{}
11495 \begin_inset space \thinspace{}
11499 \begin_inset space \thinspace{}
11505 \begin_layout Itemize
11506 The default font is
11514 but all math equations are still typeset in the usual roman font.
11517 \begin_layout Itemize
11520 Foil\SpecialChar TeX
11523 supports A4 and Letter paper sizes as well as a special size for working
11525 \begin_inset space \thinspace{}
11529 It doesn't support A5, B5, legal or executive paper sizes.
11532 \begin_layout Itemize
11533 Don't bother changing the
11537 settings because they are ignored anyway.
11538 All floats appear where they are defined in the text.
11541 \begin_layout Itemize
11546 setting behaves a bit differently for this class.
11549 Foil\SpecialChar TeX
11552 provides extensive footer and header capabilities including a user-defined
11555 \begin_inset space ~
11559 \begin_inset CommandInset ref
11561 reference "sec:foilfoot"
11566 The title page is treated differently to all other pages in the document
11575 has the logo centered at the bottom of the page (if one is defined).
11576 The possible page style choices and what they do are as follows:
11580 \begin_layout Labeling
11581 \labelwidthstring MMMMMMM
11588 The final output contains no page numbers, or other headers or footers
11589 (except footnotes of course).
11593 \begin_layout Labeling
11594 \labelwidthstring MMMMMMM
11601 The final output contains page numbers centered at the bottom of the page.
11602 No other headings or footers (other than footnotes).
11605 \begin_layout Labeling
11606 \labelwidthstring MMMMMMM
11611 Page numbers in lower right corner.
11612 Additional headers and footers are also shown.
11613 This is also the default.
11616 \begin_layout Labeling
11617 \labelwidthstring MMMMMMM
11622 Gives you access to the
11626 package although its use with
11628 Foil\SpecialChar TeX
11631 is discouraged by the writer of the
11633 Foil\SpecialChar TeX
11636 package because of some potential page layout clashes.
11640 \begin_layout Subsubsection
11644 \begin_layout Standard
11645 The following options may be used in the extra class options in the
11647 Document\SpecialChar menuseparator
11653 \begin_layout Labeling
11654 \labelwidthstring MMMMMMx
11659 This sets up the page layout for 7.33
11660 \begin_inset space \thinspace{}
11664 \begin_inset space \thinspace{}
11667 in paper, which is about the same aspect ratio as a 35
11668 \begin_inset space \thinspace{}
11671 mm slide, making it a bit easier to work with this medium.
11674 \begin_layout Labeling
11675 \labelwidthstring MMMMMMx
11680 Places a rule across the page below the header on every page except the
11684 \begin_layout Labeling
11685 \labelwidthstring MMMMMMx
11690 Places a rule across the page above the footer on every page except the
11694 \begin_layout Labeling
11695 \labelwidthstring MMMMMMx
11700 This is automatically set each time you create a new
11707 Foil\SpecialChar TeX
11710 to use the dvips driver to rotate those pages that are set as landscape
11714 \begin_layout Labeling
11715 \labelwidthstring MMMMMMx
11720 Simply changes the page dimensions to those of a landscape page but doesn't
11722 Thus if you use this option you need to use an external program to rotate
11723 each page or feed your paper through your printer as landscape.
11724 Note that this option effectively reverses the roles of the
11732 environments (don't worry these are described in the next section).
11735 \begin_layout Labeling
11736 \labelwidthstring MMMMMMx
11741 Equation numbers on the left.
11744 \begin_layout Labeling
11745 \labelwidthstring MMMMMMx
11750 Flush-left equations.
11753 \begin_layout Subsection
11754 Supported Environments
11757 \begin_layout Standard
11758 Most of the environments commonly supported in other classes are also supported
11764 There are several additional environments provided by
11766 Foil\SpecialChar TeX
11769 as well as a couple added by \SpecialChar LyX
11771 The following environments are shared with other classes:
11774 \begin_layout Standard
11775 \begin_inset Flex Multiple Columns
11778 \begin_layout Itemize
11784 \begin_layout Itemize
11790 \begin_layout Itemize
11796 \begin_layout Itemize
11802 \begin_layout Itemize
11808 \begin_layout Itemize
11815 \begin_layout Itemize
11821 \begin_layout Itemize
11827 \begin_layout Itemize
11833 \begin_layout Itemize
11839 \begin_layout Itemize
11845 \begin_layout Itemize
11851 \begin_layout Itemize
11857 \begin_layout Itemize
11863 \begin_layout Itemize
11869 \begin_layout Itemize
11875 \begin_layout Itemize
11881 \begin_layout Itemize
11892 \begin_layout Standard
11893 That is, all the major environments apart from the sectioning environments.
11894 Since foils are essentially self-contained sections, with a title and body,
11897 Foil\SpecialChar TeX
11900 provides specific commands for starting new foils and these are:
11903 \begin_layout Itemize
11909 \begin_layout Itemize
11915 \begin_layout Standard
11917 also provides slightly modified versions of these two environments called:
11920 \begin_layout Itemize
11926 \begin_layout Itemize
11929 ShortRotatefoilhead
11932 \begin_layout Standard
11933 and the differences will be explained in the next section.
11936 \begin_layout Standard
11937 Since foils are often used in presenting ideas or new theorems and such
11940 Foil\SpecialChar TeX
11943 also provides a comprehensive box of goodies for presenting them:
11946 \begin_layout Standard
11947 \begin_inset Flex Multiple Columns
11950 \begin_layout Itemize
11956 \begin_layout Itemize
11962 \begin_layout Itemize
11968 \begin_layout Itemize
11974 \begin_layout Itemize
11980 \begin_layout Itemize
11986 \begin_layout Itemize
11992 \begin_layout Itemize
11998 \begin_layout Itemize
12004 \begin_layout Itemize
12010 \begin_layout Itemize
12021 \begin_layout Standard
12022 The starred versions are unnumbered while the unstarred versions are numbered.
12023 There are also two list environments added by \SpecialChar LyX
12027 \begin_layout Itemize
12033 \begin_layout Itemize
12039 \begin_layout Standard
12042 Foil\SpecialChar TeX
12045 provides some powerful header and footer capabilities that are best set
12046 in the preamble although they may be set at any point in a document.
12047 If you want to change these settings in your document the best place to
12048 do so is at the very top of a foil, i.
12049 \begin_inset space \thinspace{}
12055 \begin_inset space \space{}
12060 straight after the foilhead.
12063 \begin_layout Standard
12064 For this purpose, the following command styles are provided [
12071 \begin_layout Standard
12072 \begin_inset Flex Multiple Columns
12075 \begin_layout Itemize
12079 \begin_inset space ~
12085 \begin_layout Itemize
12091 \begin_layout Itemize
12095 \begin_inset space ~
12101 \begin_layout Itemize
12105 \begin_inset space ~
12111 \begin_layout Itemize
12115 \begin_inset space ~
12122 \begin_layout Plain Layout
12123 \begin_inset space ~
12135 \begin_layout Standard
12136 There are also a few commands provided by
12138 Foil\SpecialChar TeX
12141 that aren't directly supported by \SpecialChar LyX
12142 but I'll tell you what they do and how
12143 to use them in section
12144 \begin_inset space ~
12148 \begin_inset CommandInset ref
12150 reference "sec:unsuppfoils"
12157 \begin_layout Subsection
12158 Building a Set of Foils
12161 \begin_layout Standard
12162 This section will give a simple introduction to using the different environments
12163 to build a set of foils.
12164 If you want to see an example set of foils, take a look at the
12168 file you find in \SpecialChar LyX
12176 \begin_layout Subsubsection
12177 Give It a Title Page
12180 \begin_layout Standard
12181 Unlike other classes that provide
12201 creates the title on a page of its own.
12202 If you leave out the
12206 environment \SpecialChar LaTeX
12207 will substitute the current date (every time you regenerate
12211 \begin_layout Subsubsection
12215 \begin_layout Standard
12216 As I mentioned earlier, there are four ways of starting a new foil.
12217 For portrait foils you should use
12226 The difference between these two environments is the amount of space between
12227 the title of the foil (the foilhead) and the body of the foil.
12230 \begin_layout Standard
12231 Landscape foils are generated using the
12237 ShortRotatefoilhead
12240 Again the only difference is the spacing between foilhead and body.
12241 Both of the short versions have 0.5
12242 \begin_inset space ~
12245 inches less separation between the foilhead and the body.
12249 \begin_layout Standard
12250 One problem with the support for landscape foils is the requirement that
12251 you have to use the
12255 driver to generate the PostScript output otherwise the foils won't be rotated.
12256 It is possible to get landscape foils even if you haven't got the
12260 driver provided you can feed your foils sideways through your printer ;-)
12263 \begin_layout Subsubsection
12264 Theorems, Lemmas, Proofs and more
12267 \begin_layout Standard
12268 Due to a small bug in \SpecialChar LyX
12269 you can't have two of the same type of these environments
12270 directly following each other.
12271 They must be separated by something.
12272 If you try, you will just be extending the previous environment as if you
12273 had merged the two environments together.
12274 So, how do you get around this problem? The simplest option is to insert
12275 some text between the two environments or add a
12280 environment between the two with just a
12281 \begin_inset Quotes eld
12289 \begin_inset Quotes erd
12293 This will force \SpecialChar LyX
12294 to produce two separate environments and hence the correct
12297 An example is provided in the example file included with the \SpecialChar LyX
12299 Remember, this problem only occurs if you are trying to place two of the
12300 same type of theorem-like environments one directly after the other.
12303 \begin_layout Subsubsection
12307 \begin_layout Standard
12308 You get all the commonly supported list styles found in other classes as
12309 well as two new ones.
12310 I'll only describe the new ones here.
12311 If you want to find out more about the other list environments check out
12317 If you intend to use itemized lists you might also want to read about the
12321 \begin_inset space ~
12325 \begin_inset space ~
12330 dialog described above in section
12331 \begin_inset space ~
12335 \begin_inset CommandInset ref
12337 reference "sec:bullet"
12344 \begin_layout Standard
12345 The two new list styles,
12353 , are designed to make it easier for you to create lists of do's and don'ts
12354 or right and wrong by providing dedicated environments that use a tick
12355 or a cross as the label of the list.
12356 These lists are in fact dedicated variants of the
12361 They do however require that you have the
12365 packages installed.
12368 \begin_layout Subsubsection
12372 \begin_layout Standard
12375 Foil\SpecialChar TeX
12378 redefines the floating tables and figures so that they appear exactly where
12379 they are in the text rather than pushing them to the top of the page or
12380 to some user specified location.
12381 In fact if you change the float placement settings they are simply ignored.
12384 \begin_layout Subsubsection
12385 Page Headers and Footers
12386 \begin_inset CommandInset label
12388 name "sec:foilfoot"
12395 \begin_layout Standard
12399 \begin_inset space ~
12408 are two commands used to control the left-footer text string.
12409 The first is meant to allow you to include a graphic logo on your foils
12411 \begin_inset Quotes eld
12416 Foil\SpecialChar TeX
12420 \begin_inset Quotes erd
12424 While the second is meant to provide a classification for the audience,
12428 \begin_inset space \thinspace{}
12434 \begin_inset space \space{}
12438 It is empty by default.
12441 \begin_layout Standard
12442 The remaining page corners can be filled by
12445 \begin_inset space ~
12450 (which defaults to page numbers),
12453 \begin_inset space ~
12461 \begin_inset space ~
12469 \begin_layout Subsection
12472 Foil\SpecialChar TeX
12476 \begin_inset CommandInset label
12478 name "sec:unsuppfoils"
12485 \begin_layout Standard
12486 All the commands mentioned below need to be set in a
12496 within another environment.
12499 \begin_layout Subsubsection
12503 \begin_layout Standard
12504 All lengths are adjusted using the
12527 should be replaced by the name given to the length you want to change and
12532 is the length value.
12533 All lengths should be specified in units of length such as inches (
12545 ) or relative to some document or font-based length such as
12555 \begin_layout Standard
12556 It's possible to change the spacing between a foilhead and the body of the
12557 foil by adjusting the length specified by
12564 For example, to make
12569 \begin_inset space \space{}
12572 in closer to their bodies put the following in the preamble:
12578 foilheadskip}{-0.5in}
12581 \begin_layout Standard
12582 The spacings around floats can be adjusted by setting these lengths:
12585 \begin_layout Labeling
12586 \labelwidthstring MMMMMMMMMMM
12593 Separation between the text and the top of the float
12596 \begin_layout Labeling
12597 \labelwidthstring MMMMMMMMMMM
12604 Separation between the float and the caption
12607 \begin_layout Labeling
12608 \labelwidthstring MMMMMMMMMMM
12615 Separation between the caption and the following text
12618 \begin_layout Labeling
12619 \labelwidthstring MMMMMMMMMMM
12626 You can make the captions narrower than the surrounding text by adjusting
12628 Best done relative to
12637 \begin_layout Standard
12638 There are also several title page related lengths that you may find useful
12639 if you have a long title or several authors:
12642 \begin_layout Labeling
12643 \labelwidthstring MMMMMMMMMMM
12650 Separation from headers to
12655 \begin_layout Labeling
12656 \labelwidthstring MMMMMMMMMMM
12674 \begin_layout Labeling
12675 \labelwidthstring MMMMMMMMMMM
12689 \begin_layout Labeling
12690 \labelwidthstring MMMMMMMMMMM
12706 \begin_layout Labeling
12707 \labelwidthstring MMMMMMMMMMM
12723 \begin_layout Standard
12724 The last length related command affects all the list environments.
12735 a list environment then all the vertical spacing between the list items
12737 Note that this is a command not a length so it doesn't require
12743 like the stuff mentioned above.
12746 \begin_layout Subsubsection
12747 Headers and Footers
12750 \begin_layout Standard
12763 commands control whether the logo in the
12767 definition appear on a given page.
12774 in the preamble then none of the foils will have the logo on them.
12775 If you don't want the logo on a particular page place the
12781 directly after the foilhead of that page and the
12787 directly after the next foilhead.
12790 \begin_layout Standard
12791 If you decide to use the
12795 page style setting in the
12798 \begin_inset space ~
12803 dialog you should probably add
12813 to your preamble so headers and footers on landscape pages are correctly
12814 placed when rotated.
12815 This is due to some clashes between the page layouts provided by the
12826 \begin_layout Section
12827 Hollywood (Hollywood spec scripts)
12830 \begin_layout Standard
12836 \begin_layout Subsection
12840 \begin_layout Standard
12841 Getting the format of a Hollywood script right is a
12842 \begin_inset Quotes eld
12846 \begin_inset Quotes erd
12849 It is designed to make the readers focus on content and to be easy and
12850 familiar for the actors to read.
12851 Each page of a script should be one minute of film.
12852 Nothing goes in a script that you cannot see or hear on screen.
12853 The courier 12 pt font should be used throughout.
12857 \begin_layout Subsection
12861 \begin_layout Standard
12862 Speakers' lines should NEVER break in mid-sentence.
12863 If a speaker's lines continue over a page break, repeat the
12867 title followed by (Cont'd).
12870 \begin_layout Subsection
12874 \begin_layout Standard
12879 names as labels then cross-reference the label to insert the name.
12880 The cross-reference dialog will show the current cast of characters.
12881 You can use this to insert the speaker name in narratives also.
12884 \begin_layout Subsection
12885 Paper size and Margins
12888 \begin_layout Standard
12889 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12892 \begin_layout Subsection
12896 \begin_layout Standard
12897 The following environments are available.
12898 You can use hollywood.bind to get the bind keys shown at the right.
12901 \begin_layout Itemize
12905 \begin_inset Newline newline
12910 Used where nothing else works.
12914 \begin_layout Itemize
12920 \begin_inset space \hfill{}
12928 \begin_inset Newline newline
12931 Usually followed by something like
12932 \begin_inset Quotes eld
12935 on Sally waking up.
12936 \begin_inset Quotes erd
12942 \begin_layout Itemize
12946 \begin_inset space \hfill{}
12950 \begin_inset Newline newline
12955 Introduces a new INTERIOR camera set-up.
12956 Always followed by DAY or NIGHT, or something similar to define the lighting
12958 Everthing on this line in CAPS.
12961 \begin_layout Itemize
12965 \begin_inset space \hfill{}
12969 \begin_inset Newline newline
12974 Introduces a new EXTERIOR camera set-up.
12975 Everthing on this line in CAPS.
12978 \begin_layout Itemize
12982 \begin_inset space \hfill{}
12986 \begin_inset Newline newline
12991 The character speaking.
12994 \begin_layout Itemize
12998 \begin_inset space \hfill{}
13002 \begin_inset Newline newline
13007 Instructions to the speaker.
13008 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
13010 Both will be printed.
13013 \begin_layout Itemize
13017 \begin_inset space \hfill{}
13021 \begin_inset Newline newline
13033 \begin_layout Itemize
13037 \begin_inset space \hfill{}
13041 \begin_inset Newline newline
13046 Camera movement instruction.
13048 \begin_inset space \thinspace{}
13052 \begin_inset space \space{}
13058 \begin_layout Itemize
13062 \begin_inset space \hfill{}
13068 \begin_layout Itemize
13072 \begin_inset space \hfill{}
13078 \begin_layout Itemize
13082 \begin_inset space \hfill{}
13088 \begin_layout Itemize
13092 \begin_inset space \hfill{}
13098 \begin_layout Subsection
13102 \begin_layout Itemize
13106 \begin_layout Itemize
13110 \begin_layout Itemize
13112 \begin_inset space \thinspace{}
13119 \begin_layout Itemize
13124 \begin_layout Itemize
13125 PAN — camera movement
13128 \begin_layout Itemize
13129 INSERT — cut to close-up of
13132 \begin_layout Section
13136 \begin_layout Standard
13139 Panayotis Papasotiriou
13142 \begin_layout Subsection
13146 \begin_layout Standard
13147 The ijmpc package is a set of macros that facilitates electronic manuscript
13150 International Journal of Modern Physics C
13153 Similarly, the ijmpd package is for creating manuscripts to be submitted
13156 International Journal of Modern Physics D
13159 Both journals are published by World Scientific.
13160 The corresponding document classes are named
13169 These files, together with instructions for the authors, can be downloaded
13171 \begin_inset Flex URL
13174 \begin_layout Plain Layout
13176 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
13182 \begin_inset Flex URL
13185 \begin_layout Plain Layout
13187 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
13193 Both packages are modified versions of the standard
13194 \begin_inset Quotes eld
13198 \begin_inset Quotes erd
13201 package, and they are almost (but not exactly) identical.
13202 Most of their features are supported by \SpecialChar LyX
13204 I have used \SpecialChar LyX
13205 successfully to write articles submitted to both journals
13206 without any problem.
13209 \begin_layout Subsection
13213 \begin_layout Standard
13214 As usual, the easiest way to write a paper is to start with a template.
13217 File\SpecialChar menuseparator
13233 This will give an (almost) empty document that includes the most common
13234 fields found in a manuscript.
13235 Simply overwrite the existing text (including the brackets,
13240 You should keep in mind the following remarks.
13243 \begin_layout Enumerate
13245 won't let you change the font size and the page style of the document,
13246 because such modifications are not allowed by both packages.
13249 \begin_layout Enumerate
13250 The language of the document should not be changed.
13251 Before previewing your paper, be sure that the babel package is not used.
13252 To do this, click on
13254 Tools\SpecialChar menuseparator
13265 checkbox in the language settings, and click on
13273 , if you wish to make this change permanent).
13276 \begin_layout Enumerate
13278 \begin_inset Quotes eld
13282 \begin_inset Quotes erd
13285 style must be used to define keywords.
13288 \begin_layout Enumerate
13289 The ijmpc package provides a style named
13290 \begin_inset Quotes eld
13293 Classification Codes
13294 \begin_inset Quotes erd
13297 , which can be used to define classification codes, such as PACS numbers.
13298 Note that this facility is not supported by the ijmpd package.
13301 \begin_layout Enumerate
13302 Several new environments are available:
13303 \begin_inset Quotes eld
13307 \begin_inset Quotes erd
13311 \begin_inset Quotes eld
13315 \begin_inset Quotes erd
13319 \begin_inset Quotes eld
13323 \begin_inset Quotes erd
13327 \begin_inset Quotes eld
13331 \begin_inset Quotes erd
13335 \begin_inset Quotes eld
13339 \begin_inset Quotes erd
13343 \begin_inset Quotes eld
13347 \begin_inset Quotes erd
13351 \begin_inset Quotes eld
13355 \begin_inset Quotes erd
13359 \begin_inset Quotes eld
13363 \begin_inset Quotes erd
13367 \begin_inset Quotes eld
13371 \begin_inset Quotes erd
13375 \begin_inset Quotes eld
13379 \begin_inset Quotes erd
13383 \begin_inset Quotes eld
13387 \begin_inset Quotes erd
13391 \begin_inset Quotes eld
13395 \begin_inset Quotes erd
13399 \begin_inset Quotes eld
13403 \begin_inset Quotes erd
13407 \begin_inset Quotes eld
13411 \begin_inset Quotes erd
13415 Their use is more or less obvious.
13417 supports all these environments; it will use the proper label, text style,
13418 and numbering scheme for each of them.
13421 \begin_layout Enumerate
13422 Both packages use basic citations; the natbib package should not be used.
13423 In \SpecialChar LyX
13424 , citation references are shown as usual; in the output, citations are
13425 shown as superscripts.
13426 If you want to use a citation as normal text, you should use the
13431 \begin_inset space \thinspace{}
13435 \begin_inset space \space{}
13439 \begin_inset Quotes eld
13443 \begin_inset space \space{}
13453 \begin_inset Quotes erd
13459 \begin_layout Enumerate
13461 \begin_inset Quotes eld
13465 \begin_inset Quotes erd
13468 section in both packages.
13469 To put acknowledgments, just use the
13470 \begin_inset Quotes eld
13474 \begin_inset Quotes erd
13480 \begin_layout Enumerate
13481 Appendices may be added to the paper,
13485 the Acknowledgments and
13491 provides a special environment, called
13492 \begin_inset Quotes eld
13496 \begin_inset Quotes erd
13499 which marks the beginning of the appendices.
13500 This environment should be left blank; it just sends a \SpecialChar LaTeX
13501 command, but nothing
13503 In \SpecialChar LyX
13505 \begin_inset Quotes eld
13509 \begin_inset Quotes erd
13512 is printed with blue letters, as a signal that all sections after that
13513 point are appendices.
13514 To write an appendix, use the
13515 \begin_inset Quotes eld
13519 \begin_inset Quotes erd
13524 will number each appendix with capital letters, as required by both journals.
13526 \begin_inset Quotes eld
13530 \begin_inset Quotes erd
13537 be present before the first appendix; if not, all appendices will be numbered
13538 as normal sections in the output.
13541 \begin_layout Enumerate
13542 The ijmpc and the ijmpd packages use the
13546 command to implement table captions.
13547 As a result, a table created by \SpecialChar LyX
13548 is printed correctly, but its caption
13550 However, you can use some \SpecialChar TeX
13551 code to overcome this problem, so that captions
13552 are printed as expected.
13553 To do so, create a float table as usual, remove the caption, and replace
13554 it with the \SpecialChar TeX
13565 (sic); you must also the \SpecialChar TeX
13570 immediately after the tabular material.
13571 Study the example table included in the template files to see how this
13572 trick is implemented.
13573 Alternatively, If you need table captions, you should implement the whole
13578 file, then include this file to the \SpecialChar LyX
13581 Insert\SpecialChar menuseparator
13582 File\SpecialChar menuseparator
13584 \begin_inset space ~
13590 Details on how to create a table float can be found in the files
13598 , included in the corresponding packages.
13601 \begin_layout Subsection
13602 Preparing a paper for submission
13605 \begin_layout Standard
13606 Before you submit your paper you must export the \SpecialChar LyX
13607 document as a \SpecialChar LaTeX
13610 File\SpecialChar menuseparator
13611 Export\SpecialChar menuseparator
13619 \begin_layout Plain Layout
13620 Actually you have the choice between \SpecialChar LaTeX
13621 (plain) and pdflatex.
13622 If you intend to use pdflatex to prepare the paper, you should use the
13623 pdflatex option so that included graphics are converted to PDF format,
13624 ready for use by pdflatex.
13629 , then make the following changes to the resulting
13636 \begin_layout Enumerate
13637 Remove the comment lines before the
13646 \begin_layout Enumerate
13647 Remove everything between (and including) the
13659 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13663 \begin_layout Standard
13668 file should be saved and processed through \SpecialChar LaTeX
13669 as many times as necessary.
13670 You may also want to check the resulting
13677 \begin_layout Subsection
13678 Use of \SpecialChar TeX
13682 \begin_layout Standard
13683 The use of \SpecialChar TeX
13684 code is reduced to two commands, which must be placed at the
13685 top of the document.
13686 If you started writing your paper by using the
13694 template, the \SpecialChar TeX
13695 code needed is already in its place; you usually don't need
13697 You may only modify the first \SpecialChar TeX
13698 code to specify the information printed
13699 to the top of odd and even pages (authors' names and short paper's title,
13701 This \SpecialChar TeX
13702 code must have the form
13706 markboth{Authors' Names}{Short Paper's Title}
13711 \begin_layout Section
13715 \begin_layout Standard
13721 \begin_layout Subsection
13725 \begin_layout Standard
13726 The iopart package provides a document class to create electronic manuscript
13727 submission to the journals published by the Institute of Physics.
13728 Instructions for the authors how to create a paper using the iopart class
13729 can be downloaded together with the iopart package from the site
13730 \begin_inset Flex URL
13733 \begin_layout Plain Layout
13735 ftp://ftp.iop.org/pub/journals/latex2e
13743 \begin_layout Subsection
13747 \begin_layout Standard
13748 The easiest way to write a paper is to start with the file
13752 that is available in \SpecialChar LyX
13753 's examples files folder.
13754 Open this file, save it under a new name, and start writing.
13755 The example file explains how to use the special text environments.
13756 Here are the most important advices:
13759 \begin_layout Itemize
13760 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13763 Use AMS math package
13765 in the document settings under
13772 \begin_layout Itemize
13775 The title environment defines the kind of your paper.
13776 So use one of the following environments for the title:
13780 \begin_layout Itemize
13789 \begin_layout Itemize
13798 \begin_layout Itemize
13804 for a Topical review
13807 \begin_layout Itemize
13816 \begin_layout Itemize
13825 \begin_layout Itemize
13831 for a Paper (same as Title)
13834 \begin_layout Itemize
13840 for a Preliminary communication
13843 \begin_layout Itemize
13849 for a Rapid communication
13852 \begin_layout Itemize
13858 for a Letter to the editor
13862 \begin_layout Itemize
13865 All title environments except of
13869 can have an optional short title.
13872 \begin_layout Itemize
13873 There is a general title environment
13877 which is not directly supported by the \SpecialChar LyX
13879 This can be used as \SpecialChar TeX
13880 code when your document doesn't fit into one of the
13884 \begin_layout Standard
13885 For more informations like hints for special table and formula formatting,
13886 look at the IOP author guidelines.
13889 \begin_layout Section
13893 \begin_layout Standard
13896 Panayotis Papasotiriou
13899 \begin_layout Subsection
13903 \begin_layout Standard
13904 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13905 that facilitates electronic manuscript submission to the journals they
13907 Most known of them (at least in my domain of interest) are
13909 Astrophysics and Space Science
13915 , but there are many others (see a complete list at
13916 \begin_inset Flex URL
13919 \begin_layout Plain Layout
13921 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13927 The Kluwer package may be downloaded from the site
13928 \begin_inset Flex URL
13931 \begin_layout Plain Layout
13933 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13939 A complete user guide is contained in that package (but it can also be
13940 downloaded separately).
13943 \begin_layout Standard
13945 supports many features of the package but not everything.
13946 However, the \SpecialChar TeX
13947 code needed is reduced to some
13948 \begin_inset Quotes eld
13952 \begin_inset Quotes erd
13955 commands of the package (see
13956 \begin_inset space ~
13960 \begin_inset CommandInset ref
13962 reference "subsec:kluwer_peculiarities"
13967 I have recently used \SpecialChar LyX
13968 to write an article submitted to the
13970 Astrophysics and Space Science
13972 without any problem.
13975 \begin_layout Subsection
13979 \begin_layout Standard
13980 The easiest way to write a paper is to start with the Kluwer template file.
13983 File\SpecialChar menuseparator
13995 This will give an (almost) empty document that includes the most common
13996 fields found in a manuscript and a short description of their use.
13997 As in most templates, simply overwrite the existing text (including the
14002 ) with the correct information.
14005 \begin_layout Subsection
14006 Preparing a paper for submission
14009 \begin_layout Standard
14010 As in the AAS\SpecialChar TeX
14011 package, before you submit your paper to a journal you must
14013 \begin_inset Quotes eld
14017 \begin_inset Quotes erd
14023 \begin_layout Enumerate
14024 Export your paper as a \SpecialChar LaTeX
14026 To do this, click on
14028 File\SpecialChar menuseparator
14029 Export\SpecialChar menuseparator
14037 \begin_layout Enumerate
14042 file with a text editor and make the following changes
14046 \begin_layout Enumerate
14047 remove the comment lines before the
14056 \begin_layout Enumerate
14057 remove everything between (and including) the
14069 commands, except for any commands you specifically put into the \SpecialChar LaTeX
14073 \begin_layout Standard
14082 \begin_layout Enumerate
14087 file through \SpecialChar LaTeX
14088 as many times as necessary (usually up to three).
14091 \begin_layout Enumerate
14097 \begin_inset space \thinspace{}
14101 \begin_inset space \space{}
14108 , and check if everything is OK (it should, if you didn't make any mistake).
14111 \begin_layout Subsection
14112 \begin_inset Quotes eld
14116 \begin_inset Quotes erd
14119 of the Kluwer package
14120 \begin_inset CommandInset label
14122 name "subsec:kluwer_peculiarities"
14129 \begin_layout Standard
14130 The Kluwer package has the following
14131 \begin_inset Quotes eld
14135 \begin_inset Quotes erd
14141 \begin_layout Enumerate
14142 It is possible to write multiple articles in the same \SpecialChar LaTeX
14147 \begin_layout Plain Layout
14148 I can't imagine any good reason to do this.
14154 Each article must be included in the environment
14155 \begin_inset Quotes eld
14159 \begin_inset Quotes erd
14163 Unfortunately, this environment cannot be omitted, even if you write just
14165 Therefore, each article starts with the command
14171 and, obviously, ends with the command
14178 Although this can be implemented in \SpecialChar LyX
14179 , I didn't included it, since it looks
14180 ugly and can confuse the novice user.
14181 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
14184 \begin_inset Quotes eld
14189 \begin_inset Quotes erd
14195 \begin_layout Enumerate
14196 Information given at the beginning of the article (i.
14197 \begin_inset space \thinspace{}
14201 \begin_inset space \space{}
14204 title, subtitle, author, institution, running title, running author, abstract
14205 and keywords) must be included in an environment called
14206 \begin_inset Quotes eld
14210 \begin_inset Quotes erd
14214 This is not implemented in \SpecialChar LyX
14215 , so you must enter title, subtitle etc.
14216 \begin_inset space ~
14219 between two \SpecialChar TeX
14235 \begin_layout Enumerate
14236 According to the user manual, the label of each bibliography item must be
14260 \begin_layout Standard
14265 template takes care of all these
14266 \begin_inset Quotes eld
14270 \begin_inset Quotes erd
14274 If you start a new paper using this template you don't need to do anything
14279 \begin_layout Enumerate
14280 don't delete the \SpecialChar TeX
14281 code included in the template, and
14284 \begin_layout Enumerate
14285 copy the example bibliography item included in the template and modify it
14286 as necessary to enter new bibliography items.
14289 \begin_layout Section
14293 \begin_layout Standard
14299 \begin_layout Subsection
14303 \begin_layout Standard
14304 The \SpecialChar LyX
14307 article (koma-script)
14311 report (koma-script)
14329 correspond to the \SpecialChar LaTeX
14347 \begin_inset space ~
14350 of the Koma-Script family.
14351 They are replacements for the standard document classes
14367 , resp., and fit better to European typography conventions in a number of
14371 \begin_layout Itemize
14372 Standard character size is 11pt in
14374 article (koma-script)
14378 report (koma-script)
14386 letter (koma-script)
14391 \begin_layout Itemize
14392 Headings, labels of the description environment, and a number of elements
14395 letter (koma-script)
14397 document class are set in a bold sans serif font.
14401 \begin_layout Plain Layout
14402 There is a big difference between the bold sans serif old cm fonts and new
14403 ec fonts, especially in the appearance of headings.
14404 In comparison, the ec bold sans serif fonts look a bit thin.
14405 Here the \SpecialChar LaTeX
14414 helps to produce the
14415 \begin_inset Quotes eld
14419 \begin_inset Quotes erd
14422 appearance when using the ec fonts.
14427 The numbering of chapter headings is made in the same way as the numbering
14428 of section headings, that is without the extra line
14429 \begin_inset Quotes eld
14432 Chapter\SpecialChar ldots
14434 \begin_inset Quotes erd
14438 In addition, the appearance of the headings can be modified by using a
14439 number of options (in \SpecialChar LyX
14440 to be entered in the field
14443 \begin_inset space ~
14450 Layout\SpecialChar menuseparator
14457 \begin_layout Itemize
14458 The main means in the Koma-Script document classes to design the type area
14467 (in \SpecialChar LyX
14468 to be entered in the extra class options field in the dialog
14470 Document\SpecialChar menuseparator
14474 They make a clearer modification of page margins possible as do the options
14477 Document\SpecialChar menuseparator
14484 \begin_layout Itemize
14485 The \SpecialChar LaTeX
14486 document classes of the Koma-Script family define a number of additional
14488 Those part of it which makes sense in \SpecialChar LyX
14489 is implemented in corresponding
14493 \begin_layout Standard
14494 Detailed descriptions of the \SpecialChar LaTeX
14495 document classes of the Koma-Script family
14496 can be found in the Koma-Script documentation
14507 \begin_layout Subsection
14508 article (koma-script), report (koma-script), and book (koma-script)
14511 \begin_layout Standard
14512 The document classes
14514 article (koma-script)
14518 report (koma-script)
14528 are implemented in the layout files
14541 They contain all the paragraph types of the corresponding standard document
14554 , resp., partly modified, with the exception of the \SpecialChar LyX
14559 -type, which is replaced by the new
14563 -type having the same functionality.
14568 -Type there is a number of new paragraph types added.
14575 letter (koma-script)
14580 \begin_layout Itemize
14589 : are equivalents to
14597 , resp., additionally inserting an entry in the table of contents.
14606 are not contained in
14608 article (koma-script)
14613 \begin_layout Itemize
14622 : behave exactly as
14630 , resp., additionally clearing running heads.
14635 is not contained in
14637 article (koma-script)
14643 \begin_layout Plain Layout
14656 report (koma-script)
14658 , but since this is identical to
14662 , is has not been implemented in \SpecialChar LyX
14671 \begin_layout Itemize
14676 : generates a heading directly above the following paragraph in the standard
14677 character size without affecting the structure of the document.
14680 \begin_layout Itemize
14689 are special captions which respect the different space settings needed
14690 for captions placed above or below an element (if you follow strict typographic
14691 rules, you might want to place table captions always above the table).
14692 You can also use the class option
14696 , which will switch
14709 You need at least Koma-Script version 2.8q to use this.
14712 \begin_layout Itemize
14717 : can be used to set a bonmot, e.
14718 \begin_inset space \thinspace{}
14722 \begin_inset space \space{}
14725 at the beginning of a chapter.
14726 If you use the optional argument (
14728 Insert\SpecialChar menuseparator
14730 \begin_inset space ~
14735 ), you can insert the dictum's author there.
14736 Dictum and author are separated by a line.
14737 You need at least Koma-Script version 2.8q to use this.
14742 is not contained in
14744 article (koma-script)
14749 \begin_layout Standard
14750 The following types, together with the standard types
14762 , form the title area of the document.
14763 They must be entered ahead of the first
14764 \begin_inset Quotes eld
14768 \begin_inset Quotes erd
14775 \begin_layout Plain Layout
14776 The corresponding \SpecialChar LaTeX
14777 commands must appear before the
14788 When such a type is used more than once, the latter usage overwrites the
14789 former one, that means, for every type only the latest usage is valid.
14790 The order of the different types however has, like
14802 , no effect on the appearance of the produced document.
14805 \begin_layout Itemize
14810 : produces a centered paragraph above the ordinary title (
14822 ) for the subject of the document.
14825 \begin_layout Itemize
14830 : produces a centered paragraph below the ordinary title (
14842 ) for the publishers' name.
14845 \begin_layout Itemize
14852 report (koma-script)
14858 produces a centered paragraph on its own page behind the title page, or
14861 article (koma-script)
14863 produces a centered paragraph below the ordinary title (
14879 ) for a dedication.
14882 \begin_layout Itemize
14887 : produces a left aligned paragraph above the ordinary title (
14903 ) for a document`s head.
14906 \begin_layout Itemize
14911 : produces in a double-sided print in
14913 report (koma-script)
14919 a left-aligned paragraph at the top of the title page`s back or has no
14920 effect in a single-sided print or in
14922 article (koma-script)
14927 \begin_layout Itemize
14932 : produces in a double-sided print in
14934 report (koma-script)
14940 a left-aligned paragraph at the bottom of the title page`s back or has
14941 no effect in a single-sided print or in
14943 article (koma-script)
14948 \begin_layout Itemize
14953 : produces a special
14954 \begin_inset Quotes eld
14958 \begin_inset Quotes erd
14961 page ahead of the actual document containing a paragraph without special
14965 \begin_layout Standard
14966 The layout files for the document classes
14968 article (koma-script)
14972 report (koma-script)
14978 do include the file
14983 This is thought of as a place to define your own types.
14988 in your personal layout directory and edit the file!
14991 \begin_layout Subsection
14992 letter (koma-script)
14995 \begin_layout Standard
14999 letter (koma-script)
15001 is implemented in the layout file
15006 It contains all the paragraph types of the corresponding standard document
15011 , partly modified, with the exception of the \SpecialChar LyX
15025 type, which is replaced by the new
15030 In addition, it contains, in contrast to the standard document class, the
15049 Furthermore, there are a number of new letter specific types.
15052 \begin_layout Standard
15053 The appearance of the letter produced by this document class can be controlled
15054 by a number of \SpecialChar LaTeX
15055 commands, which you can put in the \SpecialChar LaTeX
15060 \begin_layout Plain Layout
15061 For example, the standard appearance of the letter`s heading, consisting
15062 of name and address, is quite self-willed.
15064 \begin_inset Quotes eld
15068 \begin_inset Quotes erd
15071 heading is produced by the following \SpecialChar LaTeX
15072 commands in the preamble:
15075 \begin_layout LyX-Code
15085 \begin_layout LyX-Code
15101 \begin_layout LyX-Code
15111 \begin_layout LyX-Code
15131 A detailed German description of such \SpecialChar LaTeX
15132 commands can be found in the Koma-Script
15138 With it, the letter's author can produce his personal letter layout.
15141 \begin_layout Standard
15150 define the beginning of the letter and must be used in every letter.
15151 To emphasize them in the \SpecialChar LyX
15152 document class, they are marked with the letter
15162 \begin_inset space ~
15165 in the left margin.
15166 It is possible to write any number of letters in one file.
15171 type produces a new letter using the same addressee and a
15175 type produces a new addressee.
15192 are ordinary paragraph types and can also be used several times in one
15193 and the same letter.
15196 \begin_layout Itemize
15201 : produces a paragraph for the addressee and implicitly defines the beginning
15205 \begin_layout Itemize
15210 : produces a paragraph for the form of address and implicitly produces a
15214 \begin_layout Itemize
15219 : produces a paragraph for a close.
15222 \begin_layout Itemize
15227 : produces a paragraph for a postscript.
15230 \begin_layout Itemize
15235 : produces a paragraph for a distribution list.
15238 \begin_layout Itemize
15243 : produces a paragraph for enclosures.
15246 \begin_layout Standard
15287 are input types provided with a label to enter information, which will
15288 be processed by the document class.
15292 \begin_layout Plain Layout
15293 It could be seen as a matter of inconsequence, that the types
15301 described above are not such input types as well.
15302 Because of the special meaning of those types, however, I have implemented
15303 them as ordinary paragraph types with a one letter mark in the left margin.
15304 Moreover, it would affect my feeling of symmetry, if the
15312 type had such a serious different appearance.
15317 The types must be used ahead of the corresponding
15324 \begin_layout Standard
15325 An implementation of these types in a WYSIWYG fashion does not seem to make
15326 sense, because the real appearance of the produced letter does not only
15327 depend on the usage of the particular type, but also on other factors.
15328 For example, a signature entered in the
15332 type will in the standard behavior appear in the produced letter only,
15333 when in the same letter also a
15338 The entered value of the
15342 type will in the standard behavior not appear in the produced letter at
15344 The possibility to design the letter`s heading freely is already indicated
15345 in a footnote above.
15348 \begin_layout Standard
15349 The input types can also be used as empty paragraphs.
15350 This makes sense e.
15351 \begin_inset space \thinspace{}
15355 \begin_inset space \space{}
15367 type is not used at all, in the standard behavior the value of the
15371 type is used as signature, whereas if an empty
15375 type is used, no signature value is defined.
15378 \begin_layout Standard
15379 By using the input types it is possible to write a letter template, containing
15380 filled input types with your personal dates (name, address, etc.) and empty
15381 input types for other dates you want to enter.
15384 \begin_layout Itemize
15389 : sender's name, in the standard behavior appears as a centered paragraph
15390 in small caps in the letter`s heading.
15393 \begin_layout Itemize
15398 : sender's signature, in the standard behavior appears below the
15407 type is used, the value of the
15411 type appears instead.
15414 \begin_layout Itemize
15419 : sender's address, in the standard behavior appears in a centered paragraph
15420 in the letter`s heading below the sender's name.
15423 \begin_layout Itemize
15428 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15439 \begin_layout Itemize
15444 : place of the letter`s making.
15447 \begin_layout Itemize
15452 : date of the letter`s making.
15461 , in the standard behavior, produce the place and the date in a right-aligned
15462 line below the addressee's field.
15467 type is used, neither place nor date appear, independent of the value of
15477 type is used, the date of the letter `s production is used.
15480 \begin_layout Itemize
15485 : sender`s back address, in the standard behavior appears above the addressee's
15486 field in a small sans serif font.
15489 \begin_layout Itemize
15494 : special mail information, in the standard behavior appears underlined
15495 above the addressee's field below the back address.
15498 \begin_layout Itemize
15503 : additional information, in the standard behavior appears on right side
15504 below the addressee`s field.
15507 \begin_layout Itemize
15512 : the letter's title, in the standard behavior appears in a big, bold, sans
15513 serif font above the subject.
15516 \begin_layout Itemize
15521 : the letter's subject, in the standard behavior appears in a bold font
15529 \begin_layout Standard
15550 produce a business letter like line above the
15554 line containing the fields
15555 \begin_inset Quotes eld
15559 \begin_inset Quotes erd
15563 \begin_inset Quotes eld
15567 \begin_inset Quotes erd
15571 \begin_inset Quotes eld
15575 \begin_inset Quotes erd
15579 \begin_inset Quotes eld
15583 \begin_inset Quotes erd
15587 \begin_inset Quotes eld
15591 \begin_inset Quotes erd
15595 \begin_inset Quotes eld
15599 \begin_inset Quotes erd
15603 For the date field, the value of the
15609 \begin_inset Quotes eld
15612 business letter types
15613 \begin_inset Quotes erd
15616 is used, the value of the
15620 type however does not appear, but only the \SpecialChar LaTeX
15628 The ordinary output of place and date in a right-aligned line below the
15629 addressee`s field is suppressed.
15630 The types are implemented as input types provided with a label and must
15631 be used ahead of the corresponding
15638 \begin_layout Itemize
15646 \begin_layout Itemize
15654 \begin_layout Itemize
15662 \begin_layout Itemize
15670 \begin_layout Itemize
15678 \begin_layout Subsection
15679 The new letter class: letter (koma-script v.2)
15682 \begin_layout Standard
15688 \begin_layout Standard
15689 \begin_inset VSpace medskip
15695 \begin_layout Standard
15697 Koma-Script version 2.8 has introduced a new letter class
15701 which supersedes the now unsupported
15706 It has — on the \SpecialChar LaTeX
15707 side — a completely new interface and is not compatible
15708 with the old class.
15709 Therefore, \SpecialChar LyX
15710 supports both, though it is recommended you use the new class.
15713 \begin_layout Standard
15714 This class covers the same functionality as
15716 letter (koma-script),
15719 The basic items are
15723 (receiver's address, same as
15727 in the old layout),
15740 will start a new letter (i.
15741 \begin_inset space \thinspace{}
15745 \begin_inset space \space{}
15748 you can write several letters per document).
15749 New elements are sender's
15765 and the possibility to use a
15771 Insert\SpecialChar menuseparator
15777 \begin_layout Standard
15778 The biggest improvement is, though, that the letter's layout is configurable
15779 to meet almost any needs.
15780 This can be done via the preamble or with a special style file (Letter
15781 Class Option, extension
15785 ), that will be read in as a class option.
15789 \begin_layout Plain Layout
15790 The KOMA package comes with some default
15795 There is, for instance, a
15799 file that follows german typesetting rules, or a
15803 that provides the default layout of the old
15808 The latter can be loaded with the class option
15814 Layout\SpecialChar menuseparator
15815 Document\SpecialChar menuseparator
15827 template that is included in \SpecialChar LyX
15829 A detailed description is to be found in the Koma-Script documentation
15837 \begin_layout Subsection
15841 \begin_layout Standard
15842 Visualizing the Koma-Script document classes in \SpecialChar LyX
15843 , the \SpecialChar LyX
15844 internals cause some
15848 \begin_layout Itemize
15849 The chapter number of a
15853 type appears on a line of its own above the chapter heading instead of
15854 appearing in the same line ahead of it.
15855 The cause for that is the \SpecialChar LyX
15856 internal behavior for the labeltype
15860 in the layout file.
15863 \begin_layout Itemize
15864 The headings of the types
15872 are only put in the
15873 \begin_inset Quotes eld
15877 \begin_inset Quotes erd
15881 table of contents, but not in the \SpecialChar LyX
15882 table of contents (
15884 Document\SpecialChar menuseparator
15886 \begin_inset space ~
15890 \begin_inset space ~
15898 \begin_layout Itemize
15899 The paragraphs in a
15903 document class appear in a skip separation mode, not indented.
15904 This is the standard behavior, no special \SpecialChar LaTeX
15905 commands are needed for that.
15908 Document\SpecialChar menuseparator
15911 dialog the corresponding radio button indicates
15920 value always has the effect that extra \SpecialChar LaTeX
15921 commands are inserted in the document
15922 to produce the gap, which is not what is wanted in this case.
15925 \begin_layout Section
15929 \begin_layout Standard
15935 \begin_layout Subsection
15939 \begin_layout Standard
15940 Memoir is a very powerful and constantly evolving class.
15941 It has been designed with regard to fictional and non-fictional literature.
15942 Its aim is to let the user have maximum control over the typesetting of
15944 Memoir is based on the standard book class, but it can also emulate the
15945 article class (see below).
15948 \begin_layout Standard
15949 Peter Wilson, the developer of Memoir, is known as the author of lots of
15950 useful packages in the \SpecialChar LaTeX
15952 Most of them have been merged with Memoir.
15953 Therefore, it is much easier to layout the table of contents, appendices,
15954 chapter designs and such.
15956 , though, does not support all of these goodies natively.
15957 Some of them might be added to forthcoming releases
15961 \begin_layout Plain Layout
15962 You are invited to send suggestions to
15963 \begin_inset Flex URL
15966 \begin_layout Plain Layout
15968 lyx-devel@lists.lyx.org
15978 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15980 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15982 commands (\SpecialChar TeX
15987 \begin_layout Plain Layout
15992 \begin_layout Plain Layout
16002 \begin_inset space ~
16006 \begin_inset CommandInset ref
16008 reference "sec:Inserting-TeX-Code"
16018 In this section, we can only list those features that are natively supported
16019 by \SpecialChar LyX
16021 For detailed descriptions (and for the rest of features) we recommend you
16022 have a look at the detailed manual of the Memoir class
16026 \begin_layout Plain Layout
16031 \begin_layout Plain Layout
16041 \begin_inset Flex URL
16044 \begin_layout Plain Layout
16046 CTAN:/macros/latex/memoir/memman.pdf
16056 , which is not only a user guide for the class, but also both a comprehensive
16057 description on good typesetting and a superb example for good typesetting
16061 \begin_layout Subsection
16062 Basic features and restrictions
16065 \begin_layout Standard
16066 Memoir supports basically all features of the standard book classes.
16067 There are, however, some differences, as follows:
16070 \begin_layout Description
16072 \begin_inset space ~
16075 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
16078 \begin_layout Description
16080 \begin_inset space ~
16083 style: The fancy page style is not supported, due to a command clash between
16084 Memoir and the fancyhdr package (they both define a command with the same
16085 name, which confuses \SpecialChar LaTeX
16087 Instead, Memoir comes with a number of its own page styles (see
16089 Layout\SpecialChar menuseparator
16090 Document\SpecialChar menuseparator
16092 \begin_inset space ~
16098 If you want to use these for the chapter pages, you have to use the command
16105 in the main text or in preamble (e.
16106 \begin_inset space \thinspace{}
16110 \begin_inset space \space{}
16117 chapterstyle{companion}
16122 \begin_layout Description
16123 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
16124 optional argument in the standard classes.
16125 With this, you can specify an alternative version of the title for the
16126 table of contents and the headers (for instance, if the title is too long).
16127 In \SpecialChar LyX
16128 , you can do this via
16130 Insert\SpecialChar menuseparator
16132 \begin_inset space ~
16137 at the beginning of a chapter/section.
16138 Memoir features a second optional argument and thus separates the table
16139 of contents from the header.
16140 You can define three variants of a title with this: one for the main text,
16141 one for the table of contents, and one for the headers.
16142 Simply insert two optional arguments if you need this feature, the first
16143 one containing the short title for the Table of Contents, the second one
16144 containing an alternative short title for the headers.
16147 \begin_layout Description
16148 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
16149 of contents, the list of figures and the list of table start a new page
16151 Memoir does not follow this route.
16152 You have to insert a page break yourself, if you want to have one.
16155 \begin_layout Description
16156 Titlepage: For some unknown reason, Memoir uses pagination on the title
16157 page (in the standard classes, title pages are
16158 \begin_inset Quotes eld
16162 \begin_inset Quotes erd
16166 If you want an empty title page, type
16170 aliaspagestyle{title}{empty}
16175 \begin_layout Description
16176 Article: With the class option
16182 Layout\SpecialChar menuseparator
16183 Document\SpecialChar menuseparator
16185 \begin_inset space ~
16190 ), you can emulate article style.
16191 That is, counters (footnotes, figures, tables etc.) will not be reset on
16192 new chapters, chapters don't start a new page (but are—in contrary to
16193 \begin_inset Quotes eld
16197 \begin_inset Quotes erd
16200 article classes—still allowed), parts, though, use their own page, as in
16204 \begin_layout Description
16205 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
16206 font commands, which have been used in the old \SpecialChar LaTeX
16208 \begin_inset space \thinspace{}
16212 \begin_inset space \space{}
16228 It produces an error and stops \SpecialChar LaTeX
16229 whenever such a command appears.
16234 reallows the commands and spits out warnings instead (which does at least
16235 not stop \SpecialChar LaTeX
16237 Since a lot of packages and particularly Bib\SpecialChar TeX
16238 style files are still using
16239 those commands, we have decided to use this option by default.
16242 \begin_layout Subsection
16246 \begin_layout Standard
16247 We will only describe the features supported by \SpecialChar LyX
16248 (which is not much currently).
16249 Please consult the Memoir manual
16253 \begin_layout Plain Layout
16258 \begin_layout Plain Layout
16268 \begin_inset Flex URL
16271 \begin_layout Plain Layout
16273 CTAN:/macros/latex/memoir/memman.pdf
16286 \begin_layout Description
16287 Abstract: You may wonder why an abstract is an extra feature.
16288 Well, it is in book class.
16289 Usually books don't have abstracts.
16290 Memoir, however, has.
16291 You can use it wherever and how often you like.
16294 \begin_layout Description
16295 Chapterprecis: You may know this older typesetting style: The contents of
16296 a chapter are summarized below the title and also in the table of contents
16298 \begin_inset space \thinspace{}
16302 \begin_inset space \space{}
16307 Our hero arrives in Troia; he loses some friends; he finds others
16310 Chapterprecis does exactly this.
16311 It is therefore only sensible below a chapter.
16314 \begin_layout Description
16315 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16316 The epigraph environment provides an elegant way of typesetting such a
16318 The motto itself (text) and its author (source) are divided by a short
16320 Unfortunately, we have to fool \SpecialChar LyX
16321 a bit here again, since the environment
16322 needs two arguments (text and source).
16323 In this case, we have to use curly brackets (in \SpecialChar TeX
16324 mode) between the two
16335 <author of the slogan>.
16338 \begin_layout Description
16339 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16340 complex figurative poems).
16342 can only support a few of them.
16343 One is poemtitle, which is a centered title for poems, which will also
16344 be added to the table of contents (verse is the standard environment for
16346 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16348 because they have to be nested inside regular verse environments, which
16349 is not possible with \SpecialChar LyX
16353 \begin_layout Description
16354 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16357 \begin_layout Section
16358 Article (mwart), book (mwbk) and report (mwrep)
16359 \begin_inset Argument status
16362 \begin_layout Plain Layout
16375 \begin_layout Standard
16381 \begin_layout Standard
16382 The \SpecialChar LyX
16399 correspond to the \SpecialChar LaTeX
16413 They are replacements for the standard document classes
16425 , resp., and fit better to Polish typography conventions in a number of points.
16429 \begin_layout Standard
16433 \begin_layout Itemize
16434 Unnumbered titles (with star, e.
16435 \begin_inset space \thinspace{}
16439 \begin_inset space \space{}
16446 ) are added into table of contents,
16449 \begin_layout Itemize
16450 Additional page styles:
16454 \begin_layout Description
16455 uheadings header with separated lines,
16458 \begin_layout Description
16459 myheadings custom header, contents headers via commands:
16474 \begin_layout Description
16475 myuheadings custom header with separated lines,
16478 \begin_layout Description
16479 outer page number is placed on outer side of page
16483 \begin_layout Itemize
16488 \begin_layout Description
16489 rmheadings serif titles — default,
16492 \begin_layout Description
16493 sfheadings sansserif titles,
16496 \begin_layout Description
16497 authortitle on title page first placed is author next title — default,
16500 \begin_layout Description
16501 titleauthor on title page first placed is title next author,
16504 \begin_layout Description
16505 withmarginpar reserve place on page for margins.
16509 \begin_layout Section
16513 \begin_layout Standard
16518 provides an alternative to the standard
16523 It provides similar functionality, but you might prefer this layout with
16524 sans serif sections, headings, and more.
16527 \begin_layout Section
16528 Rev\SpecialChar TeX
16532 \begin_layout Standard
16538 \begin_layout Standard
16539 \begin_inset VSpace bigskip
16545 \begin_layout Standard
16550 \begin_inset space ~
16555 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16557 \begin_inset Formula $\beta$
16560 release of May, 1999) class.
16563 \begin_layout Standard
16569 textclass, which works with Rev\SpecialChar TeX
16571 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16573 That means that it doesn't interact very well with \SpecialChar LyX
16574 , which requires \SpecialChar LaTeX2e
16576 it has been kludged to work.
16577 Since Rev\SpecialChar TeX
16578 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16583 Rev\SpecialChar TeX
16585 \begin_inset space ~
16590 textclass should also be pretty easy to use.
16593 \begin_layout Standard
16594 These documents are supposed to be used in
16598 to the Rev\SpecialChar TeX
16599 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16601 and assume you'll know what to put in the preamble if necessary.
16604 \begin_layout Subsection
16608 \begin_layout Standard
16609 All you need to do is install Rev\SpecialChar TeX
16610 4, as described in the package's README
16612 The package can be found at The Rev\SpecialChar TeX
16614 \begin_inset Flex URL
16617 \begin_layout Plain Layout
16619 http://publish.aps.org/revtex4/
16625 Install it somewhere that \SpecialChar LaTeX
16627 Test it by trying to \SpecialChar LaTeX
16628 a short Rev\SpecialChar TeX
16629 4 document in some random directory (i.
16630 \begin_inset space \thinspace{}
16634 \begin_inset space \space{}
16637 not the directory where you installed the class file.) Then, if you reconfigure
16639 , it will find the class file and let you use the Rev\SpecialChar TeX
16643 \begin_layout Standard
16644 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16653 \begin_inset space ~
16658 template, found in the templates directory.
16661 \begin_layout Subsection
16665 \begin_layout Standard
16666 Optional arguments to
16673 \begin_inset Quotes eld
16677 \begin_inset Quotes erd
16681 \begin_inset Quotes eld
16685 \begin_inset Quotes erd
16691 \begin_inset space ~
16699 \begin_inset space ~
16705 Remember that in Rev\SpecialChar TeX
16706 , at least one optional argument is required!
16709 \begin_layout Standard
16710 Other preamble matter, like
16717 \begin_inset space ~
16724 \begin_inset space ~
16729 dialog, also as usual.
16732 \begin_layout Subsection
16736 \begin_layout Standard
16737 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16739 For example, the Email layout corresponds to
16746 Note that (at least as of Rev\SpecialChar TeX
16755 layouts are exactly equivalent, so you shouldn't need to use both.
16759 \begin_layout Plain Layout
16760 In case you're curious, both were included so that
16764 would be able to translate both
16784 \begin_layout Subsection
16788 \begin_layout Standard
16789 There are a couple of important unique aspects of Rev\SpecialChar TeX
16790 4 which might cause
16791 bugs that will be even more confusing in \SpecialChar LyX
16795 \begin_layout Standard
16796 In Rev\SpecialChar TeX
16814 The \SpecialChar LyX
16815 equivalent is that there is a separate Thanks layout.
16820 write footnotes in the
16824 layout, or weird things may happen.
16825 See the Rev\SpecialChar TeX
16826 4 documentation for more details.
16829 \begin_layout Standard
16833 \begin_inset space ~
16841 \begin_inset space ~
16850 layouts must be placed
16858 layout and the corresponding
16875 , the \SpecialChar LaTeX
16879 \begin_layout Subsection
16883 \begin_layout Standard
16884 The main problem with this layout is that you can't use the optional arguments
16885 to layouts like Email and Title.
16886 (The problem is not unique to this layout; you can't use optional arguments
16887 to the Section layouts either.) This means that after you export that file
16888 to \SpecialChar LaTeX
16889 (which you'll need to do eventually to send it in to APS), you'll need
16890 to edit the \SpecialChar LaTeX
16891 file with a text editor to add the optional arguments to set,
16893 \begin_inset space \thinspace{}
16897 \begin_inset space \space{}
16900 the running title for the page headers.
16901 Lacking these layouts makes the
16907 (and the equivalent
16913 ) useless, so the corresponding layouts don't exist, and will have to be
16918 \begin_layout Plain Layout
16923 actually, \SpecialChar LyX
16924 1.3.0 supports some forms of optional arguments, but this layout
16925 has not been updated yet to take advantage of it.
16933 \begin_layout Section
16934 Springer Journals (
16941 \begin_layout Standard
16947 \begin_layout Subsection
16951 \begin_layout Standard
16952 These are the layout files for some of the journal formats used by Springer
16953 Verlag and listed on
16954 \begin_inset Flex URL
16957 \begin_layout Plain Layout
16959 http://www.springer.de/author/tex/help-journals.html
16964 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16966 It is a modular system: the things common to all journals are implemented
16971 , which journal-specific layout files (such as, e.
16972 \begin_inset space \thinspace{}
16976 \begin_inset space \space{}
16983 for Journal of Geodesy) can include.
16986 \begin_layout Standard
16987 This means that implementing support for any other Springer journal on this
16988 list is as simple as writing your own
16996 file following the outline given in
17004 \begin_layout Standard
17005 It is reasonably well tested only for the Journal of Geodesy.
17014 come with the standard \SpecialChar LyX
17016 Install the relevant class file (downloaded from Springer) in a proper
17017 directory, reconfigure \SpecialChar LaTeX
17018 (in the te\SpecialChar TeX
17023 , as root if necessary — doesn't \SpecialChar LyX
17024 take care of this?), reconfigure \SpecialChar LyX
17029 \begin_layout Subsection
17033 \begin_layout Standard
17034 A large number of theorem-like styles —
17046 \begin_layout Standard
17049 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
17050 _Title, Author_Running, Institute,
17051 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
17054 See the Springer class file documentation for details.
17057 \begin_layout Subsection
17061 \begin_layout Itemize
17073 \begin_layout Itemize
17076 Probability Theory and Related Fields
17082 — Jean-Marc Lasgouttes
17085 \begin_layout Standard
17086 Add your own, it isn't so hard!
17089 \begin_layout Subsection
17093 \begin_layout Standard
17094 These files are partly based on the older
17098 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
17100 file from Springer.
17105 layout, are now defunct.
17106 Jean-Marc Lasgouttes helped out big in making me find my way around the
17108 layout file mechanism.
17111 \begin_layout Subsection
17115 \begin_layout Standard
17117 But probably less than in the old hacked-\SpecialChar LaTeX
17125 \begin_layout Standard
17127 \begin_inset space \thinspace{}
17130 g.: does not display the number for theorem-like layouts, just #.
17133 \begin_layout Section
17136 Sli\SpecialChar TeX
17140 \begin_inset CommandInset label
17149 \begin_layout Standard
17157 \begin_layout Subsection
17161 \begin_layout Standard
17162 This section describes how to use \SpecialChar LyX
17163 to make slides for overhead projectors.
17164 There are two document classes that can do this: the default slides class
17167 Foil\SpecialChar TeX
17171 This section documents the former.
17174 \begin_layout Standard
17175 I'm going to say this again, nice and clear, so that there's no misunderstanding
17179 \begin_layout Standard
17180 \begin_inset VSpace bigskip
17186 \begin_layout Standard
17190 This section documents the class
17191 \begin_inset Quotes eld
17199 \begin_inset Quotes erd
17207 \begin_layout Standard
17208 \begin_inset VSpace bigskip
17214 \begin_layout Standard
17215 If you're looking for the documentation for
17216 \begin_inset Quotes eld
17221 slides (Foil\SpecialChar TeX
17225 \begin_inset Quotes erd
17228 , check out section
17229 \begin_inset space ~
17233 \begin_inset CommandInset ref
17235 reference "sec:foiltex"
17245 \begin_inset Quotes eld
17250 slides (Foil\SpecialChar TeX
17254 \begin_inset Quotes erd
17257 ] is actually somewhat better than the default
17265 \begin_layout Plain Layout
17267 or so I've been told repeatedly by its advocates.
17268 Having never used it, I have no idea if this claim is true or not.
17273 which this section documents.
17276 \begin_layout Standard
17277 This class is the \SpecialChar LaTeX2e
17278 improvement of the old
17280 Sli\SpecialChar TeX
17284 Every \SpecialChar LaTeX2e
17285 distribution includes this class [which I'll just refer to as
17286 \begin_inset Quotes eld
17294 \begin_inset Quotes erd
17297 from now on], so you're bound to have it.
17298 As I noted earlier, there are other classes, such as
17302 , which also produce slides for overhead projectors and do a better job
17304 However, there are some things which
17308 can do which the others can't, such as generate overlays.
17309 Read on to learn more!
17312 \begin_layout Subsection
17314 \begin_inset CommandInset label
17316 name "sec:slidesetup"
17323 \begin_layout Standard
17324 Obviously, to use this document class, you need to select
17325 \begin_inset Quotes eld
17333 \begin_inset Quotes erd
17336 from the class list in the
17338 Document\SpecialChar menuseparator
17342 There are some other special things you should know about this class:
17345 \begin_layout Itemize
17346 Don't bother changing the options
17351 They're not supported by the
17358 \begin_layout Itemize
17362 \begin_inset space ~
17367 behaves a bit differently for this class.
17368 The possible choices and what they do are as follows:
17372 \begin_layout Description
17377 The final output contains page numbers in the lower right corner.
17380 \begin_layout Description
17389 , but also prints out any time markers you've put in.
17390 This is the default.
17393 \begin_layout Description
17398 The final output contains no page numbers, time markers, or alignment markers.
17402 \begin_layout Itemize
17407 class has an extra option:
17413 \begin_inset Quotes eld
17421 \begin_inset Quotes erd
17424 in the extra class options.
17428 \begin_layout Standard
17429 Using this options allows you to add time markers to
17435 \begin_inset space ~
17439 \begin_inset CommandInset ref
17441 reference "sec:slideNote"
17449 \begin_layout Standard
17450 You can also use the template file
17451 \begin_inset Quotes eld
17459 \begin_inset Quotes erd
17462 to automatically set up a document to use the
17468 File\SpecialChar menuseparator
17470 \begin_inset space ~
17474 \begin_inset space ~
17479 to open your new document].
17480 The template file also contains some examples of the special paragraph
17481 environments used by this class.
17482 I'll describe those next.
17485 \begin_layout Subsection
17486 Paragraph Environments
17489 \begin_layout Subsubsection
17490 Supported Environments
17493 \begin_layout Standard
17494 The first thing you'll notice when you start up a new
17498 document is the font size and type: it's the equivalent of the size
17499 \begin_inset Quotes eld
17507 \begin_inset Quotes erd
17513 \begin_inset space ~
17519 This is also what's used in the output.
17521 \begin_inset Quotes eld
17525 \begin_inset Quotes erd
17528 to remind you that this is a slide.
17529 Your final slides will use a larger font; ergo, you'll have less space.
17530 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17533 \begin_layout Standard
17534 The next thing that becomes obvious is the changes to the paragraph environment
17535 pull-down box [at the far-left end of the toolbar].
17536 Most of the paragraph environments you're used to seeing are missing.
17537 There are also five new ones.
17542 class itself only supports certain paragraph environments:
17545 \begin_layout Itemize
17551 \begin_layout Itemize
17557 \begin_layout Itemize
17563 \begin_layout Itemize
17569 \begin_layout Itemize
17575 \begin_layout Itemize
17581 \begin_layout Itemize
17587 \begin_layout Itemize
17593 \begin_layout Itemize
17599 \begin_layout Itemize
17606 \begin_layout Itemize
17612 \begin_layout Standard
17613 All of the other standard environments, including the section-heading environmen
17614 ts, aren't used in the
17621 \begin_layout Standard
17622 On the other hand, you'll notice the following new environments:
17625 \begin_layout Itemize
17631 \begin_layout Itemize
17637 \begin_layout Itemize
17643 \begin_layout Itemize
17649 \begin_layout Itemize
17655 \begin_layout Standard
17656 These five are kind of quirky, due to a
17657 \begin_inset Quotes eld
17661 \begin_inset Quotes erd
17664 in \SpecialChar LyX
17666 You see, \SpecialChar LyX
17667 doesn't permit you to nest any other paragraph environment into
17668 an empty environment.
17669 Now, that's fine and dandy, but it means that you wouldn't be able to start
17670 a slide with anything except plain text.
17671 To deal with this, I've performed a little
17672 \begin_inset Quotes eld
17677 \begin_inset Quotes erd
17683 \begin_layout Subsubsection
17684 Quirks of the New Environments
17685 \begin_inset CommandInset label
17687 name "sec:slideQuirk"
17694 \begin_layout Standard
17695 All five of the new paragraph environments are somewhat quirky due to inherent
17696 limitiations in the current version of \SpecialChar LyX
17698 As I just mentioned, \SpecialChar LyX
17699 forbids environments that begin with another environment.
17700 To get around this, the
17704 environment isn't a paragraph environment as described in the
17712 \begin_layout Standard
17713 You should consider
17726 \begin_inset Quotes eld
17729 pseudo-environments.
17730 \begin_inset Quotes erd
17733 They look like a section heading or a
17734 \begin_inset Quotes eld
17742 \begin_inset Quotes erd
17745 but really begin a [and, if necessary, end the previous] paragraph environment.
17755 \begin_inset Quotes eld
17759 \begin_inset Quotes erd
17762 These two perform some action.
17765 \begin_layout Standard
17766 A common feature of all five environments,
17786 , is a rather long-ish label.
17787 The text following this label — ordinarily the contents of the paragraph
17788 environment — is utterly irrelevant for
17810 completely ignores it.
17811 In fact, you can leave these five environments completely empty.
17815 \begin_layout Standard
17820 to put any text after the rather long-ish label, you might want to.
17821 This could be a short description of the contents of the
17826 In that case, enter your descriptive comment and hit
17830 as you normally would.
17833 \begin_layout Standard
17834 If, on the other hand, you don't want to enter any descriptive text, you'll
17835 hit another \SpecialChar LyX
17838 , like nature, abhors a vacuum, and will not let you start a new paragraph
17839 environment until you put something in the old one.
17843 \begin_layout Itemize
17844 Start entering the text that will
17872 \begin_layout Itemize
17873 Now move to the beginning of that paragraph.
17877 \begin_layout Itemize
17886 \begin_layout Itemize
17887 Finally, change this new, empty paragraph to a
17911 \begin_layout Standard
17912 Some future version of \SpecialChar LyX
17913 will, hopefully, resolve this quirkiness\SpecialChar ldots
17917 \begin_layout Subsection
17918 Making a Presentation with
17931 \begin_layout Subsubsection
17939 \begin_layout Standard
17940 If you're expecting this section to teach you how to actually make a presentatio
17941 n, you'll be sorely disappointed.
17942 Naturally, I'll describe all of the ways the
17946 class can assist you in preparing the materials for a presentation.
17947 Filling in the contents, however, is up to you.
17952 the \SpecialChar LyX
17956 \begin_layout Standard
17961 environment [in the manner described in section
17962 \begin_inset space ~
17966 \begin_inset CommandInset ref
17968 reference "sec:slideQuirk"
17972 ] tells \SpecialChar LyX
17973 to begin a new slide [duh].
17974 The label for this environment/
17975 \begin_inset Quotes erd
17979 \begin_inset Quotes erd
17983 \begin_inset Quotes eld
17987 \begin_inset Quotes erd
17990 in cool blue, followed by the label,
17991 \begin_inset Quotes eld
17995 \begin_inset Quotes erd
17999 Any text or paragraph environments that follow this one go on the new slide.
18003 \begin_layout Standard
18004 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
18006 (this can be specified in the
18011 In fact, you'll want to, once you finish entering the contents of one slide.
18012 If you've entered more text than can physically fit on a slide, the extra
18013 overflows onto a new slide.
18014 I don't recommend doing this, however, since the overflow slide won't have
18015 any page number on it.
18016 Furthermore, it may interfere with any
18020 you've made to accompany the oversized
18027 \begin_layout Standard
18036 environments work the same way as the
18041 They both create an
18042 \begin_inset Quotes eld
18046 \begin_inset Quotes erd
18049 followed by a label [
18050 \begin_inset Quotes eld
18054 \begin_inset Quotes erd
18058 \begin_inset Quotes eld
18062 \begin_inset Quotes erd
18066 The color is a stunning magenta instead of blue, and the
18067 \begin_inset Quotes eld
18071 \begin_inset Quotes erd
18074 will look different, in style and in length.
18075 The label fonts of all three also differ from one another.
18078 \begin_layout Standard
18083 , if the contents of a
18091 exceed the physical size of a slide or sheet of paper, the extra will overflow
18093 Again, you should avoid this.
18094 It defeats the whole purpose of
18105 \begin_layout Subsubsection
18115 \begin_layout Standard
18120 is a slide that sits atop another slide.
18121 Perhaps you wish to discuss a figure on the main
18125 before displaying the text associated with it.
18126 One way to accomplish this is tape a flap of dark paper over the part of
18131 you want to display later.
18132 This method fails, however, if you wish to overlap one graph with another,
18134 You would then have to fumble while speaking to align the two separate,
18139 s to align the two graphs.
18144 environment in both cases makes life much easier.
18147 \begin_layout Standard
18152 receives the page number of its
18153 \begin_inset Quotes eld
18157 \begin_inset Quotes erd
18165 \begin_inset Quotes eld
18173 \begin_inset Quotes erd
18180 \begin_layout Plain Layout
18181 Presumably, mutliple
18186 \begin_inset Quotes eld
18194 \begin_inset Quotes erd
18198 \begin_inset Quotes eld
18206 \begin_inset Quotes erd
18210 \begin_inset Quotes eld
18218 \begin_inset Quotes erd
18222 \begin_inset space ~
18225 appended to the page number of the parent
18235 Clearly, you want the contents of both the
18243 to each fit on a single physical slide! You should probably consider an
18249 \begin_inset Quotes eld
18253 \begin_inset Quotes erd
18261 Indeed, the \SpecialChar LyX
18266 class provides a visual cue for this: the label at the start of an
18270 is shorter than that at the start of a
18275 Lastly, when you generate printable output, you'll find alignment markers
18276 in all four corners of both the
18280 page and its parent
18285 These will assist you in lining up the two physical slides.
18288 \begin_layout Standard
18289 The major problem in overlaying two slides is aligning the contents of the
18290 two transparencies.
18291 How much space should you leave for that graph on the second slide? Worse
18292 still, what if you want a graph and a sentence on second slide, but there
18293 is text on the main transparency that goes in between them? You could try
18294 and insert vertical space of the right size.
18295 The better way is to use
18306 \begin_layout Standard
18307 As their names imply,
18315 are two command-like paragraph environments that make all subsequent text
18316 invisible and visible, respectively.
18318 \begin_inset space ~
18322 \begin_inset CommandInset ref
18324 reference "sec:slideQuirk"
18328 that you don't place anything
18332 these two environments, however.
18337 , it inserts a centered, sky-blue label into the page reading
18338 \begin_inset Quotes eld
18341 <Invisible Text Follows>
18342 \begin_inset Quotes erd
18346 For paragraphs following this label, the parts of the
18354 ; it doesn't matter which] where they would be contain instead blank space.
18358 \begin_layout Standard
18363 , the corresponding centered label is
18364 \begin_inset Quotes eld
18367 <Visible Text Follows>
18368 \begin_inset Quotes erd
18372 Paragraphs following this label behave normally.
18373 Note that the beginning of a new
18385 automatically shuts off an
18390 It's therefore not necessary to use
18401 \begin_layout Standard
18402 By now, it should be obvious how to create overlay transparencies using
18403 the proper combination of
18422 \begin_layout Enumerate
18427 , including everything that will appear on it, whether on the main slide
18435 \begin_layout Enumerate
18436 Before each figure or paragraph that will appear only on the
18445 If necessary, insert a
18449 environment after the
18456 \begin_layout Enumerate
18461 immediately following the
18468 \begin_layout Enumerate
18469 Copy the contents of this
18480 \begin_layout Enumerate
18485 , change all of the
18496 \begin_layout Standard
18498 You've just made an
18505 \begin_layout Standard
18506 There's one problem with the way I've designed the \SpecialChar LyX
18511 class: you can't make text in the middle of a paragraph invisible, nor
18512 make text in the middle of an invisible paragraph visible again.
18513 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18518 \begin_layout Plain Layout
18519 The commands of interest are:
18522 \begin_layout Itemize
18527 invisible \SpecialChar ldots
18531 \begin_layout Itemize
18536 visible \SpecialChar ldots
18540 \begin_layout Plain Layout
18542 and need to be marked as \SpecialChar TeX
18545 \begin_inset Quotes eld
18549 \begin_inset Quotes erd
18552 you wish to change goes in between the brackets [and after the
18565 If you don't know how to mark text as \SpecialChar TeX
18566 , see the appropriate section of
18579 \begin_layout Subsubsection
18589 \begin_inset CommandInset label
18591 name "sec:slideNote"
18598 \begin_layout Standard
18607 is associated with a
18608 \begin_inset Quotes eld
18612 \begin_inset Quotes erd
18620 Here, too, the \SpecialChar LyX
18625 class provides visual cues.
18630 is shorter than that of a
18634 [yet longer than that of an
18638 ] and, like the label of an
18642 is shockingly magenta.
18643 Additionally, the printed
18647 has the page number of its
18648 \begin_inset Quotes eld
18652 \begin_inset Quotes erd
18660 \begin_inset Quotes eld
18668 \begin_inset Quotes erd
18672 \begin_inset Quotes eld
18680 \begin_inset Quotes erd
18684 \begin_inset Quotes eld
18692 \begin_inset Quotes erd
18696 You can have multiple
18700 s associated with a single
18712 , you'll probably want to break up long
18716 s so that they fit on a single sheet of paper.
18719 \begin_layout Standard
18724 is obvious: it contains anything additional you might want to say about
18730 It could also be used as a sheet of reminders for a particular
18735 In the case of the latter, you might want to make use of time markers.
18736 Currently, the \SpecialChar LyX
18742 \begin_inset Quotes eld
18746 \begin_inset Quotes erd
18749 support for time markers, a
18751 Sli\SpecialChar TeX
18755 So, you'll have to resort to using the \SpecialChar LaTeX
18759 \begin_layout Standard
18760 To use time markers, you'll need to specify the extra class option
18761 \begin_inset Quotes eld
18769 \begin_inset Quotes erd
18773 \begin_inset space ~
18777 \begin_inset CommandInset ref
18779 reference "sec:slidesetup"
18784 This option turns on timing marks, which will appear in the lower-left-hand
18790 To set what appears in the time marker, you use the \SpecialChar LaTeX
18792 \begin_inset Quotes eld
18802 \begin_inset Quotes erd
18806 \begin_inset Quotes eld
18816 \begin_inset Quotes erd
18820 The arguments of both commands are time measured in seconds.
18822 \begin_inset Quotes eld
18832 \begin_inset Quotes erd
18835 sets the time marker to a given time.
18837 \begin_inset Quotes eld
18847 \begin_inset Quotes erd
18850 increments the time marker by the specified amount.
18851 Using time markers and
18855 s in this fashion, you can remind yourself how much time to spend on a particula
18863 \begin_layout Standard
18864 There's one last feature to describe.
18865 Clearly, you'd like to print out all of your
18873 s on transparencies while printing all of your
18890 with which it is associated.
18891 What's a person to do?
18894 \begin_layout Standard
18895 Luckily, there are two \SpecialChar LaTeX
18896 commands that allow you to select what to print
18898 Both must be placed into the preamble of your document.
18900 \begin_inset Quotes eld
18912 \begin_inset Quotes erd
18915 will cause the output to contain only the
18924 Correspondingly, the command
18925 \begin_inset Quotes eld
18937 \begin_inset Quotes erd
18940 prevents the output of anything but
18945 I'd advise placing both commands in the preamble and initially comment
18947 You can then preview your entire presentation as you write.
18948 When you're done writing, you can then uncomment one of the two to select
18949 what you want to print.
18950 I like to uncomment
18951 \begin_inset Quotes eld
18963 \begin_inset Quotes erd
18966 , print to a file with
18967 \begin_inset Quotes eld
18975 \begin_inset Quotes erd
18978 in its name, comment it back out, then uncomment
18979 \begin_inset Quotes eld
18991 \begin_inset Quotes erd
18995 \begin_inset Quotes eld
19003 \begin_inset Quotes erd
19007 I can then send either file to a printer, loading transparencies or plain
19008 paper as appropriate.
19011 \begin_layout Standard
19012 You can also provide other arguments to the
19013 \begin_inset Quotes eld
19023 \begin_inset Quotes erd
19027 \begin_inset Quotes eld
19037 \begin_inset Quotes erd
19041 See a good \SpecialChar LaTeX
19045 \begin_layout Subsection
19050 Class Template File
19053 \begin_layout Standard
19054 I have also provided a template file,
19055 \begin_inset Quotes eld
19063 \begin_inset Quotes erd
19071 To use it, begin your new presentation with
19073 File\SpecialChar menuseparator
19075 \begin_inset space ~
19079 \begin_inset space ~
19085 Your new \SpecialChar LyX
19086 presentation file will contain an example
19107 additionally contain an example of the use of
19116 Lastly, the preamble will contain:
19119 \begin_layout LyX-Code
19120 % Uncomment to print out only slides and overlays
19123 \begin_layout LyX-Code
19127 \begin_layout LyX-Code
19133 \begin_inset Newline newline
19139 \begin_layout LyX-Code
19140 % Uncomment to print out only notes
19143 \begin_layout LyX-Code
19147 \begin_layout LyX-Code
19155 \begin_layout Standard
19156 One final thing: I created this class to support the \SpecialChar LaTeX2e
19158 \begin_inset Quotes eld
19163 Sli\SpecialChar TeX
19167 \begin_inset Quotes erd
19170 class, one of the built-in \SpecialChar LaTeX2e
19172 Neither I nor the rest of the \SpecialChar LyX
19173 Team endorse or oppose the use of this built-in
19175 It's here if you want it or need it.
19176 There exist other \SpecialChar LaTeX2e
19177 classes for creating presentations, such as the
19182 \begin_inset space ~
19186 \begin_inset CommandInset ref
19188 reference "sec:foiltex"
19193 \begin_inset Quotes eld
19201 \begin_inset Quotes erd
19204 package [present on some \SpecialChar TeX
19206 The latter is not yet supported under \SpecialChar LyX
19211 \begin_layout Plain Layout
19212 Perhaps you can take on the task\SpecialChar ldots
19218 I know nothing about these other classes.
19219 Try them out to see what sort of alternative they provide.
19222 \begin_layout Chapter
19224 Features needing Extra Software
19227 \begin_layout Section
19228 Checking \SpecialChar TeX
19232 \begin_layout Standard
19238 \begin_layout Subsection
19242 \begin_layout Standard
19251 \begin_layout Plain Layout
19256 is not yet available when you are using the \SpecialChar LaTeX
19257 distribution MiK\SpecialChar TeX
19263 , you'll find in the
19270 \begin_inset space ~
19281 \begin_inset Newline newline
19285 \begin_inset CommandInset href
19287 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19295 \begin_layout Standard
19298 Chk\SpecialChar TeX
19301 package is a program that was written by
19302 \begin_inset Flex Noun
19305 \begin_layout Plain Layout
19307 \begin_inset space ~
19315 in frustration because some constructs in \SpecialChar LaTeX
19316 are sometimes non-intuitive,
19317 and easy to forget.
19318 The program runs over your \SpecialChar LaTeX
19319 file, checks the integrity of the file, and
19320 flags some common errors.
19321 In other technical words, it is
19325 for \SpecialChar LaTeX
19329 \begin_layout Standard
19330 Well, what is a syntax checker doing in \SpecialChar LyX
19331 which is supposed to produce correct
19333 anyways? The answer is simple: Just as
19337 not only checks the
19341 of C programs, but also does
19345 checks for type-errors,
19347 Chk\SpecialChar TeX
19350 catches some common
19354 errors, in addition to the syntactical ones.
19357 Chk\SpecialChar TeX
19360 is capable of detecting several common errors, such as
19363 \begin_layout Itemize
19364 Ellipsis detection:
19365 \begin_inset Newline newline
19368 Use \SpecialChar ldots
19372 \begin_layout Itemize
19373 No space in front of/after parenthesis:
19374 \begin_inset Newline newline
19380 \begin_layout Itemize
19381 Enforcement of normal space after common abbreviations:
19382 \begin_inset Newline newline
19386 \begin_inset space \thinspace{}
19390 \begin_inset space \space{}
19393 is too wide spacing.
19396 \begin_layout Itemize
19397 Enforcement of end-of-sentence space when the last sentence ends with a
19399 \begin_inset Newline newline
19403 And this is wrong spacing.
19406 \begin_layout Itemize
19407 Space in front of labels and similar commands:
19408 \begin_inset Newline newline
19411 The label should stick right up to the text to avoid falling to a wrong
19414 \begin_inset CommandInset label
19424 \begin_layout Plain Layout
19425 This footnote is in danger of falling off to a wrong page
19430 The label is separated too much.
19433 \begin_layout Itemize
19434 Space in front of references, instead of hard spaces:
19435 \begin_inset Newline newline
19438 If you have bad luck, the text will break right between the referenced text
19439 and reference number, and that's a pity.
19441 \begin_inset CommandInset ref
19443 reference "sec:chktex"
19450 \begin_layout Itemize
19452 \begin_inset Quotes eld
19456 \begin_inset Quotes erd
19460 \begin_inset Formula $\times$
19464 \begin_inset Newline newline
19467 2x2 looks cheap compared to
19468 \begin_inset Formula $2\times2$
19474 \begin_layout Standard
19475 and more \SpecialChar ldots
19476 It is an invaluable tool when you are
19477 \begin_inset Quotes eld
19481 \begin_inset Quotes erd
19484 your document before printing, and you should run it right after the obligatory
19485 spelling check, and before you go fine tuning the typesetting.
19488 \begin_layout Subsection
19492 \begin_layout Standard
19493 If you have the program installed, usage is as simple as choosing
19495 Tools\SpecialChar menuseparator
19497 \begin_inset space ~
19503 This will make \SpecialChar LyX
19504 generate a \SpecialChar LaTeX
19505 file of your document, start
19507 Chk\SpecialChar TeX
19510 to check it, and then make \SpecialChar LyX
19512 \begin_inset Quotes eld
19516 \begin_inset Quotes erd
19519 with the warnings from
19521 Chk\SpecialChar TeX
19524 , if there were any.
19525 The warnings will be placed close to the point of the mistake, and you
19526 can quickly find them by using the
19528 Navigate\SpecialChar menuseparator
19531 menu item, or the shortcut key
19540 Open the error boxes by clicking on them with the mouse, or use the shortcut
19549 bindings, or the corresponding
19558 Read the warning and correct the mistake, if it is a mistake.
19559 If you have trouble understanding what the warning is about, you can safely
19561 Remember that there is a hidden layer between the document on screen and
19562 the technical details in invoking
19564 Chk\SpecialChar TeX
19567 , and this gap can make some warnings seem arcane or just plain silly.
19570 \begin_layout Standard
19571 This document is an excellent testing bed for the feature, and it should
19572 provide quite a few warnings for you to fiddle with.
19573 Since computers are only so smart, expect most of the warnings to be false
19577 \begin_layout Subsection
19578 How to fine tune it
19581 \begin_layout Standard
19582 Sometimes, you'll find that
19584 Chk\SpecialChar TeX
19587 makes more noise than suits your mood.
19588 Then you can choose not to use it, wait until your mood changes, or try
19591 Chk\SpecialChar TeX
19594 to get better along with you.
19597 \begin_layout Standard
19600 Chk\SpecialChar TeX
19607 very configurable and extensible, you should not expect to solve all problems
19610 Chk\SpecialChar TeX
19613 in \SpecialChar LyX
19615 Since \SpecialChar LyX
19616 has to generate a somewhat special \SpecialChar LaTeX
19617 file to be able to match the
19618 line numbers from the
19620 Chk\SpecialChar TeX
19627 \begin_layout Plain Layout
19628 You can inspect the specific output from
19634 Document\SpecialChar menuseparator
19637 \begin_inset space ~
19651 to the internal document structure, some of the warnings will not appear
19653 There are two things you can do about this:
19656 \begin_layout Itemize
19659 Chk\SpecialChar TeX
19662 invocation command line in
19663 \begin_inset Flex Noun
19666 \begin_layout Plain Layout
19667 Tools\SpecialChar menuseparator
19668 Preferences\SpecialChar menuseparator
19669 Output\SpecialChar menuseparator
19670 LaTeX\SpecialChar menuseparator
19678 Chk\SpecialChar TeX
19681 installation configuration file (usually with the file
19686 See below to learn what warnings can be enabled and disabled on the command
19690 \begin_layout Itemize
19691 Export your document as a raw \SpecialChar LaTeX
19694 File\SpecialChar menuseparator
19695 Export\SpecialChar menuseparator
19704 Invoked in this way, it can be a hassle to find the corresponding place
19705 in the document inside \SpecialChar LyX
19706 , but with a little patience, you should be able
19710 \begin_layout Standard
19711 Here follows the warning messages that can be enabled and disabled in
19720 to disable a warning, and
19724 to enable a warning.
19725 The emphasized entries are disabled by default, because the default is
19728 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19733 \begin_layout Standard
19734 Notice that you should only use the options that enable and disable warnings,
19735 because \SpecialChar LyX
19736 relies on some of the other command line parameters to be set
19737 in a specific way to have a chance to communicate with
19744 \begin_layout Enumerate
19748 Command terminated with space.
19751 \begin_layout Enumerate
19754 Non-breaking space (
19755 \begin_inset Quotes eld
19763 \begin_inset Quotes erd
19766 ) should have been used.
19769 \begin_layout Enumerate
19773 You should enclose the previous parenthesis with
19774 \begin_inset Quotes eld
19782 \begin_inset Quotes erd
19788 \begin_layout Enumerate
19791 Italic correction (
19792 \begin_inset Quotes eld
19802 \begin_inset Quotes erd
19805 ) found in non-italic buffer.
19808 \begin_layout Enumerate
19811 Italic correction (
19812 \begin_inset Quotes eld
19822 \begin_inset Quotes erd
19825 ) found more than once.
19828 \begin_layout Enumerate
19832 No italic correction (
19833 \begin_inset Quotes eld
19843 \begin_inset Quotes erd
19849 \begin_layout Enumerate
19853 \begin_inset Quotes eld
19861 \begin_inset Quotes erd
19865 \begin_inset Quotes eld
19873 \begin_inset Quotes erd
19879 \begin_layout Enumerate
19882 Wrong length of dash may have been used.
19885 \begin_layout Enumerate
19889 \begin_inset Quotes eld
19897 \begin_inset Quotes erd
19901 \begin_inset Quotes eld
19909 \begin_inset Quotes erd
19915 \begin_layout Enumerate
19919 \begin_inset Quotes eld
19927 \begin_inset Quotes erd
19933 \begin_layout Enumerate
19937 \begin_inset Quotes eld
19945 \begin_inset Quotes erd
19948 to achieve an ellipsis.
19951 \begin_layout Enumerate
19954 Inter-word spacing (
19955 \begin_inset Quotes eld
19965 \begin_inset Quotes eld
19968 ) should perhaps be used.
19971 \begin_layout Enumerate
19974 Inter-sentence spacing (
19975 \begin_inset Quotes eld
19985 \begin_inset Quotes erd
19988 ) should perhaps be used.
19991 \begin_layout Enumerate
19994 Could not find argument for command.
19997 \begin_layout Enumerate
20001 \begin_inset Quotes eld
20009 \begin_inset Quotes erd
20015 \begin_layout Enumerate
20018 Math mode still on at end of \SpecialChar LaTeX
20022 \begin_layout Enumerate
20026 \begin_inset Quotes eld
20034 \begin_inset Quotes erd
20037 doesn't match the number of
20038 \begin_inset Quotes eld
20046 \begin_inset Quotes erd
20052 \begin_layout Enumerate
20055 You should use either
20058 \begin_inset Quotes eld
20066 \begin_inset Quotes erd
20071 as an alternative to
20072 \begin_inset Quotes eld
20080 \begin_inset Quotes erd
20086 \begin_layout Enumerate
20093 " (ASCII 39) instead of "
20100 \begin_layout Enumerate
20103 User-specified pattern found.
20106 \begin_layout Enumerate
20109 This command might not be intended.
20112 \begin_layout Enumerate
20119 \begin_layout Enumerate
20137 \begin_layout Enumerate
20140 Delete this space to maintain correct page references.
20143 \begin_layout Enumerate
20147 You might wish to put this between a pair of
20148 \begin_inset Quotes eld
20156 \begin_inset Quotes erd
20162 \begin_layout Enumerate
20165 You ought to remove spaces in front of punctuation.
20168 \begin_layout Enumerate
20171 Could not execute \SpecialChar LaTeX
20175 \begin_layout Enumerate
20184 in front of small punctuation.
20187 \begin_layout Enumerate
20195 may look prettier here.
20198 \begin_layout Enumerate
20202 Multiple spaces detected in output.
20205 \begin_layout Enumerate
20208 This text may be ignored.
20211 \begin_layout Enumerate
20217 \begin_inset Quotes eld
20222 to begin quotation, not
20229 \begin_layout Enumerate
20236 to end quotation, not
20239 \begin_inset Quotes eld
20247 \begin_layout Enumerate
20253 \begin_layout Enumerate
20256 You should perhaps use
20257 \begin_inset Quotes eld
20265 \begin_inset Quotes erd
20271 \begin_layout Enumerate
20274 You should put a space in front of/after parenthesis.
20277 \begin_layout Enumerate
20280 You should avoid spaces in front of/after parenthesis.
20283 \begin_layout Enumerate
20287 You should not use punctuation in front of/after quotes.
20290 \begin_layout Enumerate
20293 Double space found.
20296 \begin_layout Enumerate
20299 You should put punctuation outside inner/inside display math mode.
20302 \begin_layout Enumerate
20305 You ought to not use primitive \SpecialChar TeX
20306 in \SpecialChar LaTeX
20310 \begin_layout Enumerate
20313 You should remove spaces in front of
20314 \begin_inset Quotes eld
20322 \begin_inset Quotes erd
20328 \begin_layout Enumerate
20331 \begin_inset Quotes eld
20339 \begin_inset Quotes erd
20342 is normally not followed by
20343 \begin_inset Quotes eld
20351 \begin_inset Quotes erd
20357 \begin_layout Standard
20358 In later versions of \SpecialChar LyX
20359 , we hope to provide a more complete interface to this
20360 tool (and it's smaller cousin
20364 ) to exploit the full power of it.
20365 But it's not exactly useless as it is now: go try it on one of your existing
20366 documents of a certain length and be surprised.
20369 \begin_layout Section
20370 Version Control in \SpecialChar LyX
20374 \begin_layout Standard
20377 Lars Gullik Bjønnes
20384 \begin_layout Subsection
20388 \begin_layout Standard
20390 supports some of the most basic RCS/CVS/SVN/GIT commands.
20391 If you need something a bit more sophisticated you will have to do that
20392 manually in a terminal.
20395 \begin_layout Standard
20396 Also note that CVS support is not as good as subversion support so we advise
20398 A good place to start learning Subversion is SVN Book
20402 \begin_layout Plain Layout
20403 \begin_inset CommandInset href
20405 target "http://svnbook.red-bean.com/"
20416 In the case of RCS you should read
20417 \begin_inset Quotes eld
20421 \begin_inset Quotes erd
20424 (a man file, read it with
20429 This file describes all the basic features of RCS.
20430 You should especially notice the comment about a RCS directory, and the
20431 notion of a master RCS file (the file ending in
20438 \begin_layout Standard
20439 Before you begin to use the version control features in \SpecialChar LyX
20441 familiar with RCS/CVS/SVN/GIT usage.
20442 The implementation in \SpecialChar LyX
20443 assumes a recent version of the GNU RCS or CVS/SVN
20444 package — no guarantees are made for older versions.
20445 Most of the log messages are not currently displayed after operations —
20446 you can check them in the Messages pane if unsure.
20447 Regular users of version control will appreciate VC toolbar, which can
20450 View\SpecialChar menuseparator
20451 Toolbars\SpecialChar menuseparator
20453 \begin_inset space ~
20461 \begin_layout Standard
20462 For introducing your own external commands consult vc-command in the manual
20463 of \SpecialChar LyX
20467 \begin_layout Standard
20468 It is strongly recommended to store documents in uncompressed format if
20469 using version control (uncheck
20471 Document\SpecialChar menuseparator
20474 if it is checked): Uncompressed LyX documents are text files and therefore
20475 for merging two different versions by version control systems.
20476 Compressed LyX documents are binary files, which cannot be merged by version
20480 \begin_layout Subsection
20481 RCS commands in \SpecialChar LyX
20485 \begin_layout Standard
20486 The following sections describe the RCS commands supported by \SpecialChar LyX
20488 You can find them in the
20490 File\SpecialChar menuseparator
20492 \begin_inset space ~
20499 was tested against RCS 5.7/5.8.
20502 \begin_layout Subsubsection
20508 \begin_layout Standard
20509 If your document is not under revision control, this is the only item shown
20511 And if it is under revision control, the
20515 item is not visible.
20519 \begin_layout Standard
20520 This command registers your document with RCS (unless you are under the
20521 directory managed by CVS)\SpecialChar endofsentence
20522 You are asked interactively to supply an initial
20523 description of the document.
20524 The document is now set in Read-Only mode and you have to
20527 \begin_inset space ~
20531 \begin_inset space ~
20535 \begin_inset space ~
20540 , before making any changes to it.
20541 A document under revision control has a
20542 \begin_inset Quotes eld
20545 [RCS:<version> <locker>]
20546 \begin_inset Quotes erd
20549 item tagged to the filename in the minibuffer.
20552 \begin_layout Standard
20553 RCS command that is run:
20555 ci -q -u -i -t-"<initial description>" <file-name>
20558 \begin_layout Standard
20563 to understand the switches.
20567 \begin_layout Subsubsection
20573 \begin_layout Standard
20574 When you are finished editing a file, you check in your changes.
20575 When you do this, you are asked for a description of the changes.
20576 This is stored in the history log.
20577 The version number is bumped, your changes are applied to the master RCS
20578 file, the document is unlocked and set to Read-Only mode.
20581 \begin_layout Standard
20584 ci -q -u -m"<description>" <file-name>
20587 \begin_layout Subsubsection
20593 \begin_layout Standard
20594 By doing this you lock the document so that only you can edit it.
20595 This will also make the document Read-Write only for you.
20596 You will usually continue editing for a while and when you are finished
20597 you check in your changes.
20598 The status line is changed to reflect that you have locked the file.
20601 \begin_layout Standard
20604 co -q -l <file-name>
20607 \begin_layout Subsubsection
20610 Revert To Repository Version
20613 \begin_layout Standard
20614 This will discard all changes made to the document since the last check
20616 You get a warning before changes are discarded.
20619 \begin_layout Standard
20622 co -f -u<version> <file-name>
20625 \begin_layout Subsubsection
20631 \begin_layout Standard
20632 This will create a copy of the current document.
20633 Since RCS does not support copy operations natively, the version history
20634 is not preserved, and the copy is added as a new file.
20635 It requires a clean document without any changes since the last checkin.
20636 You are asked for a file name and a description of the copy operation.
20637 After that the copy is created, both locally and in the repository.
20638 If the parent directories of the copied and original document differ, all
20639 relative paths of included files of the copy are adjusted (like in
20641 File\SpecialChar menuseparator
20646 Finally, the copy is loaded instead of the original document.
20649 \begin_layout Labeling
20650 \labelwidthstring 00.00.0000
20652 \begin_inset space ~
20656 \begin_inset space ~
20660 \begin_inset Newline newline
20664 \begin_inset Flex Code
20667 \begin_layout Plain Layout
20670 \begin_inset Quotes eld
20674 \begin_inset Quotes erd
20683 \begin_inset Flex Code
20686 \begin_layout Plain Layout
20689 \begin_inset Quotes eld
20693 \begin_inset Quotes erd
20702 \begin_inset Newline newline
20706 \begin_inset Flex Code
20709 \begin_layout Plain Layout
20713 \begin_inset Quotes eld
20717 \begin_inset Quotes erd
20728 \begin_layout Subsubsection
20734 \begin_layout Standard
20735 This makes as if the last check in never happened.
20736 No changes are made to the document loaded into \SpecialChar LyX
20737 , but the last version
20738 is removed from the master RCS file.
20741 \begin_layout Standard
20744 rcs -o<version> <file-name>
20747 \begin_layout Subsubsection
20753 \begin_layout Standard
20754 This shows the complete history of the RCS document.
20759 is shown in a browser.
20767 \begin_layout Subsubsection
20771 \begin_layout Standard
20773 supports RCS version number, author name, date and time of last commit.
20774 All those are extracted from
20776 rlog -r <file-name>
20780 \begin_inset CommandInset ref
20782 reference "subsec:VCS-Revision-Information"
20789 \begin_layout Subsection
20790 CVS commands in \SpecialChar LyX
20794 \begin_layout Standard
20795 A subset of CVS operations is supported by \SpecialChar LyX
20797 You can find the commands in the
20799 File\SpecialChar menuseparator
20801 \begin_inset space ~
20807 The version control system SVN is more powerful, so please use it instead
20808 of CVS if possible.
20811 \begin_layout Subsubsection
20817 \begin_layout Standard
20818 If you start from scratch with CVS you have to create your repository and
20819 checkout the working copy with external tools.
20820 If you're using a client-server setup you may need to login before doing
20821 the first repository checkout.
20824 \begin_layout Standard
20825 If your documents are under revision control and others are using the same
20826 repository problems arise when different changes to the same document at
20827 the same location happen.
20828 Standard CVS repositories don't operate with a file locking mechanism.
20829 This may be surprising, but conflicts only occur if people disagree on
20830 the proper content of the same part of a document.
20831 So, if co-workers are used to communicate regularly, these conflicts occur
20833 If they don't communicate they have a fundamental problem anyway.
20834 Nevertheless some people like to work with so called
20835 \begin_inset Quotes eld
20839 \begin_inset Quotes erd
20843 If they do so the working copy of all files is readonly when checked out
20844 first and the user starts editing after using a special command to make
20845 the working copy writable.
20846 When the changes are checked in the working copy returns to readonly state.
20847 With \SpecialChar LyX
20848 one has to edit the
20849 \begin_inset Flex Code
20852 \begin_layout Plain Layout
20858 file and add the line
20859 \begin_inset Flex Code
20862 \begin_layout Plain Layout
20868 to work with reserved checkouts.
20869 The benefit is the possibility to see who is using a writable copy of some
20871 It's not guaranteed only one user makes a copy writable.
20874 \begin_layout Standard
20876 tries to guess if you're using reserved or non-reserved checkouts.
20877 If your working copy is readonly or it is writable and an additional copy
20878 of your document exists in the CVS/Base sub-directory a reserved otherwise
20879 a non-reserved checkout is assumed.
20880 When a reserved checkout is detected you have to use
20881 \begin_inset Flex Noun
20884 \begin_layout Plain Layout
20890 to make your working copy writable if it's readonly.
20892 \begin_inset Flex Noun
20895 \begin_layout Plain Layout
20901 operation is possible and that makes your working copy readonly again after
20902 transferring your changes to the repository.
20905 \begin_layout Standard
20906 More information about CVS can be found here
20907 \begin_inset Flex URL
20910 \begin_layout Plain Layout
20912 http://www.nongnu.org/cvs
20918 \begin_inset Flex URL
20921 \begin_layout Plain Layout
20923 http://ximbiot.com/cvs
20931 \begin_layout Standard
20936 to understand the sub-commands and the switches mentioned below.
20939 \begin_layout Subsubsection
20945 \begin_layout Standard
20946 If your document is not under revision control, this is the only item shown
20948 And if it is under revision control, the
20952 item is not visible.
20956 \begin_layout Standard
20957 This command registers in CVS your document
20958 \begin_inset Flex Strong
20961 \begin_layout Plain Layout
20969 in the case you have already the documents directory under CVS control
20975 This means you have to create or checkout the archive by yourself using
20977 (In case you forget that step \SpecialChar LyX
20978 registers the document with RCS.)
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 checked in.
20987 \begin_layout Standard
20988 CVS command that is run:
20990 cvs -q add -m"<entered message>" "<file-name>"
20993 \begin_layout Standard
20998 above and for all other CVS commands is an abbreviation for
20999 \begin_inset Quotes eld
21002 change the current working directory to file location and use the file name
21003 without path component as argument
21004 \begin_inset Quotes erd
21010 \begin_layout Subsubsection
21016 \begin_layout Standard
21017 When you are finished editing a file, you commit your changes.
21018 When you do this and you had changed the document, you are asked for a
21019 description of the changes.
21020 After that changes are written to the repository.
21021 In case you didn't change the document and a reserved checkout is detected
21022 the reservation made on
21023 \begin_inset Flex Noun
21026 \begin_layout Plain Layout
21035 \begin_layout Labeling
21036 \labelwidthstring 00.00.0000
21038 \begin_inset space ~
21042 \begin_inset space ~
21046 \begin_inset Newline newline
21050 \begin_inset Flex Code
21053 \begin_layout Plain Layout
21056 -q commit -m"<description>" "<file-name>"
21062 \begin_inset Newline newline
21066 \begin_inset Flex Code
21069 \begin_layout Plain Layout
21080 \begin_layout Subsubsection
21086 \begin_layout Standard
21087 When you are sharing a repository with others, you may have to incorporate
21088 their changes into your working copy.
21091 \begin_layout Standard
21094 cvs -q update "<file-name>"
21097 \begin_layout Standard
21098 If a readonly checkout is detected the working copy is made writable and
21102 \begin_layout Standard
21105 cvs -q edit "<file-name>"
21108 \begin_layout Subsubsection
21111 Revert To Repository Version
21114 \begin_layout Standard
21115 This will discard all changes made to the document since the last check
21117 You get a warning before changes are discarded.
21118 Firstly the file is deleted, secondly CVS update command is run.
21121 \begin_layout Standard
21124 cvs -q update "<file-name>"
21127 \begin_layout Standard
21128 If a reserved checkout is detected and the working copy has no changes only
21129 the reservation is undone.
21132 \begin_layout Standard
21135 cvs -q unedit "<file-name>"
21138 \begin_layout Subsubsection
21144 \begin_layout Standard
21145 This will create a copy of the current document.
21146 Since CVS does not support copy operations natively, the version history
21147 is not preserved, and the copy is added as a new file.
21148 It requires a clean document without any changes since the last checkin.
21149 You are asked for a file name and a description of the copy operation.
21150 After that the copy is created, both locally and in the repository.
21151 If the parent directories of the copied and original document differ, all
21152 relative paths of included files of the copy are adjusted (like in
21154 File\SpecialChar menuseparator
21159 Finally, the copy is loaded instead of the original document.
21162 \begin_layout Labeling
21163 \labelwidthstring 00.00.0000
21165 \begin_inset space ~
21169 \begin_inset space ~
21173 \begin_inset Newline newline
21177 \begin_inset Flex Code
21180 \begin_layout Plain Layout
21183 \begin_inset Quotes eld
21187 \begin_inset Quotes erd
21196 \begin_inset Flex Code
21199 \begin_layout Plain Layout
21202 \begin_inset Quotes eld
21206 \begin_inset Quotes erd
21215 \begin_inset Newline newline
21219 \begin_inset Flex Code
21222 \begin_layout Plain Layout
21226 \begin_inset Quotes eld
21230 \begin_inset Quotes erd
21241 \begin_layout Subsubsection
21247 \begin_layout Standard
21248 This will rename the current document.
21249 Since CVS does not support rename operations natively, the version history
21250 is not preserved, the renamed document is added as a new file, and the
21251 original document is deleted.
21252 It requires a clean document without any changes since the last checkin.
21253 You are asked for a file name and a description of the rename operation.
21254 After that the document is renamed, both locally and in the repository.
21255 If the parent directories of the new and old file names differ, all relative
21256 paths of included files are adjusted (like in
21258 File\SpecialChar menuseparator
21263 Finally, the document is reloaded using the new name.
21266 \begin_layout Labeling
21267 \labelwidthstring 00.00.0000
21269 \begin_inset space ~
21273 \begin_inset space ~
21277 \begin_inset Newline newline
21281 \begin_inset Flex Code
21284 \begin_layout Plain Layout
21287 \begin_inset Quotes eld
21291 \begin_inset Quotes erd
21300 \begin_inset Flex Code
21303 \begin_layout Plain Layout
21306 \begin_inset Quotes eld
21310 \begin_inset Quotes erd
21319 \begin_inset Newline newline
21323 \begin_inset Flex Code
21326 \begin_layout Plain Layout
21330 \begin_inset Quotes eld
21334 \begin_inset Quotes erd
21343 \begin_inset Newline newline
21347 \begin_inset Flex Code
21350 \begin_layout Plain Layout
21354 \begin_inset Quotes eld
21358 \begin_inset Quotes erd
21369 \begin_layout Subsubsection
21370 Update of the local directory checkout from repository
21373 \begin_layout Standard
21374 Once your documents gets more complex, containing sub-documents and pictures,
21376 \begin_inset Flex Code
21379 \begin_layout Plain Layout
21385 files and so on using version control becomes more complicated.
21387 supports updating the whole tree in which resides the document.
21388 This become especially useful once you cooperate with people which neither
21389 have detailed knowledge about CVS usage nor they have ambition to commit
21390 additional material to the repository.
21391 You have to organize the files structure so that all external files are
21392 in the same directory or subdirectories of the document.
21393 It's good practice anyway to store multipart documents in an extra directory.
21396 \begin_layout Standard
21398 \begin_inset Flex Code
21401 \begin_layout Plain Layout
21402 Update local directory from repository
21407 command updates the whole directory.
21408 If local changes are detected user is warned before update starts.
21409 In case of merge conflicts both versions of the conflicting document parts
21410 are placed in the final document.
21411 You have to review and correct the result of the merge.
21412 You'll find the conflicts enclosed in pairs of
21413 \begin_inset Flex Code
21416 \begin_layout Plain Layout
21423 \begin_inset Flex Code
21426 \begin_layout Plain Layout
21433 \begin_inset Flex Code
21436 \begin_layout Plain Layout
21443 The first part is your version as before the update operation with the
21444 document name prepended.
21445 The second one is the repository version with the version number after
21447 \begin_inset Flex Code
21450 \begin_layout Plain Layout
21459 \begin_layout Labeling
21460 \labelwidthstring 00.00.0000
21462 \begin_inset space ~
21466 \begin_inset space ~
21470 \begin_inset Newline newline
21474 \begin_inset Flex Code
21477 \begin_layout Plain Layout
21485 (Ask if changes are detected.)
21486 \begin_inset Newline newline
21490 \begin_inset Flex Code
21493 \begin_layout Plain Layout
21494 cd $path; cvs -q update
21504 \begin_layout Standard
21506 \begin_inset Flex Code
21509 \begin_layout Plain Layout
21515 stands for the path to the document.
21518 \begin_layout Subsubsection
21524 \begin_layout Standard
21525 This shows the complete history of the CVS document.
21528 cvs log "<file-name>"
21530 is shown in a browser.
21533 \begin_layout Subsubsection
21537 \begin_layout Standard
21539 supports CVS version number, author name, date and time of last commit.
21540 All those are extracted from
21542 cvs log -r <file-name>
21546 \begin_inset CommandInset ref
21548 reference "subsec:VCS-Revision-Information"
21555 \begin_layout Subsection
21556 SVN commands in \SpecialChar LyX
21560 \begin_layout Standard
21561 SVN is now partially supported by \SpecialChar LyX
21563 You can find the commands in the
21565 File\SpecialChar menuseparator
21567 \begin_inset space ~
21573 Please note that if you use password protected access to repository via
21574 ssh, you will be asked in terminal window.
21576 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21580 \begin_layout Plain Layout
21581 Most of the commands will work with 1.4 too, see
21582 \begin_inset CommandInset ref
21584 reference "subsec:SVN-Repo-Update"
21589 There seems to be currently unresolved permissions problem under SVN 1.8
21590 with reverting changes when file is locked.
21598 \begin_layout Subsubsection
21604 \begin_layout Standard
21605 If your document is not under revision control, this is the only item shown
21607 And if it is under revision control, the
21611 item is not visible.
21614 \begin_layout Standard
21615 This command registers in SVN your document ONLY in case you have already
21616 the documents directory under SVN control (in particular
21621 This means you have to checkout the archive by yourself.
21624 \begin_layout Standard
21625 Then you are asked interactively to supply an initial description of the
21627 Don't forget that registered file is not yet commited.
21630 \begin_layout Standard
21631 SVN command that is run:
21634 \begin_inset Quotes eld
21638 \begin_inset Quotes erd
21644 \begin_layout Standard
21649 to understand the switches.
21652 \begin_layout Subsubsection
21658 \begin_layout Standard
21659 When you are finished editing a file, you commit your changes.
21660 When you do this, you are asked for a description of the changes.
21661 After that changes are commited.
21664 \begin_layout Standard
21669 \begin_layout Plain Layout
21670 In case locking is not enabled.
21672 \begin_inset CommandInset ref
21674 reference "subsec:SVN-File-Locking"
21685 svn commit -q -m"<description>" <file-name>
21688 \begin_layout Subsubsection
21694 \begin_layout Standard
21695 Updates the changes of this file from the repository.
21696 Be sure you understand SVN merging and conflicts resolving before using
21697 this function, because all conflicts has to be resolved manually by you!
21700 \begin_layout Standard
21705 \begin_layout Plain Layout
21713 svn update --non-interactive
21714 \begin_inset Quotes eld
21718 \begin_inset Quotes erd
21724 \begin_layout Subsubsection
21727 Revert To Repository Version
21730 \begin_layout Standard
21731 This will discard all changes made to the document since the last check
21733 You get a warning before changes are discarded.
21736 \begin_layout Standard
21740 \begin_inset Quotes eld
21744 \begin_inset Quotes erd
21750 \begin_layout Subsubsection
21756 \begin_layout Standard
21757 This will create a copy of the current document including the version history.
21758 It requires a clean document without any changes since the last checkin.
21759 You are asked for a file name and a description of the copy operation.
21760 After that the copy is created, both locally and in the repository.
21761 If the parent directories of the copied and original document differ, all
21762 relative paths of included files of the copy are adjusted (like in
21764 File\SpecialChar menuseparator
21769 Finally, the copy is loaded instead of the original document.
21772 \begin_layout Labeling
21773 \labelwidthstring 00.00.0000
21775 \begin_inset space ~
21779 \begin_inset space ~
21783 \begin_inset Newline newline
21787 \begin_inset Flex Code
21790 \begin_layout Plain Layout
21794 \begin_inset Quotes eld
21798 \begin_inset Quotes erd
21802 \begin_inset Quotes eld
21806 \begin_inset Quotes erd
21815 \begin_inset Newline newline
21819 \begin_inset Flex Code
21822 \begin_layout Plain Layout
21831 \begin_layout Subsubsection
21837 \begin_layout Standard
21838 This will rename the current document including the version history.
21839 It requires a clean document without any changes since the last checkin.
21840 You are asked for a file name and a description of the rename operation.
21841 After that the document is renamed, both locally and in the repository.
21842 If the parent directories of the new and old file names differ, all relative
21843 paths of included files are adjusted (like in
21845 File\SpecialChar menuseparator
21850 Finally, the document is reloaded using the new name.
21853 \begin_layout Labeling
21854 \labelwidthstring 00.00.0000
21856 \begin_inset space ~
21860 \begin_inset space ~
21864 \begin_inset Newline newline
21868 \begin_inset Flex Code
21871 \begin_layout Plain Layout
21875 \begin_inset Quotes eld
21879 \begin_inset Quotes erd
21883 \begin_inset Quotes eld
21887 \begin_inset Quotes erd
21896 \begin_inset Newline newline
21900 \begin_inset Flex Code
21903 \begin_layout Plain Layout
21912 \begin_layout Subsubsection
21913 \begin_inset CommandInset label
21915 name "subsec:SVN-Repo-Update"
21919 Update of the local directory checkout from repository
21923 \begin_layout Plain Layout
21924 Note that this command will work only with subversion
21925 \begin_inset Formula $\geqq1.5$
21936 \begin_layout Standard
21937 All the commands above have one shortcomming - they deal with the current
21939 Once your document contains pictures, includes external
21940 \begin_inset Flex Code
21943 \begin_layout Plain Layout
21949 files and so on administration becomes more complicated.
21951 now supports updating the whole tree in which resides the document
21955 \begin_layout Plain Layout
21956 One need to organize the files structure so that all external files are
21957 in the same directory or subdirectories of the document.
21964 This become especially useful once you cooperate with people which neither
21965 know about subversion management nor they have ambition to commit additional
21966 material to the repository.
21970 \begin_layout Standard
21971 \begin_inset Flex Code
21974 \begin_layout Plain Layout
21975 Update local directory from repository
21980 command updates the whole directory and in case of merge conflicts local
21981 version of the files are left, so no unintended data loss occurs.
21982 If local changes are detected user is warned before update starts.
21985 \begin_layout Labeling
21986 \labelwidthstring 00.00.0000
21988 \begin_inset space ~
21992 \begin_inset space ~
21996 \begin_inset Newline newline
22000 \begin_inset Flex Code
22003 \begin_layout Plain Layout
22009 (Ask if changes are detected.)
22010 \begin_inset Newline newline
22014 \begin_inset Flex Code
22017 \begin_layout Plain Layout
22018 svn update –accept mine-full $path
22026 \begin_layout Standard
22028 \begin_inset Flex Code
22031 \begin_layout Plain Layout
22037 stands for the path to the document.
22040 \begin_layout Subsubsection
22046 \begin_layout Standard
22047 This shows the complete history of the SVN document.
22051 \begin_inset Quotes eld
22055 \begin_inset Quotes erd
22060 is shown in a browser.
22063 \begin_layout Subsubsection
22065 \begin_inset CommandInset label
22067 name "subsec:SVN-File-Locking"
22074 \begin_layout Standard
22075 The file exchange through various revision control systems brings the problem
22076 of merge conflicts in case two different users try to edit the same (parts
22078 When such a conflict happens it needs manual resolving and one reasonable
22079 alternative is to provide some kind of locking mechanism, which guarantees
22080 that only one user is allowed to edit file at the given time.
22083 \begin_layout Standard
22084 SVN has two such mechanisms to provide mutual exclusivity for file access
22085 - locks and automatic setting of write permissions (see sec.
22087 \begin_inset CommandInset ref
22089 reference "subsec:Automatical-Locking-Property"
22094 \begin_inset Flex Code
22097 \begin_layout Plain Layout
22107 \begin_layout Plain Layout
22108 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
22114 If this property is detected for a given document \SpecialChar LyX
22115 starts to use SVN locks
22116 for document editing automatically and the whole check-in/out mechanism
22117 switches to the same regimen as for RCS.
22118 This in particular means there are two different modes of file use in \SpecialChar LyX
22122 \begin_layout Itemize
22124 The loaded file is in the read-only mode.
22125 For editing on needs to check-out.
22130 consists of updating from the repository and gaining write lock.
22131 If the lock is not possible to obtain, we remain in unlocked state.
22134 \begin_layout Itemize
22136 The loaded file is in the 'normal' edit mode.
22137 No other user is allowed to edit the file.
22142 consists of commiting changes and releasing write-lock.
22143 If no changes have been made to the document, no commit will be produced
22147 \begin_layout Plain Layout
22148 Don't be puzzled by the fact that you will be asked for commit message anyway.
22153 and only the write-lock will be released.
22156 \begin_layout Standard
22160 \begin_layout Labeling
22161 \labelwidthstring 00.00.0000
22164 svn commit -q -m"<description>" "<file-name>"
22165 \begin_inset Newline newline
22168 svn unlock "<file-name>"
22171 \begin_layout Labeling
22172 \labelwidthstring 00.00.0000
22175 svn update "<file-name>"
22176 \begin_inset Newline newline
22179 svn lock "<file-name>"
22182 \begin_layout Subsubsection
22185 \begin_inset CommandInset label
22187 name "subsec:Automatical-Locking-Property"
22193 Automatic Locking Property
22196 \begin_layout Standard
22197 The above mentioned automatic setting of write permissions of the .lyx file
22200 File\SpecialChar menuseparator
22202 \begin_inset space ~
22205 Control\SpecialChar menuseparator
22206 Toggle locking property
22209 This command is active only when the file is not locked on the svn server
22211 you need to check-out before proceeding).
22214 \begin_layout Labeling
22215 \labelwidthstring 00.00.0000
22217 \begin_inset space ~
22223 \begin_layout Labeling
22224 \labelwidthstring 00.00.0000
22227 svn propset svn:needs-lock ON "<file-name>"
22230 \begin_layout Labeling
22231 \labelwidthstring 00.00.0000
22234 svn propdel svn:needs-lock "<file-name>"
22237 \begin_layout Subsubsection
22238 \begin_inset CommandInset label
22240 name "subsec:VCS-Revision-Information"
22244 Revision Information in Documents
22247 \begin_layout Standard
22248 There are more possibilities how to activate revision information in our
22252 \begin_layout Itemize
22258 \begin_layout Itemize
22259 tree revision information (
22260 \begin_inset Flex Code
22263 \begin_layout Plain Layout
22270 The result is the output of the
22271 \begin_inset Flex Code
22274 \begin_layout Plain Layout
22280 command, the following table gives you an idea, how to read the results.
22283 \begin_layout Standard
22285 \begin_inset Tabular
22286 <lyxtabular version="3" rows="6" columns="2">
22287 <features tabularvalignment="middle">
22288 <column alignment="center" valignment="top">
22289 <column alignment="center" valignment="top">
22291 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22294 \begin_layout Plain Layout
22300 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22303 \begin_layout Plain Layout
22311 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22314 \begin_layout Plain Layout
22320 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22323 \begin_layout Plain Layout
22324 mixed revision working copy
22331 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22334 \begin_layout Plain Layout
22340 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22343 \begin_layout Plain Layout
22344 modified working copy
22351 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22354 \begin_layout Plain Layout
22360 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22363 \begin_layout Plain Layout
22364 switched working copy
22371 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22374 \begin_layout Plain Layout
22380 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22383 \begin_layout Plain Layout
22384 partial working copy, from a sparse checkout
22391 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22394 \begin_layout Plain Layout
22400 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22403 \begin_layout Plain Layout
22404 mixed revision, modified, switched working copy
22417 \begin_layout Itemize
22418 file revision information.
22419 The result comes from parsing the output of
22420 \begin_inset Flex Code
22423 \begin_layout Plain Layout
22425 \begin_inset space ~
22429 \begin_inset space ~
22433 \begin_inset space ~
22442 Supported flags are:
22446 \begin_layout Itemize
22447 version number of the last commit (
22448 \begin_inset Flex Code
22451 \begin_layout Plain Layout
22460 \begin_layout Itemize
22461 author of the last commit (
22462 \begin_inset Flex Code
22465 \begin_layout Plain Layout
22474 \begin_layout Itemize
22475 date of the last commit (
22476 \begin_inset Flex Code
22479 \begin_layout Plain Layout
22488 \begin_layout Itemize
22489 time of the last commit (
22490 \begin_inset Flex Code
22493 \begin_layout Plain Layout
22503 \begin_layout Standard
22504 You can obtain this info via InsetInfo (e.g.
22506 \begin_inset Flex Code
22509 \begin_layout Plain Layout
22510 info-insert buffer vcs-date
22516 The information will be available only when you have the file stored under
22517 svn managment (i.e.
22519 \begin_inset Flex Code
22522 \begin_layout Plain Layout
22528 directory is available with your document).
22532 \begin_layout Itemize
22533 Another—a hacking one—possibility is to use svn keywords
22537 \begin_layout Plain Layout
22538 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22544 In short – you set file keywords property (e.g.
22547 svn propset svn:keywords 'Rev' file.lyx
22549 ) and then paste keyword \SpecialChar TeX
22554 \begin_layout Plain Layout
22555 This is an easy way how to ensure that \SpecialChar LyX
22556 won't break the line in the middle
22562 tag in your document (e.g.
22567 \begin_layout Plain Layout
22575 This way svn client will automatically substitute revision number (e.g.
22580 \begin_layout Plain Layout
22587 ) after each update and commit.
22588 There are more problems with this approach.
22589 Firstly, the '$' character is used in \SpecialChar TeX
22590 world for math equations, so any
22591 occurence of math formula
22592 \begin_inset Formula $Rev$
22596 \begin_inset Formula $Rev:59$
22599 in your \SpecialChar LyX
22601 Similarly for other keywords like Id, Date, Author, etc.
22602 Secondly svn output is dependent on your locales, so its very easy that
22603 svn would produce some problematic strings once Date is used.
22604 Thirdly you get the whole 'Rev: 59' string in your document instead of
22606 Until subversion implements user's custom keywords it will be hard to use
22607 this approach reliably or let \SpecialChar LyX
22608 to support it directly.
22611 \begin_layout Subsection
22612 SVN and Windows Environment
22615 \begin_layout Quote
22616 My inclination is to say that if the user cannot figure out the command
22617 line operations on their own fairly quickly, they would be well advised
22618 to use TortoiseSVN.
22624 \begin_layout Subsubsection
22628 \begin_layout Standard
22629 In addition to installing \SpecialChar LyX
22630 , and having access to a Subversion repository,
22631 the user will need to install the Subversion client program.
22632 A Windows installer for the client program is available from
22633 \begin_inset CommandInset href
22636 target "http://www.collab.net/nonav/downloads/subversion/"
22642 The user may also want to install
22643 \begin_inset CommandInset href
22646 target "http://tortoisesvn.tigris.org/"
22651 , which integrates Subversion operations into the context (rightclick) menu
22652 of Windows Explorer.
22653 Operations done outside \SpecialChar LyX
22654 will typically be more convenient using the Explorer
22656 Note that TortoiseSVN is not a replacement for the client program, which
22657 is what \SpecialChar LyX
22661 \begin_layout Subsubsection
22662 Bringing a document under Subversion control
22665 \begin_layout Standard
22666 Before a \SpecialChar LyX
22667 document can be brought under version control in Subversion, its
22668 parent directory needs to be under version control.
22669 If the document is being added to a project already in the repository,
22670 this is accomplished by checking the project out to the directory where
22671 the new document will be placed.
22672 If the project itself is not yet under version control (for instance, if
22673 this document starts a new project), the directory must be imported into
22675 This is done outside \SpecialChar LyX
22677 Both import and checkout are easily accomplished from the Explorer context
22678 menu using TortoiseSVN, or alternatively can be done using the command
22679 line client at a DOS prompt.
22680 The procedure for importing the project using TortoiseSVN is described
22681 below, assuming an existing repository and a new project being started
22689 For information on using the Subversion client program, run
22696 \begin_layout Enumerate
22703 in Windows Explorer, right click it, and select
22705 TortoiseSVN\SpecialChar menuseparator
22709 If necessary, adjust the URL for the repository, then click OK.
22712 \begin_layout Enumerate
22713 Right click the level of the repository under which you want to place the
22714 new project folder (typically the top level) and click
22718 Supply a name for the project folder and click OK.
22719 Add a message for the log file if desired, then click OK again.
22720 The new project folder should appear in the repository.
22721 Finally, click OK again to exit the repository browser.
22724 \begin_layout Enumerate
22725 Once again right click
22731 , this time selecting SVN Checkout\SpecialChar ldots
22732 Select the URL of the project folder
22733 you just created in the repository, and set the checkout directory to
22741 You will be warned about a non-empty folder; click OK to proceed.
22742 You should now have a
22753 \begin_layout Enumerate
22754 Create or open your document in \SpecialChar LyX
22757 File\SpecialChar menuseparator
22759 \begin_inset space ~
22762 Control\SpecialChar menuseparator
22766 Add a log message and click OK to commit the document to version control.
22769 \begin_layout Standard
22770 From this point onward, you should have full functionality in the
22772 File\SpecialChar menuseparator
22774 \begin_inset space ~
22780 You also have the option of checking the document in and out, viewing its
22782 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22783 client program from a command prompt.
22786 \begin_layout Subsubsection
22787 SSH tunnel used with SVN under Windows
22790 \begin_layout Standard
22791 Compared with Linux setting up an svn client to communicate over ssh under
22792 Windows is a rather troublesome task.
22793 We will at least offer some hints how to setup the client side but prior
22794 knowledge about ssh and the Windows command line is needed, also be prepared
22795 for a great deal of frustration\SpecialChar ldots
22799 \begin_layout Enumerate
22800 Get an svn client for windows, as described in the previous sections.
22801 When it is a fresh install run some svn command (e.g.
22803 \begin_inset Flex Code
22806 \begin_layout Plain Layout
22812 ) to create config files, which you will need to change later on.
22815 \begin_layout Enumerate
22816 Choose an ssh client for Windows.
22817 There are several possibilities, we will use the one from Putty tools
22821 \begin_layout Plain Layout
22822 \begin_inset Flex URL
22825 \begin_layout Plain Layout
22827 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22838 You will need to set the connection up so that the client doesn't ask for
22839 any password from you.
22840 To keep things easy we will use only keys without any additional password
22845 \begin_layout Enumerate
22847 \begin_inset Flex Code
22850 \begin_layout Plain Layout
22857 Save your private .ppk key file and put the public one on the server side.
22858 If the SVN server runs on Linux, note that the format of the public key
22859 is not compatible with Linux openssh and you will need to direcly copy-paste
22862 Public key for pasting into OpenSSH authorized_keys file
22864 :” edit field into the server's
22865 \begin_inset Flex Code
22868 \begin_layout Plain Layout
22869 ~/.ssh/authorized_keys
22875 \begin_inset Flex Code
22878 \begin_layout Plain Layout
22887 \begin_layout Enumerate
22889 \begin_inset Flex Code
22892 \begin_layout Plain Layout
22899 In the SVN config file
22903 \begin_layout Plain Layout
22904 Exact path depends on Windows version, usually somewhere around
22905 \begin_inset Flex Code
22908 \begin_layout Plain Layout
22911 Documents and Settings
22925 \begin_inset Flex Code
22928 \begin_layout Plain Layout
22943 , section [tunnels], setup ssh command, e.g.
22945 \begin_inset Flex Code
22948 \begin_layout Plain Layout
22949 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22958 \begin_layout Plain Layout
22959 It will usually take a lot of time to get exact command right and it depends
22961 For example do not have some remote server saved as a default session in
22963 If things fail, try to connect via plink without SVN first.
22972 \begin_layout Enumerate
22973 Checkout the SVN archive, e.
22974 \begin_inset space \thinspace{}
22978 \begin_inset Newline newline
22982 \begin_inset Flex Code
22985 \begin_layout Plain Layout
22986 svn co svn+ssh://user@server/repository_path
22994 \begin_layout Subsubsection
22995 End-of-Line Conversions
22998 \begin_layout Standard
22999 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
23001 use different line endings inside the .lyx files.
23002 This is not a problem as far as \SpecialChar LyX
23003 functionality is concerned, but the commit
23004 diffs will be huge and merge-conflicts prone.
23005 Fortunately SVN itself knows
23009 \begin_layout Plain Layout
23010 \begin_inset Flex URL
23013 \begin_layout Plain Layout
23015 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
23025 how to deal with CR/LF problems when switching .lyx files to the
23026 \begin_inset Flex Code
23029 \begin_layout Plain Layout
23039 \begin_layout Plain Layout
23041 \begin_inset Flex Code
23044 \begin_layout Plain Layout
23045 svn propset svn:eol-style native FILE_NAME
23058 \begin_layout Subsection
23059 GIT commands in \SpecialChar LyX
23063 \begin_layout Standard
23064 A minimal subset of GIT commands is now supported by \SpecialChar LyX
23066 You can find the commands in the
23068 File\SpecialChar menuseparator
23070 \begin_inset space ~
23076 Please note that if you use password protected access to repository via
23077 ssh, you will be asked in terminal window.
23079 was tested against GIT 1.7.
23083 \begin_layout Plain Layout
23084 Windows users please note that you need to ensure that git is on the path.
23085 This can be set from within \SpecialChar LyX
23088 Tools\SpecialChar menuseparator
23089 Preferences\SpecialChar menuseparator
23090 Paths\SpecialChar menuseparator
23101 \begin_layout Standard
23102 One big difference of GIT and the other supported version control systems
23103 is the distributed nature of GIT: With traditional version control systems
23104 there is one central server which hosts the repository.
23105 Users commit their changes to the server, and get updates made by other
23107 With GIT, users commit to a local repository.
23108 The local repository can be synchronized with one or more remote repositories
23110 \begin_inset Flex Code
23113 \begin_layout Plain Layout
23120 \begin_inset Flex Code
23123 \begin_layout Plain Layout
23131 does not interact in any way with remote GIT repositories.
23132 It works exclusively with the local repository in a very similar way as
23133 with a central CVS or SVN repository.
23134 If you use remote GIT repositories you need to do the
23135 \begin_inset Flex Code
23138 \begin_layout Plain Layout
23145 \begin_inset Flex Code
23148 \begin_layout Plain Layout
23154 operations with your favourite GIT client.
23157 \begin_layout Subsubsection
23163 \begin_layout Standard
23164 If your document is not under revision control, this is the only item shown
23166 And if it is under revision control, the
23170 item is not visible.
23173 \begin_layout Standard
23174 This command registers in GIT your document ONLY in case you have already
23175 the documents directory under GIT control (in particular
23180 This means you have to checkout the archive by yourself.
23183 \begin_layout Standard
23184 Then you are asked interactively to supply an initial description of the
23186 Don't forget that registered file is not yet commited.
23189 \begin_layout Standard
23190 GIT command that is run:
23193 \begin_inset Quotes eld
23197 \begin_inset Quotes erd
23203 \begin_layout Standard
23208 to understand the switches.
23211 \begin_layout Subsubsection
23217 \begin_layout Standard
23218 When you are finished editing a file, you commit your changes.
23219 When you do this, you are asked for a description of the changes.
23220 After that changes are commited.
23223 \begin_layout Standard
23226 git commit -q -m"<description>" <file-name>
23229 \begin_layout Subsubsection
23232 Revert To Repository Version
23235 \begin_layout Standard
23236 This will discard all changes made to the document since the last check
23238 You get a warning before changes are discarded.
23241 \begin_layout Standard
23245 \begin_inset Quotes eld
23249 \begin_inset Quotes erd
23255 \begin_layout Subsubsection
23261 \begin_layout Standard
23262 This will rename the current document including the version history.
23263 It requires a clean document without any changes since the last checkin.
23264 You are asked for a file name and a description of the rename operation.
23265 After that the document is renamed, both locally and in the repository.
23266 If the parent directories of the new and old file names differ, all relative
23267 paths of included files are adjusted (like in
23269 File\SpecialChar menuseparator
23274 Finally, the document is reloaded using the new name.
23277 \begin_layout Labeling
23278 \labelwidthstring 00.00.0000
23280 \begin_inset space ~
23284 \begin_inset space ~
23288 \begin_inset Newline newline
23292 \begin_inset Flex Code
23295 \begin_layout Plain Layout
23299 \begin_inset Quotes eld
23303 \begin_inset Quotes erd
23307 \begin_inset Quotes eld
23311 \begin_inset Quotes erd
23320 \begin_inset Newline newline
23324 \begin_inset Flex Code
23327 \begin_layout Plain Layout
23336 \begin_layout Subsubsection
23342 \begin_layout Standard
23343 This shows the complete history of the GIT document.
23347 \begin_inset Quotes eld
23351 \begin_inset Quotes erd
23356 is shown in a browser.
23359 \begin_layout Subsubsection
23363 \begin_layout Standard
23365 supports GIT hash number of the last commit to the file, author name, date
23366 and time of last commit.
23367 All those are extracted from
23369 git log -n 1 --pretty=format:%H%n%an%n%ai
23372 Tree version information is obtained via
23374 git describe --abbrev --dirty --long
23378 \begin_inset CommandInset ref
23380 reference "subsec:VCS-Revision-Information"
23387 \begin_layout Subsection
23391 \begin_layout Standard
23392 With the recent addition of the vc-command function \SpecialChar LyX
23393 power users are allowed
23394 to create their own commands for revision control.
23397 \begin_layout Standard
23398 As an example you can see how two TortoiseSVN commands could be integrated
23402 \begin_layout Description
23404 \begin_inset Flex Code
23407 \begin_layout Plain Layout
23408 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23416 \begin_layout Description
23418 \begin_inset Flex Code
23421 \begin_layout Plain Layout
23422 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23430 \begin_layout Subsection
23431 Version control and Document comparison
23434 \begin_layout Standard
23435 One of the typical uses of version control is to inspect the changes between
23436 revisions, usually by creating
23437 \begin_inset Flex Code
23440 \begin_layout Plain Layout
23447 While this is useful for plain text files, it is much less useful in the
23448 case of \SpecialChar LyX
23449 files, which have more a complicated structure.
23450 Hence we provide binding to the Document comparison feature.
23451 There are two ways of calling this feature - either by direct call of
23452 \begin_inset Flex Code
23455 \begin_layout Plain Layout
23462 function (for details see \SpecialChar LyX
23463 functions manual) or by icon/menu item
23464 \begin_inset Flex Noun
23467 \begin_layout Plain Layout
23468 Compare with older revision...
23474 One can either compare two chosen revisions of the document or he can simply
23475 compare the current version of edited text with older revisions (where
23477 \begin_inset Flex Noun
23480 \begin_layout Plain Layout
23486 ' revisions back means comparison of the edited file with last commited
23491 \begin_layout Standard
23492 This feature is supported for SVN and RCS though due to the more complicated
23493 versioning scheme of RCS there is a constraint – when addressing the revisions
23494 in dialog, numbers always point to the last number in RCS revision number,
23497 We don't currently support GIT addressing of revisions, one can just compare
23498 edited document with its revision X steps backs, where X is addressed as
23502 \begin_layout Section
23503 Literate Programming
23506 \begin_layout Standard
23511 (kayvan@sylvan.com)
23515 original documentation written by
23517 Edmar Wienskoski Jr.
23520 (edmar-w-jr@technologist.com)
23523 \begin_layout Subsection
23527 \begin_layout Standard
23528 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23530 programming, where it is assumed that you are familiar with this programming
23531 technique, and know what
23532 \begin_inset Quotes eld
23536 \begin_inset Quotes erd
23540 \begin_inset Quotes eld
23544 \begin_inset Quotes erd
23548 If that is not the case, please follow the web links provided in the following
23550 There is a lot of good documentation out there covering old development
23551 history to the latest tools tips.
23554 \begin_layout Standard
23555 It is also assumed that you are familiar with \SpecialChar LyX
23556 itself to a point that you
23557 are comfortable changing your \SpecialChar LyX
23558 preferences, and X resources file.
23559 If that is not the case please refer to other \SpecialChar LyX
23560 documentation to cover your
23564 \begin_layout Subsection
23565 Literate Programming
23568 \begin_layout Standard
23569 From the Literate Programming FAQ:
23572 \begin_layout Quotation
23573 Literate programming is the combination of documentation and source together
23574 in a fashion suited for reading by human beings.
23575 In fact, literate programs should be enjoyable reading, even inviting!
23576 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23577 and documentation in a single file.
23578 Literate programming tools then parse the file to produce either readable
23579 documentation or compilable source.
23580 The WEB style of literate programming was created by D.
23581 \begin_inset space \thinspace{}
23585 Knuth during the development of his \SpecialChar TeX
23586 typesetting software.
23590 \begin_layout Standard
23591 Another excerpt says:
23594 \begin_layout Quotation
23597 How is literate programming different from verbose commenting?
23600 \begin_layout Quotation
23601 There are three distinguishing characteristics.
23602 In order of importance, they are:
23606 \begin_layout Itemize
23607 flexible order of elaboration
23610 \begin_layout Itemize
23611 automatic support for browsing
23614 \begin_layout Itemize
23615 typeset documentation, especially diagrams and mathematics
23619 \begin_layout Standard
23620 Now that I sparked your curiosity, take a look in the references.
23623 \begin_layout Subsubsection
23627 \begin_layout Standard
23628 The complete Literate Programming FAQ can be found at:
23631 \begin_layout Quote
23632 Literate Programming FAQ
23633 \begin_inset Flex URL
23636 \begin_layout Plain Layout
23638 http://www.literateprogramming.com/lpfaq.pdf
23646 \begin_layout Standard
23647 The FAQ lists 23 (twenty three!) different literate programming tools.
23648 Where some are specialized or
23649 \begin_inset Quotes eld
23653 \begin_inset Quotes erd
23656 for particular programming languages, while other have general scope.
23661 for my own use for several reasons:
23664 \begin_layout Itemize
23665 It can generate the documentation either in \SpecialChar LaTeX
23669 \begin_layout Itemize
23670 It has a open architecture, i.
23671 \begin_inset space \thinspace{}
23675 \begin_inset space \space{}
23678 it is easy to plug in new filters and to perform special processing that
23683 \begin_layout Itemize
23684 There is a good selection of filters available already (the HTML is one
23688 \begin_layout Itemize
23692 \begin_layout Standard
23693 The Noweb web page can be found at:
23696 \begin_layout Quote
23698 \begin_inset Flex URL
23701 \begin_layout Plain Layout
23703 http://www.cs.virginia.edu/~nr/noweb/
23711 \begin_layout Standard
23712 Starting from there you can reach many other interesting links and even
23713 some literate program examples.
23716 \begin_layout Subsection
23718 and Literate Programming with Noweb
23721 \begin_layout Standard
23722 The \SpecialChar LyX
23723 support for Literate Programming is provided by using the generic \SpecialChar LyX
23725 converters mechanism.
23726 This support is provided in a
23727 \begin_inset Quotes eld
23731 \begin_inset Quotes erd
23735 \begin_inset space \thinspace{}
23739 \begin_inset space \space{}
23742 you will be able to use this new \SpecialChar LyX
23743 feature with some other literate programming
23744 tool of your choice by just changing your \SpecialChar LyX
23748 \begin_layout Subsubsection
23749 Generating documents and code (weaving and tangling)
23752 \begin_layout Paragraph
23753 Using the noweb module
23756 \begin_layout Standard
23757 If you have installed Noweb and \SpecialChar LyX
23758 successfully, whenever you open a new document,
23759 after you have chosen its document class, use the Document->Settings menu
23761 \begin_inset Quotes eld
23765 \begin_inset Quotes erd
23769 If Noweb is correctly installed, when you click on the
23770 \begin_inset Quotes eld
23774 \begin_inset Quotes erd
23777 link, you will see the
23778 \begin_inset Quotes eld
23782 \begin_inset Quotes erd
23785 module in the available list and you can add it to your document.
23788 \begin_layout Paragraph
23792 \begin_layout Standard
23794 enables you to write code with a layout named
23795 \begin_inset Flex Noun
23798 \begin_layout Plain Layout
23805 Noweb delimits chunks like this:
23808 \begin_layout LyX-Code
23812 \begin_layout LyX-Code
23816 \begin_layout LyX-Code
23820 \begin_layout LyX-Code
23824 \begin_layout LyX-Code
23828 \begin_layout Standard
23829 The problem is that whatever is written in between the << and the
23833 must be taken literally, i.
23834 \begin_inset space \thinspace{}
23838 \begin_inset space \space{}
23842 should be prevented from making any special interpretation of what has
23844 This is also handled by
23845 \begin_inset Flex Noun
23848 \begin_layout Plain Layout
23854 , that works like a normal paragraph but has a free spacing capability.
23857 \begin_layout Standard
23858 As a special note, you can also use the
23859 \begin_inset Quotes eld
23863 \begin_inset Quotes erd
23866 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23870 \begin_layout LyX-Code
23874 \begin_layout LyX-Code
23875 def some_function(args):
23878 \begin_layout LyX-Code
23879 "This is the doc string for this function."
23882 \begin_layout LyX-Code
23883 print "My args: ", args
23886 \begin_layout LyX-Code
23887 @ %def some_function
23890 \begin_layout Standard
23891 For an example of this usage and the resulting cross-reference output, look
23892 at the Literate python program in
23894 LIBDIR/examples/listerrors.lyx
23896 which should make this all clear.
23899 \begin_layout Paragraph
23900 Generating the documentation
23903 \begin_layout Standard
23904 At this point you already have a new document file with a proper document
23905 class, and with some code and text on it.
23906 How do I print it? The answer is simple, you select
23908 View\SpecialChar menuseparator
23912 Just like you would do for a plain document.
23913 No special procedure is required.
23916 \begin_layout Standard
23917 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23921 \begin_layout Enumerate
23924 Update\SpecialChar menuseparator
23927 menu option is chosen, a \SpecialChar LaTeX
23933 \begin_layout Standard
23934 If the document is of any literate class the generated file will be named
23935 with an extension name defined by the
23936 \begin_inset Quotes eld
23940 \begin_inset Quotes erd
23943 format (defined in the Preferences panel), otherwise the file will have
23952 \begin_layout Enumerate
23953 Note that the only difference so far is in the name of the file, no special
23954 processing is required by \SpecialChar LyX
23956 Given that you formatted the code using the
23957 \begin_inset Flex Noun
23960 \begin_layout Plain Layout
23966 layout that, by itself, takes care of the business.
23969 \begin_layout Enumerate
23970 If the document is of any literate class \SpecialChar LyX
23971 will then use the internal \SpecialChar LyX
23973 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23978 \begin_layout Plain Layout
23979 The converters are defined in the
23981 Tools\SpecialChar menuseparator
23985 \begin_inset Quotes eld
23989 \begin_inset Quotes erd
24001 manual for general information about converters.
24006 to generate the \SpecialChar LaTeX
24011 \begin_layout Standard
24012 Otherwise it will just skip this step.
24016 \begin_layout Enumerate
24017 Finally, \SpecialChar LaTeX
24018 is invoked and the regular post processing continues as in a plain
24022 \begin_layout Standard
24023 Independence from a particular
24024 \begin_inset Quotes eld
24028 \begin_inset Quotes erd
24031 is easily achieved by changing the commands that are run by the various
24035 \begin_layout Paragraph
24036 Generating the code
24039 \begin_layout Standard
24040 When the build menu option is chosen or the corresponding button in the
24041 toolbar is pressed, a \SpecialChar LaTeX
24042 file is generated just like step 1 above.
24043 Next, \SpecialChar LyX
24049 This converter needs to be defined by the user and is not installed by
24050 default, though the Program format is.
24051 This converter (like any other converter) will have two parts:
24054 \begin_layout Enumerate
24055 The converter program itself.
24056 This program performs the conversion from the one format to the other (in
24057 this case, from the Noweb format to the Program pseudo-format).
24060 \begin_layout Enumerate
24061 The error log parser.
24062 This is a program whose sole purpose is to rewrite error messages in a
24063 format that \SpecialChar LyX
24065 This makes it possible for \SpecialChar LyX
24066 to place error boxes in the right places in
24070 \begin_layout Standard
24071 The first part, the
24072 \begin_inset Quotes eld
24076 \begin_inset Quotes erd
24079 setting, should be set to
24080 \begin_inset Newline newline
24084 \begin_inset Quotes eld
24092 \begin_inset Quotes erd
24096 \begin_inset Newline newline
24099 This basically means that \SpecialChar LyX
24101 \begin_inset Quotes eld
24105 \begin_inset Quotes erd
24108 (a program or script) with the name of the Noweb file (normally a file
24109 in the \SpecialChar LyX
24110 temp directory) and the directory path of the original \SpecialChar LyX
24115 \begin_layout Standard
24116 This is an implementation of
24117 \begin_inset Quotes eld
24121 \begin_inset Quotes erd
24124 that you can place in a directory on your path:
24127 \begin_layout Standard
24128 \begin_inset VSpace defskip
24134 \begin_layout Standard
24135 \begin_inset Newpage pagebreak
24141 \begin_layout Standard
24147 \begin_layout Standard
24153 \begin_layout Standard
24156 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
24159 \begin_layout Standard
24160 \begin_inset VSpace defskip
24166 \begin_layout Standard
24167 The next part of the converter setting is the
24168 \begin_inset Quotes eld
24172 \begin_inset Quotes erd
24175 which is to be set to
24176 \begin_inset Newline newline
24180 \begin_inset Quotes eld
24185 parselog=$$s/scripts/listerrors
24188 \begin_inset Quotes erd
24192 \begin_inset Newline newline
24195 This will run any errors that are generated by the
24196 \begin_inset Quotes eld
24200 \begin_inset Quotes erd
24203 process through the
24204 \begin_inset Quotes eld
24208 \begin_inset Quotes erd
24214 \begin_layout Standard
24215 The build will normally take place in \SpecialChar LyX
24216 's temporary directory, so the files
24217 produced by the conversion will be in that directory.
24219 will copy out what it regards as the `main' file, but the
24223 conversion may produce several files, and so most of these would then be
24224 deleted when \SpecialChar LyX
24226 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
24227 the build-script chunk can place the generated files in that location.
24230 \begin_layout Paragraph
24231 Build instructions in the document
24234 \begin_layout Standard
24235 The last piece of the integration between \SpecialChar LyX
24237 \begin_inset Quotes eld
24241 \begin_inset Quotes erd
24245 Generally, the instructions for building your program should be embedded
24246 in a chunk of its own.
24248 \begin_inset Quotes eld
24252 \begin_inset Quotes erd
24255 above uses the notangle command to look for this chunk (called
24256 \begin_inset Quotes eld
24260 \begin_inset Quotes erd
24263 ) and runs its contents through
24264 \begin_inset Quotes eld
24268 \begin_inset Quotes erd
24274 \begin_layout Standard
24275 Typically, such a chunk would look something like this:
24278 \begin_layout LyX-Code
24282 \begin_layout LyX-Code
24284 \begin_inset Newline newline
24287 if [ -z "${NOWEB_SOURCE}" ]
24288 \begin_inset Newline newline
24294 \begin_layout LyX-Code
24295 NOWEB_SOURCE=myfile.nw
24296 \begin_inset Newline newline
24300 \begin_inset Newline newline
24304 code to extract files ...
24305 use NOWEB_OUTPUT_DIR here ...]
24306 \begin_inset Newline newline
24310 code to compile files ...]
24311 \begin_inset Newline newline
24317 \begin_layout Standard
24320 LIBDIR/examples/listerrors.lyx
24324 LIBDIR/examples/Literate.lyx
24326 which implement two versions of the
24327 \begin_inset Quotes eld
24331 \begin_inset Quotes erd
24334 program for some illustrations of how all of these pieces go together or
24337 LIBDIR/examples/noweb2lyx.lyx.
24340 Interestingly, these three files show off the language-indepence of the
24342 literate programming support since they are written in Python, C and Perl
24346 \begin_layout Subsubsection
24347 Configuring \SpecialChar LyX
24351 \begin_layout Standard
24352 All the Literate Programming support is configured by the
24354 Tools\SpecialChar menuseparator
24358 \begin_inset Quotes eld
24362 \begin_inset Quotes erd
24366 The important parts are:
24369 \begin_layout Description
24371 \begin_inset space ~
24375 \begin_inset Quotes eld
24379 \begin_inset Quotes erd
24383 \begin_inset space ~
24386 format Set up via the File Formats tab, this is where the Noweb-specific
24396 , the file extension is set to
24401 This tells \SpecialChar LyX
24402 to create a file with a
24406 extension in the first step of the conversion process.
24409 \begin_layout Description
24411 \begin_inset space ~
24419 \begin_inset space ~
24422 format This is an empty format whose sole purpose is to be the endpoint
24423 of a conversion (which then allows us to set up a converter for it).
24426 \begin_layout Description
24436 This converter performs the
24437 \begin_inset Quotes eld
24441 \begin_inset Quotes erd
24444 of the literate document.
24445 For Noweb, it is set to
24446 \begin_inset Quotes eld
24451 noweave -delay -index $$i > $$o
24454 \begin_inset Quotes erd
24460 \begin_layout Description
24470 \begin_inset Quotes eld
24474 \begin_inset Quotes erd
24478 As stated above, the Converter is set to
24479 \begin_inset Quotes eld
24487 \begin_inset Quotes erd
24490 , with Flags set to
24491 \begin_inset Newline newline
24495 \begin_inset Quotes eld
24500 parselog=$$s/scripts/listerrors
24503 \begin_inset Quotes erd
24509 \begin_layout Subsubsection
24513 \begin_layout Standard
24514 There is also a new function implemented in the \SpecialChar LyX
24516 \begin_inset Quotes eld
24519 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24523 \begin_layout Standard
24524 When debugging code with ddd/gdb, it is possible to invoke a text editor
24525 at the current execution position with a single key stroke.
24526 The default ddd configuration for that is shift-ctrl-V.
24527 It happens that you can define the editor command line invocation in ddd
24530 Edit\SpecialChar menuseparator
24531 Preferences\SpecialChar menuseparator
24534 dialog and changing the "Edit Sources" entry.
24537 \begin_layout Standard
24538 I take advantage of the newly created \SpecialChar LyX
24539 server function and this ddd feature,
24541 \begin_inset Quotes eld
24545 \begin_inset Quotes erd
24551 \begin_layout Standard
24552 \begin_inset VSpace defskip
24558 \begin_layout Standard
24561 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24564 \begin_layout Standard
24565 \begin_inset VSpace defskip
24571 \begin_layout Standard
24572 With this, whenever you are using ddd and find a point in the program that
24573 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24574 ddd will forward this information to \SpecialChar LyX
24575 through the \SpecialChar LyX
24576 server and then the
24578 window will show the same file with the cursor at the same position ddd
24580 No more guessing or long scrolling to locate a point in the program back
24584 \begin_layout Standard
24585 Note however that you must enable the \SpecialChar LyX
24586 server to get this feature working
24587 (it is disabled by default).
24588 You can enable it in
24600 ) by entering in the
24606 \begin_inset Quotes eld
24611 /home/<your-home-directory>/.lyx/lyxpipe
24614 \begin_inset Quotes erd
24620 \begin_layout Standard
24621 Read the \SpecialChar LyX
24622 server documentation in the
24624 Customization Manual
24626 for further information.
24629 \begin_layout Subsubsection
24633 \begin_layout Standard
24634 There are six new buttons that can be added to your \SpecialChar LyX
24636 Five of these buttons are short cuts to layout styles:
24659 The last one is a short cut to the
24660 \begin_inset Quotes eld
24664 \begin_inset Quotes erd
24671 \begin_layout Standard
24673 has a range of buttons that are available for tool bar customization.
24674 In my toolbar I like to combine the six short cuts above with two more:
24679 \SpecialChar menuseparator
24684 \SpecialChar menuseparator
24691 Document\SpecialChar menuseparator
24692 View\SpecialChar menuseparator
24696 Here is how it looks like:
24699 \begin_layout LyX-Code
24703 \begin_layout LyX-Code
24707 \begin_layout LyX-Code
24708 Icon "layout Standard"
24711 \begin_layout LyX-Code
24712 Icon "layout Section"
24715 \begin_layout LyX-Code
24716 Icon "layout \SpecialChar LaTeX
24720 \begin_layout LyX-Code
24721 Icon "layout \SpecialChar LyX
24725 \begin_layout LyX-Code
24726 Icon "layout Chunk"
24729 \begin_layout LyX-Code
24733 \begin_layout LyX-Code
24737 \begin_layout LyX-Code
24738 Icon "buffer-typeset"
24741 \begin_layout LyX-Code
24742 Icon "build-program"
24745 \begin_layout LyX-Code
24749 \begin_layout LyX-Code
24753 \begin_layout LyX-Code
24757 \begin_layout LyX-Code
24761 \begin_layout LyX-Code
24765 \begin_layout Subsubsection
24766 Colors customization
24769 \begin_layout Standard
24770 There are a number of colors in \SpecialChar LyX
24771 that can be customized in
24776 One of the things that bothers people is the \SpecialChar LaTeX
24778 The default color is red, since the chunks uses \SpecialChar LaTeX
24779 font, and there is a lot
24780 of chunks in literate documents, you may get tired of seeing everything
24782 You can change it by going to the tabs
24791 \begin_layout Standard
24792 The next thing is the visible presence of the newline character in the screen.
24793 You can choose the color of this particular character and make it blend
24795 I recommend you choosing a color that is close to the background but not
24796 equal, that way you still can see it is there, but it is not bothering
24800 \begin_layout Subsection
24805 \begin_layout Standard
24814 is documented in the
24818 example file and in the Sweave manual (menu
24820 Help\SpecialChar menuseparator
24826 \begin_layout Chapter
24830 \begin_layout Standard
24831 You can do everything with \SpecialChar LyX
24832 that you can do with \SpecialChar LaTeX
24834 However, \SpecialChar LyX
24835 cannot support every \SpecialChar LaTeX
24837 But you can always use \SpecialChar TeX
24839 This chapter shows you some more special things you might want to use.
24840 For other special things you can do with figures, tables, floats, boxes
24841 and notes, have a look at the
24844 \begin_inset space ~
24852 \begin_layout Section
24853 Multiple Text Columns
24856 \begin_layout Standard
24857 This feature is independent of the option
24859 Two-column document
24861 in the document settings under
24866 If you want to have 2
24867 \begin_inset space ~
24870 columns for the whole document, it is recommended to use the
24872 Two-column document
24875 For all other cases use this feature.
24878 \begin_layout Standard
24879 To use multiple text columns in your document, you have to load the module
24886 Document\SpecialChar menuseparator
24887 Settings\SpecialChar menuseparator
24890 ) and must have the \SpecialChar LaTeX
24898 \begin_layout Standard
24899 Footnotes within multiple columns will be placed at the bottom of the page
24900 and not under each column.
24901 Within the different columns you can use everything, with the limitation
24902 that for floats you need to use the float option
24909 \begin_layout Subsection
24913 \begin_layout Standard
24914 If you want to have 2
24915 \begin_inset space ~
24918 columns in your text, insert a multicolumn inset via the menu
24920 Insert\SpecialChar menuseparator
24922 \begin_inset space ~
24925 Insets\SpecialChar menuseparator
24927 \begin_inset space ~
24932 where the columns should start.
24933 Write all text that should be printed in 2
24934 \begin_inset space ~
24937 columns into this inset.
24940 \begin_layout Standard
24941 Here is an example:
24944 \begin_layout Standard
24946 \begin_inset Flex Multiple Columns
24949 \begin_layout Plain Layout
24954 The Adventure of the Empty House
24957 \begin_inset Newline newline
24960 by Sir Arthur Conan Doyle
24963 \begin_layout Plain Layout
24966 It was in the spring of the year 1894 that all London was interested, and
24967 the fashionable world dismayed, by the murder of the Honourable Ronald
24968 Adair under most unusual and inexplicable circumstances.
24969 The public has already learned those particulars of the crime which came
24970 out in the police investigation, but a good deal was suppressed upon that
24971 occasion, since the case for the prosecution was so overwhelmingly strong
24972 that it was not necessary to bring forward all the facts.
24973 Only now, at the end of nearly ten years, am I allowed to supply those
24974 missing links which make up the whole of that remarkable chain.
24975 The crime was of interest in itself, but that interest was as nothing to
24976 me compared to the inconceivable sequel, which afforded me the greatest
24977 shock and surprise of any event in my adventurous life.
24978 Even now, after this long interval, I find myself thrilling as I think
24979 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24980 ty which utterly submerged my mind.
24981 Let me say to that public, which has shown some interest in those glimpses
24982 which I have occasionally given them of the thoughts and actions of a very
24983 remarkable man, that they are not to blame me if I have not shared my knowledge
24984 with them, for I should have considered it my first duty to do so, had
24985 I not been barred by a positive prohibition from his own lips, which was
24986 only withdrawn upon the third of last month.
24994 \begin_layout Standard
24995 To get 3 or more columns, set the cursor into the multicolumn inset and
24998 Insert\SpecialChar menuseparator
25000 \begin_inset space ~
25004 \begin_inset space ~
25010 The number of the desired columns is written into that inset (for 3
25011 \begin_inset space ~
25015 \begin_inset Quotes eld
25019 \begin_inset Quotes erd
25023 \begin_inset Newline newline
25026 Here is an example with 3
25027 \begin_inset space ~
25033 \begin_layout Standard
25034 \begin_inset Flex Multiple Columns
25037 \begin_layout Plain Layout
25040 \begin_inset Argument 1
25043 \begin_layout Plain Layout
25049 It can be imagined that my close intimacy with Sherlock Holmes had interested
25050 me deeply in crime, and that after his disappearance I never failed to
25051 read with care the various problems which came before the public.
25052 And I even attempted, more than once, for my own private satisfaction,
25053 to employ his methods in their solution, though with indifferent success.
25054 There was none, however, which appealed to me like this tragedy of Ronald
25056 As I read the evidence at the inquest, which led up to a verdict of willful
25057 murder against some person or persons unknown, I realized more clearly
25058 than I had ever done the loss which the community had sustained by the
25059 death of Sherlock Holmes.
25060 There were points about this strange business which would, I was sure,
25061 have specially appealed to him, and the efforts of the police would have
25062 been supplemented, or more probably anticipated, by the trained observation
25063 and the alert mind of the first criminal agent in Europe.
25064 All day, as I drove upon my round, I turned over the case in my mind and
25065 found no explanation which appeared to me to be adequate.
25066 At the risk of telling a twice-told tale, I will recapitulate the facts
25067 as they were known to the public at the conclusion of the inquest.
25075 \begin_layout Standard
25076 You can have up to 10
25077 \begin_inset space ~
25080 columns if you want to, but that might not be very pleasant for the readers
25084 \begin_layout Standard
25085 \begin_inset Newpage newpage
25091 \begin_layout Subsection
25092 Columns inside Columns
25095 \begin_layout Standard
25096 You can also have columns inside columns:
25099 \begin_layout Standard
25100 \begin_inset Flex Multiple Columns
25103 \begin_layout Plain Layout
25106 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
25107 at that time governor of one of the Australian colonies.
25108 Adair's mother had returned from Australia to undergo the operation for
25109 cataract, and she, her son Ronald, and her daughter Hilda were living together
25113 \begin_layout Plain Layout
25114 \begin_inset Flex Multiple Columns
25117 \begin_layout Plain Layout
25120 The youth moved in the best society–had, so far as was known, no enemies
25121 and no particular vices.
25122 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
25123 had been broken off by mutual consent some months before, and there was
25124 no sign that it had left any very profound feeling behind it.
25125 For the rest {sic} the man's life moved in a narrow and conventional circle,
25126 for his habits were quiet and his nature unemotional.
25127 Yet it was upon this easy-going young aristocrat that death came, in most
25128 strange and unexpected form, between the hours of ten and eleven-twenty
25129 on the night of March 30, 1894.
25137 \begin_layout Plain Layout
25140 Ronald Adair was fond of cards–playing continually, but never for such stakes
25142 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
25143 It was shown that, after dinner on the day of his death, he had played
25144 a rubber of whist at the latter club.
25145 He had also played there in the afternoon.
25150 The evidence of those who had played with him– Mr.
25151 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
25152 and that there was a fairly equal fall of the cards.
25153 Adair might have lost five pounds, but not more.
25154 His fortune was a considerable one, and such a loss could not in any way
25156 He had played nearly every day at one club or other, but he was a cautious
25157 player, and usually rose a winner.
25158 It came out in evidence that, in partnership with Colonel Moran, he had
25159 actually won as much as four hundred and twenty pounds in a sitting, some
25160 weeks before, from Godfrey Milner and Lord Balmoral.
25161 So much for his recent history as it came out at the inquest.
25169 \begin_layout Subsection
25173 \begin_layout Standard
25174 The examples in this section show some more special features of multiple
25178 \begin_layout Standard
25179 For more features of multiple columns, have a look at the documentation
25180 of the \SpecialChar LaTeX
25186 \begin_inset CommandInset citation
25196 \begin_layout Subsubsection
25200 \begin_layout Standard
25201 To add a preface text for multiple columns, set the cursor into the multicolumn
25202 inset and use the menu
25204 Insert\SpecialChar menuseparator
25208 Write your preface text into that inset.
25209 \begin_inset Newline newline
25212 This is an example with some preface text:
25215 \begin_layout Standard
25216 \begin_inset VSpace bigskip
25222 \begin_layout Standard
25223 \begin_inset Flex Multiple Columns
25226 \begin_layout Plain Layout
25227 \begin_inset Argument 2
25230 \begin_layout Plain Layout
25231 And the story continues and continues and continues and continues\SpecialChar ldots
25239 On the evening of the crime, he returned from the club exactly at ten.
25240 His mother and sister were out spending the evening with a relation.
25241 The servant deposed that she heard him enter the front room on the second
25242 floor, generally used as his sitting-room.
25243 She had lit a fire there, and as it smoked she had opened the window.
25244 No sound was heard from the room until eleven-twenty, the hour of the return
25245 of Lady Maynooth and her daughter.
25246 Desiring to say good-night, she attempted to enter her son's room.
25247 The door was locked on the inside, and no answer could be got to their
25248 cries and knocking.
25249 Help was obtained, and the door forced.
25250 The unfortunate young man was found lying near the table.
25251 His head had been horribly mutilated by an expanding revolver bullet, but
25252 no weapon of any sort was to be found in the room.
25260 \begin_layout Standard
25261 You can also use a section heading as the preface if you use a section command
25262 as \SpecialChar TeX
25264 For example the command
25267 \begin_layout Standard
25272 subsection{subsection title}
25275 \begin_layout Standard
25276 creates a subsection.
25277 In this example the preface is a subsubsection:
25280 \begin_layout Standard
25281 \begin_inset Flex Multiple Columns
25284 \begin_layout Plain Layout
25285 \begin_inset Argument 2
25288 \begin_layout Plain Layout
25292 \begin_layout Plain Layout
25301 This is a subsubsection heading as a preface
25305 \begin_layout Plain Layout
25319 A minute examination of the circumstances served only to make the case more
25321 In the first place, no reason could be given why the young man should have
25322 fastened the door upon the inside.
25323 There was the possibility that the murderer had done this, and had afterwards
25324 escaped by the window.
25325 The drop was at least twenty feet, however, and a bed of crocuses in full
25327 Neither the flowers nor the earth showed any sign of having been disturbed,
25328 nor were there any marks upon the narrow strip of grass which separated
25329 the house from the road.
25330 Apparently, therefore, it was the young man himself who had fastened the
25332 But how did he come by his death? No one could have climbed up to the window
25333 without leaving traces.
25334 Suppose a man had fired through the window, he would indeed be a remarkable
25335 shot who could with a revolver inflict so deadly a wound.
25336 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25337 a hundred yards of the house.
25338 No one had heard a shot.
25346 \begin_layout Standard
25347 If there is less vertical space than 6
25348 \begin_inset space ~
25351 text lines is left on the page at the beginning of the multiple columns,
25352 a page break will be inserted before the multiple columns.
25353 Depending on the number of lines of the preface text, you might want to
25355 This is done by setting the cursor into the mulitcolumn inset behind the
25356 preface (if there is any) and using the menu
25358 Insert\SpecialChar menuseparator
25360 \begin_inset space ~
25364 \begin_inset space ~
25368 \begin_inset space ~
25374 Insert into that inset the amount of space like e.
25375 \begin_inset space \thinspace{}
25379 \begin_inset space \space{}
25383 \begin_inset Quotes eld
25387 \begin_inset Quotes erd
25391 \begin_inset Newline newline
25394 In this example the space is set to 7
25395 \begin_inset space ~
25398 text lines by using
25399 \begin_inset Quotes eld
25405 \begin_inset Quotes erd
25414 needs to be inserted as \SpecialChar TeX
25418 \begin_layout Standard
25419 \begin_inset Flex Multiple Columns
25422 \begin_layout Plain Layout
25423 \begin_inset Argument 3
25426 \begin_layout Plain Layout
25431 \begin_layout Plain Layout
25447 On the evening of the crime, he returned from the club exactly at ten.
25448 His mother and sister were out spending the evening with a relation.
25449 The servant deposed that she heard him enter the front room on the second
25450 floor, generally used as his sitting-room.
25451 She had lit a fire there, and as it smoked she had opened the window.
25452 No sound was heard from the room until eleven-twenty, the hour of the return
25453 of Lady Maynooth and her daughter.
25454 Desiring to say good-night, she attempted to enter her son's room.
25455 The door was locked on the inside, and no answer could be got to their
25456 cries and knocking.
25457 Help was obtained, and the door forced.
25458 The unfortunate young man was found lying near the table.
25459 His head had been horribly mutilated by an expanding revolver bullet, but
25460 no weapon of any sort was to be found in the room.
25468 \begin_layout Subsubsection
25472 \begin_layout Standard
25473 The amount of space before and after multiple columns can be changed by
25474 changing the length
25481 For example the command
25484 \begin_layout Standard
25494 \begin_layout Standard
25495 in \SpecialChar TeX
25496 Code changes its value to 3
25497 \begin_inset space \thinspace{}
25501 The change must be made before the multiple columns' start.
25502 The predefined value is 13
25503 \begin_inset space \thinspace{}
25509 \begin_layout Standard
25517 \begin_inset space \thinspace{}
25523 \begin_layout Standard
25527 \begin_layout Plain Layout
25533 multicolsep}{2.5cm}
25541 \begin_layout Standard
25542 \begin_inset Flex Multiple Columns
25545 \begin_layout Plain Layout
25548 All day I turned these facts over in my mind, endeavouring to hit upon some
25549 theory which could reconcile them all, and to find that line of least resistanc
25550 e which my poor friend had declared to be the starting-point of every investigat
25552 I confess that I made little progress.
25553 In the evening I strolled across the Park, and found myself about six o'clock
25554 at the Oxford Street end of Park Lane.
25555 A group of loafers upon the pavements, all staring up at a particular window,
25556 directed me to the house which I had come to see.
25557 A tall, thin man with coloured glasses, whom I strongly suspected of being
25558 a plain-clothes detective, was pointing out some theory of his own, while
25559 the others crowded round to listen to what he said.
25560 I got as near him as I could, but his observations seemed to me to be absurd,
25561 so I withdrew again in some disgust.
25562 As I did so I struck against an elderly, deformed man, who had been behind
25563 me, and I knocked down several books which he was carrying.
25571 \begin_layout Standard
25572 \begin_inset Note Greyedout
25575 \begin_layout Plain Layout
25580 The values you set with
25586 will be used for all following multiple columns until you change them again.
25594 \begin_layout Standard
25598 \begin_layout Plain Layout
25610 \begin_inset Note Note
25613 \begin_layout Plain Layout
25614 go back to the default
25622 \begin_layout Standard
25623 \begin_inset Newpage newpage
25629 \begin_layout Subsubsection
25633 \begin_layout Standard
25634 A column break can be forced by inserting the command
25640 as \SpecialChar TeX
25641 Code to that position in the text where the column should be broken.
25642 Note that this leads in most cases to whitespace in the text.
25643 \begin_inset Newline newline
25646 Here is an example:
25649 \begin_layout Standard
25650 \begin_inset Flex Multiple Columns
25653 \begin_layout Plain Layout
25656 \begin_inset Quotes eld
25659 You're surprised to see me, sir,
25660 \begin_inset Quotes erd
25663 said he, in a strange, croaking voice.
25666 \begin_layout Plain Layout
25669 I acknowledged that I was.
25672 \begin_layout Plain Layout
25675 \begin_inset Quotes eld
25678 Well, I've a conscience, sir, and when I chanced to see you go into this
25679 house, as I came hobbling after you, I thought to myself, I'll just step
25680 in and see that kind gentleman, and tell him that if I was a bit gruff
25681 in my manner there was not any harm meant, and that I am much obliged to
25682 him for picking up my books.
25683 \begin_inset Quotes erd
25689 \begin_layout Plain Layout
25692 \begin_inset Quotes eld
25695 You make too much of a trifle,
25696 \begin_inset Quotes erd
25701 \begin_inset Quotes eld
25704 May I ask how you knew who I was?
25705 \begin_inset Quotes erd
25708 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25712 \begin_layout Plain Layout
25724 \begin_layout Plain Layout
25727 \begin_inset Quotes eld
25730 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25731 you'll find my little bookshop at the corner of Church Street, and very
25732 happy to see you, I am sure.
25733 Maybe you collect yourself, sir.
25737 \begin_inset space ~
25750 –a bargain, every one of them.
25751 With five volumes you could just fill that gap on that second shelf.
25752 It looks untidy, does it not, sir?
25753 \begin_inset Quotes erd
25764 \begin_layout Subsubsection
25768 \begin_layout Standard
25769 The width of the columns is automatically calculated, but you can modify
25770 the space between the columns.
25771 This is done by changing the length
25778 Its predefined value is 10
25779 \begin_inset space \thinspace{}
25783 Here is an example where
25790 \begin_inset space \thinspace{}
25796 \begin_layout Standard
25800 \begin_layout Plain Layout
25814 \begin_layout Standard
25815 \begin_inset Flex Multiple Columns
25818 \begin_layout Plain Layout
25821 My observations of No.
25822 \begin_inset space \space{}
25825 427 Park Lane did little to clear up the problem in which I was interested.
25826 The house was separated from the street by a low wall and railing, the
25827 whole not more than five feet high.
25828 It was perfectly easy, therefore, for anyone to get into the garden, but
25829 the window was entirely inaccessible, since there was no water pipe or
25830 anything which could help the most active man to climb it.
25831 More puzzled than ever, I retraced my steps to Kensington.
25832 I had not been in my study five minutes when the maid entered to say that
25833 a person desired to see me.
25834 To my astonishment it was none other than my strange old book collector,
25835 his sharp, wizened face peering out from a frame of white hair, and his
25836 precious volumes, a dozen of them at least, wedged under his right arm.
25844 \begin_layout Standard
25848 \begin_layout Plain Layout
25860 \begin_inset Note Note
25863 \begin_layout Plain Layout
25864 go back to the default
25872 \begin_layout Subsubsection
25876 \begin_layout Standard
25877 Between the columns a rule with a width of the length
25884 If this rule width is set to 0
25885 \begin_inset space \thinspace{}
25888 pt (this is the default), the rule is suppressed.
25889 In the following example the rule is 2
25890 \begin_inset space \thinspace{}
25896 \begin_layout Standard
25900 \begin_layout Plain Layout
25906 columnseprule}{2pt}
25914 \begin_layout Standard
25915 \begin_inset Flex Multiple Columns
25918 \begin_layout Plain Layout
25921 \begin_inset Quotes eld
25924 You're surprised to see me, sir,
25925 \begin_inset Quotes erd
25928 said he, in a strange, croaking voice.
25931 \begin_layout Plain Layout
25934 I acknowledged that I was.
25937 \begin_layout Plain Layout
25940 \begin_inset Quotes eld
25943 Well, I've a conscience, sir, and when I chanced to see you go into this
25944 house, as I came hobbling after you, I thought to myself, I'll just step
25945 in and see that kind gentleman, and tell him that if I was a bit gruff
25946 in my manner there was not any harm meant, and that I am much obliged to
25947 him for picking up my books.
25948 \begin_inset Quotes erd
25954 \begin_layout Plain Layout
25957 \begin_inset Quotes eld
25960 You make too much of a trifle,
25961 \begin_inset Quotes erd
25966 \begin_inset Quotes eld
25969 May I ask how you knew who I was?
25970 \begin_inset Quotes erd
25976 \begin_layout Plain Layout
25979 \begin_inset Quotes eld
25982 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25983 you'll find my little bookshop at the corner of Church Street, and very
25984 happy to see you, I am sure.
25985 Maybe you collect yourself, sir.
25989 \begin_inset space ~
26002 –a bargain, every one of them.
26003 With five volumes you could just fill that gap on that second shelf.
26004 It looks untidy, does it not, sir?
26005 \begin_inset Quotes erd
26016 \begin_layout Standard
26017 \begin_inset VSpace defskip
26023 \begin_layout Standard
26024 The rule can be colored by redefining the command
26031 This is done by inserting the command
26032 \begin_inset Newline newline
26041 columnseprulecolor}{
26046 \begin_inset Newline newline
26049 as \SpecialChar TeX
26050 Code before the multicolumn inset.
26055 in this command by a color of your choice.
26056 You can use all pre- and self-defined colors.
26064 \begin_inset space ~
26069 for more information about pre- and self-defined colors.
26070 To go back to the default color insert the command
26071 \begin_inset Newline newline
26080 columnseprulecolor}{
26085 \begin_inset Newline newline
26088 Here is the example with a cyan rule and 1
26089 \begin_inset space \thinspace{}
26092 cm column separation:
26095 \begin_layout Standard
26099 \begin_layout Plain Layout
26108 \begin_layout Plain Layout
26114 columnseprulecolor}{
26124 \begin_layout Standard
26125 \begin_inset Flex Multiple Columns
26128 \begin_layout Plain Layout
26131 \begin_inset Quotes eld
26134 You're surprised to see me, sir,
26135 \begin_inset Quotes erd
26138 said he, in a strange, croaking voice.
26141 \begin_layout Plain Layout
26144 I acknowledged that I was.
26147 \begin_layout Plain Layout
26150 \begin_inset Quotes eld
26153 Well, I've a conscience, sir, and when I chanced to see you go into this
26154 house, as I came hobbling after you, I thought to myself, I'll just step
26155 in and see that kind gentleman, and tell him that if I was a bit gruff
26156 in my manner there was not any harm meant, and that I am much obliged to
26157 him for picking up my books.
26158 \begin_inset Quotes erd
26164 \begin_layout Plain Layout
26167 \begin_inset Quotes eld
26170 You make too much of a trifle,
26171 \begin_inset Quotes erd
26176 \begin_inset Quotes eld
26179 May I ask how you knew who I was?
26180 \begin_inset Quotes erd
26186 \begin_layout Plain Layout
26189 \begin_inset Quotes eld
26192 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26193 you'll find my little bookshop at the corner of Church Street, and very
26194 happy to see you, I am sure.
26195 Maybe you collect yourself, sir.
26199 \begin_inset space ~
26212 –a bargain, every one of them.
26213 With five volumes you could just fill that gap on that second shelf.
26214 It looks untidy, does it not, sir?
26215 \begin_inset Quotes erd
26226 \begin_layout Standard
26230 \begin_layout Plain Layout
26236 columnseprule}{0pt}
26239 \begin_layout Plain Layout
26245 columnseprulecolor}{
26253 \begin_inset Note Note
26256 \begin_layout Plain Layout
26257 go back to the default
26265 \begin_layout Section
26266 Non-standard Paragraph Shapes
26269 \begin_layout Standard
26272 as well as any other text processor uses by default rectangular paragraphs.
26273 For special cases like for example posters, invitation cards or poems you
26274 can modify the paragraph shape to one of your choice.
26275 This can be done by using the \SpecialChar LaTeX
26280 which is loaded by using in the document settings the module
26282 Custom paragraph shapes
26287 \begin_layout Subsection
26291 \begin_layout Standard
26296 provides the following shapes:
26299 \begin_layout Standard
26300 \begin_inset Tabular
26301 <lyxtabular version="3" rows="13" columns="3">
26302 <features booktabs="true" islongtable="true" longtabularalignment="center">
26303 <column alignment="center" valignment="middle" width="16col%">
26304 <column alignment="center" valignment="middle" width="40col%">
26305 <column alignment="center" valignment="middle" width="35col%">
26306 <row endhead="true">
26307 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26310 \begin_layout Plain Layout
26316 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26319 \begin_layout Plain Layout
26325 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26328 \begin_layout Plain Layout
26336 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26339 \begin_layout Plain Layout
26345 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26348 \begin_layout Plain Layout
26349 Circle with circular hole (in the size of a CD/DVD)
26354 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26357 \begin_layout Plain Layout
26358 Cannot be scaled, take care there is not too much text
26365 <cell alignment="center" valignment="top" topline="true" usebox="none">
26368 \begin_layout Plain Layout
26374 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26377 \begin_layout Plain Layout
26383 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26386 \begin_layout Plain Layout
26387 Fragile, calculation might fail
26394 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26397 \begin_layout Plain Layout
26403 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26406 \begin_layout Plain Layout
26407 Rhomboid (symbolizing a
26408 \begin_inset Quotes eld
26412 \begin_inset Quotes erd
26420 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26423 \begin_layout Plain Layout
26431 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26434 \begin_layout Plain Layout
26440 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26443 \begin_layout Plain Layout
26449 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26452 \begin_layout Plain Layout
26460 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26463 \begin_layout Plain Layout
26469 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26472 \begin_layout Plain Layout
26478 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26481 \begin_layout Plain Layout
26489 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26492 \begin_layout Plain Layout
26498 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26501 \begin_layout Plain Layout
26502 Nut for bolt (hexagon with circular hole)
26507 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26510 \begin_layout Plain Layout
26518 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26521 \begin_layout Plain Layout
26527 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26530 \begin_layout Plain Layout
26536 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26539 \begin_layout Plain Layout
26547 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26550 \begin_layout Plain Layout
26556 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26559 \begin_layout Plain Layout
26565 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26568 \begin_layout Plain Layout
26576 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26579 \begin_layout Plain Layout
26585 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26588 \begin_layout Plain Layout
26594 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26597 \begin_layout Plain Layout
26605 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26608 \begin_layout Plain Layout
26614 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26617 \begin_layout Plain Layout
26618 Normal/reversed rain drop
26623 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26626 \begin_layout Plain Layout
26627 Fragile, calculation might fail
26634 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26637 \begin_layout Plain Layout
26644 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26647 \begin_layout Plain Layout
26648 The \SpecialChar TeX
26654 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26657 \begin_layout Plain Layout
26665 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26668 \begin_layout Plain Layout
26670 \begin_inset Newline newline
26678 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26681 \begin_layout Plain Layout
26682 Triangles in different orientations
26687 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26690 \begin_layout Plain Layout
26704 \begin_layout Standard
26705 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26707 for environments in the toolbar.
26710 \begin_layout Standard
26711 \begin_inset Newpage newpage
26717 \begin_layout Standard
26718 Here is an example paragraph in the shape of a nut:
26721 \begin_layout Standard
26722 \begin_inset VSpace bigskip
26731 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26732 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26734 At vero eos et accusam et justo duo dolores et ea rebum.
26735 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26737 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26738 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26742 \begin_layout Standard
26743 \begin_inset VSpace bigskip
26749 \begin_layout Standard
26750 \begin_inset Note Greyedout
26753 \begin_layout Plain Layout
26758 : shapepar paragraphs cannot run over a page break.
26766 \begin_layout Standard
26767 \begin_inset VSpace bigskip
26773 \begin_layout Standard
26778 takes care that the shape will always be preserved, no matter how much
26779 text is in the paragraph.
26780 Therefore the paragraph size changes with the amount of contained text.
26781 This can lead to paragraph sizes exceeding the page margins.
26782 To demonstrate the size scaling, here is the same example paragraph but
26783 with twice as much text:
26786 \begin_layout Standard
26787 \begin_inset Newpage newpage
26796 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26797 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26799 At vero eos et accusam et justo duo dolores et ea rebum.
26800 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26802 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26803 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26805 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26806 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26808 At vero eos et accusam et justo duo dolores et ea rebum.
26809 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26811 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26812 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26816 \begin_layout Standard
26817 \begin_inset VSpace bigskip
26823 \begin_layout Standard
26824 An exception is the shape
26829 It cannot be scaled because it must fit the size of a CD/DVD.
26830 Therefore the amount of text that fits into the shape is limited.
26831 \begin_inset Newline newline
26842 shape are fragile, meaning that the calculation of their size can fail,
26843 depending on the amount of text.
26844 You will then get the \SpecialChar LaTeX
26846 \begin_inset Quotes eld
26849 Arithmetic overflow
26850 \begin_inset Quotes erd
26854 In this case one can try to remove or add some text; if nothing works one
26855 has to use another shape.
26858 \begin_layout Standard
26859 \begin_inset VSpace bigskip
26865 \begin_layout Standard
26866 For shapes with tips you will maybe see that \SpecialChar LaTeX
26867 's hyphenation routine fails
26868 for text in the tips.
26869 Therefore it is often necessary to add hyphenation points
26874 arg "specialchar-insert hyphenation"
26879 ) to the corresponding text parts.
26882 \begin_layout Standard
26883 \begin_inset VSpace bigskip
26889 \begin_layout Standard
26890 Shapepar paragraphs are either always centered or placed on the page so
26891 that their left border touches the left page margin.
26892 You can therefore not use the paragraph dialog to align such paragraphs.
26893 A solution is to put the paragraph into a minipage or parbox and align
26895 The problem is hereby to find the right width for the box.
26896 Because if it is too wide and you center the box, the paragraph is not
26897 centered too because it sticks at the left side of the box.
26898 So you might have to play a bit with the width until it fits.
26899 Here are two heart-shaped paragraphs, the first one is not aligned, the
26900 second one is right-aligned:
26903 \begin_layout Standard
26904 \begin_inset Newpage newpage
26910 \begin_layout Heart
26914 Lo\SpecialChar softhyphen
26915 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26916 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26918 At vero eos et accusam et justo duo dolores et ea rebum.
26919 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26923 \begin_layout Standard
26924 \begin_inset VSpace bigskip
26930 \begin_layout Standard
26933 \begin_inset Box Frameless
26943 height_special "totalheight"
26948 backgroundcolor "none"
26951 \begin_layout Heart
26955 Lo\SpecialChar softhyphen
26956 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26957 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26959 At vero eos et accusam et justo duo dolores et ea rebum.
26960 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26969 \begin_layout Subsection
26973 \begin_layout Standard
26974 You can define any shape you want.
26975 Doing this manually is a lot of work because every coordinate must be specified.
26976 But there is a way to let the computer calculate the coordinates:
26979 \begin_layout Enumerate
26980 Install the program
26981 \begin_inset CommandInset href
26984 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26992 \begin_layout Enumerate
26999 TeX/LaTeX\SpecialChar menuseparator
27000 Settings\SpecialChar menuseparator
27003 and select the font size you are using in your document.
27004 For example this document uses the size 12
27005 \begin_inset space \thinspace{}
27011 \begin_layout Enumerate
27015 \begin_layout Enumerate
27018 TeX/LaTeX\SpecialChar menuseparator
27021 to export the shape to coordinates.
27022 In the appearing dialog use either the outline of your shape for the coordinate
27023 s or the path itself.
27027 \begin_layout Plain Layout
27028 For more information see
27029 \begin_inset CommandInset href
27031 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
27044 \begin_layout Standard
27045 The coordinates are written into a \SpecialChar TeX
27047 To use it for your \SpecialChar LyX
27051 \begin_layout Enumerate
27052 Place the cursor before the first character of your paragraph (or into a
27056 \begin_layout Enumerate
27057 Open in \SpecialChar LyX
27060 Insert\SpecialChar menuseparator
27061 File\SpecialChar menuseparator
27063 \begin_inset space ~
27068 , select the file and use
27077 \begin_layout Standard
27078 \begin_inset VSpace defskip
27084 \begin_layout Standard
27085 \begin_inset Note Greyedout
27088 \begin_layout Plain Layout
27093 : The changed shape only applies to the current paragraph; everything is
27094 reset to normal for the next paragraph.
27095 Therefore the shape definition file must be input into every paragraph
27096 with the desired shape.
27104 \begin_layout Standard
27105 \begin_inset VSpace bigskip
27111 \begin_layout Standard
27112 Here is an example:
27115 \begin_layout Standard
27116 \begin_inset VSpace bigskip
27122 \begin_layout Standard
27123 \begin_inset CommandInset include
27125 filename "SpecialParagraphShape.tex"
27131 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27132 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27134 At vero eos et accusam et justo duo dolores et ea rebum.
27135 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27137 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27138 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27142 \begin_layout Standard
27143 \begin_inset VSpace bigskip
27149 \begin_layout Standard
27154 to draw complexer shapes in
27158 you can draw the shape in a program of your choice and import the resulting
27164 Then you only need to draw a line or spline along the outline of the image.
27167 \begin_layout Standard
27168 \begin_inset VSpace bigskip
27174 \begin_layout Standard
27177 Custom paragraph shapes
27179 also provides the two commands
27187 which can be used to define custom shapes coordinate by coordinate.
27191 \begin_layout Plain Layout
27192 These commands are internally used for all shapes described here.
27197 For information how these styles are used and about further customization
27198 possibilities, have a look at the documentation of the package
27203 \begin_inset CommandInset citation
27213 \begin_layout Bibliography
27214 \begin_inset CommandInset bibitem
27215 LatexCommand bibitem
27221 Documentation of the \SpecialChar LaTeX
27223 \begin_inset CommandInset href
27226 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
27234 \begin_layout Bibliography
27235 \begin_inset CommandInset bibitem
27236 LatexCommand bibitem
27242 Documentation of the \SpecialChar LaTeX
27244 \begin_inset CommandInset href
27247 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"