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 1486231742
3031 \change_deleted -712698321 1486231742
3033 \change_inserted -712698321 1486199445
3035 \change_deleted -712698321 1486199447
3039 \change_inserted -712698321 1486231758
3040 or child (sub-document)
3042 of the document, are
3043 \change_deleted -712698321 1486199458
3045 \change_inserted -712698321 1486200433
3049 \change_inserted -712698321 1486231617
3052 In order to enable it, go to
3053 \begin_inset Flex Noun
3056 \begin_layout Plain Layout
3058 \change_inserted -712698321 1486199572
3059 Document\SpecialChar menuseparator
3060 Settings\SpecialChar menuseparator
3068 and select the relevant unit (e.
3069 \begin_inset space \thinspace{}
3073 \begin_inset Quotes eld
3077 \begin_inset Quotes erd
3081 \begin_inset Flex Noun
3084 \begin_layout Plain Layout
3086 \change_inserted -712698321 1486199553
3087 Multiple Bibliographies
3096 \change_deleted -712698321 1486199771
3097 by Bib\SpecialChar TeX
3100 \change_inserted -712698321 1486200569
3101 Then add a Bib(la)\SpecialChar TeX
3102 bibliography to each unit (e.
3103 \begin_inset space \thinspace{}
3106 g., section) of your document.
3107 In the output, a separate bibliography, containing only the references
3108 done in the current unit is generated.
3111 \begin_layout Standard
3113 \change_inserted -712698321 1486199829
3114 If you use Bib\SpecialChar TeX
3116 \change_deleted -712698321 1486199835
3118 \change_inserted -712698321 1486231520
3122 \change_inserted -712698321 1486231576
3124 \begin_inset Flex Code
3127 \begin_layout Plain Layout
3129 \change_inserted -712698321 1486231576
3140 \begin_inset Flex Code
3143 \begin_layout Plain Layout
3150 \change_deleted -712698321 1486231584
3151 , which is used for the creation of sectioned bibliographies in \SpecialChar LyX
3156 \change_inserted -712698321 1486231676
3157 is used to create multiple bibliographies.
3158 The former package is used if you select
3159 \begin_inset Quotes eld
3163 \begin_inset Quotes erd
3171 \begin_inset Flex Noun
3174 \begin_layout Plain Layout
3176 \change_inserted -712698321 1486231676
3177 Sectioned Bibliography
3186 \begin_inset Flex Code
3189 \begin_layout Plain Layout
3191 \change_inserted -712698321 1486231655
3198 \change_deleted -712698321 1486200505
3199 provides an easy way to solve this task, if you are willing to use some
3201 \begin_inset Flex Noun
3204 \begin_layout Plain Layout
3212 \begin_inset space ~
3216 \begin_inset CommandInset ref
3218 reference "sec:Inserting-TeX-Code"
3228 \begin_layout Plain Layout
3229 An alternative approach
3230 \change_inserted -712698321 1486199215
3231 , if you are willing to use some
3232 \begin_inset Flex Noun
3235 \begin_layout Plain Layout
3237 \change_inserted -712698321 1486199212
3245 \begin_inset space ~
3249 \begin_inset CommandInset ref
3251 reference "sec:Inserting-TeX-Code"
3258 \change_deleted -712698321 1486231820
3260 \begin_inset Flex Code
3263 \begin_layout Plain Layout
3272 \begin_inset Flex Code
3275 \begin_layout Plain Layout
3282 \change_deleted -712698321 1486231824
3291 \change_inserted -712698321 1486231646
3293 \change_deleted -712698321 1486202138
3297 \begin_layout Standard
3299 \change_deleted -712698321 1486202126
3301 \begin_inset Flex Noun
3304 \begin_layout Plain Layout
3305 Document\SpecialChar menuseparator
3312 \begin_inset Flex Noun
3315 \begin_layout Plain Layout
3322 \begin_inset Flex Noun
3325 \begin_layout Plain Layout
3326 Sectioned bibliography
3332 In the document, you have to enclose the sections, which shall contain
3333 their own bibliography (including the Bib\SpecialChar TeX
3334 bibliography itself), between
3336 \change_inserted -712698321 1486231702
3338 \begin_inset Flex Code
3341 \begin_layout Plain Layout
3343 \change_inserted -712698321 1486231702
3349 is used, \SpecialChar LyX
3350 encloses the specified units in
3351 \begin_inset Flex Code
3354 \begin_layout Plain Layout
3356 \change_inserted -712698321 1486201443
3365 \begin_inset Flex Code
3368 \begin_layout Plain Layout
3377 \begin_inset Flex Code
3380 \begin_layout Plain Layout
3389 \change_inserted -712698321 1486231697
3390 in order to create the units.
3391 Note that this approach has
3394 \change_inserted -712698321 1486231697
3397 \change_deleted -712698321 1486200476
3398 (those commands have to be inserted as \SpecialChar TeX
3400 The bibliography will contain all references that have been cited in the
3402 \begin_inset Flex Code
3405 \begin_layout Plain Layout
3416 If you are using this approach, then
3417 \change_inserted -712698321 1486231697
3420 every citation reference has to be inside some
3421 \begin_inset Flex Code
3424 \begin_layout Plain Layout
3432 \change_inserted -712698321 1486231697
3433 So citations outside a defined unit (e.
3434 \begin_inset space \thinspace{}
3437 g., before the first section if you use
3438 \begin_inset Quotes eld
3442 \begin_inset Quotes erd
3446 \begin_inset Quotes eld
3450 \begin_inset Quotes erd
3454 You can also create your own units by entering
3455 \begin_inset Flex Code
3458 \begin_layout Plain Layout
3460 \change_inserted -712698321 1486200131
3469 \begin_inset Flex Code
3472 \begin_layout Plain Layout
3474 \change_inserted -712698321 1486200131
3483 code (for instance to work around the mentioned limitation).
3485 \change_deleted -712698321 1486200476
3489 \begin_inset Flex Code
3492 \begin_layout Plain Layout
3500 \change_inserted -712698321 1486231697
3501 A second limitation is that
3502 \begin_inset Flex Code
3505 \begin_layout Plain Layout
3507 \change_inserted -712698321 1486200199
3513 always processes all references of a bibliography database, even if they
3515 This can result in odd labels (e.
3516 \begin_inset space \thinspace{}
3521 \begin_inset Quotes eld
3525 \begin_inset Quotes erd
3528 if two works of this author from 2014 are in the database, even if only
3532 \begin_layout Standard
3534 \change_inserted -712698321 1486204109
3540 \begin_inset Flex Code
3543 \begin_layout Plain Layout
3545 \change_inserted -712698321 1486202183
3553 option is used instead.
3554 If you need specific units, you can start them with the \SpecialChar TeX
3556 \begin_inset Flex Code
3559 \begin_layout Plain Layout
3561 \change_inserted -712698321 1485697716
3572 \begin_inset Flex Code
3575 \begin_layout Plain Layout
3577 \change_inserted -712698321 1485697724
3588 If you also want to control the end of the unit, use the environment
3589 \begin_inset Flex Code
3592 \begin_layout Plain Layout
3594 \change_inserted -712698321 1485697769
3604 \begin_inset Flex Code
3607 \begin_layout Plain Layout
3609 \change_inserted -712698321 1485697780
3619 \begin_inset Flex Code
3622 \begin_layout Plain Layout
3624 \change_inserted -712698321 1486201999
3633 In addition to the individual bibliography of the current unit,
3637 also provides an easy way to output all bibliographies, subsequently, at
3639 \begin_inset space \thinspace{}
3642 g., at the end of the document).
3644 \begin_inset Quotes eld
3648 \begin_inset Quotes erd
3651 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3657 manual for more information on this topic.
3662 \begin_layout Section
3666 \begin_layout Subsection
3670 \begin_layout Standard
3671 When you are working on a large file with many sections, it is often convenient
3672 to break up the document into several files, or perhaps you have something
3673 where a table may change from time to time, but the preceding text does
3675 In these cases, you should seriously consider using multipart documents.
3676 For example, scientific papers often have five major sections: the introduction
3677 , observations, results, discussion, and conclusion.
3678 Each of these could be its own separate \SpecialChar LyX
3680 \begin_inset Quotes eld
3684 \begin_inset Quotes erd
3687 file which contains the title, authors, abstract, references, etc., plus
3688 the five included files.
3689 It is important to note that each of these files is a full \SpecialChar LyX
3691 can be formatted and printed on its own, as well as included in a master
3693 Each of these files must have the same document class, however—don't attempt
3694 to mix book classes with article classes.
3695 You may also include \SpecialChar LaTeX
3696 files; however, these files must not have their own
3698 \begin_inset space \thinspace{}
3702 \begin_inset space \space{}
3705 everything up to and including the
3706 \begin_inset Flex Code
3709 \begin_layout Plain Layout
3718 \begin_inset Flex Code
3721 \begin_layout Plain Layout
3729 line must be deleted) or else errors will be generated when you try to
3733 \begin_layout Standard
3735 allows you to include files quite easily with
3736 \begin_inset Flex Noun
3739 \begin_layout Plain Layout
3740 Insert\SpecialChar menuseparator
3742 \begin_inset space ~
3751 When you click on this selection a small box is inserted into the file
3752 at the current cursor location.
3753 Clicking on the box raises a dialog which allows you to select the file
3754 to be included, and the method of its inclusion.
3758 \begin_layout Standard
3759 The file selection box should by now be obvious.
3760 The three inclusion methods are
3761 \begin_inset Quotes eld
3765 \begin_inset Quotes erd
3769 \begin_inset Quotes eld
3773 \begin_inset Quotes erd
3777 \begin_inset Quotes eld
3781 \begin_inset Quotes erd
3785 The difference between
3786 \begin_inset Quotes eld
3790 \begin_inset Quotes erd
3794 \begin_inset Quotes eld
3798 \begin_inset Quotes erd
3801 is really only meaningful to \SpecialChar LaTeX
3802 perts, but the practical difference is that
3804 \begin_inset Quotes eld
3808 \begin_inset Quotes erd
3811 are typeset beginning on a new page, while files that are
3812 \begin_inset Quotes eld
3816 \begin_inset Quotes erd
3819 are typeset starting on the current page.
3822 \begin_layout Standard
3823 Generally, the master file is converted into a full \SpecialChar LaTeX
3824 file before typesetting,
3825 while the included files are converted to \SpecialChar LaTeX
3826 files that do not have all the
3827 preamble information.
3830 \begin_layout Standard
3832 \begin_inset Quotes eld
3836 \begin_inset Quotes erd
3839 included file allows you to include a file typeset exactly as it appears
3841 \begin_inset space \thinspace{}
3845 \begin_inset space \space{}
3849 \begin_inset Flex Code
3852 \begin_layout Plain Layout
3858 mode, with the characters set in a fixed-width typewriter font.
3859 Normally, spaces in this file are invisible, though two consecutive spaces
3860 are conserved, unlike \SpecialChar LyX
3861 's normal treatment of spaces.
3862 However, setting the
3863 \begin_inset Flex Noun
3866 \begin_layout Plain Layout
3868 \begin_inset space ~
3872 \begin_inset space ~
3876 \begin_inset space ~
3884 checkbox typesets a mark to unambiguously define the presence of a space.
3888 \begin_layout Subsection
3889 Cross-References Between Files
3892 \begin_layout Standard
3893 \begin_inset Box Shadowbox
3903 height_special "totalheight"
3908 backgroundcolor "none"
3911 \begin_layout Plain Layout
3912 This section is somewhat out of date.
3913 Need to describe default master documents and how children are opened when
3923 \begin_layout Standard
3924 It is possible to set up cross-references between the different files.
3925 First, open all the files in question: let's call them A and B in a two
3926 file example, where B is included in A.
3927 Let's say you insert a label in A, then want to reference it in B.
3928 Open the cross-reference dialog whilst in document B, and you can select
3930 \begin_inset Quotes eld
3934 \begin_inset Quotes erd
3940 \begin_layout Subsection
3941 Bibliography Lists in all Subdocuments
3944 \begin_layout Standard
3945 \begin_inset Box Frameless
3955 height_special "totalheight"
3960 backgroundcolor "none"
3963 \begin_layout Plain Layout
3964 This section also needs updating.
3965 There is now material about this on the wiki, and it could be copied here.
3973 \begin_layout Standard
3974 Copy the bibliography list with all entries to all subdocuments and transform
3976 This way \SpecialChar LyX
3978 \begin_inset Flex Code
3981 \begin_layout Plain Layout
3987 -files and you can easily insert references without making the bibliography
3991 \begin_layout Standard
3992 As the bibliography list is in a comment, \SpecialChar LaTeX
3993 won't use it and the references
3994 will look like this: [?], instead of like this: [1].
3995 One solution is to use the \SpecialChar LaTeX
3997 \begin_inset Flex Code
4000 \begin_layout Plain Layout
4006 that will only include comments by processing the files separately.
4007 To do this, add in the \SpecialChar LaTeX
4008 preamble of every subdocument the following:
4011 \begin_layout LyX-Code
4017 \begin_layout LyX-Code
4020 includecomment{comment}
4023 \begin_layout Standard
4025 \begin_inset Flex URL
4028 \begin_layout Plain Layout
4030 http://wiki.lyx.org/FAQ/Unsorted#toc31
4038 \begin_layout Section
4043 \begin_layout Standard
4044 Users sometimes need to be able to
4045 \begin_inset Quotes eld
4049 \begin_inset Quotes erd
4053 file together with all the images (and other files) on which it depends,
4054 either for sending to a publisher or for sharing with a co-author.
4056 2.0 includes a Python script (
4057 \begin_inset Flex Code
4060 \begin_layout Plain Layout
4066 ) that automates this process.
4067 To use it, you must have either the
4068 \begin_inset Flex Code
4071 \begin_layout Plain Layout
4078 \begin_inset Flex Code
4081 \begin_layout Plain Layout
4087 python modules installed on your system.
4088 By default, the script prefers the
4089 \begin_inset Flex Code
4092 \begin_layout Plain Layout
4099 \begin_inset Flex Code
4102 \begin_layout Plain Layout
4108 format on Unix-like systems and the
4109 \begin_inset Flex Code
4112 \begin_layout Plain Layout
4121 \begin_layout Standard
4123 's configuration process will set the script up to export a `\SpecialChar LyX
4125 and this format will then be available under
4126 \begin_inset Flex Code
4129 \begin_layout Plain Layout
4130 File\SpecialChar menuseparator
4139 \begin_layout Standard
4140 Independently of the platform, the generation of a particular archive format
4141 can be forced by adding either the
4142 \begin_inset Flex Code
4145 \begin_layout Plain Layout
4152 \begin_inset Flex Code
4155 \begin_layout Plain Layout
4162 \begin_inset Flex Code
4165 \begin_layout Plain Layout
4172 \begin_inset Flex Code
4175 \begin_layout Plain Layout
4181 format) switch to the
4182 \begin_inset Flex Code
4185 \begin_layout Plain Layout
4187 \SpecialChar menuseparator
4195 \begin_inset Flex Code
4198 \begin_layout Plain Layout
4199 Tools\SpecialChar menuseparator
4200 Preferences\SpecialChar menuseparator
4201 File Handling\SpecialChar menuseparator
4208 (Make sure you add the switch after the script name, not before it.)
4211 \begin_layout Section
4212 Fancy Headers and Footers
4215 \begin_layout Standard
4216 The default page layout is rather plain; for an
4217 \begin_inset Flex Code
4220 \begin_layout Plain Layout
4226 document class, all you get is a centered page number at the bottom of
4228 This document uses KOMA-script's book class, so it appears to be a bit
4230 But to really put on a show, you need to set the document page style to
4232 \begin_inset Quotes eld
4236 \begin_inset Quotes erd
4239 , as mentioned in the
4244 This section describes the \SpecialChar LaTeX
4245 code you need to insert in your \SpecialChar LaTeX
4247 order to get the desired effects.
4250 \begin_layout Standard
4251 For more information on fancy headers, see the
4252 \begin_inset Flex Code
4255 \begin_layout Plain Layout
4261 package documentation.
4263 \begin_inset Flex URL
4266 \begin_layout Plain Layout
4268 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4276 \begin_layout Standard
4277 The page header is divided into three fields, not surprisingly labeled
4278 \begin_inset Quotes eld
4282 \begin_inset Quotes erd
4286 \begin_inset Quotes eld
4290 \begin_inset Quotes erd
4294 \begin_inset Quotes eld
4298 \begin_inset Quotes erd
4302 The footer is also divided into these three fields.
4303 The \SpecialChar LaTeX
4304 commands to set these fields in the simplest manner are
4305 \begin_inset Flex Code
4308 \begin_layout Plain Layout
4317 \begin_inset Flex Code
4320 \begin_layout Plain Layout
4329 \begin_inset Flex Code
4332 \begin_layout Plain Layout
4341 \begin_inset Flex Code
4344 \begin_layout Plain Layout
4353 Suppose you wish to put your name in the upper left hand corner of each
4355 Simply insert the following command in the preamble:
4358 \begin_layout Standard
4367 \begin_layout Standard
4368 You will now see your name in the upper left.
4369 If a field has a default entry that you would like to get rid of (often
4370 the page number appears in the central footer) simply include a command
4371 with a blank argument, e.
4372 \begin_inset space \thinspace{}
4378 \begin_layout Standard
4386 \begin_layout Standard
4387 Let's get really fancy: lets put the section number with the word
4388 \begin_inset Quotes eld
4392 \begin_inset Quotes erd
4396 \begin_inset space \thinspace{}
4400 \begin_inset space \space{}
4403 Section 3) in the upper left, the page number (e.
4404 \begin_inset space \thinspace{}
4408 \begin_inset space \space{}
4411 Page 4) in the upper right, your name in the lower left, and the date in
4413 The following commands should now appear in the preamble:
4416 \begin_layout Standard
4426 \begin_layout Standard
4434 \begin_layout Standard
4444 \begin_layout Standard
4453 \begin_layout Standard
4461 \begin_layout Standard
4471 \begin_layout Standard
4473 \begin_inset Flex Code
4476 \begin_layout Plain Layout
4485 \begin_inset Flex Code
4488 \begin_layout Plain Layout
4496 access \SpecialChar LaTeX
4497 's section and page counters, and so print out the current section
4500 \begin_inset Flex Code
4503 \begin_layout Plain Layout
4511 simply prints out today's date.
4514 \begin_layout Standard
4515 The thicknesses of the horizontal rules drawn beneath the header and above
4516 the footer can also be modified.
4517 If you don't want one of the rules, set its thickness to 0.
4518 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4524 \begin_inset Flex Code
4527 \begin_layout Plain Layout
4532 headrulewidth}{0.4pt}
4538 \begin_inset Flex Code
4541 \begin_layout Plain Layout
4546 footrulewidth}{0.4pt}
4551 to set the thicknesses.
4554 \begin_layout Standard
4555 You can switch the header/footer settings on and off for individual pages
4557 \begin_inset Flex Code
4560 \begin_layout Plain Layout
4563 thispagestyle{empty}
4569 \begin_inset Flex Code
4572 \begin_layout Plain Layout
4575 thispagestyle{plain}
4581 \begin_inset Flex Code
4584 \begin_layout Plain Layout
4587 thispagestyle{fancy}
4593 Simply insert them in the text on the page you want changed and mark them
4596 In fact, title pages are marked as plain by default, while following pages
4597 are marked fancy when using the global fancy setting.
4600 \begin_layout Standard
4601 As a final example, it is possible to include an image in the header or
4603 Suppose you want to put a company logo in the upper lefthand corner.
4604 You might try something like
4607 \begin_layout Standard
4616 includegraphics{logo.eps}}}
4619 \begin_layout Standard
4621 (you may need to preface this with
4622 \begin_inset Flex Code
4625 \begin_layout Plain Layout
4629 usepackage{graphics}
4634 if you don't include graphics elsewhere in your document).
4637 \begin_layout Section
4638 Itemize Bullet Selection
4639 \begin_inset CommandInset label
4648 \begin_layout Standard
4654 \begin_layout Subsection
4658 \begin_layout Standard
4660 provides 216 bullet shapes that can be accessed from a simple dialog.
4661 Using this dialog you can easily specify what bullet shape to use at each
4662 level of an itemized list.
4663 These settings are document-wide so you won't be able to specify different
4664 sets of bullets for different paragraphs.
4668 \begin_layout Plain Layout
4669 Well, actually you can but you'll have to do it by hand.
4677 \begin_layout Subsection
4681 \begin_layout Standard
4682 Open the dialog by selecting the
4683 \begin_inset Flex Noun
4686 \begin_layout Plain Layout
4687 Document\SpecialChar menuseparator
4693 menu item and then select the
4694 \begin_inset Flex Noun
4697 \begin_layout Plain Layout
4706 \begin_layout Standard
4707 The dialog provides you with a table of bullet shapes.
4708 A column of buttons on the left of the table provides access to the six
4709 different panels of bullet shapes.
4710 The row of buttons across the top is used to select which bullet depth
4712 A text entry under the table shows the currently selected bullet shape's
4714 equivalent and this can be edited if desired.
4715 If you do modify the text you will also need to specify any needed packages
4716 in the \SpecialChar LaTeX
4720 \begin_layout Standard
4721 The six panels are divided up by the packages they require.
4722 The following table shows the mappings from button name to \SpecialChar LaTeX
4726 \begin_layout Standard
4728 \begin_inset Tabular
4729 <lyxtabular version="3" rows="7" columns="2">
4730 <features tabularvalignment="middle">
4731 <column alignment="center" valignment="top" width="0pt">
4732 <column alignment="center" valignment="top" width="0pt">
4734 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4737 \begin_layout Plain Layout
4752 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4755 \begin_layout Plain Layout
4772 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4775 \begin_layout Plain Layout
4790 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4793 \begin_layout Plain Layout
4802 base \SpecialChar LaTeX
4810 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4813 \begin_layout Plain Layout
4828 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4831 \begin_layout Plain Layout
4848 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4851 \begin_layout Plain Layout
4866 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4869 \begin_layout Plain Layout
4886 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4889 \begin_layout Plain Layout
4904 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4907 \begin_layout Plain Layout
4924 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4927 \begin_layout Plain Layout
4942 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4945 \begin_layout Plain Layout
4962 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4965 \begin_layout Plain Layout
4980 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4983 \begin_layout Plain Layout
5006 \begin_layout Standard
5008 doesn't stop you using bullets from packages you don't have.
5009 If you get errors from \SpecialChar LaTeX
5010 when you try to view or print the file, then it
5011 is likely you are missing a package.
5015 \begin_layout Plain Layout
5017 doesn't restrict your use since you may be editing locally and exporting
5026 \begin_layout Subsection
5030 \begin_layout Standard
5031 Select which bullet depth you want to change then select the bullet shape
5033 Any changes will not be visible in \SpecialChar LyX
5034 , but are visible when viewing the document.
5037 \begin_layout Standard
5038 You can reset a bullet shape to the default simply by clicking your right
5039 mouse button on the appropriate bullet depth button.
5043 \begin_layout Plain Layout
5048 want to have multiple sets of paragraphs with different sets of bullets
5049 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
5051 The bullet selection dialog can help though because it provides you with
5052 the \SpecialChar LaTeX
5053 code for a wide range of bullet shapes.
5054 To make your own custom paragraphs you have the following options:
5057 \begin_layout Plain Layout
5061 \begin_layout Plain Layout
5077 \begin_layout Plain Layout
5081 \begin_layout Plain Layout
5103 \begin_layout Itemize
5104 Use the \SpecialChar LaTeX
5106 \begin_inset Flex Code
5109 \begin_layout Plain Layout
5117 to specify a new bullet shape for a given depth.
5118 You'll also need to save the current bullet shape so you can restore it
5120 In this itemized list the following \SpecialChar LaTeX
5121 code was used to change the bullet
5122 used for the first depth.
5126 \begin_layout LyX-Code
5136 \begin_layout LyX-Code
5153 \begin_layout Itemize
5154 Note that the itemize depth is specified in Roman numerals as part of the
5164 \begin_layout Itemize
5168 \begin_layout Plain Layout
5181 Specify each individual entry by starting each item with the bullet shape
5182 enclosed in square brackets and set as
5183 \begin_inset Flex Noun
5186 \begin_layout Plain Layout
5194 For example, this item was started with
5195 \begin_inset Flex Code
5198 \begin_layout Plain Layout
5213 \begin_layout Plain Layout
5217 \begin_layout Plain Layout
5233 \begin_layout Plain Layout
5234 You'll also need to revert the labelitem back to its previous setting for
5235 the global bullet shape settings to remain in effect.
5236 The way used here was:
5239 \begin_layout LyX-Code
5254 \begin_layout Chapter
5256 and the World Wide Web
5259 \begin_layout Standard
5261 has long supported the export of documents to various web-friendly formats,
5263 Before verson 2.0, however, HTML export was always accomplished by the use
5264 of external converters.
5268 \begin_layout Plain Layout
5269 For details on the use of external converters with \SpecialChar LyX
5274 section of the Customization manual.
5279 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5281 intermediate format, such as
5282 \begin_inset Flex Code
5285 \begin_layout Plain Layout
5292 \begin_inset Flex Code
5295 \begin_layout Plain Layout
5302 \begin_inset Flex Code
5305 \begin_layout Plain Layout
5311 , relying upon \SpecialChar LyX
5312 to produce the \SpecialChar LaTeX
5313 ; and there is a converter that works directly
5316 \begin_inset Flex Code
5319 \begin_layout Plain Layout
5327 All of these have different advantages and disadvantages.
5331 \begin_layout Standard
5332 The \SpecialChar LaTeX
5333 -based converters have the advantage that, in principle, they know everythin
5334 g about the exported document that \SpecialChar LaTeX
5336 Such converters do not care, for example, if a certain block of code was
5337 produced by \SpecialChar LyX
5338 or was Evil Red Text.
5339 These converters know about
5340 \begin_inset Flex Code
5343 \begin_layout Plain Layout
5349 files, counters, and references, and can often make use of the
5350 \begin_inset Flex Code
5353 \begin_layout Plain Layout
5359 files generated by Bib\SpecialChar TeX
5361 On the other hand, \SpecialChar LaTeX
5362 is a very hard language to parse—it is sometimes said
5363 that only \SpecialChar TeX
5364 itself understands \SpecialChar TeX
5365 —and \SpecialChar LaTeX
5366 -based converters will often choke on
5367 what seem to be quite simple constructs; complex ones can throw them completely
5368 , and as of this writing, for example, the
5372 manual will not export with
5373 \begin_inset Flex Code
5376 \begin_layout Plain Layout
5382 , though the others will.
5383 The other issue concerns how math is handled.
5384 These converters typically convert the formulae into little pictures that
5385 are then linked from the HTML document.
5386 Since these are actually generated by \SpecialChar LaTeX
5387 , they are accurate.
5388 But they do not scale well, and just getting them to look as if they are
5389 actually meant to be in your document—so that the font sizes seem to be
5390 roughly the same—can be a challenge.
5393 \begin_layout Standard
5395 \begin_inset Flex Code
5398 \begin_layout Plain Layout
5406 \begin_inset CommandInset href
5408 name "http://elyxer.nongnu.org/"
5409 target "http://elyxer.nongnu.org/"
5414 ) solves some of these problems.
5415 In particular, the formulae it produces scale perfectly, since it renders
5416 math using a combination of HTML and CSS rather than converting the formulae
5418 But even moderately complex formula are rendered less well than with
5419 \begin_inset Flex Code
5422 \begin_layout Plain Layout
5428 ; this reflects the limitations of HTML.
5432 \begin_layout Plain Layout
5434 \begin_inset Flex Code
5437 \begin_layout Plain Layout
5444 can also use jsMath and MathJax for equations, but this setting is only
5445 available globally and requires one to have access to a server that runs
5451 More importantly (as of version 1.1.1, at least),
5452 \begin_inset Flex Code
5455 \begin_layout Plain Layout
5462 has limited support for math macros and no support for user-defined paragraph
5463 or character styles.
5464 These limitations make
5465 \begin_inset Flex Code
5468 \begin_layout Plain Layout
5475 unsuitable for many of the documents \SpecialChar LyX
5477 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5479 have decided to follow a different path and have made \SpecialChar LyX
5481 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5482 , DocBook, and plaintext.
5485 \begin_layout Standard
5486 As of this writing, XHTML output remains under development and should probably
5488 \begin_inset Quotes eld
5492 \begin_inset Quotes erd
5499 \begin_layout Plain Layout
5501 \begin_inset Flex Code
5504 \begin_layout Plain Layout
5505 development/HTML.notes
5510 , which can be found in the \SpecialChar LyX
5512 \begin_inset CommandInset href
5514 name "accessed online"
5515 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5520 , usually contains up-to-date information about the state of XHTML output.
5521 See also the list of XHTML bugs on
5522 \begin_inset CommandInset href
5524 name "the bug tracker"
5525 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"
5535 Still, the developers have chosen this approach because it has several
5536 potential advantages over the other two.
5539 \begin_layout Standard
5540 These advantages are primarily due to the fact that the XHTML output routines,
5541 since they are part of \SpecialChar LyX
5542 , know everything \SpecialChar LyX
5543 knows about the document being
5548 \begin_layout Plain Layout
5549 Another advantage is that, since these routines are internal to \SpecialChar LyX
5551 immune to changes in \SpecialChar LyX
5552 's file format, or to changes in the semantics of
5558 So they know about the table of contents (as displayed in the outline),
5559 about the counters associated with different paragraph styles, and about
5560 user-defined styles.
5561 The XHTML output routines know what \SpecialChar LyX
5562 knows about internationalization,
5563 too, so they will output
5564 \begin_inset Quotes eld
5568 \begin_inset Quotes erd
5572 \begin_inset Quotes eld
5580 \begin_inset Quotes erd
5583 , depending upon the language in effect at the time.
5587 \begin_layout Standard
5588 Quite generally, the output routines know what \SpecialChar LyX
5589 knows about document layout,
5590 that is, about how the document is to be rendered on screen.
5591 We use this information when we output the document as XHTML.
5592 In particular, \SpecialChar LyX
5597 generates CSS style information corresponding to the layout information
5598 it uses to render the document on screen: if section headings are supposed
5599 to be sans-serif and bold as seen in \SpecialChar LyX
5600 , then (by default) they will be sans-seri
5601 f and bold when viewed in a web browser, too.
5602 And this is true not just for pre-defined styles, like Section, but for
5603 any style, including user-defined styles.
5604 Indeed, the XHTML output routines make no distinction between user-defined
5605 paragraph and character styles and \SpecialChar LyX
5606 's own pre-defined styles: in each case,
5607 everything \SpecialChar LyX
5608 knows about the styles is contained in the layout files.
5609 And much the same is true as regards pre-defined textual insets, such as
5610 footnotes, and various custom insets.
5614 \begin_layout Standard
5615 The result is that XHTML output can be customized and extended in exactly
5616 the same way \SpecialChar LaTeX
5617 output can be customized and extended: through layout files
5619 See chapter five of the
5623 manual for the details.
5626 \begin_layout Standard
5627 The remainder of this chapter contains more detailed information on XHTML
5628 output, its limitations, and ways to work around those limitations.
5631 \begin_layout Section
5632 Math Output in XHTML
5635 \begin_layout Standard
5637 offers four choices for how math is rendered.
5638 These have various advantages and disadvantages:
5641 \begin_layout Itemize
5643 \begin_inset Newline newline
5646 MathML is a dialect of XML designed specifically for mathematics on the
5647 web, and it typically renders very well in browsers that support it.
5648 The disadvantage is that not all browsers support MathML, and support is
5649 not complete even in the Gecko-based browsers, such as Firefox.
5650 \begin_inset Newline newline
5654 is unable to render a formula as MathML—for example, if the formula
5656 \begin_inset Flex Code
5659 \begin_layout Plain Layout
5665 package or ERT—then it will instead output the formula as an image.
5669 \begin_layout Itemize
5671 \begin_inset Newline newline
5675 \begin_inset Flex Code
5678 \begin_layout Plain Layout
5684 outputs math as HTML, styled by CSS.
5688 \begin_layout Plain Layout
5690 has borrowed some of the CSS for its HTML output from
5691 \begin_inset Flex Code
5694 \begin_layout Plain Layout
5705 For simple formulae, this can work quite well, though with more complicated
5706 formulae it tends to break down.
5707 Still, this method has the advantage that it is very widely supported and
5708 so it may be appropriate for documents that contain only a little, fairly
5710 \begin_inset Newline newline
5713 If Lyx is unable to render a formula as HTML—for example, if the formula
5715 \begin_inset Flex Code
5718 \begin_layout Plain Layout
5724 package or ERT—then it will instead output the formula as an image.
5728 \begin_layout Itemize
5730 \begin_inset Newline newline
5734 \begin_inset Flex Code
5737 \begin_layout Plain Layout
5744 will output formulae as images, the very same images, in fact, that are
5745 used for instant preview.
5749 \begin_layout Plain Layout
5750 Instant preview does
5754 have to be on for images to be output, however.
5759 The advantage to this method is that the images are simply generated by
5761 , so they are very accurate.
5762 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5763 so they do not scale terribly well, and one cannot copy them, etc.
5764 (As of this writing, there are also problems about equation numbering.
5766 \begin_inset CommandInset href
5769 target "http://www.lyx.org/trac/ticket/6894"
5775 \begin_inset Newline newline
5778 The size of the images can be controlled by setting the
5779 \begin_inset Quotes eld
5783 \begin_inset Quotes erd
5787 \begin_inset Flex Noun
5790 \begin_layout Plain Layout
5791 Document\SpecialChar menuseparator
5792 Settings\SpecialChar menuseparator
5802 \begin_layout Plain Layout
5803 For those who want to know, this controls the resolution of the image in
5804 dots per inch and is based upon a default of 75 dpi.
5810 \begin_inset Newline newline
5814 for some reason fails to create an image for a formula (e.g., if a required
5816 package is not installed), then it will fall back to outputing the raw
5821 \begin_layout Itemize
5824 \begin_inset Newline newline
5827 Finally, \SpecialChar LyX
5828 will happily output math as \SpecialChar LaTeX
5830 As well as being the output of last resort, this method can be used with
5832 \begin_inset CommandInset href
5835 target "http://www.math.union.edu/~dpvc/jsMath/"
5840 , which uses JavaScript to render \SpecialChar LaTeX
5841 embedded in HTML documents.
5843 wraps the \SpecialChar LaTeX
5845 \begin_inset Flex Code
5848 \begin_layout Plain Layout
5854 (for inline formulas) or
5855 \begin_inset Flex Code
5858 \begin_layout Plain Layout
5864 (for displayed formulas) with
5865 \begin_inset Flex Code
5868 \begin_layout Plain Layout
5874 , as is required for jsMath.
5877 \begin_layout Standard
5878 One of these output methods must be selected under
5879 \begin_inset Flex Noun
5882 \begin_layout Plain Layout
5883 Document\SpecialChar menuseparator
5884 Settings\SpecialChar menuseparator
5891 By default, \SpecialChar LyX
5893 This is a document-wide setting, therefore.
5896 \begin_layout Standard
5897 Eventually, \SpecialChar LyX
5898 will offer the user the option to select an alternate output
5899 method for a particular inset, say, one that isn't being rendered very
5904 \begin_layout Plain Layout
5905 That said, since \SpecialChar LyX
5906 falls back to images if the inset contains ERT, then one
5907 can force output as an image by putting some harmless ERT into the math,
5909 \begin_inset Formula $a=b\relax$
5920 \begin_layout Section
5921 Bibliography and Citations
5924 \begin_layout Standard
5925 XHTML output fully supports bibliographies and citations.
5929 \begin_layout Standard
5930 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5932 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5935 If you are using numerical citations, then \SpecialChar LyX
5936 will output numerical labels,
5937 such as [1] or [17], rather than simply showing the citation key in square
5938 brackets, as it does on-screen.
5939 If you are using author-year citations, then \SpecialChar LyX
5940 will add lowercase letters
5941 to the years, just as Bib\SpecialChar TeX
5942 does, if it finds more than one citation for
5943 a given author-year combination.
5944 The labels will be printed with the bibliography entries.
5945 Note that there is, at present, no way to customize the appearance of the
5946 labels, for example, to choose between square brackets and parentheses.
5949 \begin_layout Standard
5950 Bibliography output is handled by the same machinery that handles the presentati
5951 on of reference information in the citation dialog, so you will see in the
5952 XHTML output pretty much what you would see if you were to look at a given
5953 entry in the citation dialog.
5954 The formatting can be customized in your layout file or, preferably, in
5960 manual for the details.
5963 \begin_layout Standard
5964 The main defect at present is that cross-referenced information is printed
5965 with every entry with which it is associated.
5966 So you can see things like this:
5971 \begin_inset Quotes eld
5974 Context and Logical Form
5975 \begin_inset Quotes erd
5980 Language in Context: Selected Essays
5982 (Oxford: Oxford University Press, 2007), pp.
5988 \begin_inset Quotes eld
5991 Semantics in Context
5992 \begin_inset Quotes erd
5997 Language in Context: Selected Essays
5999 (Oxford: Oxford University Press, 2007), pp.
6003 \begin_layout Standard
6004 This should be fixed before long.
6007 \begin_layout Standard
6008 There is no support at present for sectioned bibliographies.
6009 If you have multiple bibliographies, then \SpecialChar LyX
6010 will print the same bibliography
6014 \begin_layout Section
6018 \begin_layout Standard
6020 will happily export indexes as XHTML, but with certain limitations at the
6024 \begin_layout Standard
6025 Index export will be most reliable when you do not attempt to use the fancy
6026 constructs that are described in the section on indexes in the
6034 \begin_layout Plain Layout
6035 The main issue here is that \SpecialChar LyX
6036 itself does not really handle these.
6037 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
6043 We'll describe how they are handled using the subsection headings from
6047 \begin_layout Itemize
6048 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
6049 makes an effort to support these,
6050 but the entries must be separated by
6051 \begin_inset Quotes eld
6055 \begin_inset Quotes erd
6058 , that is, there must be spaces around the exclamation point.
6059 This is because it is otherwise too difficult to check for escaped exclamation
6060 points, ones in math, and so forth.
6063 \begin_layout Itemize
6064 Page Ranges: There is no support at all for page ranges, since these make
6065 no sense with XHMTL.
6066 Instead, you will just get two index entries, one at either end.
6069 \begin_layout Itemize
6070 Cross-referencing: There is no support for cross-referencing.
6072 finds an entry containing the
6073 \begin_inset Quotes eld
6076 |see\SpecialChar ldots
6078 \begin_inset Quotes erd
6081 construct, it is just dropped, and the rest is treated as an ordinary index
6085 \begin_layout Itemize
6086 Index Entry Order: \SpecialChar LyX
6087 does support attempts to fix the sorting order.
6088 It will take what is before the first `@' it finds and use that for sorting,
6089 taking what follows the first `@' to be the actual entry.
6090 At present, \SpecialChar LyX
6091 does not check for escaped `@', so do not try to index email
6095 \begin_layout Itemize
6096 Index Entry Layout: You can format entries by using the text style dialog,
6097 or by using any other method available within \SpecialChar LyX
6099 There is no support for constructs like:
6100 \begin_inset Quotes eld
6104 \begin_inset Quotes erd
6108 Indeed, if \SpecialChar LyX
6109 finds a pipe symbol, `|', in an entry, it will delete it and
6110 everything that follows it.
6113 \begin_layout Itemize
6114 Multiple Indexes: There is no support for multiple indexes.
6115 Rather, all index entries will be printed as one large index.
6116 To avoid our printing several versions of the index, we print only the
6117 main index, so make sure you have one.
6120 \begin_layout Section
6121 Nomenclature and Glossary
6124 \begin_layout Standard
6125 There is at present no support for glossaries.
6126 Adding it would be fairly trivial, and welcome.
6129 \begin_layout Chapter
6130 The \SpecialChar LyX
6134 \begin_layout Section
6138 \begin_layout Standard
6139 The `\SpecialChar LyX
6140 server' allows other programs to talk to \SpecialChar LyX
6141 , invoke \SpecialChar LyX
6142 commands, and retrieve
6143 information about the \SpecialChar LyX
6145 This is only intended for advanced users, but they should find it useful.
6146 It is by writing to the \SpecialChar LyX
6147 server, for example, that bibliography managers,
6148 such as JabRef, are able to
6149 \begin_inset Quotes eld
6153 \begin_inset Quotes erd
6156 citations to \SpecialChar LyX
6160 \begin_layout Section
6161 Starting the \SpecialChar LyX
6165 \begin_layout Standard
6166 The \SpecialChar LyX
6167 server works through the use of a pair of named pipes.
6168 These are usually located in
6169 \begin_inset Flex Code
6172 \begin_layout Plain Layout
6178 , (except on Windows, where
6182 named pipes are special objects located in
6183 \begin_inset Flex Code
6186 \begin_layout Plain Layout
6198 ) and have the names
6199 \begin_inset Quotes eld
6203 \begin_inset Flex Code
6206 \begin_layout Plain Layout
6213 \begin_inset Quotes erd
6217 \begin_inset Quotes eld
6221 \begin_inset Flex Code
6224 \begin_layout Plain Layout
6231 \begin_inset Quotes erd
6235 External programs write into
6236 \begin_inset Flex Code
6239 \begin_layout Plain Layout
6245 and read back data from
6246 \begin_inset Flex Code
6249 \begin_layout Plain Layout
6256 The stem of the pipe names can be defined in the
6257 \begin_inset Flex Noun
6260 \begin_layout Plain Layout
6261 Tools\SpecialChar menuseparator
6268 \begin_inset Flex Code
6271 \begin_layout Plain Layout
6272 "/home/myhome/lyxpipe"
6278 \begin_inset Flex Code
6281 \begin_layout Plain Layout
6295 on Windows (where any working path instead of lyxpipe can be used, for
6297 \begin_inset Flex Code
6300 \begin_layout Plain Layout
6323 configure this manually in order for the server to start.
6326 \begin_layout Standard
6329 \begin_inset Flex Code
6332 \begin_layout Plain Layout
6339 \begin_inset Flex Code
6342 \begin_layout Plain Layout
6348 ' to create the pipes.
6349 If one of the pipes already exists, \SpecialChar LyX
6350 will assume that another \SpecialChar LyX
6352 is already running and will not start the server.
6353 On POSIX (Unix like) systems, if for some other reason, an unused
6354 \begin_inset Quotes eld
6358 \begin_inset Quotes erd
6361 pipe is left in existence when \SpecialChar LyX
6362 closes, then \SpecialChar LyX
6363 will try to delete it.
6364 If this fails for some reason, you will need to delete the pipes manually
6365 and then restart \SpecialChar LyX
6367 On Windows, pipes are deleted by the OS on program termination or crash,
6369 \begin_inset Quotes eld
6373 \begin_inset Quotes erd
6376 pipes should not be possible.
6379 \begin_layout Standard
6380 To have several \SpecialChar LyX
6381 processes with servers at the same time, you have to use
6382 different configurations, perhaps by using separate user directories, each
6384 \begin_inset Flex Code
6387 \begin_layout Plain Layout
6393 file, for each process.
6396 \begin_layout Standard
6397 If you are developing a client program, you might find it useful to enable
6398 debugging information from the \SpecialChar LyX
6400 Do this by starting \SpecialChar LyX
6402 \begin_inset Flex Code
6405 \begin_layout Plain Layout
6414 \begin_layout Standard
6415 You can find a complete example client written in C++ in the source distribution
6417 \begin_inset Flex Code
6420 \begin_layout Plain Layout
6421 development/lyxserver/server_monitor.cpp
6429 \begin_layout Standard
6430 Another useful tool is the command-line based client found in
6431 \begin_inset Flex Code
6434 \begin_layout Plain Layout
6435 src/client/lyxclient
6443 \begin_layout Section
6444 Normal communication
6447 \begin_layout Standard
6448 To issue a \SpecialChar LyX
6449 call, the client writes a line of ASCII text into the input
6451 This line has the following format:
6468 \begin_layout Description
6469 clientname is a name that the client can choose arbitrarily.
6470 Its only use is that \SpecialChar LyX
6471 will echo it if it sends an answer—so a client can
6472 dispatch results from different requesters.
6475 \begin_layout Description
6476 function is the function you want \SpecialChar LyX
6478 It is the same as the commands you'd use in the minibuffer.
6481 \begin_layout Description
6482 argument is an optional argument which is meaningful only to some functions
6484 \begin_inset Quotes eld
6488 \begin_inset Quotes erd
6491 LFUN will insert the argument as text at the cursor position).
6494 \begin_layout Standard
6495 The answer from \SpecialChar LyX
6496 will arrive in the output pipe and be of the form
6513 \begin_layout Standard
6522 are just echoed from the command request, while
6526 is more or less useful information filled according to how the command
6527 execution worked out.
6528 Some commands, such as
6529 \begin_inset Quotes eld
6533 \begin_inset Quotes erd
6536 , will return information about the internal state of \SpecialChar LyX
6538 return an empty data-response.
6539 This means that the command execution went fine.
6542 \begin_layout Standard
6543 In case of errors, the response from \SpecialChar LyX
6561 \begin_layout Standard
6566 should contain an explanation of why the command failed.
6569 \begin_layout Standard
6573 \begin_layout LyX-Code
6574 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6575 \begin_inset Newline newline
6578 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6579 \begin_inset Newline newline
6582 read a <~/.lyxpipe.out
6583 \begin_inset Newline newline
6589 \begin_layout Subsection
6590 AppleScript (Mac OS X)
6593 \begin_layout Standard
6594 Since \SpecialChar LyX
6595 2.1, \SpecialChar LyX
6596 supports basic interactions with AppleScript for normal communicatio
6597 n through the command run.
6598 This command takes a direct argument (the
6602 to perform) and an optional argument.
6603 It either returns the output of the function or triggers an error with
6604 the error message and code.
6607 \begin_layout Standard
6611 \begin_layout LyX-Code
6612 tell application "\SpecialChar LyX
6616 \begin_layout LyX-Code
6620 \begin_layout LyX-Code
6621 -- Stores the current file name into f
6624 \begin_layout LyX-Code
6625 set f to (run "server-get-filename" with argument "")
6628 \begin_layout LyX-Code
6629 on error the error_message number the error_number
6632 \begin_layout LyX-Code
6633 display dialog "Error: " & the error_number & ".
6637 \begin_layout LyX-Code
6638 & the error_message buttons {"OK"} default button 1
6641 \begin_layout LyX-Code
6645 \begin_layout LyX-Code
6649 \begin_layout Section
6653 \begin_layout Standard
6655 can notify clients of events going on asynchronously.
6656 Currently it will only do this if the user binds a key sequence with the
6658 \begin_inset Quotes eld
6662 \begin_inset Quotes erd
6666 The format of the string \SpecialChar LyX
6667 sends is as follows:
6671 \begin_inset Flex Code
6674 \begin_layout Plain Layout
6685 \begin_layout Standard
6690 is the printed representation of the key sequence that was actually typed
6694 \begin_layout Standard
6695 This mechanism can be used to extend \SpecialChar LyX
6696 's command set and implement macros.
6697 Bind some key sequence to
6698 \begin_inset Quotes eld
6702 \begin_inset Quotes erd
6706 Then start a client that listens on the output pipe, dispatches the command
6707 according to the sequence, and starts a function that may use \SpecialChar LyX
6710 requests to issue a command or a series of commands to \SpecialChar LyX
6714 \begin_layout Section
6715 The simple \SpecialChar LyX
6719 \begin_layout Standard
6721 implements a simple protocol that can be used for session management.
6722 All messages are of the form
6735 \begin_layout Standard
6741 \begin_inset Quotes eld
6745 \begin_inset Quotes erd
6749 \begin_inset Quotes eld
6753 \begin_inset Quotes erd
6758 \begin_inset Quotes eld
6762 \begin_inset Quotes erd
6765 is received from a client, \SpecialChar LyX
6766 will report back to inform the client that
6767 it's listening to it's messages, while
6768 \begin_inset Quotes eld
6772 \begin_inset Quotes erd
6775 sent from \SpecialChar LyX
6776 will inform clients that \SpecialChar LyX
6780 \begin_layout Section
6781 Reverse DVI/PDF search
6784 \begin_layout Standard
6785 Some DVI/PDF viewers
6789 \begin_layout Plain Layout
6790 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6791 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6800 facility (also called
6805 This means that you can tell \SpecialChar LyX
6806 to put the cursor to a specific line in the
6807 document by clicking at the respective position in the DVI/PDF output.
6808 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6810 This is done via the \SpecialChar LyX
6811 server either by using the named pipe (
6815 ), or the UNIX domain socket (
6819 ) that \SpecialChar LyX
6820 creates in its temporary directory (this is the way the
6821 \begin_inset Flex Code
6824 \begin_layout Plain Layout
6830 program communicates with \SpecialChar LyX
6832 In some cases, you need a helper script that mediates between the viewer
6833 and \SpecialChar LyX
6834 , in others, the viewer can communicate with \SpecialChar LyX
6836 This depends on the selected viewer and on your operating system.
6837 The same applies to the way viewers need to be configured and the way the
6838 reverse search is actually performed.
6839 In what follows, we will thus describe how to setup reverse search for
6841 Before we turn to this, though, we will explain what needs to be done generally
6842 to enable reverse search in the DVI/PDF output.
6845 \begin_layout Subsection
6847 \begin_inset CommandInset label
6849 name "subsec:rev-search"
6856 \begin_layout Standard
6857 In most cases \SpecialChar LyX
6858 will do the work for you by enabling the option
6859 \begin_inset Flex Noun
6862 \begin_layout Plain Layout
6863 Synchronize with Output
6869 \begin_inset Flex Noun
6872 \begin_layout Plain Layout
6873 Document\SpecialChar menuseparator
6874 Settings\SpecialChar menuseparator
6881 In such a case \SpecialChar LyX
6882 will automatically insert the necessary Sync\SpecialChar TeX
6884 PDF) or load the srcltx package (for DVI) respectively.
6885 This option can be easily reached also on
6886 \begin_inset Flex Code
6889 \begin_layout Plain Layout
6898 \begin_layout Standard
6899 If you need a different setting, you can select or input a custom macro
6900 from the drop down box just below
6901 \begin_inset Flex Noun
6904 \begin_layout Plain Layout
6905 Document\SpecialChar menuseparator
6906 Settings\SpecialChar menuseparator
6907 Output\SpecialChar menuseparator
6908 Synchronize with Output
6916 \begin_layout Standard
6917 Note that the method
6918 \begin_inset Flex Code
6921 \begin_layout Plain Layout
6929 enables gzip compression.
6930 If your viewer does not support it, you should instead use
6931 \begin_inset Flex Code
6934 \begin_layout Plain Layout
6945 \begin_layout Standard
6946 Please also note that including the
6947 \begin_inset Flex Code
6950 \begin_layout Plain Layout
6957 \begin_inset Flex Code
6960 \begin_layout Plain Layout
6966 sometimes has an undesired impact on the typesetting.
6967 Thus, you should switch output synchronization off for the final typesetting
6969 \begin_inset Flex Code
6972 \begin_layout Plain Layout
6979 \begin_inset Flex Code
6982 \begin_layout Plain Layout
6992 \begin_layout Standard
6993 In case you need some more special settings that are not covered by the
6994 automatic settings, read the next section about how to set up output synchroniz
6996 If the automatic setup suits your needs, you can readily jump to section
6997 \begin_inset space ~
7001 \begin_inset CommandInset ref
7003 reference "subsec:configuring-viewers"
7007 , where the necessary configuration steps in your viewer – needed both with
7008 the automatic and the manual setup – are described.
7011 \begin_layout Subsection
7015 \begin_layout Standard
7017 provides several different methods for reverse search.
7018 Some are built-in in the
7019 \begin_inset Flex Code
7022 \begin_layout Plain Layout
7028 program, some are provided by external packages.
7029 Your choice depends on whether your \SpecialChar LaTeX
7030 distribution already provides a given
7031 method (the built-in methods are rather new) and whether your viewer can
7033 The available methods are described in the following.
7036 \begin_layout Subsubsection*
7037 Built-in DVI-search via src-specials (DVI only)
7040 \begin_layout Standard
7041 This method provides the DVI file with the necessary information for reverse
7043 It is available in \SpecialChar LaTeX
7044 since quite some time (any somewhat recent \SpecialChar LaTeX
7046 should include it), and it works reliably.
7047 To enable it, change the
7048 \begin_inset Flex Noun
7051 \begin_layout Plain Layout
7062 \begin_inset Flex Noun
7065 \begin_layout Plain Layout
7076 \begin_inset Flex Noun
7079 \begin_layout Plain Layout
7080 Preferences\SpecialChar menuseparator
7081 File Handling\SpecialChar menuseparator
7088 \begin_inset Flex Code
7091 \begin_layout Plain Layout
7092 latex -src-specials $$i
7098 If this doesn't work, check if your \SpecialChar TeX
7099 engine needs different options (the
7100 syntax might differ in some distributions).
7103 \begin_layout Subsubsection*
7104 External Packages (PDFSync and scrltx)
7107 \begin_layout Standard
7116 provide reverse search facility for PDF output (via pdflatex) and DVI output,
7118 In order to enable it, load the packages in the \SpecialChar LyX
7122 \begin_layout Itemize
7123 \begin_inset Flex Code
7126 \begin_layout Plain Layout
7134 for reverse PDF search,
7137 \begin_layout Itemize
7138 \begin_inset Flex Code
7141 \begin_layout Plain Layout
7144 usepackage[active]{srcltx}
7149 for reverse DVI search.
7152 \begin_layout Standard
7153 If you want to be able to perform both DVI and PDF reverse searches, you
7154 can also insert in the preamble the following lines
7157 \begin_layout LyX-Code
7161 \begin_inset Newline newline
7167 \begin_inset Newline newline
7173 \begin_inset Newline newline
7179 \begin_inset Newline newline
7184 usepackage[active]{srcltx}
7185 \begin_inset Newline newline
7193 \begin_layout Standard
7194 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7195 right package will be used.
7198 \begin_layout Standard
7199 Note that PDFSync might affect the output layout of your document.
7200 It is therefore advised to disable PDFsync for final documents.
7203 \begin_layout Subsubsection*
7204 Built-in reverse search via Sync\SpecialChar TeX
7208 \begin_layout Standard
7210 \begin_inset Flex Code
7213 \begin_layout Plain Layout
7219 have built-in support for both PDF and DVI reverse search.
7222 Sync\SpecialChar TeX
7225 facility is basically the result of the integration of the PDFSync package
7226 to the pdftex program and its merge with the
7231 You need at least \SpecialChar TeX
7232 Live 2008 or a recent Mik\SpecialChar TeX
7233 distribution in order to use
7238 \begin_layout Plain Layout
7239 For some reason, Mik\SpecialChar TeX
7240 does not understand/obey the command \SpecialChar LyX
7242 the preamble when you check the "Enable Forward/Reverse Search" button
7243 in the toolbar and does not generate the necessary info.
7246 \begin_layout Plain Layout
7247 The generation of the required info can be forced by changing the converter
7249 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7250 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7251 the -synctex=1 switch).
7256 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
7257 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
7261 \begin_layout Standard
7262 To enable Sync\SpecialChar TeX
7263 for DVI output, change the
7264 \begin_inset Flex Noun
7267 \begin_layout Plain Layout
7278 \begin_inset Flex Noun
7281 \begin_layout Plain Layout
7292 \begin_inset Flex Noun
7295 \begin_layout Plain Layout
7296 Preferences\SpecialChar menuseparator
7297 File Handling\SpecialChar menuseparator
7304 \begin_inset Flex Code
7307 \begin_layout Plain Layout
7308 latex -synctex=1 $$i
7313 , and for PDF output, change the
7314 \begin_inset Flex Noun
7317 \begin_layout Plain Layout
7322 (pdflatex) -> PDF (pdflatex)
7328 \begin_inset Flex Code
7331 \begin_layout Plain Layout
7332 pdflatex -synctex=1 $$i
7338 Check the documentation of your viewer whether the viewer needs to be configure
7339 d for the use with Sync\SpecialChar TeX
7344 \begin_layout Plain Layout
7345 Note that the option
7346 \begin_inset Flex Code
7349 \begin_layout Plain Layout
7355 option enables gzip compression.
7356 If your viewer does not support it, you should instead use
7357 \begin_inset Flex Code
7360 \begin_layout Plain Layout
7374 \begin_layout Subsection
7375 Configuring and using specific viewers
7376 \begin_inset CommandInset label
7378 name "subsec:configuring-viewers"
7385 \begin_layout Subsubsection*
7386 Xdvi (all platforms)
7389 \begin_layout Standard
7391 \begin_inset Flex Code
7394 \begin_layout Plain Layout
7400 , you don't need to do anything else for performing a reverse DVI search,
7402 already provides the necessary hooks for automatically using the
7403 \begin_inset Flex Code
7406 \begin_layout Plain Layout
7413 Just setup your document as described above (reverse search is triggered
7414 by Ctrl-click or Alt-click on Mac OSX, respectively).
7417 \begin_layout Standard
7418 However, if for whatever reason you want to use the named pipe instead of
7419 the socket for communicating with \SpecialChar LyX
7420 , simply change the DVI viewer in
7421 \begin_inset Flex Noun
7424 \begin_layout Plain Layout
7425 Preferences\SpecialChar menuseparator
7426 File Handling\SpecialChar menuseparator
7436 \begin_layout Plain Layout
7437 On Mac OSX you have to use
7438 \begin_inset Flex Code
7441 \begin_layout Plain Layout
7442 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7453 \begin_inset Flex Code
7456 \begin_layout Plain Layout
7457 xdvi -editor "lyxeditor.sh %f %l"
7463 \begin_inset Flex Code
7466 \begin_layout Plain Layout
7472 is a suitable script.
7473 For example, a minimal shell script is the following one:
7476 \begin_layout LyX-Code
7478 \begin_inset Newline newline
7481 LYXPIPE="/path/to/lyxpipe"
7482 \begin_inset Newline newline
7485 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7486 \begin_inset Newline newline
7489 echo "$COMMAND" > "${LYXPIPE}".in || exit
7490 \begin_inset Newline newline
7493 read TMP < "${LYXPIPE}".out || exit
7496 \begin_layout Standard
7498 \begin_inset Flex Code
7501 \begin_layout Plain Layout
7507 is the LyXServer pipe path specified in
7508 \begin_inset Flex Noun
7511 \begin_layout Plain Layout
7512 Preferences\SpecialChar menuseparator
7522 \begin_layout Plain Layout
7524 \begin_inset Flex Code
7527 \begin_layout Plain Layout
7533 folder of a source distribution you can find a
7534 \begin_inset Flex Code
7537 \begin_layout Plain Layout
7543 script which is able to locate the
7547 based on your preferences.
7555 \begin_layout Subsubsection*
7559 \begin_layout Standard
7561 \begin_inset Flex Code
7564 \begin_layout Plain Layout
7565 /Applications/MacDviX_Folder/calleditor.script
7570 , add the following lines:
7573 \begin_layout LyX-Code
7574 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7575 \begin_inset Newline newline
7581 \begin_layout Standard
7582 Modify the lines accordingly if you install \SpecialChar LyX
7583 somewhere else than in the
7584 Applications folder.
7587 \begin_layout Standard
7588 Reverse search is triggered by Alt-click (OPTION-click).
7591 \begin_layout Subsubsection*
7595 \begin_layout Standard
7597 \begin_inset Flex Code
7600 \begin_layout Plain Layout
7601 open -a Skim.app $$i
7606 to the viewer setting in
7607 \begin_inset Flex Noun
7610 \begin_layout Plain Layout
7611 Preferences\SpecialChar menuseparator
7612 File Handling\SpecialChar menuseparator
7613 File formats\SpecialChar menuseparator
7620 \begin_inset Flex Noun
7623 \begin_layout Plain Layout
7624 Skim\SpecialChar menuseparator
7625 Preferences\SpecialChar menuseparator
7632 \begin_inset Flex Noun
7635 \begin_layout Plain Layout
7641 preset and enter command
7642 \begin_inset Flex Noun
7645 \begin_layout Plain Layout
7646 /Applications/\SpecialChar LyX
7647 .app/Contents/MacOS/lyxeditor
7655 \begin_layout Standard
7656 Reverse search is triggered by COMMAND-SHIFT-click
7659 \begin_layout Subsubsection*
7663 \begin_layout Standard
7665 \begin_inset Flex Noun
7668 \begin_layout Plain Layout
7669 Settings\SpecialChar menuseparator
7670 Configure Okular\SpecialChar menuseparator
7677 \begin_inset Quotes eld
7681 \begin_inset Quotes erd
7685 \begin_inset Flex Code
7688 \begin_layout Plain Layout
7697 \begin_layout Standard
7698 Reverse search is triggered by SHIFT-click.
7701 \begin_layout Subsubsection*
7705 \begin_layout Standard
7706 Qpdfview supports Sync\SpecialChar TeX
7707 since version 0.3.5.
7709 \begin_inset Flex Noun
7712 \begin_layout Plain Layout
7713 Edit\SpecialChar menuseparator
7714 Settings\SpecialChar menuseparator
7720 , click on the input field of the
7721 \begin_inset Quotes eld
7725 \begin_inset Quotes erd
7728 item and add the command
7729 \begin_inset Flex Code
7732 \begin_layout Plain Layout
7741 \begin_layout Standard
7742 Reverse search is triggered by double-click or, in more recent versions,
7746 \begin_layout Subsubsection*
7750 \begin_layout Standard
7751 Launch yap, choose its
7752 \begin_inset Flex Noun
7755 \begin_layout Plain Layout
7756 View\SpecialChar menuseparator
7763 \begin_inset Quotes eld
7767 \begin_inset Quotes erd
7772 \begin_inset Quotes eld
7775 New\SpecialChar ldots
7777 \begin_inset Quotes erd
7780 button and, in the window that opens, enter
7781 \begin_inset Quotes eld
7786 \begin_inset Quotes erd
7789 (or any other name you like) in the
7790 \begin_inset Quotes eld
7794 \begin_inset Quotes erd
7798 Now click on the button labeled
7799 \begin_inset Quotes eld
7804 \begin_inset Quotes erd
7807 to open a file dialog and navigate to the directory containing the batch
7809 \begin_inset Flex Code
7812 \begin_layout Plain Layout
7820 \begin_inset Flex Code
7823 \begin_layout Plain Layout
7829 and then specify the program arguments as
7830 \begin_inset Flex Code
7833 \begin_layout Plain Layout
7841 \begin_inset Flex Code
7844 \begin_layout Plain Layout
7850 wrapper is used for communicating with \SpecialChar LyX
7858 \begin_layout LyX-Code
7860 \begin_inset Newline newline
7863 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7872 \begin_inset Newline newline
7886 \begin_layout Standard
7887 Make sure that the \SpecialChar LyX
7888 Server pipe path you specified in \SpecialChar LyX
7890 \begin_inset Flex Code
7893 \begin_layout Plain Layout
7907 , otherwise change the
7908 \begin_inset Flex Code
7911 \begin_layout Plain Layout
7917 wrapper accordingly.
7920 \begin_layout Standard
7921 In yap, reverse search is triggered by double-click.
7924 \begin_layout Subsubsection*
7925 SumatraPDF (Windows)
7928 \begin_layout Standard
7929 In order to use SumatraPDF for inverse search, enter
7930 \begin_inset Flex Code
7933 \begin_layout Plain Layout
7934 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7939 in the viewer setting in
7940 \begin_inset Flex Noun
7943 \begin_layout Plain Layout
7944 Preferences\SpecialChar menuseparator
7945 File Handling\SpecialChar menuseparator
7946 File formats\SpecialChar menuseparator
7953 \begin_inset Flex Code
7956 \begin_layout Plain Layout
7962 is the previous wrapper.
7963 If SumatraPDF.exe is not in your command PATH, use its full file name.
7966 \begin_layout Standard
7967 Reverse search is triggered by double-click.
7970 \begin_layout Subsubsection*
7974 \begin_layout Standard
7975 First of all, make sure that yap is your default DVI viewer in the Windows
7976 environment, then launch it, choose its
7977 \begin_inset Flex Noun
7980 \begin_layout Plain Layout
7981 View\SpecialChar menuseparator
7988 \begin_inset Quotes eld
7992 \begin_inset Quotes erd
7997 \begin_inset Quotes eld
8000 New\SpecialChar ldots
8002 \begin_inset Quotes erd
8005 button and, in the window that opens, enter
8006 \begin_inset Quotes eld
8011 \begin_inset Quotes erd
8014 (or any other name you like) in the
8015 \begin_inset Quotes eld
8019 \begin_inset Quotes erd
8023 Now click on the button labeled
8024 \begin_inset Quotes eld
8029 \begin_inset Quotes erd
8032 to open a file dialog and navigate to the directory containing the
8033 \begin_inset Flex Code
8036 \begin_layout Plain Layout
8042 program (which is installed by default on Cygwin along with the \SpecialChar LyX
8045 \begin_inset Flex Code
8048 \begin_layout Plain Layout
8054 and then specify the program arguments as
8055 \begin_inset Flex Code
8058 \begin_layout Plain Layout
8065 In this way, you will be using the
8069 for communicating with \SpecialChar LyX
8071 If, for whatever reason, you want to use the
8076 \begin_inset Flex Code
8079 \begin_layout Plain Layout
8085 option and be sure to specify the \SpecialChar LyX
8086 Server pipe path in the \SpecialChar LyX
8090 \begin_layout Standard
8091 In yap, reverse search is triggered by double-click.
8094 \begin_layout Subsubsection*
8098 \begin_layout Standard
8099 In order to use SumatraPDF for inverse search, enter
8100 \begin_inset Flex Code
8103 \begin_layout Plain Layout
8104 SumatraPDF -inverse-search "lyxeditor -g %f %l"
8109 in the viewer setting in
8110 \begin_inset Flex Noun
8113 \begin_layout Plain Layout
8114 Preferences\SpecialChar menuseparator
8115 File Handling\SpecialChar menuseparator
8116 File formats\SpecialChar menuseparator
8123 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8125 \begin_inset Flex Code
8128 \begin_layout Plain Layout
8134 enables communication via the
8140 \begin_inset Flex Code
8143 \begin_layout Plain Layout
8149 option if you want to use the
8153 , and be sure to specify the \SpecialChar LyX
8154 Server pipe path in the \SpecialChar LyX
8158 \begin_layout Standard
8159 Reverse search is triggered by double-click.
8162 \begin_layout Section
8166 \begin_layout Standard
8167 Forward search is, as the name implies, in a sense the
8168 \begin_inset Quotes eld
8172 \begin_inset Quotes erd
8176 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8178 If forward search is set up (as described in what follows), you can put
8179 the cursor anywhere in your \SpecialChar LyX
8181 \begin_inset Flex Noun
8184 \begin_layout Plain Layout
8185 Navigate\SpecialChar menuseparator
8192 \begin_inset Flex Noun
8195 \begin_layout Plain Layout
8201 in the context menu via right mouse click), and then the viewer will jump
8202 to that position as well.
8203 This implies, of course, that your viewer supports this function.
8206 \begin_layout Standard
8207 To make forward search possible, you first need to provide the generated
8208 output PDF/DVI file with additional information about the \SpecialChar TeX
8210 This can be done via the methods described in the section
8211 \begin_inset CommandInset ref
8213 reference "subsec:rev-search"
8220 \begin_layout Standard
8221 Additionally, you need to configure \SpecialChar LyX
8222 for using your viewers in
8223 \begin_inset Flex Noun
8226 \begin_layout Plain Layout
8227 Tools\SpecialChar menuseparator
8228 Preferences\SpecialChar menuseparator
8229 Output\SpecialChar menuseparator
8236 We provide a range of tested configurations for some viewers, which you
8237 can select from the drop down list.
8238 If none of these configurations suits you, you have to find out and enter
8239 a suitable configuration yourself.
8240 The definition syntax uses the following placeholders:
8243 \begin_layout Itemize
8245 \begin_inset Flex Code
8248 \begin_layout Plain Layout
8257 \begin_layout Itemize
8259 \begin_inset Flex Code
8262 \begin_layout Plain Layout
8268 : name of the (temporary) exported .tex file (without path)
8271 \begin_layout Itemize
8273 \begin_inset Flex Code
8276 \begin_layout Plain Layout
8282 : name of the (temporary) exported .tex file (including path)
8285 \begin_layout Itemize
8287 \begin_inset Flex Code
8290 \begin_layout Plain Layout
8296 : name of the exported output file (either dvi or pdf, depending on which
8297 one exists in the temporary directory)
8300 \begin_layout Standard
8301 Note that only some of the viewers provide full forward search functionality,
8302 among them yap, xdvi, okular
8306 \begin_layout Plain Layout
8307 You might want to set
8308 \begin_inset Flex Code
8311 \begin_layout Plain Layout
8318 \begin_inset Flex Noun
8321 \begin_layout Plain Layout
8322 Tools\SpecialChar menuseparator
8323 Preferences\SpecialChar menuseparator
8324 File Handling\SpecialChar menuseparator
8326 \begin_inset space ~
8339 , qpdfview and SumatraPDF
8343 \begin_layout Plain Layout
8344 SumatraPDF can also use DDE commands through the external program CMCDDE
8346 \begin_inset CommandInset href
8348 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8359 While many of the widespread PDF viewers (most notably Adobe Reader) do
8360 not support forward search at all, some other viewers – e.
8361 \begin_inset space \thinspace{}
8365 evince and xpdf – allow at least to reload the document and jump to a specific
8366 page of the file, so you can at least navigate
8367 \begin_inset Quotes eld
8371 \begin_inset Quotes erd
8375 This latter functionality is provided by an external call of synctex (see
8376 the predefined example configurations).
8380 \begin_layout Standard
8381 Forward search works both with DVI and PDF output.
8383 simply checks which preview format you have used before (i.
8384 \begin_inset space \thinspace{}
8387 e., which format is already there in the temporary directory) and chooses
8388 the appropriate configuration for the respective format.
8391 \begin_layout Chapter
8392 Special Document Classes
8395 \begin_layout Section
8399 \begin_layout Standard
8405 \begin_layout Subsection
8409 \begin_layout Standard
8410 This section describes how \SpecialChar LyX
8411 can be used to write articles for submission
8412 to the scientific journal
8414 Astronomy and Astrophysics
8417 \begin_inset Flex URL
8420 \begin_layout Plain Layout
8422 http://www.edpsciences.fr/aa/
8427 ) using Version 5.01 of the document class
8432 This package can be downloaded from the ftp site
8435 \begin_layout Standard
8436 \begin_inset VSpace medskip
8442 \begin_layout Standard
8444 \begin_inset Flex URL
8447 \begin_layout Plain Layout
8449 ftp://ftp.edpsciences.org/pub/aa/readme.html
8457 \begin_layout Standard
8458 \begin_inset VSpace medskip
8464 \begin_layout Standard
8465 A manual comes together with that package, and this text is not meant to
8466 replace the original manual but is merely a short guide in how to realize
8467 the correct form of your paper.
8471 \begin_layout Standard
8472 Please note that the publisher of the journal was changed from Springer
8473 to EDP Sciences starting January 1, 2001.
8474 That change involved also some slight changes to the style files, namely
8475 the removal of the thesaurus command.
8476 The \SpecialChar LyX
8477 class aa supports the newest version of these style files, V 5.01.
8478 If you have an older version installed, please upgrade.
8479 For compatibility, the old (version 4) layout has been kept as
8484 Please refer to the comments in
8487 Dir/layouts/aapaper.layout
8492 \begin_layout Subsection
8496 \begin_layout Standard
8497 It is recommended you start from the example template distributed with \SpecialChar LyX
8499 If you are not using a template, note the following settings:
8502 \begin_layout Itemize
8509 Document\SpecialChar menuseparator
8512 dialog (OK, that one was obvious).
8515 \begin_layout Itemize
8516 Don't change the option
8519 \begin_inset space ~
8529 The whole layout is done by the macros, you shouldn't change anything.
8532 \begin_layout Subsection
8536 \begin_layout Standard
8537 First thing to enter is the header information.
8538 It consists of seven entries, of which some are optional.
8542 \begin_layout Itemize
8550 \begin_layout Itemize
8558 \begin_layout Itemize
8566 \begin_layout Itemize
8574 \begin_layout Itemize
8579 : [optional] if more than one author: whom to contact for offprint requests.
8582 \begin_layout Itemize
8587 : [optional] mail address for contacts.
8590 \begin_layout Itemize
8598 Received: <date>; Accepted <date>
8601 \begin_layout Standard
8602 There is no need to issue the
8608 command, this is done automatically by \SpecialChar LyX
8609 when the header is finished.
8610 Although the order of the single header entries doesn't matter it is advised
8611 to keep the above sequence, just to get the best optics and meets the layout
8612 of the real document.
8615 \begin_layout Standard
8616 If you want to place footnotes in the header block, e.
8617 \begin_inset space \thinspace{}
8621 \begin_inset space \space{}
8624 to state your present address, just use the standard footnote via the menu
8627 Insert\SpecialChar menuseparator
8632 will automagically use the term
8641 \begin_layout Standard
8642 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8644 have no counterpart in \SpecialChar LyX
8648 \begin_layout Itemize
8655 to separate different names for more than one author and institute, respectivel
8659 \begin_layout Itemize
8666 to mark corresponding author/institute pairs.
8667 The institutes are numbered sequentially as they appear in the
8671 field, so you have to put a marker to each author.
8674 \begin_layout Itemize
8681 to supply an email address for fast contact.
8684 \begin_layout Standard
8685 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8693 \begin_layout Subsection
8697 \begin_layout Standard
8698 The abstract should immediately follow the header block.
8699 With version 5 the abstract environment was changed to a command, and there
8700 is now a resctriction to only one paragraph.
8701 In addition, it should contain an entry with the keywords.
8702 This is not yet implemented for \SpecialChar LyX
8703 , therefore you have to enter the \SpecialChar LaTeX
8711 by hand and mark it as \SpecialChar LaTeX
8713 Refer to the example paper.
8716 \begin_layout Subsection
8717 Supported environments
8720 \begin_layout Standard
8721 The A&A paper layout supports the following environments for structuring
8725 \begin_layout Itemize
8731 \begin_layout Itemize
8737 \begin_layout Itemize
8743 \begin_layout Itemize
8749 \begin_layout Itemize
8755 \begin_layout Itemize
8761 \begin_layout Itemize
8767 \begin_layout Itemize
8773 \begin_layout Itemize
8779 \begin_layout Itemize
8785 \begin_layout Itemize
8791 \begin_layout Itemize
8798 \begin_layout Subsection
8799 Commands not supported by \SpecialChar LyX
8803 \begin_layout Standard
8804 Some commands are not yet supported by the
8808 layout for \SpecialChar LyX
8810 Some have already been mentioned.
8811 For the sake of completeness, they are listed all together here:
8814 \begin_layout Itemize
8822 \begin_layout Itemize
8830 \begin_layout Itemize
8838 \begin_layout Itemize
8846 \begin_layout Itemize
8854 \begin_layout Itemize
8862 \begin_layout Itemize
8870 \begin_layout Itemize
8878 \begin_layout Standard
8879 If you want to use any of these commands, you have to enter them yourself.
8882 Do not forget to mark them as \SpecialChar LaTeX
8886 \begin_layout Subsection
8887 Figure and Table Floats
8890 \begin_layout Standard
8892 provides support for the necessary float environments
8894 figure, figure*, table
8900 , therefore we won't tell much about it here.
8904 \begin_inset space ~
8910 Just remember that tables should be left-aligned.
8911 For that, select the table and change the alignment in
8913 Edit\SpecialChar menuseparator
8915 \begin_inset space ~
8921 \begin_layout Standard
8922 There is only one special thing: the figures with caption besides the figure.
8923 To create such a figure, you have to do the following:
8926 \begin_layout Enumerate
8927 Create a wide figure float:
8929 Insert\SpecialChar menuseparator
8930 Float\SpecialChar menuseparator
8933 , then right click in the figure and select
8936 \begin_inset space ~
8944 \begin_layout Enumerate
8945 Enter your caption text.
8948 \begin_layout Enumerate
8953 to move the cursor above the caption.
8956 \begin_layout Enumerate
8960 \begin_layout Enumerate
8961 Position the cursor behind the figure and insert a horizontal fill:
8963 Insert\SpecialChar menuseparator
8965 \begin_inset space ~
8968 Character\SpecialChar menuseparator
8970 \begin_inset space ~
8978 \begin_layout Enumerate
8979 Switch to \SpecialChar LaTeX
8983 \begin_inset space ~
8991 \begin_layout Enumerate
9001 Do not close the brace!
9004 \begin_layout Enumerate
9005 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
9010 \begin_inset space ~
9022 \begin_layout Standard
9023 Also, refer to the figures in the example paper.
9026 \begin_layout Subsection
9030 \begin_layout Standard
9031 For submission, the paper has to be formated in a special double-spacing
9033 For this purpose, you have to give the option
9037 to the documentclass.
9038 This must be done using the extra class options field in the
9040 Document\SpecialChar menuseparator
9044 Just enter the string
9051 \begin_layout Subsection
9055 \begin_layout Standard
9060 directory contains an example paper written with \SpecialChar LyX
9062 It is the example paper from the original macro package, translated to
9065 Use it for inspiration, and compare the original \SpecialChar LaTeX
9066 code with \SpecialChar LyX
9070 \begin_layout Section
9075 \begin_layout Standard
9081 \begin_layout Subsection
9085 \begin_layout Standard
9087 is a set of macros produced by the American Astronomical Society to
9088 facilitate electronic manuscript submission to the three journals they
9089 publish: the Astrophysical Journal (including the Letters and Supplement),
9090 the Astronomical Journal, and the Publications of the Astronomical Society
9093 has proven to be an excellent tool for generating these documents, especially
9094 given its equation, citation, and figure handling capabilities.
9096 requires version 5.0 (or higher) of these macros; preferably 5.2, which
9097 is the version described here, or higher.
9098 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9099 2.09 and are fundamentally
9100 incompatible with \SpecialChar LyX
9102 The AAS\SpecialChar TeX
9103 package may be downloaded from the AAS\SpecialChar TeX
9107 \begin_layout Standard
9108 \begin_inset VSpace medskip
9114 \begin_layout Standard
9116 \begin_inset Flex URL
9119 \begin_layout Plain Layout
9121 https://aas.org/aastex/aastex-downloads
9129 \begin_layout Standard
9130 \begin_inset VSpace medskip
9136 \begin_layout Standard
9137 A complete user guide is contained in that package and you should familiarize
9138 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9141 will not reduce the need to figure out all the AAS\SpecialChar TeX
9142 commands, it will only
9143 reduce the drudgery of typing everything in.
9144 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9146 completely to the requirements of the journal to which you are submitting
9150 \begin_layout Subsection
9151 Starting a New Paper
9154 \begin_layout Standard
9155 I strongly suggest that you start with the AAS\SpecialChar TeX
9159 File\SpecialChar menuseparator
9166 , enter the new file name, then choose the
9171 This will show the most common fields found in a manuscript.
9172 Simply overwrite the existing text (including the brackets,
9176 ) with the correct information.
9177 Many of the AAS\SpecialChar TeX
9178 commands and environments can be implemented directly in
9180 , but some cannot: most noticeably
9192 , which should stick out like a sore thumb if you actually just opened the
9194 For commands such as these, the \SpecialChar LaTeX
9195 code must be entered directly and marked
9197 Such commands are referred to as \SpecialChar TeX
9198 code, or Evil Red Text.
9199 I tried to minimize the amount of \SpecialChar TeX
9200 code needed in an AAS\SpecialChar TeX
9202 there is still a bit more required than any of us would like.
9205 \begin_layout Subsection
9206 Finishing Your Paper
9209 \begin_layout Standard
9210 When the paper is finished to your satisfaction and previews/prints correctly,
9212 \begin_inset Quotes eld
9216 \begin_inset Quotes erd
9219 actions which need to be done before you submit it to the journals.
9223 \begin_layout Enumerate
9224 Export your paper as a \SpecialChar LaTeX
9227 File\SpecialChar menuseparator
9228 Export\SpecialChar menuseparator
9236 \begin_layout Enumerate
9241 file with your favorite text editor
9245 \begin_layout Enumerate
9246 remove the comment lines before the
9255 \begin_layout Enumerate
9260 usepackage...{fontenc}
9262 line if it appears (usually just after
9277 \begin_layout Enumerate
9278 remove everything between (and including) the
9290 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9292 (which should appear immediately after the
9293 \begin_inset Quotes eld
9296 User specified \SpecialChar LaTeX
9298 \begin_inset Quotes erd
9309 \begin_layout Enumerate
9310 Run the resulting file through \SpecialChar LaTeX
9311 to make sure it still processes correctly.
9314 \begin_layout Enumerate
9315 Reread the journal requirements to make sure your filenames and formats
9319 \begin_layout Enumerate
9323 \begin_layout Subsection
9324 Comments On Specific Commands
9327 \begin_layout Standard
9328 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9335 ) gives a good description of each.
9336 Thus it's probably easiest for me to go down the list as found in the guide
9337 and offer comments where necessary.
9338 So let's begin \SpecialChar ldots
9342 \begin_layout Subsubsection
9343 Things that work as expected
9346 \begin_layout Standard
9347 Because they work as you might expect, I simply list them and the section
9448 begin{thebibliography}
9456 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9457 graphicx figure commands (2.14.1),
9481 (2.15.4, amongst other places),
9508 \begin_layout Standard
9509 The following style options also work correctly:
9530 Simply put them in the
9536 Layout\SpecialChar menuseparator
9542 \begin_layout Subsubsection
9543 Things that work, but require more comment
9546 \begin_layout Standard
9547 The following items work, but require a little more discussion:
9550 \begin_layout Itemize
9551 These items are reserved for use by the journal editors, but you can put
9552 them into the \SpecialChar LaTeX
9553 preamble if you feel compelled to do so:
9586 \begin_layout Itemize
9587 These items may be placed in the \SpecialChar LaTeX
9588 preamble, and are included as blanks in
9610 \begin_layout Itemize
9617 (2.3) – can only be used
9618 \begin_inset Quotes eld
9622 \begin_inset Quotes erd
9625 , not in the middle of a paragraph.
9626 Use \SpecialChar TeX
9627 code if you need to embed it.
9630 \begin_layout Itemize
9637 (2.3) – will have extra {} after it.
9638 This should not cause an error.
9641 \begin_layout Itemize
9648 (2.6) – can only be used
9649 \begin_inset Quotes eld
9653 \begin_inset Quotes erd
9656 , not in the middle of a paragraph.
9657 Use \SpecialChar TeX
9658 code if you need to embed it.
9661 \begin_layout Itemize
9668 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9672 \begin_layout Itemize
9686 \begin_layout Itemize
9693 (2.9) – will have extra {} after it.
9694 This should not cause an error.
9697 \begin_layout Itemize
9704 (2.11) – will have extra {} after it.
9705 This should not cause an error.
9708 \begin_layout Itemize
9715 (2.14.2) – you can insert an optional filename argument by placing the cursor
9716 at the beginning of the text and selecting
9718 Insert\SpecialChar menuseparator
9723 \begin_inset Quotes eld
9727 \begin_inset Quotes erd
9730 inserts an optional argument of the type needed by
9737 Hopefully it will be renamed someday.
9740 \begin_layout Itemize
9753 for the catalog ID optional parameter
9756 \begin_layout Itemize
9769 for the catalog ID optional parameter
9772 \begin_layout Subsubsection
9773 Things not implemented, use \SpecialChar TeX
9777 \begin_layout Standard
9800 setcounter{equation}
9802 (2.12), Journal name abbreviations (2.13.4),
9838 (2.15.4, insert it as the first element in the lefthand cell after where
9840 Don't use any of \SpecialChar LyX
9841 's rules in the table),
9853 (2.15.5), much of Misc (2.17, except
9904 \begin_layout Subsubsection
9905 Things that cannot be implemented
9908 \begin_layout Standard
9910 at least in any meaningful sort of way, so I suggest ignoring them.
9911 They are the references environment (2.13.3), and the deluxetable environment
9913 If you really, really need to use deluxetable, I suggest editing it in
9914 a separate file with a text editor, then using
9916 Insert\SpecialChar menuseparator
9918 \begin_inset space ~
9923 to include it in your \SpecialChar LyX
9929 file to see an example of this.
9932 \begin_layout Subsection
9933 FAQs, Tips, Tricks, and Other Ruminations
9936 \begin_layout Subsubsection
9937 Getting \SpecialChar LyX
9938 and AAS\SpecialChar TeX
9942 \begin_layout Standard
9943 It can be a bit tricky to get \SpecialChar LyX
9944 to recognize a new layout and document class.
9945 When all else fails, do this:
9948 \begin_layout Enumerate
9949 Make certain that \SpecialChar LaTeX
9950 can find AAS\SpecialChar TeX
9952 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9954 directory completely unrelated to \SpecialChar LaTeX
9955 or AAS\SpecialChar TeX
9956 and run \SpecialChar LaTeX
9964 \begin_layout Enumerate
9969 appears in \SpecialChar LyX
9977 \begin_layout Enumerate
9980 Tools\SpecialChar menuseparator
9984 , then restart \SpecialChar LyX
9988 \begin_layout Enumerate
9989 Open a regular new file, not from a template.
9990 Does AAS\SpecialChar TeX
9991 appear in the class list in
9993 Document\SpecialChar menuseparator
9999 \begin_layout Standard
10000 If you get a warning from an existing AAS\SpecialChar TeX
10001 document about not being able
10002 to find the AAS\SpecialChar TeX
10003 layout or a message about
10004 \begin_inset Quotes eld
10007 You should not mix title layouts with normal ones
10008 \begin_inset Quotes erd
10011 , things haven't been installed correctly.
10014 \begin_layout Subsubsection
10016 error processing a table
10019 \begin_layout Standard
10021 , by default, attempts to center the table caption/title.
10022 This seems to produce a bad interaction in AAS\SpecialChar TeX
10023 so you should click somewhere
10024 in the caption/title, then select
10026 Edit\SpecialChar menuseparator
10028 \begin_inset space ~
10042 This took care of it for me.
10045 \begin_layout Subsubsection
10049 \begin_layout Standard
10050 A couple of things: 1) I have noticed some funny spacing in the reference
10051 entries in the text.
10052 When you enter the bibliography item data, make sure their is
10056 space between the last author and the parenthesis setting off the year;
10060 \begin_inset space \thinspace{}
10064 \begin_inset space \space{}
10078 2) Entering the references at all is not obvious.
10079 The easiest thing is to start typing your first reference at the end of
10080 the document, then mark it as type
10085 That will put a small gray box in front of what you just typed.
10086 Click on the box to fill in the rest of the information.
10087 For new references, go to the end of an existing reference and press return.
10088 That will create a new line with its own box, etc.
10091 \begin_layout Subsubsection
10092 Including EPS files
10095 \begin_layout Standard
10096 Even though AAS\SpecialChar TeX
10097 provides its own figure commands (
10103 , for example), I much prefer \SpecialChar LaTeX
10104 's standard figure commands (with the default
10113 \begin_inset space ~
10116 commands as \SpecialChar TeX
10117 code into a Figure Float box if you desire, but I never have
10118 much luck getting the layout right.
10119 With the standard graphics, \SpecialChar LyX
10124 usepackage{graphicx}
10126 command into the \SpecialChar LaTeX
10127 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10129 interspersing the figures in the text.
10130 I believe ApJ accepts figures exactly this way now; AJ might still use
10132 \begin_inset Quotes eld
10135 stack everything at the end
10136 \begin_inset Quotes erd
10142 \begin_layout Subsubsection
10143 Things I could have done, but didn't
10146 \begin_layout Standard
10148 \begin_inset Quotes eld
10152 \begin_inset Quotes erd
10155 things I could have implemented, but chose not to.
10156 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10158 even though it is double-spaced in the paper manuscript.
10159 Also, I chose not to make separate layouts for the preprint and preprint2
10161 Since I assume you will spend most of your time in the plain manuscript
10162 mode anyway, I decided not to chew up more disk space with this.
10166 \begin_layout Subsection
10170 \begin_layout Standard
10171 Your mileage may vary.
10172 I've now had papers published by both ApJ and AJ that have had 98% of the
10173 effort done in \SpecialChar LyX
10174 ; the last 2% was the \SpecialChar LaTeX
10175 post-processing and a few cleanups.
10176 I have had no trouble with the submission process, and I'm sure the journals
10177 were never aware that there might be a difference.
10178 So, go forth and publish!
10181 \begin_layout Section
10182 AMS \SpecialChar LaTeX
10186 \begin_layout Standard
10196 \begin_layout Standard
10197 \begin_inset VSpace bigskip
10203 \begin_layout Standard
10205 The AMS \SpecialChar LaTeX
10206 layouts are set up to conform to suggested styles for mathematical
10207 papers to be submitted to American Mathematical Society publications.
10208 The layouts are not tailored to a specific journal, but easily can be.
10209 You should refer to the AMS documentation for specific instructions for
10210 each journal (usually it will entail only changing a single line in the
10213 That documentation is available on the Web at
10214 \begin_inset Flex URL
10217 \begin_layout Plain Layout
10225 \begin_inset Flex URL
10228 \begin_layout Plain Layout
10230 ftp://ftp.ams.org/pub/tex/amslatex/
10236 These layouts are appropriate, and useful, for any mathematical writing.
10240 \begin_layout Standard
10241 There are two basic AMS \SpecialChar LaTeX
10245 \begin_layout Itemize
10246 amsart: The standard AMS article format.
10249 \begin_layout Itemize
10250 amsbook: the standard AMS book (really, monograph) format.
10254 \begin_layout Standard
10255 The layouts themselves contain only the minimum necessary to use the AMS
10257 They do not, in particular, contain any of the `theorem' environments used
10258 for setting theorems, lemmas, and the like.
10259 These are contained, instead, in the
10260 \begin_inset Flex Code
10263 \begin_layout Plain Layout
10269 module, which is loaded by default when you select one of the AMS classes.
10270 (It can also be used with other classes and can be removed, if you would
10271 rather use something else.) Less commonly used environments are in the
10272 \begin_inset Flex Code
10275 \begin_layout Plain Layout
10276 Theorems (AMS-Extended)
10281 module, which must be loaded manually.
10284 \begin_layout Standard
10285 By default, theorems and the like are numbered consecutively throughout
10286 the document, but this may be modified by loading the module
10287 \begin_inset Flex Code
10290 \begin_layout Plain Layout
10291 Theorems (Order by Section)
10296 or, if you are using
10297 \begin_inset Flex Code
10300 \begin_layout Plain Layout
10307 \begin_inset Flex Code
10310 \begin_layout Plain Layout
10311 Theorems (Order by Chapter)
10317 These will number the results as
10318 \begin_inset Formula $n.m$
10321 , where the first number refers to the section (or chapter) and the second
10322 refers to the total number of results so far in that section (or chapter).
10323 Many environments are also available unnumbered.
10324 These are indicated by an asterisk at the end.
10325 If you happen to want
10329 unnumbered results, the module
10330 \begin_inset Flex Code
10333 \begin_layout Plain Layout
10339 provides that option.
10342 \begin_layout Standard
10343 Note that these modules do not
10347 to be used with the AMS classes.
10348 It is perfectly possible to use the
10349 \begin_inset Flex Code
10352 \begin_layout Plain Layout
10358 module, and the others mentioned, with other classes, such as
10359 \begin_inset Flex Code
10362 \begin_layout Plain Layout
10369 \begin_inset Flex Code
10372 \begin_layout Plain Layout
10379 \begin_inset Flex Code
10382 \begin_layout Plain Layout
10391 \begin_layout Subsection
10392 What these layouts provide
10395 \begin_layout Standard
10396 There is a long list of included environments provided by these layouts.
10397 In AMS-\SpecialChar LaTeX
10398 , there is, in fact, an opportunity to define an unlimited variety
10399 of `theorem' environments.
10400 However, the AMS recommends the environments that are available in \SpecialChar LyX
10405 \begin_layout Standard
10406 The following environments—as well as the standard environments, such as
10408 \begin_inset Flex Noun
10411 \begin_layout Plain Layout
10418 \begin_inset Flex Noun
10421 \begin_layout Plain Layout
10428 \begin_inset Flex Noun
10431 \begin_layout Plain Layout
10438 \begin_inset Flex Noun
10441 \begin_layout Plain Layout
10448 \begin_inset Flex Noun
10451 \begin_layout Plain Layout
10458 \begin_inset Flex Code
10461 \begin_layout Plain Layout
10468 \begin_inset Flex Code
10471 \begin_layout Plain Layout
10480 \begin_layout Description
10481 Address This should be the author's permanent address.
10484 \begin_layout Description
10486 \begin_inset space ~
10489 Address This should be the author's temporary address at the time of submission,
10490 if different from the Address.
10493 \begin_layout Description
10494 Email Author's e-mail address
10497 \begin_layout Description
10498 URL Author's Web address, if desired.
10501 \begin_layout Description
10502 Keywords Key words or phrases used to identify specific topics discussed
10506 \begin_layout Description
10507 Subjectclass These refer to the AMS Subject Classifications, published and
10510 Mathematical Reviews
10513 These are also available online at the AMS cites listed above.
10516 \begin_layout Description
10520 \begin_layout Description
10524 \begin_layout Description
10528 \begin_layout Standard
10529 The following environments are provided by both the
10530 \begin_inset Flex Code
10533 \begin_layout Plain Layout
10540 \begin_inset Flex Code
10543 \begin_layout Plain Layout
10549 modules, in the latter case in both starred (unnumbered) and unstarred
10550 (numbered) versions.
10551 These same environments are provided only in the starred versions by the
10553 \begin_inset Flex Code
10556 \begin_layout Plain Layout
10565 \begin_layout Theorem
10566 This is typically used for the statements of major results.
10570 \begin_layout Corollary*
10571 This is used for statements which follow fairly directly from previous statement
10573 Again, these can be major results.
10577 \begin_layout Lemma
10578 These are smaller results needed to prove other statements.
10581 \begin_layout Proposition
10582 These are less major results which (hopefully) add to the general theory
10586 \begin_layout Conjecture
10587 These are statements provided without justification, which the author does
10588 not know how to prove, but which seem to be true (to the author, at least).
10591 \begin_layout Definition*
10592 Guess what this is for.
10593 The font is different for this environment than for the previous ones.
10597 \begin_layout Example*
10598 Used for examples illustrating proven results.
10601 \begin_layout Problem
10602 It's not really known what this is for.
10603 You should figure it out.
10606 \begin_layout Exercise*
10607 Write a description for this one.
10610 \begin_layout Remark
10611 This environment is also a type of theorem, usually a lesser sort of observation.
10614 \begin_layout Claim*
10615 Often used in the course of giving a proof of a larger result.
10619 Generally, these are used to break up long arguments, using specific instances
10625 The numbering scheme for cases is on its own, not together with other numbered
10630 \begin_layout Proof
10631 At the end of this environment, a QED symbol (usually a square, but it can
10632 vary with different styles) is placed.
10633 If you want to have other environments within this one—for example, Case
10634 environments—and have the QED symbol appear only after them, then the other
10635 environments need to be nested within the proof environment.
10638 Nesting Environments
10644 for information on nesting.
10647 \begin_layout Standard
10648 And these environments are provided by
10649 \begin_inset Flex Code
10652 \begin_layout Plain Layout
10653 Theorems (AMS-Extended)
10661 \begin_layout Criterion*
10662 A required condition.
10665 \begin_layout Algorithm*
10666 A general procedure to be used.
10669 \begin_layout Axiom*
10670 This is a property or statement taken as true within the system being discussed.
10673 \begin_layout Condition*
10674 Sometimes used to state a condition assumed within the present context of
10678 \begin_layout Note*
10679 Similar to a Remark.
10682 \begin_layout Notation*
10683 Used for the explanation of, yes, notation.
10686 \begin_layout Summary
10687 Do we really need to tell you?
10690 \begin_layout Acknowledgement*
10694 \begin_layout Conclusion*
10695 Sometimes used at the end of a long train of argument.
10699 Used in a way similar to Proposition, though perhaps lower on the scale.
10702 \begin_layout Standard
10703 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10706 They need to be available on your system in order to use these environments.
10709 \begin_layout Section
10717 \begin_layout Standard
10723 \begin_layout Subsection
10727 \begin_layout Standard
10728 These are the layout files for some of the journals of the American Geophysical
10730 It is assumed that you have both the AGU's own class files and AGUplus
10731 installed (everything to be found at
10732 \begin_inset Flex URL
10735 \begin_layout Plain Layout
10737 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10745 \begin_layout Subsection
10749 \begin_layout Standard
10759 They are still called this in the \SpecialChar LyX
10760 GUI, though their \SpecialChar LaTeX
10773 \begin_layout Standard
10774 Newly defined styles are
10811 These are mostly manuscript attributes and defined in the AGU class documentati
10815 \begin_layout Standard
10816 I suspect this is still badly incomplete.
10819 \begin_layout Subsection
10823 \begin_layout Standard
10840 \begin_layout Subsection
10844 \begin_layout Itemize
10847 Journal of Geophysical Research
10856 \begin_layout Standard
10857 Add your own, it isn't so hard! Look at the
10868 \begin_layout Subsection
10869 Bugs and things to remember
10872 \begin_layout Standard
10873 In order to use the new layouts, you must remember to do the following for
10877 \begin_layout Enumerate
10883 This can be done in the
10885 Layout\SpecialChar menuseparator
10890 Document\SpecialChar menuseparator
10894 (AGU articles are always in English, right? So
10898 choose a language.)
10901 \begin_layout Enumerate
10906 into the document's
10911 (Yes, this is a bug.)
10914 \begin_layout Enumerate
10915 Make sure you use the
10919 bibliography style, by entering
10923 into the second field of the Bib\SpecialChar TeX
10925 None of the standard styles will do.
10928 \begin_layout Section
10932 \begin_layout Standard
10938 \begin_layout Subsection
10942 \begin_layout Standard
10943 Broadway is for writing plays.
10944 The format is more decorative than Hollywood, and much less standardized.
10945 This format should be suitable for workshops.
10948 \begin_layout Subsection
10952 \begin_layout Standard
10953 The same as in Hollywood.
10956 \begin_layout Subsection
10960 \begin_layout Standard
10965 names as labels then cross-reference the label to insert the name.
10966 The cross-reference dialog will show the current cast of characters.
10969 \begin_layout Subsection
10970 Paper size and Margins
10973 \begin_layout Standard
10974 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10977 \begin_layout Subsection
10981 \begin_layout Standard
10982 The following environments are available.
10983 You can use broadway.bind to get the bind keys shown at the right.
10986 \begin_layout Itemize
10990 \begin_inset Newline newline
10995 You should not have to use this, but it is here for anything that does not
10999 \begin_layout Itemize
11003 \begin_inset space \hfill{}
11007 \begin_inset Newline newline
11012 Used to describe stage setting and the action.
11013 First use of speaker names in all CAPs.
11016 \begin_layout Itemize
11020 \begin_inset space \hfill{}
11024 \begin_inset Newline newline
11029 Automatically numbered.
11030 On screen it will be arabic, but will print as Roman.
11033 \begin_layout Itemize
11037 \begin_inset space \hfill{}
11041 \begin_inset Newline newline
11051 It is just centered text.
11054 \begin_layout Itemize
11058 \begin_inset space \hfill{}
11062 \begin_inset Newline newline
11067 Not automatically numbered.
11068 You supply the number.
11069 This is because I couldn't figure out how.
11072 \begin_layout Itemize
11076 \begin_inset space \hfill{}
11080 \begin_inset Newline newline
11085 A special case of Narrative to describe the setting and action as the curtain
11089 \begin_layout Itemize
11093 \begin_inset space \hfill{}
11097 \begin_inset Newline newline
11102 The speaker's (actor's) title, centered in all CAPS.
11105 \begin_layout Itemize
11109 \begin_inset space \hfill{}
11113 \begin_inset Newline newline
11118 Instructions to the speaker.
11119 The parentheses are automatically inserted.
11120 The ( will appear on screen, but both will be in the printed play.
11121 This environment is only used within
11128 \begin_layout Itemize
11132 \begin_inset space \hfill{}
11136 \begin_inset Newline newline
11141 What the Speaker says.
11144 \begin_layout Itemize
11148 \begin_inset space \hfill{}
11152 \begin_inset Newline newline
11157 The curtain comes down.
11160 \begin_layout Itemize
11164 \begin_inset space \hfill{}
11170 \begin_layout Itemize
11174 \begin_inset space \hfill{}
11180 \begin_layout Itemize
11184 \begin_inset space \hfill{}
11190 \begin_layout Standard
11194 \begin_layout Section
11198 \begin_layout Standard
11203 can be used to type letters according to German conventions.
11204 A template file is included in
11206 .../lyx/share/templates
11208 for you to use as a starting point.
11211 \begin_layout Section
11219 \begin_layout Standard
11225 \begin_layout Subsection
11229 \begin_layout Standard
11230 This is the layout file for the European Geophysical Society journals.
11235 can be downloaded from the web site of the EGS under
11236 \begin_inset Flex URL
11239 \begin_layout Plain Layout
11249 \begin_layout Subsection
11253 \begin_layout Standard
11256 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
11264 The current layout file is unfortunately very unmodular and would benefit
11265 from using the various
11272 \begin_layout Section
11276 \begin_layout Standard
11277 See the \SpecialChar LyX
11283 It contains all infos you need.
11286 \begin_layout Section
11289 Foil\SpecialChar TeX
11293 \begin_inset CommandInset label
11302 \begin_layout Standard
11308 \begin_layout Subsection
11312 \begin_layout Standard
11313 This section describes how to use \SpecialChar LyX
11314 to make slides for overhead projectors.
11315 There are two document classes that can do this: the default slides class
11318 Foil\SpecialChar TeX
11322 This section documents the latter.
11325 \begin_layout Standard
11326 I'm going to say this again, nice and clear, so that there's no misunderstanding
11330 \begin_layout Standard
11331 \begin_inset VSpace bigskip
11337 \begin_layout Standard
11341 This section documents the class
11342 \begin_inset Quotes eld
11350 \begin_inset Quotes erd
11358 \begin_layout Standard
11359 \begin_inset VSpace bigskip
11365 \begin_layout Standard
11366 If you're looking for the documentation for
11367 \begin_inset Quotes eld
11375 \begin_inset Quotes erd
11378 , check out section
11379 \begin_inset space ~
11383 \begin_inset CommandInset ref
11385 reference "sec:slitex"
11390 If your machine doesn't have the
11398 installed, you'll probably have to use the default
11402 class, which isn't quite as good as
11407 \begin_layout Standard
11412 class is designed for use with version
11413 \begin_inset space ~
11421 class file which is now an integral part of \SpecialChar LaTeX2e
11425 \begin_layout Subsection
11429 \begin_layout Standard
11430 Obviously, to use this document class, you need to select
11441 \begin_inset space ~
11447 There are some settings in the
11450 \begin_inset space ~
11455 dialog that you should know about that are specific to this class:
11458 \begin_layout Itemize
11459 Don't change the options
11470 \begin_inset space ~
11476 They're ignored by the
11483 \begin_layout Itemize
11484 The default font size is 20
11485 \begin_inset space \thinspace{}
11488 pt with the other options being 17
11489 \begin_inset space \thinspace{}
11493 \begin_inset space \thinspace{}
11497 \begin_inset space \thinspace{}
11503 \begin_layout Itemize
11504 The default font is
11512 but all math equations are still typeset in the usual roman font.
11515 \begin_layout Itemize
11518 Foil\SpecialChar TeX
11521 supports A4 and Letter paper sizes as well as a special size for working
11523 \begin_inset space \thinspace{}
11527 It doesn't support A5, B5, legal or executive paper sizes.
11530 \begin_layout Itemize
11531 Don't bother changing the
11535 settings because they are ignored anyway.
11536 All floats appear where they are defined in the text.
11539 \begin_layout Itemize
11544 setting behaves a bit differently for this class.
11547 Foil\SpecialChar TeX
11550 provides extensive footer and header capabilities including a user-defined
11553 \begin_inset space ~
11557 \begin_inset CommandInset ref
11559 reference "sec:foilfoot"
11564 The title page is treated differently to all other pages in the document
11573 has the logo centered at the bottom of the page (if one is defined).
11574 The possible page style choices and what they do are as follows:
11578 \begin_layout Labeling
11579 \labelwidthstring MMMMMMM
11586 The final output contains no page numbers, or other headers or footers
11587 (except footnotes of course).
11591 \begin_layout Labeling
11592 \labelwidthstring MMMMMMM
11599 The final output contains page numbers centered at the bottom of the page.
11600 No other headings or footers (other than footnotes).
11603 \begin_layout Labeling
11604 \labelwidthstring MMMMMMM
11609 Page numbers in lower right corner.
11610 Additional headers and footers are also shown.
11611 This is also the default.
11614 \begin_layout Labeling
11615 \labelwidthstring MMMMMMM
11620 Gives you access to the
11624 package although its use with
11626 Foil\SpecialChar TeX
11629 is discouraged by the writer of the
11631 Foil\SpecialChar TeX
11634 package because of some potential page layout clashes.
11638 \begin_layout Subsubsection
11642 \begin_layout Standard
11643 The following options may be used in the extra class options in the
11645 Document\SpecialChar menuseparator
11651 \begin_layout Labeling
11652 \labelwidthstring MMMMMMx
11657 This sets up the page layout for 7.33
11658 \begin_inset space \thinspace{}
11662 \begin_inset space \thinspace{}
11665 in paper, which is about the same aspect ratio as a 35
11666 \begin_inset space \thinspace{}
11669 mm slide, making it a bit easier to work with this medium.
11672 \begin_layout Labeling
11673 \labelwidthstring MMMMMMx
11678 Places a rule across the page below the header on every page except the
11682 \begin_layout Labeling
11683 \labelwidthstring MMMMMMx
11688 Places a rule across the page above the footer on every page except the
11692 \begin_layout Labeling
11693 \labelwidthstring MMMMMMx
11698 This is automatically set each time you create a new
11705 Foil\SpecialChar TeX
11708 to use the dvips driver to rotate those pages that are set as landscape
11712 \begin_layout Labeling
11713 \labelwidthstring MMMMMMx
11718 Simply changes the page dimensions to those of a landscape page but doesn't
11720 Thus if you use this option you need to use an external program to rotate
11721 each page or feed your paper through your printer as landscape.
11722 Note that this option effectively reverses the roles of the
11730 environments (don't worry these are described in the next section).
11733 \begin_layout Labeling
11734 \labelwidthstring MMMMMMx
11739 Equation numbers on the left.
11742 \begin_layout Labeling
11743 \labelwidthstring MMMMMMx
11748 Flush-left equations.
11751 \begin_layout Subsection
11752 Supported Environments
11755 \begin_layout Standard
11756 Most of the environments commonly supported in other classes are also supported
11762 There are several additional environments provided by
11764 Foil\SpecialChar TeX
11767 as well as a couple added by \SpecialChar LyX
11769 The following environments are shared with other classes:
11772 \begin_layout Standard
11773 \begin_inset Flex Multiple Columns
11776 \begin_layout Itemize
11782 \begin_layout Itemize
11788 \begin_layout Itemize
11794 \begin_layout Itemize
11800 \begin_layout Itemize
11806 \begin_layout Itemize
11813 \begin_layout Itemize
11819 \begin_layout Itemize
11825 \begin_layout Itemize
11831 \begin_layout Itemize
11837 \begin_layout Itemize
11843 \begin_layout Itemize
11849 \begin_layout Itemize
11855 \begin_layout Itemize
11861 \begin_layout Itemize
11867 \begin_layout Itemize
11873 \begin_layout Itemize
11879 \begin_layout Itemize
11890 \begin_layout Standard
11891 That is, all the major environments apart from the sectioning environments.
11892 Since foils are essentially self-contained sections, with a title and body,
11895 Foil\SpecialChar TeX
11898 provides specific commands for starting new foils and these are:
11901 \begin_layout Itemize
11907 \begin_layout Itemize
11913 \begin_layout Standard
11915 also provides slightly modified versions of these two environments called:
11918 \begin_layout Itemize
11924 \begin_layout Itemize
11927 ShortRotatefoilhead
11930 \begin_layout Standard
11931 and the differences will be explained in the next section.
11934 \begin_layout Standard
11935 Since foils are often used in presenting ideas or new theorems and such
11938 Foil\SpecialChar TeX
11941 also provides a comprehensive box of goodies for presenting them:
11944 \begin_layout Standard
11945 \begin_inset Flex Multiple Columns
11948 \begin_layout Itemize
11954 \begin_layout Itemize
11960 \begin_layout Itemize
11966 \begin_layout Itemize
11972 \begin_layout Itemize
11978 \begin_layout Itemize
11984 \begin_layout Itemize
11990 \begin_layout Itemize
11996 \begin_layout Itemize
12002 \begin_layout Itemize
12008 \begin_layout Itemize
12019 \begin_layout Standard
12020 The starred versions are unnumbered while the unstarred versions are numbered.
12021 There are also two list environments added by \SpecialChar LyX
12025 \begin_layout Itemize
12031 \begin_layout Itemize
12037 \begin_layout Standard
12040 Foil\SpecialChar TeX
12043 provides some powerful header and footer capabilities that are best set
12044 in the preamble although they may be set at any point in a document.
12045 If you want to change these settings in your document the best place to
12046 do so is at the very top of a foil, i.
12047 \begin_inset space \thinspace{}
12053 \begin_inset space \space{}
12058 straight after the foilhead.
12061 \begin_layout Standard
12062 For this purpose, the following command styles are provided [
12069 \begin_layout Standard
12070 \begin_inset Flex Multiple Columns
12073 \begin_layout Itemize
12077 \begin_inset space ~
12083 \begin_layout Itemize
12089 \begin_layout Itemize
12093 \begin_inset space ~
12099 \begin_layout Itemize
12103 \begin_inset space ~
12109 \begin_layout Itemize
12113 \begin_inset space ~
12120 \begin_layout Plain Layout
12121 \begin_inset space ~
12133 \begin_layout Standard
12134 There are also a few commands provided by
12136 Foil\SpecialChar TeX
12139 that aren't directly supported by \SpecialChar LyX
12140 but I'll tell you what they do and how
12141 to use them in section
12142 \begin_inset space ~
12146 \begin_inset CommandInset ref
12148 reference "sec:unsuppfoils"
12155 \begin_layout Subsection
12156 Building a Set of Foils
12159 \begin_layout Standard
12160 This section will give a simple introduction to using the different environments
12161 to build a set of foils.
12162 If you want to see an example set of foils, take a look at the
12166 file you find in \SpecialChar LyX
12174 \begin_layout Subsubsection
12175 Give It a Title Page
12178 \begin_layout Standard
12179 Unlike other classes that provide
12199 creates the title on a page of its own.
12200 If you leave out the
12204 environment \SpecialChar LaTeX
12205 will substitute the current date (every time you regenerate
12209 \begin_layout Subsubsection
12213 \begin_layout Standard
12214 As I mentioned earlier, there are four ways of starting a new foil.
12215 For portrait foils you should use
12224 The difference between these two environments is the amount of space between
12225 the title of the foil (the foilhead) and the body of the foil.
12228 \begin_layout Standard
12229 Landscape foils are generated using the
12235 ShortRotatefoilhead
12238 Again the only difference is the spacing between foilhead and body.
12239 Both of the short versions have 0.5
12240 \begin_inset space ~
12243 inches less separation between the foilhead and the body.
12247 \begin_layout Standard
12248 One problem with the support for landscape foils is the requirement that
12249 you have to use the
12253 driver to generate the PostScript output otherwise the foils won't be rotated.
12254 It is possible to get landscape foils even if you haven't got the
12258 driver provided you can feed your foils sideways through your printer ;-)
12261 \begin_layout Subsubsection
12262 Theorems, Lemmas, Proofs and more
12265 \begin_layout Standard
12266 Due to a small bug in \SpecialChar LyX
12267 you can't have two of the same type of these environments
12268 directly following each other.
12269 They must be separated by something.
12270 If you try, you will just be extending the previous environment as if you
12271 had merged the two environments together.
12272 So, how do you get around this problem? The simplest option is to insert
12273 some text between the two environments or add a
12278 environment between the two with just a
12279 \begin_inset Quotes eld
12287 \begin_inset Quotes erd
12291 This will force \SpecialChar LyX
12292 to produce two separate environments and hence the correct
12295 An example is provided in the example file included with the \SpecialChar LyX
12297 Remember, this problem only occurs if you are trying to place two of the
12298 same type of theorem-like environments one directly after the other.
12301 \begin_layout Subsubsection
12305 \begin_layout Standard
12306 You get all the commonly supported list styles found in other classes as
12307 well as two new ones.
12308 I'll only describe the new ones here.
12309 If you want to find out more about the other list environments check out
12315 If you intend to use itemized lists you might also want to read about the
12319 \begin_inset space ~
12323 \begin_inset space ~
12328 dialog described above in section
12329 \begin_inset space ~
12333 \begin_inset CommandInset ref
12335 reference "sec:bullet"
12342 \begin_layout Standard
12343 The two new list styles,
12351 , are designed to make it easier for you to create lists of do's and don'ts
12352 or right and wrong by providing dedicated environments that use a tick
12353 or a cross as the label of the list.
12354 These lists are in fact dedicated variants of the
12359 They do however require that you have the
12363 packages installed.
12366 \begin_layout Subsubsection
12370 \begin_layout Standard
12373 Foil\SpecialChar TeX
12376 redefines the floating tables and figures so that they appear exactly where
12377 they are in the text rather than pushing them to the top of the page or
12378 to some user specified location.
12379 In fact if you change the float placement settings they are simply ignored.
12382 \begin_layout Subsubsection
12383 Page Headers and Footers
12384 \begin_inset CommandInset label
12386 name "sec:foilfoot"
12393 \begin_layout Standard
12397 \begin_inset space ~
12406 are two commands used to control the left-footer text string.
12407 The first is meant to allow you to include a graphic logo on your foils
12409 \begin_inset Quotes eld
12414 Foil\SpecialChar TeX
12418 \begin_inset Quotes erd
12422 While the second is meant to provide a classification for the audience,
12426 \begin_inset space \thinspace{}
12432 \begin_inset space \space{}
12436 It is empty by default.
12439 \begin_layout Standard
12440 The remaining page corners can be filled by
12443 \begin_inset space ~
12448 (which defaults to page numbers),
12451 \begin_inset space ~
12459 \begin_inset space ~
12467 \begin_layout Subsection
12470 Foil\SpecialChar TeX
12474 \begin_inset CommandInset label
12476 name "sec:unsuppfoils"
12483 \begin_layout Standard
12484 All the commands mentioned below need to be set in a
12494 within another environment.
12497 \begin_layout Subsubsection
12501 \begin_layout Standard
12502 All lengths are adjusted using the
12525 should be replaced by the name given to the length you want to change and
12530 is the length value.
12531 All lengths should be specified in units of length such as inches (
12543 ) or relative to some document or font-based length such as
12553 \begin_layout Standard
12554 It's possible to change the spacing between a foilhead and the body of the
12555 foil by adjusting the length specified by
12562 For example, to make
12567 \begin_inset space \space{}
12570 in closer to their bodies put the following in the preamble:
12576 foilheadskip}{-0.5in}
12579 \begin_layout Standard
12580 The spacings around floats can be adjusted by setting these lengths:
12583 \begin_layout Labeling
12584 \labelwidthstring MMMMMMMMMMM
12591 Separation between the text and the top of the float
12594 \begin_layout Labeling
12595 \labelwidthstring MMMMMMMMMMM
12602 Separation between the float and the caption
12605 \begin_layout Labeling
12606 \labelwidthstring MMMMMMMMMMM
12613 Separation between the caption and the following text
12616 \begin_layout Labeling
12617 \labelwidthstring MMMMMMMMMMM
12624 You can make the captions narrower than the surrounding text by adjusting
12626 Best done relative to
12635 \begin_layout Standard
12636 There are also several title page related lengths that you may find useful
12637 if you have a long title or several authors:
12640 \begin_layout Labeling
12641 \labelwidthstring MMMMMMMMMMM
12648 Separation from headers to
12653 \begin_layout Labeling
12654 \labelwidthstring MMMMMMMMMMM
12672 \begin_layout Labeling
12673 \labelwidthstring MMMMMMMMMMM
12687 \begin_layout Labeling
12688 \labelwidthstring MMMMMMMMMMM
12704 \begin_layout Labeling
12705 \labelwidthstring MMMMMMMMMMM
12721 \begin_layout Standard
12722 The last length related command affects all the list environments.
12733 a list environment then all the vertical spacing between the list items
12735 Note that this is a command not a length so it doesn't require
12741 like the stuff mentioned above.
12744 \begin_layout Subsubsection
12745 Headers and Footers
12748 \begin_layout Standard
12761 commands control whether the logo in the
12765 definition appear on a given page.
12772 in the preamble then none of the foils will have the logo on them.
12773 If you don't want the logo on a particular page place the
12779 directly after the foilhead of that page and the
12785 directly after the next foilhead.
12788 \begin_layout Standard
12789 If you decide to use the
12793 page style setting in the
12796 \begin_inset space ~
12801 dialog you should probably add
12811 to your preamble so headers and footers on landscape pages are correctly
12812 placed when rotated.
12813 This is due to some clashes between the page layouts provided by the
12824 \begin_layout Section
12825 Hollywood (Hollywood spec scripts)
12828 \begin_layout Standard
12834 \begin_layout Subsection
12838 \begin_layout Standard
12839 Getting the format of a Hollywood script right is a
12840 \begin_inset Quotes eld
12844 \begin_inset Quotes erd
12847 It is designed to make the readers focus on content and to be easy and
12848 familiar for the actors to read.
12849 Each page of a script should be one minute of film.
12850 Nothing goes in a script that you cannot see or hear on screen.
12851 The courier 12 pt font should be used throughout.
12855 \begin_layout Subsection
12859 \begin_layout Standard
12860 Speakers' lines should NEVER break in mid-sentence.
12861 If a speaker's lines continue over a page break, repeat the
12865 title followed by (Cont'd).
12868 \begin_layout Subsection
12872 \begin_layout Standard
12877 names as labels then cross-reference the label to insert the name.
12878 The cross-reference dialog will show the current cast of characters.
12879 You can use this to insert the speaker name in narratives also.
12882 \begin_layout Subsection
12883 Paper size and Margins
12886 \begin_layout Standard
12887 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12890 \begin_layout Subsection
12894 \begin_layout Standard
12895 The following environments are available.
12896 You can use hollywood.bind to get the bind keys shown at the right.
12899 \begin_layout Itemize
12903 \begin_inset Newline newline
12908 Used where nothing else works.
12912 \begin_layout Itemize
12918 \begin_inset space \hfill{}
12926 \begin_inset Newline newline
12929 Usually followed by something like
12930 \begin_inset Quotes eld
12933 on Sally waking up.
12934 \begin_inset Quotes erd
12940 \begin_layout Itemize
12944 \begin_inset space \hfill{}
12948 \begin_inset Newline newline
12953 Introduces a new INTERIOR camera set-up.
12954 Always followed by DAY or NIGHT, or something similar to define the lighting
12956 Everthing on this line in CAPS.
12959 \begin_layout Itemize
12963 \begin_inset space \hfill{}
12967 \begin_inset Newline newline
12972 Introduces a new EXTERIOR camera set-up.
12973 Everthing on this line in CAPS.
12976 \begin_layout Itemize
12980 \begin_inset space \hfill{}
12984 \begin_inset Newline newline
12989 The character speaking.
12992 \begin_layout Itemize
12996 \begin_inset space \hfill{}
13000 \begin_inset Newline newline
13005 Instructions to the speaker.
13006 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
13008 Both will be printed.
13011 \begin_layout Itemize
13015 \begin_inset space \hfill{}
13019 \begin_inset Newline newline
13031 \begin_layout Itemize
13035 \begin_inset space \hfill{}
13039 \begin_inset Newline newline
13044 Camera movement instruction.
13046 \begin_inset space \thinspace{}
13050 \begin_inset space \space{}
13056 \begin_layout Itemize
13060 \begin_inset space \hfill{}
13066 \begin_layout Itemize
13070 \begin_inset space \hfill{}
13076 \begin_layout Itemize
13080 \begin_inset space \hfill{}
13086 \begin_layout Itemize
13090 \begin_inset space \hfill{}
13096 \begin_layout Subsection
13100 \begin_layout Itemize
13104 \begin_layout Itemize
13108 \begin_layout Itemize
13110 \begin_inset space \thinspace{}
13117 \begin_layout Itemize
13122 \begin_layout Itemize
13123 PAN — camera movement
13126 \begin_layout Itemize
13127 INSERT — cut to close-up of
13130 \begin_layout Section
13134 \begin_layout Standard
13137 Panayotis Papasotiriou
13140 \begin_layout Subsection
13144 \begin_layout Standard
13145 The ijmpc package is a set of macros that facilitates electronic manuscript
13148 International Journal of Modern Physics C
13151 Similarly, the ijmpd package is for creating manuscripts to be submitted
13154 International Journal of Modern Physics D
13157 Both journals are published by World Scientific.
13158 The corresponding document classes are named
13167 These files, together with instructions for the authors, can be downloaded
13169 \begin_inset Flex URL
13172 \begin_layout Plain Layout
13174 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
13180 \begin_inset Flex URL
13183 \begin_layout Plain Layout
13185 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
13191 Both packages are modified versions of the standard
13192 \begin_inset Quotes eld
13196 \begin_inset Quotes erd
13199 package, and they are almost (but not exactly) identical.
13200 Most of their features are supported by \SpecialChar LyX
13202 I have used \SpecialChar LyX
13203 successfully to write articles submitted to both journals
13204 without any problem.
13207 \begin_layout Subsection
13211 \begin_layout Standard
13212 As usual, the easiest way to write a paper is to start with a template.
13215 File\SpecialChar menuseparator
13231 This will give an (almost) empty document that includes the most common
13232 fields found in a manuscript.
13233 Simply overwrite the existing text (including the brackets,
13238 You should keep in mind the following remarks.
13241 \begin_layout Enumerate
13243 won't let you change the font size and the page style of the document,
13244 because such modifications are not allowed by both packages.
13247 \begin_layout Enumerate
13248 The language of the document should not be changed.
13249 Before previewing your paper, be sure that the babel package is not used.
13250 To do this, click on
13252 Tools\SpecialChar menuseparator
13263 checkbox in the language settings, and click on
13271 , if you wish to make this change permanent).
13274 \begin_layout Enumerate
13276 \begin_inset Quotes eld
13280 \begin_inset Quotes erd
13283 style must be used to define keywords.
13286 \begin_layout Enumerate
13287 The ijmpc package provides a style named
13288 \begin_inset Quotes eld
13291 Classification Codes
13292 \begin_inset Quotes erd
13295 , which can be used to define classification codes, such as PACS numbers.
13296 Note that this facility is not supported by the ijmpd package.
13299 \begin_layout Enumerate
13300 Several new environments are available:
13301 \begin_inset Quotes eld
13305 \begin_inset Quotes erd
13309 \begin_inset Quotes eld
13313 \begin_inset Quotes erd
13317 \begin_inset Quotes eld
13321 \begin_inset Quotes erd
13325 \begin_inset Quotes eld
13329 \begin_inset Quotes erd
13333 \begin_inset Quotes eld
13337 \begin_inset Quotes erd
13341 \begin_inset Quotes eld
13345 \begin_inset Quotes erd
13349 \begin_inset Quotes eld
13353 \begin_inset Quotes erd
13357 \begin_inset Quotes eld
13361 \begin_inset Quotes erd
13365 \begin_inset Quotes eld
13369 \begin_inset Quotes erd
13373 \begin_inset Quotes eld
13377 \begin_inset Quotes erd
13381 \begin_inset Quotes eld
13385 \begin_inset Quotes erd
13389 \begin_inset Quotes eld
13393 \begin_inset Quotes erd
13397 \begin_inset Quotes eld
13401 \begin_inset Quotes erd
13405 \begin_inset Quotes eld
13409 \begin_inset Quotes erd
13413 Their use is more or less obvious.
13415 supports all these environments; it will use the proper label, text style,
13416 and numbering scheme for each of them.
13419 \begin_layout Enumerate
13420 Both packages use basic citations; the natbib package should not be used.
13421 In \SpecialChar LyX
13422 , citation references are shown as usual; in the output, citations are
13423 shown as superscripts.
13424 If you want to use a citation as normal text, you should use the
13429 \begin_inset space \thinspace{}
13433 \begin_inset space \space{}
13437 \begin_inset Quotes eld
13441 \begin_inset space \space{}
13451 \begin_inset Quotes erd
13457 \begin_layout Enumerate
13459 \begin_inset Quotes eld
13463 \begin_inset Quotes erd
13466 section in both packages.
13467 To put acknowledgments, just use the
13468 \begin_inset Quotes eld
13472 \begin_inset Quotes erd
13478 \begin_layout Enumerate
13479 Appendices may be added to the paper,
13483 the Acknowledgments and
13489 provides a special environment, called
13490 \begin_inset Quotes eld
13494 \begin_inset Quotes erd
13497 which marks the beginning of the appendices.
13498 This environment should be left blank; it just sends a \SpecialChar LaTeX
13499 command, but nothing
13501 In \SpecialChar LyX
13503 \begin_inset Quotes eld
13507 \begin_inset Quotes erd
13510 is printed with blue letters, as a signal that all sections after that
13511 point are appendices.
13512 To write an appendix, use the
13513 \begin_inset Quotes eld
13517 \begin_inset Quotes erd
13522 will number each appendix with capital letters, as required by both journals.
13524 \begin_inset Quotes eld
13528 \begin_inset Quotes erd
13535 be present before the first appendix; if not, all appendices will be numbered
13536 as normal sections in the output.
13539 \begin_layout Enumerate
13540 The ijmpc and the ijmpd packages use the
13544 command to implement table captions.
13545 As a result, a table created by \SpecialChar LyX
13546 is printed correctly, but its caption
13548 However, you can use some \SpecialChar TeX
13549 code to overcome this problem, so that captions
13550 are printed as expected.
13551 To do so, create a float table as usual, remove the caption, and replace
13552 it with the \SpecialChar TeX
13563 (sic); you must also the \SpecialChar TeX
13568 immediately after the tabular material.
13569 Study the example table included in the template files to see how this
13570 trick is implemented.
13571 Alternatively, If you need table captions, you should implement the whole
13576 file, then include this file to the \SpecialChar LyX
13579 Insert\SpecialChar menuseparator
13580 File\SpecialChar menuseparator
13582 \begin_inset space ~
13588 Details on how to create a table float can be found in the files
13596 , included in the corresponding packages.
13599 \begin_layout Subsection
13600 Preparing a paper for submission
13603 \begin_layout Standard
13604 Before you submit your paper you must export the \SpecialChar LyX
13605 document as a \SpecialChar LaTeX
13608 File\SpecialChar menuseparator
13609 Export\SpecialChar menuseparator
13617 \begin_layout Plain Layout
13618 Actually you have the choice between \SpecialChar LaTeX
13619 (plain) and pdflatex.
13620 If you intend to use pdflatex to prepare the paper, you should use the
13621 pdflatex option so that included graphics are converted to PDF format,
13622 ready for use by pdflatex.
13627 , then make the following changes to the resulting
13634 \begin_layout Enumerate
13635 Remove the comment lines before the
13644 \begin_layout Enumerate
13645 Remove everything between (and including) the
13657 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13661 \begin_layout Standard
13666 file should be saved and processed through \SpecialChar LaTeX
13667 as many times as necessary.
13668 You may also want to check the resulting
13675 \begin_layout Subsection
13676 Use of \SpecialChar TeX
13680 \begin_layout Standard
13681 The use of \SpecialChar TeX
13682 code is reduced to two commands, which must be placed at the
13683 top of the document.
13684 If you started writing your paper by using the
13692 template, the \SpecialChar TeX
13693 code needed is already in its place; you usually don't need
13695 You may only modify the first \SpecialChar TeX
13696 code to specify the information printed
13697 to the top of odd and even pages (authors' names and short paper's title,
13699 This \SpecialChar TeX
13700 code must have the form
13704 markboth{Authors' Names}{Short Paper's Title}
13709 \begin_layout Section
13713 \begin_layout Standard
13719 \begin_layout Subsection
13723 \begin_layout Standard
13724 The iopart package provides a document class to create electronic manuscript
13725 submission to the journals published by the Institute of Physics.
13726 Instructions for the authors how to create a paper using the iopart class
13727 can be downloaded together with the iopart package from the site
13728 \begin_inset Flex URL
13731 \begin_layout Plain Layout
13733 ftp://ftp.iop.org/pub/journals/latex2e
13741 \begin_layout Subsection
13745 \begin_layout Standard
13746 The easiest way to write a paper is to start with the file
13750 that is available in \SpecialChar LyX
13751 's examples files folder.
13752 Open this file, save it under a new name, and start writing.
13753 The example file explains how to use the special text environments.
13754 Here are the most important advices:
13757 \begin_layout Itemize
13758 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13761 Use AMS math package
13763 in the document settings under
13770 \begin_layout Itemize
13773 The title environment defines the kind of your paper.
13774 So use one of the following environments for the title:
13778 \begin_layout Itemize
13787 \begin_layout Itemize
13796 \begin_layout Itemize
13802 for a Topical review
13805 \begin_layout Itemize
13814 \begin_layout Itemize
13823 \begin_layout Itemize
13829 for a Paper (same as Title)
13832 \begin_layout Itemize
13838 for a Preliminary communication
13841 \begin_layout Itemize
13847 for a Rapid communication
13850 \begin_layout Itemize
13856 for a Letter to the editor
13860 \begin_layout Itemize
13863 All title environments except of
13867 can have an optional short title.
13870 \begin_layout Itemize
13871 There is a general title environment
13875 which is not directly supported by the \SpecialChar LyX
13877 This can be used as \SpecialChar TeX
13878 code when your document doesn't fit into one of the
13882 \begin_layout Standard
13883 For more informations like hints for special table and formula formatting,
13884 look at the IOP author guidelines.
13887 \begin_layout Section
13891 \begin_layout Standard
13894 Panayotis Papasotiriou
13897 \begin_layout Subsection
13901 \begin_layout Standard
13902 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13903 that facilitates electronic manuscript submission to the journals they
13905 Most known of them (at least in my domain of interest) are
13907 Astrophysics and Space Science
13913 , but there are many others (see a complete list at
13914 \begin_inset Flex URL
13917 \begin_layout Plain Layout
13919 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13925 The Kluwer package may be downloaded from the site
13926 \begin_inset Flex URL
13929 \begin_layout Plain Layout
13931 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13937 A complete user guide is contained in that package (but it can also be
13938 downloaded separately).
13941 \begin_layout Standard
13943 supports many features of the package but not everything.
13944 However, the \SpecialChar TeX
13945 code needed is reduced to some
13946 \begin_inset Quotes eld
13950 \begin_inset Quotes erd
13953 commands of the package (see
13954 \begin_inset space ~
13958 \begin_inset CommandInset ref
13960 reference "subsec:kluwer_peculiarities"
13965 I have recently used \SpecialChar LyX
13966 to write an article submitted to the
13968 Astrophysics and Space Science
13970 without any problem.
13973 \begin_layout Subsection
13977 \begin_layout Standard
13978 The easiest way to write a paper is to start with the Kluwer template file.
13981 File\SpecialChar menuseparator
13993 This will give an (almost) empty document that includes the most common
13994 fields found in a manuscript and a short description of their use.
13995 As in most templates, simply overwrite the existing text (including the
14000 ) with the correct information.
14003 \begin_layout Subsection
14004 Preparing a paper for submission
14007 \begin_layout Standard
14008 As in the AAS\SpecialChar TeX
14009 package, before you submit your paper to a journal you must
14011 \begin_inset Quotes eld
14015 \begin_inset Quotes erd
14021 \begin_layout Enumerate
14022 Export your paper as a \SpecialChar LaTeX
14024 To do this, click on
14026 File\SpecialChar menuseparator
14027 Export\SpecialChar menuseparator
14035 \begin_layout Enumerate
14040 file with a text editor and make the following changes
14044 \begin_layout Enumerate
14045 remove the comment lines before the
14054 \begin_layout Enumerate
14055 remove everything between (and including) the
14067 commands, except for any commands you specifically put into the \SpecialChar LaTeX
14071 \begin_layout Standard
14080 \begin_layout Enumerate
14085 file through \SpecialChar LaTeX
14086 as many times as necessary (usually up to three).
14089 \begin_layout Enumerate
14095 \begin_inset space \thinspace{}
14099 \begin_inset space \space{}
14106 , and check if everything is OK (it should, if you didn't make any mistake).
14109 \begin_layout Subsection
14110 \begin_inset Quotes eld
14114 \begin_inset Quotes erd
14117 of the Kluwer package
14118 \begin_inset CommandInset label
14120 name "subsec:kluwer_peculiarities"
14127 \begin_layout Standard
14128 The Kluwer package has the following
14129 \begin_inset Quotes eld
14133 \begin_inset Quotes erd
14139 \begin_layout Enumerate
14140 It is possible to write multiple articles in the same \SpecialChar LaTeX
14145 \begin_layout Plain Layout
14146 I can't imagine any good reason to do this.
14152 Each article must be included in the environment
14153 \begin_inset Quotes eld
14157 \begin_inset Quotes erd
14161 Unfortunately, this environment cannot be omitted, even if you write just
14163 Therefore, each article starts with the command
14169 and, obviously, ends with the command
14176 Although this can be implemented in \SpecialChar LyX
14177 , I didn't included it, since it looks
14178 ugly and can confuse the novice user.
14179 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
14182 \begin_inset Quotes eld
14187 \begin_inset Quotes erd
14193 \begin_layout Enumerate
14194 Information given at the beginning of the article (i.
14195 \begin_inset space \thinspace{}
14199 \begin_inset space \space{}
14202 title, subtitle, author, institution, running title, running author, abstract
14203 and keywords) must be included in an environment called
14204 \begin_inset Quotes eld
14208 \begin_inset Quotes erd
14212 This is not implemented in \SpecialChar LyX
14213 , so you must enter title, subtitle etc.
14214 \begin_inset space ~
14217 between two \SpecialChar TeX
14233 \begin_layout Enumerate
14234 According to the user manual, the label of each bibliography item must be
14258 \begin_layout Standard
14263 template takes care of all these
14264 \begin_inset Quotes eld
14268 \begin_inset Quotes erd
14272 If you start a new paper using this template you don't need to do anything
14277 \begin_layout Enumerate
14278 don't delete the \SpecialChar TeX
14279 code included in the template, and
14282 \begin_layout Enumerate
14283 copy the example bibliography item included in the template and modify it
14284 as necessary to enter new bibliography items.
14287 \begin_layout Section
14291 \begin_layout Standard
14297 \begin_layout Subsection
14301 \begin_layout Standard
14302 The \SpecialChar LyX
14305 article (koma-script)
14309 report (koma-script)
14327 correspond to the \SpecialChar LaTeX
14345 \begin_inset space ~
14348 of the Koma-Script family.
14349 They are replacements for the standard document classes
14365 , resp., and fit better to European typography conventions in a number of
14369 \begin_layout Itemize
14370 Standard character size is 11pt in
14372 article (koma-script)
14376 report (koma-script)
14384 letter (koma-script)
14389 \begin_layout Itemize
14390 Headings, labels of the description environment, and a number of elements
14393 letter (koma-script)
14395 document class are set in a bold sans serif font.
14399 \begin_layout Plain Layout
14400 There is a big difference between the bold sans serif old cm fonts and new
14401 ec fonts, especially in the appearance of headings.
14402 In comparison, the ec bold sans serif fonts look a bit thin.
14403 Here the \SpecialChar LaTeX
14412 helps to produce the
14413 \begin_inset Quotes eld
14417 \begin_inset Quotes erd
14420 appearance when using the ec fonts.
14425 The numbering of chapter headings is made in the same way as the numbering
14426 of section headings, that is without the extra line
14427 \begin_inset Quotes eld
14430 Chapter\SpecialChar ldots
14432 \begin_inset Quotes erd
14436 In addition, the appearance of the headings can be modified by using a
14437 number of options (in \SpecialChar LyX
14438 to be entered in the field
14441 \begin_inset space ~
14448 Layout\SpecialChar menuseparator
14455 \begin_layout Itemize
14456 The main means in the Koma-Script document classes to design the type area
14465 (in \SpecialChar LyX
14466 to be entered in the extra class options field in the dialog
14468 Document\SpecialChar menuseparator
14472 They make a clearer modification of page margins possible as do the options
14475 Document\SpecialChar menuseparator
14482 \begin_layout Itemize
14483 The \SpecialChar LaTeX
14484 document classes of the Koma-Script family define a number of additional
14486 Those part of it which makes sense in \SpecialChar LyX
14487 is implemented in corresponding
14491 \begin_layout Standard
14492 Detailed descriptions of the \SpecialChar LaTeX
14493 document classes of the Koma-Script family
14494 can be found in the Koma-Script documentation
14505 \begin_layout Subsection
14506 article (koma-script), report (koma-script), and book (koma-script)
14509 \begin_layout Standard
14510 The document classes
14512 article (koma-script)
14516 report (koma-script)
14526 are implemented in the layout files
14539 They contain all the paragraph types of the corresponding standard document
14552 , resp., partly modified, with the exception of the \SpecialChar LyX
14557 -type, which is replaced by the new
14561 -type having the same functionality.
14566 -Type there is a number of new paragraph types added.
14573 letter (koma-script)
14578 \begin_layout Itemize
14587 : are equivalents to
14595 , resp., additionally inserting an entry in the table of contents.
14604 are not contained in
14606 article (koma-script)
14611 \begin_layout Itemize
14620 : behave exactly as
14628 , resp., additionally clearing running heads.
14633 is not contained in
14635 article (koma-script)
14641 \begin_layout Plain Layout
14654 report (koma-script)
14656 , but since this is identical to
14660 , is has not been implemented in \SpecialChar LyX
14669 \begin_layout Itemize
14674 : generates a heading directly above the following paragraph in the standard
14675 character size without affecting the structure of the document.
14678 \begin_layout Itemize
14687 are special captions which respect the different space settings needed
14688 for captions placed above or below an element (if you follow strict typographic
14689 rules, you might want to place table captions always above the table).
14690 You can also use the class option
14694 , which will switch
14707 You need at least Koma-Script version 2.8q to use this.
14710 \begin_layout Itemize
14715 : can be used to set a bonmot, e.
14716 \begin_inset space \thinspace{}
14720 \begin_inset space \space{}
14723 at the beginning of a chapter.
14724 If you use the optional argument (
14726 Insert\SpecialChar menuseparator
14728 \begin_inset space ~
14733 ), you can insert the dictum's author there.
14734 Dictum and author are separated by a line.
14735 You need at least Koma-Script version 2.8q to use this.
14740 is not contained in
14742 article (koma-script)
14747 \begin_layout Standard
14748 The following types, together with the standard types
14760 , form the title area of the document.
14761 They must be entered ahead of the first
14762 \begin_inset Quotes eld
14766 \begin_inset Quotes erd
14773 \begin_layout Plain Layout
14774 The corresponding \SpecialChar LaTeX
14775 commands must appear before the
14786 When such a type is used more than once, the latter usage overwrites the
14787 former one, that means, for every type only the latest usage is valid.
14788 The order of the different types however has, like
14800 , no effect on the appearance of the produced document.
14803 \begin_layout Itemize
14808 : produces a centered paragraph above the ordinary title (
14820 ) for the subject of the document.
14823 \begin_layout Itemize
14828 : produces a centered paragraph below the ordinary title (
14840 ) for the publishers' name.
14843 \begin_layout Itemize
14850 report (koma-script)
14856 produces a centered paragraph on its own page behind the title page, or
14859 article (koma-script)
14861 produces a centered paragraph below the ordinary title (
14877 ) for a dedication.
14880 \begin_layout Itemize
14885 : produces a left aligned paragraph above the ordinary title (
14901 ) for a document`s head.
14904 \begin_layout Itemize
14909 : produces in a double-sided print in
14911 report (koma-script)
14917 a left-aligned paragraph at the top of the title page`s back or has no
14918 effect in a single-sided print or in
14920 article (koma-script)
14925 \begin_layout Itemize
14930 : produces in a double-sided print in
14932 report (koma-script)
14938 a left-aligned paragraph at the bottom of the title page`s back or has
14939 no effect in a single-sided print or in
14941 article (koma-script)
14946 \begin_layout Itemize
14951 : produces a special
14952 \begin_inset Quotes eld
14956 \begin_inset Quotes erd
14959 page ahead of the actual document containing a paragraph without special
14963 \begin_layout Standard
14964 The layout files for the document classes
14966 article (koma-script)
14970 report (koma-script)
14976 do include the file
14981 This is thought of as a place to define your own types.
14986 in your personal layout directory and edit the file!
14989 \begin_layout Subsection
14990 letter (koma-script)
14993 \begin_layout Standard
14997 letter (koma-script)
14999 is implemented in the layout file
15004 It contains all the paragraph types of the corresponding standard document
15009 , partly modified, with the exception of the \SpecialChar LyX
15023 type, which is replaced by the new
15028 In addition, it contains, in contrast to the standard document class, the
15047 Furthermore, there are a number of new letter specific types.
15050 \begin_layout Standard
15051 The appearance of the letter produced by this document class can be controlled
15052 by a number of \SpecialChar LaTeX
15053 commands, which you can put in the \SpecialChar LaTeX
15058 \begin_layout Plain Layout
15059 For example, the standard appearance of the letter`s heading, consisting
15060 of name and address, is quite self-willed.
15062 \begin_inset Quotes eld
15066 \begin_inset Quotes erd
15069 heading is produced by the following \SpecialChar LaTeX
15070 commands in the preamble:
15073 \begin_layout LyX-Code
15083 \begin_layout LyX-Code
15099 \begin_layout LyX-Code
15109 \begin_layout LyX-Code
15129 A detailed German description of such \SpecialChar LaTeX
15130 commands can be found in the Koma-Script
15136 With it, the letter's author can produce his personal letter layout.
15139 \begin_layout Standard
15148 define the beginning of the letter and must be used in every letter.
15149 To emphasize them in the \SpecialChar LyX
15150 document class, they are marked with the letter
15160 \begin_inset space ~
15163 in the left margin.
15164 It is possible to write any number of letters in one file.
15169 type produces a new letter using the same addressee and a
15173 type produces a new addressee.
15190 are ordinary paragraph types and can also be used several times in one
15191 and the same letter.
15194 \begin_layout Itemize
15199 : produces a paragraph for the addressee and implicitly defines the beginning
15203 \begin_layout Itemize
15208 : produces a paragraph for the form of address and implicitly produces a
15212 \begin_layout Itemize
15217 : produces a paragraph for a close.
15220 \begin_layout Itemize
15225 : produces a paragraph for a postscript.
15228 \begin_layout Itemize
15233 : produces a paragraph for a distribution list.
15236 \begin_layout Itemize
15241 : produces a paragraph for enclosures.
15244 \begin_layout Standard
15285 are input types provided with a label to enter information, which will
15286 be processed by the document class.
15290 \begin_layout Plain Layout
15291 It could be seen as a matter of inconsequence, that the types
15299 described above are not such input types as well.
15300 Because of the special meaning of those types, however, I have implemented
15301 them as ordinary paragraph types with a one letter mark in the left margin.
15302 Moreover, it would affect my feeling of symmetry, if the
15310 type had such a serious different appearance.
15315 The types must be used ahead of the corresponding
15322 \begin_layout Standard
15323 An implementation of these types in a WYSIWYG fashion does not seem to make
15324 sense, because the real appearance of the produced letter does not only
15325 depend on the usage of the particular type, but also on other factors.
15326 For example, a signature entered in the
15330 type will in the standard behavior appear in the produced letter only,
15331 when in the same letter also a
15336 The entered value of the
15340 type will in the standard behavior not appear in the produced letter at
15342 The possibility to design the letter`s heading freely is already indicated
15343 in a footnote above.
15346 \begin_layout Standard
15347 The input types can also be used as empty paragraphs.
15348 This makes sense e.
15349 \begin_inset space \thinspace{}
15353 \begin_inset space \space{}
15365 type is not used at all, in the standard behavior the value of the
15369 type is used as signature, whereas if an empty
15373 type is used, no signature value is defined.
15376 \begin_layout Standard
15377 By using the input types it is possible to write a letter template, containing
15378 filled input types with your personal dates (name, address, etc.) and empty
15379 input types for other dates you want to enter.
15382 \begin_layout Itemize
15387 : sender's name, in the standard behavior appears as a centered paragraph
15388 in small caps in the letter`s heading.
15391 \begin_layout Itemize
15396 : sender's signature, in the standard behavior appears below the
15405 type is used, the value of the
15409 type appears instead.
15412 \begin_layout Itemize
15417 : sender's address, in the standard behavior appears in a centered paragraph
15418 in the letter`s heading below the sender's name.
15421 \begin_layout Itemize
15426 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15437 \begin_layout Itemize
15442 : place of the letter`s making.
15445 \begin_layout Itemize
15450 : date of the letter`s making.
15459 , in the standard behavior, produce the place and the date in a right-aligned
15460 line below the addressee's field.
15465 type is used, neither place nor date appear, independent of the value of
15475 type is used, the date of the letter `s production is used.
15478 \begin_layout Itemize
15483 : sender`s back address, in the standard behavior appears above the addressee's
15484 field in a small sans serif font.
15487 \begin_layout Itemize
15492 : special mail information, in the standard behavior appears underlined
15493 above the addressee's field below the back address.
15496 \begin_layout Itemize
15501 : additional information, in the standard behavior appears on right side
15502 below the addressee`s field.
15505 \begin_layout Itemize
15510 : the letter's title, in the standard behavior appears in a big, bold, sans
15511 serif font above the subject.
15514 \begin_layout Itemize
15519 : the letter's subject, in the standard behavior appears in a bold font
15527 \begin_layout Standard
15548 produce a business letter like line above the
15552 line containing the fields
15553 \begin_inset Quotes eld
15557 \begin_inset Quotes erd
15561 \begin_inset Quotes eld
15565 \begin_inset Quotes erd
15569 \begin_inset Quotes eld
15573 \begin_inset Quotes erd
15577 \begin_inset Quotes eld
15581 \begin_inset Quotes erd
15585 \begin_inset Quotes eld
15589 \begin_inset Quotes erd
15593 \begin_inset Quotes eld
15597 \begin_inset Quotes erd
15601 For the date field, the value of the
15607 \begin_inset Quotes eld
15610 business letter types
15611 \begin_inset Quotes erd
15614 is used, the value of the
15618 type however does not appear, but only the \SpecialChar LaTeX
15626 The ordinary output of place and date in a right-aligned line below the
15627 addressee`s field is suppressed.
15628 The types are implemented as input types provided with a label and must
15629 be used ahead of the corresponding
15636 \begin_layout Itemize
15644 \begin_layout Itemize
15652 \begin_layout Itemize
15660 \begin_layout Itemize
15668 \begin_layout Itemize
15676 \begin_layout Subsection
15677 The new letter class: letter (koma-script v.2)
15680 \begin_layout Standard
15686 \begin_layout Standard
15687 \begin_inset VSpace medskip
15693 \begin_layout Standard
15695 Koma-Script version 2.8 has introduced a new letter class
15699 which supersedes the now unsupported
15704 It has — on the \SpecialChar LaTeX
15705 side — a completely new interface and is not compatible
15706 with the old class.
15707 Therefore, \SpecialChar LyX
15708 supports both, though it is recommended you use the new class.
15711 \begin_layout Standard
15712 This class covers the same functionality as
15714 letter (koma-script),
15717 The basic items are
15721 (receiver's address, same as
15725 in the old layout),
15738 will start a new letter (i.
15739 \begin_inset space \thinspace{}
15743 \begin_inset space \space{}
15746 you can write several letters per document).
15747 New elements are sender's
15763 and the possibility to use a
15769 Insert\SpecialChar menuseparator
15775 \begin_layout Standard
15776 The biggest improvement is, though, that the letter's layout is configurable
15777 to meet almost any needs.
15778 This can be done via the preamble or with a special style file (Letter
15779 Class Option, extension
15783 ), that will be read in as a class option.
15787 \begin_layout Plain Layout
15788 The KOMA package comes with some default
15793 There is, for instance, a
15797 file that follows german typesetting rules, or a
15801 that provides the default layout of the old
15806 The latter can be loaded with the class option
15812 Layout\SpecialChar menuseparator
15813 Document\SpecialChar menuseparator
15825 template that is included in \SpecialChar LyX
15827 A detailed description is to be found in the Koma-Script documentation
15835 \begin_layout Subsection
15839 \begin_layout Standard
15840 Visualizing the Koma-Script document classes in \SpecialChar LyX
15841 , the \SpecialChar LyX
15842 internals cause some
15846 \begin_layout Itemize
15847 The chapter number of a
15851 type appears on a line of its own above the chapter heading instead of
15852 appearing in the same line ahead of it.
15853 The cause for that is the \SpecialChar LyX
15854 internal behavior for the labeltype
15858 in the layout file.
15861 \begin_layout Itemize
15862 The headings of the types
15870 are only put in the
15871 \begin_inset Quotes eld
15875 \begin_inset Quotes erd
15879 table of contents, but not in the \SpecialChar LyX
15880 table of contents (
15882 Document\SpecialChar menuseparator
15884 \begin_inset space ~
15888 \begin_inset space ~
15896 \begin_layout Itemize
15897 The paragraphs in a
15901 document class appear in a skip separation mode, not indented.
15902 This is the standard behavior, no special \SpecialChar LaTeX
15903 commands are needed for that.
15906 Document\SpecialChar menuseparator
15909 dialog the corresponding radio button indicates
15918 value always has the effect that extra \SpecialChar LaTeX
15919 commands are inserted in the document
15920 to produce the gap, which is not what is wanted in this case.
15923 \begin_layout Section
15927 \begin_layout Standard
15933 \begin_layout Subsection
15937 \begin_layout Standard
15938 Memoir is a very powerful and constantly evolving class.
15939 It has been designed with regard to fictional and non-fictional literature.
15940 Its aim is to let the user have maximum control over the typesetting of
15942 Memoir is based on the standard book class, but it can also emulate the
15943 article class (see below).
15946 \begin_layout Standard
15947 Peter Wilson, the developer of Memoir, is known as the author of lots of
15948 useful packages in the \SpecialChar LaTeX
15950 Most of them have been merged with Memoir.
15951 Therefore, it is much easier to layout the table of contents, appendices,
15952 chapter designs and such.
15954 , though, does not support all of these goodies natively.
15955 Some of them might be added to forthcoming releases
15959 \begin_layout Plain Layout
15960 You are invited to send suggestions to
15961 \begin_inset Flex URL
15964 \begin_layout Plain Layout
15966 lyx-devel@lists.lyx.org
15976 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15978 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15980 commands (\SpecialChar TeX
15985 \begin_layout Plain Layout
15990 \begin_layout Plain Layout
16000 \begin_inset space ~
16004 \begin_inset CommandInset ref
16006 reference "sec:Inserting-TeX-Code"
16016 In this section, we can only list those features that are natively supported
16017 by \SpecialChar LyX
16019 For detailed descriptions (and for the rest of features) we recommend you
16020 have a look at the detailed manual of the Memoir class
16024 \begin_layout Plain Layout
16029 \begin_layout Plain Layout
16039 \begin_inset Flex URL
16042 \begin_layout Plain Layout
16044 CTAN:/macros/latex/memoir/memman.pdf
16054 , which is not only a user guide for the class, but also both a comprehensive
16055 description on good typesetting and a superb example for good typesetting
16059 \begin_layout Subsection
16060 Basic features and restrictions
16063 \begin_layout Standard
16064 Memoir supports basically all features of the standard book classes.
16065 There are, however, some differences, as follows:
16068 \begin_layout Description
16070 \begin_inset space ~
16073 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
16076 \begin_layout Description
16078 \begin_inset space ~
16081 style: The fancy page style is not supported, due to a command clash between
16082 Memoir and the fancyhdr package (they both define a command with the same
16083 name, which confuses \SpecialChar LaTeX
16085 Instead, Memoir comes with a number of its own page styles (see
16087 Layout\SpecialChar menuseparator
16088 Document\SpecialChar menuseparator
16090 \begin_inset space ~
16096 If you want to use these for the chapter pages, you have to use the command
16103 in the main text or in preamble (e.
16104 \begin_inset space \thinspace{}
16108 \begin_inset space \space{}
16115 chapterstyle{companion}
16120 \begin_layout Description
16121 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
16122 optional argument in the standard classes.
16123 With this, you can specify an alternative version of the title for the
16124 table of contents and the headers (for instance, if the title is too long).
16125 In \SpecialChar LyX
16126 , you can do this via
16128 Insert\SpecialChar menuseparator
16130 \begin_inset space ~
16135 at the beginning of a chapter/section.
16136 Memoir features a second optional argument and thus separates the table
16137 of contents from the header.
16138 You can define three variants of a title with this: one for the main text,
16139 one for the table of contents, and one for the headers.
16140 Simply insert two optional arguments if you need this feature, the first
16141 one containing the short title for the Table of Contents, the second one
16142 containing an alternative short title for the headers.
16145 \begin_layout Description
16146 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
16147 of contents, the list of figures and the list of table start a new page
16149 Memoir does not follow this route.
16150 You have to insert a page break yourself, if you want to have one.
16153 \begin_layout Description
16154 Titlepage: For some unknown reason, Memoir uses pagination on the title
16155 page (in the standard classes, title pages are
16156 \begin_inset Quotes eld
16160 \begin_inset Quotes erd
16164 If you want an empty title page, type
16168 aliaspagestyle{title}{empty}
16173 \begin_layout Description
16174 Article: With the class option
16180 Layout\SpecialChar menuseparator
16181 Document\SpecialChar menuseparator
16183 \begin_inset space ~
16188 ), you can emulate article style.
16189 That is, counters (footnotes, figures, tables etc.) will not be reset on
16190 new chapters, chapters don't start a new page (but are—in contrary to
16191 \begin_inset Quotes eld
16195 \begin_inset Quotes erd
16198 article classes—still allowed), parts, though, use their own page, as in
16202 \begin_layout Description
16203 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
16204 font commands, which have been used in the old \SpecialChar LaTeX
16206 \begin_inset space \thinspace{}
16210 \begin_inset space \space{}
16226 It produces an error and stops \SpecialChar LaTeX
16227 whenever such a command appears.
16232 reallows the commands and spits out warnings instead (which does at least
16233 not stop \SpecialChar LaTeX
16235 Since a lot of packages and particularly Bib\SpecialChar TeX
16236 style files are still using
16237 those commands, we have decided to use this option by default.
16240 \begin_layout Subsection
16244 \begin_layout Standard
16245 We will only describe the features supported by \SpecialChar LyX
16246 (which is not much currently).
16247 Please consult the Memoir manual
16251 \begin_layout Plain Layout
16256 \begin_layout Plain Layout
16266 \begin_inset Flex URL
16269 \begin_layout Plain Layout
16271 CTAN:/macros/latex/memoir/memman.pdf
16284 \begin_layout Description
16285 Abstract: You may wonder why an abstract is an extra feature.
16286 Well, it is in book class.
16287 Usually books don't have abstracts.
16288 Memoir, however, has.
16289 You can use it wherever and how often you like.
16292 \begin_layout Description
16293 Chapterprecis: You may know this older typesetting style: The contents of
16294 a chapter are summarized below the title and also in the table of contents
16296 \begin_inset space \thinspace{}
16300 \begin_inset space \space{}
16305 Our hero arrives in Troia; he loses some friends; he finds others
16308 Chapterprecis does exactly this.
16309 It is therefore only sensible below a chapter.
16312 \begin_layout Description
16313 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16314 The epigraph environment provides an elegant way of typesetting such a
16316 The motto itself (text) and its author (source) are divided by a short
16318 Unfortunately, we have to fool \SpecialChar LyX
16319 a bit here again, since the environment
16320 needs two arguments (text and source).
16321 In this case, we have to use curly brackets (in \SpecialChar TeX
16322 mode) between the two
16333 <author of the slogan>.
16336 \begin_layout Description
16337 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16338 complex figurative poems).
16340 can only support a few of them.
16341 One is poemtitle, which is a centered title for poems, which will also
16342 be added to the table of contents (verse is the standard environment for
16344 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16346 because they have to be nested inside regular verse environments, which
16347 is not possible with \SpecialChar LyX
16351 \begin_layout Description
16352 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16355 \begin_layout Section
16356 Article (mwart), book (mwbk) and report (mwrep)
16357 \begin_inset Argument status
16360 \begin_layout Plain Layout
16373 \begin_layout Standard
16379 \begin_layout Standard
16380 The \SpecialChar LyX
16397 correspond to the \SpecialChar LaTeX
16411 They are replacements for the standard document classes
16423 , resp., and fit better to Polish typography conventions in a number of points.
16427 \begin_layout Standard
16431 \begin_layout Itemize
16432 Unnumbered titles (with star, e.
16433 \begin_inset space \thinspace{}
16437 \begin_inset space \space{}
16444 ) are added into table of contents,
16447 \begin_layout Itemize
16448 Additional page styles:
16452 \begin_layout Description
16453 uheadings header with separated lines,
16456 \begin_layout Description
16457 myheadings custom header, contents headers via commands:
16472 \begin_layout Description
16473 myuheadings custom header with separated lines,
16476 \begin_layout Description
16477 outer page number is placed on outer side of page
16481 \begin_layout Itemize
16486 \begin_layout Description
16487 rmheadings serif titles — default,
16490 \begin_layout Description
16491 sfheadings sansserif titles,
16494 \begin_layout Description
16495 authortitle on title page first placed is author next title — default,
16498 \begin_layout Description
16499 titleauthor on title page first placed is title next author,
16502 \begin_layout Description
16503 withmarginpar reserve place on page for margins.
16507 \begin_layout Section
16511 \begin_layout Standard
16516 provides an alternative to the standard
16521 It provides similar functionality, but you might prefer this layout with
16522 sans serif sections, headings, and more.
16525 \begin_layout Section
16526 Rev\SpecialChar TeX
16530 \begin_layout Standard
16536 \begin_layout Standard
16537 \begin_inset VSpace bigskip
16543 \begin_layout Standard
16548 \begin_inset space ~
16553 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16555 \begin_inset Formula $\beta$
16558 release of May, 1999) class.
16561 \begin_layout Standard
16567 textclass, which works with Rev\SpecialChar TeX
16569 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16571 That means that it doesn't interact very well with \SpecialChar LyX
16572 , which requires \SpecialChar LaTeX2e
16574 it has been kludged to work.
16575 Since Rev\SpecialChar TeX
16576 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16581 Rev\SpecialChar TeX
16583 \begin_inset space ~
16588 textclass should also be pretty easy to use.
16591 \begin_layout Standard
16592 These documents are supposed to be used in
16596 to the Rev\SpecialChar TeX
16597 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16599 and assume you'll know what to put in the preamble if necessary.
16602 \begin_layout Subsection
16606 \begin_layout Standard
16607 All you need to do is install Rev\SpecialChar TeX
16608 4, as described in the package's README
16610 The package can be found at The Rev\SpecialChar TeX
16612 \begin_inset Flex URL
16615 \begin_layout Plain Layout
16617 http://publish.aps.org/revtex4/
16623 Install it somewhere that \SpecialChar LaTeX
16625 Test it by trying to \SpecialChar LaTeX
16626 a short Rev\SpecialChar TeX
16627 4 document in some random directory (i.
16628 \begin_inset space \thinspace{}
16632 \begin_inset space \space{}
16635 not the directory where you installed the class file.) Then, if you reconfigure
16637 , it will find the class file and let you use the Rev\SpecialChar TeX
16641 \begin_layout Standard
16642 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16651 \begin_inset space ~
16656 template, found in the templates directory.
16659 \begin_layout Subsection
16663 \begin_layout Standard
16664 Optional arguments to
16671 \begin_inset Quotes eld
16675 \begin_inset Quotes erd
16679 \begin_inset Quotes eld
16683 \begin_inset Quotes erd
16689 \begin_inset space ~
16697 \begin_inset space ~
16703 Remember that in Rev\SpecialChar TeX
16704 , at least one optional argument is required!
16707 \begin_layout Standard
16708 Other preamble matter, like
16715 \begin_inset space ~
16722 \begin_inset space ~
16727 dialog, also as usual.
16730 \begin_layout Subsection
16734 \begin_layout Standard
16735 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16737 For example, the Email layout corresponds to
16744 Note that (at least as of Rev\SpecialChar TeX
16753 layouts are exactly equivalent, so you shouldn't need to use both.
16757 \begin_layout Plain Layout
16758 In case you're curious, both were included so that
16762 would be able to translate both
16782 \begin_layout Subsection
16786 \begin_layout Standard
16787 There are a couple of important unique aspects of Rev\SpecialChar TeX
16788 4 which might cause
16789 bugs that will be even more confusing in \SpecialChar LyX
16793 \begin_layout Standard
16794 In Rev\SpecialChar TeX
16812 The \SpecialChar LyX
16813 equivalent is that there is a separate Thanks layout.
16818 write footnotes in the
16822 layout, or weird things may happen.
16823 See the Rev\SpecialChar TeX
16824 4 documentation for more details.
16827 \begin_layout Standard
16831 \begin_inset space ~
16839 \begin_inset space ~
16848 layouts must be placed
16856 layout and the corresponding
16873 , the \SpecialChar LaTeX
16877 \begin_layout Subsection
16881 \begin_layout Standard
16882 The main problem with this layout is that you can't use the optional arguments
16883 to layouts like Email and Title.
16884 (The problem is not unique to this layout; you can't use optional arguments
16885 to the Section layouts either.) This means that after you export that file
16886 to \SpecialChar LaTeX
16887 (which you'll need to do eventually to send it in to APS), you'll need
16888 to edit the \SpecialChar LaTeX
16889 file with a text editor to add the optional arguments to set,
16891 \begin_inset space \thinspace{}
16895 \begin_inset space \space{}
16898 the running title for the page headers.
16899 Lacking these layouts makes the
16905 (and the equivalent
16911 ) useless, so the corresponding layouts don't exist, and will have to be
16916 \begin_layout Plain Layout
16921 actually, \SpecialChar LyX
16922 1.3.0 supports some forms of optional arguments, but this layout
16923 has not been updated yet to take advantage of it.
16931 \begin_layout Section
16932 Springer Journals (
16939 \begin_layout Standard
16945 \begin_layout Subsection
16949 \begin_layout Standard
16950 These are the layout files for some of the journal formats used by Springer
16951 Verlag and listed on
16952 \begin_inset Flex URL
16955 \begin_layout Plain Layout
16957 http://www.springer.de/author/tex/help-journals.html
16962 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16964 It is a modular system: the things common to all journals are implemented
16969 , which journal-specific layout files (such as, e.
16970 \begin_inset space \thinspace{}
16974 \begin_inset space \space{}
16981 for Journal of Geodesy) can include.
16984 \begin_layout Standard
16985 This means that implementing support for any other Springer journal on this
16986 list is as simple as writing your own
16994 file following the outline given in
17002 \begin_layout Standard
17003 It is reasonably well tested only for the Journal of Geodesy.
17012 come with the standard \SpecialChar LyX
17014 Install the relevant class file (downloaded from Springer) in a proper
17015 directory, reconfigure \SpecialChar LaTeX
17016 (in the te\SpecialChar TeX
17021 , as root if necessary — doesn't \SpecialChar LyX
17022 take care of this?), reconfigure \SpecialChar LyX
17027 \begin_layout Subsection
17031 \begin_layout Standard
17032 A large number of theorem-like styles —
17044 \begin_layout Standard
17047 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
17048 _Title, Author_Running, Institute,
17049 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
17052 See the Springer class file documentation for details.
17055 \begin_layout Subsection
17059 \begin_layout Itemize
17071 \begin_layout Itemize
17074 Probability Theory and Related Fields
17080 — Jean-Marc Lasgouttes
17083 \begin_layout Standard
17084 Add your own, it isn't so hard!
17087 \begin_layout Subsection
17091 \begin_layout Standard
17092 These files are partly based on the older
17096 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
17098 file from Springer.
17103 layout, are now defunct.
17104 Jean-Marc Lasgouttes helped out big in making me find my way around the
17106 layout file mechanism.
17109 \begin_layout Subsection
17113 \begin_layout Standard
17115 But probably less than in the old hacked-\SpecialChar LaTeX
17123 \begin_layout Standard
17125 \begin_inset space \thinspace{}
17128 g.: does not display the number for theorem-like layouts, just #.
17131 \begin_layout Section
17134 Sli\SpecialChar TeX
17138 \begin_inset CommandInset label
17147 \begin_layout Standard
17155 \begin_layout Subsection
17159 \begin_layout Standard
17160 This section describes how to use \SpecialChar LyX
17161 to make slides for overhead projectors.
17162 There are two document classes that can do this: the default slides class
17165 Foil\SpecialChar TeX
17169 This section documents the former.
17172 \begin_layout Standard
17173 I'm going to say this again, nice and clear, so that there's no misunderstanding
17177 \begin_layout Standard
17178 \begin_inset VSpace bigskip
17184 \begin_layout Standard
17188 This section documents the class
17189 \begin_inset Quotes eld
17197 \begin_inset Quotes erd
17205 \begin_layout Standard
17206 \begin_inset VSpace bigskip
17212 \begin_layout Standard
17213 If you're looking for the documentation for
17214 \begin_inset Quotes eld
17219 slides (Foil\SpecialChar TeX
17223 \begin_inset Quotes erd
17226 , check out section
17227 \begin_inset space ~
17231 \begin_inset CommandInset ref
17233 reference "sec:foiltex"
17243 \begin_inset Quotes eld
17248 slides (Foil\SpecialChar TeX
17252 \begin_inset Quotes erd
17255 ] is actually somewhat better than the default
17263 \begin_layout Plain Layout
17265 or so I've been told repeatedly by its advocates.
17266 Having never used it, I have no idea if this claim is true or not.
17271 which this section documents.
17274 \begin_layout Standard
17275 This class is the \SpecialChar LaTeX2e
17276 improvement of the old
17278 Sli\SpecialChar TeX
17282 Every \SpecialChar LaTeX2e
17283 distribution includes this class [which I'll just refer to as
17284 \begin_inset Quotes eld
17292 \begin_inset Quotes erd
17295 from now on], so you're bound to have it.
17296 As I noted earlier, there are other classes, such as
17300 , which also produce slides for overhead projectors and do a better job
17302 However, there are some things which
17306 can do which the others can't, such as generate overlays.
17307 Read on to learn more!
17310 \begin_layout Subsection
17312 \begin_inset CommandInset label
17314 name "sec:slidesetup"
17321 \begin_layout Standard
17322 Obviously, to use this document class, you need to select
17323 \begin_inset Quotes eld
17331 \begin_inset Quotes erd
17334 from the class list in the
17336 Document\SpecialChar menuseparator
17340 There are some other special things you should know about this class:
17343 \begin_layout Itemize
17344 Don't bother changing the options
17349 They're not supported by the
17356 \begin_layout Itemize
17360 \begin_inset space ~
17365 behaves a bit differently for this class.
17366 The possible choices and what they do are as follows:
17370 \begin_layout Description
17375 The final output contains page numbers in the lower right corner.
17378 \begin_layout Description
17387 , but also prints out any time markers you've put in.
17388 This is the default.
17391 \begin_layout Description
17396 The final output contains no page numbers, time markers, or alignment markers.
17400 \begin_layout Itemize
17405 class has an extra option:
17411 \begin_inset Quotes eld
17419 \begin_inset Quotes erd
17422 in the extra class options.
17426 \begin_layout Standard
17427 Using this options allows you to add time markers to
17433 \begin_inset space ~
17437 \begin_inset CommandInset ref
17439 reference "sec:slideNote"
17447 \begin_layout Standard
17448 You can also use the template file
17449 \begin_inset Quotes eld
17457 \begin_inset Quotes erd
17460 to automatically set up a document to use the
17466 File\SpecialChar menuseparator
17468 \begin_inset space ~
17472 \begin_inset space ~
17477 to open your new document].
17478 The template file also contains some examples of the special paragraph
17479 environments used by this class.
17480 I'll describe those next.
17483 \begin_layout Subsection
17484 Paragraph Environments
17487 \begin_layout Subsubsection
17488 Supported Environments
17491 \begin_layout Standard
17492 The first thing you'll notice when you start up a new
17496 document is the font size and type: it's the equivalent of the size
17497 \begin_inset Quotes eld
17505 \begin_inset Quotes erd
17511 \begin_inset space ~
17517 This is also what's used in the output.
17519 \begin_inset Quotes eld
17523 \begin_inset Quotes erd
17526 to remind you that this is a slide.
17527 Your final slides will use a larger font; ergo, you'll have less space.
17528 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17531 \begin_layout Standard
17532 The next thing that becomes obvious is the changes to the paragraph environment
17533 pull-down box [at the far-left end of the toolbar].
17534 Most of the paragraph environments you're used to seeing are missing.
17535 There are also five new ones.
17540 class itself only supports certain paragraph environments:
17543 \begin_layout Itemize
17549 \begin_layout Itemize
17555 \begin_layout Itemize
17561 \begin_layout Itemize
17567 \begin_layout Itemize
17573 \begin_layout Itemize
17579 \begin_layout Itemize
17585 \begin_layout Itemize
17591 \begin_layout Itemize
17597 \begin_layout Itemize
17604 \begin_layout Itemize
17610 \begin_layout Standard
17611 All of the other standard environments, including the section-heading environmen
17612 ts, aren't used in the
17619 \begin_layout Standard
17620 On the other hand, you'll notice the following new environments:
17623 \begin_layout Itemize
17629 \begin_layout Itemize
17635 \begin_layout Itemize
17641 \begin_layout Itemize
17647 \begin_layout Itemize
17653 \begin_layout Standard
17654 These five are kind of quirky, due to a
17655 \begin_inset Quotes eld
17659 \begin_inset Quotes erd
17662 in \SpecialChar LyX
17664 You see, \SpecialChar LyX
17665 doesn't permit you to nest any other paragraph environment into
17666 an empty environment.
17667 Now, that's fine and dandy, but it means that you wouldn't be able to start
17668 a slide with anything except plain text.
17669 To deal with this, I've performed a little
17670 \begin_inset Quotes eld
17675 \begin_inset Quotes erd
17681 \begin_layout Subsubsection
17682 Quirks of the New Environments
17683 \begin_inset CommandInset label
17685 name "sec:slideQuirk"
17692 \begin_layout Standard
17693 All five of the new paragraph environments are somewhat quirky due to inherent
17694 limitiations in the current version of \SpecialChar LyX
17696 As I just mentioned, \SpecialChar LyX
17697 forbids environments that begin with another environment.
17698 To get around this, the
17702 environment isn't a paragraph environment as described in the
17710 \begin_layout Standard
17711 You should consider
17724 \begin_inset Quotes eld
17727 pseudo-environments.
17728 \begin_inset Quotes erd
17731 They look like a section heading or a
17732 \begin_inset Quotes eld
17740 \begin_inset Quotes erd
17743 but really begin a [and, if necessary, end the previous] paragraph environment.
17753 \begin_inset Quotes eld
17757 \begin_inset Quotes erd
17760 These two perform some action.
17763 \begin_layout Standard
17764 A common feature of all five environments,
17784 , is a rather long-ish label.
17785 The text following this label — ordinarily the contents of the paragraph
17786 environment — is utterly irrelevant for
17808 completely ignores it.
17809 In fact, you can leave these five environments completely empty.
17813 \begin_layout Standard
17818 to put any text after the rather long-ish label, you might want to.
17819 This could be a short description of the contents of the
17824 In that case, enter your descriptive comment and hit
17828 as you normally would.
17831 \begin_layout Standard
17832 If, on the other hand, you don't want to enter any descriptive text, you'll
17833 hit another \SpecialChar LyX
17836 , like nature, abhors a vacuum, and will not let you start a new paragraph
17837 environment until you put something in the old one.
17841 \begin_layout Itemize
17842 Start entering the text that will
17870 \begin_layout Itemize
17871 Now move to the beginning of that paragraph.
17875 \begin_layout Itemize
17884 \begin_layout Itemize
17885 Finally, change this new, empty paragraph to a
17909 \begin_layout Standard
17910 Some future version of \SpecialChar LyX
17911 will, hopefully, resolve this quirkiness\SpecialChar ldots
17915 \begin_layout Subsection
17916 Making a Presentation with
17929 \begin_layout Subsubsection
17937 \begin_layout Standard
17938 If you're expecting this section to teach you how to actually make a presentatio
17939 n, you'll be sorely disappointed.
17940 Naturally, I'll describe all of the ways the
17944 class can assist you in preparing the materials for a presentation.
17945 Filling in the contents, however, is up to you.
17950 the \SpecialChar LyX
17954 \begin_layout Standard
17959 environment [in the manner described in section
17960 \begin_inset space ~
17964 \begin_inset CommandInset ref
17966 reference "sec:slideQuirk"
17970 ] tells \SpecialChar LyX
17971 to begin a new slide [duh].
17972 The label for this environment/
17973 \begin_inset Quotes erd
17977 \begin_inset Quotes erd
17981 \begin_inset Quotes eld
17985 \begin_inset Quotes erd
17988 in cool blue, followed by the label,
17989 \begin_inset Quotes eld
17993 \begin_inset Quotes erd
17997 Any text or paragraph environments that follow this one go on the new slide.
18001 \begin_layout Standard
18002 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
18004 (this can be specified in the
18009 In fact, you'll want to, once you finish entering the contents of one slide.
18010 If you've entered more text than can physically fit on a slide, the extra
18011 overflows onto a new slide.
18012 I don't recommend doing this, however, since the overflow slide won't have
18013 any page number on it.
18014 Furthermore, it may interfere with any
18018 you've made to accompany the oversized
18025 \begin_layout Standard
18034 environments work the same way as the
18039 They both create an
18040 \begin_inset Quotes eld
18044 \begin_inset Quotes erd
18047 followed by a label [
18048 \begin_inset Quotes eld
18052 \begin_inset Quotes erd
18056 \begin_inset Quotes eld
18060 \begin_inset Quotes erd
18064 The color is a stunning magenta instead of blue, and the
18065 \begin_inset Quotes eld
18069 \begin_inset Quotes erd
18072 will look different, in style and in length.
18073 The label fonts of all three also differ from one another.
18076 \begin_layout Standard
18081 , if the contents of a
18089 exceed the physical size of a slide or sheet of paper, the extra will overflow
18091 Again, you should avoid this.
18092 It defeats the whole purpose of
18103 \begin_layout Subsubsection
18113 \begin_layout Standard
18118 is a slide that sits atop another slide.
18119 Perhaps you wish to discuss a figure on the main
18123 before displaying the text associated with it.
18124 One way to accomplish this is tape a flap of dark paper over the part of
18129 you want to display later.
18130 This method fails, however, if you wish to overlap one graph with another,
18132 You would then have to fumble while speaking to align the two separate,
18137 s to align the two graphs.
18142 environment in both cases makes life much easier.
18145 \begin_layout Standard
18150 receives the page number of its
18151 \begin_inset Quotes eld
18155 \begin_inset Quotes erd
18163 \begin_inset Quotes eld
18171 \begin_inset Quotes erd
18178 \begin_layout Plain Layout
18179 Presumably, mutliple
18184 \begin_inset Quotes eld
18192 \begin_inset Quotes erd
18196 \begin_inset Quotes eld
18204 \begin_inset Quotes erd
18208 \begin_inset Quotes eld
18216 \begin_inset Quotes erd
18220 \begin_inset space ~
18223 appended to the page number of the parent
18233 Clearly, you want the contents of both the
18241 to each fit on a single physical slide! You should probably consider an
18247 \begin_inset Quotes eld
18251 \begin_inset Quotes erd
18259 Indeed, the \SpecialChar LyX
18264 class provides a visual cue for this: the label at the start of an
18268 is shorter than that at the start of a
18273 Lastly, when you generate printable output, you'll find alignment markers
18274 in all four corners of both the
18278 page and its parent
18283 These will assist you in lining up the two physical slides.
18286 \begin_layout Standard
18287 The major problem in overlaying two slides is aligning the contents of the
18288 two transparencies.
18289 How much space should you leave for that graph on the second slide? Worse
18290 still, what if you want a graph and a sentence on second slide, but there
18291 is text on the main transparency that goes in between them? You could try
18292 and insert vertical space of the right size.
18293 The better way is to use
18304 \begin_layout Standard
18305 As their names imply,
18313 are two command-like paragraph environments that make all subsequent text
18314 invisible and visible, respectively.
18316 \begin_inset space ~
18320 \begin_inset CommandInset ref
18322 reference "sec:slideQuirk"
18326 that you don't place anything
18330 these two environments, however.
18335 , it inserts a centered, sky-blue label into the page reading
18336 \begin_inset Quotes eld
18339 <Invisible Text Follows>
18340 \begin_inset Quotes erd
18344 For paragraphs following this label, the parts of the
18352 ; it doesn't matter which] where they would be contain instead blank space.
18356 \begin_layout Standard
18361 , the corresponding centered label is
18362 \begin_inset Quotes eld
18365 <Visible Text Follows>
18366 \begin_inset Quotes erd
18370 Paragraphs following this label behave normally.
18371 Note that the beginning of a new
18383 automatically shuts off an
18388 It's therefore not necessary to use
18399 \begin_layout Standard
18400 By now, it should be obvious how to create overlay transparencies using
18401 the proper combination of
18420 \begin_layout Enumerate
18425 , including everything that will appear on it, whether on the main slide
18433 \begin_layout Enumerate
18434 Before each figure or paragraph that will appear only on the
18443 If necessary, insert a
18447 environment after the
18454 \begin_layout Enumerate
18459 immediately following the
18466 \begin_layout Enumerate
18467 Copy the contents of this
18478 \begin_layout Enumerate
18483 , change all of the
18494 \begin_layout Standard
18496 You've just made an
18503 \begin_layout Standard
18504 There's one problem with the way I've designed the \SpecialChar LyX
18509 class: you can't make text in the middle of a paragraph invisible, nor
18510 make text in the middle of an invisible paragraph visible again.
18511 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18516 \begin_layout Plain Layout
18517 The commands of interest are:
18520 \begin_layout Itemize
18525 invisible \SpecialChar ldots
18529 \begin_layout Itemize
18534 visible \SpecialChar ldots
18538 \begin_layout Plain Layout
18540 and need to be marked as \SpecialChar TeX
18543 \begin_inset Quotes eld
18547 \begin_inset Quotes erd
18550 you wish to change goes in between the brackets [and after the
18563 If you don't know how to mark text as \SpecialChar TeX
18564 , see the appropriate section of
18577 \begin_layout Subsubsection
18587 \begin_inset CommandInset label
18589 name "sec:slideNote"
18596 \begin_layout Standard
18605 is associated with a
18606 \begin_inset Quotes eld
18610 \begin_inset Quotes erd
18618 Here, too, the \SpecialChar LyX
18623 class provides visual cues.
18628 is shorter than that of a
18632 [yet longer than that of an
18636 ] and, like the label of an
18640 is shockingly magenta.
18641 Additionally, the printed
18645 has the page number of its
18646 \begin_inset Quotes eld
18650 \begin_inset Quotes erd
18658 \begin_inset Quotes eld
18666 \begin_inset Quotes erd
18670 \begin_inset Quotes eld
18678 \begin_inset Quotes erd
18682 \begin_inset Quotes eld
18690 \begin_inset Quotes erd
18694 You can have multiple
18698 s associated with a single
18710 , you'll probably want to break up long
18714 s so that they fit on a single sheet of paper.
18717 \begin_layout Standard
18722 is obvious: it contains anything additional you might want to say about
18728 It could also be used as a sheet of reminders for a particular
18733 In the case of the latter, you might want to make use of time markers.
18734 Currently, the \SpecialChar LyX
18740 \begin_inset Quotes eld
18744 \begin_inset Quotes erd
18747 support for time markers, a
18749 Sli\SpecialChar TeX
18753 So, you'll have to resort to using the \SpecialChar LaTeX
18757 \begin_layout Standard
18758 To use time markers, you'll need to specify the extra class option
18759 \begin_inset Quotes eld
18767 \begin_inset Quotes erd
18771 \begin_inset space ~
18775 \begin_inset CommandInset ref
18777 reference "sec:slidesetup"
18782 This option turns on timing marks, which will appear in the lower-left-hand
18788 To set what appears in the time marker, you use the \SpecialChar LaTeX
18790 \begin_inset Quotes eld
18800 \begin_inset Quotes erd
18804 \begin_inset Quotes eld
18814 \begin_inset Quotes erd
18818 The arguments of both commands are time measured in seconds.
18820 \begin_inset Quotes eld
18830 \begin_inset Quotes erd
18833 sets the time marker to a given time.
18835 \begin_inset Quotes eld
18845 \begin_inset Quotes erd
18848 increments the time marker by the specified amount.
18849 Using time markers and
18853 s in this fashion, you can remind yourself how much time to spend on a particula
18861 \begin_layout Standard
18862 There's one last feature to describe.
18863 Clearly, you'd like to print out all of your
18871 s on transparencies while printing all of your
18888 with which it is associated.
18889 What's a person to do?
18892 \begin_layout Standard
18893 Luckily, there are two \SpecialChar LaTeX
18894 commands that allow you to select what to print
18896 Both must be placed into the preamble of your document.
18898 \begin_inset Quotes eld
18910 \begin_inset Quotes erd
18913 will cause the output to contain only the
18922 Correspondingly, the command
18923 \begin_inset Quotes eld
18935 \begin_inset Quotes erd
18938 prevents the output of anything but
18943 I'd advise placing both commands in the preamble and initially comment
18945 You can then preview your entire presentation as you write.
18946 When you're done writing, you can then uncomment one of the two to select
18947 what you want to print.
18948 I like to uncomment
18949 \begin_inset Quotes eld
18961 \begin_inset Quotes erd
18964 , print to a file with
18965 \begin_inset Quotes eld
18973 \begin_inset Quotes erd
18976 in its name, comment it back out, then uncomment
18977 \begin_inset Quotes eld
18989 \begin_inset Quotes erd
18993 \begin_inset Quotes eld
19001 \begin_inset Quotes erd
19005 I can then send either file to a printer, loading transparencies or plain
19006 paper as appropriate.
19009 \begin_layout Standard
19010 You can also provide other arguments to the
19011 \begin_inset Quotes eld
19021 \begin_inset Quotes erd
19025 \begin_inset Quotes eld
19035 \begin_inset Quotes erd
19039 See a good \SpecialChar LaTeX
19043 \begin_layout Subsection
19048 Class Template File
19051 \begin_layout Standard
19052 I have also provided a template file,
19053 \begin_inset Quotes eld
19061 \begin_inset Quotes erd
19069 To use it, begin your new presentation with
19071 File\SpecialChar menuseparator
19073 \begin_inset space ~
19077 \begin_inset space ~
19083 Your new \SpecialChar LyX
19084 presentation file will contain an example
19105 additionally contain an example of the use of
19114 Lastly, the preamble will contain:
19117 \begin_layout LyX-Code
19118 % Uncomment to print out only slides and overlays
19121 \begin_layout LyX-Code
19125 \begin_layout LyX-Code
19131 \begin_inset Newline newline
19137 \begin_layout LyX-Code
19138 % Uncomment to print out only notes
19141 \begin_layout LyX-Code
19145 \begin_layout LyX-Code
19153 \begin_layout Standard
19154 One final thing: I created this class to support the \SpecialChar LaTeX2e
19156 \begin_inset Quotes eld
19161 Sli\SpecialChar TeX
19165 \begin_inset Quotes erd
19168 class, one of the built-in \SpecialChar LaTeX2e
19170 Neither I nor the rest of the \SpecialChar LyX
19171 Team endorse or oppose the use of this built-in
19173 It's here if you want it or need it.
19174 There exist other \SpecialChar LaTeX2e
19175 classes for creating presentations, such as the
19180 \begin_inset space ~
19184 \begin_inset CommandInset ref
19186 reference "sec:foiltex"
19191 \begin_inset Quotes eld
19199 \begin_inset Quotes erd
19202 package [present on some \SpecialChar TeX
19204 The latter is not yet supported under \SpecialChar LyX
19209 \begin_layout Plain Layout
19210 Perhaps you can take on the task\SpecialChar ldots
19216 I know nothing about these other classes.
19217 Try them out to see what sort of alternative they provide.
19220 \begin_layout Chapter
19222 Features needing Extra Software
19225 \begin_layout Section
19226 Checking \SpecialChar TeX
19230 \begin_layout Standard
19236 \begin_layout Subsection
19240 \begin_layout Standard
19249 \begin_layout Plain Layout
19254 is not yet available when you are using the \SpecialChar LaTeX
19255 distribution MiK\SpecialChar TeX
19261 , you'll find in the
19268 \begin_inset space ~
19279 \begin_inset Newline newline
19283 \begin_inset CommandInset href
19285 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19293 \begin_layout Standard
19296 Chk\SpecialChar TeX
19299 package is a program that was written by
19300 \begin_inset Flex Noun
19303 \begin_layout Plain Layout
19305 \begin_inset space ~
19313 in frustration because some constructs in \SpecialChar LaTeX
19314 are sometimes non-intuitive,
19315 and easy to forget.
19316 The program runs over your \SpecialChar LaTeX
19317 file, checks the integrity of the file, and
19318 flags some common errors.
19319 In other technical words, it is
19323 for \SpecialChar LaTeX
19327 \begin_layout Standard
19328 Well, what is a syntax checker doing in \SpecialChar LyX
19329 which is supposed to produce correct
19331 anyways? The answer is simple: Just as
19335 not only checks the
19339 of C programs, but also does
19343 checks for type-errors,
19345 Chk\SpecialChar TeX
19348 catches some common
19352 errors, in addition to the syntactical ones.
19355 Chk\SpecialChar TeX
19358 is capable of detecting several common errors, such as
19361 \begin_layout Itemize
19362 Ellipsis detection:
19363 \begin_inset Newline newline
19366 Use \SpecialChar ldots
19370 \begin_layout Itemize
19371 No space in front of/after parenthesis:
19372 \begin_inset Newline newline
19378 \begin_layout Itemize
19379 Enforcement of normal space after common abbreviations:
19380 \begin_inset Newline newline
19384 \begin_inset space \thinspace{}
19388 \begin_inset space \space{}
19391 is too wide spacing.
19394 \begin_layout Itemize
19395 Enforcement of end-of-sentence space when the last sentence ends with a
19397 \begin_inset Newline newline
19401 And this is wrong spacing.
19404 \begin_layout Itemize
19405 Space in front of labels and similar commands:
19406 \begin_inset Newline newline
19409 The label should stick right up to the text to avoid falling to a wrong
19412 \begin_inset CommandInset label
19422 \begin_layout Plain Layout
19423 This footnote is in danger of falling off to a wrong page
19428 The label is separated too much.
19431 \begin_layout Itemize
19432 Space in front of references, instead of hard spaces:
19433 \begin_inset Newline newline
19436 If you have bad luck, the text will break right between the referenced text
19437 and reference number, and that's a pity.
19439 \begin_inset CommandInset ref
19441 reference "sec:chktex"
19448 \begin_layout Itemize
19450 \begin_inset Quotes eld
19454 \begin_inset Quotes erd
19458 \begin_inset Formula $\times$
19462 \begin_inset Newline newline
19465 2x2 looks cheap compared to
19466 \begin_inset Formula $2\times2$
19472 \begin_layout Standard
19473 and more \SpecialChar ldots
19474 It is an invaluable tool when you are
19475 \begin_inset Quotes eld
19479 \begin_inset Quotes erd
19482 your document before printing, and you should run it right after the obligatory
19483 spelling check, and before you go fine tuning the typesetting.
19486 \begin_layout Subsection
19490 \begin_layout Standard
19491 If you have the program installed, usage is as simple as choosing
19493 Tools\SpecialChar menuseparator
19495 \begin_inset space ~
19501 This will make \SpecialChar LyX
19502 generate a \SpecialChar LaTeX
19503 file of your document, start
19505 Chk\SpecialChar TeX
19508 to check it, and then make \SpecialChar LyX
19510 \begin_inset Quotes eld
19514 \begin_inset Quotes erd
19517 with the warnings from
19519 Chk\SpecialChar TeX
19522 , if there were any.
19523 The warnings will be placed close to the point of the mistake, and you
19524 can quickly find them by using the
19526 Navigate\SpecialChar menuseparator
19529 menu item, or the shortcut key
19538 Open the error boxes by clicking on them with the mouse, or use the shortcut
19547 bindings, or the corresponding
19556 Read the warning and correct the mistake, if it is a mistake.
19557 If you have trouble understanding what the warning is about, you can safely
19559 Remember that there is a hidden layer between the document on screen and
19560 the technical details in invoking
19562 Chk\SpecialChar TeX
19565 , and this gap can make some warnings seem arcane or just plain silly.
19568 \begin_layout Standard
19569 This document is an excellent testing bed for the feature, and it should
19570 provide quite a few warnings for you to fiddle with.
19571 Since computers are only so smart, expect most of the warnings to be false
19575 \begin_layout Subsection
19576 How to fine tune it
19579 \begin_layout Standard
19580 Sometimes, you'll find that
19582 Chk\SpecialChar TeX
19585 makes more noise than suits your mood.
19586 Then you can choose not to use it, wait until your mood changes, or try
19589 Chk\SpecialChar TeX
19592 to get better along with you.
19595 \begin_layout Standard
19598 Chk\SpecialChar TeX
19605 very configurable and extensible, you should not expect to solve all problems
19608 Chk\SpecialChar TeX
19611 in \SpecialChar LyX
19613 Since \SpecialChar LyX
19614 has to generate a somewhat special \SpecialChar LaTeX
19615 file to be able to match the
19616 line numbers from the
19618 Chk\SpecialChar TeX
19625 \begin_layout Plain Layout
19626 You can inspect the specific output from
19632 Document\SpecialChar menuseparator
19635 \begin_inset space ~
19649 to the internal document structure, some of the warnings will not appear
19651 There are two things you can do about this:
19654 \begin_layout Itemize
19657 Chk\SpecialChar TeX
19660 invocation command line in
19661 \begin_inset Flex Noun
19664 \begin_layout Plain Layout
19665 Tools\SpecialChar menuseparator
19666 Preferences\SpecialChar menuseparator
19667 Output\SpecialChar menuseparator
19668 LaTeX\SpecialChar menuseparator
19676 Chk\SpecialChar TeX
19679 installation configuration file (usually with the file
19684 See below to learn what warnings can be enabled and disabled on the command
19688 \begin_layout Itemize
19689 Export your document as a raw \SpecialChar LaTeX
19692 File\SpecialChar menuseparator
19693 Export\SpecialChar menuseparator
19702 Invoked in this way, it can be a hassle to find the corresponding place
19703 in the document inside \SpecialChar LyX
19704 , but with a little patience, you should be able
19708 \begin_layout Standard
19709 Here follows the warning messages that can be enabled and disabled in
19718 to disable a warning, and
19722 to enable a warning.
19723 The emphasized entries are disabled by default, because the default is
19726 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19731 \begin_layout Standard
19732 Notice that you should only use the options that enable and disable warnings,
19733 because \SpecialChar LyX
19734 relies on some of the other command line parameters to be set
19735 in a specific way to have a chance to communicate with
19742 \begin_layout Enumerate
19746 Command terminated with space.
19749 \begin_layout Enumerate
19752 Non-breaking space (
19753 \begin_inset Quotes eld
19761 \begin_inset Quotes erd
19764 ) should have been used.
19767 \begin_layout Enumerate
19771 You should enclose the previous parenthesis with
19772 \begin_inset Quotes eld
19780 \begin_inset Quotes erd
19786 \begin_layout Enumerate
19789 Italic correction (
19790 \begin_inset Quotes eld
19800 \begin_inset Quotes erd
19803 ) found in non-italic buffer.
19806 \begin_layout Enumerate
19809 Italic correction (
19810 \begin_inset Quotes eld
19820 \begin_inset Quotes erd
19823 ) found more than once.
19826 \begin_layout Enumerate
19830 No italic correction (
19831 \begin_inset Quotes eld
19841 \begin_inset Quotes erd
19847 \begin_layout Enumerate
19851 \begin_inset Quotes eld
19859 \begin_inset Quotes erd
19863 \begin_inset Quotes eld
19871 \begin_inset Quotes erd
19877 \begin_layout Enumerate
19880 Wrong length of dash may have been used.
19883 \begin_layout Enumerate
19887 \begin_inset Quotes eld
19895 \begin_inset Quotes erd
19899 \begin_inset Quotes eld
19907 \begin_inset Quotes erd
19913 \begin_layout Enumerate
19917 \begin_inset Quotes eld
19925 \begin_inset Quotes erd
19931 \begin_layout Enumerate
19935 \begin_inset Quotes eld
19943 \begin_inset Quotes erd
19946 to achieve an ellipsis.
19949 \begin_layout Enumerate
19952 Inter-word spacing (
19953 \begin_inset Quotes eld
19963 \begin_inset Quotes eld
19966 ) should perhaps be used.
19969 \begin_layout Enumerate
19972 Inter-sentence spacing (
19973 \begin_inset Quotes eld
19983 \begin_inset Quotes erd
19986 ) should perhaps be used.
19989 \begin_layout Enumerate
19992 Could not find argument for command.
19995 \begin_layout Enumerate
19999 \begin_inset Quotes eld
20007 \begin_inset Quotes erd
20013 \begin_layout Enumerate
20016 Math mode still on at end of \SpecialChar LaTeX
20020 \begin_layout Enumerate
20024 \begin_inset Quotes eld
20032 \begin_inset Quotes erd
20035 doesn't match the number of
20036 \begin_inset Quotes eld
20044 \begin_inset Quotes erd
20050 \begin_layout Enumerate
20053 You should use either
20056 \begin_inset Quotes eld
20064 \begin_inset Quotes erd
20069 as an alternative to
20070 \begin_inset Quotes eld
20078 \begin_inset Quotes erd
20084 \begin_layout Enumerate
20091 " (ASCII 39) instead of "
20098 \begin_layout Enumerate
20101 User-specified pattern found.
20104 \begin_layout Enumerate
20107 This command might not be intended.
20110 \begin_layout Enumerate
20117 \begin_layout Enumerate
20135 \begin_layout Enumerate
20138 Delete this space to maintain correct page references.
20141 \begin_layout Enumerate
20145 You might wish to put this between a pair of
20146 \begin_inset Quotes eld
20154 \begin_inset Quotes erd
20160 \begin_layout Enumerate
20163 You ought to remove spaces in front of punctuation.
20166 \begin_layout Enumerate
20169 Could not execute \SpecialChar LaTeX
20173 \begin_layout Enumerate
20182 in front of small punctuation.
20185 \begin_layout Enumerate
20193 may look prettier here.
20196 \begin_layout Enumerate
20200 Multiple spaces detected in output.
20203 \begin_layout Enumerate
20206 This text may be ignored.
20209 \begin_layout Enumerate
20215 \begin_inset Quotes eld
20220 to begin quotation, not
20227 \begin_layout Enumerate
20234 to end quotation, not
20237 \begin_inset Quotes eld
20245 \begin_layout Enumerate
20251 \begin_layout Enumerate
20254 You should perhaps use
20255 \begin_inset Quotes eld
20263 \begin_inset Quotes erd
20269 \begin_layout Enumerate
20272 You should put a space in front of/after parenthesis.
20275 \begin_layout Enumerate
20278 You should avoid spaces in front of/after parenthesis.
20281 \begin_layout Enumerate
20285 You should not use punctuation in front of/after quotes.
20288 \begin_layout Enumerate
20291 Double space found.
20294 \begin_layout Enumerate
20297 You should put punctuation outside inner/inside display math mode.
20300 \begin_layout Enumerate
20303 You ought to not use primitive \SpecialChar TeX
20304 in \SpecialChar LaTeX
20308 \begin_layout Enumerate
20311 You should remove spaces in front of
20312 \begin_inset Quotes eld
20320 \begin_inset Quotes erd
20326 \begin_layout Enumerate
20329 \begin_inset Quotes eld
20337 \begin_inset Quotes erd
20340 is normally not followed by
20341 \begin_inset Quotes eld
20349 \begin_inset Quotes erd
20355 \begin_layout Standard
20356 In later versions of \SpecialChar LyX
20357 , we hope to provide a more complete interface to this
20358 tool (and it's smaller cousin
20362 ) to exploit the full power of it.
20363 But it's not exactly useless as it is now: go try it on one of your existing
20364 documents of a certain length and be surprised.
20367 \begin_layout Section
20368 Version Control in \SpecialChar LyX
20372 \begin_layout Standard
20375 Lars Gullik Bjønnes
20382 \begin_layout Subsection
20386 \begin_layout Standard
20388 supports some of the most basic RCS/CVS/SVN/GIT commands.
20389 If you need something a bit more sophisticated you will have to do that
20390 manually in a terminal.
20393 \begin_layout Standard
20394 Also note that CVS support is not as good as subversion support so we advise
20396 A good place to start learning Subversion is SVN Book
20400 \begin_layout Plain Layout
20401 \begin_inset CommandInset href
20403 target "http://svnbook.red-bean.com/"
20414 In the case of RCS you should read
20415 \begin_inset Quotes eld
20419 \begin_inset Quotes erd
20422 (a man file, read it with
20427 This file describes all the basic features of RCS.
20428 You should especially notice the comment about a RCS directory, and the
20429 notion of a master RCS file (the file ending in
20436 \begin_layout Standard
20437 Before you begin to use the version control features in \SpecialChar LyX
20439 familiar with RCS/CVS/SVN/GIT usage.
20440 The implementation in \SpecialChar LyX
20441 assumes a recent version of the GNU RCS or CVS/SVN
20442 package — no guarantees are made for older versions.
20443 Most of the log messages are not currently displayed after operations —
20444 you can check them in the Messages pane if unsure.
20445 Regular users of version control will appreciate VC toolbar, which can
20448 View\SpecialChar menuseparator
20449 Toolbars\SpecialChar menuseparator
20451 \begin_inset space ~
20459 \begin_layout Standard
20460 For introducing your own external commands consult vc-command in the manual
20461 of \SpecialChar LyX
20465 \begin_layout Standard
20466 It is strongly recommended to store documents in uncompressed format if
20467 using version control (uncheck
20469 Document\SpecialChar menuseparator
20472 if it is checked): Uncompressed LyX documents are text files and therefore
20473 for merging two different versions by version control systems.
20474 Compressed LyX documents are binary files, which cannot be merged by version
20478 \begin_layout Subsection
20479 RCS commands in \SpecialChar LyX
20483 \begin_layout Standard
20484 The following sections describe the RCS commands supported by \SpecialChar LyX
20486 You can find them in the
20488 File\SpecialChar menuseparator
20490 \begin_inset space ~
20497 was tested against RCS 5.7/5.8.
20500 \begin_layout Subsubsection
20506 \begin_layout Standard
20507 If your document is not under revision control, this is the only item shown
20509 And if it is under revision control, the
20513 item is not visible.
20517 \begin_layout Standard
20518 This command registers your document with RCS (unless you are under the
20519 directory managed by CVS)\SpecialChar endofsentence
20520 You are asked interactively to supply an initial
20521 description of the document.
20522 The document is now set in Read-Only mode and you have to
20525 \begin_inset space ~
20529 \begin_inset space ~
20533 \begin_inset space ~
20538 , before making any changes to it.
20539 A document under revision control has a
20540 \begin_inset Quotes eld
20543 [RCS:<version> <locker>]
20544 \begin_inset Quotes erd
20547 item tagged to the filename in the minibuffer.
20550 \begin_layout Standard
20551 RCS command that is run:
20553 ci -q -u -i -t-"<initial description>" <file-name>
20556 \begin_layout Standard
20561 to understand the switches.
20565 \begin_layout Subsubsection
20571 \begin_layout Standard
20572 When you are finished editing a file, you check in your changes.
20573 When you do this, you are asked for a description of the changes.
20574 This is stored in the history log.
20575 The version number is bumped, your changes are applied to the master RCS
20576 file, the document is unlocked and set to Read-Only mode.
20579 \begin_layout Standard
20582 ci -q -u -m"<description>" <file-name>
20585 \begin_layout Subsubsection
20591 \begin_layout Standard
20592 By doing this you lock the document so that only you can edit it.
20593 This will also make the document Read-Write only for you.
20594 You will usually continue editing for a while and when you are finished
20595 you check in your changes.
20596 The status line is changed to reflect that you have locked the file.
20599 \begin_layout Standard
20602 co -q -l <file-name>
20605 \begin_layout Subsubsection
20608 Revert To Repository Version
20611 \begin_layout Standard
20612 This will discard all changes made to the document since the last check
20614 You get a warning before changes are discarded.
20617 \begin_layout Standard
20620 co -f -u<version> <file-name>
20623 \begin_layout Subsubsection
20629 \begin_layout Standard
20630 This will create a copy of the current document.
20631 Since RCS does not support copy operations natively, the version history
20632 is not preserved, and the copy is added as a new file.
20633 It requires a clean document without any changes since the last checkin.
20634 You are asked for a file name and a description of the copy operation.
20635 After that the copy is created, both locally and in the repository.
20636 If the parent directories of the copied and original document differ, all
20637 relative paths of included files of the copy are adjusted (like in
20639 File\SpecialChar menuseparator
20644 Finally, the copy is loaded instead of the original document.
20647 \begin_layout Labeling
20648 \labelwidthstring 00.00.0000
20650 \begin_inset space ~
20654 \begin_inset space ~
20658 \begin_inset Newline newline
20662 \begin_inset Flex Code
20665 \begin_layout Plain Layout
20668 \begin_inset Quotes eld
20672 \begin_inset Quotes erd
20681 \begin_inset Flex Code
20684 \begin_layout Plain Layout
20687 \begin_inset Quotes eld
20691 \begin_inset Quotes erd
20700 \begin_inset Newline newline
20704 \begin_inset Flex Code
20707 \begin_layout Plain Layout
20711 \begin_inset Quotes eld
20715 \begin_inset Quotes erd
20726 \begin_layout Subsubsection
20732 \begin_layout Standard
20733 This makes as if the last check in never happened.
20734 No changes are made to the document loaded into \SpecialChar LyX
20735 , but the last version
20736 is removed from the master RCS file.
20739 \begin_layout Standard
20742 rcs -o<version> <file-name>
20745 \begin_layout Subsubsection
20751 \begin_layout Standard
20752 This shows the complete history of the RCS document.
20757 is shown in a browser.
20765 \begin_layout Subsubsection
20769 \begin_layout Standard
20771 supports RCS version number, author name, date and time of last commit.
20772 All those are extracted from
20774 rlog -r <file-name>
20778 \begin_inset CommandInset ref
20780 reference "subsec:VCS-Revision-Information"
20787 \begin_layout Subsection
20788 CVS commands in \SpecialChar LyX
20792 \begin_layout Standard
20793 A subset of CVS operations is supported by \SpecialChar LyX
20795 You can find the commands in the
20797 File\SpecialChar menuseparator
20799 \begin_inset space ~
20805 The version control system SVN is more powerful, so please use it instead
20806 of CVS if possible.
20809 \begin_layout Subsubsection
20815 \begin_layout Standard
20816 If you start from scratch with CVS you have to create your repository and
20817 checkout the working copy with external tools.
20818 If you're using a client-server setup you may need to login before doing
20819 the first repository checkout.
20822 \begin_layout Standard
20823 If your documents are under revision control and others are using the same
20824 repository problems arise when different changes to the same document at
20825 the same location happen.
20826 Standard CVS repositories don't operate with a file locking mechanism.
20827 This may be surprising, but conflicts only occur if people disagree on
20828 the proper content of the same part of a document.
20829 So, if co-workers are used to communicate regularly, these conflicts occur
20831 If they don't communicate they have a fundamental problem anyway.
20832 Nevertheless some people like to work with so called
20833 \begin_inset Quotes eld
20837 \begin_inset Quotes erd
20841 If they do so the working copy of all files is readonly when checked out
20842 first and the user starts editing after using a special command to make
20843 the working copy writable.
20844 When the changes are checked in the working copy returns to readonly state.
20845 With \SpecialChar LyX
20846 one has to edit the
20847 \begin_inset Flex Code
20850 \begin_layout Plain Layout
20856 file and add the line
20857 \begin_inset Flex Code
20860 \begin_layout Plain Layout
20866 to work with reserved checkouts.
20867 The benefit is the possibility to see who is using a writable copy of some
20869 It's not guaranteed only one user makes a copy writable.
20872 \begin_layout Standard
20874 tries to guess if you're using reserved or non-reserved checkouts.
20875 If your working copy is readonly or it is writable and an additional copy
20876 of your document exists in the CVS/Base sub-directory a reserved otherwise
20877 a non-reserved checkout is assumed.
20878 When a reserved checkout is detected you have to use
20879 \begin_inset Flex Noun
20882 \begin_layout Plain Layout
20888 to make your working copy writable if it's readonly.
20890 \begin_inset Flex Noun
20893 \begin_layout Plain Layout
20899 operation is possible and that makes your working copy readonly again after
20900 transferring your changes to the repository.
20903 \begin_layout Standard
20904 More information about CVS can be found here
20905 \begin_inset Flex URL
20908 \begin_layout Plain Layout
20910 http://www.nongnu.org/cvs
20916 \begin_inset Flex URL
20919 \begin_layout Plain Layout
20921 http://ximbiot.com/cvs
20929 \begin_layout Standard
20934 to understand the sub-commands and the switches mentioned below.
20937 \begin_layout Subsubsection
20943 \begin_layout Standard
20944 If your document is not under revision control, this is the only item shown
20946 And if it is under revision control, the
20950 item is not visible.
20954 \begin_layout Standard
20955 This command registers in CVS your document
20956 \begin_inset Flex Strong
20959 \begin_layout Plain Layout
20967 in the case you have already the documents directory under CVS control
20973 This means you have to create or checkout the archive by yourself using
20975 (In case you forget that step \SpecialChar LyX
20976 registers the document with RCS.)
20979 \begin_layout Standard
20980 Then you are asked interactively to supply an initial description of the
20982 Don't forget that registered file is not yet checked in.
20985 \begin_layout Standard
20986 CVS command that is run:
20988 cvs -q add -m"<entered message>" "<file-name>"
20991 \begin_layout Standard
20996 above and for all other CVS commands is an abbreviation for
20997 \begin_inset Quotes eld
21000 change the current working directory to file location and use the file name
21001 without path component as argument
21002 \begin_inset Quotes erd
21008 \begin_layout Subsubsection
21014 \begin_layout Standard
21015 When you are finished editing a file, you commit your changes.
21016 When you do this and you had changed the document, you are asked for a
21017 description of the changes.
21018 After that changes are written to the repository.
21019 In case you didn't change the document and a reserved checkout is detected
21020 the reservation made on
21021 \begin_inset Flex Noun
21024 \begin_layout Plain Layout
21033 \begin_layout Labeling
21034 \labelwidthstring 00.00.0000
21036 \begin_inset space ~
21040 \begin_inset space ~
21044 \begin_inset Newline newline
21048 \begin_inset Flex Code
21051 \begin_layout Plain Layout
21054 -q commit -m"<description>" "<file-name>"
21060 \begin_inset Newline newline
21064 \begin_inset Flex Code
21067 \begin_layout Plain Layout
21078 \begin_layout Subsubsection
21084 \begin_layout Standard
21085 When you are sharing a repository with others, you may have to incorporate
21086 their changes into your working copy.
21089 \begin_layout Standard
21092 cvs -q update "<file-name>"
21095 \begin_layout Standard
21096 If a readonly checkout is detected the working copy is made writable and
21100 \begin_layout Standard
21103 cvs -q edit "<file-name>"
21106 \begin_layout Subsubsection
21109 Revert To Repository Version
21112 \begin_layout Standard
21113 This will discard all changes made to the document since the last check
21115 You get a warning before changes are discarded.
21116 Firstly the file is deleted, secondly CVS update command is run.
21119 \begin_layout Standard
21122 cvs -q update "<file-name>"
21125 \begin_layout Standard
21126 If a reserved checkout is detected and the working copy has no changes only
21127 the reservation is undone.
21130 \begin_layout Standard
21133 cvs -q unedit "<file-name>"
21136 \begin_layout Subsubsection
21142 \begin_layout Standard
21143 This will create a copy of the current document.
21144 Since CVS does not support copy operations natively, the version history
21145 is not preserved, and the copy is added as a new file.
21146 It requires a clean document without any changes since the last checkin.
21147 You are asked for a file name and a description of the copy operation.
21148 After that the copy is created, both locally and in the repository.
21149 If the parent directories of the copied and original document differ, all
21150 relative paths of included files of the copy are adjusted (like in
21152 File\SpecialChar menuseparator
21157 Finally, the copy is loaded instead of the original document.
21160 \begin_layout Labeling
21161 \labelwidthstring 00.00.0000
21163 \begin_inset space ~
21167 \begin_inset space ~
21171 \begin_inset Newline newline
21175 \begin_inset Flex Code
21178 \begin_layout Plain Layout
21181 \begin_inset Quotes eld
21185 \begin_inset Quotes erd
21194 \begin_inset Flex Code
21197 \begin_layout Plain Layout
21200 \begin_inset Quotes eld
21204 \begin_inset Quotes erd
21213 \begin_inset Newline newline
21217 \begin_inset Flex Code
21220 \begin_layout Plain Layout
21224 \begin_inset Quotes eld
21228 \begin_inset Quotes erd
21239 \begin_layout Subsubsection
21245 \begin_layout Standard
21246 This will rename the current document.
21247 Since CVS does not support rename operations natively, the version history
21248 is not preserved, the renamed document is added as a new file, and the
21249 original document is deleted.
21250 It requires a clean document without any changes since the last checkin.
21251 You are asked for a file name and a description of the rename operation.
21252 After that the document is renamed, both locally and in the repository.
21253 If the parent directories of the new and old file names differ, all relative
21254 paths of included files are adjusted (like in
21256 File\SpecialChar menuseparator
21261 Finally, the document is reloaded using the new name.
21264 \begin_layout Labeling
21265 \labelwidthstring 00.00.0000
21267 \begin_inset space ~
21271 \begin_inset space ~
21275 \begin_inset Newline newline
21279 \begin_inset Flex Code
21282 \begin_layout Plain Layout
21285 \begin_inset Quotes eld
21289 \begin_inset Quotes erd
21298 \begin_inset Flex Code
21301 \begin_layout Plain Layout
21304 \begin_inset Quotes eld
21308 \begin_inset Quotes erd
21317 \begin_inset Newline newline
21321 \begin_inset Flex Code
21324 \begin_layout Plain Layout
21328 \begin_inset Quotes eld
21332 \begin_inset Quotes erd
21341 \begin_inset Newline newline
21345 \begin_inset Flex Code
21348 \begin_layout Plain Layout
21352 \begin_inset Quotes eld
21356 \begin_inset Quotes erd
21367 \begin_layout Subsubsection
21368 Update of the local directory checkout from repository
21371 \begin_layout Standard
21372 Once your documents gets more complex, containing sub-documents and pictures,
21374 \begin_inset Flex Code
21377 \begin_layout Plain Layout
21383 files and so on using version control becomes more complicated.
21385 supports updating the whole tree in which resides the document.
21386 This become especially useful once you cooperate with people which neither
21387 have detailed knowledge about CVS usage nor they have ambition to commit
21388 additional material to the repository.
21389 You have to organize the files structure so that all external files are
21390 in the same directory or subdirectories of the document.
21391 It's good practice anyway to store multipart documents in an extra directory.
21394 \begin_layout Standard
21396 \begin_inset Flex Code
21399 \begin_layout Plain Layout
21400 Update local directory from repository
21405 command updates the whole directory.
21406 If local changes are detected user is warned before update starts.
21407 In case of merge conflicts both versions of the conflicting document parts
21408 are placed in the final document.
21409 You have to review and correct the result of the merge.
21410 You'll find the conflicts enclosed in pairs of
21411 \begin_inset Flex Code
21414 \begin_layout Plain Layout
21421 \begin_inset Flex Code
21424 \begin_layout Plain Layout
21431 \begin_inset Flex Code
21434 \begin_layout Plain Layout
21441 The first part is your version as before the update operation with the
21442 document name prepended.
21443 The second one is the repository version with the version number after
21445 \begin_inset Flex Code
21448 \begin_layout Plain Layout
21457 \begin_layout Labeling
21458 \labelwidthstring 00.00.0000
21460 \begin_inset space ~
21464 \begin_inset space ~
21468 \begin_inset Newline newline
21472 \begin_inset Flex Code
21475 \begin_layout Plain Layout
21483 (Ask if changes are detected.)
21484 \begin_inset Newline newline
21488 \begin_inset Flex Code
21491 \begin_layout Plain Layout
21492 cd $path; cvs -q update
21502 \begin_layout Standard
21504 \begin_inset Flex Code
21507 \begin_layout Plain Layout
21513 stands for the path to the document.
21516 \begin_layout Subsubsection
21522 \begin_layout Standard
21523 This shows the complete history of the CVS document.
21526 cvs log "<file-name>"
21528 is shown in a browser.
21531 \begin_layout Subsubsection
21535 \begin_layout Standard
21537 supports CVS version number, author name, date and time of last commit.
21538 All those are extracted from
21540 cvs log -r <file-name>
21544 \begin_inset CommandInset ref
21546 reference "subsec:VCS-Revision-Information"
21553 \begin_layout Subsection
21554 SVN commands in \SpecialChar LyX
21558 \begin_layout Standard
21559 SVN is now partially supported by \SpecialChar LyX
21561 You can find the commands in the
21563 File\SpecialChar menuseparator
21565 \begin_inset space ~
21571 Please note that if you use password protected access to repository via
21572 ssh, you will be asked in terminal window.
21574 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21578 \begin_layout Plain Layout
21579 Most of the commands will work with 1.4 too, see
21580 \begin_inset CommandInset ref
21582 reference "subsec:SVN-Repo-Update"
21587 There seems to be currently unresolved permissions problem under SVN 1.8
21588 with reverting changes when file is locked.
21596 \begin_layout Subsubsection
21602 \begin_layout Standard
21603 If your document is not under revision control, this is the only item shown
21605 And if it is under revision control, the
21609 item is not visible.
21612 \begin_layout Standard
21613 This command registers in SVN your document ONLY in case you have already
21614 the documents directory under SVN control (in particular
21619 This means you have to checkout the archive by yourself.
21622 \begin_layout Standard
21623 Then you are asked interactively to supply an initial description of the
21625 Don't forget that registered file is not yet commited.
21628 \begin_layout Standard
21629 SVN command that is run:
21632 \begin_inset Quotes eld
21636 \begin_inset Quotes erd
21642 \begin_layout Standard
21647 to understand the switches.
21650 \begin_layout Subsubsection
21656 \begin_layout Standard
21657 When you are finished editing a file, you commit your changes.
21658 When you do this, you are asked for a description of the changes.
21659 After that changes are commited.
21662 \begin_layout Standard
21667 \begin_layout Plain Layout
21668 In case locking is not enabled.
21670 \begin_inset CommandInset ref
21672 reference "subsec:SVN-File-Locking"
21683 svn commit -q -m"<description>" <file-name>
21686 \begin_layout Subsubsection
21692 \begin_layout Standard
21693 Updates the changes of this file from the repository.
21694 Be sure you understand SVN merging and conflicts resolving before using
21695 this function, because all conflicts has to be resolved manually by you!
21698 \begin_layout Standard
21703 \begin_layout Plain Layout
21711 svn update --non-interactive
21712 \begin_inset Quotes eld
21716 \begin_inset Quotes erd
21722 \begin_layout Subsubsection
21725 Revert To Repository Version
21728 \begin_layout Standard
21729 This will discard all changes made to the document since the last check
21731 You get a warning before changes are discarded.
21734 \begin_layout Standard
21738 \begin_inset Quotes eld
21742 \begin_inset Quotes erd
21748 \begin_layout Subsubsection
21754 \begin_layout Standard
21755 This will create a copy of the current document including the version history.
21756 It requires a clean document without any changes since the last checkin.
21757 You are asked for a file name and a description of the copy operation.
21758 After that the copy is created, both locally and in the repository.
21759 If the parent directories of the copied and original document differ, all
21760 relative paths of included files of the copy are adjusted (like in
21762 File\SpecialChar menuseparator
21767 Finally, the copy is loaded instead of the original document.
21770 \begin_layout Labeling
21771 \labelwidthstring 00.00.0000
21773 \begin_inset space ~
21777 \begin_inset space ~
21781 \begin_inset Newline newline
21785 \begin_inset Flex Code
21788 \begin_layout Plain Layout
21792 \begin_inset Quotes eld
21796 \begin_inset Quotes erd
21800 \begin_inset Quotes eld
21804 \begin_inset Quotes erd
21813 \begin_inset Newline newline
21817 \begin_inset Flex Code
21820 \begin_layout Plain Layout
21829 \begin_layout Subsubsection
21835 \begin_layout Standard
21836 This will rename the current document including the version history.
21837 It requires a clean document without any changes since the last checkin.
21838 You are asked for a file name and a description of the rename operation.
21839 After that the document is renamed, both locally and in the repository.
21840 If the parent directories of the new and old file names differ, all relative
21841 paths of included files are adjusted (like in
21843 File\SpecialChar menuseparator
21848 Finally, the document is reloaded using the new name.
21851 \begin_layout Labeling
21852 \labelwidthstring 00.00.0000
21854 \begin_inset space ~
21858 \begin_inset space ~
21862 \begin_inset Newline newline
21866 \begin_inset Flex Code
21869 \begin_layout Plain Layout
21873 \begin_inset Quotes eld
21877 \begin_inset Quotes erd
21881 \begin_inset Quotes eld
21885 \begin_inset Quotes erd
21894 \begin_inset Newline newline
21898 \begin_inset Flex Code
21901 \begin_layout Plain Layout
21910 \begin_layout Subsubsection
21911 \begin_inset CommandInset label
21913 name "subsec:SVN-Repo-Update"
21917 Update of the local directory checkout from repository
21921 \begin_layout Plain Layout
21922 Note that this command will work only with subversion
21923 \begin_inset Formula $\geqq1.5$
21934 \begin_layout Standard
21935 All the commands above have one shortcomming - they deal with the current
21937 Once your document contains pictures, includes external
21938 \begin_inset Flex Code
21941 \begin_layout Plain Layout
21947 files and so on administration becomes more complicated.
21949 now supports updating the whole tree in which resides the document
21953 \begin_layout Plain Layout
21954 One need to organize the files structure so that all external files are
21955 in the same directory or subdirectories of the document.
21962 This become especially useful once you cooperate with people which neither
21963 know about subversion management nor they have ambition to commit additional
21964 material to the repository.
21968 \begin_layout Standard
21969 \begin_inset Flex Code
21972 \begin_layout Plain Layout
21973 Update local directory from repository
21978 command updates the whole directory and in case of merge conflicts local
21979 version of the files are left, so no unintended data loss occurs.
21980 If local changes are detected user is warned before update starts.
21983 \begin_layout Labeling
21984 \labelwidthstring 00.00.0000
21986 \begin_inset space ~
21990 \begin_inset space ~
21994 \begin_inset Newline newline
21998 \begin_inset Flex Code
22001 \begin_layout Plain Layout
22007 (Ask if changes are detected.)
22008 \begin_inset Newline newline
22012 \begin_inset Flex Code
22015 \begin_layout Plain Layout
22016 svn update –accept mine-full $path
22024 \begin_layout Standard
22026 \begin_inset Flex Code
22029 \begin_layout Plain Layout
22035 stands for the path to the document.
22038 \begin_layout Subsubsection
22044 \begin_layout Standard
22045 This shows the complete history of the SVN document.
22049 \begin_inset Quotes eld
22053 \begin_inset Quotes erd
22058 is shown in a browser.
22061 \begin_layout Subsubsection
22063 \begin_inset CommandInset label
22065 name "subsec:SVN-File-Locking"
22072 \begin_layout Standard
22073 The file exchange through various revision control systems brings the problem
22074 of merge conflicts in case two different users try to edit the same (parts
22076 When such a conflict happens it needs manual resolving and one reasonable
22077 alternative is to provide some kind of locking mechanism, which guarantees
22078 that only one user is allowed to edit file at the given time.
22081 \begin_layout Standard
22082 SVN has two such mechanisms to provide mutual exclusivity for file access
22083 - locks and automatic setting of write permissions (see sec.
22085 \begin_inset CommandInset ref
22087 reference "subsec:Automatical-Locking-Property"
22092 \begin_inset Flex Code
22095 \begin_layout Plain Layout
22105 \begin_layout Plain Layout
22106 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
22112 If this property is detected for a given document \SpecialChar LyX
22113 starts to use SVN locks
22114 for document editing automatically and the whole check-in/out mechanism
22115 switches to the same regimen as for RCS.
22116 This in particular means there are two different modes of file use in \SpecialChar LyX
22120 \begin_layout Itemize
22122 The loaded file is in the read-only mode.
22123 For editing on needs to check-out.
22128 consists of updating from the repository and gaining write lock.
22129 If the lock is not possible to obtain, we remain in unlocked state.
22132 \begin_layout Itemize
22134 The loaded file is in the 'normal' edit mode.
22135 No other user is allowed to edit the file.
22140 consists of commiting changes and releasing write-lock.
22141 If no changes have been made to the document, no commit will be produced
22145 \begin_layout Plain Layout
22146 Don't be puzzled by the fact that you will be asked for commit message anyway.
22151 and only the write-lock will be released.
22154 \begin_layout Standard
22158 \begin_layout Labeling
22159 \labelwidthstring 00.00.0000
22162 svn commit -q -m"<description>" "<file-name>"
22163 \begin_inset Newline newline
22166 svn unlock "<file-name>"
22169 \begin_layout Labeling
22170 \labelwidthstring 00.00.0000
22173 svn update "<file-name>"
22174 \begin_inset Newline newline
22177 svn lock "<file-name>"
22180 \begin_layout Subsubsection
22183 \begin_inset CommandInset label
22185 name "subsec:Automatical-Locking-Property"
22191 Automatic Locking Property
22194 \begin_layout Standard
22195 The above mentioned automatic setting of write permissions of the .lyx file
22198 File\SpecialChar menuseparator
22200 \begin_inset space ~
22203 Control\SpecialChar menuseparator
22204 Toggle locking property
22207 This command is active only when the file is not locked on the svn server
22209 you need to check-out before proceeding).
22212 \begin_layout Labeling
22213 \labelwidthstring 00.00.0000
22215 \begin_inset space ~
22221 \begin_layout Labeling
22222 \labelwidthstring 00.00.0000
22225 svn propset svn:needs-lock ON "<file-name>"
22228 \begin_layout Labeling
22229 \labelwidthstring 00.00.0000
22232 svn propdel svn:needs-lock "<file-name>"
22235 \begin_layout Subsubsection
22236 \begin_inset CommandInset label
22238 name "subsec:VCS-Revision-Information"
22242 Revision Information in Documents
22245 \begin_layout Standard
22246 There are more possibilities how to activate revision information in our
22250 \begin_layout Itemize
22256 \begin_layout Itemize
22257 tree revision information (
22258 \begin_inset Flex Code
22261 \begin_layout Plain Layout
22268 The result is the output of the
22269 \begin_inset Flex Code
22272 \begin_layout Plain Layout
22278 command, the following table gives you an idea, how to read the results.
22281 \begin_layout Standard
22283 \begin_inset Tabular
22284 <lyxtabular version="3" rows="6" columns="2">
22285 <features tabularvalignment="middle">
22286 <column alignment="center" valignment="top">
22287 <column alignment="center" valignment="top">
22289 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22292 \begin_layout Plain Layout
22298 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22301 \begin_layout Plain Layout
22309 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22312 \begin_layout Plain Layout
22318 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22321 \begin_layout Plain Layout
22322 mixed revision working copy
22329 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22332 \begin_layout Plain Layout
22338 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22341 \begin_layout Plain Layout
22342 modified working copy
22349 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22352 \begin_layout Plain Layout
22358 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22361 \begin_layout Plain Layout
22362 switched working copy
22369 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22372 \begin_layout Plain Layout
22378 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22381 \begin_layout Plain Layout
22382 partial working copy, from a sparse checkout
22389 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22392 \begin_layout Plain Layout
22398 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22401 \begin_layout Plain Layout
22402 mixed revision, modified, switched working copy
22415 \begin_layout Itemize
22416 file revision information.
22417 The result comes from parsing the output of
22418 \begin_inset Flex Code
22421 \begin_layout Plain Layout
22423 \begin_inset space ~
22427 \begin_inset space ~
22431 \begin_inset space ~
22440 Supported flags are:
22444 \begin_layout Itemize
22445 version number of the last commit (
22446 \begin_inset Flex Code
22449 \begin_layout Plain Layout
22458 \begin_layout Itemize
22459 author of the last commit (
22460 \begin_inset Flex Code
22463 \begin_layout Plain Layout
22472 \begin_layout Itemize
22473 date of the last commit (
22474 \begin_inset Flex Code
22477 \begin_layout Plain Layout
22486 \begin_layout Itemize
22487 time of the last commit (
22488 \begin_inset Flex Code
22491 \begin_layout Plain Layout
22501 \begin_layout Standard
22502 You can obtain this info via InsetInfo (e.g.
22504 \begin_inset Flex Code
22507 \begin_layout Plain Layout
22508 info-insert buffer vcs-date
22514 The information will be available only when you have the file stored under
22515 svn managment (i.e.
22517 \begin_inset Flex Code
22520 \begin_layout Plain Layout
22526 directory is available with your document).
22530 \begin_layout Itemize
22531 Another—a hacking one—possibility is to use svn keywords
22535 \begin_layout Plain Layout
22536 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22542 In short – you set file keywords property (e.g.
22545 svn propset svn:keywords 'Rev' file.lyx
22547 ) and then paste keyword \SpecialChar TeX
22552 \begin_layout Plain Layout
22553 This is an easy way how to ensure that \SpecialChar LyX
22554 won't break the line in the middle
22560 tag in your document (e.g.
22565 \begin_layout Plain Layout
22573 This way svn client will automatically substitute revision number (e.g.
22578 \begin_layout Plain Layout
22585 ) after each update and commit.
22586 There are more problems with this approach.
22587 Firstly, the '$' character is used in \SpecialChar TeX
22588 world for math equations, so any
22589 occurence of math formula
22590 \begin_inset Formula $Rev$
22594 \begin_inset Formula $Rev:59$
22597 in your \SpecialChar LyX
22599 Similarly for other keywords like Id, Date, Author, etc.
22600 Secondly svn output is dependent on your locales, so its very easy that
22601 svn would produce some problematic strings once Date is used.
22602 Thirdly you get the whole 'Rev: 59' string in your document instead of
22604 Until subversion implements user's custom keywords it will be hard to use
22605 this approach reliably or let \SpecialChar LyX
22606 to support it directly.
22609 \begin_layout Subsection
22610 SVN and Windows Environment
22613 \begin_layout Quote
22614 My inclination is to say that if the user cannot figure out the command
22615 line operations on their own fairly quickly, they would be well advised
22616 to use TortoiseSVN.
22622 \begin_layout Subsubsection
22626 \begin_layout Standard
22627 In addition to installing \SpecialChar LyX
22628 , and having access to a Subversion repository,
22629 the user will need to install the Subversion client program.
22630 A Windows installer for the client program is available from
22631 \begin_inset CommandInset href
22634 target "http://www.collab.net/nonav/downloads/subversion/"
22640 The user may also want to install
22641 \begin_inset CommandInset href
22644 target "http://tortoisesvn.tigris.org/"
22649 , which integrates Subversion operations into the context (rightclick) menu
22650 of Windows Explorer.
22651 Operations done outside \SpecialChar LyX
22652 will typically be more convenient using the Explorer
22654 Note that TortoiseSVN is not a replacement for the client program, which
22655 is what \SpecialChar LyX
22659 \begin_layout Subsubsection
22660 Bringing a document under Subversion control
22663 \begin_layout Standard
22664 Before a \SpecialChar LyX
22665 document can be brought under version control in Subversion, its
22666 parent directory needs to be under version control.
22667 If the document is being added to a project already in the repository,
22668 this is accomplished by checking the project out to the directory where
22669 the new document will be placed.
22670 If the project itself is not yet under version control (for instance, if
22671 this document starts a new project), the directory must be imported into
22673 This is done outside \SpecialChar LyX
22675 Both import and checkout are easily accomplished from the Explorer context
22676 menu using TortoiseSVN, or alternatively can be done using the command
22677 line client at a DOS prompt.
22678 The procedure for importing the project using TortoiseSVN is described
22679 below, assuming an existing repository and a new project being started
22687 For information on using the Subversion client program, run
22694 \begin_layout Enumerate
22701 in Windows Explorer, right click it, and select
22703 TortoiseSVN\SpecialChar menuseparator
22707 If necessary, adjust the URL for the repository, then click OK.
22710 \begin_layout Enumerate
22711 Right click the level of the repository under which you want to place the
22712 new project folder (typically the top level) and click
22716 Supply a name for the project folder and click OK.
22717 Add a message for the log file if desired, then click OK again.
22718 The new project folder should appear in the repository.
22719 Finally, click OK again to exit the repository browser.
22722 \begin_layout Enumerate
22723 Once again right click
22729 , this time selecting SVN Checkout\SpecialChar ldots
22730 Select the URL of the project folder
22731 you just created in the repository, and set the checkout directory to
22739 You will be warned about a non-empty folder; click OK to proceed.
22740 You should now have a
22751 \begin_layout Enumerate
22752 Create or open your document in \SpecialChar LyX
22755 File\SpecialChar menuseparator
22757 \begin_inset space ~
22760 Control\SpecialChar menuseparator
22764 Add a log message and click OK to commit the document to version control.
22767 \begin_layout Standard
22768 From this point onward, you should have full functionality in the
22770 File\SpecialChar menuseparator
22772 \begin_inset space ~
22778 You also have the option of checking the document in and out, viewing its
22780 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22781 client program from a command prompt.
22784 \begin_layout Subsubsection
22785 SSH tunnel used with SVN under Windows
22788 \begin_layout Standard
22789 Compared with Linux setting up an svn client to communicate over ssh under
22790 Windows is a rather troublesome task.
22791 We will at least offer some hints how to setup the client side but prior
22792 knowledge about ssh and the Windows command line is needed, also be prepared
22793 for a great deal of frustration\SpecialChar ldots
22797 \begin_layout Enumerate
22798 Get an svn client for windows, as described in the previous sections.
22799 When it is a fresh install run some svn command (e.g.
22801 \begin_inset Flex Code
22804 \begin_layout Plain Layout
22810 ) to create config files, which you will need to change later on.
22813 \begin_layout Enumerate
22814 Choose an ssh client for Windows.
22815 There are several possibilities, we will use the one from Putty tools
22819 \begin_layout Plain Layout
22820 \begin_inset Flex URL
22823 \begin_layout Plain Layout
22825 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22836 You will need to set the connection up so that the client doesn't ask for
22837 any password from you.
22838 To keep things easy we will use only keys without any additional password
22843 \begin_layout Enumerate
22845 \begin_inset Flex Code
22848 \begin_layout Plain Layout
22855 Save your private .ppk key file and put the public one on the server side.
22856 If the SVN server runs on Linux, note that the format of the public key
22857 is not compatible with Linux openssh and you will need to direcly copy-paste
22860 Public key for pasting into OpenSSH authorized_keys file
22862 :” edit field into the server's
22863 \begin_inset Flex Code
22866 \begin_layout Plain Layout
22867 ~/.ssh/authorized_keys
22873 \begin_inset Flex Code
22876 \begin_layout Plain Layout
22885 \begin_layout Enumerate
22887 \begin_inset Flex Code
22890 \begin_layout Plain Layout
22897 In the SVN config file
22901 \begin_layout Plain Layout
22902 Exact path depends on Windows version, usually somewhere around
22903 \begin_inset Flex Code
22906 \begin_layout Plain Layout
22909 Documents and Settings
22923 \begin_inset Flex Code
22926 \begin_layout Plain Layout
22941 , section [tunnels], setup ssh command, e.g.
22943 \begin_inset Flex Code
22946 \begin_layout Plain Layout
22947 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22956 \begin_layout Plain Layout
22957 It will usually take a lot of time to get exact command right and it depends
22959 For example do not have some remote server saved as a default session in
22961 If things fail, try to connect via plink without SVN first.
22970 \begin_layout Enumerate
22971 Checkout the SVN archive, e.
22972 \begin_inset space \thinspace{}
22976 \begin_inset Newline newline
22980 \begin_inset Flex Code
22983 \begin_layout Plain Layout
22984 svn co svn+ssh://user@server/repository_path
22992 \begin_layout Subsubsection
22993 End-of-Line Conversions
22996 \begin_layout Standard
22997 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22999 use different line endings inside the .lyx files.
23000 This is not a problem as far as \SpecialChar LyX
23001 functionality is concerned, but the commit
23002 diffs will be huge and merge-conflicts prone.
23003 Fortunately SVN itself knows
23007 \begin_layout Plain Layout
23008 \begin_inset Flex URL
23011 \begin_layout Plain Layout
23013 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
23023 how to deal with CR/LF problems when switching .lyx files to the
23024 \begin_inset Flex Code
23027 \begin_layout Plain Layout
23037 \begin_layout Plain Layout
23039 \begin_inset Flex Code
23042 \begin_layout Plain Layout
23043 svn propset svn:eol-style native FILE_NAME
23056 \begin_layout Subsection
23057 GIT commands in \SpecialChar LyX
23061 \begin_layout Standard
23062 A minimal subset of GIT commands is now supported by \SpecialChar LyX
23064 You can find the commands in the
23066 File\SpecialChar menuseparator
23068 \begin_inset space ~
23074 Please note that if you use password protected access to repository via
23075 ssh, you will be asked in terminal window.
23077 was tested against GIT 1.7.
23081 \begin_layout Plain Layout
23082 Windows users please note that you need to ensure that git is on the path.
23083 This can be set from within \SpecialChar LyX
23086 Tools\SpecialChar menuseparator
23087 Preferences\SpecialChar menuseparator
23088 Paths\SpecialChar menuseparator
23099 \begin_layout Standard
23100 One big difference of GIT and the other supported version control systems
23101 is the distributed nature of GIT: With traditional version control systems
23102 there is one central server which hosts the repository.
23103 Users commit their changes to the server, and get updates made by other
23105 With GIT, users commit to a local repository.
23106 The local repository can be synchronized with one or more remote repositories
23108 \begin_inset Flex Code
23111 \begin_layout Plain Layout
23118 \begin_inset Flex Code
23121 \begin_layout Plain Layout
23129 does not interact in any way with remote GIT repositories.
23130 It works exclusively with the local repository in a very similar way as
23131 with a central CVS or SVN repository.
23132 If you use remote GIT repositories you need to do the
23133 \begin_inset Flex Code
23136 \begin_layout Plain Layout
23143 \begin_inset Flex Code
23146 \begin_layout Plain Layout
23152 operations with your favourite GIT client.
23155 \begin_layout Subsubsection
23161 \begin_layout Standard
23162 If your document is not under revision control, this is the only item shown
23164 And if it is under revision control, the
23168 item is not visible.
23171 \begin_layout Standard
23172 This command registers in GIT your document ONLY in case you have already
23173 the documents directory under GIT control (in particular
23178 This means you have to checkout the archive by yourself.
23181 \begin_layout Standard
23182 Then you are asked interactively to supply an initial description of the
23184 Don't forget that registered file is not yet commited.
23187 \begin_layout Standard
23188 GIT command that is run:
23191 \begin_inset Quotes eld
23195 \begin_inset Quotes erd
23201 \begin_layout Standard
23206 to understand the switches.
23209 \begin_layout Subsubsection
23215 \begin_layout Standard
23216 When you are finished editing a file, you commit your changes.
23217 When you do this, you are asked for a description of the changes.
23218 After that changes are commited.
23221 \begin_layout Standard
23224 git commit -q -m"<description>" <file-name>
23227 \begin_layout Subsubsection
23230 Revert To Repository Version
23233 \begin_layout Standard
23234 This will discard all changes made to the document since the last check
23236 You get a warning before changes are discarded.
23239 \begin_layout Standard
23243 \begin_inset Quotes eld
23247 \begin_inset Quotes erd
23253 \begin_layout Subsubsection
23259 \begin_layout Standard
23260 This will rename the current document including the version history.
23261 It requires a clean document without any changes since the last checkin.
23262 You are asked for a file name and a description of the rename operation.
23263 After that the document is renamed, both locally and in the repository.
23264 If the parent directories of the new and old file names differ, all relative
23265 paths of included files are adjusted (like in
23267 File\SpecialChar menuseparator
23272 Finally, the document is reloaded using the new name.
23275 \begin_layout Labeling
23276 \labelwidthstring 00.00.0000
23278 \begin_inset space ~
23282 \begin_inset space ~
23286 \begin_inset Newline newline
23290 \begin_inset Flex Code
23293 \begin_layout Plain Layout
23297 \begin_inset Quotes eld
23301 \begin_inset Quotes erd
23305 \begin_inset Quotes eld
23309 \begin_inset Quotes erd
23318 \begin_inset Newline newline
23322 \begin_inset Flex Code
23325 \begin_layout Plain Layout
23334 \begin_layout Subsubsection
23340 \begin_layout Standard
23341 This shows the complete history of the GIT document.
23345 \begin_inset Quotes eld
23349 \begin_inset Quotes erd
23354 is shown in a browser.
23357 \begin_layout Subsubsection
23361 \begin_layout Standard
23363 supports GIT hash number of the last commit to the file, author name, date
23364 and time of last commit.
23365 All those are extracted from
23367 git log -n 1 --pretty=format:%H%n%an%n%ai
23370 Tree version information is obtained via
23372 git describe --abbrev --dirty --long
23376 \begin_inset CommandInset ref
23378 reference "subsec:VCS-Revision-Information"
23385 \begin_layout Subsection
23389 \begin_layout Standard
23390 With the recent addition of the vc-command function \SpecialChar LyX
23391 power users are allowed
23392 to create their own commands for revision control.
23395 \begin_layout Standard
23396 As an example you can see how two TortoiseSVN commands could be integrated
23400 \begin_layout Description
23402 \begin_inset Flex Code
23405 \begin_layout Plain Layout
23406 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23414 \begin_layout Description
23416 \begin_inset Flex Code
23419 \begin_layout Plain Layout
23420 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23428 \begin_layout Subsection
23429 Version control and Document comparison
23432 \begin_layout Standard
23433 One of the typical uses of version control is to inspect the changes between
23434 revisions, usually by creating
23435 \begin_inset Flex Code
23438 \begin_layout Plain Layout
23445 While this is useful for plain text files, it is much less useful in the
23446 case of \SpecialChar LyX
23447 files, which have more a complicated structure.
23448 Hence we provide binding to the Document comparison feature.
23449 There are two ways of calling this feature - either by direct call of
23450 \begin_inset Flex Code
23453 \begin_layout Plain Layout
23460 function (for details see \SpecialChar LyX
23461 functions manual) or by icon/menu item
23462 \begin_inset Flex Noun
23465 \begin_layout Plain Layout
23466 Compare with older revision...
23472 One can either compare two chosen revisions of the document or he can simply
23473 compare the current version of edited text with older revisions (where
23475 \begin_inset Flex Noun
23478 \begin_layout Plain Layout
23484 ' revisions back means comparison of the edited file with last commited
23489 \begin_layout Standard
23490 This feature is supported for SVN and RCS though due to the more complicated
23491 versioning scheme of RCS there is a constraint – when addressing the revisions
23492 in dialog, numbers always point to the last number in RCS revision number,
23495 We don't currently support GIT addressing of revisions, one can just compare
23496 edited document with its revision X steps backs, where X is addressed as
23500 \begin_layout Section
23501 Literate Programming
23504 \begin_layout Standard
23509 (kayvan@sylvan.com)
23513 original documentation written by
23515 Edmar Wienskoski Jr.
23518 (edmar-w-jr@technologist.com)
23521 \begin_layout Subsection
23525 \begin_layout Standard
23526 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23528 programming, where it is assumed that you are familiar with this programming
23529 technique, and know what
23530 \begin_inset Quotes eld
23534 \begin_inset Quotes erd
23538 \begin_inset Quotes eld
23542 \begin_inset Quotes erd
23546 If that is not the case, please follow the web links provided in the following
23548 There is a lot of good documentation out there covering old development
23549 history to the latest tools tips.
23552 \begin_layout Standard
23553 It is also assumed that you are familiar with \SpecialChar LyX
23554 itself to a point that you
23555 are comfortable changing your \SpecialChar LyX
23556 preferences, and X resources file.
23557 If that is not the case please refer to other \SpecialChar LyX
23558 documentation to cover your
23562 \begin_layout Subsection
23563 Literate Programming
23566 \begin_layout Standard
23567 From the Literate Programming FAQ:
23570 \begin_layout Quotation
23571 Literate programming is the combination of documentation and source together
23572 in a fashion suited for reading by human beings.
23573 In fact, literate programs should be enjoyable reading, even inviting!
23574 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23575 and documentation in a single file.
23576 Literate programming tools then parse the file to produce either readable
23577 documentation or compilable source.
23578 The WEB style of literate programming was created by D.
23579 \begin_inset space \thinspace{}
23583 Knuth during the development of his \SpecialChar TeX
23584 typesetting software.
23588 \begin_layout Standard
23589 Another excerpt says:
23592 \begin_layout Quotation
23595 How is literate programming different from verbose commenting?
23598 \begin_layout Quotation
23599 There are three distinguishing characteristics.
23600 In order of importance, they are:
23604 \begin_layout Itemize
23605 flexible order of elaboration
23608 \begin_layout Itemize
23609 automatic support for browsing
23612 \begin_layout Itemize
23613 typeset documentation, especially diagrams and mathematics
23617 \begin_layout Standard
23618 Now that I sparked your curiosity, take a look in the references.
23621 \begin_layout Subsubsection
23625 \begin_layout Standard
23626 The complete Literate Programming FAQ can be found at:
23629 \begin_layout Quote
23630 Literate Programming FAQ
23631 \begin_inset Flex URL
23634 \begin_layout Plain Layout
23636 http://www.literateprogramming.com/lpfaq.pdf
23644 \begin_layout Standard
23645 The FAQ lists 23 (twenty three!) different literate programming tools.
23646 Where some are specialized or
23647 \begin_inset Quotes eld
23651 \begin_inset Quotes erd
23654 for particular programming languages, while other have general scope.
23659 for my own use for several reasons:
23662 \begin_layout Itemize
23663 It can generate the documentation either in \SpecialChar LaTeX
23667 \begin_layout Itemize
23668 It has a open architecture, i.
23669 \begin_inset space \thinspace{}
23673 \begin_inset space \space{}
23676 it is easy to plug in new filters and to perform special processing that
23681 \begin_layout Itemize
23682 There is a good selection of filters available already (the HTML is one
23686 \begin_layout Itemize
23690 \begin_layout Standard
23691 The Noweb web page can be found at:
23694 \begin_layout Quote
23696 \begin_inset Flex URL
23699 \begin_layout Plain Layout
23701 http://www.cs.virginia.edu/~nr/noweb/
23709 \begin_layout Standard
23710 Starting from there you can reach many other interesting links and even
23711 some literate program examples.
23714 \begin_layout Subsection
23716 and Literate Programming with Noweb
23719 \begin_layout Standard
23720 The \SpecialChar LyX
23721 support for Literate Programming is provided by using the generic \SpecialChar LyX
23723 converters mechanism.
23724 This support is provided in a
23725 \begin_inset Quotes eld
23729 \begin_inset Quotes erd
23733 \begin_inset space \thinspace{}
23737 \begin_inset space \space{}
23740 you will be able to use this new \SpecialChar LyX
23741 feature with some other literate programming
23742 tool of your choice by just changing your \SpecialChar LyX
23746 \begin_layout Subsubsection
23747 Generating documents and code (weaving and tangling)
23750 \begin_layout Paragraph
23751 Using the noweb module
23754 \begin_layout Standard
23755 If you have installed Noweb and \SpecialChar LyX
23756 successfully, whenever you open a new document,
23757 after you have chosen its document class, use the Document->Settings menu
23759 \begin_inset Quotes eld
23763 \begin_inset Quotes erd
23767 If Noweb is correctly installed, when you click on the
23768 \begin_inset Quotes eld
23772 \begin_inset Quotes erd
23775 link, you will see the
23776 \begin_inset Quotes eld
23780 \begin_inset Quotes erd
23783 module in the available list and you can add it to your document.
23786 \begin_layout Paragraph
23790 \begin_layout Standard
23792 enables you to write code with a layout named
23793 \begin_inset Flex Noun
23796 \begin_layout Plain Layout
23803 Noweb delimits chunks like this:
23806 \begin_layout LyX-Code
23810 \begin_layout LyX-Code
23814 \begin_layout LyX-Code
23818 \begin_layout LyX-Code
23822 \begin_layout LyX-Code
23826 \begin_layout Standard
23827 The problem is that whatever is written in between the << and the
23831 must be taken literally, i.
23832 \begin_inset space \thinspace{}
23836 \begin_inset space \space{}
23840 should be prevented from making any special interpretation of what has
23842 This is also handled by
23843 \begin_inset Flex Noun
23846 \begin_layout Plain Layout
23852 , that works like a normal paragraph but has a free spacing capability.
23855 \begin_layout Standard
23856 As a special note, you can also use the
23857 \begin_inset Quotes eld
23861 \begin_inset Quotes erd
23864 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23868 \begin_layout LyX-Code
23872 \begin_layout LyX-Code
23873 def some_function(args):
23876 \begin_layout LyX-Code
23877 "This is the doc string for this function."
23880 \begin_layout LyX-Code
23881 print "My args: ", args
23884 \begin_layout LyX-Code
23885 @ %def some_function
23888 \begin_layout Standard
23889 For an example of this usage and the resulting cross-reference output, look
23890 at the Literate python program in
23892 LIBDIR/examples/listerrors.lyx
23894 which should make this all clear.
23897 \begin_layout Paragraph
23898 Generating the documentation
23901 \begin_layout Standard
23902 At this point you already have a new document file with a proper document
23903 class, and with some code and text on it.
23904 How do I print it? The answer is simple, you select
23906 View\SpecialChar menuseparator
23910 Just like you would do for a plain document.
23911 No special procedure is required.
23914 \begin_layout Standard
23915 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23919 \begin_layout Enumerate
23922 Update\SpecialChar menuseparator
23925 menu option is chosen, a \SpecialChar LaTeX
23931 \begin_layout Standard
23932 If the document is of any literate class the generated file will be named
23933 with an extension name defined by the
23934 \begin_inset Quotes eld
23938 \begin_inset Quotes erd
23941 format (defined in the Preferences panel), otherwise the file will have
23950 \begin_layout Enumerate
23951 Note that the only difference so far is in the name of the file, no special
23952 processing is required by \SpecialChar LyX
23954 Given that you formatted the code using the
23955 \begin_inset Flex Noun
23958 \begin_layout Plain Layout
23964 layout that, by itself, takes care of the business.
23967 \begin_layout Enumerate
23968 If the document is of any literate class \SpecialChar LyX
23969 will then use the internal \SpecialChar LyX
23971 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23976 \begin_layout Plain Layout
23977 The converters are defined in the
23979 Tools\SpecialChar menuseparator
23983 \begin_inset Quotes eld
23987 \begin_inset Quotes erd
23999 manual for general information about converters.
24004 to generate the \SpecialChar LaTeX
24009 \begin_layout Standard
24010 Otherwise it will just skip this step.
24014 \begin_layout Enumerate
24015 Finally, \SpecialChar LaTeX
24016 is invoked and the regular post processing continues as in a plain
24020 \begin_layout Standard
24021 Independence from a particular
24022 \begin_inset Quotes eld
24026 \begin_inset Quotes erd
24029 is easily achieved by changing the commands that are run by the various
24033 \begin_layout Paragraph
24034 Generating the code
24037 \begin_layout Standard
24038 When the build menu option is chosen or the corresponding button in the
24039 toolbar is pressed, a \SpecialChar LaTeX
24040 file is generated just like step 1 above.
24041 Next, \SpecialChar LyX
24047 This converter needs to be defined by the user and is not installed by
24048 default, though the Program format is.
24049 This converter (like any other converter) will have two parts:
24052 \begin_layout Enumerate
24053 The converter program itself.
24054 This program performs the conversion from the one format to the other (in
24055 this case, from the Noweb format to the Program pseudo-format).
24058 \begin_layout Enumerate
24059 The error log parser.
24060 This is a program whose sole purpose is to rewrite error messages in a
24061 format that \SpecialChar LyX
24063 This makes it possible for \SpecialChar LyX
24064 to place error boxes in the right places in
24068 \begin_layout Standard
24069 The first part, the
24070 \begin_inset Quotes eld
24074 \begin_inset Quotes erd
24077 setting, should be set to
24078 \begin_inset Newline newline
24082 \begin_inset Quotes eld
24090 \begin_inset Quotes erd
24094 \begin_inset Newline newline
24097 This basically means that \SpecialChar LyX
24099 \begin_inset Quotes eld
24103 \begin_inset Quotes erd
24106 (a program or script) with the name of the Noweb file (normally a file
24107 in the \SpecialChar LyX
24108 temp directory) and the directory path of the original \SpecialChar LyX
24113 \begin_layout Standard
24114 This is an implementation of
24115 \begin_inset Quotes eld
24119 \begin_inset Quotes erd
24122 that you can place in a directory on your path:
24125 \begin_layout Standard
24126 \begin_inset VSpace defskip
24132 \begin_layout Standard
24133 \begin_inset Newpage pagebreak
24139 \begin_layout Standard
24145 \begin_layout Standard
24151 \begin_layout Standard
24154 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
24157 \begin_layout Standard
24158 \begin_inset VSpace defskip
24164 \begin_layout Standard
24165 The next part of the converter setting is the
24166 \begin_inset Quotes eld
24170 \begin_inset Quotes erd
24173 which is to be set to
24174 \begin_inset Newline newline
24178 \begin_inset Quotes eld
24183 parselog=$$s/scripts/listerrors
24186 \begin_inset Quotes erd
24190 \begin_inset Newline newline
24193 This will run any errors that are generated by the
24194 \begin_inset Quotes eld
24198 \begin_inset Quotes erd
24201 process through the
24202 \begin_inset Quotes eld
24206 \begin_inset Quotes erd
24212 \begin_layout Standard
24213 The build will normally take place in \SpecialChar LyX
24214 's temporary directory, so the files
24215 produced by the conversion will be in that directory.
24217 will copy out what it regards as the `main' file, but the
24221 conversion may produce several files, and so most of these would then be
24222 deleted when \SpecialChar LyX
24224 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
24225 the build-script chunk can place the generated files in that location.
24228 \begin_layout Paragraph
24229 Build instructions in the document
24232 \begin_layout Standard
24233 The last piece of the integration between \SpecialChar LyX
24235 \begin_inset Quotes eld
24239 \begin_inset Quotes erd
24243 Generally, the instructions for building your program should be embedded
24244 in a chunk of its own.
24246 \begin_inset Quotes eld
24250 \begin_inset Quotes erd
24253 above uses the notangle command to look for this chunk (called
24254 \begin_inset Quotes eld
24258 \begin_inset Quotes erd
24261 ) and runs its contents through
24262 \begin_inset Quotes eld
24266 \begin_inset Quotes erd
24272 \begin_layout Standard
24273 Typically, such a chunk would look something like this:
24276 \begin_layout LyX-Code
24280 \begin_layout LyX-Code
24282 \begin_inset Newline newline
24285 if [ -z "${NOWEB_SOURCE}" ]
24286 \begin_inset Newline newline
24292 \begin_layout LyX-Code
24293 NOWEB_SOURCE=myfile.nw
24294 \begin_inset Newline newline
24298 \begin_inset Newline newline
24302 code to extract files ...
24303 use NOWEB_OUTPUT_DIR here ...]
24304 \begin_inset Newline newline
24308 code to compile files ...]
24309 \begin_inset Newline newline
24315 \begin_layout Standard
24318 LIBDIR/examples/listerrors.lyx
24322 LIBDIR/examples/Literate.lyx
24324 which implement two versions of the
24325 \begin_inset Quotes eld
24329 \begin_inset Quotes erd
24332 program for some illustrations of how all of these pieces go together or
24335 LIBDIR/examples/noweb2lyx.lyx.
24338 Interestingly, these three files show off the language-indepence of the
24340 literate programming support since they are written in Python, C and Perl
24344 \begin_layout Subsubsection
24345 Configuring \SpecialChar LyX
24349 \begin_layout Standard
24350 All the Literate Programming support is configured by the
24352 Tools\SpecialChar menuseparator
24356 \begin_inset Quotes eld
24360 \begin_inset Quotes erd
24364 The important parts are:
24367 \begin_layout Description
24369 \begin_inset space ~
24373 \begin_inset Quotes eld
24377 \begin_inset Quotes erd
24381 \begin_inset space ~
24384 format Set up via the File Formats tab, this is where the Noweb-specific
24394 , the file extension is set to
24399 This tells \SpecialChar LyX
24400 to create a file with a
24404 extension in the first step of the conversion process.
24407 \begin_layout Description
24409 \begin_inset space ~
24417 \begin_inset space ~
24420 format This is an empty format whose sole purpose is to be the endpoint
24421 of a conversion (which then allows us to set up a converter for it).
24424 \begin_layout Description
24434 This converter performs the
24435 \begin_inset Quotes eld
24439 \begin_inset Quotes erd
24442 of the literate document.
24443 For Noweb, it is set to
24444 \begin_inset Quotes eld
24449 noweave -delay -index $$i > $$o
24452 \begin_inset Quotes erd
24458 \begin_layout Description
24468 \begin_inset Quotes eld
24472 \begin_inset Quotes erd
24476 As stated above, the Converter is set to
24477 \begin_inset Quotes eld
24485 \begin_inset Quotes erd
24488 , with Flags set to
24489 \begin_inset Newline newline
24493 \begin_inset Quotes eld
24498 parselog=$$s/scripts/listerrors
24501 \begin_inset Quotes erd
24507 \begin_layout Subsubsection
24511 \begin_layout Standard
24512 There is also a new function implemented in the \SpecialChar LyX
24514 \begin_inset Quotes eld
24517 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24521 \begin_layout Standard
24522 When debugging code with ddd/gdb, it is possible to invoke a text editor
24523 at the current execution position with a single key stroke.
24524 The default ddd configuration for that is shift-ctrl-V.
24525 It happens that you can define the editor command line invocation in ddd
24528 Edit\SpecialChar menuseparator
24529 Preferences\SpecialChar menuseparator
24532 dialog and changing the "Edit Sources" entry.
24535 \begin_layout Standard
24536 I take advantage of the newly created \SpecialChar LyX
24537 server function and this ddd feature,
24539 \begin_inset Quotes eld
24543 \begin_inset Quotes erd
24549 \begin_layout Standard
24550 \begin_inset VSpace defskip
24556 \begin_layout Standard
24559 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24562 \begin_layout Standard
24563 \begin_inset VSpace defskip
24569 \begin_layout Standard
24570 With this, whenever you are using ddd and find a point in the program that
24571 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24572 ddd will forward this information to \SpecialChar LyX
24573 through the \SpecialChar LyX
24574 server and then the
24576 window will show the same file with the cursor at the same position ddd
24578 No more guessing or long scrolling to locate a point in the program back
24582 \begin_layout Standard
24583 Note however that you must enable the \SpecialChar LyX
24584 server to get this feature working
24585 (it is disabled by default).
24586 You can enable it in
24598 ) by entering in the
24604 \begin_inset Quotes eld
24609 /home/<your-home-directory>/.lyx/lyxpipe
24612 \begin_inset Quotes erd
24618 \begin_layout Standard
24619 Read the \SpecialChar LyX
24620 server documentation in the
24622 Customization Manual
24624 for further information.
24627 \begin_layout Subsubsection
24631 \begin_layout Standard
24632 There are six new buttons that can be added to your \SpecialChar LyX
24634 Five of these buttons are short cuts to layout styles:
24657 The last one is a short cut to the
24658 \begin_inset Quotes eld
24662 \begin_inset Quotes erd
24669 \begin_layout Standard
24671 has a range of buttons that are available for tool bar customization.
24672 In my toolbar I like to combine the six short cuts above with two more:
24677 \SpecialChar menuseparator
24682 \SpecialChar menuseparator
24689 Document\SpecialChar menuseparator
24690 View\SpecialChar menuseparator
24694 Here is how it looks like:
24697 \begin_layout LyX-Code
24701 \begin_layout LyX-Code
24705 \begin_layout LyX-Code
24706 Icon "layout Standard"
24709 \begin_layout LyX-Code
24710 Icon "layout Section"
24713 \begin_layout LyX-Code
24714 Icon "layout \SpecialChar LaTeX
24718 \begin_layout LyX-Code
24719 Icon "layout \SpecialChar LyX
24723 \begin_layout LyX-Code
24724 Icon "layout Chunk"
24727 \begin_layout LyX-Code
24731 \begin_layout LyX-Code
24735 \begin_layout LyX-Code
24736 Icon "buffer-typeset"
24739 \begin_layout LyX-Code
24740 Icon "build-program"
24743 \begin_layout LyX-Code
24747 \begin_layout LyX-Code
24751 \begin_layout LyX-Code
24755 \begin_layout LyX-Code
24759 \begin_layout LyX-Code
24763 \begin_layout Subsubsection
24764 Colors customization
24767 \begin_layout Standard
24768 There are a number of colors in \SpecialChar LyX
24769 that can be customized in
24774 One of the things that bothers people is the \SpecialChar LaTeX
24776 The default color is red, since the chunks uses \SpecialChar LaTeX
24777 font, and there is a lot
24778 of chunks in literate documents, you may get tired of seeing everything
24780 You can change it by going to the tabs
24789 \begin_layout Standard
24790 The next thing is the visible presence of the newline character in the screen.
24791 You can choose the color of this particular character and make it blend
24793 I recommend you choosing a color that is close to the background but not
24794 equal, that way you still can see it is there, but it is not bothering
24798 \begin_layout Subsection
24803 \begin_layout Standard
24812 is documented in the
24816 example file and in the Sweave manual (menu
24818 Help\SpecialChar menuseparator
24824 \begin_layout Chapter
24828 \begin_layout Standard
24829 You can do everything with \SpecialChar LyX
24830 that you can do with \SpecialChar LaTeX
24832 However, \SpecialChar LyX
24833 cannot support every \SpecialChar LaTeX
24835 But you can always use \SpecialChar TeX
24837 This chapter shows you some more special things you might want to use.
24838 For other special things you can do with figures, tables, floats, boxes
24839 and notes, have a look at the
24842 \begin_inset space ~
24850 \begin_layout Section
24851 Multiple Text Columns
24854 \begin_layout Standard
24855 This feature is independent of the option
24857 Two-column document
24859 in the document settings under
24864 If you want to have 2
24865 \begin_inset space ~
24868 columns for the whole document, it is recommended to use the
24870 Two-column document
24873 For all other cases use this feature.
24876 \begin_layout Standard
24877 To use multiple text columns in your document, you have to load the module
24884 Document\SpecialChar menuseparator
24885 Settings\SpecialChar menuseparator
24888 ) and must have the \SpecialChar LaTeX
24896 \begin_layout Standard
24897 Footnotes within multiple columns will be placed at the bottom of the page
24898 and not under each column.
24899 Within the different columns you can use everything, with the limitation
24900 that for floats you need to use the float option
24907 \begin_layout Subsection
24911 \begin_layout Standard
24912 If you want to have 2
24913 \begin_inset space ~
24916 columns in your text, insert a multicolumn inset via the menu
24918 Insert\SpecialChar menuseparator
24920 \begin_inset space ~
24923 Insets\SpecialChar menuseparator
24925 \begin_inset space ~
24930 where the columns should start.
24931 Write all text that should be printed in 2
24932 \begin_inset space ~
24935 columns into this inset.
24938 \begin_layout Standard
24939 Here is an example:
24942 \begin_layout Standard
24944 \begin_inset Flex Multiple Columns
24947 \begin_layout Plain Layout
24952 The Adventure of the Empty House
24955 \begin_inset Newline newline
24958 by Sir Arthur Conan Doyle
24961 \begin_layout Plain Layout
24964 It was in the spring of the year 1894 that all London was interested, and
24965 the fashionable world dismayed, by the murder of the Honourable Ronald
24966 Adair under most unusual and inexplicable circumstances.
24967 The public has already learned those particulars of the crime which came
24968 out in the police investigation, but a good deal was suppressed upon that
24969 occasion, since the case for the prosecution was so overwhelmingly strong
24970 that it was not necessary to bring forward all the facts.
24971 Only now, at the end of nearly ten years, am I allowed to supply those
24972 missing links which make up the whole of that remarkable chain.
24973 The crime was of interest in itself, but that interest was as nothing to
24974 me compared to the inconceivable sequel, which afforded me the greatest
24975 shock and surprise of any event in my adventurous life.
24976 Even now, after this long interval, I find myself thrilling as I think
24977 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24978 ty which utterly submerged my mind.
24979 Let me say to that public, which has shown some interest in those glimpses
24980 which I have occasionally given them of the thoughts and actions of a very
24981 remarkable man, that they are not to blame me if I have not shared my knowledge
24982 with them, for I should have considered it my first duty to do so, had
24983 I not been barred by a positive prohibition from his own lips, which was
24984 only withdrawn upon the third of last month.
24992 \begin_layout Standard
24993 To get 3 or more columns, set the cursor into the multicolumn inset and
24996 Insert\SpecialChar menuseparator
24998 \begin_inset space ~
25002 \begin_inset space ~
25008 The number of the desired columns is written into that inset (for 3
25009 \begin_inset space ~
25013 \begin_inset Quotes eld
25017 \begin_inset Quotes erd
25021 \begin_inset Newline newline
25024 Here is an example with 3
25025 \begin_inset space ~
25031 \begin_layout Standard
25032 \begin_inset Flex Multiple Columns
25035 \begin_layout Plain Layout
25038 \begin_inset Argument 1
25041 \begin_layout Plain Layout
25047 It can be imagined that my close intimacy with Sherlock Holmes had interested
25048 me deeply in crime, and that after his disappearance I never failed to
25049 read with care the various problems which came before the public.
25050 And I even attempted, more than once, for my own private satisfaction,
25051 to employ his methods in their solution, though with indifferent success.
25052 There was none, however, which appealed to me like this tragedy of Ronald
25054 As I read the evidence at the inquest, which led up to a verdict of willful
25055 murder against some person or persons unknown, I realized more clearly
25056 than I had ever done the loss which the community had sustained by the
25057 death of Sherlock Holmes.
25058 There were points about this strange business which would, I was sure,
25059 have specially appealed to him, and the efforts of the police would have
25060 been supplemented, or more probably anticipated, by the trained observation
25061 and the alert mind of the first criminal agent in Europe.
25062 All day, as I drove upon my round, I turned over the case in my mind and
25063 found no explanation which appeared to me to be adequate.
25064 At the risk of telling a twice-told tale, I will recapitulate the facts
25065 as they were known to the public at the conclusion of the inquest.
25073 \begin_layout Standard
25074 You can have up to 10
25075 \begin_inset space ~
25078 columns if you want to, but that might not be very pleasant for the readers
25082 \begin_layout Standard
25083 \begin_inset Newpage newpage
25089 \begin_layout Subsection
25090 Columns inside Columns
25093 \begin_layout Standard
25094 You can also have columns inside columns:
25097 \begin_layout Standard
25098 \begin_inset Flex Multiple Columns
25101 \begin_layout Plain Layout
25104 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
25105 at that time governor of one of the Australian colonies.
25106 Adair's mother had returned from Australia to undergo the operation for
25107 cataract, and she, her son Ronald, and her daughter Hilda were living together
25111 \begin_layout Plain Layout
25112 \begin_inset Flex Multiple Columns
25115 \begin_layout Plain Layout
25118 The youth moved in the best society–had, so far as was known, no enemies
25119 and no particular vices.
25120 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
25121 had been broken off by mutual consent some months before, and there was
25122 no sign that it had left any very profound feeling behind it.
25123 For the rest {sic} the man's life moved in a narrow and conventional circle,
25124 for his habits were quiet and his nature unemotional.
25125 Yet it was upon this easy-going young aristocrat that death came, in most
25126 strange and unexpected form, between the hours of ten and eleven-twenty
25127 on the night of March 30, 1894.
25135 \begin_layout Plain Layout
25138 Ronald Adair was fond of cards–playing continually, but never for such stakes
25140 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
25141 It was shown that, after dinner on the day of his death, he had played
25142 a rubber of whist at the latter club.
25143 He had also played there in the afternoon.
25148 The evidence of those who had played with him– Mr.
25149 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
25150 and that there was a fairly equal fall of the cards.
25151 Adair might have lost five pounds, but not more.
25152 His fortune was a considerable one, and such a loss could not in any way
25154 He had played nearly every day at one club or other, but he was a cautious
25155 player, and usually rose a winner.
25156 It came out in evidence that, in partnership with Colonel Moran, he had
25157 actually won as much as four hundred and twenty pounds in a sitting, some
25158 weeks before, from Godfrey Milner and Lord Balmoral.
25159 So much for his recent history as it came out at the inquest.
25167 \begin_layout Subsection
25171 \begin_layout Standard
25172 The examples in this section show some more special features of multiple
25176 \begin_layout Standard
25177 For more features of multiple columns, have a look at the documentation
25178 of the \SpecialChar LaTeX
25184 \begin_inset CommandInset citation
25194 \begin_layout Subsubsection
25198 \begin_layout Standard
25199 To add a preface text for multiple columns, set the cursor into the multicolumn
25200 inset and use the menu
25202 Insert\SpecialChar menuseparator
25206 Write your preface text into that inset.
25207 \begin_inset Newline newline
25210 This is an example with some preface text:
25213 \begin_layout Standard
25214 \begin_inset VSpace bigskip
25220 \begin_layout Standard
25221 \begin_inset Flex Multiple Columns
25224 \begin_layout Plain Layout
25225 \begin_inset Argument 2
25228 \begin_layout Plain Layout
25229 And the story continues and continues and continues and continues\SpecialChar ldots
25237 On the evening of the crime, he returned from the club exactly at ten.
25238 His mother and sister were out spending the evening with a relation.
25239 The servant deposed that she heard him enter the front room on the second
25240 floor, generally used as his sitting-room.
25241 She had lit a fire there, and as it smoked she had opened the window.
25242 No sound was heard from the room until eleven-twenty, the hour of the return
25243 of Lady Maynooth and her daughter.
25244 Desiring to say good-night, she attempted to enter her son's room.
25245 The door was locked on the inside, and no answer could be got to their
25246 cries and knocking.
25247 Help was obtained, and the door forced.
25248 The unfortunate young man was found lying near the table.
25249 His head had been horribly mutilated by an expanding revolver bullet, but
25250 no weapon of any sort was to be found in the room.
25258 \begin_layout Standard
25259 You can also use a section heading as the preface if you use a section command
25260 as \SpecialChar TeX
25262 For example the command
25265 \begin_layout Standard
25270 subsection{subsection title}
25273 \begin_layout Standard
25274 creates a subsection.
25275 In this example the preface is a subsubsection:
25278 \begin_layout Standard
25279 \begin_inset Flex Multiple Columns
25282 \begin_layout Plain Layout
25283 \begin_inset Argument 2
25286 \begin_layout Plain Layout
25290 \begin_layout Plain Layout
25299 This is a subsubsection heading as a preface
25303 \begin_layout Plain Layout
25317 A minute examination of the circumstances served only to make the case more
25319 In the first place, no reason could be given why the young man should have
25320 fastened the door upon the inside.
25321 There was the possibility that the murderer had done this, and had afterwards
25322 escaped by the window.
25323 The drop was at least twenty feet, however, and a bed of crocuses in full
25325 Neither the flowers nor the earth showed any sign of having been disturbed,
25326 nor were there any marks upon the narrow strip of grass which separated
25327 the house from the road.
25328 Apparently, therefore, it was the young man himself who had fastened the
25330 But how did he come by his death? No one could have climbed up to the window
25331 without leaving traces.
25332 Suppose a man had fired through the window, he would indeed be a remarkable
25333 shot who could with a revolver inflict so deadly a wound.
25334 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25335 a hundred yards of the house.
25336 No one had heard a shot.
25344 \begin_layout Standard
25345 If there is less vertical space than 6
25346 \begin_inset space ~
25349 text lines is left on the page at the beginning of the multiple columns,
25350 a page break will be inserted before the multiple columns.
25351 Depending on the number of lines of the preface text, you might want to
25353 This is done by setting the cursor into the mulitcolumn inset behind the
25354 preface (if there is any) and using the menu
25356 Insert\SpecialChar menuseparator
25358 \begin_inset space ~
25362 \begin_inset space ~
25366 \begin_inset space ~
25372 Insert into that inset the amount of space like e.
25373 \begin_inset space \thinspace{}
25377 \begin_inset space \space{}
25381 \begin_inset Quotes eld
25385 \begin_inset Quotes erd
25389 \begin_inset Newline newline
25392 In this example the space is set to 7
25393 \begin_inset space ~
25396 text lines by using
25397 \begin_inset Quotes eld
25403 \begin_inset Quotes erd
25412 needs to be inserted as \SpecialChar TeX
25416 \begin_layout Standard
25417 \begin_inset Flex Multiple Columns
25420 \begin_layout Plain Layout
25421 \begin_inset Argument 3
25424 \begin_layout Plain Layout
25429 \begin_layout Plain Layout
25445 On the evening of the crime, he returned from the club exactly at ten.
25446 His mother and sister were out spending the evening with a relation.
25447 The servant deposed that she heard him enter the front room on the second
25448 floor, generally used as his sitting-room.
25449 She had lit a fire there, and as it smoked she had opened the window.
25450 No sound was heard from the room until eleven-twenty, the hour of the return
25451 of Lady Maynooth and her daughter.
25452 Desiring to say good-night, she attempted to enter her son's room.
25453 The door was locked on the inside, and no answer could be got to their
25454 cries and knocking.
25455 Help was obtained, and the door forced.
25456 The unfortunate young man was found lying near the table.
25457 His head had been horribly mutilated by an expanding revolver bullet, but
25458 no weapon of any sort was to be found in the room.
25466 \begin_layout Subsubsection
25470 \begin_layout Standard
25471 The amount of space before and after multiple columns can be changed by
25472 changing the length
25479 For example the command
25482 \begin_layout Standard
25492 \begin_layout Standard
25493 in \SpecialChar TeX
25494 Code changes its value to 3
25495 \begin_inset space \thinspace{}
25499 The change must be made before the multiple columns' start.
25500 The predefined value is 13
25501 \begin_inset space \thinspace{}
25507 \begin_layout Standard
25515 \begin_inset space \thinspace{}
25521 \begin_layout Standard
25525 \begin_layout Plain Layout
25531 multicolsep}{2.5cm}
25539 \begin_layout Standard
25540 \begin_inset Flex Multiple Columns
25543 \begin_layout Plain Layout
25546 All day I turned these facts over in my mind, endeavouring to hit upon some
25547 theory which could reconcile them all, and to find that line of least resistanc
25548 e which my poor friend had declared to be the starting-point of every investigat
25550 I confess that I made little progress.
25551 In the evening I strolled across the Park, and found myself about six o'clock
25552 at the Oxford Street end of Park Lane.
25553 A group of loafers upon the pavements, all staring up at a particular window,
25554 directed me to the house which I had come to see.
25555 A tall, thin man with coloured glasses, whom I strongly suspected of being
25556 a plain-clothes detective, was pointing out some theory of his own, while
25557 the others crowded round to listen to what he said.
25558 I got as near him as I could, but his observations seemed to me to be absurd,
25559 so I withdrew again in some disgust.
25560 As I did so I struck against an elderly, deformed man, who had been behind
25561 me, and I knocked down several books which he was carrying.
25569 \begin_layout Standard
25570 \begin_inset Note Greyedout
25573 \begin_layout Plain Layout
25578 The values you set with
25584 will be used for all following multiple columns until you change them again.
25592 \begin_layout Standard
25596 \begin_layout Plain Layout
25608 \begin_inset Note Note
25611 \begin_layout Plain Layout
25612 go back to the default
25620 \begin_layout Standard
25621 \begin_inset Newpage newpage
25627 \begin_layout Subsubsection
25631 \begin_layout Standard
25632 A column break can be forced by inserting the command
25638 as \SpecialChar TeX
25639 Code to that position in the text where the column should be broken.
25640 Note that this leads in most cases to whitespace in the text.
25641 \begin_inset Newline newline
25644 Here is an example:
25647 \begin_layout Standard
25648 \begin_inset Flex Multiple Columns
25651 \begin_layout Plain Layout
25654 \begin_inset Quotes eld
25657 You're surprised to see me, sir,
25658 \begin_inset Quotes erd
25661 said he, in a strange, croaking voice.
25664 \begin_layout Plain Layout
25667 I acknowledged that I was.
25670 \begin_layout Plain Layout
25673 \begin_inset Quotes eld
25676 Well, I've a conscience, sir, and when I chanced to see you go into this
25677 house, as I came hobbling after you, I thought to myself, I'll just step
25678 in and see that kind gentleman, and tell him that if I was a bit gruff
25679 in my manner there was not any harm meant, and that I am much obliged to
25680 him for picking up my books.
25681 \begin_inset Quotes erd
25687 \begin_layout Plain Layout
25690 \begin_inset Quotes eld
25693 You make too much of a trifle,
25694 \begin_inset Quotes erd
25699 \begin_inset Quotes eld
25702 May I ask how you knew who I was?
25703 \begin_inset Quotes erd
25706 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25710 \begin_layout Plain Layout
25722 \begin_layout Plain Layout
25725 \begin_inset Quotes eld
25728 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25729 you'll find my little bookshop at the corner of Church Street, and very
25730 happy to see you, I am sure.
25731 Maybe you collect yourself, sir.
25735 \begin_inset space ~
25748 –a bargain, every one of them.
25749 With five volumes you could just fill that gap on that second shelf.
25750 It looks untidy, does it not, sir?
25751 \begin_inset Quotes erd
25762 \begin_layout Subsubsection
25766 \begin_layout Standard
25767 The width of the columns is automatically calculated, but you can modify
25768 the space between the columns.
25769 This is done by changing the length
25776 Its predefined value is 10
25777 \begin_inset space \thinspace{}
25781 Here is an example where
25788 \begin_inset space \thinspace{}
25794 \begin_layout Standard
25798 \begin_layout Plain Layout
25812 \begin_layout Standard
25813 \begin_inset Flex Multiple Columns
25816 \begin_layout Plain Layout
25819 My observations of No.
25820 \begin_inset space \space{}
25823 427 Park Lane did little to clear up the problem in which I was interested.
25824 The house was separated from the street by a low wall and railing, the
25825 whole not more than five feet high.
25826 It was perfectly easy, therefore, for anyone to get into the garden, but
25827 the window was entirely inaccessible, since there was no water pipe or
25828 anything which could help the most active man to climb it.
25829 More puzzled than ever, I retraced my steps to Kensington.
25830 I had not been in my study five minutes when the maid entered to say that
25831 a person desired to see me.
25832 To my astonishment it was none other than my strange old book collector,
25833 his sharp, wizened face peering out from a frame of white hair, and his
25834 precious volumes, a dozen of them at least, wedged under his right arm.
25842 \begin_layout Standard
25846 \begin_layout Plain Layout
25858 \begin_inset Note Note
25861 \begin_layout Plain Layout
25862 go back to the default
25870 \begin_layout Subsubsection
25874 \begin_layout Standard
25875 Between the columns a rule with a width of the length
25882 If this rule width is set to 0
25883 \begin_inset space \thinspace{}
25886 pt (this is the default), the rule is suppressed.
25887 In the following example the rule is 2
25888 \begin_inset space \thinspace{}
25894 \begin_layout Standard
25898 \begin_layout Plain Layout
25904 columnseprule}{2pt}
25912 \begin_layout Standard
25913 \begin_inset Flex Multiple Columns
25916 \begin_layout Plain Layout
25919 \begin_inset Quotes eld
25922 You're surprised to see me, sir,
25923 \begin_inset Quotes erd
25926 said he, in a strange, croaking voice.
25929 \begin_layout Plain Layout
25932 I acknowledged that I was.
25935 \begin_layout Plain Layout
25938 \begin_inset Quotes eld
25941 Well, I've a conscience, sir, and when I chanced to see you go into this
25942 house, as I came hobbling after you, I thought to myself, I'll just step
25943 in and see that kind gentleman, and tell him that if I was a bit gruff
25944 in my manner there was not any harm meant, and that I am much obliged to
25945 him for picking up my books.
25946 \begin_inset Quotes erd
25952 \begin_layout Plain Layout
25955 \begin_inset Quotes eld
25958 You make too much of a trifle,
25959 \begin_inset Quotes erd
25964 \begin_inset Quotes eld
25967 May I ask how you knew who I was?
25968 \begin_inset Quotes erd
25974 \begin_layout Plain Layout
25977 \begin_inset Quotes eld
25980 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25981 you'll find my little bookshop at the corner of Church Street, and very
25982 happy to see you, I am sure.
25983 Maybe you collect yourself, sir.
25987 \begin_inset space ~
26000 –a bargain, every one of them.
26001 With five volumes you could just fill that gap on that second shelf.
26002 It looks untidy, does it not, sir?
26003 \begin_inset Quotes erd
26014 \begin_layout Standard
26015 \begin_inset VSpace defskip
26021 \begin_layout Standard
26022 The rule can be colored by redefining the command
26029 This is done by inserting the command
26030 \begin_inset Newline newline
26039 columnseprulecolor}{
26044 \begin_inset Newline newline
26047 as \SpecialChar TeX
26048 Code before the multicolumn inset.
26053 in this command by a color of your choice.
26054 You can use all pre- and self-defined colors.
26062 \begin_inset space ~
26067 for more information about pre- and self-defined colors.
26068 To go back to the default color insert the command
26069 \begin_inset Newline newline
26078 columnseprulecolor}{
26083 \begin_inset Newline newline
26086 Here is the example with a cyan rule and 1
26087 \begin_inset space \thinspace{}
26090 cm column separation:
26093 \begin_layout Standard
26097 \begin_layout Plain Layout
26106 \begin_layout Plain Layout
26112 columnseprulecolor}{
26122 \begin_layout Standard
26123 \begin_inset Flex Multiple Columns
26126 \begin_layout Plain Layout
26129 \begin_inset Quotes eld
26132 You're surprised to see me, sir,
26133 \begin_inset Quotes erd
26136 said he, in a strange, croaking voice.
26139 \begin_layout Plain Layout
26142 I acknowledged that I was.
26145 \begin_layout Plain Layout
26148 \begin_inset Quotes eld
26151 Well, I've a conscience, sir, and when I chanced to see you go into this
26152 house, as I came hobbling after you, I thought to myself, I'll just step
26153 in and see that kind gentleman, and tell him that if I was a bit gruff
26154 in my manner there was not any harm meant, and that I am much obliged to
26155 him for picking up my books.
26156 \begin_inset Quotes erd
26162 \begin_layout Plain Layout
26165 \begin_inset Quotes eld
26168 You make too much of a trifle,
26169 \begin_inset Quotes erd
26174 \begin_inset Quotes eld
26177 May I ask how you knew who I was?
26178 \begin_inset Quotes erd
26184 \begin_layout Plain Layout
26187 \begin_inset Quotes eld
26190 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26191 you'll find my little bookshop at the corner of Church Street, and very
26192 happy to see you, I am sure.
26193 Maybe you collect yourself, sir.
26197 \begin_inset space ~
26210 –a bargain, every one of them.
26211 With five volumes you could just fill that gap on that second shelf.
26212 It looks untidy, does it not, sir?
26213 \begin_inset Quotes erd
26224 \begin_layout Standard
26228 \begin_layout Plain Layout
26234 columnseprule}{0pt}
26237 \begin_layout Plain Layout
26243 columnseprulecolor}{
26251 \begin_inset Note Note
26254 \begin_layout Plain Layout
26255 go back to the default
26263 \begin_layout Section
26264 Non-standard Paragraph Shapes
26267 \begin_layout Standard
26270 as well as any other text processor uses by default rectangular paragraphs.
26271 For special cases like for example posters, invitation cards or poems you
26272 can modify the paragraph shape to one of your choice.
26273 This can be done by using the \SpecialChar LaTeX
26278 which is loaded by using in the document settings the module
26280 Custom paragraph shapes
26285 \begin_layout Subsection
26289 \begin_layout Standard
26294 provides the following shapes:
26297 \begin_layout Standard
26298 \begin_inset Tabular
26299 <lyxtabular version="3" rows="13" columns="3">
26300 <features booktabs="true" islongtable="true" longtabularalignment="center">
26301 <column alignment="center" valignment="middle" width="16col%">
26302 <column alignment="center" valignment="middle" width="40col%">
26303 <column alignment="center" valignment="middle" width="35col%">
26304 <row endhead="true">
26305 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26308 \begin_layout Plain Layout
26314 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26317 \begin_layout Plain Layout
26323 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26326 \begin_layout Plain Layout
26334 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26337 \begin_layout Plain Layout
26343 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26346 \begin_layout Plain Layout
26347 Circle with circular hole (in the size of a CD/DVD)
26352 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26355 \begin_layout Plain Layout
26356 Cannot be scaled, take care there is not too much text
26363 <cell alignment="center" valignment="top" topline="true" usebox="none">
26366 \begin_layout Plain Layout
26372 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26375 \begin_layout Plain Layout
26381 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26384 \begin_layout Plain Layout
26385 Fragile, calculation might fail
26392 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26395 \begin_layout Plain Layout
26401 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26404 \begin_layout Plain Layout
26405 Rhomboid (symbolizing a
26406 \begin_inset Quotes eld
26410 \begin_inset Quotes erd
26418 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26421 \begin_layout Plain Layout
26429 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26432 \begin_layout Plain Layout
26438 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26441 \begin_layout Plain Layout
26447 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26450 \begin_layout Plain Layout
26458 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26461 \begin_layout Plain Layout
26467 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26470 \begin_layout Plain Layout
26476 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26479 \begin_layout Plain Layout
26487 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26490 \begin_layout Plain Layout
26496 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26499 \begin_layout Plain Layout
26500 Nut for bolt (hexagon with circular hole)
26505 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26508 \begin_layout Plain Layout
26516 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26519 \begin_layout Plain Layout
26525 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26528 \begin_layout Plain Layout
26534 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26537 \begin_layout Plain Layout
26545 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26548 \begin_layout Plain Layout
26554 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26557 \begin_layout Plain Layout
26563 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26566 \begin_layout Plain Layout
26574 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26577 \begin_layout Plain Layout
26583 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26586 \begin_layout Plain Layout
26592 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26595 \begin_layout Plain Layout
26603 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26606 \begin_layout Plain Layout
26612 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26615 \begin_layout Plain Layout
26616 Normal/reversed rain drop
26621 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26624 \begin_layout Plain Layout
26625 Fragile, calculation might fail
26632 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26635 \begin_layout Plain Layout
26642 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26645 \begin_layout Plain Layout
26646 The \SpecialChar TeX
26652 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26655 \begin_layout Plain Layout
26663 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26666 \begin_layout Plain Layout
26668 \begin_inset Newline newline
26676 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26679 \begin_layout Plain Layout
26680 Triangles in different orientations
26685 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26688 \begin_layout Plain Layout
26702 \begin_layout Standard
26703 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26705 for environments in the toolbar.
26708 \begin_layout Standard
26709 \begin_inset Newpage newpage
26715 \begin_layout Standard
26716 Here is an example paragraph in the shape of a nut:
26719 \begin_layout Standard
26720 \begin_inset VSpace bigskip
26729 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26730 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26732 At vero eos et accusam et justo duo dolores et ea rebum.
26733 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26735 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26736 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26740 \begin_layout Standard
26741 \begin_inset VSpace bigskip
26747 \begin_layout Standard
26748 \begin_inset Note Greyedout
26751 \begin_layout Plain Layout
26756 : shapepar paragraphs cannot run over a page break.
26764 \begin_layout Standard
26765 \begin_inset VSpace bigskip
26771 \begin_layout Standard
26776 takes care that the shape will always be preserved, no matter how much
26777 text is in the paragraph.
26778 Therefore the paragraph size changes with the amount of contained text.
26779 This can lead to paragraph sizes exceeding the page margins.
26780 To demonstrate the size scaling, here is the same example paragraph but
26781 with twice as much text:
26784 \begin_layout Standard
26785 \begin_inset Newpage newpage
26794 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26795 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26797 At vero eos et accusam et justo duo dolores et ea rebum.
26798 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26800 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26801 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26803 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26804 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26806 At vero eos et accusam et justo duo dolores et ea rebum.
26807 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26809 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26810 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26814 \begin_layout Standard
26815 \begin_inset VSpace bigskip
26821 \begin_layout Standard
26822 An exception is the shape
26827 It cannot be scaled because it must fit the size of a CD/DVD.
26828 Therefore the amount of text that fits into the shape is limited.
26829 \begin_inset Newline newline
26840 shape are fragile, meaning that the calculation of their size can fail,
26841 depending on the amount of text.
26842 You will then get the \SpecialChar LaTeX
26844 \begin_inset Quotes eld
26847 Arithmetic overflow
26848 \begin_inset Quotes erd
26852 In this case one can try to remove or add some text; if nothing works one
26853 has to use another shape.
26856 \begin_layout Standard
26857 \begin_inset VSpace bigskip
26863 \begin_layout Standard
26864 For shapes with tips you will maybe see that \SpecialChar LaTeX
26865 's hyphenation routine fails
26866 for text in the tips.
26867 Therefore it is often necessary to add hyphenation points
26872 arg "specialchar-insert hyphenation"
26877 ) to the corresponding text parts.
26880 \begin_layout Standard
26881 \begin_inset VSpace bigskip
26887 \begin_layout Standard
26888 Shapepar paragraphs are either always centered or placed on the page so
26889 that their left border touches the left page margin.
26890 You can therefore not use the paragraph dialog to align such paragraphs.
26891 A solution is to put the paragraph into a minipage or parbox and align
26893 The problem is hereby to find the right width for the box.
26894 Because if it is too wide and you center the box, the paragraph is not
26895 centered too because it sticks at the left side of the box.
26896 So you might have to play a bit with the width until it fits.
26897 Here are two heart-shaped paragraphs, the first one is not aligned, the
26898 second one is right-aligned:
26901 \begin_layout Standard
26902 \begin_inset Newpage newpage
26908 \begin_layout Heart
26912 Lo\SpecialChar softhyphen
26913 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26914 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26916 At vero eos et accusam et justo duo dolores et ea rebum.
26917 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26921 \begin_layout Standard
26922 \begin_inset VSpace bigskip
26928 \begin_layout Standard
26931 \begin_inset Box Frameless
26941 height_special "totalheight"
26946 backgroundcolor "none"
26949 \begin_layout Heart
26953 Lo\SpecialChar softhyphen
26954 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26955 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26957 At vero eos et accusam et justo duo dolores et ea rebum.
26958 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26967 \begin_layout Subsection
26971 \begin_layout Standard
26972 You can define any shape you want.
26973 Doing this manually is a lot of work because every coordinate must be specified.
26974 But there is a way to let the computer calculate the coordinates:
26977 \begin_layout Enumerate
26978 Install the program
26979 \begin_inset CommandInset href
26982 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26990 \begin_layout Enumerate
26997 TeX/LaTeX\SpecialChar menuseparator
26998 Settings\SpecialChar menuseparator
27001 and select the font size you are using in your document.
27002 For example this document uses the size 12
27003 \begin_inset space \thinspace{}
27009 \begin_layout Enumerate
27013 \begin_layout Enumerate
27016 TeX/LaTeX\SpecialChar menuseparator
27019 to export the shape to coordinates.
27020 In the appearing dialog use either the outline of your shape for the coordinate
27021 s or the path itself.
27025 \begin_layout Plain Layout
27026 For more information see
27027 \begin_inset CommandInset href
27029 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
27042 \begin_layout Standard
27043 The coordinates are written into a \SpecialChar TeX
27045 To use it for your \SpecialChar LyX
27049 \begin_layout Enumerate
27050 Place the cursor before the first character of your paragraph (or into a
27054 \begin_layout Enumerate
27055 Open in \SpecialChar LyX
27058 Insert\SpecialChar menuseparator
27059 File\SpecialChar menuseparator
27061 \begin_inset space ~
27066 , select the file and use
27075 \begin_layout Standard
27076 \begin_inset VSpace defskip
27082 \begin_layout Standard
27083 \begin_inset Note Greyedout
27086 \begin_layout Plain Layout
27091 : The changed shape only applies to the current paragraph; everything is
27092 reset to normal for the next paragraph.
27093 Therefore the shape definition file must be input into every paragraph
27094 with the desired shape.
27102 \begin_layout Standard
27103 \begin_inset VSpace bigskip
27109 \begin_layout Standard
27110 Here is an example:
27113 \begin_layout Standard
27114 \begin_inset VSpace bigskip
27120 \begin_layout Standard
27121 \begin_inset CommandInset include
27123 filename "SpecialParagraphShape.tex"
27129 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27130 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27132 At vero eos et accusam et justo duo dolores et ea rebum.
27133 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27135 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27136 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27140 \begin_layout Standard
27141 \begin_inset VSpace bigskip
27147 \begin_layout Standard
27152 to draw complexer shapes in
27156 you can draw the shape in a program of your choice and import the resulting
27162 Then you only need to draw a line or spline along the outline of the image.
27165 \begin_layout Standard
27166 \begin_inset VSpace bigskip
27172 \begin_layout Standard
27175 Custom paragraph shapes
27177 also provides the two commands
27185 which can be used to define custom shapes coordinate by coordinate.
27189 \begin_layout Plain Layout
27190 These commands are internally used for all shapes described here.
27195 For information how these styles are used and about further customization
27196 possibilities, have a look at the documentation of the package
27201 \begin_inset CommandInset citation
27211 \begin_layout Bibliography
27212 \begin_inset CommandInset bibitem
27213 LatexCommand bibitem
27219 Documentation of the \SpecialChar LaTeX
27221 \begin_inset CommandInset href
27224 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
27232 \begin_layout Bibliography
27233 \begin_inset CommandInset bibitem
27234 LatexCommand bibitem
27240 Documentation of the \SpecialChar LaTeX
27242 \begin_inset CommandInset href
27245 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"