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 fleqn,bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children false
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
53 \font_sf_scale 100 100
54 \font_tt_scale 100 100
57 \default_output_format pdf2
59 \bibtex_command default
60 \index_command default
64 \pdf_title "LyX's Additional Features manual"
65 \pdf_author "LyX Team"
66 \pdf_subject "LyX's additional features documentation"
67 \pdf_keywords "LyX, Documentation, Additional"
69 \pdf_bookmarksnumbered true
70 \pdf_bookmarksopen false
71 \pdf_bookmarksopenlevel 1
76 \pdf_pdfusetitle false
77 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
80 \use_package amsmath 1
81 \use_package amssymb 1
84 \use_package mathdots 1
85 \use_package mathtools 0
87 \use_package stackrel 0
88 \use_package stmaryrd 0
89 \use_package undertilde 0
91 \cite_engine_type default
95 \paperorientation portrait
99 \notefontcolor #0000ff
106 \paragraph_separation indent
107 \paragraph_indentation default
108 \quotes_style english
112 \paperpagestyle headings
113 \tracking_changes true
114 \output_changes false
118 \author -712698321 "Jürgen Spitzmüller"
124 Additional \SpecialChar LyX
128 \begin_layout Subtitle
133 by the \SpecialChar LyX
138 \begin_layout Plain Layout
140 Principal maintainer of this file is
145 If you have comments or error corrections, please send them to the \SpecialChar LyX
148 \begin_inset Flex Code
151 \begin_layout Plain Layout
153 <lyx-docs@lists.lyx.org>
166 \begin_layout Standard
167 \begin_inset CommandInset toc
168 LatexCommand tableofcontents
175 \begin_layout Chapter
179 \begin_layout Standard
180 This manual is essentially Part II of the
182 User's Guide\SpecialChar endofsentence
185 The reason for separating the two documents is simple: the
189 is already quite lengthy, and it contains information on all of the basic
190 features one needs to know in order to prepare most documents.
191 However, the \SpecialChar LyX
192 Team has worked to make \SpecialChar LyX
193 extensible through various configuration
194 files and external packages.
195 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
197 create a layout file (or module) for it without having to alter \SpecialChar LyX
199 We've already had contributions of several new features this way, and some
200 of them are documented here.
201 There are also some more `advanced' features, such as how to control the
202 presentation of bibliographies and how to work with multi-part documents,
203 that are not covered in the
207 and are discussed here.
210 \begin_layout Standard
211 This manual also documents some special features, like fax support, version
212 control, and SGML support, which require additional software to work properly.
213 There is also a chapter on \SpecialChar LyX
215 And lastly, there's a chapter of \SpecialChar LaTeX
216 tools and tips, things you can use to
217 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
219 After all, \SpecialChar LyX
224 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
228 \begin_layout Standard
229 If you haven't read the
233 yet, you are definitely in the wrong manual.
238 is the first place to go, since it describes the notation and format of
240 You should also be thoroughly familiar with the
244 and all of the basic features of \SpecialChar LyX
245 before attempting to read this one.
248 \begin_layout Standard
249 Since many of the topics in this manual depend heavily on \SpecialChar LyX
251 with \SpecialChar LaTeX
252 , this first chapter covers the inner workings of \SpecialChar LyX
255 to generate exactly the \SpecialChar LaTeX
257 It is obviously for more seasoned \SpecialChar LyX
261 \begin_layout Chapter
263 and \SpecialChar LaTeX
267 \begin_layout Section
269 Uses \SpecialChar LaTeX
273 \begin_layout Standard
274 This chapter is for both \SpecialChar TeX
275 -nicians and the \SpecialChar LaTeX
277 In it, we'll explain how \SpecialChar LyX
278 and \SpecialChar LaTeX
279 work together to produce printable output.
280 This is the only place in any of the manuals where we assume you know something
281 about \SpecialChar LaTeX
285 \begin_layout Standard
286 At one time, \SpecialChar LyX
288 \begin_inset Quotes eld
291 WYSIWYM frontend to \SpecialChar LaTeX
293 \begin_inset Quotes erd
296 but that's no longer true.
297 There are frontends to \SpecialChar LaTeX
302 \begin_layout Plain Layout
303 Some familar ones are \SpecialChar TeX
304 maker and kile, on Linux, and \SpecialChar TeX
306 There are also the \SpecialChar LaTeX
307 modes for vi and emacs, of course.
312 These are basically text editors with the ability to run \SpecialChar LaTeX
314 errors in the file you're editing.
315 Although \SpecialChar LyX
324 run \SpecialChar LaTeX
325 , and it also indicates errors in the file, it also does much, much
327 For one thing, you don't need to know \SpecialChar LaTeX
328 to use \SpecialChar LyX
331 has added its own extensions to \SpecialChar LaTeX
333 Try the following sometime: select
334 \begin_inset Flex Noun
337 \begin_layout Plain Layout
338 Export\SpecialChar menuseparator
345 \begin_inset Flex Noun
348 \begin_layout Plain Layout
355 \begin_inset Flex Noun
358 \begin_layout Plain Layout
359 View\SpecialChar menuseparator
369 ), then look at the preamble of the resulting
370 \begin_inset Flex Code
373 \begin_layout Plain Layout
380 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
382 These macros are defined automatically, according to the features you use
386 \begin_layout Standard
387 There are several commands that automatically invoke \SpecialChar LaTeX
392 \begin_layout Itemize
393 \begin_inset Flex Noun
396 \begin_layout Plain Layout
397 Document\SpecialChar menuseparator
406 \begin_layout Itemize
407 \begin_inset Flex Noun
410 \begin_layout Plain Layout
411 Document\SpecialChar menuseparator
420 \begin_layout Standard
421 They will only invoke \SpecialChar LaTeX
422 if the file has changed since the last time \SpecialChar LaTeX
428 \begin_layout Standard
429 When \SpecialChar LyX
430 runs \SpecialChar LaTeX
431 on the file you're editing, it performs these steps:
434 \begin_layout Enumerate
435 Convert the document to \SpecialChar LaTeX
436 and save to a file with the extension
437 \begin_inset Flex Code
440 \begin_layout Plain Layout
447 \begin_inset Flex Code
450 \begin_layout Plain Layout
459 \begin_layout Enumerate
460 Run \SpecialChar LaTeX
462 \begin_inset Flex Code
465 \begin_layout Plain Layout
471 file (maybe several times), and run any other commands (such as
472 \begin_inset Flex Code
475 \begin_layout Plain Layout
482 \begin_inset Flex Code
485 \begin_layout Plain Layout
491 ) needed to compile the \SpecialChar LaTeX
495 \begin_layout Enumerate
496 If there are any errors, show the error log.
499 \begin_layout Standard
500 If you have run \SpecialChar LaTeX
502 \begin_inset Flex Noun
505 \begin_layout Plain Layout
506 View\SpecialChar menuseparator
513 then runs a DVI viewer to display the DVI-file.
515 \begin_inset Flex Noun
518 \begin_layout Plain Layout
519 View\SpecialChar menuseparator
526 performs further steps:
529 \begin_layout Itemize
531 \begin_inset Flex Code
534 \begin_layout Plain Layout
540 to convert the DVI file to PostScript.
543 \begin_layout Itemize
544 Run a PostScript viewer, such as
545 \begin_inset Flex Code
548 \begin_layout Plain Layout
554 , to display the PostScript file.
557 \begin_layout Standard
559 does similar things when viewing, or exporting, other formats.
562 \begin_layout Section
563 Translating \SpecialChar LaTeX
564 files into \SpecialChar LyX
568 \begin_layout Standard
569 You can import a \SpecialChar LaTeX
570 file into \SpecialChar LyX
572 \begin_inset Flex Noun
575 \begin_layout Plain Layout
576 File\SpecialChar menuseparator
577 Import\SpecialChar menuseparator
583 command in \SpecialChar LyX
585 This will call a program named
586 \begin_inset Flex Code
589 \begin_layout Plain Layout
595 which will create a file
596 \begin_inset Flex Code
599 \begin_layout Plain Layout
606 \begin_inset Flex Code
609 \begin_layout Plain Layout
617 will then open that file.
621 \begin_layout Plain Layout
622 \begin_inset Flex Code
625 \begin_layout Plain Layout
631 can also be run from the command line, of course.
639 \begin_layout Standard
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
649 will translate most legal \SpecialChar LaTeX
650 , but not everything.
651 It will put things it doesn't understand into \SpecialChar TeX
652 code, so after translating
654 \begin_inset Flex Code
657 \begin_layout Plain Layout
663 , you can look for \SpecialChar TeX
664 code and hand-edit it until it looks right.
667 \begin_layout Standard
668 If you don't know what \SpecialChar TeX
669 code is, read the next section.
672 \begin_layout Section
673 \begin_inset CommandInset label
675 name "sec:Inserting-TeX-Code"
679 Inserting \SpecialChar TeX
680 Code into \SpecialChar LyX
684 \begin_layout Standard
685 Anything you can do in \SpecialChar LaTeX
686 you can do in \SpecialChar LyX
687 , for a very simple reason: You can
688 always insert \SpecialChar TeX
689 code into any \SpecialChar LyX
692 cannot, and will never be able to, display every possible \SpecialChar LaTeX
694 If ever you need to insert \SpecialChar LaTeX
695 commands into your \SpecialChar LyX
696 document, you can use the
698 \begin_inset Flex Code
701 \begin_layout Plain Layout
708 box, which you can insert into your document with
709 \begin_inset Flex Noun
712 \begin_layout Plain Layout
713 Insert\SpecialChar menuseparator
723 or the keyboard shortcut
732 \begin_layout Standard
733 Here's an example of inserting \SpecialChar LaTeX
734 commands in a \SpecialChar LyX
736 The code looks like this:
739 \begin_layout LyX-Code
743 \begin_inset Newline newline
749 \begin_inset Newline newline
752 This is an example of a minipage environment.
754 \begin_inset Newline newline
757 can put nearly everything in it, even (non-floating)
758 \begin_inset Newline newline
763 \begin_inset Newline newline
769 \begin_inset Newline newline
773 \begin_inset Newline newline
779 \begin_inset Newline newline
785 \begin_inset Newline newline
791 \begin_inset Newline newline
796 \begin_inset Newline newline
802 \begin_inset Newline newline
808 \begin_inset Newline newline
814 \begin_inset Newline newline
822 \begin_layout LyX-Code
826 \begin_layout Standard
828 \begin_inset Flex Code
831 \begin_layout Plain Layout
838 box containing this text is directly after this paragraph.
839 Those of you reading the manual in \SpecialChar LyX
840 will only see the \SpecialChar TeX
842 Those reading a printed version of the manuals will see the actual results:
843 \begin_inset VSpace bigskip
849 \begin_layout Standard
853 \begin_layout Plain Layout
860 \begin_layout Plain Layout
867 \begin_layout Plain Layout
869 This is an example of a minipage environment.
870 You can put nearly everything in it, even (non-floating) figures and tables.
874 \begin_layout Plain Layout
881 \begin_layout Plain Layout
886 \begin_layout Plain Layout
893 \begin_layout Plain Layout
900 \begin_layout Plain Layout
907 \begin_layout Plain Layout
913 \begin_layout Plain Layout
920 \begin_layout Plain Layout
927 \begin_layout Plain Layout
934 \begin_layout Plain Layout
944 \begin_inset VSpace bigskip
950 \begin_layout Standard
951 In addition to using \SpecialChar TeX
952 code, you can also create a separate file containing
953 some complex \SpecialChar LaTeX
954 structure and then use
955 \begin_inset Flex Noun
958 \begin_layout Plain Layout
959 Insert\SpecialChar menuseparator
969 to include your file (you should select the type
970 \begin_inset Flex Code
973 \begin_layout Plain Layout
980 We recommend that you only do this if you have a
981 \begin_inset Flex Code
984 \begin_layout Plain Layout
995 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
999 \begin_layout Standard
1000 There are a few last points to emphasize:
1003 \begin_layout Itemize
1009 check if your \SpecialChar LaTeX
1013 \begin_layout Itemize
1014 Beware of reinventing the wheel.
1017 \begin_layout Standard
1018 On that last point, \SpecialChar LyX
1019 does have quite a few features tucked into it, and
1021 Be sure to check the manuals to make sure that \SpecialChar LyX
1022 doesn't have such-and-such
1023 feature before you decide you have to do it by hand.
1024 Moreover, there are numerous \SpecialChar LaTeX
1025 packages out there to do all sorts of things,
1026 from labels to envelopes to fancy multipage tables.
1028 \begin_inset CommandInset href
1031 target "http://www.ctan.org/"
1039 \begin_layout Standard
1040 If you do need to do some wild and fancy things within your document, be
1041 sure to check out a good \SpecialChar LaTeX
1042 book for assistance.
1043 There are a number of them listed in the bibliography of the
1050 \begin_layout Section
1052 and the \SpecialChar LaTeX
1056 \begin_layout Subsection
1057 About the \SpecialChar LaTeX
1061 \begin_layout Standard
1062 If you already know \SpecialChar LaTeX
1063 , there is no need to explain here what the preamble
1065 If you don't, the following will give you some ideas—we recommend again
1066 that you consult a \SpecialChar LaTeX
1067 book for further information.
1068 In any case, you should read the points below, because they explain what
1069 you can do and what you don't need to do in the \SpecialChar LaTeX
1070 preamble of a \SpecialChar LyX
1074 \begin_layout Standard
1075 The \SpecialChar LaTeX
1076 preamble comes at the very beginning of a document,
1084 \begin_layout Itemize
1085 Declare the document class.
1087 \begin_inset Newline newline
1091 already does this for you.
1092 If you're a seasoned \SpecialChar LaTeX
1093 -nician, and you have a custom document class you
1094 want to use, check out the
1096 Customization Manual
1098 for information on how to make \SpecialChar LyX
1102 \begin_layout Itemize
1103 Declare the usage of packages.
1105 \begin_inset Newline newline
1109 packages provide special commands, which are only available within a document
1110 when the package has been declared in the preamble.
1111 In addition to providing special commands, the inclusion of a package can
1112 change the document.
1113 For example, the package
1114 \begin_inset Flex Code
1117 \begin_layout Plain Layout
1123 forces all paragraphs to be indented.
1124 There are other packages for labels, envelopes, margins, etc.
1128 \begin_layout Itemize
1129 Set counters, variables, lengths and widths.
1131 \begin_inset Newline newline
1134 There are several \SpecialChar LaTeX
1135 counters and variables that
1139 be set globally from within the preamble in order to have the desired effect.
1140 (There are variables that you can set and reset inside the document, too.)
1141 Margins are a good example of something that must be set in the preamble.
1142 Another example is the label format for lists.
1143 You can actually set these just about anywhere, but it's best to do it
1144 just once, inside the preamble.
1147 \begin_layout Itemize
1148 Declare user defined commands (with
1149 \begin_inset Flex Code
1152 \begin_layout Plain Layout
1161 \begin_inset Flex Code
1164 \begin_layout Plain Layout
1173 \begin_inset Newline newline
1176 These are abbreviations for \SpecialChar LaTeX
1177 commands which appear very often inside a document.
1178 Although the preamble is a good place to declare such commands, they
1182 be declared anywhere (before they are used for the first time, of course).
1183 This can be useful if there is a lot of raw \SpecialChar LaTeX
1184 code in your document, which
1185 normally should not be the case.
1188 \begin_layout Standard
1190 adds its own set of definitions to the preamble of the
1191 \begin_inset Flex Code
1194 \begin_layout Plain Layout
1201 This makes \SpecialChar LaTeX
1202 files generated by \SpecialChar LyX
1206 \begin_layout Subsection
1207 Changing the Preamble
1210 \begin_layout Standard
1211 The commands which \SpecialChar LyX
1212 adds to the preamble of a \SpecialChar LaTeX
1213 file are fixed; you can't
1214 change them without patching \SpecialChar LyX
1216 You can, however, add your own stuff to the preamble by selecting
1217 \begin_inset Flex Noun
1220 \begin_layout Plain Layout
1223 \begin_inset space ~
1232 \begin_inset Flex Noun
1235 \begin_layout Plain Layout
1236 Document\SpecialChar menuseparator
1244 adds anything in the
1245 \begin_inset Flex Noun
1248 \begin_layout Plain Layout
1254 dialog to its own built-in preamble.
1255 Before adding your own declarations in the preamble, you should make sure
1256 that \SpecialChar LyX
1257 doesn't already support what you want to do.
1258 (Remember what we said about reinventing the wheel?) Also,
1260 make sure your preamble code is correct
1264 doesn't check it for you.
1265 If there is an error, you're likely to get an error like
1266 \begin_inset Quotes eld
1270 \begin_inset Flex Code
1273 \begin_layout Plain Layout
1282 \begin_inset Quotes erd
1286 If you see this error, check your preamble.
1289 \begin_layout Subsection
1293 \begin_layout Standard
1294 Here are some examples of what you can add to a preamble, and what they
1298 \begin_layout Subsubsection
1302 \begin_layout Standard
1303 There are two variables under \SpecialChar LaTeX
1304 that control page position:
1305 \begin_inset Flex Code
1308 \begin_layout Plain Layout
1317 \begin_inset Flex Code
1320 \begin_layout Plain Layout
1329 Their names should be self-explanatory.
1330 These variables are useful if you think for a moment about computer labels.
1331 Sometimes, the size of a print medium and the area of the medium that you
1332 can actually print on aren't the same.
1334 \begin_inset Flex Code
1337 \begin_layout Plain Layout
1346 \begin_inset Flex Code
1349 \begin_layout Plain Layout
1360 \begin_layout Standard
1361 The default values for
1362 \begin_inset Flex Code
1365 \begin_layout Plain Layout
1374 \begin_inset Flex Code
1377 \begin_layout Plain Layout
1386 \begin_inset space \thinspace{}
1390 \begin_inset space \thinspace{}
1394 \begin_inset space \space{}
1397 the page isn't shifted.
1398 Unfortunately, some DVI drivers always seem to shift the page.
1399 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1400 If you're using \SpecialChar LyX
1401 on a system that you don't personally maintain, and your
1402 sysadmin is a doofus,
1403 \begin_inset Flex Code
1406 \begin_layout Plain Layout
1415 \begin_inset Flex Code
1418 \begin_layout Plain Layout
1427 Suppose your left and top margins are always 0.5
1428 \begin_inset space \thinspace{}
1432 You can add this to the preamble:
1435 \begin_layout LyX-Code
1443 \begin_layout LyX-Code
1451 \begin_layout Standard
1452 and your margins should now be correct.
1455 \begin_layout Subsubsection
1459 \begin_layout Standard
1460 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1461 There's a rather nice package, available at your nearest CTAN archive,
1462 for printing sheets of labels:
1463 \begin_inset Flex Code
1466 \begin_layout Plain Layout
1473 Now, your system may not have this package installed by default.
1474 We leave that up to you to check.
1475 You'll also want to read the documentation for it; we're not going to do
1477 Since this is an example, however, we'll give you an example of how you
1481 \begin_layout Standard
1482 First, make sure you're using the
1483 \begin_inset Flex Code
1486 \begin_layout Plain Layout
1493 Next, you need to put the following in your preamble:
1496 \begin_layout LyX-Code
1502 \begin_layout LyX-Code
1508 \begin_layout LyX-Code
1514 \begin_layout LyX-Code
1520 \begin_layout LyX-Code
1526 \begin_layout LyX-Code
1532 \begin_layout LyX-Code
1538 \begin_layout Standard
1539 This sets things up for Avery label sheets, stock #5360.
1540 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1543 \begin_inset Flex Code
1546 \begin_layout Plain Layout
1555 \begin_inset Flex Code
1558 \begin_layout Plain Layout
1566 around each label text.
1567 This and other special features of
1568 \begin_inset Flex Code
1571 \begin_layout Plain Layout
1577 are explained in its documentation.
1580 \begin_layout Standard
1581 Someday, someone may write a \SpecialChar LyX
1582 layout file to support this package directly.
1583 Maybe that someone is you.
1586 \begin_layout Subsubsection
1587 Example #3: Paragraph Indentation
1590 \begin_layout Standard
1591 Americans are trained to indent the first line of
1596 As with all of their other weird quirks, most Americans will whine and
1597 moan until they can have their way and indent the first line of all paragraphs.
1606 \begin_layout Standard
1607 Of course, this behavior isn't standard typography.
1608 In books, you typically only indent the first line of a paragraph
1612 it follows another one.
1613 The idea behind indenting the first line of a paragraph is to distinguish
1614 neighboring paragraphs from one another.
1615 If there is no previous paragraph—for example, if it follows a figure or
1616 is the first paragraph in a section—then there is no need for indentation.
1620 \begin_layout Standard
1621 If you're a typical American (we're still joking!), though, you don't care
1622 about such esoteric things; you want your indentation! Add this to the
1626 \begin_layout LyX-Code
1629 usepackage{indentfirst}
1632 \begin_layout Standard
1633 If your \SpecialChar TeX
1634 distribution isn't braindead, you'll have this package, and all
1635 of your paragraphs will get the indentation the Founding Fathers intended
1639 \begin_layout Subsubsection
1640 Example #4: This Document
1643 \begin_layout Standard
1644 You can also check out the preamble of this document to get an idea of some
1645 of the advanced things you can do.
1648 \begin_layout Section
1650 and \SpecialChar LaTeX
1654 \begin_layout Standard
1655 When \SpecialChar LyX
1656 calls \SpecialChar LaTeX
1657 , it tells \SpecialChar LaTeX
1658 to blithely ignore any errors and keep going.
1659 It then uses the logfile from the \SpecialChar LaTeX
1660 run to do a post-mortem.
1661 After analyzing the logfile, \SpecialChar LyX
1662 displays a dialog listing the errors.
1663 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1665 where the error occurred.
1669 \begin_layout Plain Layout
1671 Analyzing the logfile is a tough job, and \SpecialChar LyX
1672 doesn't always go to the right
1674 There are also cases where \SpecialChar LaTeX
1675 reports the error on one line, but the actual
1677 This is not unlike forgetting a closing brace in a program: You'll get
1678 an error, but only later.
1686 \begin_layout Standard
1687 Some folks also like to look at the log file directly: It is available from
1689 \begin_inset Flex Noun
1692 \begin_layout Plain Layout
1693 Document\SpecialChar menuseparator
1695 \begin_inset space ~
1704 There are some fairly common error messages and warnings.
1705 We'll cover those here.
1706 You should look at a good \SpecialChar LaTeX
1707 book for a complete listing.
1710 \begin_layout Itemize
1711 \begin_inset Flex Code
1714 \begin_layout Plain Layout
1721 \begin_inset Newline newline
1724 Anything beginning with these words is a warning message for the purpose
1726 \begin_inset Quotes eld
1730 \begin_inset Quotes erd
1733 the \SpecialChar LaTeX
1735 You'll get messages like this if you added or changed cross-references
1736 or bibliography entries, in which case, \SpecialChar LaTeX
1737 is trying to tell you that you
1738 need to make another run.
1739 You can by-and-large ignore these.
1742 \begin_layout Itemize
1743 \begin_inset Flex Code
1746 \begin_layout Plain Layout
1753 \begin_inset Newline newline
1756 Another warning message, this time about fonts which \SpecialChar LaTeX
1758 The rest of the message will often say something about a replacement font
1759 that \SpecialChar LaTeX
1761 You can safely ignore these, too.
1764 \begin_layout Itemize
1765 \begin_inset Flex Code
1768 \begin_layout Plain Layout
1777 \begin_inset Newline newline
1786 They are warnings about lines that were too long and run past the right
1788 Almost always, this is unnoticeable in the final output.
1789 (It can be just a point or two.) Or, only one or two characters extend past
1792 seems to generate at least one of these messages for just about any document
1794 \begin_inset Newline newline
1797 You can ignore these messages.
1798 Your eyes will tell you if there's a problem with something that's too
1799 wide; just look at the output.
1803 \begin_layout Plain Layout
1804 You can also enable the `draft' option in
1805 \begin_inset Flex Noun
1808 \begin_layout Plain Layout
1809 Document\SpecialChar menuseparator
1815 , and then \SpecialChar LaTeX
1816 will draw a black box in the margin of lines that are overfull.
1824 \begin_layout Itemize
1825 \begin_inset Flex Code
1828 \begin_layout Plain Layout
1837 \begin_inset Newline newline
1840 Not quite as common as its cousin.
1842 seems to like to print lines that are a bit too wide as opposed to ones
1843 that are a bit too narrow.
1844 We have no idea why.
1847 \begin_layout Itemize
1848 \begin_inset Flex Code
1851 \begin_layout Plain Layout
1860 \begin_inset Flex Code
1863 \begin_layout Plain Layout
1872 \begin_inset Newline newline
1875 Warnings about troubles breaking the page.
1876 Once again, just look at the output.
1877 Your eyes will tell you where something has gone wrong.
1880 \begin_layout Itemize
1881 \begin_inset Flex Code
1884 \begin_layout Plain Layout
1886 \begin_inset Quotes els
1890 \begin_inset Quotes ers
1899 \begin_inset Newline newline
1903 \begin_inset Quotes eld
1907 \begin_inset Quotes erd
1910 isn't installed on this system.
1911 This usually appears because some package your document needs isn't installed.
1912 If you didn't touch the preamble or didn't use the
1913 \begin_inset Flex Code
1916 \begin_layout Plain Layout
1924 command, then one of the packages \SpecialChar LyX
1925 tried to load is missing.
1927 \begin_inset Flex Noun
1930 \begin_layout Plain Layout
1931 Help\SpecialChar menuseparator
1938 to get a list of packages that \SpecialChar LyX
1940 This file is updated whenever you reconfigure \SpecialChar LyX
1942 \begin_inset Flex Noun
1945 \begin_layout Plain Layout
1946 Tools\SpecialChar menuseparator
1952 ) and tells you which packages have been detected and what they do.
1953 \begin_inset Newline newline
1957 \begin_inset Flex Code
1960 \begin_layout Plain Layout
1968 command and the package in question isn't installed, then you'll need to
1969 install it yourself.
1972 \begin_layout Itemize
1973 \begin_inset Flex Code
1976 \begin_layout Plain Layout
1977 LaTeX Error: Unknown option
1983 \begin_inset Newline newline
1986 Error messages beginning with this are trying to tell you that you specified
1987 a bad or undefined option to a package.
1988 Check the package's documentation.
1991 \begin_layout Itemize
1992 \begin_inset Flex Code
1995 \begin_layout Plain Layout
1996 Undefined control sequence
2002 \begin_inset Newline newline
2005 If you've inserted \SpecialChar LaTeX
2006 code into your document, but made a typo, you'll get
2008 You may have forgotten to load a package.
2009 In any case, this error message usually means that you used an undefined
2014 \begin_layout Standard
2015 There are other error and warning messages.
2016 Some are self-explanatory.
2017 These are usually \SpecialChar LaTeX
2019 Others are downright cryptic.
2020 These are usually \SpecialChar TeX
2021 error messages, and we really have
2025 what they mean or how to decipher them.
2029 \begin_layout Standard
2030 There's a general sequence you should follow if you get error messages:
2033 \begin_layout Enumerate
2034 Look at the \SpecialChar LaTeX
2035 code you inserted for typos.
2038 \begin_layout Enumerate
2039 If there are no typos, check that you used the command(s) correctly.
2042 \begin_layout Enumerate
2043 If you get a bunch of error boxes piled up at the very top of the document—and
2044 especially if you see a
2045 \begin_inset Quotes eld
2049 \begin_inset Flex Code
2052 \begin_layout Plain Layout
2061 \begin_inset Quotes erd
2064 error—it means that there are errors in the preamble.
2065 Start debugging your preamble.
2068 \begin_layout Enumerate
2069 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2071 document, the first suspect is your \SpecialChar LaTeX
2072 distribution itself.
2073 Check for missing packages and install them.
2076 \begin_layout Enumerate
2077 Okay, so there are no missing packages.
2078 Did you use any of the fine-tuning options in \SpecialChar LyX
2079 ? Specifically, did you
2083 any of them, like trying to manually insert lots of
2084 \begin_inset Flex Code
2087 \begin_layout Plain Layout
2089 \begin_inset space ~
2098 \begin_inset Flex Code
2101 \begin_layout Plain Layout
2108 \begin_inset Flex Code
2111 \begin_layout Plain Layout
2117 ? Did you try to kludge something together with these instead of using the
2118 appropriate paragraph environment?
2121 \begin_layout Enumerate
2122 All right, you didn't use any of the fine-tuning options, you played by
2124 Did you try to pull a fancy maneuver? Did you do something funky inside
2125 a table or an equation, like inserting a graphic into a table cell?
2128 \begin_layout Enumerate
2129 Do you have long sections of text where \SpecialChar LaTeX
2130 cannot find a place to break a
2131 line? By default, \SpecialChar LaTeX
2132 is rather strict about how much extra inter-word spacing
2133 it will add in order to break a line.
2134 Preferably, you should rework the paragraph to avoid the problem.
2137 \begin_layout Enumerate
2138 Did you go overboard with the nesting? \SpecialChar LyX
2139 (currently) doesn't check to make
2140 sure you're in the limits for nesting environments.
2141 If you nested a bunch of environments to the
2142 \begin_inset Formula $17^{\mathrm{th}}$
2145 level, that's the problem.
2146 (The limit in \SpecialChar LaTeX
2150 \begin_layout Enumerate
2151 Okay, you didn't get any error messages, but your output looks awful.
2152 If you have a table or figure that's too wide or long for the page, you
2157 \begin_layout Enumerate
2158 rescale the figure so it fits.
2161 \begin_layout Enumerate
2162 trim down the table so it fits.
2166 \begin_layout Enumerate
2167 If something else is wrong with the output, and you didn't try to pull anything
2168 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2171 \begin_layout Standard
2172 If all this doesn't help—well, then
2176 you might have found a bug in \SpecialChar LyX
2181 \begin_layout Chapter
2185 \begin_layout Section
2186 Customizing Bibliographies with Bib\SpecialChar TeX
2188 \change_inserted -712698321 1485694846
2194 \begin_layout Standard
2195 The most basic information about how to use Bib\SpecialChar TeX
2197 \change_inserted -712698321 1485694851
2204 with \SpecialChar LyX
2205 is contained in the section
2207 Bibliography databases
2208 \change_deleted -712698321 1485694823
2209 (Bib\SpecialChar TeX
2219 The following subsections explain special bibliography features supported
2224 \begin_layout Subsection
2225 Alternative Citation Styles
2228 \begin_layout Standard
2229 Standard Bib\SpecialChar TeX
2231 \begin_inset space \thinspace{}
2235 \begin_inset space \space{}
2239 \begin_inset Quotes eld
2243 \begin_inset Quotes erd
2246 ) to refer to a cited work.
2247 However, in many scientific disciplines, other citation styles are in use.
2248 The most common one is the author-year style (e.
2249 \begin_inset space \thinspace{}
2253 \begin_inset space \space{}
2257 \begin_inset Quotes eld
2261 \begin_inset Quotes erd
2267 \change_deleted -712698321 1485694902
2269 \change_inserted -712698321 1485694902
2272 packages that provide this style,
2273 \change_inserted -712698321 1485694917
2275 \begin_inset Flex Code
2278 \begin_layout Plain Layout
2280 \change_inserted -712698321 1485694917
2291 \begin_inset Flex Code
2294 \begin_layout Plain Layout
2301 \change_inserted -712698321 1485696751
2305 \begin_inset Flex Code
2308 \begin_layout Plain Layout
2316 \change_deleted -712698321 1485695091
2318 \change_inserted -712698321 1485695093
2322 \change_deleted -712698321 1485695095
2324 \change_inserted -712698321 1485695095
2327 their pros and cons, which cannot be listed in detail.
2328 If you only want to have simple author-year (or author-numerical) style,
2329 or if you want to use one of the countless style files for
2330 \begin_inset Flex Code
2333 \begin_layout Plain Layout
2339 , then the established
2340 \begin_inset Flex Code
2343 \begin_layout Plain Layout
2349 package is probably your choice.
2351 \change_inserted -712698321 1485695152
2352 look for specific citation styles common in law studies
2353 \change_deleted -712698321 1485695162
2354 need special features like short title references, ibidem etc.
2356 , you might consider the
2357 \begin_inset Flex Code
2360 \begin_layout Plain Layout
2368 \change_inserted -712698321 1485695432
2369 If you want to have full control over the formatting or look for advanced
2370 features such as ibidem, footnote citations, full title citations, advanced
2371 date formats (such as 400 BC) or full localization to other languages than
2372 English, you should definitely consider
2373 \begin_inset Flex Code
2376 \begin_layout Plain Layout
2378 \change_inserted -712698321 1485695328
2384 , which exceeds all other packages in terms of features, but is also quite
2385 heavy and more resource-hungry.
2390 \begin_layout Standard
2392 \change_deleted -712698321 1485695449
2394 \change_inserted -712698321 1485695449
2397 packages in \SpecialChar LyX
2398 is basically the same.
2400 \begin_inset Flex Noun
2403 \begin_layout Plain Layout
2404 Document\SpecialChar menuseparator
2411 \begin_inset Flex Noun
2414 \begin_layout Plain Layout
2421 \change_deleted -712698321 1485695462
2423 \change_inserted -712698321 1485695559
2425 \begin_inset Flex Noun
2428 \begin_layout Plain Layout
2430 \change_inserted -712698321 1485695499
2437 \begin_inset Flex Noun
2440 \begin_layout Plain Layout
2442 \change_inserted -712698321 1485695527
2449 \begin_inset Flex Noun
2452 \begin_layout Plain Layout
2454 \change_inserted -712698321 1485695554
2455 Biblatex (Natbib mode)
2463 \begin_inset Flex Noun
2466 \begin_layout Plain Layout
2468 \change_inserted -712698321 1485695505
2477 \begin_inset Flex Noun
2480 \begin_layout Plain Layout
2482 \change_inserted -712698321 1485695511
2491 \change_inserted -712698321 1485695637
2493 \begin_inset space ~
2496 6.5.3 in the User's Guide for more information on these choices)
2500 \change_deleted -712698321 1485695643
2502 \change_inserted -712698321 1485695645
2505 packages, you will get some extra features in the citation dialog and you
2506 can select the style of the reference (
2507 \begin_inset Quotes eld
2511 \begin_inset Quotes erd
2515 \begin_inset Quotes eld
2519 \begin_inset Quotes erd
2523 \begin_inset Quotes eld
2527 \begin_inset Quotes erd
2531 \begin_inset Quotes eld
2535 \begin_inset Quotes erd
2540 \change_deleted -712698321 1485695659
2542 \change_inserted -712698321 1485695660
2546 \change_deleted -712698321 1485695663
2550 \change_inserted -712698321 1485695664
2553 specifically designed style files.
2555 \change_deleted -712698321 1485695676
2557 \change_inserted -712698321 1485695676
2560 ship their own, but there are lots of additional style files, and there
2561 is even an interactive style file builder
2565 \begin_layout Plain Layout
2567 \begin_inset Flex URL
2570 \begin_layout Plain Layout
2572 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2583 \begin_inset Flex Code
2586 \begin_layout Plain Layout
2595 \begin_layout Subsection
2597 \change_deleted -712698321 1486199102
2599 \change_inserted -712698321 1486199104
2605 \begin_layout Standard
2606 Sometimes you might need to divide your bibliography into several sections.
2607 If you are for instance a historian, the possibility to separate sources
2608 and scientific works is most likely a
2609 \begin_inset Quotes eld
2613 \begin_inset Quotes erd
2617 Unfortunately, Bib\SpecialChar TeX
2618 itself does not allow you to do this.
2619 But with the help of some \SpecialChar LaTeX
2620 packages, Bib\SpecialChar TeX
2621 can be extended to fit your needs.
2624 \begin_layout Standard
2626 provides native support for one of these packages,
2634 \begin_layout Plain Layout
2636 \begin_inset Flex URL
2639 \begin_layout Plain Layout
2641 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2651 The advantage of this package (compared to other packages
2652 \change_deleted -712698321 1485695727
2654 \change_inserted -712698321 1485695729
2661 ) is that you don't need to define new citation commands.
2662 Instead, you need to prepare different bibliographic databases which include
2663 the entries for the different sections of the bibliography.
2664 For example: If you want to divide your bibliography into the sections
2666 \begin_inset Quotes eld
2670 \begin_inset Quotes erd
2674 \begin_inset Quotes eld
2678 \begin_inset Quotes erd
2681 , you first need to create two bibliographic databases, e.
2682 \begin_inset space \thinspace{}
2686 \begin_inset space \space{}
2690 \begin_inset Flex Code
2693 \begin_layout Plain Layout
2700 \begin_inset Flex Code
2703 \begin_layout Plain Layout
2713 \begin_layout Standard
2715 \begin_inset Flex Noun
2718 \begin_layout Plain Layout
2719 Document\SpecialChar menuseparator
2726 \begin_inset Flex Noun
2729 \begin_layout Plain Layout
2736 \begin_inset Flex Noun
2739 \begin_layout Plain Layout
2741 \change_deleted -712698321 1486199132
2743 \change_inserted -712698321 1486199136
2752 Now you can insert multiple Bib\SpecialChar TeX
2753 bibliographies, one for each section of
2755 Returning to our example: Insert the Bib\SpecialChar TeX
2757 \begin_inset Flex Code
2760 \begin_layout Plain Layout
2766 and a second one for the database
2767 \begin_inset Flex Code
2770 \begin_layout Plain Layout
2777 You are free to use the same or different styles for each section.
2778 Additionally, you can choose if the bibliography section should contain
2780 \begin_inset Quotes eld
2783 all cited references
2784 \begin_inset Quotes erd
2787 of the specified database(s) (which is the default),
2788 \begin_inset Quotes eld
2791 all uncited references
2792 \begin_inset Quotes erd
2796 \begin_inset Quotes eld
2800 \begin_inset Quotes erd
2804 This might be useful if you would like to separate your bibliography into
2806 \begin_inset Quotes eld
2810 \begin_inset Quotes erd
2814 \begin_inset Quotes eld
2818 \begin_inset Quotes erd
2822 \begin_inset Quotes eld
2826 \begin_inset Quotes erd
2830 The titles for the sections can be added as ordinary sections or subsections.
2832 \begin_inset Flex Code
2835 \begin_layout Plain Layout
2841 removes the bibliography title, you have to manually re-add that, too (as
2842 a chapter* or section*, for instance).
2843 \change_inserted -712698321 1485695762
2847 \begin_layout Standard
2849 \change_inserted -712698321 1486200403
2854 , the procedure is a bit different.
2863 , the aforementioned
2864 \begin_inset Flex Noun
2867 \begin_layout Plain Layout
2869 \change_inserted -712698321 1486200382
2870 Subdivided bibliography
2875 option is disabled if you use
2884 provides its own means to generate subdivided bibliographies.
2885 You can either add keywords to bibliography entries via the
2886 \begin_inset Flex Code
2889 \begin_layout Plain Layout
2891 \change_inserted -712698321 1485696318
2899 entry option and then filter bibliography sections by keyword (by adding
2901 \begin_inset Flex Code
2904 \begin_layout Plain Layout
2906 \change_inserted -712698321 1485696306
2915 \begin_inset Flex Noun
2918 \begin_layout Plain Layout
2920 \change_inserted -712698321 1485696431
2928 field of the dialog that opens if you right-click on the
2929 \begin_inset Flex Noun
2932 \begin_layout Plain Layout
2934 \change_inserted -712698321 1485696518
2935 Biblatex Generated Bibliography
2942 button), or you can filter by entry types (such as
2951 \begin_inset space \thinspace{}
2956 \begin_inset Flex Code
2959 \begin_layout Plain Layout
2961 \change_inserted -712698321 1485696628
2968 \begin_inset Flex Code
2971 \begin_layout Plain Layout
2973 \change_inserted -712698321 1485696643
2980 \begin_inset Flex Noun
2983 \begin_layout Plain Layout
2985 \change_inserted -712698321 1485696667
2991 field, or you can create so-called
2992 \begin_inset Quotes eld
2995 Bibliography Categories
2996 \begin_inset Quotes erd
2999 to which you can assign individual entries.
3000 Please refer to the Biblatex manual, section
3002 Subdivided Bibliographies
3009 \begin_layout Subsection
3010 Multiple Bibliographies
3013 \begin_layout Standard
3014 Multiple bibliographies, e.
3015 \begin_inset space \thinspace{}
3019 \begin_inset space \space{}
3022 a bibliography for each
3023 \change_inserted -712698321 1486199441
3027 \change_inserted -712698321 1486199445
3029 \change_deleted -712698321 1486199447
3032 of the document, are
3033 \change_deleted -712698321 1486199458
3035 \change_inserted -712698321 1486200433
3039 \change_inserted -712698321 1486202058
3042 In order to enable it, go to
3043 \begin_inset Flex Noun
3046 \begin_layout Plain Layout
3048 \change_inserted -712698321 1486199572
3049 Document\SpecialChar menuseparator
3050 Settings\SpecialChar menuseparator
3058 and select the relevant unit (e.
3059 \begin_inset space \thinspace{}
3063 \begin_inset Quotes eld
3067 \begin_inset Quotes erd
3071 \begin_inset Flex Noun
3074 \begin_layout Plain Layout
3076 \change_inserted -712698321 1486199553
3077 Multiple Bibliographies
3086 \change_deleted -712698321 1486199771
3087 by Bib\SpecialChar TeX
3090 \change_inserted -712698321 1486200569
3091 Then add a Bib(la)\SpecialChar TeX
3092 bibliography to each unit (e.
3093 \begin_inset space \thinspace{}
3096 g., section) of your document.
3097 In the output, a separate bibliography, containing only the references
3098 done in the current unit is generated.
3101 \begin_layout Standard
3103 \change_inserted -712698321 1486199829
3104 If you use Bib\SpecialChar TeX
3106 \change_deleted -712698321 1486199835
3110 \begin_inset Flex Code
3113 \begin_layout Plain Layout
3120 \change_inserted -712698321 1486199815
3123 used for the creation of
3124 \change_deleted -712698321 1486199277
3126 \change_inserted -712698321 1486199815
3129 ed bibliographies in \SpecialChar LyX
3130 (see the previous section),
3131 \change_inserted -712698321 1486199852
3132 is used to create multiple bibliographies.
3133 \change_deleted -712698321 1486200505
3134 provides an easy way to solve this task, if you are willing to use some
3136 \begin_inset Flex Noun
3139 \begin_layout Plain Layout
3147 \begin_inset space ~
3151 \begin_inset CommandInset ref
3153 reference "sec:Inserting-TeX-Code"
3163 \begin_layout Plain Layout
3164 An alternative approach
3165 \change_inserted -712698321 1486199215
3166 , if you are willing to use some
3167 \begin_inset Flex Noun
3170 \begin_layout Plain Layout
3172 \change_inserted -712698321 1486199212
3180 \begin_inset space ~
3184 \begin_inset CommandInset ref
3186 reference "sec:Inserting-TeX-Code"
3193 \begin_inset Flex Code
3196 \begin_layout Plain Layout
3203 \begin_inset Flex Code
3206 \begin_layout Plain Layout
3212 package, respectively.
3218 \change_inserted -712698321 1486202156
3220 \change_deleted -712698321 1486202138
3224 \begin_layout Standard
3226 \change_deleted -712698321 1486202126
3228 \begin_inset Flex Noun
3231 \begin_layout Plain Layout
3232 Document\SpecialChar menuseparator
3239 \begin_inset Flex Noun
3242 \begin_layout Plain Layout
3249 \begin_inset Flex Noun
3252 \begin_layout Plain Layout
3253 Sectioned bibliography
3259 In the document, you have to enclose the sections, which shall contain
3260 their own bibliography (including the Bib\SpecialChar TeX
3261 bibliography itself), between
3263 \change_inserted -712698321 1486201472
3265 encloses the specified units in
3266 \begin_inset Flex Code
3269 \begin_layout Plain Layout
3271 \change_inserted -712698321 1486201443
3280 \begin_inset Flex Code
3283 \begin_layout Plain Layout
3292 \begin_inset Flex Code
3295 \begin_layout Plain Layout
3304 \change_inserted -712698321 1486201491
3305 in order to create the units.
3306 Note that this approach has
3309 \change_inserted -712698321 1486201489
3312 \change_deleted -712698321 1486200476
3313 (those commands have to be inserted as \SpecialChar TeX
3315 The bibliography will contain all references that have been cited in the
3317 \begin_inset Flex Code
3320 \begin_layout Plain Layout
3331 If you are using this approach, then
3332 \change_inserted -712698321 1486201489
3335 every citation reference has to be inside some
3336 \begin_inset Flex Code
3339 \begin_layout Plain Layout
3347 \change_inserted -712698321 1486201489
3348 So citations outside a defined unit (e.
3349 \begin_inset space \thinspace{}
3352 g., before the first section if you use
3353 \begin_inset Quotes eld
3357 \begin_inset Quotes erd
3361 \begin_inset Quotes eld
3365 \begin_inset Quotes erd
3369 You can also create your own units by entering
3370 \begin_inset Flex Code
3373 \begin_layout Plain Layout
3375 \change_inserted -712698321 1486200131
3384 \begin_inset Flex Code
3387 \begin_layout Plain Layout
3389 \change_inserted -712698321 1486200131
3398 code (for instance to work around the mentioned limitation).
3400 \change_deleted -712698321 1486200476
3404 \begin_inset Flex Code
3407 \begin_layout Plain Layout
3415 \change_inserted -712698321 1486201489
3416 A second limitation is that
3417 \begin_inset Flex Code
3420 \begin_layout Plain Layout
3422 \change_inserted -712698321 1486200199
3428 always processes all references of a bibliography database, even if they
3430 This can result in odd labels (e.
3431 \begin_inset space \thinspace{}
3436 \begin_inset Quotes eld
3440 \begin_inset Quotes erd
3443 if two works of this author from 2014 are in the database, even if only
3447 \begin_layout Standard
3449 \change_inserted -712698321 1486204109
3455 \begin_inset Flex Code
3458 \begin_layout Plain Layout
3460 \change_inserted -712698321 1486202183
3468 option is used instead.
3469 If you need specific units, you can start them with the \SpecialChar TeX
3471 \begin_inset Flex Code
3474 \begin_layout Plain Layout
3476 \change_inserted -712698321 1485697716
3487 \begin_inset Flex Code
3490 \begin_layout Plain Layout
3492 \change_inserted -712698321 1485697724
3503 If you also want to control the end of the unit, use the environment
3504 \begin_inset Flex Code
3507 \begin_layout Plain Layout
3509 \change_inserted -712698321 1485697769
3519 \begin_inset Flex Code
3522 \begin_layout Plain Layout
3524 \change_inserted -712698321 1485697780
3534 \begin_inset Flex Code
3537 \begin_layout Plain Layout
3539 \change_inserted -712698321 1486201999
3548 In addition to the individual bibliography of the current unit,
3552 also provides an easy way to output all bibliographies, subsequently, at
3554 \begin_inset space \thinspace{}
3557 g., at the end of the document).
3559 \begin_inset Quotes eld
3563 \begin_inset Quotes erd
3566 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3572 manual for more information on this topic.
3577 \begin_layout Section
3581 \begin_layout Subsection
3585 \begin_layout Standard
3586 When you are working on a large file with many sections, it is often convenient
3587 to break up the document into several files, or perhaps you have something
3588 where a table may change from time to time, but the preceding text does
3590 In these cases, you should seriously consider using multipart documents.
3591 For example, scientific papers often have five major sections: the introduction
3592 , observations, results, discussion, and conclusion.
3593 Each of these could be its own separate \SpecialChar LyX
3595 \begin_inset Quotes eld
3599 \begin_inset Quotes erd
3602 file which contains the title, authors, abstract, references, etc., plus
3603 the five included files.
3604 It is important to note that each of these files is a full \SpecialChar LyX
3606 can be formatted and printed on its own, as well as included in a master
3608 Each of these files must have the same document class, however—don't attempt
3609 to mix book classes with article classes.
3610 You may also include \SpecialChar LaTeX
3611 files; however, these files must not have their own
3613 \begin_inset space \thinspace{}
3617 \begin_inset space \space{}
3620 everything up to and including the
3621 \begin_inset Flex Code
3624 \begin_layout Plain Layout
3633 \begin_inset Flex Code
3636 \begin_layout Plain Layout
3644 line must be deleted) or else errors will be generated when you try to
3648 \begin_layout Standard
3650 allows you to include files quite easily with
3651 \begin_inset Flex Noun
3654 \begin_layout Plain Layout
3655 Insert\SpecialChar menuseparator
3657 \begin_inset space ~
3666 When you click on this selection a small box is inserted into the file
3667 at the current cursor location.
3668 Clicking on the box raises a dialog which allows you to select the file
3669 to be included, and the method of its inclusion.
3673 \begin_layout Standard
3674 The file selection box should by now be obvious.
3675 The three inclusion methods are
3676 \begin_inset Quotes eld
3680 \begin_inset Quotes erd
3684 \begin_inset Quotes eld
3688 \begin_inset Quotes erd
3692 \begin_inset Quotes eld
3696 \begin_inset Quotes erd
3700 The difference between
3701 \begin_inset Quotes eld
3705 \begin_inset Quotes erd
3709 \begin_inset Quotes eld
3713 \begin_inset Quotes erd
3716 is really only meaningful to \SpecialChar LaTeX
3717 perts, but the practical difference is that
3719 \begin_inset Quotes eld
3723 \begin_inset Quotes erd
3726 are typeset beginning on a new page, while files that are
3727 \begin_inset Quotes eld
3731 \begin_inset Quotes erd
3734 are typeset starting on the current page.
3737 \begin_layout Standard
3738 Generally, the master file is converted into a full \SpecialChar LaTeX
3739 file before typesetting,
3740 while the included files are converted to \SpecialChar LaTeX
3741 files that do not have all the
3742 preamble information.
3745 \begin_layout Standard
3747 \begin_inset Quotes eld
3751 \begin_inset Quotes erd
3754 included file allows you to include a file typeset exactly as it appears
3756 \begin_inset space \thinspace{}
3760 \begin_inset space \space{}
3764 \begin_inset Flex Code
3767 \begin_layout Plain Layout
3773 mode, with the characters set in a fixed-width typewriter font.
3774 Normally, spaces in this file are invisible, though two consecutive spaces
3775 are conserved, unlike \SpecialChar LyX
3776 's normal treatment of spaces.
3777 However, setting the
3778 \begin_inset Flex Noun
3781 \begin_layout Plain Layout
3783 \begin_inset space ~
3787 \begin_inset space ~
3791 \begin_inset space ~
3799 checkbox typesets a mark to unambiguously define the presence of a space.
3803 \begin_layout Subsection
3804 Cross-References Between Files
3807 \begin_layout Standard
3808 \begin_inset Box Shadowbox
3818 height_special "totalheight"
3823 backgroundcolor "none"
3826 \begin_layout Plain Layout
3827 This section is somewhat out of date.
3828 Need to describe default master documents and how children are opened when
3838 \begin_layout Standard
3839 It is possible to set up cross-references between the different files.
3840 First, open all the files in question: let's call them A and B in a two
3841 file example, where B is included in A.
3842 Let's say you insert a label in A, then want to reference it in B.
3843 Open the cross-reference dialog whilst in document B, and you can select
3845 \begin_inset Quotes eld
3849 \begin_inset Quotes erd
3855 \begin_layout Subsection
3856 Bibliography Lists in all Subdocuments
3859 \begin_layout Standard
3860 \begin_inset Box Frameless
3870 height_special "totalheight"
3875 backgroundcolor "none"
3878 \begin_layout Plain Layout
3879 This section also needs updating.
3880 There is now material about this on the wiki, and it could be copied here.
3888 \begin_layout Standard
3889 Copy the bibliography list with all entries to all subdocuments and transform
3891 This way \SpecialChar LyX
3893 \begin_inset Flex Code
3896 \begin_layout Plain Layout
3902 -files and you can easily insert references without making the bibliography
3906 \begin_layout Standard
3907 As the bibliography list is in a comment, \SpecialChar LaTeX
3908 won't use it and the references
3909 will look like this: [?], instead of like this: [1].
3910 One solution is to use the \SpecialChar LaTeX
3912 \begin_inset Flex Code
3915 \begin_layout Plain Layout
3921 that will only include comments by processing the files separately.
3922 To do this, add in the \SpecialChar LaTeX
3923 preamble of every subdocument the following:
3926 \begin_layout LyX-Code
3932 \begin_layout LyX-Code
3935 includecomment{comment}
3938 \begin_layout Standard
3940 \begin_inset Flex URL
3943 \begin_layout Plain Layout
3945 http://wiki.lyx.org/FAQ/Unsorted#toc31
3953 \begin_layout Section
3958 \begin_layout Standard
3959 Users sometimes need to be able to
3960 \begin_inset Quotes eld
3964 \begin_inset Quotes erd
3968 file together with all the images (and other files) on which it depends,
3969 either for sending to a publisher or for sharing with a co-author.
3971 2.0 includes a Python script (
3972 \begin_inset Flex Code
3975 \begin_layout Plain Layout
3981 ) that automates this process.
3982 To use it, you must have either the
3983 \begin_inset Flex Code
3986 \begin_layout Plain Layout
3993 \begin_inset Flex Code
3996 \begin_layout Plain Layout
4002 python modules installed on your system.
4003 By default, the script prefers the
4004 \begin_inset Flex Code
4007 \begin_layout Plain Layout
4014 \begin_inset Flex Code
4017 \begin_layout Plain Layout
4023 format on Unix-like systems and the
4024 \begin_inset Flex Code
4027 \begin_layout Plain Layout
4036 \begin_layout Standard
4038 's configuration process will set the script up to export a `\SpecialChar LyX
4040 and this format will then be available under
4041 \begin_inset Flex Code
4044 \begin_layout Plain Layout
4045 File\SpecialChar menuseparator
4054 \begin_layout Standard
4055 Independently of the platform, the generation of a particular archive format
4056 can be forced by adding either the
4057 \begin_inset Flex Code
4060 \begin_layout Plain Layout
4067 \begin_inset Flex Code
4070 \begin_layout Plain Layout
4077 \begin_inset Flex Code
4080 \begin_layout Plain Layout
4087 \begin_inset Flex Code
4090 \begin_layout Plain Layout
4096 format) switch to the
4097 \begin_inset Flex Code
4100 \begin_layout Plain Layout
4102 \SpecialChar menuseparator
4110 \begin_inset Flex Code
4113 \begin_layout Plain Layout
4114 Tools\SpecialChar menuseparator
4115 Preferences\SpecialChar menuseparator
4116 File Handling\SpecialChar menuseparator
4123 (Make sure you add the switch after the script name, not before it.)
4126 \begin_layout Section
4127 Fancy Headers and Footers
4130 \begin_layout Standard
4131 The default page layout is rather plain; for an
4132 \begin_inset Flex Code
4135 \begin_layout Plain Layout
4141 document class, all you get is a centered page number at the bottom of
4143 This document uses KOMA-script's book class, so it appears to be a bit
4145 But to really put on a show, you need to set the document page style to
4147 \begin_inset Quotes eld
4151 \begin_inset Quotes erd
4154 , as mentioned in the
4159 This section describes the \SpecialChar LaTeX
4160 code you need to insert in your \SpecialChar LaTeX
4162 order to get the desired effects.
4165 \begin_layout Standard
4166 For more information on fancy headers, see the
4167 \begin_inset Flex Code
4170 \begin_layout Plain Layout
4176 package documentation.
4178 \begin_inset Flex URL
4181 \begin_layout Plain Layout
4183 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4191 \begin_layout Standard
4192 The page header is divided into three fields, not surprisingly labeled
4193 \begin_inset Quotes eld
4197 \begin_inset Quotes erd
4201 \begin_inset Quotes eld
4205 \begin_inset Quotes erd
4209 \begin_inset Quotes eld
4213 \begin_inset Quotes erd
4217 The footer is also divided into these three fields.
4218 The \SpecialChar LaTeX
4219 commands to set these fields in the simplest manner are
4220 \begin_inset Flex Code
4223 \begin_layout Plain Layout
4232 \begin_inset Flex Code
4235 \begin_layout Plain Layout
4244 \begin_inset Flex Code
4247 \begin_layout Plain Layout
4256 \begin_inset Flex Code
4259 \begin_layout Plain Layout
4268 Suppose you wish to put your name in the upper left hand corner of each
4270 Simply insert the following command in the preamble:
4273 \begin_layout Standard
4282 \begin_layout Standard
4283 You will now see your name in the upper left.
4284 If a field has a default entry that you would like to get rid of (often
4285 the page number appears in the central footer) simply include a command
4286 with a blank argument, e.
4287 \begin_inset space \thinspace{}
4293 \begin_layout Standard
4301 \begin_layout Standard
4302 Let's get really fancy: lets put the section number with the word
4303 \begin_inset Quotes eld
4307 \begin_inset Quotes erd
4311 \begin_inset space \thinspace{}
4315 \begin_inset space \space{}
4318 Section 3) in the upper left, the page number (e.
4319 \begin_inset space \thinspace{}
4323 \begin_inset space \space{}
4326 Page 4) in the upper right, your name in the lower left, and the date in
4328 The following commands should now appear in the preamble:
4331 \begin_layout Standard
4341 \begin_layout Standard
4349 \begin_layout Standard
4359 \begin_layout Standard
4368 \begin_layout Standard
4376 \begin_layout Standard
4386 \begin_layout Standard
4388 \begin_inset Flex Code
4391 \begin_layout Plain Layout
4400 \begin_inset Flex Code
4403 \begin_layout Plain Layout
4411 access \SpecialChar LaTeX
4412 's section and page counters, and so print out the current section
4415 \begin_inset Flex Code
4418 \begin_layout Plain Layout
4426 simply prints out today's date.
4429 \begin_layout Standard
4430 The thicknesses of the horizontal rules drawn beneath the header and above
4431 the footer can also be modified.
4432 If you don't want one of the rules, set its thickness to 0.
4433 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4439 \begin_inset Flex Code
4442 \begin_layout Plain Layout
4447 headrulewidth}{0.4pt}
4453 \begin_inset Flex Code
4456 \begin_layout Plain Layout
4461 footrulewidth}{0.4pt}
4466 to set the thicknesses.
4469 \begin_layout Standard
4470 You can switch the header/footer settings on and off for individual pages
4472 \begin_inset Flex Code
4475 \begin_layout Plain Layout
4478 thispagestyle{empty}
4484 \begin_inset Flex Code
4487 \begin_layout Plain Layout
4490 thispagestyle{plain}
4496 \begin_inset Flex Code
4499 \begin_layout Plain Layout
4502 thispagestyle{fancy}
4508 Simply insert them in the text on the page you want changed and mark them
4511 In fact, title pages are marked as plain by default, while following pages
4512 are marked fancy when using the global fancy setting.
4515 \begin_layout Standard
4516 As a final example, it is possible to include an image in the header or
4518 Suppose you want to put a company logo in the upper lefthand corner.
4519 You might try something like
4522 \begin_layout Standard
4531 includegraphics{logo.eps}}}
4534 \begin_layout Standard
4536 (you may need to preface this with
4537 \begin_inset Flex Code
4540 \begin_layout Plain Layout
4544 usepackage{graphics}
4549 if you don't include graphics elsewhere in your document).
4552 \begin_layout Section
4553 Itemize Bullet Selection
4554 \begin_inset CommandInset label
4563 \begin_layout Standard
4569 \begin_layout Subsection
4573 \begin_layout Standard
4575 provides 216 bullet shapes that can be accessed from a simple dialog.
4576 Using this dialog you can easily specify what bullet shape to use at each
4577 level of an itemized list.
4578 These settings are document-wide so you won't be able to specify different
4579 sets of bullets for different paragraphs.
4583 \begin_layout Plain Layout
4584 Well, actually you can but you'll have to do it by hand.
4592 \begin_layout Subsection
4596 \begin_layout Standard
4597 Open the dialog by selecting the
4598 \begin_inset Flex Noun
4601 \begin_layout Plain Layout
4602 Document\SpecialChar menuseparator
4608 menu item and then select the
4609 \begin_inset Flex Noun
4612 \begin_layout Plain Layout
4621 \begin_layout Standard
4622 The dialog provides you with a table of bullet shapes.
4623 A column of buttons on the left of the table provides access to the six
4624 different panels of bullet shapes.
4625 The row of buttons across the top is used to select which bullet depth
4627 A text entry under the table shows the currently selected bullet shape's
4629 equivalent and this can be edited if desired.
4630 If you do modify the text you will also need to specify any needed packages
4631 in the \SpecialChar LaTeX
4635 \begin_layout Standard
4636 The six panels are divided up by the packages they require.
4637 The following table shows the mappings from button name to \SpecialChar LaTeX
4641 \begin_layout Standard
4643 \begin_inset Tabular
4644 <lyxtabular version="3" rows="7" columns="2">
4645 <features tabularvalignment="middle">
4646 <column alignment="center" valignment="top" width="0pt">
4647 <column alignment="center" valignment="top" width="0pt">
4649 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4652 \begin_layout Plain Layout
4667 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4670 \begin_layout Plain Layout
4687 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4690 \begin_layout Plain Layout
4705 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4708 \begin_layout Plain Layout
4717 base \SpecialChar LaTeX
4725 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4728 \begin_layout Plain Layout
4743 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4746 \begin_layout Plain Layout
4763 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4766 \begin_layout Plain Layout
4781 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4784 \begin_layout Plain Layout
4801 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4804 \begin_layout Plain Layout
4819 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4822 \begin_layout Plain Layout
4839 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4842 \begin_layout Plain Layout
4857 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4860 \begin_layout Plain Layout
4877 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4880 \begin_layout Plain Layout
4895 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4898 \begin_layout Plain Layout
4921 \begin_layout Standard
4923 doesn't stop you using bullets from packages you don't have.
4924 If you get errors from \SpecialChar LaTeX
4925 when you try to view or print the file, then it
4926 is likely you are missing a package.
4930 \begin_layout Plain Layout
4932 doesn't restrict your use since you may be editing locally and exporting
4941 \begin_layout Subsection
4945 \begin_layout Standard
4946 Select which bullet depth you want to change then select the bullet shape
4948 Any changes will not be visible in \SpecialChar LyX
4949 , but are visible when viewing the document.
4952 \begin_layout Standard
4953 You can reset a bullet shape to the default simply by clicking your right
4954 mouse button on the appropriate bullet depth button.
4958 \begin_layout Plain Layout
4963 want to have multiple sets of paragraphs with different sets of bullets
4964 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4966 The bullet selection dialog can help though because it provides you with
4967 the \SpecialChar LaTeX
4968 code for a wide range of bullet shapes.
4969 To make your own custom paragraphs you have the following options:
4972 \begin_layout Plain Layout
4976 \begin_layout Plain Layout
4992 \begin_layout Plain Layout
4996 \begin_layout Plain Layout
5018 \begin_layout Itemize
5019 Use the \SpecialChar LaTeX
5021 \begin_inset Flex Code
5024 \begin_layout Plain Layout
5032 to specify a new bullet shape for a given depth.
5033 You'll also need to save the current bullet shape so you can restore it
5035 In this itemized list the following \SpecialChar LaTeX
5036 code was used to change the bullet
5037 used for the first depth.
5041 \begin_layout LyX-Code
5051 \begin_layout LyX-Code
5068 \begin_layout Itemize
5069 Note that the itemize depth is specified in Roman numerals as part of the
5079 \begin_layout Itemize
5083 \begin_layout Plain Layout
5096 Specify each individual entry by starting each item with the bullet shape
5097 enclosed in square brackets and set as
5098 \begin_inset Flex Noun
5101 \begin_layout Plain Layout
5109 For example, this item was started with
5110 \begin_inset Flex Code
5113 \begin_layout Plain Layout
5128 \begin_layout Plain Layout
5132 \begin_layout Plain Layout
5148 \begin_layout Plain Layout
5149 You'll also need to revert the labelitem back to its previous setting for
5150 the global bullet shape settings to remain in effect.
5151 The way used here was:
5154 \begin_layout LyX-Code
5169 \begin_layout Chapter
5171 and the World Wide Web
5174 \begin_layout Standard
5176 has long supported the export of documents to various web-friendly formats,
5178 Before verson 2.0, however, HTML export was always accomplished by the use
5179 of external converters.
5183 \begin_layout Plain Layout
5184 For details on the use of external converters with \SpecialChar LyX
5189 section of the Customization manual.
5194 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5196 intermediate format, such as
5197 \begin_inset Flex Code
5200 \begin_layout Plain Layout
5207 \begin_inset Flex Code
5210 \begin_layout Plain Layout
5217 \begin_inset Flex Code
5220 \begin_layout Plain Layout
5226 , relying upon \SpecialChar LyX
5227 to produce the \SpecialChar LaTeX
5228 ; and there is a converter that works directly
5231 \begin_inset Flex Code
5234 \begin_layout Plain Layout
5242 All of these have different advantages and disadvantages.
5246 \begin_layout Standard
5247 The \SpecialChar LaTeX
5248 -based converters have the advantage that, in principle, they know everythin
5249 g about the exported document that \SpecialChar LaTeX
5251 Such converters do not care, for example, if a certain block of code was
5252 produced by \SpecialChar LyX
5253 or was Evil Red Text.
5254 These converters know about
5255 \begin_inset Flex Code
5258 \begin_layout Plain Layout
5264 files, counters, and references, and can often make use of the
5265 \begin_inset Flex Code
5268 \begin_layout Plain Layout
5274 files generated by Bib\SpecialChar TeX
5276 On the other hand, \SpecialChar LaTeX
5277 is a very hard language to parse—it is sometimes said
5278 that only \SpecialChar TeX
5279 itself understands \SpecialChar TeX
5280 —and \SpecialChar LaTeX
5281 -based converters will often choke on
5282 what seem to be quite simple constructs; complex ones can throw them completely
5283 , and as of this writing, for example, the
5287 manual will not export with
5288 \begin_inset Flex Code
5291 \begin_layout Plain Layout
5297 , though the others will.
5298 The other issue concerns how math is handled.
5299 These converters typically convert the formulae into little pictures that
5300 are then linked from the HTML document.
5301 Since these are actually generated by \SpecialChar LaTeX
5302 , they are accurate.
5303 But they do not scale well, and just getting them to look as if they are
5304 actually meant to be in your document—so that the font sizes seem to be
5305 roughly the same—can be a challenge.
5308 \begin_layout Standard
5310 \begin_inset Flex Code
5313 \begin_layout Plain Layout
5321 \begin_inset CommandInset href
5323 name "http://elyxer.nongnu.org/"
5324 target "http://elyxer.nongnu.org/"
5329 ) solves some of these problems.
5330 In particular, the formulae it produces scale perfectly, since it renders
5331 math using a combination of HTML and CSS rather than converting the formulae
5333 But even moderately complex formula are rendered less well than with
5334 \begin_inset Flex Code
5337 \begin_layout Plain Layout
5343 ; this reflects the limitations of HTML.
5347 \begin_layout Plain Layout
5349 \begin_inset Flex Code
5352 \begin_layout Plain Layout
5359 can also use jsMath and MathJax for equations, but this setting is only
5360 available globally and requires one to have access to a server that runs
5366 More importantly (as of version 1.1.1, at least),
5367 \begin_inset Flex Code
5370 \begin_layout Plain Layout
5377 has limited support for math macros and no support for user-defined paragraph
5378 or character styles.
5379 These limitations make
5380 \begin_inset Flex Code
5383 \begin_layout Plain Layout
5390 unsuitable for many of the documents \SpecialChar LyX
5392 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5394 have decided to follow a different path and have made \SpecialChar LyX
5396 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5397 , DocBook, and plaintext.
5400 \begin_layout Standard
5401 As of this writing, XHTML output remains under development and should probably
5403 \begin_inset Quotes eld
5407 \begin_inset Quotes erd
5414 \begin_layout Plain Layout
5416 \begin_inset Flex Code
5419 \begin_layout Plain Layout
5420 development/HTML.notes
5425 , which can be found in the \SpecialChar LyX
5427 \begin_inset CommandInset href
5429 name "accessed online"
5430 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5435 , usually contains up-to-date information about the state of XHTML output.
5436 See also the list of XHTML bugs on
5437 \begin_inset CommandInset href
5439 name "the bug tracker"
5440 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"
5450 Still, the developers have chosen this approach because it has several
5451 potential advantages over the other two.
5454 \begin_layout Standard
5455 These advantages are primarily due to the fact that the XHTML output routines,
5456 since they are part of \SpecialChar LyX
5457 , know everything \SpecialChar LyX
5458 knows about the document being
5463 \begin_layout Plain Layout
5464 Another advantage is that, since these routines are internal to \SpecialChar LyX
5466 immune to changes in \SpecialChar LyX
5467 's file format, or to changes in the semantics of
5473 So they know about the table of contents (as displayed in the outline),
5474 about the counters associated with different paragraph styles, and about
5475 user-defined styles.
5476 The XHTML output routines know what \SpecialChar LyX
5477 knows about internationalization,
5478 too, so they will output
5479 \begin_inset Quotes eld
5483 \begin_inset Quotes erd
5487 \begin_inset Quotes eld
5495 \begin_inset Quotes erd
5498 , depending upon the language in effect at the time.
5502 \begin_layout Standard
5503 Quite generally, the output routines know what \SpecialChar LyX
5504 knows about document layout,
5505 that is, about how the document is to be rendered on screen.
5506 We use this information when we output the document as XHTML.
5507 In particular, \SpecialChar LyX
5512 generates CSS style information corresponding to the layout information
5513 it uses to render the document on screen: if section headings are supposed
5514 to be sans-serif and bold as seen in \SpecialChar LyX
5515 , then (by default) they will be sans-seri
5516 f and bold when viewed in a web browser, too.
5517 And this is true not just for pre-defined styles, like Section, but for
5518 any style, including user-defined styles.
5519 Indeed, the XHTML output routines make no distinction between user-defined
5520 paragraph and character styles and \SpecialChar LyX
5521 's own pre-defined styles: in each case,
5522 everything \SpecialChar LyX
5523 knows about the styles is contained in the layout files.
5524 And much the same is true as regards pre-defined textual insets, such as
5525 footnotes, and various custom insets.
5529 \begin_layout Standard
5530 The result is that XHTML output can be customized and extended in exactly
5531 the same way \SpecialChar LaTeX
5532 output can be customized and extended: through layout files
5534 See chapter five of the
5538 manual for the details.
5541 \begin_layout Standard
5542 The remainder of this chapter contains more detailed information on XHTML
5543 output, its limitations, and ways to work around those limitations.
5546 \begin_layout Section
5547 Math Output in XHTML
5550 \begin_layout Standard
5552 offers four choices for how math is rendered.
5553 These have various advantages and disadvantages:
5556 \begin_layout Itemize
5558 \begin_inset Newline newline
5561 MathML is a dialect of XML designed specifically for mathematics on the
5562 web, and it typically renders very well in browsers that support it.
5563 The disadvantage is that not all browsers support MathML, and support is
5564 not complete even in the Gecko-based browsers, such as Firefox.
5565 \begin_inset Newline newline
5569 is unable to render a formula as MathML—for example, if the formula
5571 \begin_inset Flex Code
5574 \begin_layout Plain Layout
5580 package or ERT—then it will instead output the formula as an image.
5584 \begin_layout Itemize
5586 \begin_inset Newline newline
5590 \begin_inset Flex Code
5593 \begin_layout Plain Layout
5599 outputs math as HTML, styled by CSS.
5603 \begin_layout Plain Layout
5605 has borrowed some of the CSS for its HTML output from
5606 \begin_inset Flex Code
5609 \begin_layout Plain Layout
5620 For simple formulae, this can work quite well, though with more complicated
5621 formulae it tends to break down.
5622 Still, this method has the advantage that it is very widely supported and
5623 so it may be appropriate for documents that contain only a little, fairly
5625 \begin_inset Newline newline
5628 If Lyx is unable to render a formula as HTML—for example, if the formula
5630 \begin_inset Flex Code
5633 \begin_layout Plain Layout
5639 package or ERT—then it will instead output the formula as an image.
5643 \begin_layout Itemize
5645 \begin_inset Newline newline
5649 \begin_inset Flex Code
5652 \begin_layout Plain Layout
5659 will output formulae as images, the very same images, in fact, that are
5660 used for instant preview.
5664 \begin_layout Plain Layout
5665 Instant preview does
5669 have to be on for images to be output, however.
5674 The advantage to this method is that the images are simply generated by
5676 , so they are very accurate.
5677 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5678 so they do not scale terribly well, and one cannot copy them, etc.
5679 (As of this writing, there are also problems about equation numbering.
5681 \begin_inset CommandInset href
5684 target "http://www.lyx.org/trac/ticket/6894"
5690 \begin_inset Newline newline
5693 The size of the images can be controlled by setting the
5694 \begin_inset Quotes eld
5698 \begin_inset Quotes erd
5702 \begin_inset Flex Noun
5705 \begin_layout Plain Layout
5706 Document\SpecialChar menuseparator
5707 Settings\SpecialChar menuseparator
5717 \begin_layout Plain Layout
5718 For those who want to know, this controls the resolution of the image in
5719 dots per inch and is based upon a default of 75 dpi.
5725 \begin_inset Newline newline
5729 for some reason fails to create an image for a formula (e.g., if a required
5731 package is not installed), then it will fall back to outputing the raw
5736 \begin_layout Itemize
5739 \begin_inset Newline newline
5742 Finally, \SpecialChar LyX
5743 will happily output math as \SpecialChar LaTeX
5745 As well as being the output of last resort, this method can be used with
5747 \begin_inset CommandInset href
5750 target "http://www.math.union.edu/~dpvc/jsMath/"
5755 , which uses JavaScript to render \SpecialChar LaTeX
5756 embedded in HTML documents.
5758 wraps the \SpecialChar LaTeX
5760 \begin_inset Flex Code
5763 \begin_layout Plain Layout
5769 (for inline formulas) or
5770 \begin_inset Flex Code
5773 \begin_layout Plain Layout
5779 (for displayed formulas) with
5780 \begin_inset Flex Code
5783 \begin_layout Plain Layout
5789 , as is required for jsMath.
5792 \begin_layout Standard
5793 One of these output methods must be selected under
5794 \begin_inset Flex Noun
5797 \begin_layout Plain Layout
5798 Document\SpecialChar menuseparator
5799 Settings\SpecialChar menuseparator
5806 By default, \SpecialChar LyX
5808 This is a document-wide setting, therefore.
5811 \begin_layout Standard
5812 Eventually, \SpecialChar LyX
5813 will offer the user the option to select an alternate output
5814 method for a particular inset, say, one that isn't being rendered very
5819 \begin_layout Plain Layout
5820 That said, since \SpecialChar LyX
5821 falls back to images if the inset contains ERT, then one
5822 can force output as an image by putting some harmless ERT into the math,
5824 \begin_inset Formula $a=b\relax$
5835 \begin_layout Section
5836 Bibliography and Citations
5839 \begin_layout Standard
5840 XHTML output fully supports bibliographies and citations.
5844 \begin_layout Standard
5845 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5847 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5850 If you are using numerical citations, then \SpecialChar LyX
5851 will output numerical labels,
5852 such as [1] or [17], rather than simply showing the citation key in square
5853 brackets, as it does on-screen.
5854 If you are using author-year citations, then \SpecialChar LyX
5855 will add lowercase letters
5856 to the years, just as Bib\SpecialChar TeX
5857 does, if it finds more than one citation for
5858 a given author-year combination.
5859 The labels will be printed with the bibliography entries.
5860 Note that there is, at present, no way to customize the appearance of the
5861 labels, for example, to choose between square brackets and parentheses.
5864 \begin_layout Standard
5865 Bibliography output is handled by the same machinery that handles the presentati
5866 on of reference information in the citation dialog, so you will see in the
5867 XHTML output pretty much what you would see if you were to look at a given
5868 entry in the citation dialog.
5869 The formatting can be customized in your layout file or, preferably, in
5875 manual for the details.
5878 \begin_layout Standard
5879 The main defect at present is that cross-referenced information is printed
5880 with every entry with which it is associated.
5881 So you can see things like this:
5886 \begin_inset Quotes eld
5889 Context and Logical Form
5890 \begin_inset Quotes erd
5895 Language in Context: Selected Essays
5897 (Oxford: Oxford University Press, 2007), pp.
5903 \begin_inset Quotes eld
5906 Semantics in Context
5907 \begin_inset Quotes erd
5912 Language in Context: Selected Essays
5914 (Oxford: Oxford University Press, 2007), pp.
5918 \begin_layout Standard
5919 This should be fixed before long.
5922 \begin_layout Standard
5923 There is no support at present for sectioned bibliographies.
5924 If you have multiple bibliographies, then \SpecialChar LyX
5925 will print the same bibliography
5929 \begin_layout Section
5933 \begin_layout Standard
5935 will happily export indexes as XHTML, but with certain limitations at the
5939 \begin_layout Standard
5940 Index export will be most reliable when you do not attempt to use the fancy
5941 constructs that are described in the section on indexes in the
5949 \begin_layout Plain Layout
5950 The main issue here is that \SpecialChar LyX
5951 itself does not really handle these.
5952 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5958 We'll describe how they are handled using the subsection headings from
5962 \begin_layout Itemize
5963 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5964 makes an effort to support these,
5965 but the entries must be separated by
5966 \begin_inset Quotes eld
5970 \begin_inset Quotes erd
5973 , that is, there must be spaces around the exclamation point.
5974 This is because it is otherwise too difficult to check for escaped exclamation
5975 points, ones in math, and so forth.
5978 \begin_layout Itemize
5979 Page Ranges: There is no support at all for page ranges, since these make
5980 no sense with XHMTL.
5981 Instead, you will just get two index entries, one at either end.
5984 \begin_layout Itemize
5985 Cross-referencing: There is no support for cross-referencing.
5987 finds an entry containing the
5988 \begin_inset Quotes eld
5991 |see\SpecialChar ldots
5993 \begin_inset Quotes erd
5996 construct, it is just dropped, and the rest is treated as an ordinary index
6000 \begin_layout Itemize
6001 Index Entry Order: \SpecialChar LyX
6002 does support attempts to fix the sorting order.
6003 It will take what is before the first `@' it finds and use that for sorting,
6004 taking what follows the first `@' to be the actual entry.
6005 At present, \SpecialChar LyX
6006 does not check for escaped `@', so do not try to index email
6010 \begin_layout Itemize
6011 Index Entry Layout: You can format entries by using the text style dialog,
6012 or by using any other method available within \SpecialChar LyX
6014 There is no support for constructs like:
6015 \begin_inset Quotes eld
6019 \begin_inset Quotes erd
6023 Indeed, if \SpecialChar LyX
6024 finds a pipe symbol, `|', in an entry, it will delete it and
6025 everything that follows it.
6028 \begin_layout Itemize
6029 Multiple Indexes: There is no support for multiple indexes.
6030 Rather, all index entries will be printed as one large index.
6031 To avoid our printing several versions of the index, we print only the
6032 main index, so make sure you have one.
6035 \begin_layout Section
6036 Nomenclature and Glossary
6039 \begin_layout Standard
6040 There is at present no support for glossaries.
6041 Adding it would be fairly trivial, and welcome.
6044 \begin_layout Chapter
6045 The \SpecialChar LyX
6049 \begin_layout Section
6053 \begin_layout Standard
6054 The `\SpecialChar LyX
6055 server' allows other programs to talk to \SpecialChar LyX
6056 , invoke \SpecialChar LyX
6057 commands, and retrieve
6058 information about the \SpecialChar LyX
6060 This is only intended for advanced users, but they should find it useful.
6061 It is by writing to the \SpecialChar LyX
6062 server, for example, that bibliography managers,
6063 such as JabRef, are able to
6064 \begin_inset Quotes eld
6068 \begin_inset Quotes erd
6071 citations to \SpecialChar LyX
6075 \begin_layout Section
6076 Starting the \SpecialChar LyX
6080 \begin_layout Standard
6081 The \SpecialChar LyX
6082 server works through the use of a pair of named pipes.
6083 These are usually located in
6084 \begin_inset Flex Code
6087 \begin_layout Plain Layout
6093 , (except on Windows, where
6097 named pipes are special objects located in
6098 \begin_inset Flex Code
6101 \begin_layout Plain Layout
6113 ) and have the names
6114 \begin_inset Quotes eld
6118 \begin_inset Flex Code
6121 \begin_layout Plain Layout
6128 \begin_inset Quotes erd
6132 \begin_inset Quotes eld
6136 \begin_inset Flex Code
6139 \begin_layout Plain Layout
6146 \begin_inset Quotes erd
6150 External programs write into
6151 \begin_inset Flex Code
6154 \begin_layout Plain Layout
6160 and read back data from
6161 \begin_inset Flex Code
6164 \begin_layout Plain Layout
6171 The stem of the pipe names can be defined in the
6172 \begin_inset Flex Noun
6175 \begin_layout Plain Layout
6176 Tools\SpecialChar menuseparator
6183 \begin_inset Flex Code
6186 \begin_layout Plain Layout
6187 "/home/myhome/lyxpipe"
6193 \begin_inset Flex Code
6196 \begin_layout Plain Layout
6210 on Windows (where any working path instead of lyxpipe can be used, for
6212 \begin_inset Flex Code
6215 \begin_layout Plain Layout
6238 configure this manually in order for the server to start.
6241 \begin_layout Standard
6244 \begin_inset Flex Code
6247 \begin_layout Plain Layout
6254 \begin_inset Flex Code
6257 \begin_layout Plain Layout
6263 ' to create the pipes.
6264 If one of the pipes already exists, \SpecialChar LyX
6265 will assume that another \SpecialChar LyX
6267 is already running and will not start the server.
6268 On POSIX (Unix like) systems, if for some other reason, an unused
6269 \begin_inset Quotes eld
6273 \begin_inset Quotes erd
6276 pipe is left in existence when \SpecialChar LyX
6277 closes, then \SpecialChar LyX
6278 will try to delete it.
6279 If this fails for some reason, you will need to delete the pipes manually
6280 and then restart \SpecialChar LyX
6282 On Windows, pipes are deleted by the OS on program termination or crash,
6284 \begin_inset Quotes eld
6288 \begin_inset Quotes erd
6291 pipes should not be possible.
6294 \begin_layout Standard
6295 To have several \SpecialChar LyX
6296 processes with servers at the same time, you have to use
6297 different configurations, perhaps by using separate user directories, each
6299 \begin_inset Flex Code
6302 \begin_layout Plain Layout
6308 file, for each process.
6311 \begin_layout Standard
6312 If you are developing a client program, you might find it useful to enable
6313 debugging information from the \SpecialChar LyX
6315 Do this by starting \SpecialChar LyX
6317 \begin_inset Flex Code
6320 \begin_layout Plain Layout
6329 \begin_layout Standard
6330 You can find a complete example client written in C++ in the source distribution
6332 \begin_inset Flex Code
6335 \begin_layout Plain Layout
6336 development/lyxserver/server_monitor.cpp
6344 \begin_layout Standard
6345 Another useful tool is the command-line based client found in
6346 \begin_inset Flex Code
6349 \begin_layout Plain Layout
6350 src/client/lyxclient
6358 \begin_layout Section
6359 Normal communication
6362 \begin_layout Standard
6363 To issue a \SpecialChar LyX
6364 call, the client writes a line of ASCII text into the input
6366 This line has the following format:
6383 \begin_layout Description
6384 clientname is a name that the client can choose arbitrarily.
6385 Its only use is that \SpecialChar LyX
6386 will echo it if it sends an answer—so a client can
6387 dispatch results from different requesters.
6390 \begin_layout Description
6391 function is the function you want \SpecialChar LyX
6393 It is the same as the commands you'd use in the minibuffer.
6396 \begin_layout Description
6397 argument is an optional argument which is meaningful only to some functions
6399 \begin_inset Quotes eld
6403 \begin_inset Quotes erd
6406 LFUN will insert the argument as text at the cursor position).
6409 \begin_layout Standard
6410 The answer from \SpecialChar LyX
6411 will arrive in the output pipe and be of the form
6428 \begin_layout Standard
6437 are just echoed from the command request, while
6441 is more or less useful information filled according to how the command
6442 execution worked out.
6443 Some commands, such as
6444 \begin_inset Quotes eld
6448 \begin_inset Quotes erd
6451 , will return information about the internal state of \SpecialChar LyX
6453 return an empty data-response.
6454 This means that the command execution went fine.
6457 \begin_layout Standard
6458 In case of errors, the response from \SpecialChar LyX
6476 \begin_layout Standard
6481 should contain an explanation of why the command failed.
6484 \begin_layout Standard
6488 \begin_layout LyX-Code
6489 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6490 \begin_inset Newline newline
6493 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6494 \begin_inset Newline newline
6497 read a <~/.lyxpipe.out
6498 \begin_inset Newline newline
6504 \begin_layout Subsection
6505 AppleScript (Mac OS X)
6508 \begin_layout Standard
6509 Since \SpecialChar LyX
6510 2.1, \SpecialChar LyX
6511 supports basic interactions with AppleScript for normal communicatio
6512 n through the command run.
6513 This command takes a direct argument (the
6517 to perform) and an optional argument.
6518 It either returns the output of the function or triggers an error with
6519 the error message and code.
6522 \begin_layout Standard
6526 \begin_layout LyX-Code
6527 tell application "\SpecialChar LyX
6531 \begin_layout LyX-Code
6535 \begin_layout LyX-Code
6536 -- Stores the current file name into f
6539 \begin_layout LyX-Code
6540 set f to (run "server-get-filename" with argument "")
6543 \begin_layout LyX-Code
6544 on error the error_message number the error_number
6547 \begin_layout LyX-Code
6548 display dialog "Error: " & the error_number & ".
6552 \begin_layout LyX-Code
6553 & the error_message buttons {"OK"} default button 1
6556 \begin_layout LyX-Code
6560 \begin_layout LyX-Code
6564 \begin_layout Section
6568 \begin_layout Standard
6570 can notify clients of events going on asynchronously.
6571 Currently it will only do this if the user binds a key sequence with the
6573 \begin_inset Quotes eld
6577 \begin_inset Quotes erd
6581 The format of the string \SpecialChar LyX
6582 sends is as follows:
6586 \begin_inset Flex Code
6589 \begin_layout Plain Layout
6600 \begin_layout Standard
6605 is the printed representation of the key sequence that was actually typed
6609 \begin_layout Standard
6610 This mechanism can be used to extend \SpecialChar LyX
6611 's command set and implement macros.
6612 Bind some key sequence to
6613 \begin_inset Quotes eld
6617 \begin_inset Quotes erd
6621 Then start a client that listens on the output pipe, dispatches the command
6622 according to the sequence, and starts a function that may use \SpecialChar LyX
6625 requests to issue a command or a series of commands to \SpecialChar LyX
6629 \begin_layout Section
6630 The simple \SpecialChar LyX
6634 \begin_layout Standard
6636 implements a simple protocol that can be used for session management.
6637 All messages are of the form
6650 \begin_layout Standard
6656 \begin_inset Quotes eld
6660 \begin_inset Quotes erd
6664 \begin_inset Quotes eld
6668 \begin_inset Quotes erd
6673 \begin_inset Quotes eld
6677 \begin_inset Quotes erd
6680 is received from a client, \SpecialChar LyX
6681 will report back to inform the client that
6682 it's listening to it's messages, while
6683 \begin_inset Quotes eld
6687 \begin_inset Quotes erd
6690 sent from \SpecialChar LyX
6691 will inform clients that \SpecialChar LyX
6695 \begin_layout Section
6696 Reverse DVI/PDF search
6699 \begin_layout Standard
6700 Some DVI/PDF viewers
6704 \begin_layout Plain Layout
6705 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6706 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6715 facility (also called
6720 This means that you can tell \SpecialChar LyX
6721 to put the cursor to a specific line in the
6722 document by clicking at the respective position in the DVI/PDF output.
6723 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6725 This is done via the \SpecialChar LyX
6726 server either by using the named pipe (
6730 ), or the UNIX domain socket (
6734 ) that \SpecialChar LyX
6735 creates in its temporary directory (this is the way the
6736 \begin_inset Flex Code
6739 \begin_layout Plain Layout
6745 program communicates with \SpecialChar LyX
6747 In some cases, you need a helper script that mediates between the viewer
6748 and \SpecialChar LyX
6749 , in others, the viewer can communicate with \SpecialChar LyX
6751 This depends on the selected viewer and on your operating system.
6752 The same applies to the way viewers need to be configured and the way the
6753 reverse search is actually performed.
6754 In what follows, we will thus describe how to setup reverse search for
6756 Before we turn to this, though, we will explain what needs to be done generally
6757 to enable reverse search in the DVI/PDF output.
6760 \begin_layout Subsection
6762 \begin_inset CommandInset label
6764 name "subsec:rev-search"
6771 \begin_layout Standard
6772 In most cases \SpecialChar LyX
6773 will do the work for you by enabling the option
6774 \begin_inset Flex Noun
6777 \begin_layout Plain Layout
6778 Synchronize with Output
6784 \begin_inset Flex Noun
6787 \begin_layout Plain Layout
6788 Document\SpecialChar menuseparator
6789 Settings\SpecialChar menuseparator
6796 In such a case \SpecialChar LyX
6797 will automatically insert the necessary Sync\SpecialChar TeX
6799 PDF) or load the srcltx package (for DVI) respectively.
6800 This option can be easily reached also on
6801 \begin_inset Flex Code
6804 \begin_layout Plain Layout
6813 \begin_layout Standard
6814 If you need a different setting, you can select or input a custom macro
6815 from the drop down box just below
6816 \begin_inset Flex Noun
6819 \begin_layout Plain Layout
6820 Document\SpecialChar menuseparator
6821 Settings\SpecialChar menuseparator
6822 Output\SpecialChar menuseparator
6823 Synchronize with Output
6831 \begin_layout Standard
6832 Note that the method
6833 \begin_inset Flex Code
6836 \begin_layout Plain Layout
6844 enables gzip compression.
6845 If your viewer does not support it, you should instead use
6846 \begin_inset Flex Code
6849 \begin_layout Plain Layout
6860 \begin_layout Standard
6861 Please also note that including the
6862 \begin_inset Flex Code
6865 \begin_layout Plain Layout
6872 \begin_inset Flex Code
6875 \begin_layout Plain Layout
6881 sometimes has an undesired impact on the typesetting.
6882 Thus, you should switch output synchronization off for the final typesetting
6884 \begin_inset Flex Code
6887 \begin_layout Plain Layout
6894 \begin_inset Flex Code
6897 \begin_layout Plain Layout
6907 \begin_layout Standard
6908 In case you need some more special settings that are not covered by the
6909 automatic settings, read the next section about how to set up output synchroniz
6911 If the automatic setup suits your needs, you can readily jump to section
6912 \begin_inset space ~
6916 \begin_inset CommandInset ref
6918 reference "subsec:configuring-viewers"
6922 , where the necessary configuration steps in your viewer – needed both with
6923 the automatic and the manual setup – are described.
6926 \begin_layout Subsection
6930 \begin_layout Standard
6932 provides several different methods for reverse search.
6933 Some are built-in in the
6934 \begin_inset Flex Code
6937 \begin_layout Plain Layout
6943 program, some are provided by external packages.
6944 Your choice depends on whether your \SpecialChar LaTeX
6945 distribution already provides a given
6946 method (the built-in methods are rather new) and whether your viewer can
6948 The available methods are described in the following.
6951 \begin_layout Subsubsection*
6952 Built-in DVI-search via src-specials (DVI only)
6955 \begin_layout Standard
6956 This method provides the DVI file with the necessary information for reverse
6958 It is available in \SpecialChar LaTeX
6959 since quite some time (any somewhat recent \SpecialChar LaTeX
6961 should include it), and it works reliably.
6962 To enable it, change the
6963 \begin_inset Flex Noun
6966 \begin_layout Plain Layout
6977 \begin_inset Flex Noun
6980 \begin_layout Plain Layout
6991 \begin_inset Flex Noun
6994 \begin_layout Plain Layout
6995 Preferences\SpecialChar menuseparator
6996 File Handling\SpecialChar menuseparator
7003 \begin_inset Flex Code
7006 \begin_layout Plain Layout
7007 latex -src-specials $$i
7013 If this doesn't work, check if your \SpecialChar TeX
7014 engine needs different options (the
7015 syntax might differ in some distributions).
7018 \begin_layout Subsubsection*
7019 External Packages (PDFSync and scrltx)
7022 \begin_layout Standard
7031 provide reverse search facility for PDF output (via pdflatex) and DVI output,
7033 In order to enable it, load the packages in the \SpecialChar LyX
7037 \begin_layout Itemize
7038 \begin_inset Flex Code
7041 \begin_layout Plain Layout
7049 for reverse PDF search,
7052 \begin_layout Itemize
7053 \begin_inset Flex Code
7056 \begin_layout Plain Layout
7059 usepackage[active]{srcltx}
7064 for reverse DVI search.
7067 \begin_layout Standard
7068 If you want to be able to perform both DVI and PDF reverse searches, you
7069 can also insert in the preamble the following lines
7072 \begin_layout LyX-Code
7076 \begin_inset Newline newline
7082 \begin_inset Newline newline
7088 \begin_inset Newline newline
7094 \begin_inset Newline newline
7099 usepackage[active]{srcltx}
7100 \begin_inset Newline newline
7108 \begin_layout Standard
7109 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7110 right package will be used.
7113 \begin_layout Standard
7114 Note that PDFSync might affect the output layout of your document.
7115 It is therefore advised to disable PDFsync for final documents.
7118 \begin_layout Subsubsection*
7119 Built-in reverse search via Sync\SpecialChar TeX
7123 \begin_layout Standard
7125 \begin_inset Flex Code
7128 \begin_layout Plain Layout
7134 have built-in support for both PDF and DVI reverse search.
7137 Sync\SpecialChar TeX
7140 facility is basically the result of the integration of the PDFSync package
7141 to the pdftex program and its merge with the
7146 You need at least \SpecialChar TeX
7147 Live 2008 or a recent Mik\SpecialChar TeX
7148 distribution in order to use
7153 \begin_layout Plain Layout
7154 For some reason, Mik\SpecialChar TeX
7155 does not understand/obey the command \SpecialChar LyX
7157 the preamble when you check the "Enable Forward/Reverse Search" button
7158 in the toolbar and does not generate the necessary info.
7161 \begin_layout Plain Layout
7162 The generation of the required info can be forced by changing the converter
7164 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7165 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7166 the -synctex=1 switch).
7171 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
7172 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
7176 \begin_layout Standard
7177 To enable Sync\SpecialChar TeX
7178 for DVI output, change the
7179 \begin_inset Flex Noun
7182 \begin_layout Plain Layout
7193 \begin_inset Flex Noun
7196 \begin_layout Plain Layout
7207 \begin_inset Flex Noun
7210 \begin_layout Plain Layout
7211 Preferences\SpecialChar menuseparator
7212 File Handling\SpecialChar menuseparator
7219 \begin_inset Flex Code
7222 \begin_layout Plain Layout
7223 latex -synctex=1 $$i
7228 , and for PDF output, change the
7229 \begin_inset Flex Noun
7232 \begin_layout Plain Layout
7237 (pdflatex) -> PDF (pdflatex)
7243 \begin_inset Flex Code
7246 \begin_layout Plain Layout
7247 pdflatex -synctex=1 $$i
7253 Check the documentation of your viewer whether the viewer needs to be configure
7254 d for the use with Sync\SpecialChar TeX
7259 \begin_layout Plain Layout
7260 Note that the option
7261 \begin_inset Flex Code
7264 \begin_layout Plain Layout
7270 option enables gzip compression.
7271 If your viewer does not support it, you should instead use
7272 \begin_inset Flex Code
7275 \begin_layout Plain Layout
7289 \begin_layout Subsection
7290 Configuring and using specific viewers
7291 \begin_inset CommandInset label
7293 name "subsec:configuring-viewers"
7300 \begin_layout Subsubsection*
7301 Xdvi (all platforms)
7304 \begin_layout Standard
7306 \begin_inset Flex Code
7309 \begin_layout Plain Layout
7315 , you don't need to do anything else for performing a reverse DVI search,
7317 already provides the necessary hooks for automatically using the
7318 \begin_inset Flex Code
7321 \begin_layout Plain Layout
7328 Just setup your document as described above (reverse search is triggered
7329 by Ctrl-click or Alt-click on Mac OSX, respectively).
7332 \begin_layout Standard
7333 However, if for whatever reason you want to use the named pipe instead of
7334 the socket for communicating with \SpecialChar LyX
7335 , simply change the DVI viewer in
7336 \begin_inset Flex Noun
7339 \begin_layout Plain Layout
7340 Preferences\SpecialChar menuseparator
7341 File Handling\SpecialChar menuseparator
7351 \begin_layout Plain Layout
7352 On Mac OSX you have to use
7353 \begin_inset Flex Code
7356 \begin_layout Plain Layout
7357 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7368 \begin_inset Flex Code
7371 \begin_layout Plain Layout
7372 xdvi -editor "lyxeditor.sh %f %l"
7378 \begin_inset Flex Code
7381 \begin_layout Plain Layout
7387 is a suitable script.
7388 For example, a minimal shell script is the following one:
7391 \begin_layout LyX-Code
7393 \begin_inset Newline newline
7396 LYXPIPE="/path/to/lyxpipe"
7397 \begin_inset Newline newline
7400 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7401 \begin_inset Newline newline
7404 echo "$COMMAND" > "${LYXPIPE}".in || exit
7405 \begin_inset Newline newline
7408 read TMP < "${LYXPIPE}".out || exit
7411 \begin_layout Standard
7413 \begin_inset Flex Code
7416 \begin_layout Plain Layout
7422 is the LyXServer pipe path specified in
7423 \begin_inset Flex Noun
7426 \begin_layout Plain Layout
7427 Preferences\SpecialChar menuseparator
7437 \begin_layout Plain Layout
7439 \begin_inset Flex Code
7442 \begin_layout Plain Layout
7448 folder of a source distribution you can find a
7449 \begin_inset Flex Code
7452 \begin_layout Plain Layout
7458 script which is able to locate the
7462 based on your preferences.
7470 \begin_layout Subsubsection*
7474 \begin_layout Standard
7476 \begin_inset Flex Code
7479 \begin_layout Plain Layout
7480 /Applications/MacDviX_Folder/calleditor.script
7485 , add the following lines:
7488 \begin_layout LyX-Code
7489 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7490 \begin_inset Newline newline
7496 \begin_layout Standard
7497 Modify the lines accordingly if you install \SpecialChar LyX
7498 somewhere else than in the
7499 Applications folder.
7502 \begin_layout Standard
7503 Reverse search is triggered by Alt-click (OPTION-click).
7506 \begin_layout Subsubsection*
7510 \begin_layout Standard
7512 \begin_inset Flex Code
7515 \begin_layout Plain Layout
7516 open -a Skim.app $$i
7521 to the viewer setting in
7522 \begin_inset Flex Noun
7525 \begin_layout Plain Layout
7526 Preferences\SpecialChar menuseparator
7527 File Handling\SpecialChar menuseparator
7528 File formats\SpecialChar menuseparator
7535 \begin_inset Flex Noun
7538 \begin_layout Plain Layout
7539 Skim\SpecialChar menuseparator
7540 Preferences\SpecialChar menuseparator
7547 \begin_inset Flex Noun
7550 \begin_layout Plain Layout
7556 preset and enter command
7557 \begin_inset Flex Noun
7560 \begin_layout Plain Layout
7561 /Applications/\SpecialChar LyX
7562 .app/Contents/MacOS/lyxeditor
7570 \begin_layout Standard
7571 Reverse search is triggered by COMMAND-SHIFT-click
7574 \begin_layout Subsubsection*
7578 \begin_layout Standard
7580 \begin_inset Flex Noun
7583 \begin_layout Plain Layout
7584 Settings\SpecialChar menuseparator
7585 Configure Okular\SpecialChar menuseparator
7592 \begin_inset Quotes eld
7596 \begin_inset Quotes erd
7600 \begin_inset Flex Code
7603 \begin_layout Plain Layout
7612 \begin_layout Standard
7613 Reverse search is triggered by SHIFT-click.
7616 \begin_layout Subsubsection*
7620 \begin_layout Standard
7621 Qpdfview supports Sync\SpecialChar TeX
7622 since version 0.3.5.
7624 \begin_inset Flex Noun
7627 \begin_layout Plain Layout
7628 Edit\SpecialChar menuseparator
7629 Settings\SpecialChar menuseparator
7635 , click on the input field of the
7636 \begin_inset Quotes eld
7640 \begin_inset Quotes erd
7643 item and add the command
7644 \begin_inset Flex Code
7647 \begin_layout Plain Layout
7656 \begin_layout Standard
7657 Reverse search is triggered by double-click or, in more recent versions,
7661 \begin_layout Subsubsection*
7665 \begin_layout Standard
7666 Launch yap, choose its
7667 \begin_inset Flex Noun
7670 \begin_layout Plain Layout
7671 View\SpecialChar menuseparator
7678 \begin_inset Quotes eld
7682 \begin_inset Quotes erd
7687 \begin_inset Quotes eld
7690 New\SpecialChar ldots
7692 \begin_inset Quotes erd
7695 button and, in the window that opens, enter
7696 \begin_inset Quotes eld
7701 \begin_inset Quotes erd
7704 (or any other name you like) in the
7705 \begin_inset Quotes eld
7709 \begin_inset Quotes erd
7713 Now click on the button labeled
7714 \begin_inset Quotes eld
7719 \begin_inset Quotes erd
7722 to open a file dialog and navigate to the directory containing the batch
7724 \begin_inset Flex Code
7727 \begin_layout Plain Layout
7735 \begin_inset Flex Code
7738 \begin_layout Plain Layout
7744 and then specify the program arguments as
7745 \begin_inset Flex Code
7748 \begin_layout Plain Layout
7756 \begin_inset Flex Code
7759 \begin_layout Plain Layout
7765 wrapper is used for communicating with \SpecialChar LyX
7773 \begin_layout LyX-Code
7775 \begin_inset Newline newline
7778 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7787 \begin_inset Newline newline
7801 \begin_layout Standard
7802 Make sure that the \SpecialChar LyX
7803 Server pipe path you specified in \SpecialChar LyX
7805 \begin_inset Flex Code
7808 \begin_layout Plain Layout
7822 , otherwise change the
7823 \begin_inset Flex Code
7826 \begin_layout Plain Layout
7832 wrapper accordingly.
7835 \begin_layout Standard
7836 In yap, reverse search is triggered by double-click.
7839 \begin_layout Subsubsection*
7840 SumatraPDF (Windows)
7843 \begin_layout Standard
7844 In order to use SumatraPDF for inverse search, enter
7845 \begin_inset Flex Code
7848 \begin_layout Plain Layout
7849 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7854 in the viewer setting in
7855 \begin_inset Flex Noun
7858 \begin_layout Plain Layout
7859 Preferences\SpecialChar menuseparator
7860 File Handling\SpecialChar menuseparator
7861 File formats\SpecialChar menuseparator
7868 \begin_inset Flex Code
7871 \begin_layout Plain Layout
7877 is the previous wrapper.
7878 If SumatraPDF.exe is not in your command PATH, use its full file name.
7881 \begin_layout Standard
7882 Reverse search is triggered by double-click.
7885 \begin_layout Subsubsection*
7889 \begin_layout Standard
7890 First of all, make sure that yap is your default DVI viewer in the Windows
7891 environment, then launch it, choose its
7892 \begin_inset Flex Noun
7895 \begin_layout Plain Layout
7896 View\SpecialChar menuseparator
7903 \begin_inset Quotes eld
7907 \begin_inset Quotes erd
7912 \begin_inset Quotes eld
7915 New\SpecialChar ldots
7917 \begin_inset Quotes erd
7920 button and, in the window that opens, enter
7921 \begin_inset Quotes eld
7926 \begin_inset Quotes erd
7929 (or any other name you like) in the
7930 \begin_inset Quotes eld
7934 \begin_inset Quotes erd
7938 Now click on the button labeled
7939 \begin_inset Quotes eld
7944 \begin_inset Quotes erd
7947 to open a file dialog and navigate to the directory containing the
7948 \begin_inset Flex Code
7951 \begin_layout Plain Layout
7957 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7960 \begin_inset Flex Code
7963 \begin_layout Plain Layout
7969 and then specify the program arguments as
7970 \begin_inset Flex Code
7973 \begin_layout Plain Layout
7980 In this way, you will be using the
7984 for communicating with \SpecialChar LyX
7986 If, for whatever reason, you want to use the
7991 \begin_inset Flex Code
7994 \begin_layout Plain Layout
8000 option and be sure to specify the \SpecialChar LyX
8001 Server pipe path in the \SpecialChar LyX
8005 \begin_layout Standard
8006 In yap, reverse search is triggered by double-click.
8009 \begin_layout Subsubsection*
8013 \begin_layout Standard
8014 In order to use SumatraPDF for inverse search, enter
8015 \begin_inset Flex Code
8018 \begin_layout Plain Layout
8019 SumatraPDF -inverse-search "lyxeditor -g %f %l"
8024 in the viewer setting in
8025 \begin_inset Flex Noun
8028 \begin_layout Plain Layout
8029 Preferences\SpecialChar menuseparator
8030 File Handling\SpecialChar menuseparator
8031 File formats\SpecialChar menuseparator
8038 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8040 \begin_inset Flex Code
8043 \begin_layout Plain Layout
8049 enables communication via the
8055 \begin_inset Flex Code
8058 \begin_layout Plain Layout
8064 option if you want to use the
8068 , and be sure to specify the \SpecialChar LyX
8069 Server pipe path in the \SpecialChar LyX
8073 \begin_layout Standard
8074 Reverse search is triggered by double-click.
8077 \begin_layout Section
8081 \begin_layout Standard
8082 Forward search is, as the name implies, in a sense the
8083 \begin_inset Quotes eld
8087 \begin_inset Quotes erd
8091 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8093 If forward search is set up (as described in what follows), you can put
8094 the cursor anywhere in your \SpecialChar LyX
8096 \begin_inset Flex Noun
8099 \begin_layout Plain Layout
8100 Navigate\SpecialChar menuseparator
8107 \begin_inset Flex Noun
8110 \begin_layout Plain Layout
8116 in the context menu via right mouse click), and then the viewer will jump
8117 to that position as well.
8118 This implies, of course, that your viewer supports this function.
8121 \begin_layout Standard
8122 To make forward search possible, you first need to provide the generated
8123 output PDF/DVI file with additional information about the \SpecialChar TeX
8125 This can be done via the methods described in the section
8126 \begin_inset CommandInset ref
8128 reference "subsec:rev-search"
8135 \begin_layout Standard
8136 Additionally, you need to configure \SpecialChar LyX
8137 for using your viewers in
8138 \begin_inset Flex Noun
8141 \begin_layout Plain Layout
8142 Tools\SpecialChar menuseparator
8143 Preferences\SpecialChar menuseparator
8144 Output\SpecialChar menuseparator
8151 We provide a range of tested configurations for some viewers, which you
8152 can select from the drop down list.
8153 If none of these configurations suits you, you have to find out and enter
8154 a suitable configuration yourself.
8155 The definition syntax uses the following placeholders:
8158 \begin_layout Itemize
8160 \begin_inset Flex Code
8163 \begin_layout Plain Layout
8172 \begin_layout Itemize
8174 \begin_inset Flex Code
8177 \begin_layout Plain Layout
8183 : name of the (temporary) exported .tex file (without path)
8186 \begin_layout Itemize
8188 \begin_inset Flex Code
8191 \begin_layout Plain Layout
8197 : name of the (temporary) exported .tex file (including path)
8200 \begin_layout Itemize
8202 \begin_inset Flex Code
8205 \begin_layout Plain Layout
8211 : name of the exported output file (either dvi or pdf, depending on which
8212 one exists in the temporary directory)
8215 \begin_layout Standard
8216 Note that only some of the viewers provide full forward search functionality,
8217 among them yap, xdvi, okular
8221 \begin_layout Plain Layout
8222 You might want to set
8223 \begin_inset Flex Code
8226 \begin_layout Plain Layout
8233 \begin_inset Flex Noun
8236 \begin_layout Plain Layout
8237 Tools\SpecialChar menuseparator
8238 Preferences\SpecialChar menuseparator
8239 File Handling\SpecialChar menuseparator
8241 \begin_inset space ~
8254 , qpdfview and SumatraPDF
8258 \begin_layout Plain Layout
8259 SumatraPDF can also use DDE commands through the external program CMCDDE
8261 \begin_inset CommandInset href
8263 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8274 While many of the widespread PDF viewers (most notably Adobe Reader) do
8275 not support forward search at all, some other viewers – e.
8276 \begin_inset space \thinspace{}
8280 evince and xpdf – allow at least to reload the document and jump to a specific
8281 page of the file, so you can at least navigate
8282 \begin_inset Quotes eld
8286 \begin_inset Quotes erd
8290 This latter functionality is provided by an external call of synctex (see
8291 the predefined example configurations).
8295 \begin_layout Standard
8296 Forward search works both with DVI and PDF output.
8298 simply checks which preview format you have used before (i.
8299 \begin_inset space \thinspace{}
8302 e., which format is already there in the temporary directory) and chooses
8303 the appropriate configuration for the respective format.
8306 \begin_layout Chapter
8307 Special Document Classes
8310 \begin_layout Section
8314 \begin_layout Standard
8320 \begin_layout Subsection
8324 \begin_layout Standard
8325 This section describes how \SpecialChar LyX
8326 can be used to write articles for submission
8327 to the scientific journal
8329 Astronomy and Astrophysics
8332 \begin_inset Flex URL
8335 \begin_layout Plain Layout
8337 http://www.edpsciences.fr/aa/
8342 ) using Version 5.01 of the document class
8347 This package can be downloaded from the ftp site
8350 \begin_layout Standard
8351 \begin_inset VSpace medskip
8357 \begin_layout Standard
8359 \begin_inset Flex URL
8362 \begin_layout Plain Layout
8364 ftp://ftp.edpsciences.org/pub/aa/readme.html
8372 \begin_layout Standard
8373 \begin_inset VSpace medskip
8379 \begin_layout Standard
8380 A manual comes together with that package, and this text is not meant to
8381 replace the original manual but is merely a short guide in how to realize
8382 the correct form of your paper.
8386 \begin_layout Standard
8387 Please note that the publisher of the journal was changed from Springer
8388 to EDP Sciences starting January 1, 2001.
8389 That change involved also some slight changes to the style files, namely
8390 the removal of the thesaurus command.
8391 The \SpecialChar LyX
8392 class aa supports the newest version of these style files, V 5.01.
8393 If you have an older version installed, please upgrade.
8394 For compatibility, the old (version 4) layout has been kept as
8399 Please refer to the comments in
8402 Dir/layouts/aapaper.layout
8407 \begin_layout Subsection
8411 \begin_layout Standard
8412 It is recommended you start from the example template distributed with \SpecialChar LyX
8414 If you are not using a template, note the following settings:
8417 \begin_layout Itemize
8424 Document\SpecialChar menuseparator
8427 dialog (OK, that one was obvious).
8430 \begin_layout Itemize
8431 Don't change the option
8434 \begin_inset space ~
8444 The whole layout is done by the macros, you shouldn't change anything.
8447 \begin_layout Subsection
8451 \begin_layout Standard
8452 First thing to enter is the header information.
8453 It consists of seven entries, of which some are optional.
8457 \begin_layout Itemize
8465 \begin_layout Itemize
8473 \begin_layout Itemize
8481 \begin_layout Itemize
8489 \begin_layout Itemize
8494 : [optional] if more than one author: whom to contact for offprint requests.
8497 \begin_layout Itemize
8502 : [optional] mail address for contacts.
8505 \begin_layout Itemize
8513 Received: <date>; Accepted <date>
8516 \begin_layout Standard
8517 There is no need to issue the
8523 command, this is done automatically by \SpecialChar LyX
8524 when the header is finished.
8525 Although the order of the single header entries doesn't matter it is advised
8526 to keep the above sequence, just to get the best optics and meets the layout
8527 of the real document.
8530 \begin_layout Standard
8531 If you want to place footnotes in the header block, e.
8532 \begin_inset space \thinspace{}
8536 \begin_inset space \space{}
8539 to state your present address, just use the standard footnote via the menu
8542 Insert\SpecialChar menuseparator
8547 will automagically use the term
8556 \begin_layout Standard
8557 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8559 have no counterpart in \SpecialChar LyX
8563 \begin_layout Itemize
8570 to separate different names for more than one author and institute, respectivel
8574 \begin_layout Itemize
8581 to mark corresponding author/institute pairs.
8582 The institutes are numbered sequentially as they appear in the
8586 field, so you have to put a marker to each author.
8589 \begin_layout Itemize
8596 to supply an email address for fast contact.
8599 \begin_layout Standard
8600 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8608 \begin_layout Subsection
8612 \begin_layout Standard
8613 The abstract should immediately follow the header block.
8614 With version 5 the abstract environment was changed to a command, and there
8615 is now a resctriction to only one paragraph.
8616 In addition, it should contain an entry with the keywords.
8617 This is not yet implemented for \SpecialChar LyX
8618 , therefore you have to enter the \SpecialChar LaTeX
8626 by hand and mark it as \SpecialChar LaTeX
8628 Refer to the example paper.
8631 \begin_layout Subsection
8632 Supported environments
8635 \begin_layout Standard
8636 The A&A paper layout supports the following environments for structuring
8640 \begin_layout Itemize
8646 \begin_layout Itemize
8652 \begin_layout Itemize
8658 \begin_layout Itemize
8664 \begin_layout Itemize
8670 \begin_layout Itemize
8676 \begin_layout Itemize
8682 \begin_layout Itemize
8688 \begin_layout Itemize
8694 \begin_layout Itemize
8700 \begin_layout Itemize
8706 \begin_layout Itemize
8713 \begin_layout Subsection
8714 Commands not supported by \SpecialChar LyX
8718 \begin_layout Standard
8719 Some commands are not yet supported by the
8723 layout for \SpecialChar LyX
8725 Some have already been mentioned.
8726 For the sake of completeness, they are listed all together here:
8729 \begin_layout Itemize
8737 \begin_layout Itemize
8745 \begin_layout Itemize
8753 \begin_layout Itemize
8761 \begin_layout Itemize
8769 \begin_layout Itemize
8777 \begin_layout Itemize
8785 \begin_layout Itemize
8793 \begin_layout Standard
8794 If you want to use any of these commands, you have to enter them yourself.
8797 Do not forget to mark them as \SpecialChar LaTeX
8801 \begin_layout Subsection
8802 Figure and Table Floats
8805 \begin_layout Standard
8807 provides support for the necessary float environments
8809 figure, figure*, table
8815 , therefore we won't tell much about it here.
8819 \begin_inset space ~
8825 Just remember that tables should be left-aligned.
8826 For that, select the table and change the alignment in
8828 Edit\SpecialChar menuseparator
8830 \begin_inset space ~
8836 \begin_layout Standard
8837 There is only one special thing: the figures with caption besides the figure.
8838 To create such a figure, you have to do the following:
8841 \begin_layout Enumerate
8842 Create a wide figure float:
8844 Insert\SpecialChar menuseparator
8845 Float\SpecialChar menuseparator
8848 , then right click in the figure and select
8851 \begin_inset space ~
8859 \begin_layout Enumerate
8860 Enter your caption text.
8863 \begin_layout Enumerate
8868 to move the cursor above the caption.
8871 \begin_layout Enumerate
8875 \begin_layout Enumerate
8876 Position the cursor behind the figure and insert a horizontal fill:
8878 Insert\SpecialChar menuseparator
8880 \begin_inset space ~
8883 Character\SpecialChar menuseparator
8885 \begin_inset space ~
8893 \begin_layout Enumerate
8894 Switch to \SpecialChar LaTeX
8898 \begin_inset space ~
8906 \begin_layout Enumerate
8916 Do not close the brace!
8919 \begin_layout Enumerate
8920 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8925 \begin_inset space ~
8937 \begin_layout Standard
8938 Also, refer to the figures in the example paper.
8941 \begin_layout Subsection
8945 \begin_layout Standard
8946 For submission, the paper has to be formated in a special double-spacing
8948 For this purpose, you have to give the option
8952 to the documentclass.
8953 This must be done using the extra class options field in the
8955 Document\SpecialChar menuseparator
8959 Just enter the string
8966 \begin_layout Subsection
8970 \begin_layout Standard
8975 directory contains an example paper written with \SpecialChar LyX
8977 It is the example paper from the original macro package, translated to
8980 Use it for inspiration, and compare the original \SpecialChar LaTeX
8981 code with \SpecialChar LyX
8985 \begin_layout Section
8990 \begin_layout Standard
8996 \begin_layout Subsection
9000 \begin_layout Standard
9002 is a set of macros produced by the American Astronomical Society to
9003 facilitate electronic manuscript submission to the three journals they
9004 publish: the Astrophysical Journal (including the Letters and Supplement),
9005 the Astronomical Journal, and the Publications of the Astronomical Society
9008 has proven to be an excellent tool for generating these documents, especially
9009 given its equation, citation, and figure handling capabilities.
9011 requires version 5.0 (or higher) of these macros; preferably 5.2, which
9012 is the version described here, or higher.
9013 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9014 2.09 and are fundamentally
9015 incompatible with \SpecialChar LyX
9017 The AAS\SpecialChar TeX
9018 package may be downloaded from the AAS\SpecialChar TeX
9022 \begin_layout Standard
9023 \begin_inset VSpace medskip
9029 \begin_layout Standard
9031 \begin_inset Flex URL
9034 \begin_layout Plain Layout
9036 https://aas.org/aastex/aastex-downloads
9044 \begin_layout Standard
9045 \begin_inset VSpace medskip
9051 \begin_layout Standard
9052 A complete user guide is contained in that package and you should familiarize
9053 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9056 will not reduce the need to figure out all the AAS\SpecialChar TeX
9057 commands, it will only
9058 reduce the drudgery of typing everything in.
9059 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9061 completely to the requirements of the journal to which you are submitting
9065 \begin_layout Subsection
9066 Starting a New Paper
9069 \begin_layout Standard
9070 I strongly suggest that you start with the AAS\SpecialChar TeX
9074 File\SpecialChar menuseparator
9081 , enter the new file name, then choose the
9086 This will show the most common fields found in a manuscript.
9087 Simply overwrite the existing text (including the brackets,
9091 ) with the correct information.
9092 Many of the AAS\SpecialChar TeX
9093 commands and environments can be implemented directly in
9095 , but some cannot: most noticeably
9107 , which should stick out like a sore thumb if you actually just opened the
9109 For commands such as these, the \SpecialChar LaTeX
9110 code must be entered directly and marked
9112 Such commands are referred to as \SpecialChar TeX
9113 code, or Evil Red Text.
9114 I tried to minimize the amount of \SpecialChar TeX
9115 code needed in an AAS\SpecialChar TeX
9117 there is still a bit more required than any of us would like.
9120 \begin_layout Subsection
9121 Finishing Your Paper
9124 \begin_layout Standard
9125 When the paper is finished to your satisfaction and previews/prints correctly,
9127 \begin_inset Quotes eld
9131 \begin_inset Quotes erd
9134 actions which need to be done before you submit it to the journals.
9138 \begin_layout Enumerate
9139 Export your paper as a \SpecialChar LaTeX
9142 File\SpecialChar menuseparator
9143 Export\SpecialChar menuseparator
9151 \begin_layout Enumerate
9156 file with your favorite text editor
9160 \begin_layout Enumerate
9161 remove the comment lines before the
9170 \begin_layout Enumerate
9175 usepackage...{fontenc}
9177 line if it appears (usually just after
9192 \begin_layout Enumerate
9193 remove everything between (and including) the
9205 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9207 (which should appear immediately after the
9208 \begin_inset Quotes eld
9211 User specified \SpecialChar LaTeX
9213 \begin_inset Quotes erd
9224 \begin_layout Enumerate
9225 Run the resulting file through \SpecialChar LaTeX
9226 to make sure it still processes correctly.
9229 \begin_layout Enumerate
9230 Reread the journal requirements to make sure your filenames and formats
9234 \begin_layout Enumerate
9238 \begin_layout Subsection
9239 Comments On Specific Commands
9242 \begin_layout Standard
9243 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9250 ) gives a good description of each.
9251 Thus it's probably easiest for me to go down the list as found in the guide
9252 and offer comments where necessary.
9253 So let's begin \SpecialChar ldots
9257 \begin_layout Subsubsection
9258 Things that work as expected
9261 \begin_layout Standard
9262 Because they work as you might expect, I simply list them and the section
9363 begin{thebibliography}
9371 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9372 graphicx figure commands (2.14.1),
9396 (2.15.4, amongst other places),
9423 \begin_layout Standard
9424 The following style options also work correctly:
9445 Simply put them in the
9451 Layout\SpecialChar menuseparator
9457 \begin_layout Subsubsection
9458 Things that work, but require more comment
9461 \begin_layout Standard
9462 The following items work, but require a little more discussion:
9465 \begin_layout Itemize
9466 These items are reserved for use by the journal editors, but you can put
9467 them into the \SpecialChar LaTeX
9468 preamble if you feel compelled to do so:
9501 \begin_layout Itemize
9502 These items may be placed in the \SpecialChar LaTeX
9503 preamble, and are included as blanks in
9525 \begin_layout Itemize
9532 (2.3) – can only be used
9533 \begin_inset Quotes eld
9537 \begin_inset Quotes erd
9540 , not in the middle of a paragraph.
9541 Use \SpecialChar TeX
9542 code if you need to embed it.
9545 \begin_layout Itemize
9552 (2.3) – will have extra {} after it.
9553 This should not cause an error.
9556 \begin_layout Itemize
9563 (2.6) – can only be used
9564 \begin_inset Quotes eld
9568 \begin_inset Quotes erd
9571 , not in the middle of a paragraph.
9572 Use \SpecialChar TeX
9573 code if you need to embed it.
9576 \begin_layout Itemize
9583 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9587 \begin_layout Itemize
9601 \begin_layout Itemize
9608 (2.9) – will have extra {} after it.
9609 This should not cause an error.
9612 \begin_layout Itemize
9619 (2.11) – will have extra {} after it.
9620 This should not cause an error.
9623 \begin_layout Itemize
9630 (2.14.2) – you can insert an optional filename argument by placing the cursor
9631 at the beginning of the text and selecting
9633 Insert\SpecialChar menuseparator
9638 \begin_inset Quotes eld
9642 \begin_inset Quotes erd
9645 inserts an optional argument of the type needed by
9652 Hopefully it will be renamed someday.
9655 \begin_layout Itemize
9668 for the catalog ID optional parameter
9671 \begin_layout Itemize
9684 for the catalog ID optional parameter
9687 \begin_layout Subsubsection
9688 Things not implemented, use \SpecialChar TeX
9692 \begin_layout Standard
9715 setcounter{equation}
9717 (2.12), Journal name abbreviations (2.13.4),
9753 (2.15.4, insert it as the first element in the lefthand cell after where
9755 Don't use any of \SpecialChar LyX
9756 's rules in the table),
9768 (2.15.5), much of Misc (2.17, except
9819 \begin_layout Subsubsection
9820 Things that cannot be implemented
9823 \begin_layout Standard
9825 at least in any meaningful sort of way, so I suggest ignoring them.
9826 They are the references environment (2.13.3), and the deluxetable environment
9828 If you really, really need to use deluxetable, I suggest editing it in
9829 a separate file with a text editor, then using
9831 Insert\SpecialChar menuseparator
9833 \begin_inset space ~
9838 to include it in your \SpecialChar LyX
9844 file to see an example of this.
9847 \begin_layout Subsection
9848 FAQs, Tips, Tricks, and Other Ruminations
9851 \begin_layout Subsubsection
9852 Getting \SpecialChar LyX
9853 and AAS\SpecialChar TeX
9857 \begin_layout Standard
9858 It can be a bit tricky to get \SpecialChar LyX
9859 to recognize a new layout and document class.
9860 When all else fails, do this:
9863 \begin_layout Enumerate
9864 Make certain that \SpecialChar LaTeX
9865 can find AAS\SpecialChar TeX
9867 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9869 directory completely unrelated to \SpecialChar LaTeX
9870 or AAS\SpecialChar TeX
9871 and run \SpecialChar LaTeX
9879 \begin_layout Enumerate
9884 appears in \SpecialChar LyX
9892 \begin_layout Enumerate
9895 Tools\SpecialChar menuseparator
9899 , then restart \SpecialChar LyX
9903 \begin_layout Enumerate
9904 Open a regular new file, not from a template.
9905 Does AAS\SpecialChar TeX
9906 appear in the class list in
9908 Document\SpecialChar menuseparator
9914 \begin_layout Standard
9915 If you get a warning from an existing AAS\SpecialChar TeX
9916 document about not being able
9917 to find the AAS\SpecialChar TeX
9918 layout or a message about
9919 \begin_inset Quotes eld
9922 You should not mix title layouts with normal ones
9923 \begin_inset Quotes erd
9926 , things haven't been installed correctly.
9929 \begin_layout Subsubsection
9931 error processing a table
9934 \begin_layout Standard
9936 , by default, attempts to center the table caption/title.
9937 This seems to produce a bad interaction in AAS\SpecialChar TeX
9938 so you should click somewhere
9939 in the caption/title, then select
9941 Edit\SpecialChar menuseparator
9943 \begin_inset space ~
9957 This took care of it for me.
9960 \begin_layout Subsubsection
9964 \begin_layout Standard
9965 A couple of things: 1) I have noticed some funny spacing in the reference
9966 entries in the text.
9967 When you enter the bibliography item data, make sure their is
9971 space between the last author and the parenthesis setting off the year;
9975 \begin_inset space \thinspace{}
9979 \begin_inset space \space{}
9993 2) Entering the references at all is not obvious.
9994 The easiest thing is to start typing your first reference at the end of
9995 the document, then mark it as type
10000 That will put a small gray box in front of what you just typed.
10001 Click on the box to fill in the rest of the information.
10002 For new references, go to the end of an existing reference and press return.
10003 That will create a new line with its own box, etc.
10006 \begin_layout Subsubsection
10007 Including EPS files
10010 \begin_layout Standard
10011 Even though AAS\SpecialChar TeX
10012 provides its own figure commands (
10018 , for example), I much prefer \SpecialChar LaTeX
10019 's standard figure commands (with the default
10028 \begin_inset space ~
10031 commands as \SpecialChar TeX
10032 code into a Figure Float box if you desire, but I never have
10033 much luck getting the layout right.
10034 With the standard graphics, \SpecialChar LyX
10039 usepackage{graphicx}
10041 command into the \SpecialChar LaTeX
10042 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10044 interspersing the figures in the text.
10045 I believe ApJ accepts figures exactly this way now; AJ might still use
10047 \begin_inset Quotes eld
10050 stack everything at the end
10051 \begin_inset Quotes erd
10057 \begin_layout Subsubsection
10058 Things I could have done, but didn't
10061 \begin_layout Standard
10063 \begin_inset Quotes eld
10067 \begin_inset Quotes erd
10070 things I could have implemented, but chose not to.
10071 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10073 even though it is double-spaced in the paper manuscript.
10074 Also, I chose not to make separate layouts for the preprint and preprint2
10076 Since I assume you will spend most of your time in the plain manuscript
10077 mode anyway, I decided not to chew up more disk space with this.
10081 \begin_layout Subsection
10085 \begin_layout Standard
10086 Your mileage may vary.
10087 I've now had papers published by both ApJ and AJ that have had 98% of the
10088 effort done in \SpecialChar LyX
10089 ; the last 2% was the \SpecialChar LaTeX
10090 post-processing and a few cleanups.
10091 I have had no trouble with the submission process, and I'm sure the journals
10092 were never aware that there might be a difference.
10093 So, go forth and publish!
10096 \begin_layout Section
10097 AMS \SpecialChar LaTeX
10101 \begin_layout Standard
10111 \begin_layout Standard
10112 \begin_inset VSpace bigskip
10118 \begin_layout Standard
10120 The AMS \SpecialChar LaTeX
10121 layouts are set up to conform to suggested styles for mathematical
10122 papers to be submitted to American Mathematical Society publications.
10123 The layouts are not tailored to a specific journal, but easily can be.
10124 You should refer to the AMS documentation for specific instructions for
10125 each journal (usually it will entail only changing a single line in the
10128 That documentation is available on the Web at
10129 \begin_inset Flex URL
10132 \begin_layout Plain Layout
10140 \begin_inset Flex URL
10143 \begin_layout Plain Layout
10145 ftp://ftp.ams.org/pub/tex/amslatex/
10151 These layouts are appropriate, and useful, for any mathematical writing.
10155 \begin_layout Standard
10156 There are two basic AMS \SpecialChar LaTeX
10160 \begin_layout Itemize
10161 amsart: The standard AMS article format.
10164 \begin_layout Itemize
10165 amsbook: the standard AMS book (really, monograph) format.
10169 \begin_layout Standard
10170 The layouts themselves contain only the minimum necessary to use the AMS
10172 They do not, in particular, contain any of the `theorem' environments used
10173 for setting theorems, lemmas, and the like.
10174 These are contained, instead, in the
10175 \begin_inset Flex Code
10178 \begin_layout Plain Layout
10184 module, which is loaded by default when you select one of the AMS classes.
10185 (It can also be used with other classes and can be removed, if you would
10186 rather use something else.) Less commonly used environments are in the
10187 \begin_inset Flex Code
10190 \begin_layout Plain Layout
10191 Theorems (AMS-Extended)
10196 module, which must be loaded manually.
10199 \begin_layout Standard
10200 By default, theorems and the like are numbered consecutively throughout
10201 the document, but this may be modified by loading the module
10202 \begin_inset Flex Code
10205 \begin_layout Plain Layout
10206 Theorems (Order by Section)
10211 or, if you are using
10212 \begin_inset Flex Code
10215 \begin_layout Plain Layout
10222 \begin_inset Flex Code
10225 \begin_layout Plain Layout
10226 Theorems (Order by Chapter)
10232 These will number the results as
10233 \begin_inset Formula $n.m$
10236 , where the first number refers to the section (or chapter) and the second
10237 refers to the total number of results so far in that section (or chapter).
10238 Many environments are also available unnumbered.
10239 These are indicated by an asterisk at the end.
10240 If you happen to want
10244 unnumbered results, the module
10245 \begin_inset Flex Code
10248 \begin_layout Plain Layout
10254 provides that option.
10257 \begin_layout Standard
10258 Note that these modules do not
10262 to be used with the AMS classes.
10263 It is perfectly possible to use the
10264 \begin_inset Flex Code
10267 \begin_layout Plain Layout
10273 module, and the others mentioned, with other classes, such as
10274 \begin_inset Flex Code
10277 \begin_layout Plain Layout
10284 \begin_inset Flex Code
10287 \begin_layout Plain Layout
10294 \begin_inset Flex Code
10297 \begin_layout Plain Layout
10306 \begin_layout Subsection
10307 What these layouts provide
10310 \begin_layout Standard
10311 There is a long list of included environments provided by these layouts.
10312 In AMS-\SpecialChar LaTeX
10313 , there is, in fact, an opportunity to define an unlimited variety
10314 of `theorem' environments.
10315 However, the AMS recommends the environments that are available in \SpecialChar LyX
10320 \begin_layout Standard
10321 The following environments—as well as the standard environments, such as
10323 \begin_inset Flex Noun
10326 \begin_layout Plain Layout
10333 \begin_inset Flex Noun
10336 \begin_layout Plain Layout
10343 \begin_inset Flex Noun
10346 \begin_layout Plain Layout
10353 \begin_inset Flex Noun
10356 \begin_layout Plain Layout
10363 \begin_inset Flex Noun
10366 \begin_layout Plain Layout
10373 \begin_inset Flex Code
10376 \begin_layout Plain Layout
10383 \begin_inset Flex Code
10386 \begin_layout Plain Layout
10395 \begin_layout Description
10396 Address This should be the author's permanent address.
10399 \begin_layout Description
10401 \begin_inset space ~
10404 Address This should be the author's temporary address at the time of submission,
10405 if different from the Address.
10408 \begin_layout Description
10409 Email Author's e-mail address
10412 \begin_layout Description
10413 URL Author's Web address, if desired.
10416 \begin_layout Description
10417 Keywords Key words or phrases used to identify specific topics discussed
10421 \begin_layout Description
10422 Subjectclass These refer to the AMS Subject Classifications, published and
10425 Mathematical Reviews
10428 These are also available online at the AMS cites listed above.
10431 \begin_layout Description
10435 \begin_layout Description
10439 \begin_layout Description
10443 \begin_layout Standard
10444 The following environments are provided by both the
10445 \begin_inset Flex Code
10448 \begin_layout Plain Layout
10455 \begin_inset Flex Code
10458 \begin_layout Plain Layout
10464 modules, in the latter case in both starred (unnumbered) and unstarred
10465 (numbered) versions.
10466 These same environments are provided only in the starred versions by the
10468 \begin_inset Flex Code
10471 \begin_layout Plain Layout
10480 \begin_layout Theorem
10481 This is typically used for the statements of major results.
10485 \begin_layout Corollary*
10486 This is used for statements which follow fairly directly from previous statement
10488 Again, these can be major results.
10492 \begin_layout Lemma
10493 These are smaller results needed to prove other statements.
10496 \begin_layout Proposition
10497 These are less major results which (hopefully) add to the general theory
10501 \begin_layout Conjecture
10502 These are statements provided without justification, which the author does
10503 not know how to prove, but which seem to be true (to the author, at least).
10506 \begin_layout Definition*
10507 Guess what this is for.
10508 The font is different for this environment than for the previous ones.
10512 \begin_layout Example*
10513 Used for examples illustrating proven results.
10516 \begin_layout Problem
10517 It's not really known what this is for.
10518 You should figure it out.
10521 \begin_layout Exercise*
10522 Write a description for this one.
10525 \begin_layout Remark
10526 This environment is also a type of theorem, usually a lesser sort of observation.
10529 \begin_layout Claim*
10530 Often used in the course of giving a proof of a larger result.
10534 Generally, these are used to break up long arguments, using specific instances
10540 The numbering scheme for cases is on its own, not together with other numbered
10545 \begin_layout Proof
10546 At the end of this environment, a QED symbol (usually a square, but it can
10547 vary with different styles) is placed.
10548 If you want to have other environments within this one—for example, Case
10549 environments—and have the QED symbol appear only after them, then the other
10550 environments need to be nested within the proof environment.
10553 Nesting Environments
10559 for information on nesting.
10562 \begin_layout Standard
10563 And these environments are provided by
10564 \begin_inset Flex Code
10567 \begin_layout Plain Layout
10568 Theorems (AMS-Extended)
10576 \begin_layout Criterion*
10577 A required condition.
10580 \begin_layout Algorithm*
10581 A general procedure to be used.
10584 \begin_layout Axiom*
10585 This is a property or statement taken as true within the system being discussed.
10588 \begin_layout Condition*
10589 Sometimes used to state a condition assumed within the present context of
10593 \begin_layout Note*
10594 Similar to a Remark.
10597 \begin_layout Notation*
10598 Used for the explanation of, yes, notation.
10601 \begin_layout Summary
10602 Do we really need to tell you?
10605 \begin_layout Acknowledgement*
10609 \begin_layout Conclusion*
10610 Sometimes used at the end of a long train of argument.
10614 Used in a way similar to Proposition, though perhaps lower on the scale.
10617 \begin_layout Standard
10618 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10621 They need to be available on your system in order to use these environments.
10624 \begin_layout Section
10632 \begin_layout Standard
10638 \begin_layout Subsection
10642 \begin_layout Standard
10643 These are the layout files for some of the journals of the American Geophysical
10645 It is assumed that you have both the AGU's own class files and AGUplus
10646 installed (everything to be found at
10647 \begin_inset Flex URL
10650 \begin_layout Plain Layout
10652 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10660 \begin_layout Subsection
10664 \begin_layout Standard
10674 They are still called this in the \SpecialChar LyX
10675 GUI, though their \SpecialChar LaTeX
10688 \begin_layout Standard
10689 Newly defined styles are
10726 These are mostly manuscript attributes and defined in the AGU class documentati
10730 \begin_layout Standard
10731 I suspect this is still badly incomplete.
10734 \begin_layout Subsection
10738 \begin_layout Standard
10755 \begin_layout Subsection
10759 \begin_layout Itemize
10762 Journal of Geophysical Research
10771 \begin_layout Standard
10772 Add your own, it isn't so hard! Look at the
10783 \begin_layout Subsection
10784 Bugs and things to remember
10787 \begin_layout Standard
10788 In order to use the new layouts, you must remember to do the following for
10792 \begin_layout Enumerate
10798 This can be done in the
10800 Layout\SpecialChar menuseparator
10805 Document\SpecialChar menuseparator
10809 (AGU articles are always in English, right? So
10813 choose a language.)
10816 \begin_layout Enumerate
10821 into the document's
10826 (Yes, this is a bug.)
10829 \begin_layout Enumerate
10830 Make sure you use the
10834 bibliography style, by entering
10838 into the second field of the Bib\SpecialChar TeX
10840 None of the standard styles will do.
10843 \begin_layout Section
10847 \begin_layout Standard
10853 \begin_layout Subsection
10857 \begin_layout Standard
10858 Broadway is for writing plays.
10859 The format is more decorative than Hollywood, and much less standardized.
10860 This format should be suitable for workshops.
10863 \begin_layout Subsection
10867 \begin_layout Standard
10868 The same as in Hollywood.
10871 \begin_layout Subsection
10875 \begin_layout Standard
10880 names as labels then cross-reference the label to insert the name.
10881 The cross-reference dialog will show the current cast of characters.
10884 \begin_layout Subsection
10885 Paper size and Margins
10888 \begin_layout Standard
10889 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10892 \begin_layout Subsection
10896 \begin_layout Standard
10897 The following environments are available.
10898 You can use broadway.bind to get the bind keys shown at the right.
10901 \begin_layout Itemize
10905 \begin_inset Newline newline
10910 You should not have to use this, but it is here for anything that does not
10914 \begin_layout Itemize
10918 \begin_inset space \hfill{}
10922 \begin_inset Newline newline
10927 Used to describe stage setting and the action.
10928 First use of speaker names in all CAPs.
10931 \begin_layout Itemize
10935 \begin_inset space \hfill{}
10939 \begin_inset Newline newline
10944 Automatically numbered.
10945 On screen it will be arabic, but will print as Roman.
10948 \begin_layout Itemize
10952 \begin_inset space \hfill{}
10956 \begin_inset Newline newline
10966 It is just centered text.
10969 \begin_layout Itemize
10973 \begin_inset space \hfill{}
10977 \begin_inset Newline newline
10982 Not automatically numbered.
10983 You supply the number.
10984 This is because I couldn't figure out how.
10987 \begin_layout Itemize
10991 \begin_inset space \hfill{}
10995 \begin_inset Newline newline
11000 A special case of Narrative to describe the setting and action as the curtain
11004 \begin_layout Itemize
11008 \begin_inset space \hfill{}
11012 \begin_inset Newline newline
11017 The speaker's (actor's) title, centered in all CAPS.
11020 \begin_layout Itemize
11024 \begin_inset space \hfill{}
11028 \begin_inset Newline newline
11033 Instructions to the speaker.
11034 The parentheses are automatically inserted.
11035 The ( will appear on screen, but both will be in the printed play.
11036 This environment is only used within
11043 \begin_layout Itemize
11047 \begin_inset space \hfill{}
11051 \begin_inset Newline newline
11056 What the Speaker says.
11059 \begin_layout Itemize
11063 \begin_inset space \hfill{}
11067 \begin_inset Newline newline
11072 The curtain comes down.
11075 \begin_layout Itemize
11079 \begin_inset space \hfill{}
11085 \begin_layout Itemize
11089 \begin_inset space \hfill{}
11095 \begin_layout Itemize
11099 \begin_inset space \hfill{}
11105 \begin_layout Standard
11109 \begin_layout Section
11113 \begin_layout Standard
11118 can be used to type letters according to German conventions.
11119 A template file is included in
11121 .../lyx/share/templates
11123 for you to use as a starting point.
11126 \begin_layout Section
11134 \begin_layout Standard
11140 \begin_layout Subsection
11144 \begin_layout Standard
11145 This is the layout file for the European Geophysical Society journals.
11150 can be downloaded from the web site of the EGS under
11151 \begin_inset Flex URL
11154 \begin_layout Plain Layout
11164 \begin_layout Subsection
11168 \begin_layout Standard
11171 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
11179 The current layout file is unfortunately very unmodular and would benefit
11180 from using the various
11187 \begin_layout Section
11191 \begin_layout Standard
11192 See the \SpecialChar LyX
11198 It contains all infos you need.
11201 \begin_layout Section
11204 Foil\SpecialChar TeX
11208 \begin_inset CommandInset label
11217 \begin_layout Standard
11223 \begin_layout Subsection
11227 \begin_layout Standard
11228 This section describes how to use \SpecialChar LyX
11229 to make slides for overhead projectors.
11230 There are two document classes that can do this: the default slides class
11233 Foil\SpecialChar TeX
11237 This section documents the latter.
11240 \begin_layout Standard
11241 I'm going to say this again, nice and clear, so that there's no misunderstanding
11245 \begin_layout Standard
11246 \begin_inset VSpace bigskip
11252 \begin_layout Standard
11256 This section documents the class
11257 \begin_inset Quotes eld
11265 \begin_inset Quotes erd
11273 \begin_layout Standard
11274 \begin_inset VSpace bigskip
11280 \begin_layout Standard
11281 If you're looking for the documentation for
11282 \begin_inset Quotes eld
11290 \begin_inset Quotes erd
11293 , check out section
11294 \begin_inset space ~
11298 \begin_inset CommandInset ref
11300 reference "sec:slitex"
11305 If your machine doesn't have the
11313 installed, you'll probably have to use the default
11317 class, which isn't quite as good as
11322 \begin_layout Standard
11327 class is designed for use with version
11328 \begin_inset space ~
11336 class file which is now an integral part of \SpecialChar LaTeX2e
11340 \begin_layout Subsection
11344 \begin_layout Standard
11345 Obviously, to use this document class, you need to select
11356 \begin_inset space ~
11362 There are some settings in the
11365 \begin_inset space ~
11370 dialog that you should know about that are specific to this class:
11373 \begin_layout Itemize
11374 Don't change the options
11385 \begin_inset space ~
11391 They're ignored by the
11398 \begin_layout Itemize
11399 The default font size is 20
11400 \begin_inset space \thinspace{}
11403 pt with the other options being 17
11404 \begin_inset space \thinspace{}
11408 \begin_inset space \thinspace{}
11412 \begin_inset space \thinspace{}
11418 \begin_layout Itemize
11419 The default font is
11427 but all math equations are still typeset in the usual roman font.
11430 \begin_layout Itemize
11433 Foil\SpecialChar TeX
11436 supports A4 and Letter paper sizes as well as a special size for working
11438 \begin_inset space \thinspace{}
11442 It doesn't support A5, B5, legal or executive paper sizes.
11445 \begin_layout Itemize
11446 Don't bother changing the
11450 settings because they are ignored anyway.
11451 All floats appear where they are defined in the text.
11454 \begin_layout Itemize
11459 setting behaves a bit differently for this class.
11462 Foil\SpecialChar TeX
11465 provides extensive footer and header capabilities including a user-defined
11468 \begin_inset space ~
11472 \begin_inset CommandInset ref
11474 reference "sec:foilfoot"
11479 The title page is treated differently to all other pages in the document
11488 has the logo centered at the bottom of the page (if one is defined).
11489 The possible page style choices and what they do are as follows:
11493 \begin_layout Labeling
11494 \labelwidthstring MMMMMMM
11501 The final output contains no page numbers, or other headers or footers
11502 (except footnotes of course).
11506 \begin_layout Labeling
11507 \labelwidthstring MMMMMMM
11514 The final output contains page numbers centered at the bottom of the page.
11515 No other headings or footers (other than footnotes).
11518 \begin_layout Labeling
11519 \labelwidthstring MMMMMMM
11524 Page numbers in lower right corner.
11525 Additional headers and footers are also shown.
11526 This is also the default.
11529 \begin_layout Labeling
11530 \labelwidthstring MMMMMMM
11535 Gives you access to the
11539 package although its use with
11541 Foil\SpecialChar TeX
11544 is discouraged by the writer of the
11546 Foil\SpecialChar TeX
11549 package because of some potential page layout clashes.
11553 \begin_layout Subsubsection
11557 \begin_layout Standard
11558 The following options may be used in the extra class options in the
11560 Document\SpecialChar menuseparator
11566 \begin_layout Labeling
11567 \labelwidthstring MMMMMMx
11572 This sets up the page layout for 7.33
11573 \begin_inset space \thinspace{}
11577 \begin_inset space \thinspace{}
11580 in paper, which is about the same aspect ratio as a 35
11581 \begin_inset space \thinspace{}
11584 mm slide, making it a bit easier to work with this medium.
11587 \begin_layout Labeling
11588 \labelwidthstring MMMMMMx
11593 Places a rule across the page below the header on every page except the
11597 \begin_layout Labeling
11598 \labelwidthstring MMMMMMx
11603 Places a rule across the page above the footer on every page except the
11607 \begin_layout Labeling
11608 \labelwidthstring MMMMMMx
11613 This is automatically set each time you create a new
11620 Foil\SpecialChar TeX
11623 to use the dvips driver to rotate those pages that are set as landscape
11627 \begin_layout Labeling
11628 \labelwidthstring MMMMMMx
11633 Simply changes the page dimensions to those of a landscape page but doesn't
11635 Thus if you use this option you need to use an external program to rotate
11636 each page or feed your paper through your printer as landscape.
11637 Note that this option effectively reverses the roles of the
11645 environments (don't worry these are described in the next section).
11648 \begin_layout Labeling
11649 \labelwidthstring MMMMMMx
11654 Equation numbers on the left.
11657 \begin_layout Labeling
11658 \labelwidthstring MMMMMMx
11663 Flush-left equations.
11666 \begin_layout Subsection
11667 Supported Environments
11670 \begin_layout Standard
11671 Most of the environments commonly supported in other classes are also supported
11677 There are several additional environments provided by
11679 Foil\SpecialChar TeX
11682 as well as a couple added by \SpecialChar LyX
11684 The following environments are shared with other classes:
11687 \begin_layout Standard
11688 \begin_inset Flex Multiple Columns
11691 \begin_layout Itemize
11697 \begin_layout Itemize
11703 \begin_layout Itemize
11709 \begin_layout Itemize
11715 \begin_layout Itemize
11721 \begin_layout Itemize
11728 \begin_layout Itemize
11734 \begin_layout Itemize
11740 \begin_layout Itemize
11746 \begin_layout Itemize
11752 \begin_layout Itemize
11758 \begin_layout Itemize
11764 \begin_layout Itemize
11770 \begin_layout Itemize
11776 \begin_layout Itemize
11782 \begin_layout Itemize
11788 \begin_layout Itemize
11794 \begin_layout Itemize
11805 \begin_layout Standard
11806 That is, all the major environments apart from the sectioning environments.
11807 Since foils are essentially self-contained sections, with a title and body,
11810 Foil\SpecialChar TeX
11813 provides specific commands for starting new foils and these are:
11816 \begin_layout Itemize
11822 \begin_layout Itemize
11828 \begin_layout Standard
11830 also provides slightly modified versions of these two environments called:
11833 \begin_layout Itemize
11839 \begin_layout Itemize
11842 ShortRotatefoilhead
11845 \begin_layout Standard
11846 and the differences will be explained in the next section.
11849 \begin_layout Standard
11850 Since foils are often used in presenting ideas or new theorems and such
11853 Foil\SpecialChar TeX
11856 also provides a comprehensive box of goodies for presenting them:
11859 \begin_layout Standard
11860 \begin_inset Flex Multiple Columns
11863 \begin_layout Itemize
11869 \begin_layout Itemize
11875 \begin_layout Itemize
11881 \begin_layout Itemize
11887 \begin_layout Itemize
11893 \begin_layout Itemize
11899 \begin_layout Itemize
11905 \begin_layout Itemize
11911 \begin_layout Itemize
11917 \begin_layout Itemize
11923 \begin_layout Itemize
11934 \begin_layout Standard
11935 The starred versions are unnumbered while the unstarred versions are numbered.
11936 There are also two list environments added by \SpecialChar LyX
11940 \begin_layout Itemize
11946 \begin_layout Itemize
11952 \begin_layout Standard
11955 Foil\SpecialChar TeX
11958 provides some powerful header and footer capabilities that are best set
11959 in the preamble although they may be set at any point in a document.
11960 If you want to change these settings in your document the best place to
11961 do so is at the very top of a foil, i.
11962 \begin_inset space \thinspace{}
11968 \begin_inset space \space{}
11973 straight after the foilhead.
11976 \begin_layout Standard
11977 For this purpose, the following command styles are provided [
11984 \begin_layout Standard
11985 \begin_inset Flex Multiple Columns
11988 \begin_layout Itemize
11992 \begin_inset space ~
11998 \begin_layout Itemize
12004 \begin_layout Itemize
12008 \begin_inset space ~
12014 \begin_layout Itemize
12018 \begin_inset space ~
12024 \begin_layout Itemize
12028 \begin_inset space ~
12035 \begin_layout Plain Layout
12036 \begin_inset space ~
12048 \begin_layout Standard
12049 There are also a few commands provided by
12051 Foil\SpecialChar TeX
12054 that aren't directly supported by \SpecialChar LyX
12055 but I'll tell you what they do and how
12056 to use them in section
12057 \begin_inset space ~
12061 \begin_inset CommandInset ref
12063 reference "sec:unsuppfoils"
12070 \begin_layout Subsection
12071 Building a Set of Foils
12074 \begin_layout Standard
12075 This section will give a simple introduction to using the different environments
12076 to build a set of foils.
12077 If you want to see an example set of foils, take a look at the
12081 file you find in \SpecialChar LyX
12089 \begin_layout Subsubsection
12090 Give It a Title Page
12093 \begin_layout Standard
12094 Unlike other classes that provide
12114 creates the title on a page of its own.
12115 If you leave out the
12119 environment \SpecialChar LaTeX
12120 will substitute the current date (every time you regenerate
12124 \begin_layout Subsubsection
12128 \begin_layout Standard
12129 As I mentioned earlier, there are four ways of starting a new foil.
12130 For portrait foils you should use
12139 The difference between these two environments is the amount of space between
12140 the title of the foil (the foilhead) and the body of the foil.
12143 \begin_layout Standard
12144 Landscape foils are generated using the
12150 ShortRotatefoilhead
12153 Again the only difference is the spacing between foilhead and body.
12154 Both of the short versions have 0.5
12155 \begin_inset space ~
12158 inches less separation between the foilhead and the body.
12162 \begin_layout Standard
12163 One problem with the support for landscape foils is the requirement that
12164 you have to use the
12168 driver to generate the PostScript output otherwise the foils won't be rotated.
12169 It is possible to get landscape foils even if you haven't got the
12173 driver provided you can feed your foils sideways through your printer ;-)
12176 \begin_layout Subsubsection
12177 Theorems, Lemmas, Proofs and more
12180 \begin_layout Standard
12181 Due to a small bug in \SpecialChar LyX
12182 you can't have two of the same type of these environments
12183 directly following each other.
12184 They must be separated by something.
12185 If you try, you will just be extending the previous environment as if you
12186 had merged the two environments together.
12187 So, how do you get around this problem? The simplest option is to insert
12188 some text between the two environments or add a
12193 environment between the two with just a
12194 \begin_inset Quotes eld
12202 \begin_inset Quotes erd
12206 This will force \SpecialChar LyX
12207 to produce two separate environments and hence the correct
12210 An example is provided in the example file included with the \SpecialChar LyX
12212 Remember, this problem only occurs if you are trying to place two of the
12213 same type of theorem-like environments one directly after the other.
12216 \begin_layout Subsubsection
12220 \begin_layout Standard
12221 You get all the commonly supported list styles found in other classes as
12222 well as two new ones.
12223 I'll only describe the new ones here.
12224 If you want to find out more about the other list environments check out
12230 If you intend to use itemized lists you might also want to read about the
12234 \begin_inset space ~
12238 \begin_inset space ~
12243 dialog described above in section
12244 \begin_inset space ~
12248 \begin_inset CommandInset ref
12250 reference "sec:bullet"
12257 \begin_layout Standard
12258 The two new list styles,
12266 , are designed to make it easier for you to create lists of do's and don'ts
12267 or right and wrong by providing dedicated environments that use a tick
12268 or a cross as the label of the list.
12269 These lists are in fact dedicated variants of the
12274 They do however require that you have the
12278 packages installed.
12281 \begin_layout Subsubsection
12285 \begin_layout Standard
12288 Foil\SpecialChar TeX
12291 redefines the floating tables and figures so that they appear exactly where
12292 they are in the text rather than pushing them to the top of the page or
12293 to some user specified location.
12294 In fact if you change the float placement settings they are simply ignored.
12297 \begin_layout Subsubsection
12298 Page Headers and Footers
12299 \begin_inset CommandInset label
12301 name "sec:foilfoot"
12308 \begin_layout Standard
12312 \begin_inset space ~
12321 are two commands used to control the left-footer text string.
12322 The first is meant to allow you to include a graphic logo on your foils
12324 \begin_inset Quotes eld
12329 Foil\SpecialChar TeX
12333 \begin_inset Quotes erd
12337 While the second is meant to provide a classification for the audience,
12341 \begin_inset space \thinspace{}
12347 \begin_inset space \space{}
12351 It is empty by default.
12354 \begin_layout Standard
12355 The remaining page corners can be filled by
12358 \begin_inset space ~
12363 (which defaults to page numbers),
12366 \begin_inset space ~
12374 \begin_inset space ~
12382 \begin_layout Subsection
12385 Foil\SpecialChar TeX
12389 \begin_inset CommandInset label
12391 name "sec:unsuppfoils"
12398 \begin_layout Standard
12399 All the commands mentioned below need to be set in a
12409 within another environment.
12412 \begin_layout Subsubsection
12416 \begin_layout Standard
12417 All lengths are adjusted using the
12440 should be replaced by the name given to the length you want to change and
12445 is the length value.
12446 All lengths should be specified in units of length such as inches (
12458 ) or relative to some document or font-based length such as
12468 \begin_layout Standard
12469 It's possible to change the spacing between a foilhead and the body of the
12470 foil by adjusting the length specified by
12477 For example, to make
12482 \begin_inset space \space{}
12485 in closer to their bodies put the following in the preamble:
12491 foilheadskip}{-0.5in}
12494 \begin_layout Standard
12495 The spacings around floats can be adjusted by setting these lengths:
12498 \begin_layout Labeling
12499 \labelwidthstring MMMMMMMMMMM
12506 Separation between the text and the top of the float
12509 \begin_layout Labeling
12510 \labelwidthstring MMMMMMMMMMM
12517 Separation between the float and the caption
12520 \begin_layout Labeling
12521 \labelwidthstring MMMMMMMMMMM
12528 Separation between the caption and the following text
12531 \begin_layout Labeling
12532 \labelwidthstring MMMMMMMMMMM
12539 You can make the captions narrower than the surrounding text by adjusting
12541 Best done relative to
12550 \begin_layout Standard
12551 There are also several title page related lengths that you may find useful
12552 if you have a long title or several authors:
12555 \begin_layout Labeling
12556 \labelwidthstring MMMMMMMMMMM
12563 Separation from headers to
12568 \begin_layout Labeling
12569 \labelwidthstring MMMMMMMMMMM
12587 \begin_layout Labeling
12588 \labelwidthstring MMMMMMMMMMM
12602 \begin_layout Labeling
12603 \labelwidthstring MMMMMMMMMMM
12619 \begin_layout Labeling
12620 \labelwidthstring MMMMMMMMMMM
12636 \begin_layout Standard
12637 The last length related command affects all the list environments.
12648 a list environment then all the vertical spacing between the list items
12650 Note that this is a command not a length so it doesn't require
12656 like the stuff mentioned above.
12659 \begin_layout Subsubsection
12660 Headers and Footers
12663 \begin_layout Standard
12676 commands control whether the logo in the
12680 definition appear on a given page.
12687 in the preamble then none of the foils will have the logo on them.
12688 If you don't want the logo on a particular page place the
12694 directly after the foilhead of that page and the
12700 directly after the next foilhead.
12703 \begin_layout Standard
12704 If you decide to use the
12708 page style setting in the
12711 \begin_inset space ~
12716 dialog you should probably add
12726 to your preamble so headers and footers on landscape pages are correctly
12727 placed when rotated.
12728 This is due to some clashes between the page layouts provided by the
12739 \begin_layout Section
12740 Hollywood (Hollywood spec scripts)
12743 \begin_layout Standard
12749 \begin_layout Subsection
12753 \begin_layout Standard
12754 Getting the format of a Hollywood script right is a
12755 \begin_inset Quotes eld
12759 \begin_inset Quotes erd
12762 It is designed to make the readers focus on content and to be easy and
12763 familiar for the actors to read.
12764 Each page of a script should be one minute of film.
12765 Nothing goes in a script that you cannot see or hear on screen.
12766 The courier 12 pt font should be used throughout.
12770 \begin_layout Subsection
12774 \begin_layout Standard
12775 Speakers' lines should NEVER break in mid-sentence.
12776 If a speaker's lines continue over a page break, repeat the
12780 title followed by (Cont'd).
12783 \begin_layout Subsection
12787 \begin_layout Standard
12792 names as labels then cross-reference the label to insert the name.
12793 The cross-reference dialog will show the current cast of characters.
12794 You can use this to insert the speaker name in narratives also.
12797 \begin_layout Subsection
12798 Paper size and Margins
12801 \begin_layout Standard
12802 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12805 \begin_layout Subsection
12809 \begin_layout Standard
12810 The following environments are available.
12811 You can use hollywood.bind to get the bind keys shown at the right.
12814 \begin_layout Itemize
12818 \begin_inset Newline newline
12823 Used where nothing else works.
12827 \begin_layout Itemize
12833 \begin_inset space \hfill{}
12841 \begin_inset Newline newline
12844 Usually followed by something like
12845 \begin_inset Quotes eld
12848 on Sally waking up.
12849 \begin_inset Quotes erd
12855 \begin_layout Itemize
12859 \begin_inset space \hfill{}
12863 \begin_inset Newline newline
12868 Introduces a new INTERIOR camera set-up.
12869 Always followed by DAY or NIGHT, or something similar to define the lighting
12871 Everthing on this line in CAPS.
12874 \begin_layout Itemize
12878 \begin_inset space \hfill{}
12882 \begin_inset Newline newline
12887 Introduces a new EXTERIOR camera set-up.
12888 Everthing on this line in CAPS.
12891 \begin_layout Itemize
12895 \begin_inset space \hfill{}
12899 \begin_inset Newline newline
12904 The character speaking.
12907 \begin_layout Itemize
12911 \begin_inset space \hfill{}
12915 \begin_inset Newline newline
12920 Instructions to the speaker.
12921 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12923 Both will be printed.
12926 \begin_layout Itemize
12930 \begin_inset space \hfill{}
12934 \begin_inset Newline newline
12946 \begin_layout Itemize
12950 \begin_inset space \hfill{}
12954 \begin_inset Newline newline
12959 Camera movement instruction.
12961 \begin_inset space \thinspace{}
12965 \begin_inset space \space{}
12971 \begin_layout Itemize
12975 \begin_inset space \hfill{}
12981 \begin_layout Itemize
12985 \begin_inset space \hfill{}
12991 \begin_layout Itemize
12995 \begin_inset space \hfill{}
13001 \begin_layout Itemize
13005 \begin_inset space \hfill{}
13011 \begin_layout Subsection
13015 \begin_layout Itemize
13019 \begin_layout Itemize
13023 \begin_layout Itemize
13025 \begin_inset space \thinspace{}
13032 \begin_layout Itemize
13037 \begin_layout Itemize
13038 PAN — camera movement
13041 \begin_layout Itemize
13042 INSERT — cut to close-up of
13045 \begin_layout Section
13049 \begin_layout Standard
13052 Panayotis Papasotiriou
13055 \begin_layout Subsection
13059 \begin_layout Standard
13060 The ijmpc package is a set of macros that facilitates electronic manuscript
13063 International Journal of Modern Physics C
13066 Similarly, the ijmpd package is for creating manuscripts to be submitted
13069 International Journal of Modern Physics D
13072 Both journals are published by World Scientific.
13073 The corresponding document classes are named
13082 These files, together with instructions for the authors, can be downloaded
13084 \begin_inset Flex URL
13087 \begin_layout Plain Layout
13089 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
13095 \begin_inset Flex URL
13098 \begin_layout Plain Layout
13100 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
13106 Both packages are modified versions of the standard
13107 \begin_inset Quotes eld
13111 \begin_inset Quotes erd
13114 package, and they are almost (but not exactly) identical.
13115 Most of their features are supported by \SpecialChar LyX
13117 I have used \SpecialChar LyX
13118 successfully to write articles submitted to both journals
13119 without any problem.
13122 \begin_layout Subsection
13126 \begin_layout Standard
13127 As usual, the easiest way to write a paper is to start with a template.
13130 File\SpecialChar menuseparator
13146 This will give an (almost) empty document that includes the most common
13147 fields found in a manuscript.
13148 Simply overwrite the existing text (including the brackets,
13153 You should keep in mind the following remarks.
13156 \begin_layout Enumerate
13158 won't let you change the font size and the page style of the document,
13159 because such modifications are not allowed by both packages.
13162 \begin_layout Enumerate
13163 The language of the document should not be changed.
13164 Before previewing your paper, be sure that the babel package is not used.
13165 To do this, click on
13167 Tools\SpecialChar menuseparator
13178 checkbox in the language settings, and click on
13186 , if you wish to make this change permanent).
13189 \begin_layout Enumerate
13191 \begin_inset Quotes eld
13195 \begin_inset Quotes erd
13198 style must be used to define keywords.
13201 \begin_layout Enumerate
13202 The ijmpc package provides a style named
13203 \begin_inset Quotes eld
13206 Classification Codes
13207 \begin_inset Quotes erd
13210 , which can be used to define classification codes, such as PACS numbers.
13211 Note that this facility is not supported by the ijmpd package.
13214 \begin_layout Enumerate
13215 Several new environments are available:
13216 \begin_inset Quotes eld
13220 \begin_inset Quotes erd
13224 \begin_inset Quotes eld
13228 \begin_inset Quotes erd
13232 \begin_inset Quotes eld
13236 \begin_inset Quotes erd
13240 \begin_inset Quotes eld
13244 \begin_inset Quotes erd
13248 \begin_inset Quotes eld
13252 \begin_inset Quotes erd
13256 \begin_inset Quotes eld
13260 \begin_inset Quotes erd
13264 \begin_inset Quotes eld
13268 \begin_inset Quotes erd
13272 \begin_inset Quotes eld
13276 \begin_inset Quotes erd
13280 \begin_inset Quotes eld
13284 \begin_inset Quotes erd
13288 \begin_inset Quotes eld
13292 \begin_inset Quotes erd
13296 \begin_inset Quotes eld
13300 \begin_inset Quotes erd
13304 \begin_inset Quotes eld
13308 \begin_inset Quotes erd
13312 \begin_inset Quotes eld
13316 \begin_inset Quotes erd
13320 \begin_inset Quotes eld
13324 \begin_inset Quotes erd
13328 Their use is more or less obvious.
13330 supports all these environments; it will use the proper label, text style,
13331 and numbering scheme for each of them.
13334 \begin_layout Enumerate
13335 Both packages use basic citations; the natbib package should not be used.
13336 In \SpecialChar LyX
13337 , citation references are shown as usual; in the output, citations are
13338 shown as superscripts.
13339 If you want to use a citation as normal text, you should use the
13344 \begin_inset space \thinspace{}
13348 \begin_inset space \space{}
13352 \begin_inset Quotes eld
13356 \begin_inset space \space{}
13366 \begin_inset Quotes erd
13372 \begin_layout Enumerate
13374 \begin_inset Quotes eld
13378 \begin_inset Quotes erd
13381 section in both packages.
13382 To put acknowledgments, just use the
13383 \begin_inset Quotes eld
13387 \begin_inset Quotes erd
13393 \begin_layout Enumerate
13394 Appendices may be added to the paper,
13398 the Acknowledgments and
13404 provides a special environment, called
13405 \begin_inset Quotes eld
13409 \begin_inset Quotes erd
13412 which marks the beginning of the appendices.
13413 This environment should be left blank; it just sends a \SpecialChar LaTeX
13414 command, but nothing
13416 In \SpecialChar LyX
13418 \begin_inset Quotes eld
13422 \begin_inset Quotes erd
13425 is printed with blue letters, as a signal that all sections after that
13426 point are appendices.
13427 To write an appendix, use the
13428 \begin_inset Quotes eld
13432 \begin_inset Quotes erd
13437 will number each appendix with capital letters, as required by both journals.
13439 \begin_inset Quotes eld
13443 \begin_inset Quotes erd
13450 be present before the first appendix; if not, all appendices will be numbered
13451 as normal sections in the output.
13454 \begin_layout Enumerate
13455 The ijmpc and the ijmpd packages use the
13459 command to implement table captions.
13460 As a result, a table created by \SpecialChar LyX
13461 is printed correctly, but its caption
13463 However, you can use some \SpecialChar TeX
13464 code to overcome this problem, so that captions
13465 are printed as expected.
13466 To do so, create a float table as usual, remove the caption, and replace
13467 it with the \SpecialChar TeX
13478 (sic); you must also the \SpecialChar TeX
13483 immediately after the tabular material.
13484 Study the example table included in the template files to see how this
13485 trick is implemented.
13486 Alternatively, If you need table captions, you should implement the whole
13491 file, then include this file to the \SpecialChar LyX
13494 Insert\SpecialChar menuseparator
13495 File\SpecialChar menuseparator
13497 \begin_inset space ~
13503 Details on how to create a table float can be found in the files
13511 , included in the corresponding packages.
13514 \begin_layout Subsection
13515 Preparing a paper for submission
13518 \begin_layout Standard
13519 Before you submit your paper you must export the \SpecialChar LyX
13520 document as a \SpecialChar LaTeX
13523 File\SpecialChar menuseparator
13524 Export\SpecialChar menuseparator
13532 \begin_layout Plain Layout
13533 Actually you have the choice between \SpecialChar LaTeX
13534 (plain) and pdflatex.
13535 If you intend to use pdflatex to prepare the paper, you should use the
13536 pdflatex option so that included graphics are converted to PDF format,
13537 ready for use by pdflatex.
13542 , then make the following changes to the resulting
13549 \begin_layout Enumerate
13550 Remove the comment lines before the
13559 \begin_layout Enumerate
13560 Remove everything between (and including) the
13572 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13576 \begin_layout Standard
13581 file should be saved and processed through \SpecialChar LaTeX
13582 as many times as necessary.
13583 You may also want to check the resulting
13590 \begin_layout Subsection
13591 Use of \SpecialChar TeX
13595 \begin_layout Standard
13596 The use of \SpecialChar TeX
13597 code is reduced to two commands, which must be placed at the
13598 top of the document.
13599 If you started writing your paper by using the
13607 template, the \SpecialChar TeX
13608 code needed is already in its place; you usually don't need
13610 You may only modify the first \SpecialChar TeX
13611 code to specify the information printed
13612 to the top of odd and even pages (authors' names and short paper's title,
13614 This \SpecialChar TeX
13615 code must have the form
13619 markboth{Authors' Names}{Short Paper's Title}
13624 \begin_layout Section
13628 \begin_layout Standard
13634 \begin_layout Subsection
13638 \begin_layout Standard
13639 The iopart package provides a document class to create electronic manuscript
13640 submission to the journals published by the Institute of Physics.
13641 Instructions for the authors how to create a paper using the iopart class
13642 can be downloaded together with the iopart package from the site
13643 \begin_inset Flex URL
13646 \begin_layout Plain Layout
13648 ftp://ftp.iop.org/pub/journals/latex2e
13656 \begin_layout Subsection
13660 \begin_layout Standard
13661 The easiest way to write a paper is to start with the file
13665 that is available in \SpecialChar LyX
13666 's examples files folder.
13667 Open this file, save it under a new name, and start writing.
13668 The example file explains how to use the special text environments.
13669 Here are the most important advices:
13672 \begin_layout Itemize
13673 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13676 Use AMS math package
13678 in the document settings under
13685 \begin_layout Itemize
13688 The title environment defines the kind of your paper.
13689 So use one of the following environments for the title:
13693 \begin_layout Itemize
13702 \begin_layout Itemize
13711 \begin_layout Itemize
13717 for a Topical review
13720 \begin_layout Itemize
13729 \begin_layout Itemize
13738 \begin_layout Itemize
13744 for a Paper (same as Title)
13747 \begin_layout Itemize
13753 for a Preliminary communication
13756 \begin_layout Itemize
13762 for a Rapid communication
13765 \begin_layout Itemize
13771 for a Letter to the editor
13775 \begin_layout Itemize
13778 All title environments except of
13782 can have an optional short title.
13785 \begin_layout Itemize
13786 There is a general title environment
13790 which is not directly supported by the \SpecialChar LyX
13792 This can be used as \SpecialChar TeX
13793 code when your document doesn't fit into one of the
13797 \begin_layout Standard
13798 For more informations like hints for special table and formula formatting,
13799 look at the IOP author guidelines.
13802 \begin_layout Section
13806 \begin_layout Standard
13809 Panayotis Papasotiriou
13812 \begin_layout Subsection
13816 \begin_layout Standard
13817 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13818 that facilitates electronic manuscript submission to the journals they
13820 Most known of them (at least in my domain of interest) are
13822 Astrophysics and Space Science
13828 , but there are many others (see a complete list at
13829 \begin_inset Flex URL
13832 \begin_layout Plain Layout
13834 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13840 The Kluwer package may be downloaded from the site
13841 \begin_inset Flex URL
13844 \begin_layout Plain Layout
13846 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13852 A complete user guide is contained in that package (but it can also be
13853 downloaded separately).
13856 \begin_layout Standard
13858 supports many features of the package but not everything.
13859 However, the \SpecialChar TeX
13860 code needed is reduced to some
13861 \begin_inset Quotes eld
13865 \begin_inset Quotes erd
13868 commands of the package (see
13869 \begin_inset space ~
13873 \begin_inset CommandInset ref
13875 reference "subsec:kluwer_peculiarities"
13880 I have recently used \SpecialChar LyX
13881 to write an article submitted to the
13883 Astrophysics and Space Science
13885 without any problem.
13888 \begin_layout Subsection
13892 \begin_layout Standard
13893 The easiest way to write a paper is to start with the Kluwer template file.
13896 File\SpecialChar menuseparator
13908 This will give an (almost) empty document that includes the most common
13909 fields found in a manuscript and a short description of their use.
13910 As in most templates, simply overwrite the existing text (including the
13915 ) with the correct information.
13918 \begin_layout Subsection
13919 Preparing a paper for submission
13922 \begin_layout Standard
13923 As in the AAS\SpecialChar TeX
13924 package, before you submit your paper to a journal you must
13926 \begin_inset Quotes eld
13930 \begin_inset Quotes erd
13936 \begin_layout Enumerate
13937 Export your paper as a \SpecialChar LaTeX
13939 To do this, click on
13941 File\SpecialChar menuseparator
13942 Export\SpecialChar menuseparator
13950 \begin_layout Enumerate
13955 file with a text editor and make the following changes
13959 \begin_layout Enumerate
13960 remove the comment lines before the
13969 \begin_layout Enumerate
13970 remove everything between (and including) the
13982 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13986 \begin_layout Standard
13995 \begin_layout Enumerate
14000 file through \SpecialChar LaTeX
14001 as many times as necessary (usually up to three).
14004 \begin_layout Enumerate
14010 \begin_inset space \thinspace{}
14014 \begin_inset space \space{}
14021 , and check if everything is OK (it should, if you didn't make any mistake).
14024 \begin_layout Subsection
14025 \begin_inset Quotes eld
14029 \begin_inset Quotes erd
14032 of the Kluwer package
14033 \begin_inset CommandInset label
14035 name "subsec:kluwer_peculiarities"
14042 \begin_layout Standard
14043 The Kluwer package has the following
14044 \begin_inset Quotes eld
14048 \begin_inset Quotes erd
14054 \begin_layout Enumerate
14055 It is possible to write multiple articles in the same \SpecialChar LaTeX
14060 \begin_layout Plain Layout
14061 I can't imagine any good reason to do this.
14067 Each article must be included in the environment
14068 \begin_inset Quotes eld
14072 \begin_inset Quotes erd
14076 Unfortunately, this environment cannot be omitted, even if you write just
14078 Therefore, each article starts with the command
14084 and, obviously, ends with the command
14091 Although this can be implemented in \SpecialChar LyX
14092 , I didn't included it, since it looks
14093 ugly and can confuse the novice user.
14094 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
14097 \begin_inset Quotes eld
14102 \begin_inset Quotes erd
14108 \begin_layout Enumerate
14109 Information given at the beginning of the article (i.
14110 \begin_inset space \thinspace{}
14114 \begin_inset space \space{}
14117 title, subtitle, author, institution, running title, running author, abstract
14118 and keywords) must be included in an environment called
14119 \begin_inset Quotes eld
14123 \begin_inset Quotes erd
14127 This is not implemented in \SpecialChar LyX
14128 , so you must enter title, subtitle etc.
14129 \begin_inset space ~
14132 between two \SpecialChar TeX
14148 \begin_layout Enumerate
14149 According to the user manual, the label of each bibliography item must be
14173 \begin_layout Standard
14178 template takes care of all these
14179 \begin_inset Quotes eld
14183 \begin_inset Quotes erd
14187 If you start a new paper using this template you don't need to do anything
14192 \begin_layout Enumerate
14193 don't delete the \SpecialChar TeX
14194 code included in the template, and
14197 \begin_layout Enumerate
14198 copy the example bibliography item included in the template and modify it
14199 as necessary to enter new bibliography items.
14202 \begin_layout Section
14206 \begin_layout Standard
14212 \begin_layout Subsection
14216 \begin_layout Standard
14217 The \SpecialChar LyX
14220 article (koma-script)
14224 report (koma-script)
14242 correspond to the \SpecialChar LaTeX
14260 \begin_inset space ~
14263 of the Koma-Script family.
14264 They are replacements for the standard document classes
14280 , resp., and fit better to European typography conventions in a number of
14284 \begin_layout Itemize
14285 Standard character size is 11pt in
14287 article (koma-script)
14291 report (koma-script)
14299 letter (koma-script)
14304 \begin_layout Itemize
14305 Headings, labels of the description environment, and a number of elements
14308 letter (koma-script)
14310 document class are set in a bold sans serif font.
14314 \begin_layout Plain Layout
14315 There is a big difference between the bold sans serif old cm fonts and new
14316 ec fonts, especially in the appearance of headings.
14317 In comparison, the ec bold sans serif fonts look a bit thin.
14318 Here the \SpecialChar LaTeX
14327 helps to produce the
14328 \begin_inset Quotes eld
14332 \begin_inset Quotes erd
14335 appearance when using the ec fonts.
14340 The numbering of chapter headings is made in the same way as the numbering
14341 of section headings, that is without the extra line
14342 \begin_inset Quotes eld
14345 Chapter\SpecialChar ldots
14347 \begin_inset Quotes erd
14351 In addition, the appearance of the headings can be modified by using a
14352 number of options (in \SpecialChar LyX
14353 to be entered in the field
14356 \begin_inset space ~
14363 Layout\SpecialChar menuseparator
14370 \begin_layout Itemize
14371 The main means in the Koma-Script document classes to design the type area
14380 (in \SpecialChar LyX
14381 to be entered in the extra class options field in the dialog
14383 Document\SpecialChar menuseparator
14387 They make a clearer modification of page margins possible as do the options
14390 Document\SpecialChar menuseparator
14397 \begin_layout Itemize
14398 The \SpecialChar LaTeX
14399 document classes of the Koma-Script family define a number of additional
14401 Those part of it which makes sense in \SpecialChar LyX
14402 is implemented in corresponding
14406 \begin_layout Standard
14407 Detailed descriptions of the \SpecialChar LaTeX
14408 document classes of the Koma-Script family
14409 can be found in the Koma-Script documentation
14420 \begin_layout Subsection
14421 article (koma-script), report (koma-script), and book (koma-script)
14424 \begin_layout Standard
14425 The document classes
14427 article (koma-script)
14431 report (koma-script)
14441 are implemented in the layout files
14454 They contain all the paragraph types of the corresponding standard document
14467 , resp., partly modified, with the exception of the \SpecialChar LyX
14472 -type, which is replaced by the new
14476 -type having the same functionality.
14481 -Type there is a number of new paragraph types added.
14488 letter (koma-script)
14493 \begin_layout Itemize
14502 : are equivalents to
14510 , resp., additionally inserting an entry in the table of contents.
14519 are not contained in
14521 article (koma-script)
14526 \begin_layout Itemize
14535 : behave exactly as
14543 , resp., additionally clearing running heads.
14548 is not contained in
14550 article (koma-script)
14556 \begin_layout Plain Layout
14569 report (koma-script)
14571 , but since this is identical to
14575 , is has not been implemented in \SpecialChar LyX
14584 \begin_layout Itemize
14589 : generates a heading directly above the following paragraph in the standard
14590 character size without affecting the structure of the document.
14593 \begin_layout Itemize
14602 are special captions which respect the different space settings needed
14603 for captions placed above or below an element (if you follow strict typographic
14604 rules, you might want to place table captions always above the table).
14605 You can also use the class option
14609 , which will switch
14622 You need at least Koma-Script version 2.8q to use this.
14625 \begin_layout Itemize
14630 : can be used to set a bonmot, e.
14631 \begin_inset space \thinspace{}
14635 \begin_inset space \space{}
14638 at the beginning of a chapter.
14639 If you use the optional argument (
14641 Insert\SpecialChar menuseparator
14643 \begin_inset space ~
14648 ), you can insert the dictum's author there.
14649 Dictum and author are separated by a line.
14650 You need at least Koma-Script version 2.8q to use this.
14655 is not contained in
14657 article (koma-script)
14662 \begin_layout Standard
14663 The following types, together with the standard types
14675 , form the title area of the document.
14676 They must be entered ahead of the first
14677 \begin_inset Quotes eld
14681 \begin_inset Quotes erd
14688 \begin_layout Plain Layout
14689 The corresponding \SpecialChar LaTeX
14690 commands must appear before the
14701 When such a type is used more than once, the latter usage overwrites the
14702 former one, that means, for every type only the latest usage is valid.
14703 The order of the different types however has, like
14715 , no effect on the appearance of the produced document.
14718 \begin_layout Itemize
14723 : produces a centered paragraph above the ordinary title (
14735 ) for the subject of the document.
14738 \begin_layout Itemize
14743 : produces a centered paragraph below the ordinary title (
14755 ) for the publishers' name.
14758 \begin_layout Itemize
14765 report (koma-script)
14771 produces a centered paragraph on its own page behind the title page, or
14774 article (koma-script)
14776 produces a centered paragraph below the ordinary title (
14792 ) for a dedication.
14795 \begin_layout Itemize
14800 : produces a left aligned paragraph above the ordinary title (
14816 ) for a document`s head.
14819 \begin_layout Itemize
14824 : produces in a double-sided print in
14826 report (koma-script)
14832 a left-aligned paragraph at the top of the title page`s back or has no
14833 effect in a single-sided print or in
14835 article (koma-script)
14840 \begin_layout Itemize
14845 : produces in a double-sided print in
14847 report (koma-script)
14853 a left-aligned paragraph at the bottom of the title page`s back or has
14854 no effect in a single-sided print or in
14856 article (koma-script)
14861 \begin_layout Itemize
14866 : produces a special
14867 \begin_inset Quotes eld
14871 \begin_inset Quotes erd
14874 page ahead of the actual document containing a paragraph without special
14878 \begin_layout Standard
14879 The layout files for the document classes
14881 article (koma-script)
14885 report (koma-script)
14891 do include the file
14896 This is thought of as a place to define your own types.
14901 in your personal layout directory and edit the file!
14904 \begin_layout Subsection
14905 letter (koma-script)
14908 \begin_layout Standard
14912 letter (koma-script)
14914 is implemented in the layout file
14919 It contains all the paragraph types of the corresponding standard document
14924 , partly modified, with the exception of the \SpecialChar LyX
14938 type, which is replaced by the new
14943 In addition, it contains, in contrast to the standard document class, the
14962 Furthermore, there are a number of new letter specific types.
14965 \begin_layout Standard
14966 The appearance of the letter produced by this document class can be controlled
14967 by a number of \SpecialChar LaTeX
14968 commands, which you can put in the \SpecialChar LaTeX
14973 \begin_layout Plain Layout
14974 For example, the standard appearance of the letter`s heading, consisting
14975 of name and address, is quite self-willed.
14977 \begin_inset Quotes eld
14981 \begin_inset Quotes erd
14984 heading is produced by the following \SpecialChar LaTeX
14985 commands in the preamble:
14988 \begin_layout LyX-Code
14998 \begin_layout LyX-Code
15014 \begin_layout LyX-Code
15024 \begin_layout LyX-Code
15044 A detailed German description of such \SpecialChar LaTeX
15045 commands can be found in the Koma-Script
15051 With it, the letter's author can produce his personal letter layout.
15054 \begin_layout Standard
15063 define the beginning of the letter and must be used in every letter.
15064 To emphasize them in the \SpecialChar LyX
15065 document class, they are marked with the letter
15075 \begin_inset space ~
15078 in the left margin.
15079 It is possible to write any number of letters in one file.
15084 type produces a new letter using the same addressee and a
15088 type produces a new addressee.
15105 are ordinary paragraph types and can also be used several times in one
15106 and the same letter.
15109 \begin_layout Itemize
15114 : produces a paragraph for the addressee and implicitly defines the beginning
15118 \begin_layout Itemize
15123 : produces a paragraph for the form of address and implicitly produces a
15127 \begin_layout Itemize
15132 : produces a paragraph for a close.
15135 \begin_layout Itemize
15140 : produces a paragraph for a postscript.
15143 \begin_layout Itemize
15148 : produces a paragraph for a distribution list.
15151 \begin_layout Itemize
15156 : produces a paragraph for enclosures.
15159 \begin_layout Standard
15200 are input types provided with a label to enter information, which will
15201 be processed by the document class.
15205 \begin_layout Plain Layout
15206 It could be seen as a matter of inconsequence, that the types
15214 described above are not such input types as well.
15215 Because of the special meaning of those types, however, I have implemented
15216 them as ordinary paragraph types with a one letter mark in the left margin.
15217 Moreover, it would affect my feeling of symmetry, if the
15225 type had such a serious different appearance.
15230 The types must be used ahead of the corresponding
15237 \begin_layout Standard
15238 An implementation of these types in a WYSIWYG fashion does not seem to make
15239 sense, because the real appearance of the produced letter does not only
15240 depend on the usage of the particular type, but also on other factors.
15241 For example, a signature entered in the
15245 type will in the standard behavior appear in the produced letter only,
15246 when in the same letter also a
15251 The entered value of the
15255 type will in the standard behavior not appear in the produced letter at
15257 The possibility to design the letter`s heading freely is already indicated
15258 in a footnote above.
15261 \begin_layout Standard
15262 The input types can also be used as empty paragraphs.
15263 This makes sense e.
15264 \begin_inset space \thinspace{}
15268 \begin_inset space \space{}
15280 type is not used at all, in the standard behavior the value of the
15284 type is used as signature, whereas if an empty
15288 type is used, no signature value is defined.
15291 \begin_layout Standard
15292 By using the input types it is possible to write a letter template, containing
15293 filled input types with your personal dates (name, address, etc.) and empty
15294 input types for other dates you want to enter.
15297 \begin_layout Itemize
15302 : sender's name, in the standard behavior appears as a centered paragraph
15303 in small caps in the letter`s heading.
15306 \begin_layout Itemize
15311 : sender's signature, in the standard behavior appears below the
15320 type is used, the value of the
15324 type appears instead.
15327 \begin_layout Itemize
15332 : sender's address, in the standard behavior appears in a centered paragraph
15333 in the letter`s heading below the sender's name.
15336 \begin_layout Itemize
15341 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15352 \begin_layout Itemize
15357 : place of the letter`s making.
15360 \begin_layout Itemize
15365 : date of the letter`s making.
15374 , in the standard behavior, produce the place and the date in a right-aligned
15375 line below the addressee's field.
15380 type is used, neither place nor date appear, independent of the value of
15390 type is used, the date of the letter `s production is used.
15393 \begin_layout Itemize
15398 : sender`s back address, in the standard behavior appears above the addressee's
15399 field in a small sans serif font.
15402 \begin_layout Itemize
15407 : special mail information, in the standard behavior appears underlined
15408 above the addressee's field below the back address.
15411 \begin_layout Itemize
15416 : additional information, in the standard behavior appears on right side
15417 below the addressee`s field.
15420 \begin_layout Itemize
15425 : the letter's title, in the standard behavior appears in a big, bold, sans
15426 serif font above the subject.
15429 \begin_layout Itemize
15434 : the letter's subject, in the standard behavior appears in a bold font
15442 \begin_layout Standard
15463 produce a business letter like line above the
15467 line containing the fields
15468 \begin_inset Quotes eld
15472 \begin_inset Quotes erd
15476 \begin_inset Quotes eld
15480 \begin_inset Quotes erd
15484 \begin_inset Quotes eld
15488 \begin_inset Quotes erd
15492 \begin_inset Quotes eld
15496 \begin_inset Quotes erd
15500 \begin_inset Quotes eld
15504 \begin_inset Quotes erd
15508 \begin_inset Quotes eld
15512 \begin_inset Quotes erd
15516 For the date field, the value of the
15522 \begin_inset Quotes eld
15525 business letter types
15526 \begin_inset Quotes erd
15529 is used, the value of the
15533 type however does not appear, but only the \SpecialChar LaTeX
15541 The ordinary output of place and date in a right-aligned line below the
15542 addressee`s field is suppressed.
15543 The types are implemented as input types provided with a label and must
15544 be used ahead of the corresponding
15551 \begin_layout Itemize
15559 \begin_layout Itemize
15567 \begin_layout Itemize
15575 \begin_layout Itemize
15583 \begin_layout Itemize
15591 \begin_layout Subsection
15592 The new letter class: letter (koma-script v.2)
15595 \begin_layout Standard
15601 \begin_layout Standard
15602 \begin_inset VSpace medskip
15608 \begin_layout Standard
15610 Koma-Script version 2.8 has introduced a new letter class
15614 which supersedes the now unsupported
15619 It has — on the \SpecialChar LaTeX
15620 side — a completely new interface and is not compatible
15621 with the old class.
15622 Therefore, \SpecialChar LyX
15623 supports both, though it is recommended you use the new class.
15626 \begin_layout Standard
15627 This class covers the same functionality as
15629 letter (koma-script),
15632 The basic items are
15636 (receiver's address, same as
15640 in the old layout),
15653 will start a new letter (i.
15654 \begin_inset space \thinspace{}
15658 \begin_inset space \space{}
15661 you can write several letters per document).
15662 New elements are sender's
15678 and the possibility to use a
15684 Insert\SpecialChar menuseparator
15690 \begin_layout Standard
15691 The biggest improvement is, though, that the letter's layout is configurable
15692 to meet almost any needs.
15693 This can be done via the preamble or with a special style file (Letter
15694 Class Option, extension
15698 ), that will be read in as a class option.
15702 \begin_layout Plain Layout
15703 The KOMA package comes with some default
15708 There is, for instance, a
15712 file that follows german typesetting rules, or a
15716 that provides the default layout of the old
15721 The latter can be loaded with the class option
15727 Layout\SpecialChar menuseparator
15728 Document\SpecialChar menuseparator
15740 template that is included in \SpecialChar LyX
15742 A detailed description is to be found in the Koma-Script documentation
15750 \begin_layout Subsection
15754 \begin_layout Standard
15755 Visualizing the Koma-Script document classes in \SpecialChar LyX
15756 , the \SpecialChar LyX
15757 internals cause some
15761 \begin_layout Itemize
15762 The chapter number of a
15766 type appears on a line of its own above the chapter heading instead of
15767 appearing in the same line ahead of it.
15768 The cause for that is the \SpecialChar LyX
15769 internal behavior for the labeltype
15773 in the layout file.
15776 \begin_layout Itemize
15777 The headings of the types
15785 are only put in the
15786 \begin_inset Quotes eld
15790 \begin_inset Quotes erd
15794 table of contents, but not in the \SpecialChar LyX
15795 table of contents (
15797 Document\SpecialChar menuseparator
15799 \begin_inset space ~
15803 \begin_inset space ~
15811 \begin_layout Itemize
15812 The paragraphs in a
15816 document class appear in a skip separation mode, not indented.
15817 This is the standard behavior, no special \SpecialChar LaTeX
15818 commands are needed for that.
15821 Document\SpecialChar menuseparator
15824 dialog the corresponding radio button indicates
15833 value always has the effect that extra \SpecialChar LaTeX
15834 commands are inserted in the document
15835 to produce the gap, which is not what is wanted in this case.
15838 \begin_layout Section
15842 \begin_layout Standard
15848 \begin_layout Subsection
15852 \begin_layout Standard
15853 Memoir is a very powerful and constantly evolving class.
15854 It has been designed with regard to fictional and non-fictional literature.
15855 Its aim is to let the user have maximum control over the typesetting of
15857 Memoir is based on the standard book class, but it can also emulate the
15858 article class (see below).
15861 \begin_layout Standard
15862 Peter Wilson, the developer of Memoir, is known as the author of lots of
15863 useful packages in the \SpecialChar LaTeX
15865 Most of them have been merged with Memoir.
15866 Therefore, it is much easier to layout the table of contents, appendices,
15867 chapter designs and such.
15869 , though, does not support all of these goodies natively.
15870 Some of them might be added to forthcoming releases
15874 \begin_layout Plain Layout
15875 You are invited to send suggestions to
15876 \begin_inset Flex URL
15879 \begin_layout Plain Layout
15881 lyx-devel@lists.lyx.org
15891 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15893 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15895 commands (\SpecialChar TeX
15900 \begin_layout Plain Layout
15905 \begin_layout Plain Layout
15915 \begin_inset space ~
15919 \begin_inset CommandInset ref
15921 reference "sec:Inserting-TeX-Code"
15931 In this section, we can only list those features that are natively supported
15932 by \SpecialChar LyX
15934 For detailed descriptions (and for the rest of features) we recommend you
15935 have a look at the detailed manual of the Memoir class
15939 \begin_layout Plain Layout
15944 \begin_layout Plain Layout
15954 \begin_inset Flex URL
15957 \begin_layout Plain Layout
15959 CTAN:/macros/latex/memoir/memman.pdf
15969 , which is not only a user guide for the class, but also both a comprehensive
15970 description on good typesetting and a superb example for good typesetting
15974 \begin_layout Subsection
15975 Basic features and restrictions
15978 \begin_layout Standard
15979 Memoir supports basically all features of the standard book classes.
15980 There are, however, some differences, as follows:
15983 \begin_layout Description
15985 \begin_inset space ~
15988 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15991 \begin_layout Description
15993 \begin_inset space ~
15996 style: The fancy page style is not supported, due to a command clash between
15997 Memoir and the fancyhdr package (they both define a command with the same
15998 name, which confuses \SpecialChar LaTeX
16000 Instead, Memoir comes with a number of its own page styles (see
16002 Layout\SpecialChar menuseparator
16003 Document\SpecialChar menuseparator
16005 \begin_inset space ~
16011 If you want to use these for the chapter pages, you have to use the command
16018 in the main text or in preamble (e.
16019 \begin_inset space \thinspace{}
16023 \begin_inset space \space{}
16030 chapterstyle{companion}
16035 \begin_layout Description
16036 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
16037 optional argument in the standard classes.
16038 With this, you can specify an alternative version of the title for the
16039 table of contents and the headers (for instance, if the title is too long).
16040 In \SpecialChar LyX
16041 , you can do this via
16043 Insert\SpecialChar menuseparator
16045 \begin_inset space ~
16050 at the beginning of a chapter/section.
16051 Memoir features a second optional argument and thus separates the table
16052 of contents from the header.
16053 You can define three variants of a title with this: one for the main text,
16054 one for the table of contents, and one for the headers.
16055 Simply insert two optional arguments if you need this feature, the first
16056 one containing the short title for the Table of Contents, the second one
16057 containing an alternative short title for the headers.
16060 \begin_layout Description
16061 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
16062 of contents, the list of figures and the list of table start a new page
16064 Memoir does not follow this route.
16065 You have to insert a page break yourself, if you want to have one.
16068 \begin_layout Description
16069 Titlepage: For some unknown reason, Memoir uses pagination on the title
16070 page (in the standard classes, title pages are
16071 \begin_inset Quotes eld
16075 \begin_inset Quotes erd
16079 If you want an empty title page, type
16083 aliaspagestyle{title}{empty}
16088 \begin_layout Description
16089 Article: With the class option
16095 Layout\SpecialChar menuseparator
16096 Document\SpecialChar menuseparator
16098 \begin_inset space ~
16103 ), you can emulate article style.
16104 That is, counters (footnotes, figures, tables etc.) will not be reset on
16105 new chapters, chapters don't start a new page (but are—in contrary to
16106 \begin_inset Quotes eld
16110 \begin_inset Quotes erd
16113 article classes—still allowed), parts, though, use their own page, as in
16117 \begin_layout Description
16118 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
16119 font commands, which have been used in the old \SpecialChar LaTeX
16121 \begin_inset space \thinspace{}
16125 \begin_inset space \space{}
16141 It produces an error and stops \SpecialChar LaTeX
16142 whenever such a command appears.
16147 reallows the commands and spits out warnings instead (which does at least
16148 not stop \SpecialChar LaTeX
16150 Since a lot of packages and particularly Bib\SpecialChar TeX
16151 style files are still using
16152 those commands, we have decided to use this option by default.
16155 \begin_layout Subsection
16159 \begin_layout Standard
16160 We will only describe the features supported by \SpecialChar LyX
16161 (which is not much currently).
16162 Please consult the Memoir manual
16166 \begin_layout Plain Layout
16171 \begin_layout Plain Layout
16181 \begin_inset Flex URL
16184 \begin_layout Plain Layout
16186 CTAN:/macros/latex/memoir/memman.pdf
16199 \begin_layout Description
16200 Abstract: You may wonder why an abstract is an extra feature.
16201 Well, it is in book class.
16202 Usually books don't have abstracts.
16203 Memoir, however, has.
16204 You can use it wherever and how often you like.
16207 \begin_layout Description
16208 Chapterprecis: You may know this older typesetting style: The contents of
16209 a chapter are summarized below the title and also in the table of contents
16211 \begin_inset space \thinspace{}
16215 \begin_inset space \space{}
16220 Our hero arrives in Troia; he loses some friends; he finds others
16223 Chapterprecis does exactly this.
16224 It is therefore only sensible below a chapter.
16227 \begin_layout Description
16228 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16229 The epigraph environment provides an elegant way of typesetting such a
16231 The motto itself (text) and its author (source) are divided by a short
16233 Unfortunately, we have to fool \SpecialChar LyX
16234 a bit here again, since the environment
16235 needs two arguments (text and source).
16236 In this case, we have to use curly brackets (in \SpecialChar TeX
16237 mode) between the two
16248 <author of the slogan>.
16251 \begin_layout Description
16252 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16253 complex figurative poems).
16255 can only support a few of them.
16256 One is poemtitle, which is a centered title for poems, which will also
16257 be added to the table of contents (verse is the standard environment for
16259 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16261 because they have to be nested inside regular verse environments, which
16262 is not possible with \SpecialChar LyX
16266 \begin_layout Description
16267 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16270 \begin_layout Section
16271 Article (mwart), book (mwbk) and report (mwrep)
16272 \begin_inset Argument status
16275 \begin_layout Plain Layout
16288 \begin_layout Standard
16294 \begin_layout Standard
16295 The \SpecialChar LyX
16312 correspond to the \SpecialChar LaTeX
16326 They are replacements for the standard document classes
16338 , resp., and fit better to Polish typography conventions in a number of points.
16342 \begin_layout Standard
16346 \begin_layout Itemize
16347 Unnumbered titles (with star, e.
16348 \begin_inset space \thinspace{}
16352 \begin_inset space \space{}
16359 ) are added into table of contents,
16362 \begin_layout Itemize
16363 Additional page styles:
16367 \begin_layout Description
16368 uheadings header with separated lines,
16371 \begin_layout Description
16372 myheadings custom header, contents headers via commands:
16387 \begin_layout Description
16388 myuheadings custom header with separated lines,
16391 \begin_layout Description
16392 outer page number is placed on outer side of page
16396 \begin_layout Itemize
16401 \begin_layout Description
16402 rmheadings serif titles — default,
16405 \begin_layout Description
16406 sfheadings sansserif titles,
16409 \begin_layout Description
16410 authortitle on title page first placed is author next title — default,
16413 \begin_layout Description
16414 titleauthor on title page first placed is title next author,
16417 \begin_layout Description
16418 withmarginpar reserve place on page for margins.
16422 \begin_layout Section
16426 \begin_layout Standard
16431 provides an alternative to the standard
16436 It provides similar functionality, but you might prefer this layout with
16437 sans serif sections, headings, and more.
16440 \begin_layout Section
16441 Rev\SpecialChar TeX
16445 \begin_layout Standard
16451 \begin_layout Standard
16452 \begin_inset VSpace bigskip
16458 \begin_layout Standard
16463 \begin_inset space ~
16468 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16470 \begin_inset Formula $\beta$
16473 release of May, 1999) class.
16476 \begin_layout Standard
16482 textclass, which works with Rev\SpecialChar TeX
16484 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16486 That means that it doesn't interact very well with \SpecialChar LyX
16487 , which requires \SpecialChar LaTeX2e
16489 it has been kludged to work.
16490 Since Rev\SpecialChar TeX
16491 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16496 Rev\SpecialChar TeX
16498 \begin_inset space ~
16503 textclass should also be pretty easy to use.
16506 \begin_layout Standard
16507 These documents are supposed to be used in
16511 to the Rev\SpecialChar TeX
16512 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16514 and assume you'll know what to put in the preamble if necessary.
16517 \begin_layout Subsection
16521 \begin_layout Standard
16522 All you need to do is install Rev\SpecialChar TeX
16523 4, as described in the package's README
16525 The package can be found at The Rev\SpecialChar TeX
16527 \begin_inset Flex URL
16530 \begin_layout Plain Layout
16532 http://publish.aps.org/revtex4/
16538 Install it somewhere that \SpecialChar LaTeX
16540 Test it by trying to \SpecialChar LaTeX
16541 a short Rev\SpecialChar TeX
16542 4 document in some random directory (i.
16543 \begin_inset space \thinspace{}
16547 \begin_inset space \space{}
16550 not the directory where you installed the class file.) Then, if you reconfigure
16552 , it will find the class file and let you use the Rev\SpecialChar TeX
16556 \begin_layout Standard
16557 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16566 \begin_inset space ~
16571 template, found in the templates directory.
16574 \begin_layout Subsection
16578 \begin_layout Standard
16579 Optional arguments to
16586 \begin_inset Quotes eld
16590 \begin_inset Quotes erd
16594 \begin_inset Quotes eld
16598 \begin_inset Quotes erd
16604 \begin_inset space ~
16612 \begin_inset space ~
16618 Remember that in Rev\SpecialChar TeX
16619 , at least one optional argument is required!
16622 \begin_layout Standard
16623 Other preamble matter, like
16630 \begin_inset space ~
16637 \begin_inset space ~
16642 dialog, also as usual.
16645 \begin_layout Subsection
16649 \begin_layout Standard
16650 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16652 For example, the Email layout corresponds to
16659 Note that (at least as of Rev\SpecialChar TeX
16668 layouts are exactly equivalent, so you shouldn't need to use both.
16672 \begin_layout Plain Layout
16673 In case you're curious, both were included so that
16677 would be able to translate both
16697 \begin_layout Subsection
16701 \begin_layout Standard
16702 There are a couple of important unique aspects of Rev\SpecialChar TeX
16703 4 which might cause
16704 bugs that will be even more confusing in \SpecialChar LyX
16708 \begin_layout Standard
16709 In Rev\SpecialChar TeX
16727 The \SpecialChar LyX
16728 equivalent is that there is a separate Thanks layout.
16733 write footnotes in the
16737 layout, or weird things may happen.
16738 See the Rev\SpecialChar TeX
16739 4 documentation for more details.
16742 \begin_layout Standard
16746 \begin_inset space ~
16754 \begin_inset space ~
16763 layouts must be placed
16771 layout and the corresponding
16788 , the \SpecialChar LaTeX
16792 \begin_layout Subsection
16796 \begin_layout Standard
16797 The main problem with this layout is that you can't use the optional arguments
16798 to layouts like Email and Title.
16799 (The problem is not unique to this layout; you can't use optional arguments
16800 to the Section layouts either.) This means that after you export that file
16801 to \SpecialChar LaTeX
16802 (which you'll need to do eventually to send it in to APS), you'll need
16803 to edit the \SpecialChar LaTeX
16804 file with a text editor to add the optional arguments to set,
16806 \begin_inset space \thinspace{}
16810 \begin_inset space \space{}
16813 the running title for the page headers.
16814 Lacking these layouts makes the
16820 (and the equivalent
16826 ) useless, so the corresponding layouts don't exist, and will have to be
16831 \begin_layout Plain Layout
16836 actually, \SpecialChar LyX
16837 1.3.0 supports some forms of optional arguments, but this layout
16838 has not been updated yet to take advantage of it.
16846 \begin_layout Section
16847 Springer Journals (
16854 \begin_layout Standard
16860 \begin_layout Subsection
16864 \begin_layout Standard
16865 These are the layout files for some of the journal formats used by Springer
16866 Verlag and listed on
16867 \begin_inset Flex URL
16870 \begin_layout Plain Layout
16872 http://www.springer.de/author/tex/help-journals.html
16877 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16879 It is a modular system: the things common to all journals are implemented
16884 , which journal-specific layout files (such as, e.
16885 \begin_inset space \thinspace{}
16889 \begin_inset space \space{}
16896 for Journal of Geodesy) can include.
16899 \begin_layout Standard
16900 This means that implementing support for any other Springer journal on this
16901 list is as simple as writing your own
16909 file following the outline given in
16917 \begin_layout Standard
16918 It is reasonably well tested only for the Journal of Geodesy.
16927 come with the standard \SpecialChar LyX
16929 Install the relevant class file (downloaded from Springer) in a proper
16930 directory, reconfigure \SpecialChar LaTeX
16931 (in the te\SpecialChar TeX
16936 , as root if necessary — doesn't \SpecialChar LyX
16937 take care of this?), reconfigure \SpecialChar LyX
16942 \begin_layout Subsection
16946 \begin_layout Standard
16947 A large number of theorem-like styles —
16959 \begin_layout Standard
16962 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16963 _Title, Author_Running, Institute,
16964 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16967 See the Springer class file documentation for details.
16970 \begin_layout Subsection
16974 \begin_layout Itemize
16986 \begin_layout Itemize
16989 Probability Theory and Related Fields
16995 — Jean-Marc Lasgouttes
16998 \begin_layout Standard
16999 Add your own, it isn't so hard!
17002 \begin_layout Subsection
17006 \begin_layout Standard
17007 These files are partly based on the older
17011 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
17013 file from Springer.
17018 layout, are now defunct.
17019 Jean-Marc Lasgouttes helped out big in making me find my way around the
17021 layout file mechanism.
17024 \begin_layout Subsection
17028 \begin_layout Standard
17030 But probably less than in the old hacked-\SpecialChar LaTeX
17038 \begin_layout Standard
17040 \begin_inset space \thinspace{}
17043 g.: does not display the number for theorem-like layouts, just #.
17046 \begin_layout Section
17049 Sli\SpecialChar TeX
17053 \begin_inset CommandInset label
17062 \begin_layout Standard
17070 \begin_layout Subsection
17074 \begin_layout Standard
17075 This section describes how to use \SpecialChar LyX
17076 to make slides for overhead projectors.
17077 There are two document classes that can do this: the default slides class
17080 Foil\SpecialChar TeX
17084 This section documents the former.
17087 \begin_layout Standard
17088 I'm going to say this again, nice and clear, so that there's no misunderstanding
17092 \begin_layout Standard
17093 \begin_inset VSpace bigskip
17099 \begin_layout Standard
17103 This section documents the class
17104 \begin_inset Quotes eld
17112 \begin_inset Quotes erd
17120 \begin_layout Standard
17121 \begin_inset VSpace bigskip
17127 \begin_layout Standard
17128 If you're looking for the documentation for
17129 \begin_inset Quotes eld
17134 slides (Foil\SpecialChar TeX
17138 \begin_inset Quotes erd
17141 , check out section
17142 \begin_inset space ~
17146 \begin_inset CommandInset ref
17148 reference "sec:foiltex"
17158 \begin_inset Quotes eld
17163 slides (Foil\SpecialChar TeX
17167 \begin_inset Quotes erd
17170 ] is actually somewhat better than the default
17178 \begin_layout Plain Layout
17180 or so I've been told repeatedly by its advocates.
17181 Having never used it, I have no idea if this claim is true or not.
17186 which this section documents.
17189 \begin_layout Standard
17190 This class is the \SpecialChar LaTeX2e
17191 improvement of the old
17193 Sli\SpecialChar TeX
17197 Every \SpecialChar LaTeX2e
17198 distribution includes this class [which I'll just refer to as
17199 \begin_inset Quotes eld
17207 \begin_inset Quotes erd
17210 from now on], so you're bound to have it.
17211 As I noted earlier, there are other classes, such as
17215 , which also produce slides for overhead projectors and do a better job
17217 However, there are some things which
17221 can do which the others can't, such as generate overlays.
17222 Read on to learn more!
17225 \begin_layout Subsection
17227 \begin_inset CommandInset label
17229 name "sec:slidesetup"
17236 \begin_layout Standard
17237 Obviously, to use this document class, you need to select
17238 \begin_inset Quotes eld
17246 \begin_inset Quotes erd
17249 from the class list in the
17251 Document\SpecialChar menuseparator
17255 There are some other special things you should know about this class:
17258 \begin_layout Itemize
17259 Don't bother changing the options
17264 They're not supported by the
17271 \begin_layout Itemize
17275 \begin_inset space ~
17280 behaves a bit differently for this class.
17281 The possible choices and what they do are as follows:
17285 \begin_layout Description
17290 The final output contains page numbers in the lower right corner.
17293 \begin_layout Description
17302 , but also prints out any time markers you've put in.
17303 This is the default.
17306 \begin_layout Description
17311 The final output contains no page numbers, time markers, or alignment markers.
17315 \begin_layout Itemize
17320 class has an extra option:
17326 \begin_inset Quotes eld
17334 \begin_inset Quotes erd
17337 in the extra class options.
17341 \begin_layout Standard
17342 Using this options allows you to add time markers to
17348 \begin_inset space ~
17352 \begin_inset CommandInset ref
17354 reference "sec:slideNote"
17362 \begin_layout Standard
17363 You can also use the template file
17364 \begin_inset Quotes eld
17372 \begin_inset Quotes erd
17375 to automatically set up a document to use the
17381 File\SpecialChar menuseparator
17383 \begin_inset space ~
17387 \begin_inset space ~
17392 to open your new document].
17393 The template file also contains some examples of the special paragraph
17394 environments used by this class.
17395 I'll describe those next.
17398 \begin_layout Subsection
17399 Paragraph Environments
17402 \begin_layout Subsubsection
17403 Supported Environments
17406 \begin_layout Standard
17407 The first thing you'll notice when you start up a new
17411 document is the font size and type: it's the equivalent of the size
17412 \begin_inset Quotes eld
17420 \begin_inset Quotes erd
17426 \begin_inset space ~
17432 This is also what's used in the output.
17434 \begin_inset Quotes eld
17438 \begin_inset Quotes erd
17441 to remind you that this is a slide.
17442 Your final slides will use a larger font; ergo, you'll have less space.
17443 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17446 \begin_layout Standard
17447 The next thing that becomes obvious is the changes to the paragraph environment
17448 pull-down box [at the far-left end of the toolbar].
17449 Most of the paragraph environments you're used to seeing are missing.
17450 There are also five new ones.
17455 class itself only supports certain paragraph environments:
17458 \begin_layout Itemize
17464 \begin_layout Itemize
17470 \begin_layout Itemize
17476 \begin_layout Itemize
17482 \begin_layout Itemize
17488 \begin_layout Itemize
17494 \begin_layout Itemize
17500 \begin_layout Itemize
17506 \begin_layout Itemize
17512 \begin_layout Itemize
17519 \begin_layout Itemize
17525 \begin_layout Standard
17526 All of the other standard environments, including the section-heading environmen
17527 ts, aren't used in the
17534 \begin_layout Standard
17535 On the other hand, you'll notice the following new environments:
17538 \begin_layout Itemize
17544 \begin_layout Itemize
17550 \begin_layout Itemize
17556 \begin_layout Itemize
17562 \begin_layout Itemize
17568 \begin_layout Standard
17569 These five are kind of quirky, due to a
17570 \begin_inset Quotes eld
17574 \begin_inset Quotes erd
17577 in \SpecialChar LyX
17579 You see, \SpecialChar LyX
17580 doesn't permit you to nest any other paragraph environment into
17581 an empty environment.
17582 Now, that's fine and dandy, but it means that you wouldn't be able to start
17583 a slide with anything except plain text.
17584 To deal with this, I've performed a little
17585 \begin_inset Quotes eld
17590 \begin_inset Quotes erd
17596 \begin_layout Subsubsection
17597 Quirks of the New Environments
17598 \begin_inset CommandInset label
17600 name "sec:slideQuirk"
17607 \begin_layout Standard
17608 All five of the new paragraph environments are somewhat quirky due to inherent
17609 limitiations in the current version of \SpecialChar LyX
17611 As I just mentioned, \SpecialChar LyX
17612 forbids environments that begin with another environment.
17613 To get around this, the
17617 environment isn't a paragraph environment as described in the
17625 \begin_layout Standard
17626 You should consider
17639 \begin_inset Quotes eld
17642 pseudo-environments.
17643 \begin_inset Quotes erd
17646 They look like a section heading or a
17647 \begin_inset Quotes eld
17655 \begin_inset Quotes erd
17658 but really begin a [and, if necessary, end the previous] paragraph environment.
17668 \begin_inset Quotes eld
17672 \begin_inset Quotes erd
17675 These two perform some action.
17678 \begin_layout Standard
17679 A common feature of all five environments,
17699 , is a rather long-ish label.
17700 The text following this label — ordinarily the contents of the paragraph
17701 environment — is utterly irrelevant for
17723 completely ignores it.
17724 In fact, you can leave these five environments completely empty.
17728 \begin_layout Standard
17733 to put any text after the rather long-ish label, you might want to.
17734 This could be a short description of the contents of the
17739 In that case, enter your descriptive comment and hit
17743 as you normally would.
17746 \begin_layout Standard
17747 If, on the other hand, you don't want to enter any descriptive text, you'll
17748 hit another \SpecialChar LyX
17751 , like nature, abhors a vacuum, and will not let you start a new paragraph
17752 environment until you put something in the old one.
17756 \begin_layout Itemize
17757 Start entering the text that will
17785 \begin_layout Itemize
17786 Now move to the beginning of that paragraph.
17790 \begin_layout Itemize
17799 \begin_layout Itemize
17800 Finally, change this new, empty paragraph to a
17824 \begin_layout Standard
17825 Some future version of \SpecialChar LyX
17826 will, hopefully, resolve this quirkiness\SpecialChar ldots
17830 \begin_layout Subsection
17831 Making a Presentation with
17844 \begin_layout Subsubsection
17852 \begin_layout Standard
17853 If you're expecting this section to teach you how to actually make a presentatio
17854 n, you'll be sorely disappointed.
17855 Naturally, I'll describe all of the ways the
17859 class can assist you in preparing the materials for a presentation.
17860 Filling in the contents, however, is up to you.
17865 the \SpecialChar LyX
17869 \begin_layout Standard
17874 environment [in the manner described in section
17875 \begin_inset space ~
17879 \begin_inset CommandInset ref
17881 reference "sec:slideQuirk"
17885 ] tells \SpecialChar LyX
17886 to begin a new slide [duh].
17887 The label for this environment/
17888 \begin_inset Quotes erd
17892 \begin_inset Quotes erd
17896 \begin_inset Quotes eld
17900 \begin_inset Quotes erd
17903 in cool blue, followed by the label,
17904 \begin_inset Quotes eld
17908 \begin_inset Quotes erd
17912 Any text or paragraph environments that follow this one go on the new slide.
17916 \begin_layout Standard
17917 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17919 (this can be specified in the
17924 In fact, you'll want to, once you finish entering the contents of one slide.
17925 If you've entered more text than can physically fit on a slide, the extra
17926 overflows onto a new slide.
17927 I don't recommend doing this, however, since the overflow slide won't have
17928 any page number on it.
17929 Furthermore, it may interfere with any
17933 you've made to accompany the oversized
17940 \begin_layout Standard
17949 environments work the same way as the
17954 They both create an
17955 \begin_inset Quotes eld
17959 \begin_inset Quotes erd
17962 followed by a label [
17963 \begin_inset Quotes eld
17967 \begin_inset Quotes erd
17971 \begin_inset Quotes eld
17975 \begin_inset Quotes erd
17979 The color is a stunning magenta instead of blue, and the
17980 \begin_inset Quotes eld
17984 \begin_inset Quotes erd
17987 will look different, in style and in length.
17988 The label fonts of all three also differ from one another.
17991 \begin_layout Standard
17996 , if the contents of a
18004 exceed the physical size of a slide or sheet of paper, the extra will overflow
18006 Again, you should avoid this.
18007 It defeats the whole purpose of
18018 \begin_layout Subsubsection
18028 \begin_layout Standard
18033 is a slide that sits atop another slide.
18034 Perhaps you wish to discuss a figure on the main
18038 before displaying the text associated with it.
18039 One way to accomplish this is tape a flap of dark paper over the part of
18044 you want to display later.
18045 This method fails, however, if you wish to overlap one graph with another,
18047 You would then have to fumble while speaking to align the two separate,
18052 s to align the two graphs.
18057 environment in both cases makes life much easier.
18060 \begin_layout Standard
18065 receives the page number of its
18066 \begin_inset Quotes eld
18070 \begin_inset Quotes erd
18078 \begin_inset Quotes eld
18086 \begin_inset Quotes erd
18093 \begin_layout Plain Layout
18094 Presumably, mutliple
18099 \begin_inset Quotes eld
18107 \begin_inset Quotes erd
18111 \begin_inset Quotes eld
18119 \begin_inset Quotes erd
18123 \begin_inset Quotes eld
18131 \begin_inset Quotes erd
18135 \begin_inset space ~
18138 appended to the page number of the parent
18148 Clearly, you want the contents of both the
18156 to each fit on a single physical slide! You should probably consider an
18162 \begin_inset Quotes eld
18166 \begin_inset Quotes erd
18174 Indeed, the \SpecialChar LyX
18179 class provides a visual cue for this: the label at the start of an
18183 is shorter than that at the start of a
18188 Lastly, when you generate printable output, you'll find alignment markers
18189 in all four corners of both the
18193 page and its parent
18198 These will assist you in lining up the two physical slides.
18201 \begin_layout Standard
18202 The major problem in overlaying two slides is aligning the contents of the
18203 two transparencies.
18204 How much space should you leave for that graph on the second slide? Worse
18205 still, what if you want a graph and a sentence on second slide, but there
18206 is text on the main transparency that goes in between them? You could try
18207 and insert vertical space of the right size.
18208 The better way is to use
18219 \begin_layout Standard
18220 As their names imply,
18228 are two command-like paragraph environments that make all subsequent text
18229 invisible and visible, respectively.
18231 \begin_inset space ~
18235 \begin_inset CommandInset ref
18237 reference "sec:slideQuirk"
18241 that you don't place anything
18245 these two environments, however.
18250 , it inserts a centered, sky-blue label into the page reading
18251 \begin_inset Quotes eld
18254 <Invisible Text Follows>
18255 \begin_inset Quotes erd
18259 For paragraphs following this label, the parts of the
18267 ; it doesn't matter which] where they would be contain instead blank space.
18271 \begin_layout Standard
18276 , the corresponding centered label is
18277 \begin_inset Quotes eld
18280 <Visible Text Follows>
18281 \begin_inset Quotes erd
18285 Paragraphs following this label behave normally.
18286 Note that the beginning of a new
18298 automatically shuts off an
18303 It's therefore not necessary to use
18314 \begin_layout Standard
18315 By now, it should be obvious how to create overlay transparencies using
18316 the proper combination of
18335 \begin_layout Enumerate
18340 , including everything that will appear on it, whether on the main slide
18348 \begin_layout Enumerate
18349 Before each figure or paragraph that will appear only on the
18358 If necessary, insert a
18362 environment after the
18369 \begin_layout Enumerate
18374 immediately following the
18381 \begin_layout Enumerate
18382 Copy the contents of this
18393 \begin_layout Enumerate
18398 , change all of the
18409 \begin_layout Standard
18411 You've just made an
18418 \begin_layout Standard
18419 There's one problem with the way I've designed the \SpecialChar LyX
18424 class: you can't make text in the middle of a paragraph invisible, nor
18425 make text in the middle of an invisible paragraph visible again.
18426 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18431 \begin_layout Plain Layout
18432 The commands of interest are:
18435 \begin_layout Itemize
18440 invisible \SpecialChar ldots
18444 \begin_layout Itemize
18449 visible \SpecialChar ldots
18453 \begin_layout Plain Layout
18455 and need to be marked as \SpecialChar TeX
18458 \begin_inset Quotes eld
18462 \begin_inset Quotes erd
18465 you wish to change goes in between the brackets [and after the
18478 If you don't know how to mark text as \SpecialChar TeX
18479 , see the appropriate section of
18492 \begin_layout Subsubsection
18502 \begin_inset CommandInset label
18504 name "sec:slideNote"
18511 \begin_layout Standard
18520 is associated with a
18521 \begin_inset Quotes eld
18525 \begin_inset Quotes erd
18533 Here, too, the \SpecialChar LyX
18538 class provides visual cues.
18543 is shorter than that of a
18547 [yet longer than that of an
18551 ] and, like the label of an
18555 is shockingly magenta.
18556 Additionally, the printed
18560 has the page number of its
18561 \begin_inset Quotes eld
18565 \begin_inset Quotes erd
18573 \begin_inset Quotes eld
18581 \begin_inset Quotes erd
18585 \begin_inset Quotes eld
18593 \begin_inset Quotes erd
18597 \begin_inset Quotes eld
18605 \begin_inset Quotes erd
18609 You can have multiple
18613 s associated with a single
18625 , you'll probably want to break up long
18629 s so that they fit on a single sheet of paper.
18632 \begin_layout Standard
18637 is obvious: it contains anything additional you might want to say about
18643 It could also be used as a sheet of reminders for a particular
18648 In the case of the latter, you might want to make use of time markers.
18649 Currently, the \SpecialChar LyX
18655 \begin_inset Quotes eld
18659 \begin_inset Quotes erd
18662 support for time markers, a
18664 Sli\SpecialChar TeX
18668 So, you'll have to resort to using the \SpecialChar LaTeX
18672 \begin_layout Standard
18673 To use time markers, you'll need to specify the extra class option
18674 \begin_inset Quotes eld
18682 \begin_inset Quotes erd
18686 \begin_inset space ~
18690 \begin_inset CommandInset ref
18692 reference "sec:slidesetup"
18697 This option turns on timing marks, which will appear in the lower-left-hand
18703 To set what appears in the time marker, you use the \SpecialChar LaTeX
18705 \begin_inset Quotes eld
18715 \begin_inset Quotes erd
18719 \begin_inset Quotes eld
18729 \begin_inset Quotes erd
18733 The arguments of both commands are time measured in seconds.
18735 \begin_inset Quotes eld
18745 \begin_inset Quotes erd
18748 sets the time marker to a given time.
18750 \begin_inset Quotes eld
18760 \begin_inset Quotes erd
18763 increments the time marker by the specified amount.
18764 Using time markers and
18768 s in this fashion, you can remind yourself how much time to spend on a particula
18776 \begin_layout Standard
18777 There's one last feature to describe.
18778 Clearly, you'd like to print out all of your
18786 s on transparencies while printing all of your
18803 with which it is associated.
18804 What's a person to do?
18807 \begin_layout Standard
18808 Luckily, there are two \SpecialChar LaTeX
18809 commands that allow you to select what to print
18811 Both must be placed into the preamble of your document.
18813 \begin_inset Quotes eld
18825 \begin_inset Quotes erd
18828 will cause the output to contain only the
18837 Correspondingly, the command
18838 \begin_inset Quotes eld
18850 \begin_inset Quotes erd
18853 prevents the output of anything but
18858 I'd advise placing both commands in the preamble and initially comment
18860 You can then preview your entire presentation as you write.
18861 When you're done writing, you can then uncomment one of the two to select
18862 what you want to print.
18863 I like to uncomment
18864 \begin_inset Quotes eld
18876 \begin_inset Quotes erd
18879 , print to a file with
18880 \begin_inset Quotes eld
18888 \begin_inset Quotes erd
18891 in its name, comment it back out, then uncomment
18892 \begin_inset Quotes eld
18904 \begin_inset Quotes erd
18908 \begin_inset Quotes eld
18916 \begin_inset Quotes erd
18920 I can then send either file to a printer, loading transparencies or plain
18921 paper as appropriate.
18924 \begin_layout Standard
18925 You can also provide other arguments to the
18926 \begin_inset Quotes eld
18936 \begin_inset Quotes erd
18940 \begin_inset Quotes eld
18950 \begin_inset Quotes erd
18954 See a good \SpecialChar LaTeX
18958 \begin_layout Subsection
18963 Class Template File
18966 \begin_layout Standard
18967 I have also provided a template file,
18968 \begin_inset Quotes eld
18976 \begin_inset Quotes erd
18984 To use it, begin your new presentation with
18986 File\SpecialChar menuseparator
18988 \begin_inset space ~
18992 \begin_inset space ~
18998 Your new \SpecialChar LyX
18999 presentation file will contain an example
19020 additionally contain an example of the use of
19029 Lastly, the preamble will contain:
19032 \begin_layout LyX-Code
19033 % Uncomment to print out only slides and overlays
19036 \begin_layout LyX-Code
19040 \begin_layout LyX-Code
19046 \begin_inset Newline newline
19052 \begin_layout LyX-Code
19053 % Uncomment to print out only notes
19056 \begin_layout LyX-Code
19060 \begin_layout LyX-Code
19068 \begin_layout Standard
19069 One final thing: I created this class to support the \SpecialChar LaTeX2e
19071 \begin_inset Quotes eld
19076 Sli\SpecialChar TeX
19080 \begin_inset Quotes erd
19083 class, one of the built-in \SpecialChar LaTeX2e
19085 Neither I nor the rest of the \SpecialChar LyX
19086 Team endorse or oppose the use of this built-in
19088 It's here if you want it or need it.
19089 There exist other \SpecialChar LaTeX2e
19090 classes for creating presentations, such as the
19095 \begin_inset space ~
19099 \begin_inset CommandInset ref
19101 reference "sec:foiltex"
19106 \begin_inset Quotes eld
19114 \begin_inset Quotes erd
19117 package [present on some \SpecialChar TeX
19119 The latter is not yet supported under \SpecialChar LyX
19124 \begin_layout Plain Layout
19125 Perhaps you can take on the task\SpecialChar ldots
19131 I know nothing about these other classes.
19132 Try them out to see what sort of alternative they provide.
19135 \begin_layout Chapter
19137 Features needing Extra Software
19140 \begin_layout Section
19141 Checking \SpecialChar TeX
19145 \begin_layout Standard
19151 \begin_layout Subsection
19155 \begin_layout Standard
19164 \begin_layout Plain Layout
19169 is not yet available when you are using the \SpecialChar LaTeX
19170 distribution MiK\SpecialChar TeX
19176 , you'll find in the
19183 \begin_inset space ~
19194 \begin_inset Newline newline
19198 \begin_inset CommandInset href
19200 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19208 \begin_layout Standard
19211 Chk\SpecialChar TeX
19214 package is a program that was written by
19215 \begin_inset Flex Noun
19218 \begin_layout Plain Layout
19220 \begin_inset space ~
19228 in frustration because some constructs in \SpecialChar LaTeX
19229 are sometimes non-intuitive,
19230 and easy to forget.
19231 The program runs over your \SpecialChar LaTeX
19232 file, checks the integrity of the file, and
19233 flags some common errors.
19234 In other technical words, it is
19238 for \SpecialChar LaTeX
19242 \begin_layout Standard
19243 Well, what is a syntax checker doing in \SpecialChar LyX
19244 which is supposed to produce correct
19246 anyways? The answer is simple: Just as
19250 not only checks the
19254 of C programs, but also does
19258 checks for type-errors,
19260 Chk\SpecialChar TeX
19263 catches some common
19267 errors, in addition to the syntactical ones.
19270 Chk\SpecialChar TeX
19273 is capable of detecting several common errors, such as
19276 \begin_layout Itemize
19277 Ellipsis detection:
19278 \begin_inset Newline newline
19281 Use \SpecialChar ldots
19285 \begin_layout Itemize
19286 No space in front of/after parenthesis:
19287 \begin_inset Newline newline
19293 \begin_layout Itemize
19294 Enforcement of normal space after common abbreviations:
19295 \begin_inset Newline newline
19299 \begin_inset space \thinspace{}
19303 \begin_inset space \space{}
19306 is too wide spacing.
19309 \begin_layout Itemize
19310 Enforcement of end-of-sentence space when the last sentence ends with a
19312 \begin_inset Newline newline
19316 And this is wrong spacing.
19319 \begin_layout Itemize
19320 Space in front of labels and similar commands:
19321 \begin_inset Newline newline
19324 The label should stick right up to the text to avoid falling to a wrong
19327 \begin_inset CommandInset label
19337 \begin_layout Plain Layout
19338 This footnote is in danger of falling off to a wrong page
19343 The label is separated too much.
19346 \begin_layout Itemize
19347 Space in front of references, instead of hard spaces:
19348 \begin_inset Newline newline
19351 If you have bad luck, the text will break right between the referenced text
19352 and reference number, and that's a pity.
19354 \begin_inset CommandInset ref
19356 reference "sec:chktex"
19363 \begin_layout Itemize
19365 \begin_inset Quotes eld
19369 \begin_inset Quotes erd
19373 \begin_inset Formula $\times$
19377 \begin_inset Newline newline
19380 2x2 looks cheap compared to
19381 \begin_inset Formula $2\times2$
19387 \begin_layout Standard
19388 and more \SpecialChar ldots
19389 It is an invaluable tool when you are
19390 \begin_inset Quotes eld
19394 \begin_inset Quotes erd
19397 your document before printing, and you should run it right after the obligatory
19398 spelling check, and before you go fine tuning the typesetting.
19401 \begin_layout Subsection
19405 \begin_layout Standard
19406 If you have the program installed, usage is as simple as choosing
19408 Tools\SpecialChar menuseparator
19410 \begin_inset space ~
19416 This will make \SpecialChar LyX
19417 generate a \SpecialChar LaTeX
19418 file of your document, start
19420 Chk\SpecialChar TeX
19423 to check it, and then make \SpecialChar LyX
19425 \begin_inset Quotes eld
19429 \begin_inset Quotes erd
19432 with the warnings from
19434 Chk\SpecialChar TeX
19437 , if there were any.
19438 The warnings will be placed close to the point of the mistake, and you
19439 can quickly find them by using the
19441 Navigate\SpecialChar menuseparator
19444 menu item, or the shortcut key
19453 Open the error boxes by clicking on them with the mouse, or use the shortcut
19462 bindings, or the corresponding
19471 Read the warning and correct the mistake, if it is a mistake.
19472 If you have trouble understanding what the warning is about, you can safely
19474 Remember that there is a hidden layer between the document on screen and
19475 the technical details in invoking
19477 Chk\SpecialChar TeX
19480 , and this gap can make some warnings seem arcane or just plain silly.
19483 \begin_layout Standard
19484 This document is an excellent testing bed for the feature, and it should
19485 provide quite a few warnings for you to fiddle with.
19486 Since computers are only so smart, expect most of the warnings to be false
19490 \begin_layout Subsection
19491 How to fine tune it
19494 \begin_layout Standard
19495 Sometimes, you'll find that
19497 Chk\SpecialChar TeX
19500 makes more noise than suits your mood.
19501 Then you can choose not to use it, wait until your mood changes, or try
19504 Chk\SpecialChar TeX
19507 to get better along with you.
19510 \begin_layout Standard
19513 Chk\SpecialChar TeX
19520 very configurable and extensible, you should not expect to solve all problems
19523 Chk\SpecialChar TeX
19526 in \SpecialChar LyX
19528 Since \SpecialChar LyX
19529 has to generate a somewhat special \SpecialChar LaTeX
19530 file to be able to match the
19531 line numbers from the
19533 Chk\SpecialChar TeX
19540 \begin_layout Plain Layout
19541 You can inspect the specific output from
19547 Document\SpecialChar menuseparator
19550 \begin_inset space ~
19564 to the internal document structure, some of the warnings will not appear
19566 There are two things you can do about this:
19569 \begin_layout Itemize
19572 Chk\SpecialChar TeX
19575 invocation command line in
19576 \begin_inset Flex Noun
19579 \begin_layout Plain Layout
19580 Tools\SpecialChar menuseparator
19581 Preferences\SpecialChar menuseparator
19582 Output\SpecialChar menuseparator
19583 LaTeX\SpecialChar menuseparator
19591 Chk\SpecialChar TeX
19594 installation configuration file (usually with the file
19599 See below to learn what warnings can be enabled and disabled on the command
19603 \begin_layout Itemize
19604 Export your document as a raw \SpecialChar LaTeX
19607 File\SpecialChar menuseparator
19608 Export\SpecialChar menuseparator
19617 Invoked in this way, it can be a hassle to find the corresponding place
19618 in the document inside \SpecialChar LyX
19619 , but with a little patience, you should be able
19623 \begin_layout Standard
19624 Here follows the warning messages that can be enabled and disabled in
19633 to disable a warning, and
19637 to enable a warning.
19638 The emphasized entries are disabled by default, because the default is
19641 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19646 \begin_layout Standard
19647 Notice that you should only use the options that enable and disable warnings,
19648 because \SpecialChar LyX
19649 relies on some of the other command line parameters to be set
19650 in a specific way to have a chance to communicate with
19657 \begin_layout Enumerate
19661 Command terminated with space.
19664 \begin_layout Enumerate
19667 Non-breaking space (
19668 \begin_inset Quotes eld
19676 \begin_inset Quotes erd
19679 ) should have been used.
19682 \begin_layout Enumerate
19686 You should enclose the previous parenthesis with
19687 \begin_inset Quotes eld
19695 \begin_inset Quotes erd
19701 \begin_layout Enumerate
19704 Italic correction (
19705 \begin_inset Quotes eld
19715 \begin_inset Quotes erd
19718 ) found in non-italic buffer.
19721 \begin_layout Enumerate
19724 Italic correction (
19725 \begin_inset Quotes eld
19735 \begin_inset Quotes erd
19738 ) found more than once.
19741 \begin_layout Enumerate
19745 No italic correction (
19746 \begin_inset Quotes eld
19756 \begin_inset Quotes erd
19762 \begin_layout Enumerate
19766 \begin_inset Quotes eld
19774 \begin_inset Quotes erd
19778 \begin_inset Quotes eld
19786 \begin_inset Quotes erd
19792 \begin_layout Enumerate
19795 Wrong length of dash may have been used.
19798 \begin_layout Enumerate
19802 \begin_inset Quotes eld
19810 \begin_inset Quotes erd
19814 \begin_inset Quotes eld
19822 \begin_inset Quotes erd
19828 \begin_layout Enumerate
19832 \begin_inset Quotes eld
19840 \begin_inset Quotes erd
19846 \begin_layout Enumerate
19850 \begin_inset Quotes eld
19858 \begin_inset Quotes erd
19861 to achieve an ellipsis.
19864 \begin_layout Enumerate
19867 Inter-word spacing (
19868 \begin_inset Quotes eld
19878 \begin_inset Quotes eld
19881 ) should perhaps be used.
19884 \begin_layout Enumerate
19887 Inter-sentence spacing (
19888 \begin_inset Quotes eld
19898 \begin_inset Quotes erd
19901 ) should perhaps be used.
19904 \begin_layout Enumerate
19907 Could not find argument for command.
19910 \begin_layout Enumerate
19914 \begin_inset Quotes eld
19922 \begin_inset Quotes erd
19928 \begin_layout Enumerate
19931 Math mode still on at end of \SpecialChar LaTeX
19935 \begin_layout Enumerate
19939 \begin_inset Quotes eld
19947 \begin_inset Quotes erd
19950 doesn't match the number of
19951 \begin_inset Quotes eld
19959 \begin_inset Quotes erd
19965 \begin_layout Enumerate
19968 You should use either
19971 \begin_inset Quotes eld
19979 \begin_inset Quotes erd
19984 as an alternative to
19985 \begin_inset Quotes eld
19993 \begin_inset Quotes erd
19999 \begin_layout Enumerate
20006 " (ASCII 39) instead of "
20013 \begin_layout Enumerate
20016 User-specified pattern found.
20019 \begin_layout Enumerate
20022 This command might not be intended.
20025 \begin_layout Enumerate
20032 \begin_layout Enumerate
20050 \begin_layout Enumerate
20053 Delete this space to maintain correct page references.
20056 \begin_layout Enumerate
20060 You might wish to put this between a pair of
20061 \begin_inset Quotes eld
20069 \begin_inset Quotes erd
20075 \begin_layout Enumerate
20078 You ought to remove spaces in front of punctuation.
20081 \begin_layout Enumerate
20084 Could not execute \SpecialChar LaTeX
20088 \begin_layout Enumerate
20097 in front of small punctuation.
20100 \begin_layout Enumerate
20108 may look prettier here.
20111 \begin_layout Enumerate
20115 Multiple spaces detected in output.
20118 \begin_layout Enumerate
20121 This text may be ignored.
20124 \begin_layout Enumerate
20130 \begin_inset Quotes eld
20135 to begin quotation, not
20142 \begin_layout Enumerate
20149 to end quotation, not
20152 \begin_inset Quotes eld
20160 \begin_layout Enumerate
20166 \begin_layout Enumerate
20169 You should perhaps use
20170 \begin_inset Quotes eld
20178 \begin_inset Quotes erd
20184 \begin_layout Enumerate
20187 You should put a space in front of/after parenthesis.
20190 \begin_layout Enumerate
20193 You should avoid spaces in front of/after parenthesis.
20196 \begin_layout Enumerate
20200 You should not use punctuation in front of/after quotes.
20203 \begin_layout Enumerate
20206 Double space found.
20209 \begin_layout Enumerate
20212 You should put punctuation outside inner/inside display math mode.
20215 \begin_layout Enumerate
20218 You ought to not use primitive \SpecialChar TeX
20219 in \SpecialChar LaTeX
20223 \begin_layout Enumerate
20226 You should remove spaces in front of
20227 \begin_inset Quotes eld
20235 \begin_inset Quotes erd
20241 \begin_layout Enumerate
20244 \begin_inset Quotes eld
20252 \begin_inset Quotes erd
20255 is normally not followed by
20256 \begin_inset Quotes eld
20264 \begin_inset Quotes erd
20270 \begin_layout Standard
20271 In later versions of \SpecialChar LyX
20272 , we hope to provide a more complete interface to this
20273 tool (and it's smaller cousin
20277 ) to exploit the full power of it.
20278 But it's not exactly useless as it is now: go try it on one of your existing
20279 documents of a certain length and be surprised.
20282 \begin_layout Section
20283 Version Control in \SpecialChar LyX
20287 \begin_layout Standard
20290 Lars Gullik Bjønnes
20297 \begin_layout Subsection
20301 \begin_layout Standard
20303 supports some of the most basic RCS/CVS/SVN/GIT commands.
20304 If you need something a bit more sophisticated you will have to do that
20305 manually in a terminal.
20308 \begin_layout Standard
20309 Also note that CVS support is not as good as subversion support so we advise
20311 A good place to start learning Subversion is SVN Book
20315 \begin_layout Plain Layout
20316 \begin_inset CommandInset href
20318 target "http://svnbook.red-bean.com/"
20329 In the case of RCS you should read
20330 \begin_inset Quotes eld
20334 \begin_inset Quotes erd
20337 (a man file, read it with
20342 This file describes all the basic features of RCS.
20343 You should especially notice the comment about a RCS directory, and the
20344 notion of a master RCS file (the file ending in
20351 \begin_layout Standard
20352 Before you begin to use the version control features in \SpecialChar LyX
20354 familiar with RCS/CVS/SVN/GIT usage.
20355 The implementation in \SpecialChar LyX
20356 assumes a recent version of the GNU RCS or CVS/SVN
20357 package — no guarantees are made for older versions.
20358 Most of the log messages are not currently displayed after operations —
20359 you can check them in the Messages pane if unsure.
20360 Regular users of version control will appreciate VC toolbar, which can
20363 View\SpecialChar menuseparator
20364 Toolbars\SpecialChar menuseparator
20366 \begin_inset space ~
20374 \begin_layout Standard
20375 For introducing your own external commands consult vc-command in the manual
20376 of \SpecialChar LyX
20380 \begin_layout Standard
20381 It is strongly recommended to store documents in uncompressed format if
20382 using version control (uncheck
20384 Document\SpecialChar menuseparator
20387 if it is checked): Uncompressed LyX documents are text files and therefore
20388 for merging two different versions by version control systems.
20389 Compressed LyX documents are binary files, which cannot be merged by version
20393 \begin_layout Subsection
20394 RCS commands in \SpecialChar LyX
20398 \begin_layout Standard
20399 The following sections describe the RCS commands supported by \SpecialChar LyX
20401 You can find them in the
20403 File\SpecialChar menuseparator
20405 \begin_inset space ~
20412 was tested against RCS 5.7/5.8.
20415 \begin_layout Subsubsection
20421 \begin_layout Standard
20422 If your document is not under revision control, this is the only item shown
20424 And if it is under revision control, the
20428 item is not visible.
20432 \begin_layout Standard
20433 This command registers your document with RCS (unless you are under the
20434 directory managed by CVS)\SpecialChar endofsentence
20435 You are asked interactively to supply an initial
20436 description of the document.
20437 The document is now set in Read-Only mode and you have to
20440 \begin_inset space ~
20444 \begin_inset space ~
20448 \begin_inset space ~
20453 , before making any changes to it.
20454 A document under revision control has a
20455 \begin_inset Quotes eld
20458 [RCS:<version> <locker>]
20459 \begin_inset Quotes erd
20462 item tagged to the filename in the minibuffer.
20465 \begin_layout Standard
20466 RCS command that is run:
20468 ci -q -u -i -t-"<initial description>" <file-name>
20471 \begin_layout Standard
20476 to understand the switches.
20480 \begin_layout Subsubsection
20486 \begin_layout Standard
20487 When you are finished editing a file, you check in your changes.
20488 When you do this, you are asked for a description of the changes.
20489 This is stored in the history log.
20490 The version number is bumped, your changes are applied to the master RCS
20491 file, the document is unlocked and set to Read-Only mode.
20494 \begin_layout Standard
20497 ci -q -u -m"<description>" <file-name>
20500 \begin_layout Subsubsection
20506 \begin_layout Standard
20507 By doing this you lock the document so that only you can edit it.
20508 This will also make the document Read-Write only for you.
20509 You will usually continue editing for a while and when you are finished
20510 you check in your changes.
20511 The status line is changed to reflect that you have locked the file.
20514 \begin_layout Standard
20517 co -q -l <file-name>
20520 \begin_layout Subsubsection
20523 Revert To Repository Version
20526 \begin_layout Standard
20527 This will discard all changes made to the document since the last check
20529 You get a warning before changes are discarded.
20532 \begin_layout Standard
20535 co -f -u<version> <file-name>
20538 \begin_layout Subsubsection
20544 \begin_layout Standard
20545 This will create a copy of the current document.
20546 Since RCS does not support copy operations natively, the version history
20547 is not preserved, and the copy is added as a new file.
20548 It requires a clean document without any changes since the last checkin.
20549 You are asked for a file name and a description of the copy operation.
20550 After that the copy is created, both locally and in the repository.
20551 If the parent directories of the copied and original document differ, all
20552 relative paths of included files of the copy are adjusted (like in
20554 File\SpecialChar menuseparator
20559 Finally, the copy is loaded instead of the original document.
20562 \begin_layout Labeling
20563 \labelwidthstring 00.00.0000
20565 \begin_inset space ~
20569 \begin_inset space ~
20573 \begin_inset Newline newline
20577 \begin_inset Flex Code
20580 \begin_layout Plain Layout
20583 \begin_inset Quotes eld
20587 \begin_inset Quotes erd
20596 \begin_inset Flex Code
20599 \begin_layout Plain Layout
20602 \begin_inset Quotes eld
20606 \begin_inset Quotes erd
20615 \begin_inset Newline newline
20619 \begin_inset Flex Code
20622 \begin_layout Plain Layout
20626 \begin_inset Quotes eld
20630 \begin_inset Quotes erd
20641 \begin_layout Subsubsection
20647 \begin_layout Standard
20648 This makes as if the last check in never happened.
20649 No changes are made to the document loaded into \SpecialChar LyX
20650 , but the last version
20651 is removed from the master RCS file.
20654 \begin_layout Standard
20657 rcs -o<version> <file-name>
20660 \begin_layout Subsubsection
20666 \begin_layout Standard
20667 This shows the complete history of the RCS document.
20672 is shown in a browser.
20680 \begin_layout Subsubsection
20684 \begin_layout Standard
20686 supports RCS version number, author name, date and time of last commit.
20687 All those are extracted from
20689 rlog -r <file-name>
20693 \begin_inset CommandInset ref
20695 reference "subsec:VCS-Revision-Information"
20702 \begin_layout Subsection
20703 CVS commands in \SpecialChar LyX
20707 \begin_layout Standard
20708 A subset of CVS operations is supported by \SpecialChar LyX
20710 You can find the commands in the
20712 File\SpecialChar menuseparator
20714 \begin_inset space ~
20720 The version control system SVN is more powerful, so please use it instead
20721 of CVS if possible.
20724 \begin_layout Subsubsection
20730 \begin_layout Standard
20731 If you start from scratch with CVS you have to create your repository and
20732 checkout the working copy with external tools.
20733 If you're using a client-server setup you may need to login before doing
20734 the first repository checkout.
20737 \begin_layout Standard
20738 If your documents are under revision control and others are using the same
20739 repository problems arise when different changes to the same document at
20740 the same location happen.
20741 Standard CVS repositories don't operate with a file locking mechanism.
20742 This may be surprising, but conflicts only occur if people disagree on
20743 the proper content of the same part of a document.
20744 So, if co-workers are used to communicate regularly, these conflicts occur
20746 If they don't communicate they have a fundamental problem anyway.
20747 Nevertheless some people like to work with so called
20748 \begin_inset Quotes eld
20752 \begin_inset Quotes erd
20756 If they do so the working copy of all files is readonly when checked out
20757 first and the user starts editing after using a special command to make
20758 the working copy writable.
20759 When the changes are checked in the working copy returns to readonly state.
20760 With \SpecialChar LyX
20761 one has to edit the
20762 \begin_inset Flex Code
20765 \begin_layout Plain Layout
20771 file and add the line
20772 \begin_inset Flex Code
20775 \begin_layout Plain Layout
20781 to work with reserved checkouts.
20782 The benefit is the possibility to see who is using a writable copy of some
20784 It's not guaranteed only one user makes a copy writable.
20787 \begin_layout Standard
20789 tries to guess if you're using reserved or non-reserved checkouts.
20790 If your working copy is readonly or it is writable and an additional copy
20791 of your document exists in the CVS/Base sub-directory a reserved otherwise
20792 a non-reserved checkout is assumed.
20793 When a reserved checkout is detected you have to use
20794 \begin_inset Flex Noun
20797 \begin_layout Plain Layout
20803 to make your working copy writable if it's readonly.
20805 \begin_inset Flex Noun
20808 \begin_layout Plain Layout
20814 operation is possible and that makes your working copy readonly again after
20815 transferring your changes to the repository.
20818 \begin_layout Standard
20819 More information about CVS can be found here
20820 \begin_inset Flex URL
20823 \begin_layout Plain Layout
20825 http://www.nongnu.org/cvs
20831 \begin_inset Flex URL
20834 \begin_layout Plain Layout
20836 http://ximbiot.com/cvs
20844 \begin_layout Standard
20849 to understand the sub-commands and the switches mentioned below.
20852 \begin_layout Subsubsection
20858 \begin_layout Standard
20859 If your document is not under revision control, this is the only item shown
20861 And if it is under revision control, the
20865 item is not visible.
20869 \begin_layout Standard
20870 This command registers in CVS your document
20871 \begin_inset Flex Strong
20874 \begin_layout Plain Layout
20882 in the case you have already the documents directory under CVS control
20888 This means you have to create or checkout the archive by yourself using
20890 (In case you forget that step \SpecialChar LyX
20891 registers the document with RCS.)
20894 \begin_layout Standard
20895 Then you are asked interactively to supply an initial description of the
20897 Don't forget that registered file is not yet checked in.
20900 \begin_layout Standard
20901 CVS command that is run:
20903 cvs -q add -m"<entered message>" "<file-name>"
20906 \begin_layout Standard
20911 above and for all other CVS commands is an abbreviation for
20912 \begin_inset Quotes eld
20915 change the current working directory to file location and use the file name
20916 without path component as argument
20917 \begin_inset Quotes erd
20923 \begin_layout Subsubsection
20929 \begin_layout Standard
20930 When you are finished editing a file, you commit your changes.
20931 When you do this and you had changed the document, you are asked for a
20932 description of the changes.
20933 After that changes are written to the repository.
20934 In case you didn't change the document and a reserved checkout is detected
20935 the reservation made on
20936 \begin_inset Flex Noun
20939 \begin_layout Plain Layout
20948 \begin_layout Labeling
20949 \labelwidthstring 00.00.0000
20951 \begin_inset space ~
20955 \begin_inset space ~
20959 \begin_inset Newline newline
20963 \begin_inset Flex Code
20966 \begin_layout Plain Layout
20969 -q commit -m"<description>" "<file-name>"
20975 \begin_inset Newline newline
20979 \begin_inset Flex Code
20982 \begin_layout Plain Layout
20993 \begin_layout Subsubsection
20999 \begin_layout Standard
21000 When you are sharing a repository with others, you may have to incorporate
21001 their changes into your working copy.
21004 \begin_layout Standard
21007 cvs -q update "<file-name>"
21010 \begin_layout Standard
21011 If a readonly checkout is detected the working copy is made writable and
21015 \begin_layout Standard
21018 cvs -q edit "<file-name>"
21021 \begin_layout Subsubsection
21024 Revert To Repository Version
21027 \begin_layout Standard
21028 This will discard all changes made to the document since the last check
21030 You get a warning before changes are discarded.
21031 Firstly the file is deleted, secondly CVS update command is run.
21034 \begin_layout Standard
21037 cvs -q update "<file-name>"
21040 \begin_layout Standard
21041 If a reserved checkout is detected and the working copy has no changes only
21042 the reservation is undone.
21045 \begin_layout Standard
21048 cvs -q unedit "<file-name>"
21051 \begin_layout Subsubsection
21057 \begin_layout Standard
21058 This will create a copy of the current document.
21059 Since CVS does not support copy operations natively, the version history
21060 is not preserved, and the copy is added as a new file.
21061 It requires a clean document without any changes since the last checkin.
21062 You are asked for a file name and a description of the copy operation.
21063 After that the copy is created, both locally and in the repository.
21064 If the parent directories of the copied and original document differ, all
21065 relative paths of included files of the copy are adjusted (like in
21067 File\SpecialChar menuseparator
21072 Finally, the copy is loaded instead of the original document.
21075 \begin_layout Labeling
21076 \labelwidthstring 00.00.0000
21078 \begin_inset space ~
21082 \begin_inset space ~
21086 \begin_inset Newline newline
21090 \begin_inset Flex Code
21093 \begin_layout Plain Layout
21096 \begin_inset Quotes eld
21100 \begin_inset Quotes erd
21109 \begin_inset Flex Code
21112 \begin_layout Plain Layout
21115 \begin_inset Quotes eld
21119 \begin_inset Quotes erd
21128 \begin_inset Newline newline
21132 \begin_inset Flex Code
21135 \begin_layout Plain Layout
21139 \begin_inset Quotes eld
21143 \begin_inset Quotes erd
21154 \begin_layout Subsubsection
21160 \begin_layout Standard
21161 This will rename the current document.
21162 Since CVS does not support rename operations natively, the version history
21163 is not preserved, the renamed document is added as a new file, and the
21164 original document is deleted.
21165 It requires a clean document without any changes since the last checkin.
21166 You are asked for a file name and a description of the rename operation.
21167 After that the document is renamed, both locally and in the repository.
21168 If the parent directories of the new and old file names differ, all relative
21169 paths of included files are adjusted (like in
21171 File\SpecialChar menuseparator
21176 Finally, the document is reloaded using the new name.
21179 \begin_layout Labeling
21180 \labelwidthstring 00.00.0000
21182 \begin_inset space ~
21186 \begin_inset space ~
21190 \begin_inset Newline newline
21194 \begin_inset Flex Code
21197 \begin_layout Plain Layout
21200 \begin_inset Quotes eld
21204 \begin_inset Quotes erd
21213 \begin_inset Flex Code
21216 \begin_layout Plain Layout
21219 \begin_inset Quotes eld
21223 \begin_inset Quotes erd
21232 \begin_inset Newline newline
21236 \begin_inset Flex Code
21239 \begin_layout Plain Layout
21243 \begin_inset Quotes eld
21247 \begin_inset Quotes erd
21256 \begin_inset Newline newline
21260 \begin_inset Flex Code
21263 \begin_layout Plain Layout
21267 \begin_inset Quotes eld
21271 \begin_inset Quotes erd
21282 \begin_layout Subsubsection
21283 Update of the local directory checkout from repository
21286 \begin_layout Standard
21287 Once your documents gets more complex, containing sub-documents and pictures,
21289 \begin_inset Flex Code
21292 \begin_layout Plain Layout
21298 files and so on using version control becomes more complicated.
21300 supports updating the whole tree in which resides the document.
21301 This become especially useful once you cooperate with people which neither
21302 have detailed knowledge about CVS usage nor they have ambition to commit
21303 additional material to the repository.
21304 You have to organize the files structure so that all external files are
21305 in the same directory or subdirectories of the document.
21306 It's good practice anyway to store multipart documents in an extra directory.
21309 \begin_layout Standard
21311 \begin_inset Flex Code
21314 \begin_layout Plain Layout
21315 Update local directory from repository
21320 command updates the whole directory.
21321 If local changes are detected user is warned before update starts.
21322 In case of merge conflicts both versions of the conflicting document parts
21323 are placed in the final document.
21324 You have to review and correct the result of the merge.
21325 You'll find the conflicts enclosed in pairs of
21326 \begin_inset Flex Code
21329 \begin_layout Plain Layout
21336 \begin_inset Flex Code
21339 \begin_layout Plain Layout
21346 \begin_inset Flex Code
21349 \begin_layout Plain Layout
21356 The first part is your version as before the update operation with the
21357 document name prepended.
21358 The second one is the repository version with the version number after
21360 \begin_inset Flex Code
21363 \begin_layout Plain Layout
21372 \begin_layout Labeling
21373 \labelwidthstring 00.00.0000
21375 \begin_inset space ~
21379 \begin_inset space ~
21383 \begin_inset Newline newline
21387 \begin_inset Flex Code
21390 \begin_layout Plain Layout
21398 (Ask if changes are detected.)
21399 \begin_inset Newline newline
21403 \begin_inset Flex Code
21406 \begin_layout Plain Layout
21407 cd $path; cvs -q update
21417 \begin_layout Standard
21419 \begin_inset Flex Code
21422 \begin_layout Plain Layout
21428 stands for the path to the document.
21431 \begin_layout Subsubsection
21437 \begin_layout Standard
21438 This shows the complete history of the CVS document.
21441 cvs log "<file-name>"
21443 is shown in a browser.
21446 \begin_layout Subsubsection
21450 \begin_layout Standard
21452 supports CVS version number, author name, date and time of last commit.
21453 All those are extracted from
21455 cvs log -r <file-name>
21459 \begin_inset CommandInset ref
21461 reference "subsec:VCS-Revision-Information"
21468 \begin_layout Subsection
21469 SVN commands in \SpecialChar LyX
21473 \begin_layout Standard
21474 SVN is now partially supported by \SpecialChar LyX
21476 You can find the commands in the
21478 File\SpecialChar menuseparator
21480 \begin_inset space ~
21486 Please note that if you use password protected access to repository via
21487 ssh, you will be asked in terminal window.
21489 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21493 \begin_layout Plain Layout
21494 Most of the commands will work with 1.4 too, see
21495 \begin_inset CommandInset ref
21497 reference "subsec:SVN-Repo-Update"
21502 There seems to be currently unresolved permissions problem under SVN 1.8
21503 with reverting changes when file is locked.
21511 \begin_layout Subsubsection
21517 \begin_layout Standard
21518 If your document is not under revision control, this is the only item shown
21520 And if it is under revision control, the
21524 item is not visible.
21527 \begin_layout Standard
21528 This command registers in SVN your document ONLY in case you have already
21529 the documents directory under SVN control (in particular
21534 This means you have to checkout the archive by yourself.
21537 \begin_layout Standard
21538 Then you are asked interactively to supply an initial description of the
21540 Don't forget that registered file is not yet commited.
21543 \begin_layout Standard
21544 SVN command that is run:
21547 \begin_inset Quotes eld
21551 \begin_inset Quotes erd
21557 \begin_layout Standard
21562 to understand the switches.
21565 \begin_layout Subsubsection
21571 \begin_layout Standard
21572 When you are finished editing a file, you commit your changes.
21573 When you do this, you are asked for a description of the changes.
21574 After that changes are commited.
21577 \begin_layout Standard
21582 \begin_layout Plain Layout
21583 In case locking is not enabled.
21585 \begin_inset CommandInset ref
21587 reference "subsec:SVN-File-Locking"
21598 svn commit -q -m"<description>" <file-name>
21601 \begin_layout Subsubsection
21607 \begin_layout Standard
21608 Updates the changes of this file from the repository.
21609 Be sure you understand SVN merging and conflicts resolving before using
21610 this function, because all conflicts has to be resolved manually by you!
21613 \begin_layout Standard
21618 \begin_layout Plain Layout
21626 svn update --non-interactive
21627 \begin_inset Quotes eld
21631 \begin_inset Quotes erd
21637 \begin_layout Subsubsection
21640 Revert To Repository Version
21643 \begin_layout Standard
21644 This will discard all changes made to the document since the last check
21646 You get a warning before changes are discarded.
21649 \begin_layout Standard
21653 \begin_inset Quotes eld
21657 \begin_inset Quotes erd
21663 \begin_layout Subsubsection
21669 \begin_layout Standard
21670 This will create a copy of the current document including the version history.
21671 It requires a clean document without any changes since the last checkin.
21672 You are asked for a file name and a description of the copy operation.
21673 After that the copy is created, both locally and in the repository.
21674 If the parent directories of the copied and original document differ, all
21675 relative paths of included files of the copy are adjusted (like in
21677 File\SpecialChar menuseparator
21682 Finally, the copy is loaded instead of the original document.
21685 \begin_layout Labeling
21686 \labelwidthstring 00.00.0000
21688 \begin_inset space ~
21692 \begin_inset space ~
21696 \begin_inset Newline newline
21700 \begin_inset Flex Code
21703 \begin_layout Plain Layout
21707 \begin_inset Quotes eld
21711 \begin_inset Quotes erd
21715 \begin_inset Quotes eld
21719 \begin_inset Quotes erd
21728 \begin_inset Newline newline
21732 \begin_inset Flex Code
21735 \begin_layout Plain Layout
21744 \begin_layout Subsubsection
21750 \begin_layout Standard
21751 This will rename the current document including the version history.
21752 It requires a clean document without any changes since the last checkin.
21753 You are asked for a file name and a description of the rename operation.
21754 After that the document is renamed, both locally and in the repository.
21755 If the parent directories of the new and old file names differ, all relative
21756 paths of included files are adjusted (like in
21758 File\SpecialChar menuseparator
21763 Finally, the document is reloaded using the new name.
21766 \begin_layout Labeling
21767 \labelwidthstring 00.00.0000
21769 \begin_inset space ~
21773 \begin_inset space ~
21777 \begin_inset Newline newline
21781 \begin_inset Flex Code
21784 \begin_layout Plain Layout
21788 \begin_inset Quotes eld
21792 \begin_inset Quotes erd
21796 \begin_inset Quotes eld
21800 \begin_inset Quotes erd
21809 \begin_inset Newline newline
21813 \begin_inset Flex Code
21816 \begin_layout Plain Layout
21825 \begin_layout Subsubsection
21826 \begin_inset CommandInset label
21828 name "subsec:SVN-Repo-Update"
21832 Update of the local directory checkout from repository
21836 \begin_layout Plain Layout
21837 Note that this command will work only with subversion
21838 \begin_inset Formula $\geqq1.5$
21849 \begin_layout Standard
21850 All the commands above have one shortcomming - they deal with the current
21852 Once your document contains pictures, includes external
21853 \begin_inset Flex Code
21856 \begin_layout Plain Layout
21862 files and so on administration becomes more complicated.
21864 now supports updating the whole tree in which resides the document
21868 \begin_layout Plain Layout
21869 One need to organize the files structure so that all external files are
21870 in the same directory or subdirectories of the document.
21877 This become especially useful once you cooperate with people which neither
21878 know about subversion management nor they have ambition to commit additional
21879 material to the repository.
21883 \begin_layout Standard
21884 \begin_inset Flex Code
21887 \begin_layout Plain Layout
21888 Update local directory from repository
21893 command updates the whole directory and in case of merge conflicts local
21894 version of the files are left, so no unintended data loss occurs.
21895 If local changes are detected user is warned before update starts.
21898 \begin_layout Labeling
21899 \labelwidthstring 00.00.0000
21901 \begin_inset space ~
21905 \begin_inset space ~
21909 \begin_inset Newline newline
21913 \begin_inset Flex Code
21916 \begin_layout Plain Layout
21922 (Ask if changes are detected.)
21923 \begin_inset Newline newline
21927 \begin_inset Flex Code
21930 \begin_layout Plain Layout
21931 svn update –accept mine-full $path
21939 \begin_layout Standard
21941 \begin_inset Flex Code
21944 \begin_layout Plain Layout
21950 stands for the path to the document.
21953 \begin_layout Subsubsection
21959 \begin_layout Standard
21960 This shows the complete history of the SVN document.
21964 \begin_inset Quotes eld
21968 \begin_inset Quotes erd
21973 is shown in a browser.
21976 \begin_layout Subsubsection
21978 \begin_inset CommandInset label
21980 name "subsec:SVN-File-Locking"
21987 \begin_layout Standard
21988 The file exchange through various revision control systems brings the problem
21989 of merge conflicts in case two different users try to edit the same (parts
21991 When such a conflict happens it needs manual resolving and one reasonable
21992 alternative is to provide some kind of locking mechanism, which guarantees
21993 that only one user is allowed to edit file at the given time.
21996 \begin_layout Standard
21997 SVN has two such mechanisms to provide mutual exclusivity for file access
21998 - locks and automatic setting of write permissions (see sec.
22000 \begin_inset CommandInset ref
22002 reference "subsec:Automatical-Locking-Property"
22007 \begin_inset Flex Code
22010 \begin_layout Plain Layout
22020 \begin_layout Plain Layout
22021 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
22027 If this property is detected for a given document \SpecialChar LyX
22028 starts to use SVN locks
22029 for document editing automatically and the whole check-in/out mechanism
22030 switches to the same regimen as for RCS.
22031 This in particular means there are two different modes of file use in \SpecialChar LyX
22035 \begin_layout Itemize
22037 The loaded file is in the read-only mode.
22038 For editing on needs to check-out.
22043 consists of updating from the repository and gaining write lock.
22044 If the lock is not possible to obtain, we remain in unlocked state.
22047 \begin_layout Itemize
22049 The loaded file is in the 'normal' edit mode.
22050 No other user is allowed to edit the file.
22055 consists of commiting changes and releasing write-lock.
22056 If no changes have been made to the document, no commit will be produced
22060 \begin_layout Plain Layout
22061 Don't be puzzled by the fact that you will be asked for commit message anyway.
22066 and only the write-lock will be released.
22069 \begin_layout Standard
22073 \begin_layout Labeling
22074 \labelwidthstring 00.00.0000
22077 svn commit -q -m"<description>" "<file-name>"
22078 \begin_inset Newline newline
22081 svn unlock "<file-name>"
22084 \begin_layout Labeling
22085 \labelwidthstring 00.00.0000
22088 svn update "<file-name>"
22089 \begin_inset Newline newline
22092 svn lock "<file-name>"
22095 \begin_layout Subsubsection
22098 \begin_inset CommandInset label
22100 name "subsec:Automatical-Locking-Property"
22106 Automatic Locking Property
22109 \begin_layout Standard
22110 The above mentioned automatic setting of write permissions of the .lyx file
22113 File\SpecialChar menuseparator
22115 \begin_inset space ~
22118 Control\SpecialChar menuseparator
22119 Toggle locking property
22122 This command is active only when the file is not locked on the svn server
22124 you need to check-out before proceeding).
22127 \begin_layout Labeling
22128 \labelwidthstring 00.00.0000
22130 \begin_inset space ~
22136 \begin_layout Labeling
22137 \labelwidthstring 00.00.0000
22140 svn propset svn:needs-lock ON "<file-name>"
22143 \begin_layout Labeling
22144 \labelwidthstring 00.00.0000
22147 svn propdel svn:needs-lock "<file-name>"
22150 \begin_layout Subsubsection
22151 \begin_inset CommandInset label
22153 name "subsec:VCS-Revision-Information"
22157 Revision Information in Documents
22160 \begin_layout Standard
22161 There are more possibilities how to activate revision information in our
22165 \begin_layout Itemize
22171 \begin_layout Itemize
22172 tree revision information (
22173 \begin_inset Flex Code
22176 \begin_layout Plain Layout
22183 The result is the output of the
22184 \begin_inset Flex Code
22187 \begin_layout Plain Layout
22193 command, the following table gives you an idea, how to read the results.
22196 \begin_layout Standard
22198 \begin_inset Tabular
22199 <lyxtabular version="3" rows="6" columns="2">
22200 <features tabularvalignment="middle">
22201 <column alignment="center" valignment="top">
22202 <column alignment="center" valignment="top">
22204 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22207 \begin_layout Plain Layout
22213 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22216 \begin_layout Plain Layout
22224 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22227 \begin_layout Plain Layout
22233 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22236 \begin_layout Plain Layout
22237 mixed revision working copy
22244 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22247 \begin_layout Plain Layout
22253 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22256 \begin_layout Plain Layout
22257 modified working copy
22264 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22267 \begin_layout Plain Layout
22273 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22276 \begin_layout Plain Layout
22277 switched working copy
22284 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22287 \begin_layout Plain Layout
22293 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22296 \begin_layout Plain Layout
22297 partial working copy, from a sparse checkout
22304 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22307 \begin_layout Plain Layout
22313 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22316 \begin_layout Plain Layout
22317 mixed revision, modified, switched working copy
22330 \begin_layout Itemize
22331 file revision information.
22332 The result comes from parsing the output of
22333 \begin_inset Flex Code
22336 \begin_layout Plain Layout
22338 \begin_inset space ~
22342 \begin_inset space ~
22346 \begin_inset space ~
22355 Supported flags are:
22359 \begin_layout Itemize
22360 version number of the last commit (
22361 \begin_inset Flex Code
22364 \begin_layout Plain Layout
22373 \begin_layout Itemize
22374 author of the last commit (
22375 \begin_inset Flex Code
22378 \begin_layout Plain Layout
22387 \begin_layout Itemize
22388 date of the last commit (
22389 \begin_inset Flex Code
22392 \begin_layout Plain Layout
22401 \begin_layout Itemize
22402 time of the last commit (
22403 \begin_inset Flex Code
22406 \begin_layout Plain Layout
22416 \begin_layout Standard
22417 You can obtain this info via InsetInfo (e.g.
22419 \begin_inset Flex Code
22422 \begin_layout Plain Layout
22423 info-insert buffer vcs-date
22429 The information will be available only when you have the file stored under
22430 svn managment (i.e.
22432 \begin_inset Flex Code
22435 \begin_layout Plain Layout
22441 directory is available with your document).
22445 \begin_layout Itemize
22446 Another—a hacking one—possibility is to use svn keywords
22450 \begin_layout Plain Layout
22451 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22457 In short – you set file keywords property (e.g.
22460 svn propset svn:keywords 'Rev' file.lyx
22462 ) and then paste keyword \SpecialChar TeX
22467 \begin_layout Plain Layout
22468 This is an easy way how to ensure that \SpecialChar LyX
22469 won't break the line in the middle
22475 tag in your document (e.g.
22480 \begin_layout Plain Layout
22488 This way svn client will automatically substitute revision number (e.g.
22493 \begin_layout Plain Layout
22500 ) after each update and commit.
22501 There are more problems with this approach.
22502 Firstly, the '$' character is used in \SpecialChar TeX
22503 world for math equations, so any
22504 occurence of math formula
22505 \begin_inset Formula $Rev$
22509 \begin_inset Formula $Rev:59$
22512 in your \SpecialChar LyX
22514 Similarly for other keywords like Id, Date, Author, etc.
22515 Secondly svn output is dependent on your locales, so its very easy that
22516 svn would produce some problematic strings once Date is used.
22517 Thirdly you get the whole 'Rev: 59' string in your document instead of
22519 Until subversion implements user's custom keywords it will be hard to use
22520 this approach reliably or let \SpecialChar LyX
22521 to support it directly.
22524 \begin_layout Subsection
22525 SVN and Windows Environment
22528 \begin_layout Quote
22529 My inclination is to say that if the user cannot figure out the command
22530 line operations on their own fairly quickly, they would be well advised
22531 to use TortoiseSVN.
22537 \begin_layout Subsubsection
22541 \begin_layout Standard
22542 In addition to installing \SpecialChar LyX
22543 , and having access to a Subversion repository,
22544 the user will need to install the Subversion client program.
22545 A Windows installer for the client program is available from
22546 \begin_inset CommandInset href
22549 target "http://www.collab.net/nonav/downloads/subversion/"
22555 The user may also want to install
22556 \begin_inset CommandInset href
22559 target "http://tortoisesvn.tigris.org/"
22564 , which integrates Subversion operations into the context (rightclick) menu
22565 of Windows Explorer.
22566 Operations done outside \SpecialChar LyX
22567 will typically be more convenient using the Explorer
22569 Note that TortoiseSVN is not a replacement for the client program, which
22570 is what \SpecialChar LyX
22574 \begin_layout Subsubsection
22575 Bringing a document under Subversion control
22578 \begin_layout Standard
22579 Before a \SpecialChar LyX
22580 document can be brought under version control in Subversion, its
22581 parent directory needs to be under version control.
22582 If the document is being added to a project already in the repository,
22583 this is accomplished by checking the project out to the directory where
22584 the new document will be placed.
22585 If the project itself is not yet under version control (for instance, if
22586 this document starts a new project), the directory must be imported into
22588 This is done outside \SpecialChar LyX
22590 Both import and checkout are easily accomplished from the Explorer context
22591 menu using TortoiseSVN, or alternatively can be done using the command
22592 line client at a DOS prompt.
22593 The procedure for importing the project using TortoiseSVN is described
22594 below, assuming an existing repository and a new project being started
22602 For information on using the Subversion client program, run
22609 \begin_layout Enumerate
22616 in Windows Explorer, right click it, and select
22618 TortoiseSVN\SpecialChar menuseparator
22622 If necessary, adjust the URL for the repository, then click OK.
22625 \begin_layout Enumerate
22626 Right click the level of the repository under which you want to place the
22627 new project folder (typically the top level) and click
22631 Supply a name for the project folder and click OK.
22632 Add a message for the log file if desired, then click OK again.
22633 The new project folder should appear in the repository.
22634 Finally, click OK again to exit the repository browser.
22637 \begin_layout Enumerate
22638 Once again right click
22644 , this time selecting SVN Checkout\SpecialChar ldots
22645 Select the URL of the project folder
22646 you just created in the repository, and set the checkout directory to
22654 You will be warned about a non-empty folder; click OK to proceed.
22655 You should now have a
22666 \begin_layout Enumerate
22667 Create or open your document in \SpecialChar LyX
22670 File\SpecialChar menuseparator
22672 \begin_inset space ~
22675 Control\SpecialChar menuseparator
22679 Add a log message and click OK to commit the document to version control.
22682 \begin_layout Standard
22683 From this point onward, you should have full functionality in the
22685 File\SpecialChar menuseparator
22687 \begin_inset space ~
22693 You also have the option of checking the document in and out, viewing its
22695 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22696 client program from a command prompt.
22699 \begin_layout Subsubsection
22700 SSH tunnel used with SVN under Windows
22703 \begin_layout Standard
22704 Compared with Linux setting up an svn client to communicate over ssh under
22705 Windows is a rather troublesome task.
22706 We will at least offer some hints how to setup the client side but prior
22707 knowledge about ssh and the Windows command line is needed, also be prepared
22708 for a great deal of frustration\SpecialChar ldots
22712 \begin_layout Enumerate
22713 Get an svn client for windows, as described in the previous sections.
22714 When it is a fresh install run some svn command (e.g.
22716 \begin_inset Flex Code
22719 \begin_layout Plain Layout
22725 ) to create config files, which you will need to change later on.
22728 \begin_layout Enumerate
22729 Choose an ssh client for Windows.
22730 There are several possibilities, we will use the one from Putty tools
22734 \begin_layout Plain Layout
22735 \begin_inset Flex URL
22738 \begin_layout Plain Layout
22740 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22751 You will need to set the connection up so that the client doesn't ask for
22752 any password from you.
22753 To keep things easy we will use only keys without any additional password
22758 \begin_layout Enumerate
22760 \begin_inset Flex Code
22763 \begin_layout Plain Layout
22770 Save your private .ppk key file and put the public one on the server side.
22771 If the SVN server runs on Linux, note that the format of the public key
22772 is not compatible with Linux openssh and you will need to direcly copy-paste
22775 Public key for pasting into OpenSSH authorized_keys file
22777 :” edit field into the server's
22778 \begin_inset Flex Code
22781 \begin_layout Plain Layout
22782 ~/.ssh/authorized_keys
22788 \begin_inset Flex Code
22791 \begin_layout Plain Layout
22800 \begin_layout Enumerate
22802 \begin_inset Flex Code
22805 \begin_layout Plain Layout
22812 In the SVN config file
22816 \begin_layout Plain Layout
22817 Exact path depends on Windows version, usually somewhere around
22818 \begin_inset Flex Code
22821 \begin_layout Plain Layout
22824 Documents and Settings
22838 \begin_inset Flex Code
22841 \begin_layout Plain Layout
22856 , section [tunnels], setup ssh command, e.g.
22858 \begin_inset Flex Code
22861 \begin_layout Plain Layout
22862 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22871 \begin_layout Plain Layout
22872 It will usually take a lot of time to get exact command right and it depends
22874 For example do not have some remote server saved as a default session in
22876 If things fail, try to connect via plink without SVN first.
22885 \begin_layout Enumerate
22886 Checkout the SVN archive, e.
22887 \begin_inset space \thinspace{}
22891 \begin_inset Newline newline
22895 \begin_inset Flex Code
22898 \begin_layout Plain Layout
22899 svn co svn+ssh://user@server/repository_path
22907 \begin_layout Subsubsection
22908 End-of-Line Conversions
22911 \begin_layout Standard
22912 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22914 use different line endings inside the .lyx files.
22915 This is not a problem as far as \SpecialChar LyX
22916 functionality is concerned, but the commit
22917 diffs will be huge and merge-conflicts prone.
22918 Fortunately SVN itself knows
22922 \begin_layout Plain Layout
22923 \begin_inset Flex URL
22926 \begin_layout Plain Layout
22928 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22938 how to deal with CR/LF problems when switching .lyx files to the
22939 \begin_inset Flex Code
22942 \begin_layout Plain Layout
22952 \begin_layout Plain Layout
22954 \begin_inset Flex Code
22957 \begin_layout Plain Layout
22958 svn propset svn:eol-style native FILE_NAME
22971 \begin_layout Subsection
22972 GIT commands in \SpecialChar LyX
22976 \begin_layout Standard
22977 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22979 You can find the commands in the
22981 File\SpecialChar menuseparator
22983 \begin_inset space ~
22989 Please note that if you use password protected access to repository via
22990 ssh, you will be asked in terminal window.
22992 was tested against GIT 1.7.
22996 \begin_layout Plain Layout
22997 Windows users please note that you need to ensure that git is on the path.
22998 This can be set from within \SpecialChar LyX
23001 Tools\SpecialChar menuseparator
23002 Preferences\SpecialChar menuseparator
23003 Paths\SpecialChar menuseparator
23014 \begin_layout Standard
23015 One big difference of GIT and the other supported version control systems
23016 is the distributed nature of GIT: With traditional version control systems
23017 there is one central server which hosts the repository.
23018 Users commit their changes to the server, and get updates made by other
23020 With GIT, users commit to a local repository.
23021 The local repository can be synchronized with one or more remote repositories
23023 \begin_inset Flex Code
23026 \begin_layout Plain Layout
23033 \begin_inset Flex Code
23036 \begin_layout Plain Layout
23044 does not interact in any way with remote GIT repositories.
23045 It works exclusively with the local repository in a very similar way as
23046 with a central CVS or SVN repository.
23047 If you use remote GIT repositories you need to do the
23048 \begin_inset Flex Code
23051 \begin_layout Plain Layout
23058 \begin_inset Flex Code
23061 \begin_layout Plain Layout
23067 operations with your favourite GIT client.
23070 \begin_layout Subsubsection
23076 \begin_layout Standard
23077 If your document is not under revision control, this is the only item shown
23079 And if it is under revision control, the
23083 item is not visible.
23086 \begin_layout Standard
23087 This command registers in GIT your document ONLY in case you have already
23088 the documents directory under GIT control (in particular
23093 This means you have to checkout the archive by yourself.
23096 \begin_layout Standard
23097 Then you are asked interactively to supply an initial description of the
23099 Don't forget that registered file is not yet commited.
23102 \begin_layout Standard
23103 GIT command that is run:
23106 \begin_inset Quotes eld
23110 \begin_inset Quotes erd
23116 \begin_layout Standard
23121 to understand the switches.
23124 \begin_layout Subsubsection
23130 \begin_layout Standard
23131 When you are finished editing a file, you commit your changes.
23132 When you do this, you are asked for a description of the changes.
23133 After that changes are commited.
23136 \begin_layout Standard
23139 git commit -q -m"<description>" <file-name>
23142 \begin_layout Subsubsection
23145 Revert To Repository Version
23148 \begin_layout Standard
23149 This will discard all changes made to the document since the last check
23151 You get a warning before changes are discarded.
23154 \begin_layout Standard
23158 \begin_inset Quotes eld
23162 \begin_inset Quotes erd
23168 \begin_layout Subsubsection
23174 \begin_layout Standard
23175 This will rename the current document including the version history.
23176 It requires a clean document without any changes since the last checkin.
23177 You are asked for a file name and a description of the rename operation.
23178 After that the document is renamed, both locally and in the repository.
23179 If the parent directories of the new and old file names differ, all relative
23180 paths of included files are adjusted (like in
23182 File\SpecialChar menuseparator
23187 Finally, the document is reloaded using the new name.
23190 \begin_layout Labeling
23191 \labelwidthstring 00.00.0000
23193 \begin_inset space ~
23197 \begin_inset space ~
23201 \begin_inset Newline newline
23205 \begin_inset Flex Code
23208 \begin_layout Plain Layout
23212 \begin_inset Quotes eld
23216 \begin_inset Quotes erd
23220 \begin_inset Quotes eld
23224 \begin_inset Quotes erd
23233 \begin_inset Newline newline
23237 \begin_inset Flex Code
23240 \begin_layout Plain Layout
23249 \begin_layout Subsubsection
23255 \begin_layout Standard
23256 This shows the complete history of the GIT document.
23260 \begin_inset Quotes eld
23264 \begin_inset Quotes erd
23269 is shown in a browser.
23272 \begin_layout Subsubsection
23276 \begin_layout Standard
23278 supports GIT hash number of the last commit to the file, author name, date
23279 and time of last commit.
23280 All those are extracted from
23282 git log -n 1 --pretty=format:%H%n%an%n%ai
23285 Tree version information is obtained via
23287 git describe --abbrev --dirty --long
23291 \begin_inset CommandInset ref
23293 reference "subsec:VCS-Revision-Information"
23300 \begin_layout Subsection
23304 \begin_layout Standard
23305 With the recent addition of the vc-command function \SpecialChar LyX
23306 power users are allowed
23307 to create their own commands for revision control.
23310 \begin_layout Standard
23311 As an example you can see how two TortoiseSVN commands could be integrated
23315 \begin_layout Description
23317 \begin_inset Flex Code
23320 \begin_layout Plain Layout
23321 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23329 \begin_layout Description
23331 \begin_inset Flex Code
23334 \begin_layout Plain Layout
23335 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23343 \begin_layout Subsection
23344 Version control and Document comparison
23347 \begin_layout Standard
23348 One of the typical uses of version control is to inspect the changes between
23349 revisions, usually by creating
23350 \begin_inset Flex Code
23353 \begin_layout Plain Layout
23360 While this is useful for plain text files, it is much less useful in the
23361 case of \SpecialChar LyX
23362 files, which have more a complicated structure.
23363 Hence we provide binding to the Document comparison feature.
23364 There are two ways of calling this feature - either by direct call of
23365 \begin_inset Flex Code
23368 \begin_layout Plain Layout
23375 function (for details see \SpecialChar LyX
23376 functions manual) or by icon/menu item
23377 \begin_inset Flex Noun
23380 \begin_layout Plain Layout
23381 Compare with older revision...
23387 One can either compare two chosen revisions of the document or he can simply
23388 compare the current version of edited text with older revisions (where
23390 \begin_inset Flex Noun
23393 \begin_layout Plain Layout
23399 ' revisions back means comparison of the edited file with last commited
23404 \begin_layout Standard
23405 This feature is supported for SVN and RCS though due to the more complicated
23406 versioning scheme of RCS there is a constraint – when addressing the revisions
23407 in dialog, numbers always point to the last number in RCS revision number,
23410 We don't currently support GIT addressing of revisions, one can just compare
23411 edited document with its revision X steps backs, where X is addressed as
23415 \begin_layout Section
23416 Literate Programming
23419 \begin_layout Standard
23424 (kayvan@sylvan.com)
23428 original documentation written by
23430 Edmar Wienskoski Jr.
23433 (edmar-w-jr@technologist.com)
23436 \begin_layout Subsection
23440 \begin_layout Standard
23441 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23443 programming, where it is assumed that you are familiar with this programming
23444 technique, and know what
23445 \begin_inset Quotes eld
23449 \begin_inset Quotes erd
23453 \begin_inset Quotes eld
23457 \begin_inset Quotes erd
23461 If that is not the case, please follow the web links provided in the following
23463 There is a lot of good documentation out there covering old development
23464 history to the latest tools tips.
23467 \begin_layout Standard
23468 It is also assumed that you are familiar with \SpecialChar LyX
23469 itself to a point that you
23470 are comfortable changing your \SpecialChar LyX
23471 preferences, and X resources file.
23472 If that is not the case please refer to other \SpecialChar LyX
23473 documentation to cover your
23477 \begin_layout Subsection
23478 Literate Programming
23481 \begin_layout Standard
23482 From the Literate Programming FAQ:
23485 \begin_layout Quotation
23486 Literate programming is the combination of documentation and source together
23487 in a fashion suited for reading by human beings.
23488 In fact, literate programs should be enjoyable reading, even inviting!
23489 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23490 and documentation in a single file.
23491 Literate programming tools then parse the file to produce either readable
23492 documentation or compilable source.
23493 The WEB style of literate programming was created by D.
23494 \begin_inset space \thinspace{}
23498 Knuth during the development of his \SpecialChar TeX
23499 typesetting software.
23503 \begin_layout Standard
23504 Another excerpt says:
23507 \begin_layout Quotation
23510 How is literate programming different from verbose commenting?
23513 \begin_layout Quotation
23514 There are three distinguishing characteristics.
23515 In order of importance, they are:
23519 \begin_layout Itemize
23520 flexible order of elaboration
23523 \begin_layout Itemize
23524 automatic support for browsing
23527 \begin_layout Itemize
23528 typeset documentation, especially diagrams and mathematics
23532 \begin_layout Standard
23533 Now that I sparked your curiosity, take a look in the references.
23536 \begin_layout Subsubsection
23540 \begin_layout Standard
23541 The complete Literate Programming FAQ can be found at:
23544 \begin_layout Quote
23545 Literate Programming FAQ
23546 \begin_inset Flex URL
23549 \begin_layout Plain Layout
23551 http://www.literateprogramming.com/lpfaq.pdf
23559 \begin_layout Standard
23560 The FAQ lists 23 (twenty three!) different literate programming tools.
23561 Where some are specialized or
23562 \begin_inset Quotes eld
23566 \begin_inset Quotes erd
23569 for particular programming languages, while other have general scope.
23574 for my own use for several reasons:
23577 \begin_layout Itemize
23578 It can generate the documentation either in \SpecialChar LaTeX
23582 \begin_layout Itemize
23583 It has a open architecture, i.
23584 \begin_inset space \thinspace{}
23588 \begin_inset space \space{}
23591 it is easy to plug in new filters and to perform special processing that
23596 \begin_layout Itemize
23597 There is a good selection of filters available already (the HTML is one
23601 \begin_layout Itemize
23605 \begin_layout Standard
23606 The Noweb web page can be found at:
23609 \begin_layout Quote
23611 \begin_inset Flex URL
23614 \begin_layout Plain Layout
23616 http://www.cs.virginia.edu/~nr/noweb/
23624 \begin_layout Standard
23625 Starting from there you can reach many other interesting links and even
23626 some literate program examples.
23629 \begin_layout Subsection
23631 and Literate Programming with Noweb
23634 \begin_layout Standard
23635 The \SpecialChar LyX
23636 support for Literate Programming is provided by using the generic \SpecialChar LyX
23638 converters mechanism.
23639 This support is provided in a
23640 \begin_inset Quotes eld
23644 \begin_inset Quotes erd
23648 \begin_inset space \thinspace{}
23652 \begin_inset space \space{}
23655 you will be able to use this new \SpecialChar LyX
23656 feature with some other literate programming
23657 tool of your choice by just changing your \SpecialChar LyX
23661 \begin_layout Subsubsection
23662 Generating documents and code (weaving and tangling)
23665 \begin_layout Paragraph
23666 Using the noweb module
23669 \begin_layout Standard
23670 If you have installed Noweb and \SpecialChar LyX
23671 successfully, whenever you open a new document,
23672 after you have chosen its document class, use the Document->Settings menu
23674 \begin_inset Quotes eld
23678 \begin_inset Quotes erd
23682 If Noweb is correctly installed, when you click on the
23683 \begin_inset Quotes eld
23687 \begin_inset Quotes erd
23690 link, you will see the
23691 \begin_inset Quotes eld
23695 \begin_inset Quotes erd
23698 module in the available list and you can add it to your document.
23701 \begin_layout Paragraph
23705 \begin_layout Standard
23707 enables you to write code with a layout named
23708 \begin_inset Flex Noun
23711 \begin_layout Plain Layout
23718 Noweb delimits chunks like this:
23721 \begin_layout LyX-Code
23725 \begin_layout LyX-Code
23729 \begin_layout LyX-Code
23733 \begin_layout LyX-Code
23737 \begin_layout LyX-Code
23741 \begin_layout Standard
23742 The problem is that whatever is written in between the << and the
23746 must be taken literally, i.
23747 \begin_inset space \thinspace{}
23751 \begin_inset space \space{}
23755 should be prevented from making any special interpretation of what has
23757 This is also handled by
23758 \begin_inset Flex Noun
23761 \begin_layout Plain Layout
23767 , that works like a normal paragraph but has a free spacing capability.
23770 \begin_layout Standard
23771 As a special note, you can also use the
23772 \begin_inset Quotes eld
23776 \begin_inset Quotes erd
23779 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23783 \begin_layout LyX-Code
23787 \begin_layout LyX-Code
23788 def some_function(args):
23791 \begin_layout LyX-Code
23792 "This is the doc string for this function."
23795 \begin_layout LyX-Code
23796 print "My args: ", args
23799 \begin_layout LyX-Code
23800 @ %def some_function
23803 \begin_layout Standard
23804 For an example of this usage and the resulting cross-reference output, look
23805 at the Literate python program in
23807 LIBDIR/examples/listerrors.lyx
23809 which should make this all clear.
23812 \begin_layout Paragraph
23813 Generating the documentation
23816 \begin_layout Standard
23817 At this point you already have a new document file with a proper document
23818 class, and with some code and text on it.
23819 How do I print it? The answer is simple, you select
23821 View\SpecialChar menuseparator
23825 Just like you would do for a plain document.
23826 No special procedure is required.
23829 \begin_layout Standard
23830 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23834 \begin_layout Enumerate
23837 Update\SpecialChar menuseparator
23840 menu option is chosen, a \SpecialChar LaTeX
23846 \begin_layout Standard
23847 If the document is of any literate class the generated file will be named
23848 with an extension name defined by the
23849 \begin_inset Quotes eld
23853 \begin_inset Quotes erd
23856 format (defined in the Preferences panel), otherwise the file will have
23865 \begin_layout Enumerate
23866 Note that the only difference so far is in the name of the file, no special
23867 processing is required by \SpecialChar LyX
23869 Given that you formatted the code using the
23870 \begin_inset Flex Noun
23873 \begin_layout Plain Layout
23879 layout that, by itself, takes care of the business.
23882 \begin_layout Enumerate
23883 If the document is of any literate class \SpecialChar LyX
23884 will then use the internal \SpecialChar LyX
23886 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23891 \begin_layout Plain Layout
23892 The converters are defined in the
23894 Tools\SpecialChar menuseparator
23898 \begin_inset Quotes eld
23902 \begin_inset Quotes erd
23914 manual for general information about converters.
23919 to generate the \SpecialChar LaTeX
23924 \begin_layout Standard
23925 Otherwise it will just skip this step.
23929 \begin_layout Enumerate
23930 Finally, \SpecialChar LaTeX
23931 is invoked and the regular post processing continues as in a plain
23935 \begin_layout Standard
23936 Independence from a particular
23937 \begin_inset Quotes eld
23941 \begin_inset Quotes erd
23944 is easily achieved by changing the commands that are run by the various
23948 \begin_layout Paragraph
23949 Generating the code
23952 \begin_layout Standard
23953 When the build menu option is chosen or the corresponding button in the
23954 toolbar is pressed, a \SpecialChar LaTeX
23955 file is generated just like step 1 above.
23956 Next, \SpecialChar LyX
23962 This converter needs to be defined by the user and is not installed by
23963 default, though the Program format is.
23964 This converter (like any other converter) will have two parts:
23967 \begin_layout Enumerate
23968 The converter program itself.
23969 This program performs the conversion from the one format to the other (in
23970 this case, from the Noweb format to the Program pseudo-format).
23973 \begin_layout Enumerate
23974 The error log parser.
23975 This is a program whose sole purpose is to rewrite error messages in a
23976 format that \SpecialChar LyX
23978 This makes it possible for \SpecialChar LyX
23979 to place error boxes in the right places in
23983 \begin_layout Standard
23984 The first part, the
23985 \begin_inset Quotes eld
23989 \begin_inset Quotes erd
23992 setting, should be set to
23993 \begin_inset Newline newline
23997 \begin_inset Quotes eld
24005 \begin_inset Quotes erd
24009 \begin_inset Newline newline
24012 This basically means that \SpecialChar LyX
24014 \begin_inset Quotes eld
24018 \begin_inset Quotes erd
24021 (a program or script) with the name of the Noweb file (normally a file
24022 in the \SpecialChar LyX
24023 temp directory) and the directory path of the original \SpecialChar LyX
24028 \begin_layout Standard
24029 This is an implementation of
24030 \begin_inset Quotes eld
24034 \begin_inset Quotes erd
24037 that you can place in a directory on your path:
24040 \begin_layout Standard
24041 \begin_inset VSpace defskip
24047 \begin_layout Standard
24048 \begin_inset Newpage pagebreak
24054 \begin_layout Standard
24060 \begin_layout Standard
24066 \begin_layout Standard
24069 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
24072 \begin_layout Standard
24073 \begin_inset VSpace defskip
24079 \begin_layout Standard
24080 The next part of the converter setting is the
24081 \begin_inset Quotes eld
24085 \begin_inset Quotes erd
24088 which is to be set to
24089 \begin_inset Newline newline
24093 \begin_inset Quotes eld
24098 parselog=$$s/scripts/listerrors
24101 \begin_inset Quotes erd
24105 \begin_inset Newline newline
24108 This will run any errors that are generated by the
24109 \begin_inset Quotes eld
24113 \begin_inset Quotes erd
24116 process through the
24117 \begin_inset Quotes eld
24121 \begin_inset Quotes erd
24127 \begin_layout Standard
24128 The build will normally take place in \SpecialChar LyX
24129 's temporary directory, so the files
24130 produced by the conversion will be in that directory.
24132 will copy out what it regards as the `main' file, but the
24136 conversion may produce several files, and so most of these would then be
24137 deleted when \SpecialChar LyX
24139 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
24140 the build-script chunk can place the generated files in that location.
24143 \begin_layout Paragraph
24144 Build instructions in the document
24147 \begin_layout Standard
24148 The last piece of the integration between \SpecialChar LyX
24150 \begin_inset Quotes eld
24154 \begin_inset Quotes erd
24158 Generally, the instructions for building your program should be embedded
24159 in a chunk of its own.
24161 \begin_inset Quotes eld
24165 \begin_inset Quotes erd
24168 above uses the notangle command to look for this chunk (called
24169 \begin_inset Quotes eld
24173 \begin_inset Quotes erd
24176 ) and runs its contents through
24177 \begin_inset Quotes eld
24181 \begin_inset Quotes erd
24187 \begin_layout Standard
24188 Typically, such a chunk would look something like this:
24191 \begin_layout LyX-Code
24195 \begin_layout LyX-Code
24197 \begin_inset Newline newline
24200 if [ -z "${NOWEB_SOURCE}" ]
24201 \begin_inset Newline newline
24207 \begin_layout LyX-Code
24208 NOWEB_SOURCE=myfile.nw
24209 \begin_inset Newline newline
24213 \begin_inset Newline newline
24217 code to extract files ...
24218 use NOWEB_OUTPUT_DIR here ...]
24219 \begin_inset Newline newline
24223 code to compile files ...]
24224 \begin_inset Newline newline
24230 \begin_layout Standard
24233 LIBDIR/examples/listerrors.lyx
24237 LIBDIR/examples/Literate.lyx
24239 which implement two versions of the
24240 \begin_inset Quotes eld
24244 \begin_inset Quotes erd
24247 program for some illustrations of how all of these pieces go together or
24250 LIBDIR/examples/noweb2lyx.lyx.
24253 Interestingly, these three files show off the language-indepence of the
24255 literate programming support since they are written in Python, C and Perl
24259 \begin_layout Subsubsection
24260 Configuring \SpecialChar LyX
24264 \begin_layout Standard
24265 All the Literate Programming support is configured by the
24267 Tools\SpecialChar menuseparator
24271 \begin_inset Quotes eld
24275 \begin_inset Quotes erd
24279 The important parts are:
24282 \begin_layout Description
24284 \begin_inset space ~
24288 \begin_inset Quotes eld
24292 \begin_inset Quotes erd
24296 \begin_inset space ~
24299 format Set up via the File Formats tab, this is where the Noweb-specific
24309 , the file extension is set to
24314 This tells \SpecialChar LyX
24315 to create a file with a
24319 extension in the first step of the conversion process.
24322 \begin_layout Description
24324 \begin_inset space ~
24332 \begin_inset space ~
24335 format This is an empty format whose sole purpose is to be the endpoint
24336 of a conversion (which then allows us to set up a converter for it).
24339 \begin_layout Description
24349 This converter performs the
24350 \begin_inset Quotes eld
24354 \begin_inset Quotes erd
24357 of the literate document.
24358 For Noweb, it is set to
24359 \begin_inset Quotes eld
24364 noweave -delay -index $$i > $$o
24367 \begin_inset Quotes erd
24373 \begin_layout Description
24383 \begin_inset Quotes eld
24387 \begin_inset Quotes erd
24391 As stated above, the Converter is set to
24392 \begin_inset Quotes eld
24400 \begin_inset Quotes erd
24403 , with Flags set to
24404 \begin_inset Newline newline
24408 \begin_inset Quotes eld
24413 parselog=$$s/scripts/listerrors
24416 \begin_inset Quotes erd
24422 \begin_layout Subsubsection
24426 \begin_layout Standard
24427 There is also a new function implemented in the \SpecialChar LyX
24429 \begin_inset Quotes eld
24432 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24436 \begin_layout Standard
24437 When debugging code with ddd/gdb, it is possible to invoke a text editor
24438 at the current execution position with a single key stroke.
24439 The default ddd configuration for that is shift-ctrl-V.
24440 It happens that you can define the editor command line invocation in ddd
24443 Edit\SpecialChar menuseparator
24444 Preferences\SpecialChar menuseparator
24447 dialog and changing the "Edit Sources" entry.
24450 \begin_layout Standard
24451 I take advantage of the newly created \SpecialChar LyX
24452 server function and this ddd feature,
24454 \begin_inset Quotes eld
24458 \begin_inset Quotes erd
24464 \begin_layout Standard
24465 \begin_inset VSpace defskip
24471 \begin_layout Standard
24474 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24477 \begin_layout Standard
24478 \begin_inset VSpace defskip
24484 \begin_layout Standard
24485 With this, whenever you are using ddd and find a point in the program that
24486 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24487 ddd will forward this information to \SpecialChar LyX
24488 through the \SpecialChar LyX
24489 server and then the
24491 window will show the same file with the cursor at the same position ddd
24493 No more guessing or long scrolling to locate a point in the program back
24497 \begin_layout Standard
24498 Note however that you must enable the \SpecialChar LyX
24499 server to get this feature working
24500 (it is disabled by default).
24501 You can enable it in
24513 ) by entering in the
24519 \begin_inset Quotes eld
24524 /home/<your-home-directory>/.lyx/lyxpipe
24527 \begin_inset Quotes erd
24533 \begin_layout Standard
24534 Read the \SpecialChar LyX
24535 server documentation in the
24537 Customization Manual
24539 for further information.
24542 \begin_layout Subsubsection
24546 \begin_layout Standard
24547 There are six new buttons that can be added to your \SpecialChar LyX
24549 Five of these buttons are short cuts to layout styles:
24572 The last one is a short cut to the
24573 \begin_inset Quotes eld
24577 \begin_inset Quotes erd
24584 \begin_layout Standard
24586 has a range of buttons that are available for tool bar customization.
24587 In my toolbar I like to combine the six short cuts above with two more:
24592 \SpecialChar menuseparator
24597 \SpecialChar menuseparator
24604 Document\SpecialChar menuseparator
24605 View\SpecialChar menuseparator
24609 Here is how it looks like:
24612 \begin_layout LyX-Code
24616 \begin_layout LyX-Code
24620 \begin_layout LyX-Code
24621 Icon "layout Standard"
24624 \begin_layout LyX-Code
24625 Icon "layout Section"
24628 \begin_layout LyX-Code
24629 Icon "layout \SpecialChar LaTeX
24633 \begin_layout LyX-Code
24634 Icon "layout \SpecialChar LyX
24638 \begin_layout LyX-Code
24639 Icon "layout Chunk"
24642 \begin_layout LyX-Code
24646 \begin_layout LyX-Code
24650 \begin_layout LyX-Code
24651 Icon "buffer-typeset"
24654 \begin_layout LyX-Code
24655 Icon "build-program"
24658 \begin_layout LyX-Code
24662 \begin_layout LyX-Code
24666 \begin_layout LyX-Code
24670 \begin_layout LyX-Code
24674 \begin_layout LyX-Code
24678 \begin_layout Subsubsection
24679 Colors customization
24682 \begin_layout Standard
24683 There are a number of colors in \SpecialChar LyX
24684 that can be customized in
24689 One of the things that bothers people is the \SpecialChar LaTeX
24691 The default color is red, since the chunks uses \SpecialChar LaTeX
24692 font, and there is a lot
24693 of chunks in literate documents, you may get tired of seeing everything
24695 You can change it by going to the tabs
24704 \begin_layout Standard
24705 The next thing is the visible presence of the newline character in the screen.
24706 You can choose the color of this particular character and make it blend
24708 I recommend you choosing a color that is close to the background but not
24709 equal, that way you still can see it is there, but it is not bothering
24713 \begin_layout Subsection
24718 \begin_layout Standard
24727 is documented in the
24731 example file and in the Sweave manual (menu
24733 Help\SpecialChar menuseparator
24739 \begin_layout Chapter
24743 \begin_layout Standard
24744 You can do everything with \SpecialChar LyX
24745 that you can do with \SpecialChar LaTeX
24747 However, \SpecialChar LyX
24748 cannot support every \SpecialChar LaTeX
24750 But you can always use \SpecialChar TeX
24752 This chapter shows you some more special things you might want to use.
24753 For other special things you can do with figures, tables, floats, boxes
24754 and notes, have a look at the
24757 \begin_inset space ~
24765 \begin_layout Section
24766 Multiple Text Columns
24769 \begin_layout Standard
24770 This feature is independent of the option
24772 Two-column document
24774 in the document settings under
24779 If you want to have 2
24780 \begin_inset space ~
24783 columns for the whole document, it is recommended to use the
24785 Two-column document
24788 For all other cases use this feature.
24791 \begin_layout Standard
24792 To use multiple text columns in your document, you have to load the module
24799 Document\SpecialChar menuseparator
24800 Settings\SpecialChar menuseparator
24803 ) and must have the \SpecialChar LaTeX
24811 \begin_layout Standard
24812 Footnotes within multiple columns will be placed at the bottom of the page
24813 and not under each column.
24814 Within the different columns you can use everything, with the limitation
24815 that for floats you need to use the float option
24822 \begin_layout Subsection
24826 \begin_layout Standard
24827 If you want to have 2
24828 \begin_inset space ~
24831 columns in your text, insert a multicolumn inset via the menu
24833 Insert\SpecialChar menuseparator
24835 \begin_inset space ~
24838 Insets\SpecialChar menuseparator
24840 \begin_inset space ~
24845 where the columns should start.
24846 Write all text that should be printed in 2
24847 \begin_inset space ~
24850 columns into this inset.
24853 \begin_layout Standard
24854 Here is an example:
24857 \begin_layout Standard
24859 \begin_inset Flex Multiple Columns
24862 \begin_layout Plain Layout
24867 The Adventure of the Empty House
24870 \begin_inset Newline newline
24873 by Sir Arthur Conan Doyle
24876 \begin_layout Plain Layout
24879 It was in the spring of the year 1894 that all London was interested, and
24880 the fashionable world dismayed, by the murder of the Honourable Ronald
24881 Adair under most unusual and inexplicable circumstances.
24882 The public has already learned those particulars of the crime which came
24883 out in the police investigation, but a good deal was suppressed upon that
24884 occasion, since the case for the prosecution was so overwhelmingly strong
24885 that it was not necessary to bring forward all the facts.
24886 Only now, at the end of nearly ten years, am I allowed to supply those
24887 missing links which make up the whole of that remarkable chain.
24888 The crime was of interest in itself, but that interest was as nothing to
24889 me compared to the inconceivable sequel, which afforded me the greatest
24890 shock and surprise of any event in my adventurous life.
24891 Even now, after this long interval, I find myself thrilling as I think
24892 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24893 ty which utterly submerged my mind.
24894 Let me say to that public, which has shown some interest in those glimpses
24895 which I have occasionally given them of the thoughts and actions of a very
24896 remarkable man, that they are not to blame me if I have not shared my knowledge
24897 with them, for I should have considered it my first duty to do so, had
24898 I not been barred by a positive prohibition from his own lips, which was
24899 only withdrawn upon the third of last month.
24907 \begin_layout Standard
24908 To get 3 or more columns, set the cursor into the multicolumn inset and
24911 Insert\SpecialChar menuseparator
24913 \begin_inset space ~
24917 \begin_inset space ~
24923 The number of the desired columns is written into that inset (for 3
24924 \begin_inset space ~
24928 \begin_inset Quotes eld
24932 \begin_inset Quotes erd
24936 \begin_inset Newline newline
24939 Here is an example with 3
24940 \begin_inset space ~
24946 \begin_layout Standard
24947 \begin_inset Flex Multiple Columns
24950 \begin_layout Plain Layout
24953 \begin_inset Argument 1
24956 \begin_layout Plain Layout
24962 It can be imagined that my close intimacy with Sherlock Holmes had interested
24963 me deeply in crime, and that after his disappearance I never failed to
24964 read with care the various problems which came before the public.
24965 And I even attempted, more than once, for my own private satisfaction,
24966 to employ his methods in their solution, though with indifferent success.
24967 There was none, however, which appealed to me like this tragedy of Ronald
24969 As I read the evidence at the inquest, which led up to a verdict of willful
24970 murder against some person or persons unknown, I realized more clearly
24971 than I had ever done the loss which the community had sustained by the
24972 death of Sherlock Holmes.
24973 There were points about this strange business which would, I was sure,
24974 have specially appealed to him, and the efforts of the police would have
24975 been supplemented, or more probably anticipated, by the trained observation
24976 and the alert mind of the first criminal agent in Europe.
24977 All day, as I drove upon my round, I turned over the case in my mind and
24978 found no explanation which appeared to me to be adequate.
24979 At the risk of telling a twice-told tale, I will recapitulate the facts
24980 as they were known to the public at the conclusion of the inquest.
24988 \begin_layout Standard
24989 You can have up to 10
24990 \begin_inset space ~
24993 columns if you want to, but that might not be very pleasant for the readers
24997 \begin_layout Standard
24998 \begin_inset Newpage newpage
25004 \begin_layout Subsection
25005 Columns inside Columns
25008 \begin_layout Standard
25009 You can also have columns inside columns:
25012 \begin_layout Standard
25013 \begin_inset Flex Multiple Columns
25016 \begin_layout Plain Layout
25019 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
25020 at that time governor of one of the Australian colonies.
25021 Adair's mother had returned from Australia to undergo the operation for
25022 cataract, and she, her son Ronald, and her daughter Hilda were living together
25026 \begin_layout Plain Layout
25027 \begin_inset Flex Multiple Columns
25030 \begin_layout Plain Layout
25033 The youth moved in the best society–had, so far as was known, no enemies
25034 and no particular vices.
25035 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
25036 had been broken off by mutual consent some months before, and there was
25037 no sign that it had left any very profound feeling behind it.
25038 For the rest {sic} the man's life moved in a narrow and conventional circle,
25039 for his habits were quiet and his nature unemotional.
25040 Yet it was upon this easy-going young aristocrat that death came, in most
25041 strange and unexpected form, between the hours of ten and eleven-twenty
25042 on the night of March 30, 1894.
25050 \begin_layout Plain Layout
25053 Ronald Adair was fond of cards–playing continually, but never for such stakes
25055 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
25056 It was shown that, after dinner on the day of his death, he had played
25057 a rubber of whist at the latter club.
25058 He had also played there in the afternoon.
25063 The evidence of those who had played with him– Mr.
25064 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
25065 and that there was a fairly equal fall of the cards.
25066 Adair might have lost five pounds, but not more.
25067 His fortune was a considerable one, and such a loss could not in any way
25069 He had played nearly every day at one club or other, but he was a cautious
25070 player, and usually rose a winner.
25071 It came out in evidence that, in partnership with Colonel Moran, he had
25072 actually won as much as four hundred and twenty pounds in a sitting, some
25073 weeks before, from Godfrey Milner and Lord Balmoral.
25074 So much for his recent history as it came out at the inquest.
25082 \begin_layout Subsection
25086 \begin_layout Standard
25087 The examples in this section show some more special features of multiple
25091 \begin_layout Standard
25092 For more features of multiple columns, have a look at the documentation
25093 of the \SpecialChar LaTeX
25099 \begin_inset CommandInset citation
25109 \begin_layout Subsubsection
25113 \begin_layout Standard
25114 To add a preface text for multiple columns, set the cursor into the multicolumn
25115 inset and use the menu
25117 Insert\SpecialChar menuseparator
25121 Write your preface text into that inset.
25122 \begin_inset Newline newline
25125 This is an example with some preface text:
25128 \begin_layout Standard
25129 \begin_inset VSpace bigskip
25135 \begin_layout Standard
25136 \begin_inset Flex Multiple Columns
25139 \begin_layout Plain Layout
25140 \begin_inset Argument 2
25143 \begin_layout Plain Layout
25144 And the story continues and continues and continues and continues\SpecialChar ldots
25152 On the evening of the crime, he returned from the club exactly at ten.
25153 His mother and sister were out spending the evening with a relation.
25154 The servant deposed that she heard him enter the front room on the second
25155 floor, generally used as his sitting-room.
25156 She had lit a fire there, and as it smoked she had opened the window.
25157 No sound was heard from the room until eleven-twenty, the hour of the return
25158 of Lady Maynooth and her daughter.
25159 Desiring to say good-night, she attempted to enter her son's room.
25160 The door was locked on the inside, and no answer could be got to their
25161 cries and knocking.
25162 Help was obtained, and the door forced.
25163 The unfortunate young man was found lying near the table.
25164 His head had been horribly mutilated by an expanding revolver bullet, but
25165 no weapon of any sort was to be found in the room.
25173 \begin_layout Standard
25174 You can also use a section heading as the preface if you use a section command
25175 as \SpecialChar TeX
25177 For example the command
25180 \begin_layout Standard
25185 subsection{subsection title}
25188 \begin_layout Standard
25189 creates a subsection.
25190 In this example the preface is a subsubsection:
25193 \begin_layout Standard
25194 \begin_inset Flex Multiple Columns
25197 \begin_layout Plain Layout
25198 \begin_inset Argument 2
25201 \begin_layout Plain Layout
25205 \begin_layout Plain Layout
25214 This is a subsubsection heading as a preface
25218 \begin_layout Plain Layout
25232 A minute examination of the circumstances served only to make the case more
25234 In the first place, no reason could be given why the young man should have
25235 fastened the door upon the inside.
25236 There was the possibility that the murderer had done this, and had afterwards
25237 escaped by the window.
25238 The drop was at least twenty feet, however, and a bed of crocuses in full
25240 Neither the flowers nor the earth showed any sign of having been disturbed,
25241 nor were there any marks upon the narrow strip of grass which separated
25242 the house from the road.
25243 Apparently, therefore, it was the young man himself who had fastened the
25245 But how did he come by his death? No one could have climbed up to the window
25246 without leaving traces.
25247 Suppose a man had fired through the window, he would indeed be a remarkable
25248 shot who could with a revolver inflict so deadly a wound.
25249 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25250 a hundred yards of the house.
25251 No one had heard a shot.
25259 \begin_layout Standard
25260 If there is less vertical space than 6
25261 \begin_inset space ~
25264 text lines is left on the page at the beginning of the multiple columns,
25265 a page break will be inserted before the multiple columns.
25266 Depending on the number of lines of the preface text, you might want to
25268 This is done by setting the cursor into the mulitcolumn inset behind the
25269 preface (if there is any) and using the menu
25271 Insert\SpecialChar menuseparator
25273 \begin_inset space ~
25277 \begin_inset space ~
25281 \begin_inset space ~
25287 Insert into that inset the amount of space like e.
25288 \begin_inset space \thinspace{}
25292 \begin_inset space \space{}
25296 \begin_inset Quotes eld
25300 \begin_inset Quotes erd
25304 \begin_inset Newline newline
25307 In this example the space is set to 7
25308 \begin_inset space ~
25311 text lines by using
25312 \begin_inset Quotes eld
25318 \begin_inset Quotes erd
25327 needs to be inserted as \SpecialChar TeX
25331 \begin_layout Standard
25332 \begin_inset Flex Multiple Columns
25335 \begin_layout Plain Layout
25336 \begin_inset Argument 3
25339 \begin_layout Plain Layout
25344 \begin_layout Plain Layout
25360 On the evening of the crime, he returned from the club exactly at ten.
25361 His mother and sister were out spending the evening with a relation.
25362 The servant deposed that she heard him enter the front room on the second
25363 floor, generally used as his sitting-room.
25364 She had lit a fire there, and as it smoked she had opened the window.
25365 No sound was heard from the room until eleven-twenty, the hour of the return
25366 of Lady Maynooth and her daughter.
25367 Desiring to say good-night, she attempted to enter her son's room.
25368 The door was locked on the inside, and no answer could be got to their
25369 cries and knocking.
25370 Help was obtained, and the door forced.
25371 The unfortunate young man was found lying near the table.
25372 His head had been horribly mutilated by an expanding revolver bullet, but
25373 no weapon of any sort was to be found in the room.
25381 \begin_layout Subsubsection
25385 \begin_layout Standard
25386 The amount of space before and after multiple columns can be changed by
25387 changing the length
25394 For example the command
25397 \begin_layout Standard
25407 \begin_layout Standard
25408 in \SpecialChar TeX
25409 Code changes its value to 3
25410 \begin_inset space \thinspace{}
25414 The change must be made before the multiple columns' start.
25415 The predefined value is 13
25416 \begin_inset space \thinspace{}
25422 \begin_layout Standard
25430 \begin_inset space \thinspace{}
25436 \begin_layout Standard
25440 \begin_layout Plain Layout
25446 multicolsep}{2.5cm}
25454 \begin_layout Standard
25455 \begin_inset Flex Multiple Columns
25458 \begin_layout Plain Layout
25461 All day I turned these facts over in my mind, endeavouring to hit upon some
25462 theory which could reconcile them all, and to find that line of least resistanc
25463 e which my poor friend had declared to be the starting-point of every investigat
25465 I confess that I made little progress.
25466 In the evening I strolled across the Park, and found myself about six o'clock
25467 at the Oxford Street end of Park Lane.
25468 A group of loafers upon the pavements, all staring up at a particular window,
25469 directed me to the house which I had come to see.
25470 A tall, thin man with coloured glasses, whom I strongly suspected of being
25471 a plain-clothes detective, was pointing out some theory of his own, while
25472 the others crowded round to listen to what he said.
25473 I got as near him as I could, but his observations seemed to me to be absurd,
25474 so I withdrew again in some disgust.
25475 As I did so I struck against an elderly, deformed man, who had been behind
25476 me, and I knocked down several books which he was carrying.
25484 \begin_layout Standard
25485 \begin_inset Note Greyedout
25488 \begin_layout Plain Layout
25493 The values you set with
25499 will be used for all following multiple columns until you change them again.
25507 \begin_layout Standard
25511 \begin_layout Plain Layout
25523 \begin_inset Note Note
25526 \begin_layout Plain Layout
25527 go back to the default
25535 \begin_layout Standard
25536 \begin_inset Newpage newpage
25542 \begin_layout Subsubsection
25546 \begin_layout Standard
25547 A column break can be forced by inserting the command
25553 as \SpecialChar TeX
25554 Code to that position in the text where the column should be broken.
25555 Note that this leads in most cases to whitespace in the text.
25556 \begin_inset Newline newline
25559 Here is an example:
25562 \begin_layout Standard
25563 \begin_inset Flex Multiple Columns
25566 \begin_layout Plain Layout
25569 \begin_inset Quotes eld
25572 You're surprised to see me, sir,
25573 \begin_inset Quotes erd
25576 said he, in a strange, croaking voice.
25579 \begin_layout Plain Layout
25582 I acknowledged that I was.
25585 \begin_layout Plain Layout
25588 \begin_inset Quotes eld
25591 Well, I've a conscience, sir, and when I chanced to see you go into this
25592 house, as I came hobbling after you, I thought to myself, I'll just step
25593 in and see that kind gentleman, and tell him that if I was a bit gruff
25594 in my manner there was not any harm meant, and that I am much obliged to
25595 him for picking up my books.
25596 \begin_inset Quotes erd
25602 \begin_layout Plain Layout
25605 \begin_inset Quotes eld
25608 You make too much of a trifle,
25609 \begin_inset Quotes erd
25614 \begin_inset Quotes eld
25617 May I ask how you knew who I was?
25618 \begin_inset Quotes erd
25621 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25625 \begin_layout Plain Layout
25637 \begin_layout Plain Layout
25640 \begin_inset Quotes eld
25643 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25644 you'll find my little bookshop at the corner of Church Street, and very
25645 happy to see you, I am sure.
25646 Maybe you collect yourself, sir.
25650 \begin_inset space ~
25663 –a bargain, every one of them.
25664 With five volumes you could just fill that gap on that second shelf.
25665 It looks untidy, does it not, sir?
25666 \begin_inset Quotes erd
25677 \begin_layout Subsubsection
25681 \begin_layout Standard
25682 The width of the columns is automatically calculated, but you can modify
25683 the space between the columns.
25684 This is done by changing the length
25691 Its predefined value is 10
25692 \begin_inset space \thinspace{}
25696 Here is an example where
25703 \begin_inset space \thinspace{}
25709 \begin_layout Standard
25713 \begin_layout Plain Layout
25727 \begin_layout Standard
25728 \begin_inset Flex Multiple Columns
25731 \begin_layout Plain Layout
25734 My observations of No.
25735 \begin_inset space \space{}
25738 427 Park Lane did little to clear up the problem in which I was interested.
25739 The house was separated from the street by a low wall and railing, the
25740 whole not more than five feet high.
25741 It was perfectly easy, therefore, for anyone to get into the garden, but
25742 the window was entirely inaccessible, since there was no water pipe or
25743 anything which could help the most active man to climb it.
25744 More puzzled than ever, I retraced my steps to Kensington.
25745 I had not been in my study five minutes when the maid entered to say that
25746 a person desired to see me.
25747 To my astonishment it was none other than my strange old book collector,
25748 his sharp, wizened face peering out from a frame of white hair, and his
25749 precious volumes, a dozen of them at least, wedged under his right arm.
25757 \begin_layout Standard
25761 \begin_layout Plain Layout
25773 \begin_inset Note Note
25776 \begin_layout Plain Layout
25777 go back to the default
25785 \begin_layout Subsubsection
25789 \begin_layout Standard
25790 Between the columns a rule with a width of the length
25797 If this rule width is set to 0
25798 \begin_inset space \thinspace{}
25801 pt (this is the default), the rule is suppressed.
25802 In the following example the rule is 2
25803 \begin_inset space \thinspace{}
25809 \begin_layout Standard
25813 \begin_layout Plain Layout
25819 columnseprule}{2pt}
25827 \begin_layout Standard
25828 \begin_inset Flex Multiple Columns
25831 \begin_layout Plain Layout
25834 \begin_inset Quotes eld
25837 You're surprised to see me, sir,
25838 \begin_inset Quotes erd
25841 said he, in a strange, croaking voice.
25844 \begin_layout Plain Layout
25847 I acknowledged that I was.
25850 \begin_layout Plain Layout
25853 \begin_inset Quotes eld
25856 Well, I've a conscience, sir, and when I chanced to see you go into this
25857 house, as I came hobbling after you, I thought to myself, I'll just step
25858 in and see that kind gentleman, and tell him that if I was a bit gruff
25859 in my manner there was not any harm meant, and that I am much obliged to
25860 him for picking up my books.
25861 \begin_inset Quotes erd
25867 \begin_layout Plain Layout
25870 \begin_inset Quotes eld
25873 You make too much of a trifle,
25874 \begin_inset Quotes erd
25879 \begin_inset Quotes eld
25882 May I ask how you knew who I was?
25883 \begin_inset Quotes erd
25889 \begin_layout Plain Layout
25892 \begin_inset Quotes eld
25895 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25896 you'll find my little bookshop at the corner of Church Street, and very
25897 happy to see you, I am sure.
25898 Maybe you collect yourself, sir.
25902 \begin_inset space ~
25915 –a bargain, every one of them.
25916 With five volumes you could just fill that gap on that second shelf.
25917 It looks untidy, does it not, sir?
25918 \begin_inset Quotes erd
25929 \begin_layout Standard
25930 \begin_inset VSpace defskip
25936 \begin_layout Standard
25937 The rule can be colored by redefining the command
25944 This is done by inserting the command
25945 \begin_inset Newline newline
25954 columnseprulecolor}{
25959 \begin_inset Newline newline
25962 as \SpecialChar TeX
25963 Code before the multicolumn inset.
25968 in this command by a color of your choice.
25969 You can use all pre- and self-defined colors.
25977 \begin_inset space ~
25982 for more information about pre- and self-defined colors.
25983 To go back to the default color insert the command
25984 \begin_inset Newline newline
25993 columnseprulecolor}{
25998 \begin_inset Newline newline
26001 Here is the example with a cyan rule and 1
26002 \begin_inset space \thinspace{}
26005 cm column separation:
26008 \begin_layout Standard
26012 \begin_layout Plain Layout
26021 \begin_layout Plain Layout
26027 columnseprulecolor}{
26037 \begin_layout Standard
26038 \begin_inset Flex Multiple Columns
26041 \begin_layout Plain Layout
26044 \begin_inset Quotes eld
26047 You're surprised to see me, sir,
26048 \begin_inset Quotes erd
26051 said he, in a strange, croaking voice.
26054 \begin_layout Plain Layout
26057 I acknowledged that I was.
26060 \begin_layout Plain Layout
26063 \begin_inset Quotes eld
26066 Well, I've a conscience, sir, and when I chanced to see you go into this
26067 house, as I came hobbling after you, I thought to myself, I'll just step
26068 in and see that kind gentleman, and tell him that if I was a bit gruff
26069 in my manner there was not any harm meant, and that I am much obliged to
26070 him for picking up my books.
26071 \begin_inset Quotes erd
26077 \begin_layout Plain Layout
26080 \begin_inset Quotes eld
26083 You make too much of a trifle,
26084 \begin_inset Quotes erd
26089 \begin_inset Quotes eld
26092 May I ask how you knew who I was?
26093 \begin_inset Quotes erd
26099 \begin_layout Plain Layout
26102 \begin_inset Quotes eld
26105 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26106 you'll find my little bookshop at the corner of Church Street, and very
26107 happy to see you, I am sure.
26108 Maybe you collect yourself, sir.
26112 \begin_inset space ~
26125 –a bargain, every one of them.
26126 With five volumes you could just fill that gap on that second shelf.
26127 It looks untidy, does it not, sir?
26128 \begin_inset Quotes erd
26139 \begin_layout Standard
26143 \begin_layout Plain Layout
26149 columnseprule}{0pt}
26152 \begin_layout Plain Layout
26158 columnseprulecolor}{
26166 \begin_inset Note Note
26169 \begin_layout Plain Layout
26170 go back to the default
26178 \begin_layout Section
26179 Non-standard Paragraph Shapes
26182 \begin_layout Standard
26185 as well as any other text processor uses by default rectangular paragraphs.
26186 For special cases like for example posters, invitation cards or poems you
26187 can modify the paragraph shape to one of your choice.
26188 This can be done by using the \SpecialChar LaTeX
26193 which is loaded by using in the document settings the module
26195 Custom paragraph shapes
26200 \begin_layout Subsection
26204 \begin_layout Standard
26209 provides the following shapes:
26212 \begin_layout Standard
26213 \begin_inset Tabular
26214 <lyxtabular version="3" rows="13" columns="3">
26215 <features booktabs="true" islongtable="true" longtabularalignment="center">
26216 <column alignment="center" valignment="middle" width="16col%">
26217 <column alignment="center" valignment="middle" width="40col%">
26218 <column alignment="center" valignment="middle" width="35col%">
26219 <row endhead="true">
26220 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26223 \begin_layout Plain Layout
26229 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26232 \begin_layout Plain Layout
26238 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26241 \begin_layout Plain Layout
26249 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26252 \begin_layout Plain Layout
26258 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26261 \begin_layout Plain Layout
26262 Circle with circular hole (in the size of a CD/DVD)
26267 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26270 \begin_layout Plain Layout
26271 Cannot be scaled, take care there is not too much text
26278 <cell alignment="center" valignment="top" topline="true" usebox="none">
26281 \begin_layout Plain Layout
26287 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26290 \begin_layout Plain Layout
26296 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26299 \begin_layout Plain Layout
26300 Fragile, calculation might fail
26307 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26310 \begin_layout Plain Layout
26316 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26319 \begin_layout Plain Layout
26320 Rhomboid (symbolizing a
26321 \begin_inset Quotes eld
26325 \begin_inset Quotes erd
26333 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26336 \begin_layout Plain Layout
26344 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26347 \begin_layout Plain Layout
26353 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26356 \begin_layout Plain Layout
26362 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26365 \begin_layout Plain Layout
26373 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26376 \begin_layout Plain Layout
26382 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26385 \begin_layout Plain Layout
26391 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26394 \begin_layout Plain Layout
26402 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26405 \begin_layout Plain Layout
26411 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26414 \begin_layout Plain Layout
26415 Nut for bolt (hexagon with circular hole)
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" bottomline="true" leftline="true" usebox="none">
26463 \begin_layout Plain Layout
26469 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26472 \begin_layout Plain Layout
26478 <cell alignment="center" valignment="top" topline="true" bottomline="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
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
26531 Normal/reversed rain drop
26536 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26539 \begin_layout Plain Layout
26540 Fragile, calculation might fail
26547 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26550 \begin_layout Plain Layout
26557 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26560 \begin_layout Plain Layout
26561 The \SpecialChar TeX
26567 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26570 \begin_layout Plain Layout
26578 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26581 \begin_layout Plain Layout
26583 \begin_inset Newline newline
26591 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26594 \begin_layout Plain Layout
26595 Triangles in different orientations
26600 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26603 \begin_layout Plain Layout
26617 \begin_layout Standard
26618 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26620 for environments in the toolbar.
26623 \begin_layout Standard
26624 \begin_inset Newpage newpage
26630 \begin_layout Standard
26631 Here is an example paragraph in the shape of a nut:
26634 \begin_layout Standard
26635 \begin_inset VSpace bigskip
26644 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26645 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26647 At vero eos et accusam et justo duo dolores et ea rebum.
26648 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26650 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26651 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26655 \begin_layout Standard
26656 \begin_inset VSpace bigskip
26662 \begin_layout Standard
26663 \begin_inset Note Greyedout
26666 \begin_layout Plain Layout
26671 : shapepar paragraphs cannot run over a page break.
26679 \begin_layout Standard
26680 \begin_inset VSpace bigskip
26686 \begin_layout Standard
26691 takes care that the shape will always be preserved, no matter how much
26692 text is in the paragraph.
26693 Therefore the paragraph size changes with the amount of contained text.
26694 This can lead to paragraph sizes exceeding the page margins.
26695 To demonstrate the size scaling, here is the same example paragraph but
26696 with twice as much text:
26699 \begin_layout Standard
26700 \begin_inset Newpage newpage
26709 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26710 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26712 At vero eos et accusam et justo duo dolores et ea rebum.
26713 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26715 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26716 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26718 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26719 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26721 At vero eos et accusam et justo duo dolores et ea rebum.
26722 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26724 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26725 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26729 \begin_layout Standard
26730 \begin_inset VSpace bigskip
26736 \begin_layout Standard
26737 An exception is the shape
26742 It cannot be scaled because it must fit the size of a CD/DVD.
26743 Therefore the amount of text that fits into the shape is limited.
26744 \begin_inset Newline newline
26755 shape are fragile, meaning that the calculation of their size can fail,
26756 depending on the amount of text.
26757 You will then get the \SpecialChar LaTeX
26759 \begin_inset Quotes eld
26762 Arithmetic overflow
26763 \begin_inset Quotes erd
26767 In this case one can try to remove or add some text; if nothing works one
26768 has to use another shape.
26771 \begin_layout Standard
26772 \begin_inset VSpace bigskip
26778 \begin_layout Standard
26779 For shapes with tips you will maybe see that \SpecialChar LaTeX
26780 's hyphenation routine fails
26781 for text in the tips.
26782 Therefore it is often necessary to add hyphenation points
26787 arg "specialchar-insert hyphenation"
26792 ) to the corresponding text parts.
26795 \begin_layout Standard
26796 \begin_inset VSpace bigskip
26802 \begin_layout Standard
26803 Shapepar paragraphs are either always centered or placed on the page so
26804 that their left border touches the left page margin.
26805 You can therefore not use the paragraph dialog to align such paragraphs.
26806 A solution is to put the paragraph into a minipage or parbox and align
26808 The problem is hereby to find the right width for the box.
26809 Because if it is too wide and you center the box, the paragraph is not
26810 centered too because it sticks at the left side of the box.
26811 So you might have to play a bit with the width until it fits.
26812 Here are two heart-shaped paragraphs, the first one is not aligned, the
26813 second one is right-aligned:
26816 \begin_layout Standard
26817 \begin_inset Newpage newpage
26823 \begin_layout Heart
26827 Lo\SpecialChar softhyphen
26828 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26829 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26831 At vero eos et accusam et justo duo dolores et ea rebum.
26832 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26836 \begin_layout Standard
26837 \begin_inset VSpace bigskip
26843 \begin_layout Standard
26846 \begin_inset Box Frameless
26856 height_special "totalheight"
26861 backgroundcolor "none"
26864 \begin_layout Heart
26868 Lo\SpecialChar softhyphen
26869 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26870 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26872 At vero eos et accusam et justo duo dolores et ea rebum.
26873 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26882 \begin_layout Subsection
26886 \begin_layout Standard
26887 You can define any shape you want.
26888 Doing this manually is a lot of work because every coordinate must be specified.
26889 But there is a way to let the computer calculate the coordinates:
26892 \begin_layout Enumerate
26893 Install the program
26894 \begin_inset CommandInset href
26897 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26905 \begin_layout Enumerate
26912 TeX/LaTeX\SpecialChar menuseparator
26913 Settings\SpecialChar menuseparator
26916 and select the font size you are using in your document.
26917 For example this document uses the size 12
26918 \begin_inset space \thinspace{}
26924 \begin_layout Enumerate
26928 \begin_layout Enumerate
26931 TeX/LaTeX\SpecialChar menuseparator
26934 to export the shape to coordinates.
26935 In the appearing dialog use either the outline of your shape for the coordinate
26936 s or the path itself.
26940 \begin_layout Plain Layout
26941 For more information see
26942 \begin_inset CommandInset href
26944 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26957 \begin_layout Standard
26958 The coordinates are written into a \SpecialChar TeX
26960 To use it for your \SpecialChar LyX
26964 \begin_layout Enumerate
26965 Place the cursor before the first character of your paragraph (or into a
26969 \begin_layout Enumerate
26970 Open in \SpecialChar LyX
26973 Insert\SpecialChar menuseparator
26974 File\SpecialChar menuseparator
26976 \begin_inset space ~
26981 , select the file and use
26990 \begin_layout Standard
26991 \begin_inset VSpace defskip
26997 \begin_layout Standard
26998 \begin_inset Note Greyedout
27001 \begin_layout Plain Layout
27006 : The changed shape only applies to the current paragraph; everything is
27007 reset to normal for the next paragraph.
27008 Therefore the shape definition file must be input into every paragraph
27009 with the desired shape.
27017 \begin_layout Standard
27018 \begin_inset VSpace bigskip
27024 \begin_layout Standard
27025 Here is an example:
27028 \begin_layout Standard
27029 \begin_inset VSpace bigskip
27035 \begin_layout Standard
27036 \begin_inset CommandInset include
27038 filename "SpecialParagraphShape.tex"
27044 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27045 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27047 At vero eos et accusam et justo duo dolores et ea rebum.
27048 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27050 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27051 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27055 \begin_layout Standard
27056 \begin_inset VSpace bigskip
27062 \begin_layout Standard
27067 to draw complexer shapes in
27071 you can draw the shape in a program of your choice and import the resulting
27077 Then you only need to draw a line or spline along the outline of the image.
27080 \begin_layout Standard
27081 \begin_inset VSpace bigskip
27087 \begin_layout Standard
27090 Custom paragraph shapes
27092 also provides the two commands
27100 which can be used to define custom shapes coordinate by coordinate.
27104 \begin_layout Plain Layout
27105 These commands are internally used for all shapes described here.
27110 For information how these styles are used and about further customization
27111 possibilities, have a look at the documentation of the package
27116 \begin_inset CommandInset citation
27126 \begin_layout Bibliography
27127 \begin_inset CommandInset bibitem
27128 LatexCommand bibitem
27134 Documentation of the \SpecialChar LaTeX
27136 \begin_inset CommandInset href
27139 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
27147 \begin_layout Bibliography
27148 \begin_inset CommandInset bibitem
27149 LatexCommand bibitem
27155 Documentation of the \SpecialChar LaTeX
27157 \begin_inset CommandInset href
27160 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"