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/"
1038 \begin_layout Standard
1039 If you do need to do some wild and fancy things within your document, be
1040 sure to check out a good \SpecialChar LaTeX
1041 book for assistance.
1042 There are a number of them listed in the bibliography of the
1049 \begin_layout Section
1051 and the \SpecialChar LaTeX
1055 \begin_layout Subsection
1056 About the \SpecialChar LaTeX
1060 \begin_layout Standard
1061 If you already know \SpecialChar LaTeX
1062 , there is no need to explain here what the preamble
1064 If you don't, the following will give you some ideas—we recommend again
1065 that you consult a \SpecialChar LaTeX
1066 book for further information.
1067 In any case, you should read the points below, because they explain what
1068 you can do and what you don't need to do in the \SpecialChar LaTeX
1069 preamble of a \SpecialChar LyX
1073 \begin_layout Standard
1074 The \SpecialChar LaTeX
1075 preamble comes at the very beginning of a document,
1083 \begin_layout Itemize
1084 Declare the document class.
1086 \begin_inset Newline newline
1090 already does this for you.
1091 If you're a seasoned \SpecialChar LaTeX
1092 -nician, and you have a custom document class you
1093 want to use, check out the
1095 Customization Manual
1097 for information on how to make \SpecialChar LyX
1101 \begin_layout Itemize
1102 Declare the usage of packages.
1104 \begin_inset Newline newline
1108 packages provide special commands, which are only available within a document
1109 when the package has been declared in the preamble.
1110 In addition to providing special commands, the inclusion of a package can
1111 change the document.
1112 For example, the package
1113 \begin_inset Flex Code
1116 \begin_layout Plain Layout
1122 forces all paragraphs to be indented.
1123 There are other packages for labels, envelopes, margins, etc.
1127 \begin_layout Itemize
1128 Set counters, variables, lengths and widths.
1130 \begin_inset Newline newline
1133 There are several \SpecialChar LaTeX
1134 counters and variables that
1138 be set globally from within the preamble in order to have the desired effect.
1139 (There are variables that you can set and reset inside the document, too.)
1140 Margins are a good example of something that must be set in the preamble.
1141 Another example is the label format for lists.
1142 You can actually set these just about anywhere, but it's best to do it
1143 just once, inside the preamble.
1146 \begin_layout Itemize
1147 Declare user defined commands (with
1148 \begin_inset Flex Code
1151 \begin_layout Plain Layout
1160 \begin_inset Flex Code
1163 \begin_layout Plain Layout
1172 \begin_inset Newline newline
1175 These are abbreviations for \SpecialChar LaTeX
1176 commands which appear very often inside a document.
1177 Although the preamble is a good place to declare such commands, they
1181 be declared anywhere (before they are used for the first time, of course).
1182 This can be useful if there is a lot of raw \SpecialChar LaTeX
1183 code in your document, which
1184 normally should not be the case.
1187 \begin_layout Standard
1189 adds its own set of definitions to the preamble of the
1190 \begin_inset Flex Code
1193 \begin_layout Plain Layout
1200 This makes \SpecialChar LaTeX
1201 files generated by \SpecialChar LyX
1205 \begin_layout Subsection
1206 Changing the Preamble
1209 \begin_layout Standard
1210 The commands which \SpecialChar LyX
1211 adds to the preamble of a \SpecialChar LaTeX
1212 file are fixed; you can't
1213 change them without patching \SpecialChar LyX
1215 You can, however, add your own stuff to the preamble by selecting
1216 \begin_inset Flex Noun
1219 \begin_layout Plain Layout
1222 \begin_inset space ~
1231 \begin_inset Flex Noun
1234 \begin_layout Plain Layout
1235 Document\SpecialChar menuseparator
1243 adds anything in the
1244 \begin_inset Flex Noun
1247 \begin_layout Plain Layout
1253 dialog to its own built-in preamble.
1254 Before adding your own declarations in the preamble, you should make sure
1255 that \SpecialChar LyX
1256 doesn't already support what you want to do.
1257 (Remember what we said about reinventing the wheel?) Also,
1259 make sure your preamble code is correct
1263 doesn't check it for you.
1264 If there is an error, you're likely to get an error like
1265 \begin_inset Quotes eld
1269 \begin_inset Flex Code
1272 \begin_layout Plain Layout
1281 \begin_inset Quotes erd
1285 If you see this error, check your preamble.
1288 \begin_layout Subsection
1292 \begin_layout Standard
1293 Here are some examples of what you can add to a preamble, and what they
1297 \begin_layout Subsubsection
1301 \begin_layout Standard
1302 There are two variables under \SpecialChar LaTeX
1303 that control page position:
1304 \begin_inset Flex Code
1307 \begin_layout Plain Layout
1316 \begin_inset Flex Code
1319 \begin_layout Plain Layout
1328 Their names should be self-explanatory.
1329 These variables are useful if you think for a moment about computer labels.
1330 Sometimes, the size of a print medium and the area of the medium that you
1331 can actually print on aren't the same.
1333 \begin_inset Flex Code
1336 \begin_layout Plain Layout
1345 \begin_inset Flex Code
1348 \begin_layout Plain Layout
1359 \begin_layout Standard
1360 The default values for
1361 \begin_inset Flex Code
1364 \begin_layout Plain Layout
1373 \begin_inset Flex Code
1376 \begin_layout Plain Layout
1385 \begin_inset space \thinspace{}
1389 \begin_inset space \thinspace{}
1393 \begin_inset space \space{}
1396 the page isn't shifted.
1397 Unfortunately, some DVI drivers always seem to shift the page.
1398 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1399 If you're using \SpecialChar LyX
1400 on a system that you don't personally maintain, and your
1401 sysadmin is a doofus,
1402 \begin_inset Flex Code
1405 \begin_layout Plain Layout
1414 \begin_inset Flex Code
1417 \begin_layout Plain Layout
1426 Suppose your left and top margins are always 0.5
1427 \begin_inset space \thinspace{}
1431 You can add this to the preamble:
1434 \begin_layout LyX-Code
1442 \begin_layout LyX-Code
1450 \begin_layout Standard
1451 and your margins should now be correct.
1454 \begin_layout Subsubsection
1458 \begin_layout Standard
1459 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1460 There's a rather nice package, available at your nearest CTAN archive,
1461 for printing sheets of labels:
1462 \begin_inset Flex Code
1465 \begin_layout Plain Layout
1472 Now, your system may not have this package installed by default.
1473 We leave that up to you to check.
1474 You'll also want to read the documentation for it; we're not going to do
1476 Since this is an example, however, we'll give you an example of how you
1480 \begin_layout Standard
1481 First, make sure you're using the
1482 \begin_inset Flex Code
1485 \begin_layout Plain Layout
1492 Next, you need to put the following in your preamble:
1495 \begin_layout LyX-Code
1501 \begin_layout LyX-Code
1507 \begin_layout LyX-Code
1513 \begin_layout LyX-Code
1519 \begin_layout LyX-Code
1525 \begin_layout LyX-Code
1531 \begin_layout LyX-Code
1537 \begin_layout Standard
1538 This sets things up for Avery label sheets, stock #5360.
1539 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1542 \begin_inset Flex Code
1545 \begin_layout Plain Layout
1554 \begin_inset Flex Code
1557 \begin_layout Plain Layout
1565 around each label text.
1566 This and other special features of
1567 \begin_inset Flex Code
1570 \begin_layout Plain Layout
1576 are explained in its documentation.
1579 \begin_layout Standard
1580 Someday, someone may write a \SpecialChar LyX
1581 layout file to support this package directly.
1582 Maybe that someone is you.
1585 \begin_layout Subsubsection
1586 Example #3: Paragraph Indentation
1589 \begin_layout Standard
1590 Americans are trained to indent the first line of
1595 As with all of their other weird quirks, most Americans will whine and
1596 moan until they can have their way and indent the first line of all paragraphs.
1605 \begin_layout Standard
1606 Of course, this behavior isn't standard typography.
1607 In books, you typically only indent the first line of a paragraph
1611 it follows another one.
1612 The idea behind indenting the first line of a paragraph is to distinguish
1613 neighboring paragraphs from one another.
1614 If there is no previous paragraph—for example, if it follows a figure or
1615 is the first paragraph in a section—then there is no need for indentation.
1619 \begin_layout Standard
1620 If you're a typical American (we're still joking!), though, you don't care
1621 about such esoteric things; you want your indentation! Add this to the
1625 \begin_layout LyX-Code
1628 usepackage{indentfirst}
1631 \begin_layout Standard
1632 If your \SpecialChar TeX
1633 distribution isn't braindead, you'll have this package, and all
1634 of your paragraphs will get the indentation the Founding Fathers intended
1638 \begin_layout Subsubsection
1639 Example #4: This Document
1642 \begin_layout Standard
1643 You can also check out the preamble of this document to get an idea of some
1644 of the advanced things you can do.
1647 \begin_layout Section
1649 and \SpecialChar LaTeX
1653 \begin_layout Standard
1654 When \SpecialChar LyX
1655 calls \SpecialChar LaTeX
1656 , it tells \SpecialChar LaTeX
1657 to blithely ignore any errors and keep going.
1658 It then uses the logfile from the \SpecialChar LaTeX
1659 run to do a post-mortem.
1660 After analyzing the logfile, \SpecialChar LyX
1661 displays a dialog listing the errors.
1662 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1664 where the error occurred.
1668 \begin_layout Plain Layout
1670 Analyzing the logfile is a tough job, and \SpecialChar LyX
1671 doesn't always go to the right
1673 There are also cases where \SpecialChar LaTeX
1674 reports the error on one line, but the actual
1676 This is not unlike forgetting a closing brace in a program: You'll get
1677 an error, but only later.
1685 \begin_layout Standard
1686 Some folks also like to look at the log file directly: It is available from
1688 \begin_inset Flex Noun
1691 \begin_layout Plain Layout
1692 Document\SpecialChar menuseparator
1694 \begin_inset space ~
1703 There are some fairly common error messages and warnings.
1704 We'll cover those here.
1705 You should look at a good \SpecialChar LaTeX
1706 book for a complete listing.
1709 \begin_layout Itemize
1710 \begin_inset Flex Code
1713 \begin_layout Plain Layout
1720 \begin_inset Newline newline
1723 Anything beginning with these words is a warning message for the purpose
1725 \begin_inset Quotes eld
1729 \begin_inset Quotes erd
1732 the \SpecialChar LaTeX
1734 You'll get messages like this if you added or changed cross-references
1735 or bibliography entries, in which case, \SpecialChar LaTeX
1736 is trying to tell you that you
1737 need to make another run.
1738 You can by-and-large ignore these.
1741 \begin_layout Itemize
1742 \begin_inset Flex Code
1745 \begin_layout Plain Layout
1752 \begin_inset Newline newline
1755 Another warning message, this time about fonts which \SpecialChar LaTeX
1757 The rest of the message will often say something about a replacement font
1758 that \SpecialChar LaTeX
1760 You can safely ignore these, too.
1763 \begin_layout Itemize
1764 \begin_inset Flex Code
1767 \begin_layout Plain Layout
1776 \begin_inset Newline newline
1785 They are warnings about lines that were too long and run past the right
1787 Almost always, this is unnoticeable in the final output.
1788 (It can be just a point or two.) Or, only one or two characters extend past
1791 seems to generate at least one of these messages for just about any document
1793 \begin_inset Newline newline
1796 You can ignore these messages.
1797 Your eyes will tell you if there's a problem with something that's too
1798 wide; just look at the output.
1802 \begin_layout Plain Layout
1803 You can also enable the `draft' option in
1804 \begin_inset Flex Noun
1807 \begin_layout Plain Layout
1808 Document\SpecialChar menuseparator
1814 , and then \SpecialChar LaTeX
1815 will draw a black box in the margin of lines that are overfull.
1823 \begin_layout Itemize
1824 \begin_inset Flex Code
1827 \begin_layout Plain Layout
1836 \begin_inset Newline newline
1839 Not quite as common as its cousin.
1841 seems to like to print lines that are a bit too wide as opposed to ones
1842 that are a bit too narrow.
1843 We have no idea why.
1846 \begin_layout Itemize
1847 \begin_inset Flex Code
1850 \begin_layout Plain Layout
1859 \begin_inset Flex Code
1862 \begin_layout Plain Layout
1871 \begin_inset Newline newline
1874 Warnings about troubles breaking the page.
1875 Once again, just look at the output.
1876 Your eyes will tell you where something has gone wrong.
1879 \begin_layout Itemize
1880 \begin_inset Flex Code
1883 \begin_layout Plain Layout
1885 \begin_inset Quotes els
1889 \begin_inset Quotes ers
1898 \begin_inset Newline newline
1902 \begin_inset Quotes eld
1906 \begin_inset Quotes erd
1909 isn't installed on this system.
1910 This usually appears because some package your document needs isn't installed.
1911 If you didn't touch the preamble or didn't use the
1912 \begin_inset Flex Code
1915 \begin_layout Plain Layout
1923 command, then one of the packages \SpecialChar LyX
1924 tried to load is missing.
1926 \begin_inset Flex Noun
1929 \begin_layout Plain Layout
1930 Help\SpecialChar menuseparator
1937 to get a list of packages that \SpecialChar LyX
1939 This file is updated whenever you reconfigure \SpecialChar LyX
1941 \begin_inset Flex Noun
1944 \begin_layout Plain Layout
1945 Tools\SpecialChar menuseparator
1951 ) and tells you which packages have been detected and what they do.
1952 \begin_inset Newline newline
1956 \begin_inset Flex Code
1959 \begin_layout Plain Layout
1967 command and the package in question isn't installed, then you'll need to
1968 install it yourself.
1971 \begin_layout Itemize
1972 \begin_inset Flex Code
1975 \begin_layout Plain Layout
1976 LaTeX Error: Unknown option
1982 \begin_inset Newline newline
1985 Error messages beginning with this are trying to tell you that you specified
1986 a bad or undefined option to a package.
1987 Check the package's documentation.
1990 \begin_layout Itemize
1991 \begin_inset Flex Code
1994 \begin_layout Plain Layout
1995 Undefined control sequence
2001 \begin_inset Newline newline
2004 If you've inserted \SpecialChar LaTeX
2005 code into your document, but made a typo, you'll get
2007 You may have forgotten to load a package.
2008 In any case, this error message usually means that you used an undefined
2013 \begin_layout Standard
2014 There are other error and warning messages.
2015 Some are self-explanatory.
2016 These are usually \SpecialChar LaTeX
2018 Others are downright cryptic.
2019 These are usually \SpecialChar TeX
2020 error messages, and we really have
2024 what they mean or how to decipher them.
2028 \begin_layout Standard
2029 There's a general sequence you should follow if you get error messages:
2032 \begin_layout Enumerate
2033 Look at the \SpecialChar LaTeX
2034 code you inserted for typos.
2037 \begin_layout Enumerate
2038 If there are no typos, check that you used the command(s) correctly.
2041 \begin_layout Enumerate
2042 If you get a bunch of error boxes piled up at the very top of the document—and
2043 especially if you see a
2044 \begin_inset Quotes eld
2048 \begin_inset Flex Code
2051 \begin_layout Plain Layout
2060 \begin_inset Quotes erd
2063 error—it means that there are errors in the preamble.
2064 Start debugging your preamble.
2067 \begin_layout Enumerate
2068 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2070 document, the first suspect is your \SpecialChar LaTeX
2071 distribution itself.
2072 Check for missing packages and install them.
2075 \begin_layout Enumerate
2076 Okay, so there are no missing packages.
2077 Did you use any of the fine-tuning options in \SpecialChar LyX
2078 ? Specifically, did you
2082 any of them, like trying to manually insert lots of
2083 \begin_inset Flex Code
2086 \begin_layout Plain Layout
2088 \begin_inset space ~
2097 \begin_inset Flex Code
2100 \begin_layout Plain Layout
2107 \begin_inset Flex Code
2110 \begin_layout Plain Layout
2116 ? Did you try to kludge something together with these instead of using the
2117 appropriate paragraph environment?
2120 \begin_layout Enumerate
2121 All right, you didn't use any of the fine-tuning options, you played by
2123 Did you try to pull a fancy maneuver? Did you do something funky inside
2124 a table or an equation, like inserting a graphic into a table cell?
2127 \begin_layout Enumerate
2128 Do you have long sections of text where \SpecialChar LaTeX
2129 cannot find a place to break a
2130 line? By default, \SpecialChar LaTeX
2131 is rather strict about how much extra inter-word spacing
2132 it will add in order to break a line.
2133 Preferably, you should rework the paragraph to avoid the problem.
2136 \begin_layout Enumerate
2137 Did you go overboard with the nesting? \SpecialChar LyX
2138 (currently) doesn't check to make
2139 sure you're in the limits for nesting environments.
2140 If you nested a bunch of environments to the
2141 \begin_inset Formula $17^{\mathrm{th}}$
2144 level, that's the problem.
2145 (The limit in \SpecialChar LaTeX
2149 \begin_layout Enumerate
2150 Okay, you didn't get any error messages, but your output looks awful.
2151 If you have a table or figure that's too wide or long for the page, you
2156 \begin_layout Enumerate
2157 rescale the figure so it fits.
2160 \begin_layout Enumerate
2161 trim down the table so it fits.
2165 \begin_layout Enumerate
2166 If something else is wrong with the output, and you didn't try to pull anything
2167 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2170 \begin_layout Standard
2171 If all this doesn't help—well, then
2175 you might have found a bug in \SpecialChar LyX
2180 \begin_layout Chapter
2184 \begin_layout Section
2185 Customizing Bibliographies with Bib\SpecialChar TeX
2187 \change_inserted -712698321 1485694846
2193 \begin_layout Standard
2194 The most basic information about how to use Bib\SpecialChar TeX
2196 \change_inserted -712698321 1485694851
2203 with \SpecialChar LyX
2204 is contained in the section
2206 Bibliography databases
2207 \change_deleted -712698321 1485694823
2208 (Bib\SpecialChar TeX
2218 The following subsections explain special bibliography features supported
2223 \begin_layout Subsection
2224 Alternative Citation Styles
2227 \begin_layout Standard
2228 Standard Bib\SpecialChar TeX
2230 \begin_inset space \thinspace{}
2234 \begin_inset space \space{}
2238 \begin_inset Quotes eld
2242 \begin_inset Quotes erd
2245 ) to refer to a cited work.
2246 However, in many scientific disciplines, other citation styles are in use.
2247 The most common one is the author-year style (e.
2248 \begin_inset space \thinspace{}
2252 \begin_inset space \space{}
2256 \begin_inset Quotes eld
2260 \begin_inset Quotes erd
2266 \change_deleted -712698321 1485694902
2268 \change_inserted -712698321 1485694902
2271 packages that provide this style,
2272 \change_inserted -712698321 1485694917
2274 \begin_inset Flex Code
2277 \begin_layout Plain Layout
2279 \change_inserted -712698321 1485694917
2290 \begin_inset Flex Code
2293 \begin_layout Plain Layout
2300 \change_inserted -712698321 1485696751
2304 \begin_inset Flex Code
2307 \begin_layout Plain Layout
2315 \change_deleted -712698321 1485695091
2317 \change_inserted -712698321 1485695093
2321 \change_deleted -712698321 1485695095
2323 \change_inserted -712698321 1485695095
2326 their pros and cons, which cannot be listed in detail.
2327 If you only want to have simple author-year (or author-numerical) style,
2328 or if you want to use one of the countless style files for
2329 \begin_inset Flex Code
2332 \begin_layout Plain Layout
2338 , then the established
2339 \begin_inset Flex Code
2342 \begin_layout Plain Layout
2348 package is probably your choice.
2350 \change_inserted -712698321 1485695152
2351 look for specific citation styles common in law studies
2352 \change_deleted -712698321 1485695162
2353 need special features like short title references, ibidem etc.
2355 , you might consider the
2356 \begin_inset Flex Code
2359 \begin_layout Plain Layout
2367 \change_inserted -712698321 1485695432
2368 If you want to have full control over the formatting or look for advanced
2369 features such as ibidem, footnote citations, full title citations, advanced
2370 date formats (such as 400 BC) or full localization to other languages than
2371 English, you should definitely consider
2372 \begin_inset Flex Code
2375 \begin_layout Plain Layout
2377 \change_inserted -712698321 1485695328
2383 , which exceeds all other packages in terms of features, but is also quite
2384 heavy and more resource-hungry.
2389 \begin_layout Standard
2391 \change_deleted -712698321 1485695449
2393 \change_inserted -712698321 1485695449
2396 packages in \SpecialChar LyX
2397 is basically the same.
2399 \begin_inset Flex Noun
2402 \begin_layout Plain Layout
2403 Document\SpecialChar menuseparator
2410 \begin_inset Flex Noun
2413 \begin_layout Plain Layout
2420 \change_deleted -712698321 1485695462
2422 \change_inserted -712698321 1485695559
2424 \begin_inset Flex Noun
2427 \begin_layout Plain Layout
2429 \change_inserted -712698321 1485695499
2436 \begin_inset Flex Noun
2439 \begin_layout Plain Layout
2441 \change_inserted -712698321 1485695527
2448 \begin_inset Flex Noun
2451 \begin_layout Plain Layout
2453 \change_inserted -712698321 1485695554
2454 Biblatex (Natbib mode)
2462 \begin_inset Flex Noun
2465 \begin_layout Plain Layout
2467 \change_inserted -712698321 1485695505
2476 \begin_inset Flex Noun
2479 \begin_layout Plain Layout
2481 \change_inserted -712698321 1485695511
2490 \change_inserted -712698321 1485695637
2492 \begin_inset space ~
2495 6.5.3 in the User's Guide for more information on these choices)
2499 \change_deleted -712698321 1485695643
2501 \change_inserted -712698321 1485695645
2504 packages, you will get some extra features in the citation dialog and you
2505 can select the style of the reference (
2506 \begin_inset Quotes eld
2510 \begin_inset Quotes erd
2514 \begin_inset Quotes eld
2518 \begin_inset Quotes erd
2522 \begin_inset Quotes eld
2526 \begin_inset Quotes erd
2530 \begin_inset Quotes eld
2534 \begin_inset Quotes erd
2539 \change_deleted -712698321 1485695659
2541 \change_inserted -712698321 1485695660
2545 \change_deleted -712698321 1485695663
2549 \change_inserted -712698321 1485695664
2552 specifically designed style files.
2554 \change_deleted -712698321 1485695676
2556 \change_inserted -712698321 1485695676
2559 ship their own, but there are lots of additional style files, and there
2560 is even an interactive style file builder
2564 \begin_layout Plain Layout
2566 \begin_inset Flex URL
2569 \begin_layout Plain Layout
2571 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2582 \begin_inset Flex Code
2585 \begin_layout Plain Layout
2594 \begin_layout Subsection
2595 Sectioned Bibliographies
2598 \begin_layout Standard
2599 Sometimes you might need to divide your bibliography into several sections.
2600 If you are for instance a historian, the possibility to separate sources
2601 and scientific works is most likely a
2602 \begin_inset Quotes eld
2606 \begin_inset Quotes erd
2610 Unfortunately, Bib\SpecialChar TeX
2611 itself does not allow you to do this.
2612 But with the help of some \SpecialChar LaTeX
2613 packages, Bib\SpecialChar TeX
2614 can be extended to fit your needs.
2617 \begin_layout Standard
2619 provides native support for one of these packages,
2627 \begin_layout Plain Layout
2629 \begin_inset Flex URL
2632 \begin_layout Plain Layout
2634 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2644 The advantage of this package (compared to other packages
2645 \change_deleted -712698321 1485695727
2647 \change_inserted -712698321 1485695729
2654 ) is that you don't need to define new citation commands.
2655 Instead, you need to prepare different bibliographic databases which include
2656 the entries for the different sections of the bibliography.
2657 For example: If you want to divide your bibliography into the sections
2659 \begin_inset Quotes eld
2663 \begin_inset Quotes erd
2667 \begin_inset Quotes eld
2671 \begin_inset Quotes erd
2674 , you first need to create two bibliographic databases, e.
2675 \begin_inset space \thinspace{}
2679 \begin_inset space \space{}
2683 \begin_inset Flex Code
2686 \begin_layout Plain Layout
2693 \begin_inset Flex Code
2696 \begin_layout Plain Layout
2706 \begin_layout Standard
2708 \begin_inset Flex Noun
2711 \begin_layout Plain Layout
2712 Document\SpecialChar menuseparator
2719 \begin_inset Flex Noun
2722 \begin_layout Plain Layout
2729 \begin_inset Flex Noun
2732 \begin_layout Plain Layout
2733 Sectioned bibliography
2739 Now you can insert multiple Bib\SpecialChar TeX
2740 bibliographies, one for each section of
2742 Returning to our example: Insert the Bib\SpecialChar TeX
2744 \begin_inset Flex Code
2747 \begin_layout Plain Layout
2753 and a second one for the database
2754 \begin_inset Flex Code
2757 \begin_layout Plain Layout
2764 You are free to use the same or different styles for each section.
2765 Additionally, you can choose if the bibliography section should contain
2767 \begin_inset Quotes eld
2770 all cited references
2771 \begin_inset Quotes erd
2774 of the specified database(s) (which is the default),
2775 \begin_inset Quotes eld
2778 all uncited references
2779 \begin_inset Quotes erd
2783 \begin_inset Quotes eld
2787 \begin_inset Quotes erd
2791 This might be useful if you would like to separate your bibliography into
2793 \begin_inset Quotes eld
2797 \begin_inset Quotes erd
2801 \begin_inset Quotes eld
2805 \begin_inset Quotes erd
2809 \begin_inset Quotes eld
2813 \begin_inset Quotes erd
2817 The titles for the sections can be added as ordinary sections or subsections.
2819 \begin_inset Flex Code
2822 \begin_layout Plain Layout
2828 removes the bibliography title, you have to manually re-add that, too (as
2829 a chapter* or section*, for instance).
2830 \change_inserted -712698321 1485695762
2834 \begin_layout Standard
2836 \change_inserted -712698321 1485696667
2841 , the procedure is a bit different.
2850 , the aforementioned
2851 \begin_inset Flex Noun
2854 \begin_layout Plain Layout
2856 \change_inserted -712698321 1485695841
2857 Sectioned bibliography
2862 option is disabled if you use
2871 provides its own means to generate sectioned bibliographies.
2872 You can either add keywords to bibliography entries via the
2873 \begin_inset Flex Code
2876 \begin_layout Plain Layout
2878 \change_inserted -712698321 1485696318
2886 entry option and then filter bibliography sections by keyword (by adding
2888 \begin_inset Flex Code
2891 \begin_layout Plain Layout
2893 \change_inserted -712698321 1485696306
2902 \begin_inset Flex Noun
2905 \begin_layout Plain Layout
2907 \change_inserted -712698321 1485696431
2915 field of the dialog that opens if you right-click on the
2916 \begin_inset Flex Noun
2919 \begin_layout Plain Layout
2921 \change_inserted -712698321 1485696518
2922 Biblatex Generated Bibliography
2929 button), or you can filter by entry types (such as
2938 \begin_inset space \thinspace{}
2943 \begin_inset Flex Code
2946 \begin_layout Plain Layout
2948 \change_inserted -712698321 1485696628
2955 \begin_inset Flex Code
2958 \begin_layout Plain Layout
2960 \change_inserted -712698321 1485696643
2967 \begin_inset Flex Noun
2970 \begin_layout Plain Layout
2972 \change_inserted -712698321 1485696667
2978 field, or you can create so-called
2979 \begin_inset Quotes eld
2982 Bibliography Categories
2983 \begin_inset Quotes erd
2986 to which you can assign individual entries.
2987 Please refer to the Biblatex manual, section
2989 Subdivided Bibliographies
2996 \begin_layout Subsection
2997 Multiple Bibliographies
3000 \begin_layout Standard
3001 Multiple bibliographies, e.
3002 \begin_inset space \thinspace{}
3006 \begin_inset space \space{}
3009 a bibliography for each section or chapter of the document, are not supported
3010 by Bib\SpecialChar TeX
3013 \begin_inset Flex Code
3016 \begin_layout Plain Layout
3022 package, which is used for the creation of sectioned bibliographies in
3024 (see the previous section), provides an easy way to solve this task, if
3025 you are willing to use some
3026 \begin_inset Flex Noun
3029 \begin_layout Plain Layout
3037 \begin_inset space ~
3041 \begin_inset CommandInset ref
3043 reference "sec:Inserting-TeX-Code"
3051 \begin_layout Plain Layout
3052 An alternative approach is to use the
3053 \begin_inset Flex Code
3056 \begin_layout Plain Layout
3063 \begin_inset Flex Code
3066 \begin_layout Plain Layout
3072 package, respectively.
3080 \begin_layout Standard
3082 \begin_inset Flex Noun
3085 \begin_layout Plain Layout
3086 Document\SpecialChar menuseparator
3093 \begin_inset Flex Noun
3096 \begin_layout Plain Layout
3103 \begin_inset Flex Noun
3106 \begin_layout Plain Layout
3107 Sectioned bibliography
3113 In the document, you have to enclose the sections, which shall contain
3114 their own bibliography (including the Bib\SpecialChar TeX
3115 bibliography itself), between
3117 \begin_inset Flex Code
3120 \begin_layout Plain Layout
3129 \begin_inset Flex Code
3132 \begin_layout Plain Layout
3140 (those commands have to be inserted as \SpecialChar TeX
3142 The bibliography will contain all references that have been cited in the
3144 \begin_inset Flex Code
3147 \begin_layout Plain Layout
3158 If you are using this approach, then every citation reference has to be
3160 \begin_inset Flex Code
3163 \begin_layout Plain Layout
3171 \begin_inset Flex Code
3174 \begin_layout Plain Layout
3181 \change_inserted -712698321 1485696937
3185 \begin_layout Standard
3187 \change_inserted -712698321 1485698355
3192 , the procedure differs, since
3201 Biblatex has its own commands to get multiple bibliographies.
3202 Generally, two different ways are differentiated:
3206 are fully self-enclosed sections containing their own bibliography,
3210 are sections that contain their own bibliography, but maintain a global
3211 numbering scheme (so that if two different
3215 contain references to two different papers by Miller published in 2016,
3216 they will be labeled as
3217 \begin_inset Quotes eld
3221 \begin_inset Quotes erd
3225 \begin_inset Quotes eld
3229 \begin_inset Quotes erd
3232 in an author-year scheme, while with
3236 , they will both be labeled as
3237 \begin_inset Quotes eld
3241 \begin_inset Quotes erd
3244 , as the two sections are considered to be independent).
3247 \begin_layout Standard
3249 \change_inserted -712698321 1485698499
3258 per part, chapter, section or subsection, all you have to do is to enter,
3260 \begin_inset Flex Code
3263 \begin_layout Plain Layout
3265 \change_inserted -712698321 1485697458
3274 \begin_inset Flex Code
3277 \begin_layout Plain Layout
3279 \change_inserted -712698321 1485697463
3288 \begin_inset Flex Code
3291 \begin_layout Plain Layout
3293 \change_inserted -712698321 1485697469
3302 \begin_inset Flex Code
3305 \begin_layout Plain Layout
3307 \change_inserted -712698321 1485697474
3308 refsection=subsection
3316 \begin_inset Flex Code
3319 \begin_layout Plain Layout
3321 \change_inserted -712698321 1485697532
3322 refsegment=\SpecialChar ldots
3335 \begin_inset Flex Noun
3338 \begin_layout Plain Layout
3340 \change_inserted -712698321 1485697573
3341 Document\SpecialChar menuseparator
3342 Settings\SpecialChar menuseparator
3343 Bibliography\SpecialChar menuseparator
3352 If you need specific
3360 , you can start them with the \SpecialChar TeX
3362 \begin_inset Flex Code
3365 \begin_layout Plain Layout
3367 \change_inserted -712698321 1485697716
3378 \begin_inset Flex Code
3381 \begin_layout Plain Layout
3383 \change_inserted -712698321 1485697724
3394 If you also want to control the end of the section\SpecialChar breakableslash
3395 segment, use the environment
3397 \begin_inset Flex Code
3400 \begin_layout Plain Layout
3402 \change_inserted -712698321 1485697769
3412 \begin_inset Flex Code
3415 \begin_layout Plain Layout
3417 \change_inserted -712698321 1485697780
3426 \begin_inset Flex Code
3429 \begin_layout Plain Layout
3431 \change_inserted -712698321 1485697791
3441 \begin_inset Flex Code
3444 \begin_layout Plain Layout
3446 \change_inserted -712698321 1485697797
3457 \begin_layout Standard
3459 \change_inserted -712698321 1485698580
3460 In order to actually output the bibliography of the respective section or
3461 segment, simply insert it at the place where it should appear via
3463 Insert\SpecialChar menuseparator
3468 TOC\SpecialChar menuseparator
3470 \begin_inset space ~
3484 If you want to output all
3493 \begin_inset space \thinspace{}
3496 g., at the end of the document),
3500 provides the commands
3501 \begin_inset Flex Code
3504 \begin_layout Plain Layout
3506 \change_inserted -712698321 1485698571
3517 \begin_inset Flex Code
3520 \begin_layout Plain Layout
3522 \change_inserted -712698321 1485698580
3532 which automatically loop over all sections/segments and output them subsequentl
3534 Currently, these commands need to be entered as \SpecialChar TeX
3535 code in \SpecialChar LyX
3541 manual for more information on this topic.
3546 \begin_layout Section
3550 \begin_layout Subsection
3554 \begin_layout Standard
3555 When you are working on a large file with many sections, it is often convenient
3556 to break up the document into several files, or perhaps you have something
3557 where a table may change from time to time, but the preceding text does
3559 In these cases, you should seriously consider using multipart documents.
3560 For example, scientific papers often have five major sections: the introduction
3561 , observations, results, discussion, and conclusion.
3562 Each of these could be its own separate \SpecialChar LyX
3564 \begin_inset Quotes eld
3568 \begin_inset Quotes erd
3571 file which contains the title, authors, abstract, references, etc., plus
3572 the five included files.
3573 It is important to note that each of these files is a full \SpecialChar LyX
3575 can be formatted and printed on its own, as well as included in a master
3577 Each of these files must have the same document class, however—don't attempt
3578 to mix book classes with article classes.
3579 You may also include \SpecialChar LaTeX
3580 files; however, these files must not have their own
3582 \begin_inset space \thinspace{}
3586 \begin_inset space \space{}
3589 everything up to and including the
3590 \begin_inset Flex Code
3593 \begin_layout Plain Layout
3602 \begin_inset Flex Code
3605 \begin_layout Plain Layout
3613 line must be deleted) or else errors will be generated when you try to
3617 \begin_layout Standard
3619 allows you to include files quite easily with
3620 \begin_inset Flex Noun
3623 \begin_layout Plain Layout
3624 Insert\SpecialChar menuseparator
3626 \begin_inset space ~
3635 When you click on this selection a small box is inserted into the file
3636 at the current cursor location.
3637 Clicking on the box raises a dialog which allows you to select the file
3638 to be included, and the method of its inclusion.
3642 \begin_layout Standard
3643 The file selection box should by now be obvious.
3644 The three inclusion methods are
3645 \begin_inset Quotes eld
3649 \begin_inset Quotes erd
3653 \begin_inset Quotes eld
3657 \begin_inset Quotes erd
3661 \begin_inset Quotes eld
3665 \begin_inset Quotes erd
3669 The difference between
3670 \begin_inset Quotes eld
3674 \begin_inset Quotes erd
3678 \begin_inset Quotes eld
3682 \begin_inset Quotes erd
3685 is really only meaningful to \SpecialChar LaTeX
3686 perts, but the practical difference is that
3688 \begin_inset Quotes eld
3692 \begin_inset Quotes erd
3695 are typeset beginning on a new page, while files that are
3696 \begin_inset Quotes eld
3700 \begin_inset Quotes erd
3703 are typeset starting on the current page.
3706 \begin_layout Standard
3707 Generally, the master file is converted into a full \SpecialChar LaTeX
3708 file before typesetting,
3709 while the included files are converted to \SpecialChar LaTeX
3710 files that do not have all the
3711 preamble information.
3714 \begin_layout Standard
3716 \begin_inset Quotes eld
3720 \begin_inset Quotes erd
3723 included file allows you to include a file typeset exactly as it appears
3725 \begin_inset space \thinspace{}
3729 \begin_inset space \space{}
3733 \begin_inset Flex Code
3736 \begin_layout Plain Layout
3742 mode, with the characters set in a fixed-width typewriter font.
3743 Normally, spaces in this file are invisible, though two consecutive spaces
3744 are conserved, unlike \SpecialChar LyX
3745 's normal treatment of spaces.
3746 However, setting the
3747 \begin_inset Flex Noun
3750 \begin_layout Plain Layout
3752 \begin_inset space ~
3756 \begin_inset space ~
3760 \begin_inset space ~
3768 checkbox typesets a mark to unambiguously define the presence of a space.
3772 \begin_layout Subsection
3773 Cross-References Between Files
3776 \begin_layout Standard
3777 \begin_inset Box Shadowbox
3787 height_special "totalheight"
3792 backgroundcolor "none"
3795 \begin_layout Plain Layout
3796 This section is somewhat out of date.
3797 Need to describe default master documents and how children are opened when
3807 \begin_layout Standard
3808 It is possible to set up cross-references between the different files.
3809 First, open all the files in question: let's call them A and B in a two
3810 file example, where B is included in A.
3811 Let's say you insert a label in A, then want to reference it in B.
3812 Open the cross-reference dialog whilst in document B, and you can select
3814 \begin_inset Quotes eld
3818 \begin_inset Quotes erd
3824 \begin_layout Subsection
3825 Bibliography Lists in all Subdocuments
3828 \begin_layout Standard
3829 \begin_inset Box Frameless
3839 height_special "totalheight"
3844 backgroundcolor "none"
3847 \begin_layout Plain Layout
3848 This section also needs updating.
3849 There is now material about this on the wiki, and it could be copied here.
3857 \begin_layout Standard
3858 Copy the bibliography list with all entries to all subdocuments and transform
3860 This way \SpecialChar LyX
3862 \begin_inset Flex Code
3865 \begin_layout Plain Layout
3871 -files and you can easily insert references without making the bibliography
3875 \begin_layout Standard
3876 As the bibliography list is in a comment, \SpecialChar LaTeX
3877 won't use it and the references
3878 will look like this: [?], instead of like this: [1].
3879 One solution is to use the \SpecialChar LaTeX
3881 \begin_inset Flex Code
3884 \begin_layout Plain Layout
3890 that will only include comments by processing the files separately.
3891 To do this, add in the \SpecialChar LaTeX
3892 preamble of every subdocument the following:
3895 \begin_layout LyX-Code
3901 \begin_layout LyX-Code
3904 includecomment{comment}
3907 \begin_layout Standard
3909 \begin_inset Flex URL
3912 \begin_layout Plain Layout
3914 http://wiki.lyx.org/FAQ/Unsorted#toc31
3922 \begin_layout Section
3927 \begin_layout Standard
3928 Users sometimes need to be able to
3929 \begin_inset Quotes eld
3933 \begin_inset Quotes erd
3937 file together with all the images (and other files) on which it depends,
3938 either for sending to a publisher or for sharing with a co-author.
3940 2.0 includes a Python script (
3941 \begin_inset Flex Code
3944 \begin_layout Plain Layout
3950 ) that automates this process.
3951 To use it, you must have either the
3952 \begin_inset Flex Code
3955 \begin_layout Plain Layout
3962 \begin_inset Flex Code
3965 \begin_layout Plain Layout
3971 python modules installed on your system.
3972 By default, the script prefers the
3973 \begin_inset Flex Code
3976 \begin_layout Plain Layout
3983 \begin_inset Flex Code
3986 \begin_layout Plain Layout
3992 format on Unix-like systems and the
3993 \begin_inset Flex Code
3996 \begin_layout Plain Layout
4005 \begin_layout Standard
4007 's configuration process will set the script up to export a `\SpecialChar LyX
4009 and this format will then be available under
4010 \begin_inset Flex Code
4013 \begin_layout Plain Layout
4014 File\SpecialChar menuseparator
4023 \begin_layout Standard
4024 Independently of the platform, the generation of a particular archive format
4025 can be forced by adding either the
4026 \begin_inset Flex Code
4029 \begin_layout Plain Layout
4036 \begin_inset Flex Code
4039 \begin_layout Plain Layout
4046 \begin_inset Flex Code
4049 \begin_layout Plain Layout
4056 \begin_inset Flex Code
4059 \begin_layout Plain Layout
4065 format) switch to the
4066 \begin_inset Flex Code
4069 \begin_layout Plain Layout
4071 \SpecialChar menuseparator
4079 \begin_inset Flex Code
4082 \begin_layout Plain Layout
4083 Tools\SpecialChar menuseparator
4084 Preferences\SpecialChar menuseparator
4085 File Handling\SpecialChar menuseparator
4092 (Make sure you add the switch after the script name, not before it.)
4095 \begin_layout Section
4096 Fancy Headers and Footers
4099 \begin_layout Standard
4100 The default page layout is rather plain; for an
4101 \begin_inset Flex Code
4104 \begin_layout Plain Layout
4110 document class, all you get is a centered page number at the bottom of
4112 This document uses KOMA-script's book class, so it appears to be a bit
4114 But to really put on a show, you need to set the document page style to
4116 \begin_inset Quotes eld
4120 \begin_inset Quotes erd
4123 , as mentioned in the
4128 This section describes the \SpecialChar LaTeX
4129 code you need to insert in your \SpecialChar LaTeX
4131 order to get the desired effects.
4134 \begin_layout Standard
4135 For more information on fancy headers, see the
4136 \begin_inset Flex Code
4139 \begin_layout Plain Layout
4145 package documentation.
4147 \begin_inset Flex URL
4150 \begin_layout Plain Layout
4152 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4160 \begin_layout Standard
4161 The page header is divided into three fields, not surprisingly labeled
4162 \begin_inset Quotes eld
4166 \begin_inset Quotes erd
4170 \begin_inset Quotes eld
4174 \begin_inset Quotes erd
4178 \begin_inset Quotes eld
4182 \begin_inset Quotes erd
4186 The footer is also divided into these three fields.
4187 The \SpecialChar LaTeX
4188 commands to set these fields in the simplest manner are
4189 \begin_inset Flex Code
4192 \begin_layout Plain Layout
4201 \begin_inset Flex Code
4204 \begin_layout Plain Layout
4213 \begin_inset Flex Code
4216 \begin_layout Plain Layout
4225 \begin_inset Flex Code
4228 \begin_layout Plain Layout
4237 Suppose you wish to put your name in the upper left hand corner of each
4239 Simply insert the following command in the preamble:
4242 \begin_layout Standard
4251 \begin_layout Standard
4252 You will now see your name in the upper left.
4253 If a field has a default entry that you would like to get rid of (often
4254 the page number appears in the central footer) simply include a command
4255 with a blank argument, e.
4256 \begin_inset space \thinspace{}
4262 \begin_layout Standard
4270 \begin_layout Standard
4271 Let's get really fancy: lets put the section number with the word
4272 \begin_inset Quotes eld
4276 \begin_inset Quotes erd
4280 \begin_inset space \thinspace{}
4284 \begin_inset space \space{}
4287 Section 3) in the upper left, the page number (e.
4288 \begin_inset space \thinspace{}
4292 \begin_inset space \space{}
4295 Page 4) in the upper right, your name in the lower left, and the date in
4297 The following commands should now appear in the preamble:
4300 \begin_layout Standard
4310 \begin_layout Standard
4318 \begin_layout Standard
4328 \begin_layout Standard
4337 \begin_layout Standard
4345 \begin_layout Standard
4355 \begin_layout Standard
4357 \begin_inset Flex Code
4360 \begin_layout Plain Layout
4369 \begin_inset Flex Code
4372 \begin_layout Plain Layout
4380 access \SpecialChar LaTeX
4381 's section and page counters, and so print out the current section
4384 \begin_inset Flex Code
4387 \begin_layout Plain Layout
4395 simply prints out today's date.
4398 \begin_layout Standard
4399 The thicknesses of the horizontal rules drawn beneath the header and above
4400 the footer can also be modified.
4401 If you don't want one of the rules, set its thickness to 0.
4402 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4408 \begin_inset Flex Code
4411 \begin_layout Plain Layout
4416 headrulewidth}{0.4pt}
4422 \begin_inset Flex Code
4425 \begin_layout Plain Layout
4430 footrulewidth}{0.4pt}
4435 to set the thicknesses.
4438 \begin_layout Standard
4439 You can switch the header/footer settings on and off for individual pages
4441 \begin_inset Flex Code
4444 \begin_layout Plain Layout
4447 thispagestyle{empty}
4453 \begin_inset Flex Code
4456 \begin_layout Plain Layout
4459 thispagestyle{plain}
4465 \begin_inset Flex Code
4468 \begin_layout Plain Layout
4471 thispagestyle{fancy}
4477 Simply insert them in the text on the page you want changed and mark them
4480 In fact, title pages are marked as plain by default, while following pages
4481 are marked fancy when using the global fancy setting.
4484 \begin_layout Standard
4485 As a final example, it is possible to include an image in the header or
4487 Suppose you want to put a company logo in the upper lefthand corner.
4488 You might try something like
4491 \begin_layout Standard
4500 includegraphics{logo.eps}}}
4503 \begin_layout Standard
4505 (you may need to preface this with
4506 \begin_inset Flex Code
4509 \begin_layout Plain Layout
4513 usepackage{graphics}
4518 if you don't include graphics elsewhere in your document).
4521 \begin_layout Section
4522 Itemize Bullet Selection
4523 \begin_inset CommandInset label
4532 \begin_layout Standard
4538 \begin_layout Subsection
4542 \begin_layout Standard
4544 provides 216 bullet shapes that can be accessed from a simple dialog.
4545 Using this dialog you can easily specify what bullet shape to use at each
4546 level of an itemized list.
4547 These settings are document-wide so you won't be able to specify different
4548 sets of bullets for different paragraphs.
4552 \begin_layout Plain Layout
4553 Well, actually you can but you'll have to do it by hand.
4561 \begin_layout Subsection
4565 \begin_layout Standard
4566 Open the dialog by selecting the
4567 \begin_inset Flex Noun
4570 \begin_layout Plain Layout
4571 Document\SpecialChar menuseparator
4577 menu item and then select the
4578 \begin_inset Flex Noun
4581 \begin_layout Plain Layout
4590 \begin_layout Standard
4591 The dialog provides you with a table of bullet shapes.
4592 A column of buttons on the left of the table provides access to the six
4593 different panels of bullet shapes.
4594 The row of buttons across the top is used to select which bullet depth
4596 A text entry under the table shows the currently selected bullet shape's
4598 equivalent and this can be edited if desired.
4599 If you do modify the text you will also need to specify any needed packages
4600 in the \SpecialChar LaTeX
4604 \begin_layout Standard
4605 The six panels are divided up by the packages they require.
4606 The following table shows the mappings from button name to \SpecialChar LaTeX
4610 \begin_layout Standard
4612 \begin_inset Tabular
4613 <lyxtabular version="3" rows="7" columns="2">
4614 <features tabularvalignment="middle">
4615 <column alignment="center" valignment="top" width="0pt">
4616 <column alignment="center" valignment="top" width="0pt">
4618 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4621 \begin_layout Plain Layout
4636 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4639 \begin_layout Plain Layout
4656 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4659 \begin_layout Plain Layout
4674 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4677 \begin_layout Plain Layout
4686 base \SpecialChar LaTeX
4694 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4697 \begin_layout Plain Layout
4712 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4715 \begin_layout Plain Layout
4732 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4735 \begin_layout Plain Layout
4750 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4753 \begin_layout Plain Layout
4770 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4773 \begin_layout Plain Layout
4788 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4791 \begin_layout Plain Layout
4808 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4811 \begin_layout Plain Layout
4826 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4829 \begin_layout Plain Layout
4846 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4849 \begin_layout Plain Layout
4864 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4867 \begin_layout Plain Layout
4890 \begin_layout Standard
4892 doesn't stop you using bullets from packages you don't have.
4893 If you get errors from \SpecialChar LaTeX
4894 when you try to view or print the file, then it
4895 is likely you are missing a package.
4899 \begin_layout Plain Layout
4901 doesn't restrict your use since you may be editing locally and exporting
4910 \begin_layout Subsection
4914 \begin_layout Standard
4915 Select which bullet depth you want to change then select the bullet shape
4917 Any changes will not be visible in \SpecialChar LyX
4918 , but are visible when viewing the document.
4921 \begin_layout Standard
4922 You can reset a bullet shape to the default simply by clicking your right
4923 mouse button on the appropriate bullet depth button.
4927 \begin_layout Plain Layout
4932 want to have multiple sets of paragraphs with different sets of bullets
4933 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4935 The bullet selection dialog can help though because it provides you with
4936 the \SpecialChar LaTeX
4937 code for a wide range of bullet shapes.
4938 To make your own custom paragraphs you have the following options:
4941 \begin_layout Plain Layout
4945 \begin_layout Plain Layout
4961 \begin_layout Plain Layout
4965 \begin_layout Plain Layout
4987 \begin_layout Itemize
4988 Use the \SpecialChar LaTeX
4990 \begin_inset Flex Code
4993 \begin_layout Plain Layout
5001 to specify a new bullet shape for a given depth.
5002 You'll also need to save the current bullet shape so you can restore it
5004 In this itemized list the following \SpecialChar LaTeX
5005 code was used to change the bullet
5006 used for the first depth.
5010 \begin_layout LyX-Code
5020 \begin_layout LyX-Code
5037 \begin_layout Itemize
5038 Note that the itemize depth is specified in Roman numerals as part of the
5048 \begin_layout Itemize
5052 \begin_layout Plain Layout
5065 Specify each individual entry by starting each item with the bullet shape
5066 enclosed in square brackets and set as
5067 \begin_inset Flex Noun
5070 \begin_layout Plain Layout
5078 For example, this item was started with
5079 \begin_inset Flex Code
5082 \begin_layout Plain Layout
5097 \begin_layout Plain Layout
5101 \begin_layout Plain Layout
5117 \begin_layout Plain Layout
5118 You'll also need to revert the labelitem back to its previous setting for
5119 the global bullet shape settings to remain in effect.
5120 The way used here was:
5123 \begin_layout LyX-Code
5138 \begin_layout Chapter
5140 and the World Wide Web
5143 \begin_layout Standard
5145 has long supported the export of documents to various web-friendly formats,
5147 Before verson 2.0, however, HTML export was always accomplished by the use
5148 of external converters.
5152 \begin_layout Plain Layout
5153 For details on the use of external converters with \SpecialChar LyX
5158 section of the Customization manual.
5163 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5165 intermediate format, such as
5166 \begin_inset Flex Code
5169 \begin_layout Plain Layout
5176 \begin_inset Flex Code
5179 \begin_layout Plain Layout
5186 \begin_inset Flex Code
5189 \begin_layout Plain Layout
5195 , relying upon \SpecialChar LyX
5196 to produce the \SpecialChar LaTeX
5197 ; and there is a converter that works directly
5200 \begin_inset Flex Code
5203 \begin_layout Plain Layout
5211 All of these have different advantages and disadvantages.
5215 \begin_layout Standard
5216 The \SpecialChar LaTeX
5217 -based converters have the advantage that, in principle, they know everythin
5218 g about the exported document that \SpecialChar LaTeX
5220 Such converters do not care, for example, if a certain block of code was
5221 produced by \SpecialChar LyX
5222 or was Evil Red Text.
5223 These converters know about
5224 \begin_inset Flex Code
5227 \begin_layout Plain Layout
5233 files, counters, and references, and can often make use of the
5234 \begin_inset Flex Code
5237 \begin_layout Plain Layout
5243 files generated by Bib\SpecialChar TeX
5245 On the other hand, \SpecialChar LaTeX
5246 is a very hard language to parse—it is sometimes said
5247 that only \SpecialChar TeX
5248 itself understands \SpecialChar TeX
5249 —and \SpecialChar LaTeX
5250 -based converters will often choke on
5251 what seem to be quite simple constructs; complex ones can throw them completely
5252 , and as of this writing, for example, the
5256 manual will not export with
5257 \begin_inset Flex Code
5260 \begin_layout Plain Layout
5266 , though the others will.
5267 The other issue concerns how math is handled.
5268 These converters typically convert the formulae into little pictures that
5269 are then linked from the HTML document.
5270 Since these are actually generated by \SpecialChar LaTeX
5271 , they are accurate.
5272 But they do not scale well, and just getting them to look as if they are
5273 actually meant to be in your document—so that the font sizes seem to be
5274 roughly the same—can be a challenge.
5277 \begin_layout Standard
5279 \begin_inset Flex Code
5282 \begin_layout Plain Layout
5290 \begin_inset CommandInset href
5292 name "http://elyxer.nongnu.org/"
5293 target "http://elyxer.nongnu.org/"
5297 ) solves some of these problems.
5298 In particular, the formulae it produces scale perfectly, since it renders
5299 math using a combination of HTML and CSS rather than converting the formulae
5301 But even moderately complex formula are rendered less well than with
5302 \begin_inset Flex Code
5305 \begin_layout Plain Layout
5311 ; this reflects the limitations of HTML.
5315 \begin_layout Plain Layout
5317 \begin_inset Flex Code
5320 \begin_layout Plain Layout
5327 can also use jsMath and MathJax for equations, but this setting is only
5328 available globally and requires one to have access to a server that runs
5334 More importantly (as of version 1.1.1, at least),
5335 \begin_inset Flex Code
5338 \begin_layout Plain Layout
5345 has limited support for math macros and no support for user-defined paragraph
5346 or character styles.
5347 These limitations make
5348 \begin_inset Flex Code
5351 \begin_layout Plain Layout
5358 unsuitable for many of the documents \SpecialChar LyX
5360 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5362 have decided to follow a different path and have made \SpecialChar LyX
5364 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5365 , DocBook, and plaintext.
5368 \begin_layout Standard
5369 As of this writing, XHTML output remains under development and should probably
5371 \begin_inset Quotes eld
5375 \begin_inset Quotes erd
5382 \begin_layout Plain Layout
5384 \begin_inset Flex Code
5387 \begin_layout Plain Layout
5388 development/HTML.notes
5393 , which can be found in the \SpecialChar LyX
5395 \begin_inset CommandInset href
5397 name "accessed online"
5398 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5402 , usually contains up-to-date information about the state of XHTML output.
5403 See also the list of XHTML bugs on
5404 \begin_inset CommandInset href
5406 name "the bug tracker"
5407 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"
5416 Still, the developers have chosen this approach because it has several
5417 potential advantages over the other two.
5420 \begin_layout Standard
5421 These advantages are primarily due to the fact that the XHTML output routines,
5422 since they are part of \SpecialChar LyX
5423 , know everything \SpecialChar LyX
5424 knows about the document being
5429 \begin_layout Plain Layout
5430 Another advantage is that, since these routines are internal to \SpecialChar LyX
5432 immune to changes in \SpecialChar LyX
5433 's file format, or to changes in the semantics of
5439 So they know about the table of contents (as displayed in the outline),
5440 about the counters associated with different paragraph styles, and about
5441 user-defined styles.
5442 The XHTML output routines know what \SpecialChar LyX
5443 knows about internationalization,
5444 too, so they will output
5445 \begin_inset Quotes eld
5449 \begin_inset Quotes erd
5453 \begin_inset Quotes eld
5461 \begin_inset Quotes erd
5464 , depending upon the language in effect at the time.
5468 \begin_layout Standard
5469 Quite generally, the output routines know what \SpecialChar LyX
5470 knows about document layout,
5471 that is, about how the document is to be rendered on screen.
5472 We use this information when we output the document as XHTML.
5473 In particular, \SpecialChar LyX
5478 generates CSS style information corresponding to the layout information
5479 it uses to render the document on screen: if section headings are supposed
5480 to be sans-serif and bold as seen in \SpecialChar LyX
5481 , then (by default) they will be sans-seri
5482 f and bold when viewed in a web browser, too.
5483 And this is true not just for pre-defined styles, like Section, but for
5484 any style, including user-defined styles.
5485 Indeed, the XHTML output routines make no distinction between user-defined
5486 paragraph and character styles and \SpecialChar LyX
5487 's own pre-defined styles: in each case,
5488 everything \SpecialChar LyX
5489 knows about the styles is contained in the layout files.
5490 And much the same is true as regards pre-defined textual insets, such as
5491 footnotes, and various custom insets.
5495 \begin_layout Standard
5496 The result is that XHTML output can be customized and extended in exactly
5497 the same way \SpecialChar LaTeX
5498 output can be customized and extended: through layout files
5500 See chapter five of the
5504 manual for the details.
5507 \begin_layout Standard
5508 The remainder of this chapter contains more detailed information on XHTML
5509 output, its limitations, and ways to work around those limitations.
5512 \begin_layout Section
5513 Math Output in XHTML
5516 \begin_layout Standard
5518 offers four choices for how math is rendered.
5519 These have various advantages and disadvantages:
5522 \begin_layout Itemize
5524 \begin_inset Newline newline
5527 MathML is a dialect of XML designed specifically for mathematics on the
5528 web, and it typically renders very well in browsers that support it.
5529 The disadvantage is that not all browsers support MathML, and support is
5530 not complete even in the Gecko-based browsers, such as Firefox.
5531 \begin_inset Newline newline
5535 is unable to render a formula as MathML—for example, if the formula
5537 \begin_inset Flex Code
5540 \begin_layout Plain Layout
5546 package or ERT—then it will instead output the formula as an image.
5550 \begin_layout Itemize
5552 \begin_inset Newline newline
5556 \begin_inset Flex Code
5559 \begin_layout Plain Layout
5565 outputs math as HTML, styled by CSS.
5569 \begin_layout Plain Layout
5571 has borrowed some of the CSS for its HTML output from
5572 \begin_inset Flex Code
5575 \begin_layout Plain Layout
5586 For simple formulae, this can work quite well, though with more complicated
5587 formulae it tends to break down.
5588 Still, this method has the advantage that it is very widely supported and
5589 so it may be appropriate for documents that contain only a little, fairly
5591 \begin_inset Newline newline
5594 If Lyx is unable to render a formula as HTML—for example, if the formula
5596 \begin_inset Flex Code
5599 \begin_layout Plain Layout
5605 package or ERT—then it will instead output the formula as an image.
5609 \begin_layout Itemize
5611 \begin_inset Newline newline
5615 \begin_inset Flex Code
5618 \begin_layout Plain Layout
5625 will output formulae as images, the very same images, in fact, that are
5626 used for instant preview.
5630 \begin_layout Plain Layout
5631 Instant preview does
5635 have to be on for images to be output, however.
5640 The advantage to this method is that the images are simply generated by
5642 , so they are very accurate.
5643 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5644 so they do not scale terribly well, and one cannot copy them, etc.
5645 (As of this writing, there are also problems about equation numbering.
5647 \begin_inset CommandInset href
5650 target "http://www.lyx.org/trac/ticket/6894"
5655 \begin_inset Newline newline
5658 The size of the images can be controlled by setting the
5659 \begin_inset Quotes eld
5663 \begin_inset Quotes erd
5667 \begin_inset Flex Noun
5670 \begin_layout Plain Layout
5671 Document\SpecialChar menuseparator
5672 Settings\SpecialChar menuseparator
5682 \begin_layout Plain Layout
5683 For those who want to know, this controls the resolution of the image in
5684 dots per inch and is based upon a default of 75 dpi.
5690 \begin_inset Newline newline
5694 for some reason fails to create an image for a formula (e.g., if a required
5696 package is not installed), then it will fall back to outputing the raw
5701 \begin_layout Itemize
5704 \begin_inset Newline newline
5707 Finally, \SpecialChar LyX
5708 will happily output math as \SpecialChar LaTeX
5710 As well as being the output of last resort, this method can be used with
5712 \begin_inset CommandInset href
5715 target "http://www.math.union.edu/~dpvc/jsMath/"
5719 , which uses JavaScript to render \SpecialChar LaTeX
5720 embedded in HTML documents.
5722 wraps the \SpecialChar LaTeX
5724 \begin_inset Flex Code
5727 \begin_layout Plain Layout
5733 (for inline formulas) or
5734 \begin_inset Flex Code
5737 \begin_layout Plain Layout
5743 (for displayed formulas) with
5744 \begin_inset Flex Code
5747 \begin_layout Plain Layout
5753 , as is required for jsMath.
5756 \begin_layout Standard
5757 One of these output methods must be selected under
5758 \begin_inset Flex Noun
5761 \begin_layout Plain Layout
5762 Document\SpecialChar menuseparator
5763 Settings\SpecialChar menuseparator
5770 By default, \SpecialChar LyX
5772 This is a document-wide setting, therefore.
5775 \begin_layout Standard
5776 Eventually, \SpecialChar LyX
5777 will offer the user the option to select an alternate output
5778 method for a particular inset, say, one that isn't being rendered very
5783 \begin_layout Plain Layout
5784 That said, since \SpecialChar LyX
5785 falls back to images if the inset contains ERT, then one
5786 can force output as an image by putting some harmless ERT into the math,
5788 \begin_inset Formula $a=b\relax$
5799 \begin_layout Section
5800 Bibliography and Citations
5803 \begin_layout Standard
5804 XHTML output fully supports bibliographies and citations.
5808 \begin_layout Standard
5809 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5811 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5814 If you are using numerical citations, then \SpecialChar LyX
5815 will output numerical labels,
5816 such as [1] or [17], rather than simply showing the citation key in square
5817 brackets, as it does on-screen.
5818 If you are using author-year citations, then \SpecialChar LyX
5819 will add lowercase letters
5820 to the years, just as Bib\SpecialChar TeX
5821 does, if it finds more than one citation for
5822 a given author-year combination.
5823 The labels will be printed with the bibliography entries.
5824 Note that there is, at present, no way to customize the appearance of the
5825 labels, for example, to choose between square brackets and parentheses.
5828 \begin_layout Standard
5829 Bibliography output is handled by the same machinery that handles the presentati
5830 on of reference information in the citation dialog, so you will see in the
5831 XHTML output pretty much what you would see if you were to look at a given
5832 entry in the citation dialog.
5833 The formatting can be customized in your layout file or, preferably, in
5839 manual for the details.
5842 \begin_layout Standard
5843 The main defect at present is that cross-referenced information is printed
5844 with every entry with which it is associated.
5845 So you can see things like this:
5850 \begin_inset Quotes eld
5853 Context and Logical Form
5854 \begin_inset Quotes erd
5859 Language in Context: Selected Essays
5861 (Oxford: Oxford University Press, 2007), pp.
5867 \begin_inset Quotes eld
5870 Semantics in Context
5871 \begin_inset Quotes erd
5876 Language in Context: Selected Essays
5878 (Oxford: Oxford University Press, 2007), pp.
5882 \begin_layout Standard
5883 This should be fixed before long.
5886 \begin_layout Standard
5887 There is no support at present for sectioned bibliographies.
5888 If you have multiple bibliographies, then \SpecialChar LyX
5889 will print the same bibliography
5893 \begin_layout Section
5897 \begin_layout Standard
5899 will happily export indexes as XHTML, but with certain limitations at the
5903 \begin_layout Standard
5904 Index export will be most reliable when you do not attempt to use the fancy
5905 constructs that are described in the section on indexes in the
5913 \begin_layout Plain Layout
5914 The main issue here is that \SpecialChar LyX
5915 itself does not really handle these.
5916 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5922 We'll describe how they are handled using the subsection headings from
5926 \begin_layout Itemize
5927 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5928 makes an effort to support these,
5929 but the entries must be separated by
5930 \begin_inset Quotes eld
5934 \begin_inset Quotes erd
5937 , that is, there must be spaces around the exclamation point.
5938 This is because it is otherwise too difficult to check for escaped exclamation
5939 points, ones in math, and so forth.
5942 \begin_layout Itemize
5943 Page Ranges: There is no support at all for page ranges, since these make
5944 no sense with XHMTL.
5945 Instead, you will just get two index entries, one at either end.
5948 \begin_layout Itemize
5949 Cross-referencing: There is no support for cross-referencing.
5951 finds an entry containing the
5952 \begin_inset Quotes eld
5955 |see\SpecialChar ldots
5957 \begin_inset Quotes erd
5960 construct, it is just dropped, and the rest is treated as an ordinary index
5964 \begin_layout Itemize
5965 Index Entry Order: \SpecialChar LyX
5966 does support attempts to fix the sorting order.
5967 It will take what is before the first `@' it finds and use that for sorting,
5968 taking what follows the first `@' to be the actual entry.
5969 At present, \SpecialChar LyX
5970 does not check for escaped `@', so do not try to index email
5974 \begin_layout Itemize
5975 Index Entry Layout: You can format entries by using the text style dialog,
5976 or by using any other method available within \SpecialChar LyX
5978 There is no support for constructs like:
5979 \begin_inset Quotes eld
5983 \begin_inset Quotes erd
5987 Indeed, if \SpecialChar LyX
5988 finds a pipe symbol, `|', in an entry, it will delete it and
5989 everything that follows it.
5992 \begin_layout Itemize
5993 Multiple Indexes: There is no support for multiple indexes.
5994 Rather, all index entries will be printed as one large index.
5995 To avoid our printing several versions of the index, we print only the
5996 main index, so make sure you have one.
5999 \begin_layout Section
6000 Nomenclature and Glossary
6003 \begin_layout Standard
6004 There is at present no support for glossaries.
6005 Adding it would be fairly trivial, and welcome.
6008 \begin_layout Chapter
6009 The \SpecialChar LyX
6013 \begin_layout Section
6017 \begin_layout Standard
6018 The `\SpecialChar LyX
6019 server' allows other programs to talk to \SpecialChar LyX
6020 , invoke \SpecialChar LyX
6021 commands, and retrieve
6022 information about the \SpecialChar LyX
6024 This is only intended for advanced users, but they should find it useful.
6025 It is by writing to the \SpecialChar LyX
6026 server, for example, that bibliography managers,
6027 such as JabRef, are able to
6028 \begin_inset Quotes eld
6032 \begin_inset Quotes erd
6035 citations to \SpecialChar LyX
6039 \begin_layout Section
6040 Starting the \SpecialChar LyX
6044 \begin_layout Standard
6045 The \SpecialChar LyX
6046 server works through the use of a pair of named pipes.
6047 These are usually located in
6048 \begin_inset Flex Code
6051 \begin_layout Plain Layout
6057 , (except on Windows, where
6061 named pipes are special objects located in
6062 \begin_inset Flex Code
6065 \begin_layout Plain Layout
6077 ) and have the names
6078 \begin_inset Quotes eld
6082 \begin_inset Flex Code
6085 \begin_layout Plain Layout
6092 \begin_inset Quotes erd
6096 \begin_inset Quotes eld
6100 \begin_inset Flex Code
6103 \begin_layout Plain Layout
6110 \begin_inset Quotes erd
6114 External programs write into
6115 \begin_inset Flex Code
6118 \begin_layout Plain Layout
6124 and read back data from
6125 \begin_inset Flex Code
6128 \begin_layout Plain Layout
6135 The stem of the pipe names can be defined in the
6136 \begin_inset Flex Noun
6139 \begin_layout Plain Layout
6140 Tools\SpecialChar menuseparator
6147 \begin_inset Flex Code
6150 \begin_layout Plain Layout
6151 "/home/myhome/lyxpipe"
6157 \begin_inset Flex Code
6160 \begin_layout Plain Layout
6174 on Windows (where any working path instead of lyxpipe can be used, for
6176 \begin_inset Flex Code
6179 \begin_layout Plain Layout
6202 configure this manually in order for the server to start.
6205 \begin_layout Standard
6208 \begin_inset Flex Code
6211 \begin_layout Plain Layout
6218 \begin_inset Flex Code
6221 \begin_layout Plain Layout
6227 ' to create the pipes.
6228 If one of the pipes already exists, \SpecialChar LyX
6229 will assume that another \SpecialChar LyX
6231 is already running and will not start the server.
6232 On POSIX (Unix like) systems, if for some other reason, an unused
6233 \begin_inset Quotes eld
6237 \begin_inset Quotes erd
6240 pipe is left in existence when \SpecialChar LyX
6241 closes, then \SpecialChar LyX
6242 will try to delete it.
6243 If this fails for some reason, you will need to delete the pipes manually
6244 and then restart \SpecialChar LyX
6246 On Windows, pipes are deleted by the OS on program termination or crash,
6248 \begin_inset Quotes eld
6252 \begin_inset Quotes erd
6255 pipes should not be possible.
6258 \begin_layout Standard
6259 To have several \SpecialChar LyX
6260 processes with servers at the same time, you have to use
6261 different configurations, perhaps by using separate user directories, each
6263 \begin_inset Flex Code
6266 \begin_layout Plain Layout
6272 file, for each process.
6275 \begin_layout Standard
6276 If you are developing a client program, you might find it useful to enable
6277 debugging information from the \SpecialChar LyX
6279 Do this by starting \SpecialChar LyX
6281 \begin_inset Flex Code
6284 \begin_layout Plain Layout
6293 \begin_layout Standard
6294 You can find a complete example client written in C++ in the source distribution
6296 \begin_inset Flex Code
6299 \begin_layout Plain Layout
6300 development/lyxserver/server_monitor.cpp
6308 \begin_layout Standard
6309 Another useful tool is the command-line based client found in
6310 \begin_inset Flex Code
6313 \begin_layout Plain Layout
6314 src/client/lyxclient
6322 \begin_layout Section
6323 Normal communication
6326 \begin_layout Standard
6327 To issue a \SpecialChar LyX
6328 call, the client writes a line of ASCII text into the input
6330 This line has the following format:
6347 \begin_layout Description
6348 clientname is a name that the client can choose arbitrarily.
6349 Its only use is that \SpecialChar LyX
6350 will echo it if it sends an answer—so a client can
6351 dispatch results from different requesters.
6354 \begin_layout Description
6355 function is the function you want \SpecialChar LyX
6357 It is the same as the commands you'd use in the minibuffer.
6360 \begin_layout Description
6361 argument is an optional argument which is meaningful only to some functions
6363 \begin_inset Quotes eld
6367 \begin_inset Quotes erd
6370 LFUN will insert the argument as text at the cursor position).
6373 \begin_layout Standard
6374 The answer from \SpecialChar LyX
6375 will arrive in the output pipe and be of the form
6392 \begin_layout Standard
6401 are just echoed from the command request, while
6405 is more or less useful information filled according to how the command
6406 execution worked out.
6407 Some commands, such as
6408 \begin_inset Quotes eld
6412 \begin_inset Quotes erd
6415 , will return information about the internal state of \SpecialChar LyX
6417 return an empty data-response.
6418 This means that the command execution went fine.
6421 \begin_layout Standard
6422 In case of errors, the response from \SpecialChar LyX
6440 \begin_layout Standard
6445 should contain an explanation of why the command failed.
6448 \begin_layout Standard
6452 \begin_layout LyX-Code
6453 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6454 \begin_inset Newline newline
6457 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6458 \begin_inset Newline newline
6461 read a <~/.lyxpipe.out
6462 \begin_inset Newline newline
6468 \begin_layout Subsection
6469 AppleScript (Mac OS X)
6472 \begin_layout Standard
6473 Since \SpecialChar LyX
6474 2.1, \SpecialChar LyX
6475 supports basic interactions with AppleScript for normal communicatio
6476 n through the command run.
6477 This command takes a direct argument (the
6481 to perform) and an optional argument.
6482 It either returns the output of the function or triggers an error with
6483 the error message and code.
6486 \begin_layout Standard
6490 \begin_layout LyX-Code
6491 tell application "\SpecialChar LyX
6495 \begin_layout LyX-Code
6499 \begin_layout LyX-Code
6500 -- Stores the current file name into f
6503 \begin_layout LyX-Code
6504 set f to (run "server-get-filename" with argument "")
6507 \begin_layout LyX-Code
6508 on error the error_message number the error_number
6511 \begin_layout LyX-Code
6512 display dialog "Error: " & the error_number & ".
6516 \begin_layout LyX-Code
6517 & the error_message buttons {"OK"} default button 1
6520 \begin_layout LyX-Code
6524 \begin_layout LyX-Code
6528 \begin_layout Section
6532 \begin_layout Standard
6534 can notify clients of events going on asynchronously.
6535 Currently it will only do this if the user binds a key sequence with the
6537 \begin_inset Quotes eld
6541 \begin_inset Quotes erd
6545 The format of the string \SpecialChar LyX
6546 sends is as follows:
6550 \begin_inset Flex Code
6553 \begin_layout Plain Layout
6564 \begin_layout Standard
6569 is the printed representation of the key sequence that was actually typed
6573 \begin_layout Standard
6574 This mechanism can be used to extend \SpecialChar LyX
6575 's command set and implement macros.
6576 Bind some key sequence to
6577 \begin_inset Quotes eld
6581 \begin_inset Quotes erd
6585 Then start a client that listens on the output pipe, dispatches the command
6586 according to the sequence, and starts a function that may use \SpecialChar LyX
6589 requests to issue a command or a series of commands to \SpecialChar LyX
6593 \begin_layout Section
6594 The simple \SpecialChar LyX
6598 \begin_layout Standard
6600 implements a simple protocol that can be used for session management.
6601 All messages are of the form
6614 \begin_layout Standard
6620 \begin_inset Quotes eld
6624 \begin_inset Quotes erd
6628 \begin_inset Quotes eld
6632 \begin_inset Quotes erd
6637 \begin_inset Quotes eld
6641 \begin_inset Quotes erd
6644 is received from a client, \SpecialChar LyX
6645 will report back to inform the client that
6646 it's listening to it's messages, while
6647 \begin_inset Quotes eld
6651 \begin_inset Quotes erd
6654 sent from \SpecialChar LyX
6655 will inform clients that \SpecialChar LyX
6659 \begin_layout Section
6660 Reverse DVI/PDF search
6663 \begin_layout Standard
6664 Some DVI/PDF viewers
6668 \begin_layout Plain Layout
6669 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6670 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6679 facility (also called
6684 This means that you can tell \SpecialChar LyX
6685 to put the cursor to a specific line in the
6686 document by clicking at the respective position in the DVI/PDF output.
6687 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6689 This is done via the \SpecialChar LyX
6690 server either by using the named pipe (
6694 ), or the UNIX domain socket (
6698 ) that \SpecialChar LyX
6699 creates in its temporary directory (this is the way the
6700 \begin_inset Flex Code
6703 \begin_layout Plain Layout
6709 program communicates with \SpecialChar LyX
6711 In some cases, you need a helper script that mediates between the viewer
6712 and \SpecialChar LyX
6713 , in others, the viewer can communicate with \SpecialChar LyX
6715 This depends on the selected viewer and on your operating system.
6716 The same applies to the way viewers need to be configured and the way the
6717 reverse search is actually performed.
6718 In what follows, we will thus describe how to setup reverse search for
6720 Before we turn to this, though, we will explain what needs to be done generally
6721 to enable reverse search in the DVI/PDF output.
6724 \begin_layout Subsection
6726 \begin_inset CommandInset label
6728 name "subsec:rev-search"
6735 \begin_layout Standard
6736 In most cases \SpecialChar LyX
6737 will do the work for you by enabling the option
6738 \begin_inset Flex Noun
6741 \begin_layout Plain Layout
6742 Synchronize with Output
6748 \begin_inset Flex Noun
6751 \begin_layout Plain Layout
6752 Document\SpecialChar menuseparator
6753 Settings\SpecialChar menuseparator
6760 In such a case \SpecialChar LyX
6761 will automatically insert the necessary Sync\SpecialChar TeX
6763 PDF) or load the srcltx package (for DVI) respectively.
6764 This option can be easily reached also on
6765 \begin_inset Flex Code
6768 \begin_layout Plain Layout
6777 \begin_layout Standard
6778 If you need a different setting, you can select or input a custom macro
6779 from the drop down box just below
6780 \begin_inset Flex Noun
6783 \begin_layout Plain Layout
6784 Document\SpecialChar menuseparator
6785 Settings\SpecialChar menuseparator
6786 Output\SpecialChar menuseparator
6787 Synchronize with Output
6795 \begin_layout Standard
6796 Note that the method
6797 \begin_inset Flex Code
6800 \begin_layout Plain Layout
6808 enables gzip compression.
6809 If your viewer does not support it, you should instead use
6810 \begin_inset Flex Code
6813 \begin_layout Plain Layout
6824 \begin_layout Standard
6825 Please also note that including the
6826 \begin_inset Flex Code
6829 \begin_layout Plain Layout
6836 \begin_inset Flex Code
6839 \begin_layout Plain Layout
6845 sometimes has an undesired impact on the typesetting.
6846 Thus, you should switch output synchronization off for the final typesetting
6848 \begin_inset Flex Code
6851 \begin_layout Plain Layout
6858 \begin_inset Flex Code
6861 \begin_layout Plain Layout
6871 \begin_layout Standard
6872 In case you need some more special settings that are not covered by the
6873 automatic settings, read the next section about how to set up output synchroniz
6875 If the automatic setup suits your needs, you can readily jump to section
6876 \begin_inset space ~
6880 \begin_inset CommandInset ref
6882 reference "subsec:configuring-viewers"
6886 , where the necessary configuration steps in your viewer – needed both with
6887 the automatic and the manual setup – are described.
6890 \begin_layout Subsection
6894 \begin_layout Standard
6896 provides several different methods for reverse search.
6897 Some are built-in in the
6898 \begin_inset Flex Code
6901 \begin_layout Plain Layout
6907 program, some are provided by external packages.
6908 Your choice depends on whether your \SpecialChar LaTeX
6909 distribution already provides a given
6910 method (the built-in methods are rather new) and whether your viewer can
6912 The available methods are described in the following.
6915 \begin_layout Subsubsection*
6916 Built-in DVI-search via src-specials (DVI only)
6919 \begin_layout Standard
6920 This method provides the DVI file with the necessary information for reverse
6922 It is available in \SpecialChar LaTeX
6923 since quite some time (any somewhat recent \SpecialChar LaTeX
6925 should include it), and it works reliably.
6926 To enable it, change the
6927 \begin_inset Flex Noun
6930 \begin_layout Plain Layout
6941 \begin_inset Flex Noun
6944 \begin_layout Plain Layout
6955 \begin_inset Flex Noun
6958 \begin_layout Plain Layout
6959 Preferences\SpecialChar menuseparator
6960 File Handling\SpecialChar menuseparator
6967 \begin_inset Flex Code
6970 \begin_layout Plain Layout
6971 latex -src-specials $$i
6977 If this doesn't work, check if your \SpecialChar TeX
6978 engine needs different options (the
6979 syntax might differ in some distributions).
6982 \begin_layout Subsubsection*
6983 External Packages (PDFSync and scrltx)
6986 \begin_layout Standard
6995 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6997 In order to enable it, load the packages in the \SpecialChar LyX
7001 \begin_layout Itemize
7002 \begin_inset Flex Code
7005 \begin_layout Plain Layout
7013 for reverse PDF search,
7016 \begin_layout Itemize
7017 \begin_inset Flex Code
7020 \begin_layout Plain Layout
7023 usepackage[active]{srcltx}
7028 for reverse DVI search.
7031 \begin_layout Standard
7032 If you want to be able to perform both DVI and PDF reverse searches, you
7033 can also insert in the preamble the following lines
7036 \begin_layout LyX-Code
7040 \begin_inset Newline newline
7046 \begin_inset Newline newline
7052 \begin_inset Newline newline
7058 \begin_inset Newline newline
7063 usepackage[active]{srcltx}
7064 \begin_inset Newline newline
7072 \begin_layout Standard
7073 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7074 right package will be used.
7077 \begin_layout Standard
7078 Note that PDFSync might affect the output layout of your document.
7079 It is therefore advised to disable PDFsync for final documents.
7082 \begin_layout Subsubsection*
7083 Built-in reverse search via Sync\SpecialChar TeX
7087 \begin_layout Standard
7089 \begin_inset Flex Code
7092 \begin_layout Plain Layout
7098 have built-in support for both PDF and DVI reverse search.
7101 Sync\SpecialChar TeX
7104 facility is basically the result of the integration of the PDFSync package
7105 to the pdftex program and its merge with the
7110 You need at least \SpecialChar TeX
7111 Live 2008 or a recent Mik\SpecialChar TeX
7112 distribution in order to use
7117 \begin_layout Plain Layout
7118 For some reason, Mik\SpecialChar TeX
7119 does not understand/obey the command \SpecialChar LyX
7121 the preamble when you check the "Enable Forward/Reverse Search" button
7122 in the toolbar and does not generate the necessary info.
7125 \begin_layout Plain Layout
7126 The generation of the required info can be forced by changing the converter
7128 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7129 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7130 the -synctex=1 switch).
7135 Also note that only a few PDF viewers (Okular and Qpdfview on Unix, Skim
7136 on the Mac, SumatraPDF on Windows) already provide Sync\SpecialChar TeX
7140 \begin_layout Standard
7141 To enable Sync\SpecialChar TeX
7142 for DVI output, change the
7143 \begin_inset Flex Noun
7146 \begin_layout Plain Layout
7157 \begin_inset Flex Noun
7160 \begin_layout Plain Layout
7171 \begin_inset Flex Noun
7174 \begin_layout Plain Layout
7175 Preferences\SpecialChar menuseparator
7176 File Handling\SpecialChar menuseparator
7183 \begin_inset Flex Code
7186 \begin_layout Plain Layout
7187 latex -synctex=1 $$i
7192 , and for PDF output, change the
7193 \begin_inset Flex Noun
7196 \begin_layout Plain Layout
7201 (pdflatex) -> PDF (pdflatex)
7207 \begin_inset Flex Code
7210 \begin_layout Plain Layout
7211 pdflatex -synctex=1 $$i
7217 Check the documentation of your viewer whether the viewer needs to be configure
7218 d for the use with Sync\SpecialChar TeX
7223 \begin_layout Plain Layout
7224 Note that the option
7225 \begin_inset Flex Code
7228 \begin_layout Plain Layout
7234 option enables gzip compression.
7235 If your viewer does not support it, you should instead use
7236 \begin_inset Flex Code
7239 \begin_layout Plain Layout
7253 \begin_layout Subsection
7254 Configuring and using specific viewers
7255 \begin_inset CommandInset label
7257 name "subsec:configuring-viewers"
7264 \begin_layout Subsubsection*
7265 Xdvi (all platforms)
7268 \begin_layout Standard
7270 \begin_inset Flex Code
7273 \begin_layout Plain Layout
7279 , you don't need to do anything else for performing a reverse DVI search,
7281 already provides the necessary hooks for automatically using the
7282 \begin_inset Flex Code
7285 \begin_layout Plain Layout
7292 Just setup your document as described above (reverse search is triggered
7293 by Ctrl-click or Alt-click on Mac OSX, respectively).
7296 \begin_layout Standard
7297 However, if for whatever reason you want to use the named pipe instead of
7298 the socket for communicating with \SpecialChar LyX
7299 , simply change the DVI viewer in
7300 \begin_inset Flex Noun
7303 \begin_layout Plain Layout
7304 Preferences\SpecialChar menuseparator
7305 File Handling\SpecialChar menuseparator
7315 \begin_layout Plain Layout
7316 On Mac OSX you have to use
7317 \begin_inset Flex Code
7320 \begin_layout Plain Layout
7321 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7332 \begin_inset Flex Code
7335 \begin_layout Plain Layout
7336 xdvi -editor "lyxeditor.sh %f %l"
7342 \begin_inset Flex Code
7345 \begin_layout Plain Layout
7351 is a suitable script.
7352 For example, a minimal shell script is the following one:
7355 \begin_layout LyX-Code
7357 \begin_inset Newline newline
7360 LYXPIPE="/path/to/lyxpipe"
7361 \begin_inset Newline newline
7364 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7365 \begin_inset Newline newline
7368 echo "$COMMAND" > "${LYXPIPE}".in || exit
7369 \begin_inset Newline newline
7372 read TMP < "${LYXPIPE}".out || exit
7375 \begin_layout Standard
7377 \begin_inset Flex Code
7380 \begin_layout Plain Layout
7386 is the LyXServer pipe path specified in
7387 \begin_inset Flex Noun
7390 \begin_layout Plain Layout
7391 Preferences\SpecialChar menuseparator
7401 \begin_layout Plain Layout
7403 \begin_inset Flex Code
7406 \begin_layout Plain Layout
7412 folder of a source distribution you can find a
7413 \begin_inset Flex Code
7416 \begin_layout Plain Layout
7422 script which is able to locate the
7426 based on your preferences.
7434 \begin_layout Subsubsection*
7438 \begin_layout Standard
7440 \begin_inset Flex Code
7443 \begin_layout Plain Layout
7444 /Applications/MacDviX_Folder/calleditor.script
7449 , add the following lines:
7452 \begin_layout LyX-Code
7453 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7454 \begin_inset Newline newline
7460 \begin_layout Standard
7461 Modify the lines accordingly if you install \SpecialChar LyX
7462 somewhere else than in the
7463 Applications folder.
7466 \begin_layout Standard
7467 Reverse search is triggered by Alt-click (OPTION-click).
7470 \begin_layout Subsubsection*
7474 \begin_layout Standard
7476 \begin_inset Flex Code
7479 \begin_layout Plain Layout
7480 open -a Skim.app $$i
7485 to the viewer setting in
7486 \begin_inset Flex Noun
7489 \begin_layout Plain Layout
7490 Preferences\SpecialChar menuseparator
7491 File Handling\SpecialChar menuseparator
7492 File formats\SpecialChar menuseparator
7499 \begin_inset Flex Noun
7502 \begin_layout Plain Layout
7503 Skim\SpecialChar menuseparator
7504 Preferences\SpecialChar menuseparator
7511 \begin_inset Flex Noun
7514 \begin_layout Plain Layout
7520 preset and enter command
7521 \begin_inset Flex Noun
7524 \begin_layout Plain Layout
7525 /Applications/\SpecialChar LyX
7526 .app/Contents/MacOS/lyxeditor
7534 \begin_layout Standard
7535 Reverse search is triggered by COMMAND-SHIFT-click
7538 \begin_layout Subsubsection*
7542 \begin_layout Standard
7544 \begin_inset Flex Noun
7547 \begin_layout Plain Layout
7548 Settings\SpecialChar menuseparator
7549 Configure Okular\SpecialChar menuseparator
7556 \begin_inset Quotes eld
7560 \begin_inset Quotes erd
7564 \begin_inset Flex Code
7567 \begin_layout Plain Layout
7576 \begin_layout Standard
7577 Reverse search is triggered by SHIFT-click.
7580 \begin_layout Subsubsection*
7584 \begin_layout Standard
7585 Qpdfview supports Sync\SpecialChar TeX
7586 since version 0.3.5.
7588 \begin_inset Flex Noun
7591 \begin_layout Plain Layout
7592 Edit\SpecialChar menuseparator
7593 Settings\SpecialChar menuseparator
7599 , click on the input field of the
7600 \begin_inset Quotes eld
7604 \begin_inset Quotes erd
7607 item and add the command
7608 \begin_inset Flex Code
7611 \begin_layout Plain Layout
7620 \begin_layout Standard
7621 Reverse search is triggered by double-click or, in more recent versions,
7625 \begin_layout Subsubsection*
7629 \begin_layout Standard
7630 Launch yap, choose its
7631 \begin_inset Flex Noun
7634 \begin_layout Plain Layout
7635 View\SpecialChar menuseparator
7642 \begin_inset Quotes eld
7646 \begin_inset Quotes erd
7651 \begin_inset Quotes eld
7654 New\SpecialChar ldots
7656 \begin_inset Quotes erd
7659 button and, in the window that opens, enter
7660 \begin_inset Quotes eld
7665 \begin_inset Quotes erd
7668 (or any other name you like) in the
7669 \begin_inset Quotes eld
7673 \begin_inset Quotes erd
7677 Now click on the button labeled
7678 \begin_inset Quotes eld
7683 \begin_inset Quotes erd
7686 to open a file dialog and navigate to the directory containing the batch
7688 \begin_inset Flex Code
7691 \begin_layout Plain Layout
7699 \begin_inset Flex Code
7702 \begin_layout Plain Layout
7708 and then specify the program arguments as
7709 \begin_inset Flex Code
7712 \begin_layout Plain Layout
7720 \begin_inset Flex Code
7723 \begin_layout Plain Layout
7729 wrapper is used for communicating with \SpecialChar LyX
7737 \begin_layout LyX-Code
7739 \begin_inset Newline newline
7742 echo LYXCMD:revdvi:server-goto-file-row:%1 %2>
7751 \begin_inset Newline newline
7765 \begin_layout Standard
7766 Make sure that the \SpecialChar LyX
7767 Server pipe path you specified in \SpecialChar LyX
7769 \begin_inset Flex Code
7772 \begin_layout Plain Layout
7786 , otherwise change the
7787 \begin_inset Flex Code
7790 \begin_layout Plain Layout
7796 wrapper accordingly.
7799 \begin_layout Standard
7800 In yap, reverse search is triggered by double-click.
7803 \begin_layout Subsubsection*
7804 SumatraPDF (Windows)
7807 \begin_layout Standard
7808 In order to use SumatraPDF for inverse search, enter
7809 \begin_inset Flex Code
7812 \begin_layout Plain Layout
7813 SumatraPDF -inverse-search "lyxeditor.bat %f %l"
7818 in the viewer setting in
7819 \begin_inset Flex Noun
7822 \begin_layout Plain Layout
7823 Preferences\SpecialChar menuseparator
7824 File Handling\SpecialChar menuseparator
7825 File formats\SpecialChar menuseparator
7832 \begin_inset Flex Code
7835 \begin_layout Plain Layout
7841 is the previous wrapper.
7842 If SumatraPDF.exe is not in your command PATH, use its full file name.
7845 \begin_layout Standard
7846 Reverse search is triggered by double-click.
7849 \begin_layout Subsubsection*
7853 \begin_layout Standard
7854 First of all, make sure that yap is your default DVI viewer in the Windows
7855 environment, then launch it, choose its
7856 \begin_inset Flex Noun
7859 \begin_layout Plain Layout
7860 View\SpecialChar menuseparator
7867 \begin_inset Quotes eld
7871 \begin_inset Quotes erd
7876 \begin_inset Quotes eld
7879 New\SpecialChar ldots
7881 \begin_inset Quotes erd
7884 button and, in the window that opens, enter
7885 \begin_inset Quotes eld
7890 \begin_inset Quotes erd
7893 (or any other name you like) in the
7894 \begin_inset Quotes eld
7898 \begin_inset Quotes erd
7902 Now click on the button labeled
7903 \begin_inset Quotes eld
7908 \begin_inset Quotes erd
7911 to open a file dialog and navigate to the directory containing the
7912 \begin_inset Flex Code
7915 \begin_layout Plain Layout
7921 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7924 \begin_inset Flex Code
7927 \begin_layout Plain Layout
7933 and then specify the program arguments as
7934 \begin_inset Flex Code
7937 \begin_layout Plain Layout
7944 In this way, you will be using the
7948 for communicating with \SpecialChar LyX
7950 If, for whatever reason, you want to use the
7955 \begin_inset Flex Code
7958 \begin_layout Plain Layout
7964 option and be sure to specify the \SpecialChar LyX
7965 Server pipe path in the \SpecialChar LyX
7969 \begin_layout Standard
7970 In yap, reverse search is triggered by double-click.
7973 \begin_layout Subsubsection*
7977 \begin_layout Standard
7978 In order to use SumatraPDF for inverse search, enter
7979 \begin_inset Flex Code
7982 \begin_layout Plain Layout
7983 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7988 in the viewer setting in
7989 \begin_inset Flex Noun
7992 \begin_layout Plain Layout
7993 Preferences\SpecialChar menuseparator
7994 File Handling\SpecialChar menuseparator
7995 File formats\SpecialChar menuseparator
8002 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8004 \begin_inset Flex Code
8007 \begin_layout Plain Layout
8013 enables communication via the
8019 \begin_inset Flex Code
8022 \begin_layout Plain Layout
8028 option if you want to use the
8032 , and be sure to specify the \SpecialChar LyX
8033 Server pipe path in the \SpecialChar LyX
8037 \begin_layout Standard
8038 Reverse search is triggered by double-click.
8041 \begin_layout Section
8045 \begin_layout Standard
8046 Forward search is, as the name implies, in a sense the
8047 \begin_inset Quotes eld
8051 \begin_inset Quotes erd
8055 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8057 If forward search is set up (as described in what follows), you can put
8058 the cursor anywhere in your \SpecialChar LyX
8060 \begin_inset Flex Noun
8063 \begin_layout Plain Layout
8064 Navigate\SpecialChar menuseparator
8071 \begin_inset Flex Noun
8074 \begin_layout Plain Layout
8080 in the context menu via right mouse click), and then the viewer will jump
8081 to that position as well.
8082 This implies, of course, that your viewer supports this function.
8085 \begin_layout Standard
8086 To make forward search possible, you first need to provide the generated
8087 output PDF/DVI file with additional information about the \SpecialChar TeX
8089 This can be done via the methods described in the section
8090 \begin_inset CommandInset ref
8092 reference "subsec:rev-search"
8099 \begin_layout Standard
8100 Additionally, you need to configure \SpecialChar LyX
8101 for using your viewers in
8102 \begin_inset Flex Noun
8105 \begin_layout Plain Layout
8106 Tools\SpecialChar menuseparator
8107 Preferences\SpecialChar menuseparator
8108 Output\SpecialChar menuseparator
8115 We provide a range of tested configurations for some viewers, which you
8116 can select from the drop down list.
8117 If none of these configurations suits you, you have to find out and enter
8118 a suitable configuration yourself.
8119 The definition syntax uses the following placeholders:
8122 \begin_layout Itemize
8124 \begin_inset Flex Code
8127 \begin_layout Plain Layout
8136 \begin_layout Itemize
8138 \begin_inset Flex Code
8141 \begin_layout Plain Layout
8147 : name of the (temporary) exported .tex file (without path)
8150 \begin_layout Itemize
8152 \begin_inset Flex Code
8155 \begin_layout Plain Layout
8161 : name of the (temporary) exported .tex file (including path)
8164 \begin_layout Itemize
8166 \begin_inset Flex Code
8169 \begin_layout Plain Layout
8175 : name of the exported output file (either dvi or pdf, depending on which
8176 one exists in the temporary directory)
8179 \begin_layout Standard
8180 Note that only some of the viewers provide full forward search functionality,
8181 among them yap, xdvi, okular
8185 \begin_layout Plain Layout
8186 You might want to set
8187 \begin_inset Flex Code
8190 \begin_layout Plain Layout
8197 \begin_inset Flex Noun
8200 \begin_layout Plain Layout
8201 Tools\SpecialChar menuseparator
8202 Preferences\SpecialChar menuseparator
8203 File Handling\SpecialChar menuseparator
8205 \begin_inset space ~
8218 , qpdfview and SumatraPDF
8222 \begin_layout Plain Layout
8223 SumatraPDF can also use DDE commands through the external program CMCDDE
8225 \begin_inset CommandInset href
8227 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8237 While many of the widespread PDF viewers (most notably Adobe Reader) do
8238 not support forward search at all, some other viewers – e.
8239 \begin_inset space \thinspace{}
8243 evince and xpdf – allow at least to reload the document and jump to a specific
8244 page of the file, so you can at least navigate
8245 \begin_inset Quotes eld
8249 \begin_inset Quotes erd
8253 This latter functionality is provided by an external call of synctex (see
8254 the predefined example configurations).
8258 \begin_layout Standard
8259 Forward search works both with DVI and PDF output.
8261 simply checks which preview format you have used before (i.
8262 \begin_inset space \thinspace{}
8265 e., which format is already there in the temporary directory) and chooses
8266 the appropriate configuration for the respective format.
8269 \begin_layout Chapter
8270 Special Document Classes
8273 \begin_layout Section
8277 \begin_layout Standard
8283 \begin_layout Subsection
8287 \begin_layout Standard
8288 This section describes how \SpecialChar LyX
8289 can be used to write articles for submission
8290 to the scientific journal
8292 Astronomy and Astrophysics
8295 \begin_inset Flex URL
8298 \begin_layout Plain Layout
8300 http://www.edpsciences.fr/aa/
8305 ) using Version 5.01 of the document class
8310 This package can be downloaded from the ftp site
8313 \begin_layout Standard
8314 \begin_inset VSpace medskip
8320 \begin_layout Standard
8322 \begin_inset Flex URL
8325 \begin_layout Plain Layout
8327 ftp://ftp.edpsciences.org/pub/aa/readme.html
8335 \begin_layout Standard
8336 \begin_inset VSpace medskip
8342 \begin_layout Standard
8343 A manual comes together with that package, and this text is not meant to
8344 replace the original manual but is merely a short guide in how to realize
8345 the correct form of your paper.
8349 \begin_layout Standard
8350 Please note that the publisher of the journal was changed from Springer
8351 to EDP Sciences starting January 1, 2001.
8352 That change involved also some slight changes to the style files, namely
8353 the removal of the thesaurus command.
8354 The \SpecialChar LyX
8355 class aa supports the newest version of these style files, V 5.01.
8356 If you have an older version installed, please upgrade.
8357 For compatibility, the old (version 4) layout has been kept as
8362 Please refer to the comments in
8365 Dir/layouts/aapaper.layout
8370 \begin_layout Subsection
8374 \begin_layout Standard
8375 It is recommended you start from the example template distributed with \SpecialChar LyX
8377 If you are not using a template, note the following settings:
8380 \begin_layout Itemize
8387 Document\SpecialChar menuseparator
8390 dialog (OK, that one was obvious).
8393 \begin_layout Itemize
8394 Don't change the option
8397 \begin_inset space ~
8407 The whole layout is done by the macros, you shouldn't change anything.
8410 \begin_layout Subsection
8414 \begin_layout Standard
8415 First thing to enter is the header information.
8416 It consists of seven entries, of which some are optional.
8420 \begin_layout Itemize
8428 \begin_layout Itemize
8436 \begin_layout Itemize
8444 \begin_layout Itemize
8452 \begin_layout Itemize
8457 : [optional] if more than one author: whom to contact for offprint requests.
8460 \begin_layout Itemize
8465 : [optional] mail address for contacts.
8468 \begin_layout Itemize
8476 Received: <date>; Accepted <date>
8479 \begin_layout Standard
8480 There is no need to issue the
8486 command, this is done automatically by \SpecialChar LyX
8487 when the header is finished.
8488 Although the order of the single header entries doesn't matter it is advised
8489 to keep the above sequence, just to get the best optics and meets the layout
8490 of the real document.
8493 \begin_layout Standard
8494 If you want to place footnotes in the header block, e.
8495 \begin_inset space \thinspace{}
8499 \begin_inset space \space{}
8502 to state your present address, just use the standard footnote via the menu
8505 Insert\SpecialChar menuseparator
8510 will automagically use the term
8519 \begin_layout Standard
8520 In addition to these topics, the macros use three additional \SpecialChar LaTeX
8522 have no counterpart in \SpecialChar LyX
8526 \begin_layout Itemize
8533 to separate different names for more than one author and institute, respectivel
8537 \begin_layout Itemize
8544 to mark corresponding author/institute pairs.
8545 The institutes are numbered sequentially as they appear in the
8549 field, so you have to put a marker to each author.
8552 \begin_layout Itemize
8559 to supply an email address for fast contact.
8562 \begin_layout Standard
8563 In all cases, the appropriate command has to be entered in \SpecialChar LyX
8571 \begin_layout Subsection
8575 \begin_layout Standard
8576 The abstract should immediately follow the header block.
8577 With version 5 the abstract environment was changed to a command, and there
8578 is now a resctriction to only one paragraph.
8579 In addition, it should contain an entry with the keywords.
8580 This is not yet implemented for \SpecialChar LyX
8581 , therefore you have to enter the \SpecialChar LaTeX
8589 by hand and mark it as \SpecialChar LaTeX
8591 Refer to the example paper.
8594 \begin_layout Subsection
8595 Supported environments
8598 \begin_layout Standard
8599 The A&A paper layout supports the following environments for structuring
8603 \begin_layout Itemize
8609 \begin_layout Itemize
8615 \begin_layout Itemize
8621 \begin_layout Itemize
8627 \begin_layout Itemize
8633 \begin_layout Itemize
8639 \begin_layout Itemize
8645 \begin_layout Itemize
8651 \begin_layout Itemize
8657 \begin_layout Itemize
8663 \begin_layout Itemize
8669 \begin_layout Itemize
8676 \begin_layout Subsection
8677 Commands not supported by \SpecialChar LyX
8681 \begin_layout Standard
8682 Some commands are not yet supported by the
8686 layout for \SpecialChar LyX
8688 Some have already been mentioned.
8689 For the sake of completeness, they are listed all together here:
8692 \begin_layout Itemize
8700 \begin_layout Itemize
8708 \begin_layout Itemize
8716 \begin_layout Itemize
8724 \begin_layout Itemize
8732 \begin_layout Itemize
8740 \begin_layout Itemize
8748 \begin_layout Itemize
8756 \begin_layout Standard
8757 If you want to use any of these commands, you have to enter them yourself.
8760 Do not forget to mark them as \SpecialChar LaTeX
8764 \begin_layout Subsection
8765 Figure and Table Floats
8768 \begin_layout Standard
8770 provides support for the necessary float environments
8772 figure, figure*, table
8778 , therefore we won't tell much about it here.
8782 \begin_inset space ~
8788 Just remember that tables should be left-aligned.
8789 For that, select the table and change the alignment in
8791 Edit\SpecialChar menuseparator
8793 \begin_inset space ~
8799 \begin_layout Standard
8800 There is only one special thing: the figures with caption besides the figure.
8801 To create such a figure, you have to do the following:
8804 \begin_layout Enumerate
8805 Create a wide figure float:
8807 Insert\SpecialChar menuseparator
8808 Float\SpecialChar menuseparator
8811 , then right click in the figure and select
8814 \begin_inset space ~
8822 \begin_layout Enumerate
8823 Enter your caption text.
8826 \begin_layout Enumerate
8831 to move the cursor above the caption.
8834 \begin_layout Enumerate
8838 \begin_layout Enumerate
8839 Position the cursor behind the figure and insert a horizontal fill:
8841 Insert\SpecialChar menuseparator
8843 \begin_inset space ~
8846 Character\SpecialChar menuseparator
8848 \begin_inset space ~
8856 \begin_layout Enumerate
8857 Switch to \SpecialChar LaTeX
8861 \begin_inset space ~
8869 \begin_layout Enumerate
8879 Do not close the brace!
8882 \begin_layout Enumerate
8883 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8888 \begin_inset space ~
8900 \begin_layout Standard
8901 Also, refer to the figures in the example paper.
8904 \begin_layout Subsection
8908 \begin_layout Standard
8909 For submission, the paper has to be formated in a special double-spacing
8911 For this purpose, you have to give the option
8915 to the documentclass.
8916 This must be done using the extra class options field in the
8918 Document\SpecialChar menuseparator
8922 Just enter the string
8929 \begin_layout Subsection
8933 \begin_layout Standard
8938 directory contains an example paper written with \SpecialChar LyX
8940 It is the example paper from the original macro package, translated to
8943 Use it for inspiration, and compare the original \SpecialChar LaTeX
8944 code with \SpecialChar LyX
8948 \begin_layout Section
8953 \begin_layout Standard
8959 \begin_layout Subsection
8963 \begin_layout Standard
8965 is a set of macros produced by the American Astronomical Society to
8966 facilitate electronic manuscript submission to the three journals they
8967 publish: the Astrophysical Journal (including the Letters and Supplement),
8968 the Astronomical Journal, and the Publications of the Astronomical Society
8971 has proven to be an excellent tool for generating these documents, especially
8972 given its equation, citation, and figure handling capabilities.
8974 requires version 5.0 (or higher) of these macros; preferably 5.2, which
8975 is the version described here, or higher.
8976 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8977 2.09 and are fundamentally
8978 incompatible with \SpecialChar LyX
8980 The AAS\SpecialChar TeX
8981 package may be downloaded from the AAS\SpecialChar TeX
8985 \begin_layout Standard
8986 \begin_inset VSpace medskip
8992 \begin_layout Standard
8994 \begin_inset Flex URL
8997 \begin_layout Plain Layout
8999 https://aas.org/aastex/aastex-downloads
9007 \begin_layout Standard
9008 \begin_inset VSpace medskip
9014 \begin_layout Standard
9015 A complete user guide is contained in that package and you should familiarize
9016 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9019 will not reduce the need to figure out all the AAS\SpecialChar TeX
9020 commands, it will only
9021 reduce the drudgery of typing everything in.
9022 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9024 completely to the requirements of the journal to which you are submitting
9028 \begin_layout Subsection
9029 Starting a New Paper
9032 \begin_layout Standard
9033 I strongly suggest that you start with the AAS\SpecialChar TeX
9037 File\SpecialChar menuseparator
9044 , enter the new file name, then choose the
9049 This will show the most common fields found in a manuscript.
9050 Simply overwrite the existing text (including the brackets,
9054 ) with the correct information.
9055 Many of the AAS\SpecialChar TeX
9056 commands and environments can be implemented directly in
9058 , but some cannot: most noticeably
9070 , which should stick out like a sore thumb if you actually just opened the
9072 For commands such as these, the \SpecialChar LaTeX
9073 code must be entered directly and marked
9075 Such commands are referred to as \SpecialChar TeX
9076 code, or Evil Red Text.
9077 I tried to minimize the amount of \SpecialChar TeX
9078 code needed in an AAS\SpecialChar TeX
9080 there is still a bit more required than any of us would like.
9083 \begin_layout Subsection
9084 Finishing Your Paper
9087 \begin_layout Standard
9088 When the paper is finished to your satisfaction and previews/prints correctly,
9090 \begin_inset Quotes eld
9094 \begin_inset Quotes erd
9097 actions which need to be done before you submit it to the journals.
9101 \begin_layout Enumerate
9102 Export your paper as a \SpecialChar LaTeX
9105 File\SpecialChar menuseparator
9106 Export\SpecialChar menuseparator
9114 \begin_layout Enumerate
9119 file with your favorite text editor
9123 \begin_layout Enumerate
9124 remove the comment lines before the
9133 \begin_layout Enumerate
9138 usepackage...{fontenc}
9140 line if it appears (usually just after
9155 \begin_layout Enumerate
9156 remove everything between (and including) the
9168 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9170 (which should appear immediately after the
9171 \begin_inset Quotes eld
9174 User specified \SpecialChar LaTeX
9176 \begin_inset Quotes erd
9187 \begin_layout Enumerate
9188 Run the resulting file through \SpecialChar LaTeX
9189 to make sure it still processes correctly.
9192 \begin_layout Enumerate
9193 Reread the journal requirements to make sure your filenames and formats
9197 \begin_layout Enumerate
9201 \begin_layout Subsection
9202 Comments On Specific Commands
9205 \begin_layout Standard
9206 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9213 ) gives a good description of each.
9214 Thus it's probably easiest for me to go down the list as found in the guide
9215 and offer comments where necessary.
9216 So let's begin \SpecialChar ldots
9220 \begin_layout Subsubsection
9221 Things that work as expected
9224 \begin_layout Standard
9225 Because they work as you might expect, I simply list them and the section
9326 begin{thebibliography}
9334 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9335 graphicx figure commands (2.14.1),
9359 (2.15.4, amongst other places),
9386 \begin_layout Standard
9387 The following style options also work correctly:
9408 Simply put them in the
9414 Layout\SpecialChar menuseparator
9420 \begin_layout Subsubsection
9421 Things that work, but require more comment
9424 \begin_layout Standard
9425 The following items work, but require a little more discussion:
9428 \begin_layout Itemize
9429 These items are reserved for use by the journal editors, but you can put
9430 them into the \SpecialChar LaTeX
9431 preamble if you feel compelled to do so:
9464 \begin_layout Itemize
9465 These items may be placed in the \SpecialChar LaTeX
9466 preamble, and are included as blanks in
9488 \begin_layout Itemize
9495 (2.3) – can only be used
9496 \begin_inset Quotes eld
9500 \begin_inset Quotes erd
9503 , not in the middle of a paragraph.
9504 Use \SpecialChar TeX
9505 code if you need to embed it.
9508 \begin_layout Itemize
9515 (2.3) – will have extra {} after it.
9516 This should not cause an error.
9519 \begin_layout Itemize
9526 (2.6) – can only be used
9527 \begin_inset Quotes eld
9531 \begin_inset Quotes erd
9534 , not in the middle of a paragraph.
9535 Use \SpecialChar TeX
9536 code if you need to embed it.
9539 \begin_layout Itemize
9546 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9550 \begin_layout Itemize
9564 \begin_layout Itemize
9571 (2.9) – will have extra {} after it.
9572 This should not cause an error.
9575 \begin_layout Itemize
9582 (2.11) – will have extra {} after it.
9583 This should not cause an error.
9586 \begin_layout Itemize
9593 (2.14.2) – you can insert an optional filename argument by placing the cursor
9594 at the beginning of the text and selecting
9596 Insert\SpecialChar menuseparator
9601 \begin_inset Quotes eld
9605 \begin_inset Quotes erd
9608 inserts an optional argument of the type needed by
9615 Hopefully it will be renamed someday.
9618 \begin_layout Itemize
9631 for the catalog ID optional parameter
9634 \begin_layout Itemize
9647 for the catalog ID optional parameter
9650 \begin_layout Subsubsection
9651 Things not implemented, use \SpecialChar TeX
9655 \begin_layout Standard
9678 setcounter{equation}
9680 (2.12), Journal name abbreviations (2.13.4),
9716 (2.15.4, insert it as the first element in the lefthand cell after where
9718 Don't use any of \SpecialChar LyX
9719 's rules in the table),
9731 (2.15.5), much of Misc (2.17, except
9782 \begin_layout Subsubsection
9783 Things that cannot be implemented
9786 \begin_layout Standard
9788 at least in any meaningful sort of way, so I suggest ignoring them.
9789 They are the references environment (2.13.3), and the deluxetable environment
9791 If you really, really need to use deluxetable, I suggest editing it in
9792 a separate file with a text editor, then using
9794 Insert\SpecialChar menuseparator
9796 \begin_inset space ~
9801 to include it in your \SpecialChar LyX
9807 file to see an example of this.
9810 \begin_layout Subsection
9811 FAQs, Tips, Tricks, and Other Ruminations
9814 \begin_layout Subsubsection
9815 Getting \SpecialChar LyX
9816 and AAS\SpecialChar TeX
9820 \begin_layout Standard
9821 It can be a bit tricky to get \SpecialChar LyX
9822 to recognize a new layout and document class.
9823 When all else fails, do this:
9826 \begin_layout Enumerate
9827 Make certain that \SpecialChar LaTeX
9828 can find AAS\SpecialChar TeX
9830 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9832 directory completely unrelated to \SpecialChar LaTeX
9833 or AAS\SpecialChar TeX
9834 and run \SpecialChar LaTeX
9842 \begin_layout Enumerate
9847 appears in \SpecialChar LyX
9855 \begin_layout Enumerate
9858 Tools\SpecialChar menuseparator
9862 , then restart \SpecialChar LyX
9866 \begin_layout Enumerate
9867 Open a regular new file, not from a template.
9868 Does AAS\SpecialChar TeX
9869 appear in the class list in
9871 Document\SpecialChar menuseparator
9877 \begin_layout Standard
9878 If you get a warning from an existing AAS\SpecialChar TeX
9879 document about not being able
9880 to find the AAS\SpecialChar TeX
9881 layout or a message about
9882 \begin_inset Quotes eld
9885 You should not mix title layouts with normal ones
9886 \begin_inset Quotes erd
9889 , things haven't been installed correctly.
9892 \begin_layout Subsubsection
9894 error processing a table
9897 \begin_layout Standard
9899 , by default, attempts to center the table caption/title.
9900 This seems to produce a bad interaction in AAS\SpecialChar TeX
9901 so you should click somewhere
9902 in the caption/title, then select
9904 Edit\SpecialChar menuseparator
9906 \begin_inset space ~
9920 This took care of it for me.
9923 \begin_layout Subsubsection
9927 \begin_layout Standard
9928 A couple of things: 1) I have noticed some funny spacing in the reference
9929 entries in the text.
9930 When you enter the bibliography item data, make sure their is
9934 space between the last author and the parenthesis setting off the year;
9938 \begin_inset space \thinspace{}
9942 \begin_inset space \space{}
9956 2) Entering the references at all is not obvious.
9957 The easiest thing is to start typing your first reference at the end of
9958 the document, then mark it as type
9963 That will put a small gray box in front of what you just typed.
9964 Click on the box to fill in the rest of the information.
9965 For new references, go to the end of an existing reference and press return.
9966 That will create a new line with its own box, etc.
9969 \begin_layout Subsubsection
9973 \begin_layout Standard
9974 Even though AAS\SpecialChar TeX
9975 provides its own figure commands (
9981 , for example), I much prefer \SpecialChar LaTeX
9982 's standard figure commands (with the default
9991 \begin_inset space ~
9994 commands as \SpecialChar TeX
9995 code into a Figure Float box if you desire, but I never have
9996 much luck getting the layout right.
9997 With the standard graphics, \SpecialChar LyX
10002 usepackage{graphicx}
10004 command into the \SpecialChar LaTeX
10005 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10007 interspersing the figures in the text.
10008 I believe ApJ accepts figures exactly this way now; AJ might still use
10010 \begin_inset Quotes eld
10013 stack everything at the end
10014 \begin_inset Quotes erd
10020 \begin_layout Subsubsection
10021 Things I could have done, but didn't
10024 \begin_layout Standard
10026 \begin_inset Quotes eld
10030 \begin_inset Quotes erd
10033 things I could have implemented, but chose not to.
10034 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10036 even though it is double-spaced in the paper manuscript.
10037 Also, I chose not to make separate layouts for the preprint and preprint2
10039 Since I assume you will spend most of your time in the plain manuscript
10040 mode anyway, I decided not to chew up more disk space with this.
10044 \begin_layout Subsection
10048 \begin_layout Standard
10049 Your mileage may vary.
10050 I've now had papers published by both ApJ and AJ that have had 98% of the
10051 effort done in \SpecialChar LyX
10052 ; the last 2% was the \SpecialChar LaTeX
10053 post-processing and a few cleanups.
10054 I have had no trouble with the submission process, and I'm sure the journals
10055 were never aware that there might be a difference.
10056 So, go forth and publish!
10059 \begin_layout Section
10060 AMS \SpecialChar LaTeX
10064 \begin_layout Standard
10074 \begin_layout Standard
10075 \begin_inset VSpace bigskip
10081 \begin_layout Standard
10083 The AMS \SpecialChar LaTeX
10084 layouts are set up to conform to suggested styles for mathematical
10085 papers to be submitted to American Mathematical Society publications.
10086 The layouts are not tailored to a specific journal, but easily can be.
10087 You should refer to the AMS documentation for specific instructions for
10088 each journal (usually it will entail only changing a single line in the
10091 That documentation is available on the Web at
10092 \begin_inset Flex URL
10095 \begin_layout Plain Layout
10103 \begin_inset Flex URL
10106 \begin_layout Plain Layout
10108 ftp://ftp.ams.org/pub/tex/amslatex/
10114 These layouts are appropriate, and useful, for any mathematical writing.
10118 \begin_layout Standard
10119 There are two basic AMS \SpecialChar LaTeX
10123 \begin_layout Itemize
10124 amsart: The standard AMS article format.
10127 \begin_layout Itemize
10128 amsbook: the standard AMS book (really, monograph) format.
10132 \begin_layout Standard
10133 The layouts themselves contain only the minimum necessary to use the AMS
10135 They do not, in particular, contain any of the `theorem' environments used
10136 for setting theorems, lemmas, and the like.
10137 These are contained, instead, in the
10138 \begin_inset Flex Code
10141 \begin_layout Plain Layout
10147 module, which is loaded by default when you select one of the AMS classes.
10148 (It can also be used with other classes and can be removed, if you would
10149 rather use something else.) Less commonly used environments are in the
10150 \begin_inset Flex Code
10153 \begin_layout Plain Layout
10154 Theorems (AMS-Extended)
10159 module, which must be loaded manually.
10162 \begin_layout Standard
10163 By default, theorems and the like are numbered consecutively throughout
10164 the document, but this may be modified by loading the module
10165 \begin_inset Flex Code
10168 \begin_layout Plain Layout
10169 Theorems (Order by Section)
10174 or, if you are using
10175 \begin_inset Flex Code
10178 \begin_layout Plain Layout
10185 \begin_inset Flex Code
10188 \begin_layout Plain Layout
10189 Theorems (Order by Chapter)
10195 These will number the results as
10196 \begin_inset Formula $n.m$
10199 , where the first number refers to the section (or chapter) and the second
10200 refers to the total number of results so far in that section (or chapter).
10201 Many environments are also available unnumbered.
10202 These are indicated by an asterisk at the end.
10203 If you happen to want
10207 unnumbered results, the module
10208 \begin_inset Flex Code
10211 \begin_layout Plain Layout
10217 provides that option.
10220 \begin_layout Standard
10221 Note that these modules do not
10225 to be used with the AMS classes.
10226 It is perfectly possible to use the
10227 \begin_inset Flex Code
10230 \begin_layout Plain Layout
10236 module, and the others mentioned, with other classes, such as
10237 \begin_inset Flex Code
10240 \begin_layout Plain Layout
10247 \begin_inset Flex Code
10250 \begin_layout Plain Layout
10257 \begin_inset Flex Code
10260 \begin_layout Plain Layout
10269 \begin_layout Subsection
10270 What these layouts provide
10273 \begin_layout Standard
10274 There is a long list of included environments provided by these layouts.
10275 In AMS-\SpecialChar LaTeX
10276 , there is, in fact, an opportunity to define an unlimited variety
10277 of `theorem' environments.
10278 However, the AMS recommends the environments that are available in \SpecialChar LyX
10283 \begin_layout Standard
10284 The following environments—as well as the standard environments, such as
10286 \begin_inset Flex Noun
10289 \begin_layout Plain Layout
10296 \begin_inset Flex Noun
10299 \begin_layout Plain Layout
10306 \begin_inset Flex Noun
10309 \begin_layout Plain Layout
10316 \begin_inset Flex Noun
10319 \begin_layout Plain Layout
10326 \begin_inset Flex Noun
10329 \begin_layout Plain Layout
10336 \begin_inset Flex Code
10339 \begin_layout Plain Layout
10346 \begin_inset Flex Code
10349 \begin_layout Plain Layout
10358 \begin_layout Description
10359 Address This should be the author's permanent address.
10362 \begin_layout Description
10364 \begin_inset space ~
10367 Address This should be the author's temporary address at the time of submission,
10368 if different from the Address.
10371 \begin_layout Description
10372 Email Author's e-mail address
10375 \begin_layout Description
10376 URL Author's Web address, if desired.
10379 \begin_layout Description
10380 Keywords Key words or phrases used to identify specific topics discussed
10384 \begin_layout Description
10385 Subjectclass These refer to the AMS Subject Classifications, published and
10388 Mathematical Reviews
10391 These are also available online at the AMS cites listed above.
10394 \begin_layout Description
10398 \begin_layout Description
10402 \begin_layout Description
10406 \begin_layout Standard
10407 The following environments are provided by both the
10408 \begin_inset Flex Code
10411 \begin_layout Plain Layout
10418 \begin_inset Flex Code
10421 \begin_layout Plain Layout
10427 modules, in the latter case in both starred (unnumbered) and unstarred
10428 (numbered) versions.
10429 These same environments are provided only in the starred versions by the
10431 \begin_inset Flex Code
10434 \begin_layout Plain Layout
10443 \begin_layout Theorem
10444 This is typically used for the statements of major results.
10448 \begin_layout Corollary*
10449 This is used for statements which follow fairly directly from previous statement
10451 Again, these can be major results.
10455 \begin_layout Lemma
10456 These are smaller results needed to prove other statements.
10459 \begin_layout Proposition
10460 These are less major results which (hopefully) add to the general theory
10464 \begin_layout Conjecture
10465 These are statements provided without justification, which the author does
10466 not know how to prove, but which seem to be true (to the author, at least).
10469 \begin_layout Definition*
10470 Guess what this is for.
10471 The font is different for this environment than for the previous ones.
10475 \begin_layout Example*
10476 Used for examples illustrating proven results.
10479 \begin_layout Problem
10480 It's not really known what this is for.
10481 You should figure it out.
10484 \begin_layout Exercise*
10485 Write a description for this one.
10488 \begin_layout Remark
10489 This environment is also a type of theorem, usually a lesser sort of observation.
10492 \begin_layout Claim*
10493 Often used in the course of giving a proof of a larger result.
10497 Generally, these are used to break up long arguments, using specific instances
10503 The numbering scheme for cases is on its own, not together with other numbered
10508 \begin_layout Proof
10509 At the end of this environment, a QED symbol (usually a square, but it can
10510 vary with different styles) is placed.
10511 If you want to have other environments within this one—for example, Case
10512 environments—and have the QED symbol appear only after them, then the other
10513 environments need to be nested within the proof environment.
10516 Nesting Environments
10522 for information on nesting.
10525 \begin_layout Standard
10526 And these environments are provided by
10527 \begin_inset Flex Code
10530 \begin_layout Plain Layout
10531 Theorems (AMS-Extended)
10539 \begin_layout Criterion*
10540 A required condition.
10543 \begin_layout Algorithm*
10544 A general procedure to be used.
10547 \begin_layout Axiom*
10548 This is a property or statement taken as true within the system being discussed.
10551 \begin_layout Condition*
10552 Sometimes used to state a condition assumed within the present context of
10556 \begin_layout Note*
10557 Similar to a Remark.
10560 \begin_layout Notation*
10561 Used for the explanation of, yes, notation.
10564 \begin_layout Summary
10565 Do we really need to tell you?
10568 \begin_layout Acknowledgement*
10572 \begin_layout Conclusion*
10573 Sometimes used at the end of a long train of argument.
10577 Used in a way similar to Proposition, though perhaps lower on the scale.
10580 \begin_layout Standard
10581 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10584 They need to be available on your system in order to use these environments.
10587 \begin_layout Section
10595 \begin_layout Standard
10601 \begin_layout Subsection
10605 \begin_layout Standard
10606 These are the layout files for some of the journals of the American Geophysical
10608 It is assumed that you have both the AGU's own class files and AGUplus
10609 installed (everything to be found at
10610 \begin_inset Flex URL
10613 \begin_layout Plain Layout
10615 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10623 \begin_layout Subsection
10627 \begin_layout Standard
10637 They are still called this in the \SpecialChar LyX
10638 GUI, though their \SpecialChar LaTeX
10651 \begin_layout Standard
10652 Newly defined styles are
10689 These are mostly manuscript attributes and defined in the AGU class documentati
10693 \begin_layout Standard
10694 I suspect this is still badly incomplete.
10697 \begin_layout Subsection
10701 \begin_layout Standard
10718 \begin_layout Subsection
10722 \begin_layout Itemize
10725 Journal of Geophysical Research
10734 \begin_layout Standard
10735 Add your own, it isn't so hard! Look at the
10746 \begin_layout Subsection
10747 Bugs and things to remember
10750 \begin_layout Standard
10751 In order to use the new layouts, you must remember to do the following for
10755 \begin_layout Enumerate
10761 This can be done in the
10763 Layout\SpecialChar menuseparator
10768 Document\SpecialChar menuseparator
10772 (AGU articles are always in English, right? So
10776 choose a language.)
10779 \begin_layout Enumerate
10784 into the document's
10789 (Yes, this is a bug.)
10792 \begin_layout Enumerate
10793 Make sure you use the
10797 bibliography style, by entering
10801 into the second field of the Bib\SpecialChar TeX
10803 None of the standard styles will do.
10806 \begin_layout Section
10810 \begin_layout Standard
10816 \begin_layout Subsection
10820 \begin_layout Standard
10821 Broadway is for writing plays.
10822 The format is more decorative than Hollywood, and much less standardized.
10823 This format should be suitable for workshops.
10826 \begin_layout Subsection
10830 \begin_layout Standard
10831 The same as in Hollywood.
10834 \begin_layout Subsection
10838 \begin_layout Standard
10843 names as labels then cross-reference the label to insert the name.
10844 The cross-reference dialog will show the current cast of characters.
10847 \begin_layout Subsection
10848 Paper size and Margins
10851 \begin_layout Standard
10852 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10855 \begin_layout Subsection
10859 \begin_layout Standard
10860 The following environments are available.
10861 You can use broadway.bind to get the bind keys shown at the right.
10864 \begin_layout Itemize
10868 \begin_inset Newline newline
10873 You should not have to use this, but it is here for anything that does not
10877 \begin_layout Itemize
10881 \begin_inset space \hfill{}
10885 \begin_inset Newline newline
10890 Used to describe stage setting and the action.
10891 First use of speaker names in all CAPs.
10894 \begin_layout Itemize
10898 \begin_inset space \hfill{}
10902 \begin_inset Newline newline
10907 Automatically numbered.
10908 On screen it will be arabic, but will print as Roman.
10911 \begin_layout Itemize
10915 \begin_inset space \hfill{}
10919 \begin_inset Newline newline
10929 It is just centered text.
10932 \begin_layout Itemize
10936 \begin_inset space \hfill{}
10940 \begin_inset Newline newline
10945 Not automatically numbered.
10946 You supply the number.
10947 This is because I couldn't figure out how.
10950 \begin_layout Itemize
10954 \begin_inset space \hfill{}
10958 \begin_inset Newline newline
10963 A special case of Narrative to describe the setting and action as the curtain
10967 \begin_layout Itemize
10971 \begin_inset space \hfill{}
10975 \begin_inset Newline newline
10980 The speaker's (actor's) title, centered in all CAPS.
10983 \begin_layout Itemize
10987 \begin_inset space \hfill{}
10991 \begin_inset Newline newline
10996 Instructions to the speaker.
10997 The parentheses are automatically inserted.
10998 The ( will appear on screen, but both will be in the printed play.
10999 This environment is only used within
11006 \begin_layout Itemize
11010 \begin_inset space \hfill{}
11014 \begin_inset Newline newline
11019 What the Speaker says.
11022 \begin_layout Itemize
11026 \begin_inset space \hfill{}
11030 \begin_inset Newline newline
11035 The curtain comes down.
11038 \begin_layout Itemize
11042 \begin_inset space \hfill{}
11048 \begin_layout Itemize
11052 \begin_inset space \hfill{}
11058 \begin_layout Itemize
11062 \begin_inset space \hfill{}
11068 \begin_layout Standard
11072 \begin_layout Section
11076 \begin_layout Standard
11081 can be used to type letters according to German conventions.
11082 A template file is included in
11084 .../lyx/share/templates
11086 for you to use as a starting point.
11089 \begin_layout Section
11097 \begin_layout Standard
11103 \begin_layout Subsection
11107 \begin_layout Standard
11108 This is the layout file for the European Geophysical Society journals.
11113 can be downloaded from the web site of the EGS under
11114 \begin_inset Flex URL
11117 \begin_layout Plain Layout
11127 \begin_layout Subsection
11131 \begin_layout Standard
11134 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
11142 The current layout file is unfortunately very unmodular and would benefit
11143 from using the various
11150 \begin_layout Section
11154 \begin_layout Standard
11155 See the \SpecialChar LyX
11161 It contains all infos you need.
11164 \begin_layout Section
11167 Foil\SpecialChar TeX
11171 \begin_inset CommandInset label
11180 \begin_layout Standard
11186 \begin_layout Subsection
11190 \begin_layout Standard
11191 This section describes how to use \SpecialChar LyX
11192 to make slides for overhead projectors.
11193 There are two document classes that can do this: the default slides class
11196 Foil\SpecialChar TeX
11200 This section documents the latter.
11203 \begin_layout Standard
11204 I'm going to say this again, nice and clear, so that there's no misunderstanding
11208 \begin_layout Standard
11209 \begin_inset VSpace bigskip
11215 \begin_layout Standard
11219 This section documents the class
11220 \begin_inset Quotes eld
11228 \begin_inset Quotes erd
11236 \begin_layout Standard
11237 \begin_inset VSpace bigskip
11243 \begin_layout Standard
11244 If you're looking for the documentation for
11245 \begin_inset Quotes eld
11253 \begin_inset Quotes erd
11256 , check out section
11257 \begin_inset space ~
11261 \begin_inset CommandInset ref
11263 reference "sec:slitex"
11268 If your machine doesn't have the
11276 installed, you'll probably have to use the default
11280 class, which isn't quite as good as
11285 \begin_layout Standard
11290 class is designed for use with version
11291 \begin_inset space ~
11299 class file which is now an integral part of \SpecialChar LaTeX2e
11303 \begin_layout Subsection
11307 \begin_layout Standard
11308 Obviously, to use this document class, you need to select
11319 \begin_inset space ~
11325 There are some settings in the
11328 \begin_inset space ~
11333 dialog that you should know about that are specific to this class:
11336 \begin_layout Itemize
11337 Don't change the options
11348 \begin_inset space ~
11354 They're ignored by the
11361 \begin_layout Itemize
11362 The default font size is 20
11363 \begin_inset space \thinspace{}
11366 pt with the other options being 17
11367 \begin_inset space \thinspace{}
11371 \begin_inset space \thinspace{}
11375 \begin_inset space \thinspace{}
11381 \begin_layout Itemize
11382 The default font is
11390 but all math equations are still typeset in the usual roman font.
11393 \begin_layout Itemize
11396 Foil\SpecialChar TeX
11399 supports A4 and Letter paper sizes as well as a special size for working
11401 \begin_inset space \thinspace{}
11405 It doesn't support A5, B5, legal or executive paper sizes.
11408 \begin_layout Itemize
11409 Don't bother changing the
11413 settings because they are ignored anyway.
11414 All floats appear where they are defined in the text.
11417 \begin_layout Itemize
11422 setting behaves a bit differently for this class.
11425 Foil\SpecialChar TeX
11428 provides extensive footer and header capabilities including a user-defined
11431 \begin_inset space ~
11435 \begin_inset CommandInset ref
11437 reference "sec:foilfoot"
11442 The title page is treated differently to all other pages in the document
11451 has the logo centered at the bottom of the page (if one is defined).
11452 The possible page style choices and what they do are as follows:
11456 \begin_layout Labeling
11457 \labelwidthstring MMMMMMM
11464 The final output contains no page numbers, or other headers or footers
11465 (except footnotes of course).
11469 \begin_layout Labeling
11470 \labelwidthstring MMMMMMM
11477 The final output contains page numbers centered at the bottom of the page.
11478 No other headings or footers (other than footnotes).
11481 \begin_layout Labeling
11482 \labelwidthstring MMMMMMM
11487 Page numbers in lower right corner.
11488 Additional headers and footers are also shown.
11489 This is also the default.
11492 \begin_layout Labeling
11493 \labelwidthstring MMMMMMM
11498 Gives you access to the
11502 package although its use with
11504 Foil\SpecialChar TeX
11507 is discouraged by the writer of the
11509 Foil\SpecialChar TeX
11512 package because of some potential page layout clashes.
11516 \begin_layout Subsubsection
11520 \begin_layout Standard
11521 The following options may be used in the extra class options in the
11523 Document\SpecialChar menuseparator
11529 \begin_layout Labeling
11530 \labelwidthstring MMMMMMx
11535 This sets up the page layout for 7.33
11536 \begin_inset space \thinspace{}
11540 \begin_inset space \thinspace{}
11543 in paper, which is about the same aspect ratio as a 35
11544 \begin_inset space \thinspace{}
11547 mm slide, making it a bit easier to work with this medium.
11550 \begin_layout Labeling
11551 \labelwidthstring MMMMMMx
11556 Places a rule across the page below the header on every page except the
11560 \begin_layout Labeling
11561 \labelwidthstring MMMMMMx
11566 Places a rule across the page above the footer on every page except the
11570 \begin_layout Labeling
11571 \labelwidthstring MMMMMMx
11576 This is automatically set each time you create a new
11583 Foil\SpecialChar TeX
11586 to use the dvips driver to rotate those pages that are set as landscape
11590 \begin_layout Labeling
11591 \labelwidthstring MMMMMMx
11596 Simply changes the page dimensions to those of a landscape page but doesn't
11598 Thus if you use this option you need to use an external program to rotate
11599 each page or feed your paper through your printer as landscape.
11600 Note that this option effectively reverses the roles of the
11608 environments (don't worry these are described in the next section).
11611 \begin_layout Labeling
11612 \labelwidthstring MMMMMMx
11617 Equation numbers on the left.
11620 \begin_layout Labeling
11621 \labelwidthstring MMMMMMx
11626 Flush-left equations.
11629 \begin_layout Subsection
11630 Supported Environments
11633 \begin_layout Standard
11634 Most of the environments commonly supported in other classes are also supported
11640 There are several additional environments provided by
11642 Foil\SpecialChar TeX
11645 as well as a couple added by \SpecialChar LyX
11647 The following environments are shared with other classes:
11650 \begin_layout Standard
11651 \begin_inset Flex Multiple Columns
11654 \begin_layout Itemize
11660 \begin_layout Itemize
11666 \begin_layout Itemize
11672 \begin_layout Itemize
11678 \begin_layout Itemize
11684 \begin_layout Itemize
11691 \begin_layout Itemize
11697 \begin_layout Itemize
11703 \begin_layout Itemize
11709 \begin_layout Itemize
11715 \begin_layout Itemize
11721 \begin_layout Itemize
11727 \begin_layout Itemize
11733 \begin_layout Itemize
11739 \begin_layout Itemize
11745 \begin_layout Itemize
11751 \begin_layout Itemize
11757 \begin_layout Itemize
11768 \begin_layout Standard
11769 That is, all the major environments apart from the sectioning environments.
11770 Since foils are essentially self-contained sections, with a title and body,
11773 Foil\SpecialChar TeX
11776 provides specific commands for starting new foils and these are:
11779 \begin_layout Itemize
11785 \begin_layout Itemize
11791 \begin_layout Standard
11793 also provides slightly modified versions of these two environments called:
11796 \begin_layout Itemize
11802 \begin_layout Itemize
11805 ShortRotatefoilhead
11808 \begin_layout Standard
11809 and the differences will be explained in the next section.
11812 \begin_layout Standard
11813 Since foils are often used in presenting ideas or new theorems and such
11816 Foil\SpecialChar TeX
11819 also provides a comprehensive box of goodies for presenting them:
11822 \begin_layout Standard
11823 \begin_inset Flex Multiple Columns
11826 \begin_layout Itemize
11832 \begin_layout Itemize
11838 \begin_layout Itemize
11844 \begin_layout Itemize
11850 \begin_layout Itemize
11856 \begin_layout Itemize
11862 \begin_layout Itemize
11868 \begin_layout Itemize
11874 \begin_layout Itemize
11880 \begin_layout Itemize
11886 \begin_layout Itemize
11897 \begin_layout Standard
11898 The starred versions are unnumbered while the unstarred versions are numbered.
11899 There are also two list environments added by \SpecialChar LyX
11903 \begin_layout Itemize
11909 \begin_layout Itemize
11915 \begin_layout Standard
11918 Foil\SpecialChar TeX
11921 provides some powerful header and footer capabilities that are best set
11922 in the preamble although they may be set at any point in a document.
11923 If you want to change these settings in your document the best place to
11924 do so is at the very top of a foil, i.
11925 \begin_inset space \thinspace{}
11931 \begin_inset space \space{}
11936 straight after the foilhead.
11939 \begin_layout Standard
11940 For this purpose, the following command styles are provided [
11947 \begin_layout Standard
11948 \begin_inset Flex Multiple Columns
11951 \begin_layout Itemize
11955 \begin_inset space ~
11961 \begin_layout Itemize
11967 \begin_layout Itemize
11971 \begin_inset space ~
11977 \begin_layout Itemize
11981 \begin_inset space ~
11987 \begin_layout Itemize
11991 \begin_inset space ~
11998 \begin_layout Plain Layout
11999 \begin_inset space ~
12011 \begin_layout Standard
12012 There are also a few commands provided by
12014 Foil\SpecialChar TeX
12017 that aren't directly supported by \SpecialChar LyX
12018 but I'll tell you what they do and how
12019 to use them in section
12020 \begin_inset space ~
12024 \begin_inset CommandInset ref
12026 reference "sec:unsuppfoils"
12033 \begin_layout Subsection
12034 Building a Set of Foils
12037 \begin_layout Standard
12038 This section will give a simple introduction to using the different environments
12039 to build a set of foils.
12040 If you want to see an example set of foils, take a look at the
12044 file you find in \SpecialChar LyX
12052 \begin_layout Subsubsection
12053 Give It a Title Page
12056 \begin_layout Standard
12057 Unlike other classes that provide
12077 creates the title on a page of its own.
12078 If you leave out the
12082 environment \SpecialChar LaTeX
12083 will substitute the current date (every time you regenerate
12087 \begin_layout Subsubsection
12091 \begin_layout Standard
12092 As I mentioned earlier, there are four ways of starting a new foil.
12093 For portrait foils you should use
12102 The difference between these two environments is the amount of space between
12103 the title of the foil (the foilhead) and the body of the foil.
12106 \begin_layout Standard
12107 Landscape foils are generated using the
12113 ShortRotatefoilhead
12116 Again the only difference is the spacing between foilhead and body.
12117 Both of the short versions have 0.5
12118 \begin_inset space ~
12121 inches less separation between the foilhead and the body.
12125 \begin_layout Standard
12126 One problem with the support for landscape foils is the requirement that
12127 you have to use the
12131 driver to generate the PostScript output otherwise the foils won't be rotated.
12132 It is possible to get landscape foils even if you haven't got the
12136 driver provided you can feed your foils sideways through your printer ;-)
12139 \begin_layout Subsubsection
12140 Theorems, Lemmas, Proofs and more
12143 \begin_layout Standard
12144 Due to a small bug in \SpecialChar LyX
12145 you can't have two of the same type of these environments
12146 directly following each other.
12147 They must be separated by something.
12148 If you try, you will just be extending the previous environment as if you
12149 had merged the two environments together.
12150 So, how do you get around this problem? The simplest option is to insert
12151 some text between the two environments or add a
12156 environment between the two with just a
12157 \begin_inset Quotes eld
12165 \begin_inset Quotes erd
12169 This will force \SpecialChar LyX
12170 to produce two separate environments and hence the correct
12173 An example is provided in the example file included with the \SpecialChar LyX
12175 Remember, this problem only occurs if you are trying to place two of the
12176 same type of theorem-like environments one directly after the other.
12179 \begin_layout Subsubsection
12183 \begin_layout Standard
12184 You get all the commonly supported list styles found in other classes as
12185 well as two new ones.
12186 I'll only describe the new ones here.
12187 If you want to find out more about the other list environments check out
12193 If you intend to use itemized lists you might also want to read about the
12197 \begin_inset space ~
12201 \begin_inset space ~
12206 dialog described above in section
12207 \begin_inset space ~
12211 \begin_inset CommandInset ref
12213 reference "sec:bullet"
12220 \begin_layout Standard
12221 The two new list styles,
12229 , are designed to make it easier for you to create lists of do's and don'ts
12230 or right and wrong by providing dedicated environments that use a tick
12231 or a cross as the label of the list.
12232 These lists are in fact dedicated variants of the
12237 They do however require that you have the
12241 packages installed.
12244 \begin_layout Subsubsection
12248 \begin_layout Standard
12251 Foil\SpecialChar TeX
12254 redefines the floating tables and figures so that they appear exactly where
12255 they are in the text rather than pushing them to the top of the page or
12256 to some user specified location.
12257 In fact if you change the float placement settings they are simply ignored.
12260 \begin_layout Subsubsection
12261 Page Headers and Footers
12262 \begin_inset CommandInset label
12264 name "sec:foilfoot"
12271 \begin_layout Standard
12275 \begin_inset space ~
12284 are two commands used to control the left-footer text string.
12285 The first is meant to allow you to include a graphic logo on your foils
12287 \begin_inset Quotes eld
12292 Foil\SpecialChar TeX
12296 \begin_inset Quotes erd
12300 While the second is meant to provide a classification for the audience,
12304 \begin_inset space \thinspace{}
12310 \begin_inset space \space{}
12314 It is empty by default.
12317 \begin_layout Standard
12318 The remaining page corners can be filled by
12321 \begin_inset space ~
12326 (which defaults to page numbers),
12329 \begin_inset space ~
12337 \begin_inset space ~
12345 \begin_layout Subsection
12348 Foil\SpecialChar TeX
12352 \begin_inset CommandInset label
12354 name "sec:unsuppfoils"
12361 \begin_layout Standard
12362 All the commands mentioned below need to be set in a
12372 within another environment.
12375 \begin_layout Subsubsection
12379 \begin_layout Standard
12380 All lengths are adjusted using the
12403 should be replaced by the name given to the length you want to change and
12408 is the length value.
12409 All lengths should be specified in units of length such as inches (
12421 ) or relative to some document or font-based length such as
12431 \begin_layout Standard
12432 It's possible to change the spacing between a foilhead and the body of the
12433 foil by adjusting the length specified by
12440 For example, to make
12445 \begin_inset space \space{}
12448 in closer to their bodies put the following in the preamble:
12454 foilheadskip}{-0.5in}
12457 \begin_layout Standard
12458 The spacings around floats can be adjusted by setting these lengths:
12461 \begin_layout Labeling
12462 \labelwidthstring MMMMMMMMMMM
12469 Separation between the text and the top of the float
12472 \begin_layout Labeling
12473 \labelwidthstring MMMMMMMMMMM
12480 Separation between the float and the caption
12483 \begin_layout Labeling
12484 \labelwidthstring MMMMMMMMMMM
12491 Separation between the caption and the following text
12494 \begin_layout Labeling
12495 \labelwidthstring MMMMMMMMMMM
12502 You can make the captions narrower than the surrounding text by adjusting
12504 Best done relative to
12513 \begin_layout Standard
12514 There are also several title page related lengths that you may find useful
12515 if you have a long title or several authors:
12518 \begin_layout Labeling
12519 \labelwidthstring MMMMMMMMMMM
12526 Separation from headers to
12531 \begin_layout Labeling
12532 \labelwidthstring MMMMMMMMMMM
12550 \begin_layout Labeling
12551 \labelwidthstring MMMMMMMMMMM
12565 \begin_layout Labeling
12566 \labelwidthstring MMMMMMMMMMM
12582 \begin_layout Labeling
12583 \labelwidthstring MMMMMMMMMMM
12599 \begin_layout Standard
12600 The last length related command affects all the list environments.
12611 a list environment then all the vertical spacing between the list items
12613 Note that this is a command not a length so it doesn't require
12619 like the stuff mentioned above.
12622 \begin_layout Subsubsection
12623 Headers and Footers
12626 \begin_layout Standard
12639 commands control whether the logo in the
12643 definition appear on a given page.
12650 in the preamble then none of the foils will have the logo on them.
12651 If you don't want the logo on a particular page place the
12657 directly after the foilhead of that page and the
12663 directly after the next foilhead.
12666 \begin_layout Standard
12667 If you decide to use the
12671 page style setting in the
12674 \begin_inset space ~
12679 dialog you should probably add
12689 to your preamble so headers and footers on landscape pages are correctly
12690 placed when rotated.
12691 This is due to some clashes between the page layouts provided by the
12702 \begin_layout Section
12703 Hollywood (Hollywood spec scripts)
12706 \begin_layout Standard
12712 \begin_layout Subsection
12716 \begin_layout Standard
12717 Getting the format of a Hollywood script right is a
12718 \begin_inset Quotes eld
12722 \begin_inset Quotes erd
12725 It is designed to make the readers focus on content and to be easy and
12726 familiar for the actors to read.
12727 Each page of a script should be one minute of film.
12728 Nothing goes in a script that you cannot see or hear on screen.
12729 The courier 12 pt font should be used throughout.
12733 \begin_layout Subsection
12737 \begin_layout Standard
12738 Speakers' lines should NEVER break in mid-sentence.
12739 If a speaker's lines continue over a page break, repeat the
12743 title followed by (Cont'd).
12746 \begin_layout Subsection
12750 \begin_layout Standard
12755 names as labels then cross-reference the label to insert the name.
12756 The cross-reference dialog will show the current cast of characters.
12757 You can use this to insert the speaker name in narratives also.
12760 \begin_layout Subsection
12761 Paper size and Margins
12764 \begin_layout Standard
12765 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12768 \begin_layout Subsection
12772 \begin_layout Standard
12773 The following environments are available.
12774 You can use hollywood.bind to get the bind keys shown at the right.
12777 \begin_layout Itemize
12781 \begin_inset Newline newline
12786 Used where nothing else works.
12790 \begin_layout Itemize
12796 \begin_inset space \hfill{}
12804 \begin_inset Newline newline
12807 Usually followed by something like
12808 \begin_inset Quotes eld
12811 on Sally waking up.
12812 \begin_inset Quotes erd
12818 \begin_layout Itemize
12822 \begin_inset space \hfill{}
12826 \begin_inset Newline newline
12831 Introduces a new INTERIOR camera set-up.
12832 Always followed by DAY or NIGHT, or something similar to define the lighting
12834 Everthing on this line in CAPS.
12837 \begin_layout Itemize
12841 \begin_inset space \hfill{}
12845 \begin_inset Newline newline
12850 Introduces a new EXTERIOR camera set-up.
12851 Everthing on this line in CAPS.
12854 \begin_layout Itemize
12858 \begin_inset space \hfill{}
12862 \begin_inset Newline newline
12867 The character speaking.
12870 \begin_layout Itemize
12874 \begin_inset space \hfill{}
12878 \begin_inset Newline newline
12883 Instructions to the speaker.
12884 The () are automatically inserted, but only the ( will show in \SpecialChar LyX
12886 Both will be printed.
12889 \begin_layout Itemize
12893 \begin_inset space \hfill{}
12897 \begin_inset Newline newline
12909 \begin_layout Itemize
12913 \begin_inset space \hfill{}
12917 \begin_inset Newline newline
12922 Camera movement instruction.
12924 \begin_inset space \thinspace{}
12928 \begin_inset space \space{}
12934 \begin_layout Itemize
12938 \begin_inset space \hfill{}
12944 \begin_layout Itemize
12948 \begin_inset space \hfill{}
12954 \begin_layout Itemize
12958 \begin_inset space \hfill{}
12964 \begin_layout Itemize
12968 \begin_inset space \hfill{}
12974 \begin_layout Subsection
12978 \begin_layout Itemize
12982 \begin_layout Itemize
12986 \begin_layout Itemize
12988 \begin_inset space \thinspace{}
12995 \begin_layout Itemize
13000 \begin_layout Itemize
13001 PAN — camera movement
13004 \begin_layout Itemize
13005 INSERT — cut to close-up of
13008 \begin_layout Section
13012 \begin_layout Standard
13015 Panayotis Papasotiriou
13018 \begin_layout Subsection
13022 \begin_layout Standard
13023 The ijmpc package is a set of macros that facilitates electronic manuscript
13026 International Journal of Modern Physics C
13029 Similarly, the ijmpd package is for creating manuscripts to be submitted
13032 International Journal of Modern Physics D
13035 Both journals are published by World Scientific.
13036 The corresponding document classes are named
13045 These files, together with instructions for the authors, can be downloaded
13047 \begin_inset Flex URL
13050 \begin_layout Plain Layout
13052 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
13058 \begin_inset Flex URL
13061 \begin_layout Plain Layout
13063 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
13069 Both packages are modified versions of the standard
13070 \begin_inset Quotes eld
13074 \begin_inset Quotes erd
13077 package, and they are almost (but not exactly) identical.
13078 Most of their features are supported by \SpecialChar LyX
13080 I have used \SpecialChar LyX
13081 successfully to write articles submitted to both journals
13082 without any problem.
13085 \begin_layout Subsection
13089 \begin_layout Standard
13090 As usual, the easiest way to write a paper is to start with a template.
13093 File\SpecialChar menuseparator
13109 This will give an (almost) empty document that includes the most common
13110 fields found in a manuscript.
13111 Simply overwrite the existing text (including the brackets,
13116 You should keep in mind the following remarks.
13119 \begin_layout Enumerate
13121 won't let you change the font size and the page style of the document,
13122 because such modifications are not allowed by both packages.
13125 \begin_layout Enumerate
13126 The language of the document should not be changed.
13127 Before previewing your paper, be sure that the babel package is not used.
13128 To do this, click on
13130 Tools\SpecialChar menuseparator
13141 checkbox in the language settings, and click on
13149 , if you wish to make this change permanent).
13152 \begin_layout Enumerate
13154 \begin_inset Quotes eld
13158 \begin_inset Quotes erd
13161 style must be used to define keywords.
13164 \begin_layout Enumerate
13165 The ijmpc package provides a style named
13166 \begin_inset Quotes eld
13169 Classification Codes
13170 \begin_inset Quotes erd
13173 , which can be used to define classification codes, such as PACS numbers.
13174 Note that this facility is not supported by the ijmpd package.
13177 \begin_layout Enumerate
13178 Several new environments are available:
13179 \begin_inset Quotes eld
13183 \begin_inset Quotes erd
13187 \begin_inset Quotes eld
13191 \begin_inset Quotes erd
13195 \begin_inset Quotes eld
13199 \begin_inset Quotes erd
13203 \begin_inset Quotes eld
13207 \begin_inset Quotes erd
13211 \begin_inset Quotes eld
13215 \begin_inset Quotes erd
13219 \begin_inset Quotes eld
13223 \begin_inset Quotes erd
13227 \begin_inset Quotes eld
13231 \begin_inset Quotes erd
13235 \begin_inset Quotes eld
13239 \begin_inset Quotes erd
13243 \begin_inset Quotes eld
13247 \begin_inset Quotes erd
13251 \begin_inset Quotes eld
13255 \begin_inset Quotes erd
13259 \begin_inset Quotes eld
13263 \begin_inset Quotes erd
13267 \begin_inset Quotes eld
13271 \begin_inset Quotes erd
13275 \begin_inset Quotes eld
13279 \begin_inset Quotes erd
13283 \begin_inset Quotes eld
13287 \begin_inset Quotes erd
13291 Their use is more or less obvious.
13293 supports all these environments; it will use the proper label, text style,
13294 and numbering scheme for each of them.
13297 \begin_layout Enumerate
13298 Both packages use basic citations; the natbib package should not be used.
13299 In \SpecialChar LyX
13300 , citation references are shown as usual; in the output, citations are
13301 shown as superscripts.
13302 If you want to use a citation as normal text, you should use the
13307 \begin_inset space \thinspace{}
13311 \begin_inset space \space{}
13315 \begin_inset Quotes eld
13319 \begin_inset space \space{}
13329 \begin_inset Quotes erd
13335 \begin_layout Enumerate
13337 \begin_inset Quotes eld
13341 \begin_inset Quotes erd
13344 section in both packages.
13345 To put acknowledgments, just use the
13346 \begin_inset Quotes eld
13350 \begin_inset Quotes erd
13356 \begin_layout Enumerate
13357 Appendices may be added to the paper,
13361 the Acknowledgments and
13367 provides a special environment, called
13368 \begin_inset Quotes eld
13372 \begin_inset Quotes erd
13375 which marks the beginning of the appendices.
13376 This environment should be left blank; it just sends a \SpecialChar LaTeX
13377 command, but nothing
13379 In \SpecialChar LyX
13381 \begin_inset Quotes eld
13385 \begin_inset Quotes erd
13388 is printed with blue letters, as a signal that all sections after that
13389 point are appendices.
13390 To write an appendix, use the
13391 \begin_inset Quotes eld
13395 \begin_inset Quotes erd
13400 will number each appendix with capital letters, as required by both journals.
13402 \begin_inset Quotes eld
13406 \begin_inset Quotes erd
13413 be present before the first appendix; if not, all appendices will be numbered
13414 as normal sections in the output.
13417 \begin_layout Enumerate
13418 The ijmpc and the ijmpd packages use the
13422 command to implement table captions.
13423 As a result, a table created by \SpecialChar LyX
13424 is printed correctly, but its caption
13426 However, you can use some \SpecialChar TeX
13427 code to overcome this problem, so that captions
13428 are printed as expected.
13429 To do so, create a float table as usual, remove the caption, and replace
13430 it with the \SpecialChar TeX
13441 (sic); you must also the \SpecialChar TeX
13446 immediately after the tabular material.
13447 Study the example table included in the template files to see how this
13448 trick is implemented.
13449 Alternatively, If you need table captions, you should implement the whole
13454 file, then include this file to the \SpecialChar LyX
13457 Insert\SpecialChar menuseparator
13458 File\SpecialChar menuseparator
13460 \begin_inset space ~
13466 Details on how to create a table float can be found in the files
13474 , included in the corresponding packages.
13477 \begin_layout Subsection
13478 Preparing a paper for submission
13481 \begin_layout Standard
13482 Before you submit your paper you must export the \SpecialChar LyX
13483 document as a \SpecialChar LaTeX
13486 File\SpecialChar menuseparator
13487 Export\SpecialChar menuseparator
13495 \begin_layout Plain Layout
13496 Actually you have the choice between \SpecialChar LaTeX
13497 (plain) and pdflatex.
13498 If you intend to use pdflatex to prepare the paper, you should use the
13499 pdflatex option so that included graphics are converted to PDF format,
13500 ready for use by pdflatex.
13505 , then make the following changes to the resulting
13512 \begin_layout Enumerate
13513 Remove the comment lines before the
13522 \begin_layout Enumerate
13523 Remove everything between (and including) the
13535 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13539 \begin_layout Standard
13544 file should be saved and processed through \SpecialChar LaTeX
13545 as many times as necessary.
13546 You may also want to check the resulting
13553 \begin_layout Subsection
13554 Use of \SpecialChar TeX
13558 \begin_layout Standard
13559 The use of \SpecialChar TeX
13560 code is reduced to two commands, which must be placed at the
13561 top of the document.
13562 If you started writing your paper by using the
13570 template, the \SpecialChar TeX
13571 code needed is already in its place; you usually don't need
13573 You may only modify the first \SpecialChar TeX
13574 code to specify the information printed
13575 to the top of odd and even pages (authors' names and short paper's title,
13577 This \SpecialChar TeX
13578 code must have the form
13582 markboth{Authors' Names}{Short Paper's Title}
13587 \begin_layout Section
13591 \begin_layout Standard
13597 \begin_layout Subsection
13601 \begin_layout Standard
13602 The iopart package provides a document class to create electronic manuscript
13603 submission to the journals published by the Institute of Physics.
13604 Instructions for the authors how to create a paper using the iopart class
13605 can be downloaded together with the iopart package from the site
13606 \begin_inset Flex URL
13609 \begin_layout Plain Layout
13611 ftp://ftp.iop.org/pub/journals/latex2e
13619 \begin_layout Subsection
13623 \begin_layout Standard
13624 The easiest way to write a paper is to start with the file
13628 that is available in \SpecialChar LyX
13629 's examples files folder.
13630 Open this file, save it under a new name, and start writing.
13631 The example file explains how to use the special text environments.
13632 Here are the most important advices:
13635 \begin_layout Itemize
13636 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13639 Use AMS math package
13641 in the document settings under
13648 \begin_layout Itemize
13651 The title environment defines the kind of your paper.
13652 So use one of the following environments for the title:
13656 \begin_layout Itemize
13665 \begin_layout Itemize
13674 \begin_layout Itemize
13680 for a Topical review
13683 \begin_layout Itemize
13692 \begin_layout Itemize
13701 \begin_layout Itemize
13707 for a Paper (same as Title)
13710 \begin_layout Itemize
13716 for a Preliminary communication
13719 \begin_layout Itemize
13725 for a Rapid communication
13728 \begin_layout Itemize
13734 for a Letter to the editor
13738 \begin_layout Itemize
13741 All title environments except of
13745 can have an optional short title.
13748 \begin_layout Itemize
13749 There is a general title environment
13753 which is not directly supported by the \SpecialChar LyX
13755 This can be used as \SpecialChar TeX
13756 code when your document doesn't fit into one of the
13760 \begin_layout Standard
13761 For more informations like hints for special table and formula formatting,
13762 look at the IOP author guidelines.
13765 \begin_layout Section
13769 \begin_layout Standard
13772 Panayotis Papasotiriou
13775 \begin_layout Subsection
13779 \begin_layout Standard
13780 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13781 that facilitates electronic manuscript submission to the journals they
13783 Most known of them (at least in my domain of interest) are
13785 Astrophysics and Space Science
13791 , but there are many others (see a complete list at
13792 \begin_inset Flex URL
13795 \begin_layout Plain Layout
13797 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13803 The Kluwer package may be downloaded from the site
13804 \begin_inset Flex URL
13807 \begin_layout Plain Layout
13809 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13815 A complete user guide is contained in that package (but it can also be
13816 downloaded separately).
13819 \begin_layout Standard
13821 supports many features of the package but not everything.
13822 However, the \SpecialChar TeX
13823 code needed is reduced to some
13824 \begin_inset Quotes eld
13828 \begin_inset Quotes erd
13831 commands of the package (see
13832 \begin_inset space ~
13836 \begin_inset CommandInset ref
13838 reference "subsec:kluwer_peculiarities"
13843 I have recently used \SpecialChar LyX
13844 to write an article submitted to the
13846 Astrophysics and Space Science
13848 without any problem.
13851 \begin_layout Subsection
13855 \begin_layout Standard
13856 The easiest way to write a paper is to start with the Kluwer template file.
13859 File\SpecialChar menuseparator
13871 This will give an (almost) empty document that includes the most common
13872 fields found in a manuscript and a short description of their use.
13873 As in most templates, simply overwrite the existing text (including the
13878 ) with the correct information.
13881 \begin_layout Subsection
13882 Preparing a paper for submission
13885 \begin_layout Standard
13886 As in the AAS\SpecialChar TeX
13887 package, before you submit your paper to a journal you must
13889 \begin_inset Quotes eld
13893 \begin_inset Quotes erd
13899 \begin_layout Enumerate
13900 Export your paper as a \SpecialChar LaTeX
13902 To do this, click on
13904 File\SpecialChar menuseparator
13905 Export\SpecialChar menuseparator
13913 \begin_layout Enumerate
13918 file with a text editor and make the following changes
13922 \begin_layout Enumerate
13923 remove the comment lines before the
13932 \begin_layout Enumerate
13933 remove everything between (and including) the
13945 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13949 \begin_layout Standard
13958 \begin_layout Enumerate
13963 file through \SpecialChar LaTeX
13964 as many times as necessary (usually up to three).
13967 \begin_layout Enumerate
13973 \begin_inset space \thinspace{}
13977 \begin_inset space \space{}
13984 , and check if everything is OK (it should, if you didn't make any mistake).
13987 \begin_layout Subsection
13988 \begin_inset Quotes eld
13992 \begin_inset Quotes erd
13995 of the Kluwer package
13996 \begin_inset CommandInset label
13998 name "subsec:kluwer_peculiarities"
14005 \begin_layout Standard
14006 The Kluwer package has the following
14007 \begin_inset Quotes eld
14011 \begin_inset Quotes erd
14017 \begin_layout Enumerate
14018 It is possible to write multiple articles in the same \SpecialChar LaTeX
14023 \begin_layout Plain Layout
14024 I can't imagine any good reason to do this.
14030 Each article must be included in the environment
14031 \begin_inset Quotes eld
14035 \begin_inset Quotes erd
14039 Unfortunately, this environment cannot be omitted, even if you write just
14041 Therefore, each article starts with the command
14047 and, obviously, ends with the command
14054 Although this can be implemented in \SpecialChar LyX
14055 , I didn't included it, since it looks
14056 ugly and can confuse the novice user.
14057 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
14060 \begin_inset Quotes eld
14065 \begin_inset Quotes erd
14071 \begin_layout Enumerate
14072 Information given at the beginning of the article (i.
14073 \begin_inset space \thinspace{}
14077 \begin_inset space \space{}
14080 title, subtitle, author, institution, running title, running author, abstract
14081 and keywords) must be included in an environment called
14082 \begin_inset Quotes eld
14086 \begin_inset Quotes erd
14090 This is not implemented in \SpecialChar LyX
14091 , so you must enter title, subtitle etc.
14092 \begin_inset space ~
14095 between two \SpecialChar TeX
14111 \begin_layout Enumerate
14112 According to the user manual, the label of each bibliography item must be
14136 \begin_layout Standard
14141 template takes care of all these
14142 \begin_inset Quotes eld
14146 \begin_inset Quotes erd
14150 If you start a new paper using this template you don't need to do anything
14155 \begin_layout Enumerate
14156 don't delete the \SpecialChar TeX
14157 code included in the template, and
14160 \begin_layout Enumerate
14161 copy the example bibliography item included in the template and modify it
14162 as necessary to enter new bibliography items.
14165 \begin_layout Section
14169 \begin_layout Standard
14175 \begin_layout Subsection
14179 \begin_layout Standard
14180 The \SpecialChar LyX
14183 article (koma-script)
14187 report (koma-script)
14205 correspond to the \SpecialChar LaTeX
14223 \begin_inset space ~
14226 of the Koma-Script family.
14227 They are replacements for the standard document classes
14243 , resp., and fit better to European typography conventions in a number of
14247 \begin_layout Itemize
14248 Standard character size is 11pt in
14250 article (koma-script)
14254 report (koma-script)
14262 letter (koma-script)
14267 \begin_layout Itemize
14268 Headings, labels of the description environment, and a number of elements
14271 letter (koma-script)
14273 document class are set in a bold sans serif font.
14277 \begin_layout Plain Layout
14278 There is a big difference between the bold sans serif old cm fonts and new
14279 ec fonts, especially in the appearance of headings.
14280 In comparison, the ec bold sans serif fonts look a bit thin.
14281 Here the \SpecialChar LaTeX
14290 helps to produce the
14291 \begin_inset Quotes eld
14295 \begin_inset Quotes erd
14298 appearance when using the ec fonts.
14303 The numbering of chapter headings is made in the same way as the numbering
14304 of section headings, that is without the extra line
14305 \begin_inset Quotes eld
14308 Chapter\SpecialChar ldots
14310 \begin_inset Quotes erd
14314 In addition, the appearance of the headings can be modified by using a
14315 number of options (in \SpecialChar LyX
14316 to be entered in the field
14319 \begin_inset space ~
14326 Layout\SpecialChar menuseparator
14333 \begin_layout Itemize
14334 The main means in the Koma-Script document classes to design the type area
14343 (in \SpecialChar LyX
14344 to be entered in the extra class options field in the dialog
14346 Document\SpecialChar menuseparator
14350 They make a clearer modification of page margins possible as do the options
14353 Document\SpecialChar menuseparator
14360 \begin_layout Itemize
14361 The \SpecialChar LaTeX
14362 document classes of the Koma-Script family define a number of additional
14364 Those part of it which makes sense in \SpecialChar LyX
14365 is implemented in corresponding
14369 \begin_layout Standard
14370 Detailed descriptions of the \SpecialChar LaTeX
14371 document classes of the Koma-Script family
14372 can be found in the Koma-Script documentation
14383 \begin_layout Subsection
14384 article (koma-script), report (koma-script), and book (koma-script)
14387 \begin_layout Standard
14388 The document classes
14390 article (koma-script)
14394 report (koma-script)
14404 are implemented in the layout files
14417 They contain all the paragraph types of the corresponding standard document
14430 , resp., partly modified, with the exception of the \SpecialChar LyX
14435 -type, which is replaced by the new
14439 -type having the same functionality.
14444 -Type there is a number of new paragraph types added.
14451 letter (koma-script)
14456 \begin_layout Itemize
14465 : are equivalents to
14473 , resp., additionally inserting an entry in the table of contents.
14482 are not contained in
14484 article (koma-script)
14489 \begin_layout Itemize
14498 : behave exactly as
14506 , resp., additionally clearing running heads.
14511 is not contained in
14513 article (koma-script)
14519 \begin_layout Plain Layout
14532 report (koma-script)
14534 , but since this is identical to
14538 , is has not been implemented in \SpecialChar LyX
14547 \begin_layout Itemize
14552 : generates a heading directly above the following paragraph in the standard
14553 character size without affecting the structure of the document.
14556 \begin_layout Itemize
14565 are special captions which respect the different space settings needed
14566 for captions placed above or below an element (if you follow strict typographic
14567 rules, you might want to place table captions always above the table).
14568 You can also use the class option
14572 , which will switch
14585 You need at least Koma-Script version 2.8q to use this.
14588 \begin_layout Itemize
14593 : can be used to set a bonmot, e.
14594 \begin_inset space \thinspace{}
14598 \begin_inset space \space{}
14601 at the beginning of a chapter.
14602 If you use the optional argument (
14604 Insert\SpecialChar menuseparator
14606 \begin_inset space ~
14611 ), you can insert the dictum's author there.
14612 Dictum and author are separated by a line.
14613 You need at least Koma-Script version 2.8q to use this.
14618 is not contained in
14620 article (koma-script)
14625 \begin_layout Standard
14626 The following types, together with the standard types
14638 , form the title area of the document.
14639 They must be entered ahead of the first
14640 \begin_inset Quotes eld
14644 \begin_inset Quotes erd
14651 \begin_layout Plain Layout
14652 The corresponding \SpecialChar LaTeX
14653 commands must appear before the
14664 When such a type is used more than once, the latter usage overwrites the
14665 former one, that means, for every type only the latest usage is valid.
14666 The order of the different types however has, like
14678 , no effect on the appearance of the produced document.
14681 \begin_layout Itemize
14686 : produces a centered paragraph above the ordinary title (
14698 ) for the subject of the document.
14701 \begin_layout Itemize
14706 : produces a centered paragraph below the ordinary title (
14718 ) for the publishers' name.
14721 \begin_layout Itemize
14728 report (koma-script)
14734 produces a centered paragraph on its own page behind the title page, or
14737 article (koma-script)
14739 produces a centered paragraph below the ordinary title (
14755 ) for a dedication.
14758 \begin_layout Itemize
14763 : produces a left aligned paragraph above the ordinary title (
14779 ) for a document`s head.
14782 \begin_layout Itemize
14787 : produces in a double-sided print in
14789 report (koma-script)
14795 a left-aligned paragraph at the top of the title page`s back or has no
14796 effect in a single-sided print or in
14798 article (koma-script)
14803 \begin_layout Itemize
14808 : produces in a double-sided print in
14810 report (koma-script)
14816 a left-aligned paragraph at the bottom of the title page`s back or has
14817 no effect in a single-sided print or in
14819 article (koma-script)
14824 \begin_layout Itemize
14829 : produces a special
14830 \begin_inset Quotes eld
14834 \begin_inset Quotes erd
14837 page ahead of the actual document containing a paragraph without special
14841 \begin_layout Standard
14842 The layout files for the document classes
14844 article (koma-script)
14848 report (koma-script)
14854 do include the file
14859 This is thought of as a place to define your own types.
14864 in your personal layout directory and edit the file!
14867 \begin_layout Subsection
14868 letter (koma-script)
14871 \begin_layout Standard
14875 letter (koma-script)
14877 is implemented in the layout file
14882 It contains all the paragraph types of the corresponding standard document
14887 , partly modified, with the exception of the \SpecialChar LyX
14901 type, which is replaced by the new
14906 In addition, it contains, in contrast to the standard document class, the
14925 Furthermore, there are a number of new letter specific types.
14928 \begin_layout Standard
14929 The appearance of the letter produced by this document class can be controlled
14930 by a number of \SpecialChar LaTeX
14931 commands, which you can put in the \SpecialChar LaTeX
14936 \begin_layout Plain Layout
14937 For example, the standard appearance of the letter`s heading, consisting
14938 of name and address, is quite self-willed.
14940 \begin_inset Quotes eld
14944 \begin_inset Quotes erd
14947 heading is produced by the following \SpecialChar LaTeX
14948 commands in the preamble:
14951 \begin_layout LyX-Code
14961 \begin_layout LyX-Code
14977 \begin_layout LyX-Code
14987 \begin_layout LyX-Code
15007 A detailed German description of such \SpecialChar LaTeX
15008 commands can be found in the Koma-Script
15014 With it, the letter's author can produce his personal letter layout.
15017 \begin_layout Standard
15026 define the beginning of the letter and must be used in every letter.
15027 To emphasize them in the \SpecialChar LyX
15028 document class, they are marked with the letter
15038 \begin_inset space ~
15041 in the left margin.
15042 It is possible to write any number of letters in one file.
15047 type produces a new letter using the same addressee and a
15051 type produces a new addressee.
15068 are ordinary paragraph types and can also be used several times in one
15069 and the same letter.
15072 \begin_layout Itemize
15077 : produces a paragraph for the addressee and implicitly defines the beginning
15081 \begin_layout Itemize
15086 : produces a paragraph for the form of address and implicitly produces a
15090 \begin_layout Itemize
15095 : produces a paragraph for a close.
15098 \begin_layout Itemize
15103 : produces a paragraph for a postscript.
15106 \begin_layout Itemize
15111 : produces a paragraph for a distribution list.
15114 \begin_layout Itemize
15119 : produces a paragraph for enclosures.
15122 \begin_layout Standard
15163 are input types provided with a label to enter information, which will
15164 be processed by the document class.
15168 \begin_layout Plain Layout
15169 It could be seen as a matter of inconsequence, that the types
15177 described above are not such input types as well.
15178 Because of the special meaning of those types, however, I have implemented
15179 them as ordinary paragraph types with a one letter mark in the left margin.
15180 Moreover, it would affect my feeling of symmetry, if the
15188 type had such a serious different appearance.
15193 The types must be used ahead of the corresponding
15200 \begin_layout Standard
15201 An implementation of these types in a WYSIWYG fashion does not seem to make
15202 sense, because the real appearance of the produced letter does not only
15203 depend on the usage of the particular type, but also on other factors.
15204 For example, a signature entered in the
15208 type will in the standard behavior appear in the produced letter only,
15209 when in the same letter also a
15214 The entered value of the
15218 type will in the standard behavior not appear in the produced letter at
15220 The possibility to design the letter`s heading freely is already indicated
15221 in a footnote above.
15224 \begin_layout Standard
15225 The input types can also be used as empty paragraphs.
15226 This makes sense e.
15227 \begin_inset space \thinspace{}
15231 \begin_inset space \space{}
15243 type is not used at all, in the standard behavior the value of the
15247 type is used as signature, whereas if an empty
15251 type is used, no signature value is defined.
15254 \begin_layout Standard
15255 By using the input types it is possible to write a letter template, containing
15256 filled input types with your personal dates (name, address, etc.) and empty
15257 input types for other dates you want to enter.
15260 \begin_layout Itemize
15265 : sender's name, in the standard behavior appears as a centered paragraph
15266 in small caps in the letter`s heading.
15269 \begin_layout Itemize
15274 : sender's signature, in the standard behavior appears below the
15283 type is used, the value of the
15287 type appears instead.
15290 \begin_layout Itemize
15295 : sender's address, in the standard behavior appears in a centered paragraph
15296 in the letter`s heading below the sender's name.
15299 \begin_layout Itemize
15304 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15315 \begin_layout Itemize
15320 : place of the letter`s making.
15323 \begin_layout Itemize
15328 : date of the letter`s making.
15337 , in the standard behavior, produce the place and the date in a right-aligned
15338 line below the addressee's field.
15343 type is used, neither place nor date appear, independent of the value of
15353 type is used, the date of the letter `s production is used.
15356 \begin_layout Itemize
15361 : sender`s back address, in the standard behavior appears above the addressee's
15362 field in a small sans serif font.
15365 \begin_layout Itemize
15370 : special mail information, in the standard behavior appears underlined
15371 above the addressee's field below the back address.
15374 \begin_layout Itemize
15379 : additional information, in the standard behavior appears on right side
15380 below the addressee`s field.
15383 \begin_layout Itemize
15388 : the letter's title, in the standard behavior appears in a big, bold, sans
15389 serif font above the subject.
15392 \begin_layout Itemize
15397 : the letter's subject, in the standard behavior appears in a bold font
15405 \begin_layout Standard
15426 produce a business letter like line above the
15430 line containing the fields
15431 \begin_inset Quotes eld
15435 \begin_inset Quotes erd
15439 \begin_inset Quotes eld
15443 \begin_inset Quotes erd
15447 \begin_inset Quotes eld
15451 \begin_inset Quotes erd
15455 \begin_inset Quotes eld
15459 \begin_inset Quotes erd
15463 \begin_inset Quotes eld
15467 \begin_inset Quotes erd
15471 \begin_inset Quotes eld
15475 \begin_inset Quotes erd
15479 For the date field, the value of the
15485 \begin_inset Quotes eld
15488 business letter types
15489 \begin_inset Quotes erd
15492 is used, the value of the
15496 type however does not appear, but only the \SpecialChar LaTeX
15504 The ordinary output of place and date in a right-aligned line below the
15505 addressee`s field is suppressed.
15506 The types are implemented as input types provided with a label and must
15507 be used ahead of the corresponding
15514 \begin_layout Itemize
15522 \begin_layout Itemize
15530 \begin_layout Itemize
15538 \begin_layout Itemize
15546 \begin_layout Itemize
15554 \begin_layout Subsection
15555 The new letter class: letter (koma-script v.2)
15558 \begin_layout Standard
15564 \begin_layout Standard
15565 \begin_inset VSpace medskip
15571 \begin_layout Standard
15573 Koma-Script version 2.8 has introduced a new letter class
15577 which supersedes the now unsupported
15582 It has — on the \SpecialChar LaTeX
15583 side — a completely new interface and is not compatible
15584 with the old class.
15585 Therefore, \SpecialChar LyX
15586 supports both, though it is recommended you use the new class.
15589 \begin_layout Standard
15590 This class covers the same functionality as
15592 letter (koma-script),
15595 The basic items are
15599 (receiver's address, same as
15603 in the old layout),
15616 will start a new letter (i.
15617 \begin_inset space \thinspace{}
15621 \begin_inset space \space{}
15624 you can write several letters per document).
15625 New elements are sender's
15641 and the possibility to use a
15647 Insert\SpecialChar menuseparator
15653 \begin_layout Standard
15654 The biggest improvement is, though, that the letter's layout is configurable
15655 to meet almost any needs.
15656 This can be done via the preamble or with a special style file (Letter
15657 Class Option, extension
15661 ), that will be read in as a class option.
15665 \begin_layout Plain Layout
15666 The KOMA package comes with some default
15671 There is, for instance, a
15675 file that follows german typesetting rules, or a
15679 that provides the default layout of the old
15684 The latter can be loaded with the class option
15690 Layout\SpecialChar menuseparator
15691 Document\SpecialChar menuseparator
15703 template that is included in \SpecialChar LyX
15705 A detailed description is to be found in the Koma-Script documentation
15713 \begin_layout Subsection
15717 \begin_layout Standard
15718 Visualizing the Koma-Script document classes in \SpecialChar LyX
15719 , the \SpecialChar LyX
15720 internals cause some
15724 \begin_layout Itemize
15725 The chapter number of a
15729 type appears on a line of its own above the chapter heading instead of
15730 appearing in the same line ahead of it.
15731 The cause for that is the \SpecialChar LyX
15732 internal behavior for the labeltype
15736 in the layout file.
15739 \begin_layout Itemize
15740 The headings of the types
15748 are only put in the
15749 \begin_inset Quotes eld
15753 \begin_inset Quotes erd
15757 table of contents, but not in the \SpecialChar LyX
15758 table of contents (
15760 Document\SpecialChar menuseparator
15762 \begin_inset space ~
15766 \begin_inset space ~
15774 \begin_layout Itemize
15775 The paragraphs in a
15779 document class appear in a skip separation mode, not indented.
15780 This is the standard behavior, no special \SpecialChar LaTeX
15781 commands are needed for that.
15784 Document\SpecialChar menuseparator
15787 dialog the corresponding radio button indicates
15796 value always has the effect that extra \SpecialChar LaTeX
15797 commands are inserted in the document
15798 to produce the gap, which is not what is wanted in this case.
15801 \begin_layout Section
15805 \begin_layout Standard
15811 \begin_layout Subsection
15815 \begin_layout Standard
15816 Memoir is a very powerful and constantly evolving class.
15817 It has been designed with regard to fictional and non-fictional literature.
15818 Its aim is to let the user have maximum control over the typesetting of
15820 Memoir is based on the standard book class, but it can also emulate the
15821 article class (see below).
15824 \begin_layout Standard
15825 Peter Wilson, the developer of Memoir, is known as the author of lots of
15826 useful packages in the \SpecialChar LaTeX
15828 Most of them have been merged with Memoir.
15829 Therefore, it is much easier to layout the table of contents, appendices,
15830 chapter designs and such.
15832 , though, does not support all of these goodies natively.
15833 Some of them might be added to forthcoming releases
15837 \begin_layout Plain Layout
15838 You are invited to send suggestions to
15839 \begin_inset Flex URL
15842 \begin_layout Plain Layout
15844 lyx-devel@lists.lyx.org
15854 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15856 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15858 commands (\SpecialChar TeX
15863 \begin_layout Plain Layout
15868 \begin_layout Plain Layout
15878 \begin_inset space ~
15882 \begin_inset CommandInset ref
15884 reference "sec:Inserting-TeX-Code"
15894 In this section, we can only list those features that are natively supported
15895 by \SpecialChar LyX
15897 For detailed descriptions (and for the rest of features) we recommend you
15898 have a look at the detailed manual of the Memoir class
15902 \begin_layout Plain Layout
15907 \begin_layout Plain Layout
15917 \begin_inset Flex URL
15920 \begin_layout Plain Layout
15922 CTAN:/macros/latex/memoir/memman.pdf
15932 , which is not only a user guide for the class, but also both a comprehensive
15933 description on good typesetting and a superb example for good typesetting
15937 \begin_layout Subsection
15938 Basic features and restrictions
15941 \begin_layout Standard
15942 Memoir supports basically all features of the standard book classes.
15943 There are, however, some differences, as follows:
15946 \begin_layout Description
15948 \begin_inset space ~
15951 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15954 \begin_layout Description
15956 \begin_inset space ~
15959 style: The fancy page style is not supported, due to a command clash between
15960 Memoir and the fancyhdr package (they both define a command with the same
15961 name, which confuses \SpecialChar LaTeX
15963 Instead, Memoir comes with a number of its own page styles (see
15965 Layout\SpecialChar menuseparator
15966 Document\SpecialChar menuseparator
15968 \begin_inset space ~
15974 If you want to use these for the chapter pages, you have to use the command
15981 in the main text or in preamble (e.
15982 \begin_inset space \thinspace{}
15986 \begin_inset space \space{}
15993 chapterstyle{companion}
15998 \begin_layout Description
15999 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
16000 optional argument in the standard classes.
16001 With this, you can specify an alternative version of the title for the
16002 table of contents and the headers (for instance, if the title is too long).
16003 In \SpecialChar LyX
16004 , you can do this via
16006 Insert\SpecialChar menuseparator
16008 \begin_inset space ~
16013 at the beginning of a chapter/section.
16014 Memoir features a second optional argument and thus separates the table
16015 of contents from the header.
16016 You can define three variants of a title with this: one for the main text,
16017 one for the table of contents, and one for the headers.
16018 Simply insert two optional arguments if you need this feature, the first
16019 one containing the short title for the Table of Contents, the second one
16020 containing an alternative short title for the headers.
16023 \begin_layout Description
16024 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
16025 of contents, the list of figures and the list of table start a new page
16027 Memoir does not follow this route.
16028 You have to insert a page break yourself, if you want to have one.
16031 \begin_layout Description
16032 Titlepage: For some unknown reason, Memoir uses pagination on the title
16033 page (in the standard classes, title pages are
16034 \begin_inset Quotes eld
16038 \begin_inset Quotes erd
16042 If you want an empty title page, type
16046 aliaspagestyle{title}{empty}
16051 \begin_layout Description
16052 Article: With the class option
16058 Layout\SpecialChar menuseparator
16059 Document\SpecialChar menuseparator
16061 \begin_inset space ~
16066 ), you can emulate article style.
16067 That is, counters (footnotes, figures, tables etc.) will not be reset on
16068 new chapters, chapters don't start a new page (but are—in contrary to
16069 \begin_inset Quotes eld
16073 \begin_inset Quotes erd
16076 article classes—still allowed), parts, though, use their own page, as in
16080 \begin_layout Description
16081 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
16082 font commands, which have been used in the old \SpecialChar LaTeX
16084 \begin_inset space \thinspace{}
16088 \begin_inset space \space{}
16104 It produces an error and stops \SpecialChar LaTeX
16105 whenever such a command appears.
16110 reallows the commands and spits out warnings instead (which does at least
16111 not stop \SpecialChar LaTeX
16113 Since a lot of packages and particularly Bib\SpecialChar TeX
16114 style files are still using
16115 those commands, we have decided to use this option by default.
16118 \begin_layout Subsection
16122 \begin_layout Standard
16123 We will only describe the features supported by \SpecialChar LyX
16124 (which is not much currently).
16125 Please consult the Memoir manual
16129 \begin_layout Plain Layout
16134 \begin_layout Plain Layout
16144 \begin_inset Flex URL
16147 \begin_layout Plain Layout
16149 CTAN:/macros/latex/memoir/memman.pdf
16162 \begin_layout Description
16163 Abstract: You may wonder why an abstract is an extra feature.
16164 Well, it is in book class.
16165 Usually books don't have abstracts.
16166 Memoir, however, has.
16167 You can use it wherever and how often you like.
16170 \begin_layout Description
16171 Chapterprecis: You may know this older typesetting style: The contents of
16172 a chapter are summarized below the title and also in the table of contents
16174 \begin_inset space \thinspace{}
16178 \begin_inset space \space{}
16183 Our hero arrives in Troia; he loses some friends; he finds others
16186 Chapterprecis does exactly this.
16187 It is therefore only sensible below a chapter.
16190 \begin_layout Description
16191 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16192 The epigraph environment provides an elegant way of typesetting such a
16194 The motto itself (text) and its author (source) are divided by a short
16196 Unfortunately, we have to fool \SpecialChar LyX
16197 a bit here again, since the environment
16198 needs two arguments (text and source).
16199 In this case, we have to use curly brackets (in \SpecialChar TeX
16200 mode) between the two
16211 <author of the slogan>.
16214 \begin_layout Description
16215 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16216 complex figurative poems).
16218 can only support a few of them.
16219 One is poemtitle, which is a centered title for poems, which will also
16220 be added to the table of contents (verse is the standard environment for
16222 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16224 because they have to be nested inside regular verse environments, which
16225 is not possible with \SpecialChar LyX
16229 \begin_layout Description
16230 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16233 \begin_layout Section
16234 Article (mwart), book (mwbk) and report (mwrep)
16235 \begin_inset Argument status
16238 \begin_layout Plain Layout
16251 \begin_layout Standard
16257 \begin_layout Standard
16258 The \SpecialChar LyX
16275 correspond to the \SpecialChar LaTeX
16289 They are replacements for the standard document classes
16301 , resp., and fit better to Polish typography conventions in a number of points.
16305 \begin_layout Standard
16309 \begin_layout Itemize
16310 Unnumbered titles (with star, e.
16311 \begin_inset space \thinspace{}
16315 \begin_inset space \space{}
16322 ) are added into table of contents,
16325 \begin_layout Itemize
16326 Additional page styles:
16330 \begin_layout Description
16331 uheadings header with separated lines,
16334 \begin_layout Description
16335 myheadings custom header, contents headers via commands:
16350 \begin_layout Description
16351 myuheadings custom header with separated lines,
16354 \begin_layout Description
16355 outer page number is placed on outer side of page
16359 \begin_layout Itemize
16364 \begin_layout Description
16365 rmheadings serif titles — default,
16368 \begin_layout Description
16369 sfheadings sansserif titles,
16372 \begin_layout Description
16373 authortitle on title page first placed is author next title — default,
16376 \begin_layout Description
16377 titleauthor on title page first placed is title next author,
16380 \begin_layout Description
16381 withmarginpar reserve place on page for margins.
16385 \begin_layout Section
16389 \begin_layout Standard
16394 provides an alternative to the standard
16399 It provides similar functionality, but you might prefer this layout with
16400 sans serif sections, headings, and more.
16403 \begin_layout Section
16404 Rev\SpecialChar TeX
16408 \begin_layout Standard
16414 \begin_layout Standard
16415 \begin_inset VSpace bigskip
16421 \begin_layout Standard
16426 \begin_inset space ~
16431 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16433 \begin_inset Formula $\beta$
16436 release of May, 1999) class.
16439 \begin_layout Standard
16445 textclass, which works with Rev\SpecialChar TeX
16447 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16449 That means that it doesn't interact very well with \SpecialChar LyX
16450 , which requires \SpecialChar LaTeX2e
16452 it has been kludged to work.
16453 Since Rev\SpecialChar TeX
16454 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16459 Rev\SpecialChar TeX
16461 \begin_inset space ~
16466 textclass should also be pretty easy to use.
16469 \begin_layout Standard
16470 These documents are supposed to be used in
16474 to the Rev\SpecialChar TeX
16475 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16477 and assume you'll know what to put in the preamble if necessary.
16480 \begin_layout Subsection
16484 \begin_layout Standard
16485 All you need to do is install Rev\SpecialChar TeX
16486 4, as described in the package's README
16488 The package can be found at The Rev\SpecialChar TeX
16490 \begin_inset Flex URL
16493 \begin_layout Plain Layout
16495 http://publish.aps.org/revtex4/
16501 Install it somewhere that \SpecialChar LaTeX
16503 Test it by trying to \SpecialChar LaTeX
16504 a short Rev\SpecialChar TeX
16505 4 document in some random directory (i.
16506 \begin_inset space \thinspace{}
16510 \begin_inset space \space{}
16513 not the directory where you installed the class file.) Then, if you reconfigure
16515 , it will find the class file and let you use the Rev\SpecialChar TeX
16519 \begin_layout Standard
16520 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16529 \begin_inset space ~
16534 template, found in the templates directory.
16537 \begin_layout Subsection
16541 \begin_layout Standard
16542 Optional arguments to
16549 \begin_inset Quotes eld
16553 \begin_inset Quotes erd
16557 \begin_inset Quotes eld
16561 \begin_inset Quotes erd
16567 \begin_inset space ~
16575 \begin_inset space ~
16581 Remember that in Rev\SpecialChar TeX
16582 , at least one optional argument is required!
16585 \begin_layout Standard
16586 Other preamble matter, like
16593 \begin_inset space ~
16600 \begin_inset space ~
16605 dialog, also as usual.
16608 \begin_layout Subsection
16612 \begin_layout Standard
16613 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16615 For example, the Email layout corresponds to
16622 Note that (at least as of Rev\SpecialChar TeX
16631 layouts are exactly equivalent, so you shouldn't need to use both.
16635 \begin_layout Plain Layout
16636 In case you're curious, both were included so that
16640 would be able to translate both
16660 \begin_layout Subsection
16664 \begin_layout Standard
16665 There are a couple of important unique aspects of Rev\SpecialChar TeX
16666 4 which might cause
16667 bugs that will be even more confusing in \SpecialChar LyX
16671 \begin_layout Standard
16672 In Rev\SpecialChar TeX
16690 The \SpecialChar LyX
16691 equivalent is that there is a separate Thanks layout.
16696 write footnotes in the
16700 layout, or weird things may happen.
16701 See the Rev\SpecialChar TeX
16702 4 documentation for more details.
16705 \begin_layout Standard
16709 \begin_inset space ~
16717 \begin_inset space ~
16726 layouts must be placed
16734 layout and the corresponding
16751 , the \SpecialChar LaTeX
16755 \begin_layout Subsection
16759 \begin_layout Standard
16760 The main problem with this layout is that you can't use the optional arguments
16761 to layouts like Email and Title.
16762 (The problem is not unique to this layout; you can't use optional arguments
16763 to the Section layouts either.) This means that after you export that file
16764 to \SpecialChar LaTeX
16765 (which you'll need to do eventually to send it in to APS), you'll need
16766 to edit the \SpecialChar LaTeX
16767 file with a text editor to add the optional arguments to set,
16769 \begin_inset space \thinspace{}
16773 \begin_inset space \space{}
16776 the running title for the page headers.
16777 Lacking these layouts makes the
16783 (and the equivalent
16789 ) useless, so the corresponding layouts don't exist, and will have to be
16794 \begin_layout Plain Layout
16799 actually, \SpecialChar LyX
16800 1.3.0 supports some forms of optional arguments, but this layout
16801 has not been updated yet to take advantage of it.
16809 \begin_layout Section
16810 Springer Journals (
16817 \begin_layout Standard
16823 \begin_layout Subsection
16827 \begin_layout Standard
16828 These are the layout files for some of the journal formats used by Springer
16829 Verlag and listed on
16830 \begin_inset Flex URL
16833 \begin_layout Plain Layout
16835 http://www.springer.de/author/tex/help-journals.html
16840 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16842 It is a modular system: the things common to all journals are implemented
16847 , which journal-specific layout files (such as, e.
16848 \begin_inset space \thinspace{}
16852 \begin_inset space \space{}
16859 for Journal of Geodesy) can include.
16862 \begin_layout Standard
16863 This means that implementing support for any other Springer journal on this
16864 list is as simple as writing your own
16872 file following the outline given in
16880 \begin_layout Standard
16881 It is reasonably well tested only for the Journal of Geodesy.
16890 come with the standard \SpecialChar LyX
16892 Install the relevant class file (downloaded from Springer) in a proper
16893 directory, reconfigure \SpecialChar LaTeX
16894 (in the te\SpecialChar TeX
16899 , as root if necessary — doesn't \SpecialChar LyX
16900 take care of this?), reconfigure \SpecialChar LyX
16905 \begin_layout Subsection
16909 \begin_layout Standard
16910 A large number of theorem-like styles —
16922 \begin_layout Standard
16925 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16926 _Title, Author_Running, Institute,
16927 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16930 See the Springer class file documentation for details.
16933 \begin_layout Subsection
16937 \begin_layout Itemize
16949 \begin_layout Itemize
16952 Probability Theory and Related Fields
16958 — Jean-Marc Lasgouttes
16961 \begin_layout Standard
16962 Add your own, it isn't so hard!
16965 \begin_layout Subsection
16969 \begin_layout Standard
16970 These files are partly based on the older
16974 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16976 file from Springer.
16981 layout, are now defunct.
16982 Jean-Marc Lasgouttes helped out big in making me find my way around the
16984 layout file mechanism.
16987 \begin_layout Subsection
16991 \begin_layout Standard
16993 But probably less than in the old hacked-\SpecialChar LaTeX
17001 \begin_layout Standard
17003 \begin_inset space \thinspace{}
17006 g.: does not display the number for theorem-like layouts, just #.
17009 \begin_layout Section
17012 Sli\SpecialChar TeX
17016 \begin_inset CommandInset label
17025 \begin_layout Standard
17033 \begin_layout Subsection
17037 \begin_layout Standard
17038 This section describes how to use \SpecialChar LyX
17039 to make slides for overhead projectors.
17040 There are two document classes that can do this: the default slides class
17043 Foil\SpecialChar TeX
17047 This section documents the former.
17050 \begin_layout Standard
17051 I'm going to say this again, nice and clear, so that there's no misunderstanding
17055 \begin_layout Standard
17056 \begin_inset VSpace bigskip
17062 \begin_layout Standard
17066 This section documents the class
17067 \begin_inset Quotes eld
17075 \begin_inset Quotes erd
17083 \begin_layout Standard
17084 \begin_inset VSpace bigskip
17090 \begin_layout Standard
17091 If you're looking for the documentation for
17092 \begin_inset Quotes eld
17097 slides (Foil\SpecialChar TeX
17101 \begin_inset Quotes erd
17104 , check out section
17105 \begin_inset space ~
17109 \begin_inset CommandInset ref
17111 reference "sec:foiltex"
17121 \begin_inset Quotes eld
17126 slides (Foil\SpecialChar TeX
17130 \begin_inset Quotes erd
17133 ] is actually somewhat better than the default
17141 \begin_layout Plain Layout
17143 or so I've been told repeatedly by its advocates.
17144 Having never used it, I have no idea if this claim is true or not.
17149 which this section documents.
17152 \begin_layout Standard
17153 This class is the \SpecialChar LaTeX2e
17154 improvement of the old
17156 Sli\SpecialChar TeX
17160 Every \SpecialChar LaTeX2e
17161 distribution includes this class [which I'll just refer to as
17162 \begin_inset Quotes eld
17170 \begin_inset Quotes erd
17173 from now on], so you're bound to have it.
17174 As I noted earlier, there are other classes, such as
17178 , which also produce slides for overhead projectors and do a better job
17180 However, there are some things which
17184 can do which the others can't, such as generate overlays.
17185 Read on to learn more!
17188 \begin_layout Subsection
17190 \begin_inset CommandInset label
17192 name "sec:slidesetup"
17199 \begin_layout Standard
17200 Obviously, to use this document class, you need to select
17201 \begin_inset Quotes eld
17209 \begin_inset Quotes erd
17212 from the class list in the
17214 Document\SpecialChar menuseparator
17218 There are some other special things you should know about this class:
17221 \begin_layout Itemize
17222 Don't bother changing the options
17227 They're not supported by the
17234 \begin_layout Itemize
17238 \begin_inset space ~
17243 behaves a bit differently for this class.
17244 The possible choices and what they do are as follows:
17248 \begin_layout Description
17253 The final output contains page numbers in the lower right corner.
17256 \begin_layout Description
17265 , but also prints out any time markers you've put in.
17266 This is the default.
17269 \begin_layout Description
17274 The final output contains no page numbers, time markers, or alignment markers.
17278 \begin_layout Itemize
17283 class has an extra option:
17289 \begin_inset Quotes eld
17297 \begin_inset Quotes erd
17300 in the extra class options.
17304 \begin_layout Standard
17305 Using this options allows you to add time markers to
17311 \begin_inset space ~
17315 \begin_inset CommandInset ref
17317 reference "sec:slideNote"
17325 \begin_layout Standard
17326 You can also use the template file
17327 \begin_inset Quotes eld
17335 \begin_inset Quotes erd
17338 to automatically set up a document to use the
17344 File\SpecialChar menuseparator
17346 \begin_inset space ~
17350 \begin_inset space ~
17355 to open your new document].
17356 The template file also contains some examples of the special paragraph
17357 environments used by this class.
17358 I'll describe those next.
17361 \begin_layout Subsection
17362 Paragraph Environments
17365 \begin_layout Subsubsection
17366 Supported Environments
17369 \begin_layout Standard
17370 The first thing you'll notice when you start up a new
17374 document is the font size and type: it's the equivalent of the size
17375 \begin_inset Quotes eld
17383 \begin_inset Quotes erd
17389 \begin_inset space ~
17395 This is also what's used in the output.
17397 \begin_inset Quotes eld
17401 \begin_inset Quotes erd
17404 to remind you that this is a slide.
17405 Your final slides will use a larger font; ergo, you'll have less space.
17406 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17409 \begin_layout Standard
17410 The next thing that becomes obvious is the changes to the paragraph environment
17411 pull-down box [at the far-left end of the toolbar].
17412 Most of the paragraph environments you're used to seeing are missing.
17413 There are also five new ones.
17418 class itself only supports certain paragraph environments:
17421 \begin_layout Itemize
17427 \begin_layout Itemize
17433 \begin_layout Itemize
17439 \begin_layout Itemize
17445 \begin_layout Itemize
17451 \begin_layout Itemize
17457 \begin_layout Itemize
17463 \begin_layout Itemize
17469 \begin_layout Itemize
17475 \begin_layout Itemize
17482 \begin_layout Itemize
17488 \begin_layout Standard
17489 All of the other standard environments, including the section-heading environmen
17490 ts, aren't used in the
17497 \begin_layout Standard
17498 On the other hand, you'll notice the following new environments:
17501 \begin_layout Itemize
17507 \begin_layout Itemize
17513 \begin_layout Itemize
17519 \begin_layout Itemize
17525 \begin_layout Itemize
17531 \begin_layout Standard
17532 These five are kind of quirky, due to a
17533 \begin_inset Quotes eld
17537 \begin_inset Quotes erd
17540 in \SpecialChar LyX
17542 You see, \SpecialChar LyX
17543 doesn't permit you to nest any other paragraph environment into
17544 an empty environment.
17545 Now, that's fine and dandy, but it means that you wouldn't be able to start
17546 a slide with anything except plain text.
17547 To deal with this, I've performed a little
17548 \begin_inset Quotes eld
17553 \begin_inset Quotes erd
17559 \begin_layout Subsubsection
17560 Quirks of the New Environments
17561 \begin_inset CommandInset label
17563 name "sec:slideQuirk"
17570 \begin_layout Standard
17571 All five of the new paragraph environments are somewhat quirky due to inherent
17572 limitiations in the current version of \SpecialChar LyX
17574 As I just mentioned, \SpecialChar LyX
17575 forbids environments that begin with another environment.
17576 To get around this, the
17580 environment isn't a paragraph environment as described in the
17588 \begin_layout Standard
17589 You should consider
17602 \begin_inset Quotes eld
17605 pseudo-environments.
17606 \begin_inset Quotes erd
17609 They look like a section heading or a
17610 \begin_inset Quotes eld
17618 \begin_inset Quotes erd
17621 but really begin a [and, if necessary, end the previous] paragraph environment.
17631 \begin_inset Quotes eld
17635 \begin_inset Quotes erd
17638 These two perform some action.
17641 \begin_layout Standard
17642 A common feature of all five environments,
17662 , is a rather long-ish label.
17663 The text following this label — ordinarily the contents of the paragraph
17664 environment — is utterly irrelevant for
17686 completely ignores it.
17687 In fact, you can leave these five environments completely empty.
17691 \begin_layout Standard
17696 to put any text after the rather long-ish label, you might want to.
17697 This could be a short description of the contents of the
17702 In that case, enter your descriptive comment and hit
17706 as you normally would.
17709 \begin_layout Standard
17710 If, on the other hand, you don't want to enter any descriptive text, you'll
17711 hit another \SpecialChar LyX
17714 , like nature, abhors a vacuum, and will not let you start a new paragraph
17715 environment until you put something in the old one.
17719 \begin_layout Itemize
17720 Start entering the text that will
17748 \begin_layout Itemize
17749 Now move to the beginning of that paragraph.
17753 \begin_layout Itemize
17762 \begin_layout Itemize
17763 Finally, change this new, empty paragraph to a
17787 \begin_layout Standard
17788 Some future version of \SpecialChar LyX
17789 will, hopefully, resolve this quirkiness\SpecialChar ldots
17793 \begin_layout Subsection
17794 Making a Presentation with
17807 \begin_layout Subsubsection
17815 \begin_layout Standard
17816 If you're expecting this section to teach you how to actually make a presentatio
17817 n, you'll be sorely disappointed.
17818 Naturally, I'll describe all of the ways the
17822 class can assist you in preparing the materials for a presentation.
17823 Filling in the contents, however, is up to you.
17828 the \SpecialChar LyX
17832 \begin_layout Standard
17837 environment [in the manner described in section
17838 \begin_inset space ~
17842 \begin_inset CommandInset ref
17844 reference "sec:slideQuirk"
17848 ] tells \SpecialChar LyX
17849 to begin a new slide [duh].
17850 The label for this environment/
17851 \begin_inset Quotes erd
17855 \begin_inset Quotes erd
17859 \begin_inset Quotes eld
17863 \begin_inset Quotes erd
17866 in cool blue, followed by the label,
17867 \begin_inset Quotes eld
17871 \begin_inset Quotes erd
17875 Any text or paragraph environments that follow this one go on the new slide.
17879 \begin_layout Standard
17880 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17882 (this can be specified in the
17887 In fact, you'll want to, once you finish entering the contents of one slide.
17888 If you've entered more text than can physically fit on a slide, the extra
17889 overflows onto a new slide.
17890 I don't recommend doing this, however, since the overflow slide won't have
17891 any page number on it.
17892 Furthermore, it may interfere with any
17896 you've made to accompany the oversized
17903 \begin_layout Standard
17912 environments work the same way as the
17917 They both create an
17918 \begin_inset Quotes eld
17922 \begin_inset Quotes erd
17925 followed by a label [
17926 \begin_inset Quotes eld
17930 \begin_inset Quotes erd
17934 \begin_inset Quotes eld
17938 \begin_inset Quotes erd
17942 The color is a stunning magenta instead of blue, and the
17943 \begin_inset Quotes eld
17947 \begin_inset Quotes erd
17950 will look different, in style and in length.
17951 The label fonts of all three also differ from one another.
17954 \begin_layout Standard
17959 , if the contents of a
17967 exceed the physical size of a slide or sheet of paper, the extra will overflow
17969 Again, you should avoid this.
17970 It defeats the whole purpose of
17981 \begin_layout Subsubsection
17991 \begin_layout Standard
17996 is a slide that sits atop another slide.
17997 Perhaps you wish to discuss a figure on the main
18001 before displaying the text associated with it.
18002 One way to accomplish this is tape a flap of dark paper over the part of
18007 you want to display later.
18008 This method fails, however, if you wish to overlap one graph with another,
18010 You would then have to fumble while speaking to align the two separate,
18015 s to align the two graphs.
18020 environment in both cases makes life much easier.
18023 \begin_layout Standard
18028 receives the page number of its
18029 \begin_inset Quotes eld
18033 \begin_inset Quotes erd
18041 \begin_inset Quotes eld
18049 \begin_inset Quotes erd
18056 \begin_layout Plain Layout
18057 Presumably, mutliple
18062 \begin_inset Quotes eld
18070 \begin_inset Quotes erd
18074 \begin_inset Quotes eld
18082 \begin_inset Quotes erd
18086 \begin_inset Quotes eld
18094 \begin_inset Quotes erd
18098 \begin_inset space ~
18101 appended to the page number of the parent
18111 Clearly, you want the contents of both the
18119 to each fit on a single physical slide! You should probably consider an
18125 \begin_inset Quotes eld
18129 \begin_inset Quotes erd
18137 Indeed, the \SpecialChar LyX
18142 class provides a visual cue for this: the label at the start of an
18146 is shorter than that at the start of a
18151 Lastly, when you generate printable output, you'll find alignment markers
18152 in all four corners of both the
18156 page and its parent
18161 These will assist you in lining up the two physical slides.
18164 \begin_layout Standard
18165 The major problem in overlaying two slides is aligning the contents of the
18166 two transparencies.
18167 How much space should you leave for that graph on the second slide? Worse
18168 still, what if you want a graph and a sentence on second slide, but there
18169 is text on the main transparency that goes in between them? You could try
18170 and insert vertical space of the right size.
18171 The better way is to use
18182 \begin_layout Standard
18183 As their names imply,
18191 are two command-like paragraph environments that make all subsequent text
18192 invisible and visible, respectively.
18194 \begin_inset space ~
18198 \begin_inset CommandInset ref
18200 reference "sec:slideQuirk"
18204 that you don't place anything
18208 these two environments, however.
18213 , it inserts a centered, sky-blue label into the page reading
18214 \begin_inset Quotes eld
18217 <Invisible Text Follows>
18218 \begin_inset Quotes erd
18222 For paragraphs following this label, the parts of the
18230 ; it doesn't matter which] where they would be contain instead blank space.
18234 \begin_layout Standard
18239 , the corresponding centered label is
18240 \begin_inset Quotes eld
18243 <Visible Text Follows>
18244 \begin_inset Quotes erd
18248 Paragraphs following this label behave normally.
18249 Note that the beginning of a new
18261 automatically shuts off an
18266 It's therefore not necessary to use
18277 \begin_layout Standard
18278 By now, it should be obvious how to create overlay transparencies using
18279 the proper combination of
18298 \begin_layout Enumerate
18303 , including everything that will appear on it, whether on the main slide
18311 \begin_layout Enumerate
18312 Before each figure or paragraph that will appear only on the
18321 If necessary, insert a
18325 environment after the
18332 \begin_layout Enumerate
18337 immediately following the
18344 \begin_layout Enumerate
18345 Copy the contents of this
18356 \begin_layout Enumerate
18361 , change all of the
18372 \begin_layout Standard
18374 You've just made an
18381 \begin_layout Standard
18382 There's one problem with the way I've designed the \SpecialChar LyX
18387 class: you can't make text in the middle of a paragraph invisible, nor
18388 make text in the middle of an invisible paragraph visible again.
18389 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18394 \begin_layout Plain Layout
18395 The commands of interest are:
18398 \begin_layout Itemize
18403 invisible \SpecialChar ldots
18407 \begin_layout Itemize
18412 visible \SpecialChar ldots
18416 \begin_layout Plain Layout
18418 and need to be marked as \SpecialChar TeX
18421 \begin_inset Quotes eld
18425 \begin_inset Quotes erd
18428 you wish to change goes in between the brackets [and after the
18441 If you don't know how to mark text as \SpecialChar TeX
18442 , see the appropriate section of
18455 \begin_layout Subsubsection
18465 \begin_inset CommandInset label
18467 name "sec:slideNote"
18474 \begin_layout Standard
18483 is associated with a
18484 \begin_inset Quotes eld
18488 \begin_inset Quotes erd
18496 Here, too, the \SpecialChar LyX
18501 class provides visual cues.
18506 is shorter than that of a
18510 [yet longer than that of an
18514 ] and, like the label of an
18518 is shockingly magenta.
18519 Additionally, the printed
18523 has the page number of its
18524 \begin_inset Quotes eld
18528 \begin_inset Quotes erd
18536 \begin_inset Quotes eld
18544 \begin_inset Quotes erd
18548 \begin_inset Quotes eld
18556 \begin_inset Quotes erd
18560 \begin_inset Quotes eld
18568 \begin_inset Quotes erd
18572 You can have multiple
18576 s associated with a single
18588 , you'll probably want to break up long
18592 s so that they fit on a single sheet of paper.
18595 \begin_layout Standard
18600 is obvious: it contains anything additional you might want to say about
18606 It could also be used as a sheet of reminders for a particular
18611 In the case of the latter, you might want to make use of time markers.
18612 Currently, the \SpecialChar LyX
18618 \begin_inset Quotes eld
18622 \begin_inset Quotes erd
18625 support for time markers, a
18627 Sli\SpecialChar TeX
18631 So, you'll have to resort to using the \SpecialChar LaTeX
18635 \begin_layout Standard
18636 To use time markers, you'll need to specify the extra class option
18637 \begin_inset Quotes eld
18645 \begin_inset Quotes erd
18649 \begin_inset space ~
18653 \begin_inset CommandInset ref
18655 reference "sec:slidesetup"
18660 This option turns on timing marks, which will appear in the lower-left-hand
18666 To set what appears in the time marker, you use the \SpecialChar LaTeX
18668 \begin_inset Quotes eld
18678 \begin_inset Quotes erd
18682 \begin_inset Quotes eld
18692 \begin_inset Quotes erd
18696 The arguments of both commands are time measured in seconds.
18698 \begin_inset Quotes eld
18708 \begin_inset Quotes erd
18711 sets the time marker to a given time.
18713 \begin_inset Quotes eld
18723 \begin_inset Quotes erd
18726 increments the time marker by the specified amount.
18727 Using time markers and
18731 s in this fashion, you can remind yourself how much time to spend on a particula
18739 \begin_layout Standard
18740 There's one last feature to describe.
18741 Clearly, you'd like to print out all of your
18749 s on transparencies while printing all of your
18766 with which it is associated.
18767 What's a person to do?
18770 \begin_layout Standard
18771 Luckily, there are two \SpecialChar LaTeX
18772 commands that allow you to select what to print
18774 Both must be placed into the preamble of your document.
18776 \begin_inset Quotes eld
18788 \begin_inset Quotes erd
18791 will cause the output to contain only the
18800 Correspondingly, the command
18801 \begin_inset Quotes eld
18813 \begin_inset Quotes erd
18816 prevents the output of anything but
18821 I'd advise placing both commands in the preamble and initially comment
18823 You can then preview your entire presentation as you write.
18824 When you're done writing, you can then uncomment one of the two to select
18825 what you want to print.
18826 I like to uncomment
18827 \begin_inset Quotes eld
18839 \begin_inset Quotes erd
18842 , print to a file with
18843 \begin_inset Quotes eld
18851 \begin_inset Quotes erd
18854 in its name, comment it back out, then uncomment
18855 \begin_inset Quotes eld
18867 \begin_inset Quotes erd
18871 \begin_inset Quotes eld
18879 \begin_inset Quotes erd
18883 I can then send either file to a printer, loading transparencies or plain
18884 paper as appropriate.
18887 \begin_layout Standard
18888 You can also provide other arguments to the
18889 \begin_inset Quotes eld
18899 \begin_inset Quotes erd
18903 \begin_inset Quotes eld
18913 \begin_inset Quotes erd
18917 See a good \SpecialChar LaTeX
18921 \begin_layout Subsection
18926 Class Template File
18929 \begin_layout Standard
18930 I have also provided a template file,
18931 \begin_inset Quotes eld
18939 \begin_inset Quotes erd
18947 To use it, begin your new presentation with
18949 File\SpecialChar menuseparator
18951 \begin_inset space ~
18955 \begin_inset space ~
18961 Your new \SpecialChar LyX
18962 presentation file will contain an example
18983 additionally contain an example of the use of
18992 Lastly, the preamble will contain:
18995 \begin_layout LyX-Code
18996 % Uncomment to print out only slides and overlays
18999 \begin_layout LyX-Code
19003 \begin_layout LyX-Code
19009 \begin_inset Newline newline
19015 \begin_layout LyX-Code
19016 % Uncomment to print out only notes
19019 \begin_layout LyX-Code
19023 \begin_layout LyX-Code
19031 \begin_layout Standard
19032 One final thing: I created this class to support the \SpecialChar LaTeX2e
19034 \begin_inset Quotes eld
19039 Sli\SpecialChar TeX
19043 \begin_inset Quotes erd
19046 class, one of the built-in \SpecialChar LaTeX2e
19048 Neither I nor the rest of the \SpecialChar LyX
19049 Team endorse or oppose the use of this built-in
19051 It's here if you want it or need it.
19052 There exist other \SpecialChar LaTeX2e
19053 classes for creating presentations, such as the
19058 \begin_inset space ~
19062 \begin_inset CommandInset ref
19064 reference "sec:foiltex"
19069 \begin_inset Quotes eld
19077 \begin_inset Quotes erd
19080 package [present on some \SpecialChar TeX
19082 The latter is not yet supported under \SpecialChar LyX
19087 \begin_layout Plain Layout
19088 Perhaps you can take on the task\SpecialChar ldots
19094 I know nothing about these other classes.
19095 Try them out to see what sort of alternative they provide.
19098 \begin_layout Chapter
19100 Features needing Extra Software
19103 \begin_layout Section
19104 Checking \SpecialChar TeX
19108 \begin_layout Standard
19114 \begin_layout Subsection
19118 \begin_layout Standard
19127 \begin_layout Plain Layout
19132 is not yet available when you are using the \SpecialChar LaTeX
19133 distribution MiK\SpecialChar TeX
19139 , you'll find in the
19146 \begin_inset space ~
19157 \begin_inset Newline newline
19161 \begin_inset CommandInset href
19163 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19170 \begin_layout Standard
19173 Chk\SpecialChar TeX
19176 package is a program that was written by
19177 \begin_inset Flex Noun
19180 \begin_layout Plain Layout
19182 \begin_inset space ~
19190 in frustration because some constructs in \SpecialChar LaTeX
19191 are sometimes non-intuitive,
19192 and easy to forget.
19193 The program runs over your \SpecialChar LaTeX
19194 file, checks the integrity of the file, and
19195 flags some common errors.
19196 In other technical words, it is
19200 for \SpecialChar LaTeX
19204 \begin_layout Standard
19205 Well, what is a syntax checker doing in \SpecialChar LyX
19206 which is supposed to produce correct
19208 anyways? The answer is simple: Just as
19212 not only checks the
19216 of C programs, but also does
19220 checks for type-errors,
19222 Chk\SpecialChar TeX
19225 catches some common
19229 errors, in addition to the syntactical ones.
19232 Chk\SpecialChar TeX
19235 is capable of detecting several common errors, such as
19238 \begin_layout Itemize
19239 Ellipsis detection:
19240 \begin_inset Newline newline
19243 Use \SpecialChar ldots
19247 \begin_layout Itemize
19248 No space in front of/after parenthesis:
19249 \begin_inset Newline newline
19255 \begin_layout Itemize
19256 Enforcement of normal space after common abbreviations:
19257 \begin_inset Newline newline
19261 \begin_inset space \thinspace{}
19265 \begin_inset space \space{}
19268 is too wide spacing.
19271 \begin_layout Itemize
19272 Enforcement of end-of-sentence space when the last sentence ends with a
19274 \begin_inset Newline newline
19278 And this is wrong spacing.
19281 \begin_layout Itemize
19282 Space in front of labels and similar commands:
19283 \begin_inset Newline newline
19286 The label should stick right up to the text to avoid falling to a wrong
19289 \begin_inset CommandInset label
19299 \begin_layout Plain Layout
19300 This footnote is in danger of falling off to a wrong page
19305 The label is separated too much.
19308 \begin_layout Itemize
19309 Space in front of references, instead of hard spaces:
19310 \begin_inset Newline newline
19313 If you have bad luck, the text will break right between the referenced text
19314 and reference number, and that's a pity.
19316 \begin_inset CommandInset ref
19318 reference "sec:chktex"
19325 \begin_layout Itemize
19327 \begin_inset Quotes eld
19331 \begin_inset Quotes erd
19335 \begin_inset Formula $\times$
19339 \begin_inset Newline newline
19342 2x2 looks cheap compared to
19343 \begin_inset Formula $2\times2$
19349 \begin_layout Standard
19350 and more \SpecialChar ldots
19351 It is an invaluable tool when you are
19352 \begin_inset Quotes eld
19356 \begin_inset Quotes erd
19359 your document before printing, and you should run it right after the obligatory
19360 spelling check, and before you go fine tuning the typesetting.
19363 \begin_layout Subsection
19367 \begin_layout Standard
19368 If you have the program installed, usage is as simple as choosing
19370 Tools\SpecialChar menuseparator
19372 \begin_inset space ~
19378 This will make \SpecialChar LyX
19379 generate a \SpecialChar LaTeX
19380 file of your document, start
19382 Chk\SpecialChar TeX
19385 to check it, and then make \SpecialChar LyX
19387 \begin_inset Quotes eld
19391 \begin_inset Quotes erd
19394 with the warnings from
19396 Chk\SpecialChar TeX
19399 , if there were any.
19400 The warnings will be placed close to the point of the mistake, and you
19401 can quickly find them by using the
19403 Navigate\SpecialChar menuseparator
19406 menu item, or the shortcut key
19415 Open the error boxes by clicking on them with the mouse, or use the shortcut
19424 bindings, or the corresponding
19433 Read the warning and correct the mistake, if it is a mistake.
19434 If you have trouble understanding what the warning is about, you can safely
19436 Remember that there is a hidden layer between the document on screen and
19437 the technical details in invoking
19439 Chk\SpecialChar TeX
19442 , and this gap can make some warnings seem arcane or just plain silly.
19445 \begin_layout Standard
19446 This document is an excellent testing bed for the feature, and it should
19447 provide quite a few warnings for you to fiddle with.
19448 Since computers are only so smart, expect most of the warnings to be false
19452 \begin_layout Subsection
19453 How to fine tune it
19456 \begin_layout Standard
19457 Sometimes, you'll find that
19459 Chk\SpecialChar TeX
19462 makes more noise than suits your mood.
19463 Then you can choose not to use it, wait until your mood changes, or try
19466 Chk\SpecialChar TeX
19469 to get better along with you.
19472 \begin_layout Standard
19475 Chk\SpecialChar TeX
19482 very configurable and extensible, you should not expect to solve all problems
19485 Chk\SpecialChar TeX
19488 in \SpecialChar LyX
19490 Since \SpecialChar LyX
19491 has to generate a somewhat special \SpecialChar LaTeX
19492 file to be able to match the
19493 line numbers from the
19495 Chk\SpecialChar TeX
19502 \begin_layout Plain Layout
19503 You can inspect the specific output from
19509 Document\SpecialChar menuseparator
19512 \begin_inset space ~
19526 to the internal document structure, some of the warnings will not appear
19528 There are two things you can do about this:
19531 \begin_layout Itemize
19534 Chk\SpecialChar TeX
19537 invocation command line in
19538 \begin_inset Flex Noun
19541 \begin_layout Plain Layout
19542 Tools\SpecialChar menuseparator
19543 Preferences\SpecialChar menuseparator
19544 Output\SpecialChar menuseparator
19545 LaTeX\SpecialChar menuseparator
19553 Chk\SpecialChar TeX
19556 installation configuration file (usually with the file
19561 See below to learn what warnings can be enabled and disabled on the command
19565 \begin_layout Itemize
19566 Export your document as a raw \SpecialChar LaTeX
19569 File\SpecialChar menuseparator
19570 Export\SpecialChar menuseparator
19579 Invoked in this way, it can be a hassle to find the corresponding place
19580 in the document inside \SpecialChar LyX
19581 , but with a little patience, you should be able
19585 \begin_layout Standard
19586 Here follows the warning messages that can be enabled and disabled in
19595 to disable a warning, and
19599 to enable a warning.
19600 The emphasized entries are disabled by default, because the default is
19603 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19608 \begin_layout Standard
19609 Notice that you should only use the options that enable and disable warnings,
19610 because \SpecialChar LyX
19611 relies on some of the other command line parameters to be set
19612 in a specific way to have a chance to communicate with
19619 \begin_layout Enumerate
19623 Command terminated with space.
19626 \begin_layout Enumerate
19629 Non-breaking space (
19630 \begin_inset Quotes eld
19638 \begin_inset Quotes erd
19641 ) should have been used.
19644 \begin_layout Enumerate
19648 You should enclose the previous parenthesis with
19649 \begin_inset Quotes eld
19657 \begin_inset Quotes erd
19663 \begin_layout Enumerate
19666 Italic correction (
19667 \begin_inset Quotes eld
19677 \begin_inset Quotes erd
19680 ) found in non-italic buffer.
19683 \begin_layout Enumerate
19686 Italic correction (
19687 \begin_inset Quotes eld
19697 \begin_inset Quotes erd
19700 ) found more than once.
19703 \begin_layout Enumerate
19707 No italic correction (
19708 \begin_inset Quotes eld
19718 \begin_inset Quotes erd
19724 \begin_layout Enumerate
19728 \begin_inset Quotes eld
19736 \begin_inset Quotes erd
19740 \begin_inset Quotes eld
19748 \begin_inset Quotes erd
19754 \begin_layout Enumerate
19757 Wrong length of dash may have been used.
19760 \begin_layout Enumerate
19764 \begin_inset Quotes eld
19772 \begin_inset Quotes erd
19776 \begin_inset Quotes eld
19784 \begin_inset Quotes erd
19790 \begin_layout Enumerate
19794 \begin_inset Quotes eld
19802 \begin_inset Quotes erd
19808 \begin_layout Enumerate
19812 \begin_inset Quotes eld
19820 \begin_inset Quotes erd
19823 to achieve an ellipsis.
19826 \begin_layout Enumerate
19829 Inter-word spacing (
19830 \begin_inset Quotes eld
19840 \begin_inset Quotes eld
19843 ) should perhaps be used.
19846 \begin_layout Enumerate
19849 Inter-sentence spacing (
19850 \begin_inset Quotes eld
19860 \begin_inset Quotes erd
19863 ) should perhaps be used.
19866 \begin_layout Enumerate
19869 Could not find argument for command.
19872 \begin_layout Enumerate
19876 \begin_inset Quotes eld
19884 \begin_inset Quotes erd
19890 \begin_layout Enumerate
19893 Math mode still on at end of \SpecialChar LaTeX
19897 \begin_layout Enumerate
19901 \begin_inset Quotes eld
19909 \begin_inset Quotes erd
19912 doesn't match the number of
19913 \begin_inset Quotes eld
19921 \begin_inset Quotes erd
19927 \begin_layout Enumerate
19930 You should use either
19933 \begin_inset Quotes eld
19941 \begin_inset Quotes erd
19946 as an alternative to
19947 \begin_inset Quotes eld
19955 \begin_inset Quotes erd
19961 \begin_layout Enumerate
19968 " (ASCII 39) instead of "
19975 \begin_layout Enumerate
19978 User-specified pattern found.
19981 \begin_layout Enumerate
19984 This command might not be intended.
19987 \begin_layout Enumerate
19994 \begin_layout Enumerate
20012 \begin_layout Enumerate
20015 Delete this space to maintain correct page references.
20018 \begin_layout Enumerate
20022 You might wish to put this between a pair of
20023 \begin_inset Quotes eld
20031 \begin_inset Quotes erd
20037 \begin_layout Enumerate
20040 You ought to remove spaces in front of punctuation.
20043 \begin_layout Enumerate
20046 Could not execute \SpecialChar LaTeX
20050 \begin_layout Enumerate
20059 in front of small punctuation.
20062 \begin_layout Enumerate
20070 may look prettier here.
20073 \begin_layout Enumerate
20077 Multiple spaces detected in output.
20080 \begin_layout Enumerate
20083 This text may be ignored.
20086 \begin_layout Enumerate
20092 \begin_inset Quotes eld
20097 to begin quotation, not
20104 \begin_layout Enumerate
20111 to end quotation, not
20114 \begin_inset Quotes eld
20122 \begin_layout Enumerate
20128 \begin_layout Enumerate
20131 You should perhaps use
20132 \begin_inset Quotes eld
20140 \begin_inset Quotes erd
20146 \begin_layout Enumerate
20149 You should put a space in front of/after parenthesis.
20152 \begin_layout Enumerate
20155 You should avoid spaces in front of/after parenthesis.
20158 \begin_layout Enumerate
20162 You should not use punctuation in front of/after quotes.
20165 \begin_layout Enumerate
20168 Double space found.
20171 \begin_layout Enumerate
20174 You should put punctuation outside inner/inside display math mode.
20177 \begin_layout Enumerate
20180 You ought to not use primitive \SpecialChar TeX
20181 in \SpecialChar LaTeX
20185 \begin_layout Enumerate
20188 You should remove spaces in front of
20189 \begin_inset Quotes eld
20197 \begin_inset Quotes erd
20203 \begin_layout Enumerate
20206 \begin_inset Quotes eld
20214 \begin_inset Quotes erd
20217 is normally not followed by
20218 \begin_inset Quotes eld
20226 \begin_inset Quotes erd
20232 \begin_layout Standard
20233 In later versions of \SpecialChar LyX
20234 , we hope to provide a more complete interface to this
20235 tool (and it's smaller cousin
20239 ) to exploit the full power of it.
20240 But it's not exactly useless as it is now: go try it on one of your existing
20241 documents of a certain length and be surprised.
20244 \begin_layout Section
20245 Version Control in \SpecialChar LyX
20249 \begin_layout Standard
20252 Lars Gullik Bjønnes
20259 \begin_layout Subsection
20263 \begin_layout Standard
20265 supports some of the most basic RCS/CVS/SVN/GIT commands.
20266 If you need something a bit more sophisticated you will have to do that
20267 manually in a terminal.
20270 \begin_layout Standard
20271 Also note that CVS support is not as good as subversion support so we advise
20273 A good place to start learning Subversion is SVN Book
20277 \begin_layout Plain Layout
20278 \begin_inset CommandInset href
20280 target "http://svnbook.red-bean.com/"
20290 In the case of RCS you should read
20291 \begin_inset Quotes eld
20295 \begin_inset Quotes erd
20298 (a man file, read it with
20303 This file describes all the basic features of RCS.
20304 You should especially notice the comment about a RCS directory, and the
20305 notion of a master RCS file (the file ending in
20312 \begin_layout Standard
20313 Before you begin to use the version control features in \SpecialChar LyX
20315 familiar with RCS/CVS/SVN/GIT usage.
20316 The implementation in \SpecialChar LyX
20317 assumes a recent version of the GNU RCS or CVS/SVN
20318 package — no guarantees are made for older versions.
20319 Most of the log messages are not currently displayed after operations —
20320 you can check them in the Messages pane if unsure.
20321 Regular users of version control will appreciate VC toolbar, which can
20324 View\SpecialChar menuseparator
20325 Toolbars\SpecialChar menuseparator
20327 \begin_inset space ~
20335 \begin_layout Standard
20336 For introducing your own external commands consult vc-command in the manual
20337 of \SpecialChar LyX
20341 \begin_layout Standard
20342 It is strongly recommended to store documents in uncompressed format if
20343 using version control (uncheck
20345 Document\SpecialChar menuseparator
20348 if it is checked): Uncompressed LyX documents are text files and therefore
20349 for merging two different versions by version control systems.
20350 Compressed LyX documents are binary files, which cannot be merged by version
20354 \begin_layout Subsection
20355 RCS commands in \SpecialChar LyX
20359 \begin_layout Standard
20360 The following sections describe the RCS commands supported by \SpecialChar LyX
20362 You can find them in the
20364 File\SpecialChar menuseparator
20366 \begin_inset space ~
20373 was tested against RCS 5.7/5.8.
20376 \begin_layout Subsubsection
20382 \begin_layout Standard
20383 If your document is not under revision control, this is the only item shown
20385 And if it is under revision control, the
20389 item is not visible.
20393 \begin_layout Standard
20394 This command registers your document with RCS (unless you are under the
20395 directory managed by CVS)\SpecialChar endofsentence
20396 You are asked interactively to supply an initial
20397 description of the document.
20398 The document is now set in Read-Only mode and you have to
20401 \begin_inset space ~
20405 \begin_inset space ~
20409 \begin_inset space ~
20414 , before making any changes to it.
20415 A document under revision control has a
20416 \begin_inset Quotes eld
20419 [RCS:<version> <locker>]
20420 \begin_inset Quotes erd
20423 item tagged to the filename in the minibuffer.
20426 \begin_layout Standard
20427 RCS command that is run:
20429 ci -q -u -i -t-"<initial description>" <file-name>
20432 \begin_layout Standard
20437 to understand the switches.
20441 \begin_layout Subsubsection
20447 \begin_layout Standard
20448 When you are finished editing a file, you check in your changes.
20449 When you do this, you are asked for a description of the changes.
20450 This is stored in the history log.
20451 The version number is bumped, your changes are applied to the master RCS
20452 file, the document is unlocked and set to Read-Only mode.
20455 \begin_layout Standard
20458 ci -q -u -m"<description>" <file-name>
20461 \begin_layout Subsubsection
20467 \begin_layout Standard
20468 By doing this you lock the document so that only you can edit it.
20469 This will also make the document Read-Write only for you.
20470 You will usually continue editing for a while and when you are finished
20471 you check in your changes.
20472 The status line is changed to reflect that you have locked the file.
20475 \begin_layout Standard
20478 co -q -l <file-name>
20481 \begin_layout Subsubsection
20484 Revert To Repository Version
20487 \begin_layout Standard
20488 This will discard all changes made to the document since the last check
20490 You get a warning before changes are discarded.
20493 \begin_layout Standard
20496 co -f -u<version> <file-name>
20499 \begin_layout Subsubsection
20505 \begin_layout Standard
20506 This will create a copy of the current document.
20507 Since RCS does not support copy operations natively, the version history
20508 is not preserved, and the copy is added as a new file.
20509 It requires a clean document without any changes since the last checkin.
20510 You are asked for a file name and a description of the copy operation.
20511 After that the copy is created, both locally and in the repository.
20512 If the parent directories of the copied and original document differ, all
20513 relative paths of included files of the copy are adjusted (like in
20515 File\SpecialChar menuseparator
20520 Finally, the copy is loaded instead of the original document.
20523 \begin_layout Labeling
20524 \labelwidthstring 00.00.0000
20526 \begin_inset space ~
20530 \begin_inset space ~
20534 \begin_inset Newline newline
20538 \begin_inset Flex Code
20541 \begin_layout Plain Layout
20544 \begin_inset Quotes eld
20548 \begin_inset Quotes erd
20557 \begin_inset Flex Code
20560 \begin_layout Plain Layout
20563 \begin_inset Quotes eld
20567 \begin_inset Quotes erd
20576 \begin_inset Newline newline
20580 \begin_inset Flex Code
20583 \begin_layout Plain Layout
20587 \begin_inset Quotes eld
20591 \begin_inset Quotes erd
20602 \begin_layout Subsubsection
20608 \begin_layout Standard
20609 This makes as if the last check in never happened.
20610 No changes are made to the document loaded into \SpecialChar LyX
20611 , but the last version
20612 is removed from the master RCS file.
20615 \begin_layout Standard
20618 rcs -o<version> <file-name>
20621 \begin_layout Subsubsection
20627 \begin_layout Standard
20628 This shows the complete history of the RCS document.
20633 is shown in a browser.
20641 \begin_layout Subsubsection
20645 \begin_layout Standard
20647 supports RCS version number, author name, date and time of last commit.
20648 All those are extracted from
20650 rlog -r <file-name>
20654 \begin_inset CommandInset ref
20656 reference "subsec:VCS-Revision-Information"
20663 \begin_layout Subsection
20664 CVS commands in \SpecialChar LyX
20668 \begin_layout Standard
20669 A subset of CVS operations is supported by \SpecialChar LyX
20671 You can find the commands in the
20673 File\SpecialChar menuseparator
20675 \begin_inset space ~
20681 The version control system SVN is more powerful, so please use it instead
20682 of CVS if possible.
20685 \begin_layout Subsubsection
20691 \begin_layout Standard
20692 If you start from scratch with CVS you have to create your repository and
20693 checkout the working copy with external tools.
20694 If you're using a client-server setup you may need to login before doing
20695 the first repository checkout.
20698 \begin_layout Standard
20699 If your documents are under revision control and others are using the same
20700 repository problems arise when different changes to the same document at
20701 the same location happen.
20702 Standard CVS repositories don't operate with a file locking mechanism.
20703 This may be surprising, but conflicts only occur if people disagree on
20704 the proper content of the same part of a document.
20705 So, if co-workers are used to communicate regularly, these conflicts occur
20707 If they don't communicate they have a fundamental problem anyway.
20708 Nevertheless some people like to work with so called
20709 \begin_inset Quotes eld
20713 \begin_inset Quotes erd
20717 If they do so the working copy of all files is readonly when checked out
20718 first and the user starts editing after using a special command to make
20719 the working copy writable.
20720 When the changes are checked in the working copy returns to readonly state.
20721 With \SpecialChar LyX
20722 one has to edit the
20723 \begin_inset Flex Code
20726 \begin_layout Plain Layout
20732 file and add the line
20733 \begin_inset Flex Code
20736 \begin_layout Plain Layout
20742 to work with reserved checkouts.
20743 The benefit is the possibility to see who is using a writable copy of some
20745 It's not guaranteed only one user makes a copy writable.
20748 \begin_layout Standard
20750 tries to guess if you're using reserved or non-reserved checkouts.
20751 If your working copy is readonly or it is writable and an additional copy
20752 of your document exists in the CVS/Base sub-directory a reserved otherwise
20753 a non-reserved checkout is assumed.
20754 When a reserved checkout is detected you have to use
20755 \begin_inset Flex Noun
20758 \begin_layout Plain Layout
20764 to make your working copy writable if it's readonly.
20766 \begin_inset Flex Noun
20769 \begin_layout Plain Layout
20775 operation is possible and that makes your working copy readonly again after
20776 transferring your changes to the repository.
20779 \begin_layout Standard
20780 More information about CVS can be found here
20781 \begin_inset Flex URL
20784 \begin_layout Plain Layout
20786 http://www.nongnu.org/cvs
20792 \begin_inset Flex URL
20795 \begin_layout Plain Layout
20797 http://ximbiot.com/cvs
20805 \begin_layout Standard
20810 to understand the sub-commands and the switches mentioned below.
20813 \begin_layout Subsubsection
20819 \begin_layout Standard
20820 If your document is not under revision control, this is the only item shown
20822 And if it is under revision control, the
20826 item is not visible.
20830 \begin_layout Standard
20831 This command registers in CVS your document
20832 \begin_inset Flex Strong
20835 \begin_layout Plain Layout
20843 in the case you have already the documents directory under CVS control
20849 This means you have to create or checkout the archive by yourself using
20851 (In case you forget that step \SpecialChar LyX
20852 registers the document with RCS.)
20855 \begin_layout Standard
20856 Then you are asked interactively to supply an initial description of the
20858 Don't forget that registered file is not yet checked in.
20861 \begin_layout Standard
20862 CVS command that is run:
20864 cvs -q add -m"<entered message>" "<file-name>"
20867 \begin_layout Standard
20872 above and for all other CVS commands is an abbreviation for
20873 \begin_inset Quotes eld
20876 change the current working directory to file location and use the file name
20877 without path component as argument
20878 \begin_inset Quotes erd
20884 \begin_layout Subsubsection
20890 \begin_layout Standard
20891 When you are finished editing a file, you commit your changes.
20892 When you do this and you had changed the document, you are asked for a
20893 description of the changes.
20894 After that changes are written to the repository.
20895 In case you didn't change the document and a reserved checkout is detected
20896 the reservation made on
20897 \begin_inset Flex Noun
20900 \begin_layout Plain Layout
20909 \begin_layout Labeling
20910 \labelwidthstring 00.00.0000
20912 \begin_inset space ~
20916 \begin_inset space ~
20920 \begin_inset Newline newline
20924 \begin_inset Flex Code
20927 \begin_layout Plain Layout
20930 -q commit -m"<description>" "<file-name>"
20936 \begin_inset Newline newline
20940 \begin_inset Flex Code
20943 \begin_layout Plain Layout
20954 \begin_layout Subsubsection
20960 \begin_layout Standard
20961 When you are sharing a repository with others, you may have to incorporate
20962 their changes into your working copy.
20965 \begin_layout Standard
20968 cvs -q update "<file-name>"
20971 \begin_layout Standard
20972 If a readonly checkout is detected the working copy is made writable and
20976 \begin_layout Standard
20979 cvs -q edit "<file-name>"
20982 \begin_layout Subsubsection
20985 Revert To Repository Version
20988 \begin_layout Standard
20989 This will discard all changes made to the document since the last check
20991 You get a warning before changes are discarded.
20992 Firstly the file is deleted, secondly CVS update command is run.
20995 \begin_layout Standard
20998 cvs -q update "<file-name>"
21001 \begin_layout Standard
21002 If a reserved checkout is detected and the working copy has no changes only
21003 the reservation is undone.
21006 \begin_layout Standard
21009 cvs -q unedit "<file-name>"
21012 \begin_layout Subsubsection
21018 \begin_layout Standard
21019 This will create a copy of the current document.
21020 Since CVS does not support copy operations natively, the version history
21021 is not preserved, and the copy is added as a new file.
21022 It requires a clean document without any changes since the last checkin.
21023 You are asked for a file name and a description of the copy operation.
21024 After that the copy is created, both locally and in the repository.
21025 If the parent directories of the copied and original document differ, all
21026 relative paths of included files of the copy are adjusted (like in
21028 File\SpecialChar menuseparator
21033 Finally, the copy is loaded instead of the original document.
21036 \begin_layout Labeling
21037 \labelwidthstring 00.00.0000
21039 \begin_inset space ~
21043 \begin_inset space ~
21047 \begin_inset Newline newline
21051 \begin_inset Flex Code
21054 \begin_layout Plain Layout
21057 \begin_inset Quotes eld
21061 \begin_inset Quotes erd
21070 \begin_inset Flex Code
21073 \begin_layout Plain Layout
21076 \begin_inset Quotes eld
21080 \begin_inset Quotes erd
21089 \begin_inset Newline newline
21093 \begin_inset Flex Code
21096 \begin_layout Plain Layout
21100 \begin_inset Quotes eld
21104 \begin_inset Quotes erd
21115 \begin_layout Subsubsection
21121 \begin_layout Standard
21122 This will rename the current document.
21123 Since CVS does not support rename operations natively, the version history
21124 is not preserved, the renamed document is added as a new file, and the
21125 original document is deleted.
21126 It requires a clean document without any changes since the last checkin.
21127 You are asked for a file name and a description of the rename operation.
21128 After that the document is renamed, both locally and in the repository.
21129 If the parent directories of the new and old file names differ, all relative
21130 paths of included files are adjusted (like in
21132 File\SpecialChar menuseparator
21137 Finally, the document is reloaded using the new name.
21140 \begin_layout Labeling
21141 \labelwidthstring 00.00.0000
21143 \begin_inset space ~
21147 \begin_inset space ~
21151 \begin_inset Newline newline
21155 \begin_inset Flex Code
21158 \begin_layout Plain Layout
21161 \begin_inset Quotes eld
21165 \begin_inset Quotes erd
21174 \begin_inset Flex Code
21177 \begin_layout Plain Layout
21180 \begin_inset Quotes eld
21184 \begin_inset Quotes erd
21193 \begin_inset Newline newline
21197 \begin_inset Flex Code
21200 \begin_layout Plain Layout
21204 \begin_inset Quotes eld
21208 \begin_inset Quotes erd
21217 \begin_inset Newline newline
21221 \begin_inset Flex Code
21224 \begin_layout Plain Layout
21228 \begin_inset Quotes eld
21232 \begin_inset Quotes erd
21243 \begin_layout Subsubsection
21244 Update of the local directory checkout from repository
21247 \begin_layout Standard
21248 Once your documents gets more complex, containing sub-documents and pictures,
21250 \begin_inset Flex Code
21253 \begin_layout Plain Layout
21259 files and so on using version control becomes more complicated.
21261 supports updating the whole tree in which resides the document.
21262 This become especially useful once you cooperate with people which neither
21263 have detailed knowledge about CVS usage nor they have ambition to commit
21264 additional material to the repository.
21265 You have to organize the files structure so that all external files are
21266 in the same directory or subdirectories of the document.
21267 It's good practice anyway to store multipart documents in an extra directory.
21270 \begin_layout Standard
21272 \begin_inset Flex Code
21275 \begin_layout Plain Layout
21276 Update local directory from repository
21281 command updates the whole directory.
21282 If local changes are detected user is warned before update starts.
21283 In case of merge conflicts both versions of the conflicting document parts
21284 are placed in the final document.
21285 You have to review and correct the result of the merge.
21286 You'll find the conflicts enclosed in pairs of
21287 \begin_inset Flex Code
21290 \begin_layout Plain Layout
21297 \begin_inset Flex Code
21300 \begin_layout Plain Layout
21307 \begin_inset Flex Code
21310 \begin_layout Plain Layout
21317 The first part is your version as before the update operation with the
21318 document name prepended.
21319 The second one is the repository version with the version number after
21321 \begin_inset Flex Code
21324 \begin_layout Plain Layout
21333 \begin_layout Labeling
21334 \labelwidthstring 00.00.0000
21336 \begin_inset space ~
21340 \begin_inset space ~
21344 \begin_inset Newline newline
21348 \begin_inset Flex Code
21351 \begin_layout Plain Layout
21359 (Ask if changes are detected.)
21360 \begin_inset Newline newline
21364 \begin_inset Flex Code
21367 \begin_layout Plain Layout
21368 cd $path; cvs -q update
21378 \begin_layout Standard
21380 \begin_inset Flex Code
21383 \begin_layout Plain Layout
21389 stands for the path to the document.
21392 \begin_layout Subsubsection
21398 \begin_layout Standard
21399 This shows the complete history of the CVS document.
21402 cvs log "<file-name>"
21404 is shown in a browser.
21407 \begin_layout Subsubsection
21411 \begin_layout Standard
21413 supports CVS version number, author name, date and time of last commit.
21414 All those are extracted from
21416 cvs log -r <file-name>
21420 \begin_inset CommandInset ref
21422 reference "subsec:VCS-Revision-Information"
21429 \begin_layout Subsection
21430 SVN commands in \SpecialChar LyX
21434 \begin_layout Standard
21435 SVN is now partially supported by \SpecialChar LyX
21437 You can find the commands in the
21439 File\SpecialChar menuseparator
21441 \begin_inset space ~
21447 Please note that if you use password protected access to repository via
21448 ssh, you will be asked in terminal window.
21450 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21454 \begin_layout Plain Layout
21455 Most of the commands will work with 1.4 too, see
21456 \begin_inset CommandInset ref
21458 reference "subsec:SVN-Repo-Update"
21463 There seems to be currently unresolved permissions problem under SVN 1.8
21464 with reverting changes when file is locked.
21472 \begin_layout Subsubsection
21478 \begin_layout Standard
21479 If your document is not under revision control, this is the only item shown
21481 And if it is under revision control, the
21485 item is not visible.
21488 \begin_layout Standard
21489 This command registers in SVN your document ONLY in case you have already
21490 the documents directory under SVN control (in particular
21495 This means you have to checkout the archive by yourself.
21498 \begin_layout Standard
21499 Then you are asked interactively to supply an initial description of the
21501 Don't forget that registered file is not yet commited.
21504 \begin_layout Standard
21505 SVN command that is run:
21508 \begin_inset Quotes eld
21512 \begin_inset Quotes erd
21518 \begin_layout Standard
21523 to understand the switches.
21526 \begin_layout Subsubsection
21532 \begin_layout Standard
21533 When you are finished editing a file, you commit your changes.
21534 When you do this, you are asked for a description of the changes.
21535 After that changes are commited.
21538 \begin_layout Standard
21543 \begin_layout Plain Layout
21544 In case locking is not enabled.
21546 \begin_inset CommandInset ref
21548 reference "subsec:SVN-File-Locking"
21559 svn commit -q -m"<description>" <file-name>
21562 \begin_layout Subsubsection
21568 \begin_layout Standard
21569 Updates the changes of this file from the repository.
21570 Be sure you understand SVN merging and conflicts resolving before using
21571 this function, because all conflicts has to be resolved manually by you!
21574 \begin_layout Standard
21579 \begin_layout Plain Layout
21587 svn update --non-interactive
21588 \begin_inset Quotes eld
21592 \begin_inset Quotes erd
21598 \begin_layout Subsubsection
21601 Revert To Repository Version
21604 \begin_layout Standard
21605 This will discard all changes made to the document since the last check
21607 You get a warning before changes are discarded.
21610 \begin_layout Standard
21614 \begin_inset Quotes eld
21618 \begin_inset Quotes erd
21624 \begin_layout Subsubsection
21630 \begin_layout Standard
21631 This will create a copy of the current document including the version history.
21632 It requires a clean document without any changes since the last checkin.
21633 You are asked for a file name and a description of the copy operation.
21634 After that the copy is created, both locally and in the repository.
21635 If the parent directories of the copied and original document differ, all
21636 relative paths of included files of the copy are adjusted (like in
21638 File\SpecialChar menuseparator
21643 Finally, the copy is loaded instead of the original document.
21646 \begin_layout Labeling
21647 \labelwidthstring 00.00.0000
21649 \begin_inset space ~
21653 \begin_inset space ~
21657 \begin_inset Newline newline
21661 \begin_inset Flex Code
21664 \begin_layout Plain Layout
21668 \begin_inset Quotes eld
21672 \begin_inset Quotes erd
21676 \begin_inset Quotes eld
21680 \begin_inset Quotes erd
21689 \begin_inset Newline newline
21693 \begin_inset Flex Code
21696 \begin_layout Plain Layout
21705 \begin_layout Subsubsection
21711 \begin_layout Standard
21712 This will rename the current document including the version history.
21713 It requires a clean document without any changes since the last checkin.
21714 You are asked for a file name and a description of the rename operation.
21715 After that the document is renamed, both locally and in the repository.
21716 If the parent directories of the new and old file names differ, all relative
21717 paths of included files are adjusted (like in
21719 File\SpecialChar menuseparator
21724 Finally, the document is reloaded using the new name.
21727 \begin_layout Labeling
21728 \labelwidthstring 00.00.0000
21730 \begin_inset space ~
21734 \begin_inset space ~
21738 \begin_inset Newline newline
21742 \begin_inset Flex Code
21745 \begin_layout Plain Layout
21749 \begin_inset Quotes eld
21753 \begin_inset Quotes erd
21757 \begin_inset Quotes eld
21761 \begin_inset Quotes erd
21770 \begin_inset Newline newline
21774 \begin_inset Flex Code
21777 \begin_layout Plain Layout
21786 \begin_layout Subsubsection
21787 \begin_inset CommandInset label
21789 name "subsec:SVN-Repo-Update"
21793 Update of the local directory checkout from repository
21797 \begin_layout Plain Layout
21798 Note that this command will work only with subversion
21799 \begin_inset Formula $\geqq1.5$
21810 \begin_layout Standard
21811 All the commands above have one shortcomming - they deal with the current
21813 Once your document contains pictures, includes external
21814 \begin_inset Flex Code
21817 \begin_layout Plain Layout
21823 files and so on administration becomes more complicated.
21825 now supports updating the whole tree in which resides the document
21829 \begin_layout Plain Layout
21830 One need to organize the files structure so that all external files are
21831 in the same directory or subdirectories of the document.
21838 This become especially useful once you cooperate with people which neither
21839 know about subversion management nor they have ambition to commit additional
21840 material to the repository.
21844 \begin_layout Standard
21845 \begin_inset Flex Code
21848 \begin_layout Plain Layout
21849 Update local directory from repository
21854 command updates the whole directory and in case of merge conflicts local
21855 version of the files are left, so no unintended data loss occurs.
21856 If local changes are detected user is warned before update starts.
21859 \begin_layout Labeling
21860 \labelwidthstring 00.00.0000
21862 \begin_inset space ~
21866 \begin_inset space ~
21870 \begin_inset Newline newline
21874 \begin_inset Flex Code
21877 \begin_layout Plain Layout
21883 (Ask if changes are detected.)
21884 \begin_inset Newline newline
21888 \begin_inset Flex Code
21891 \begin_layout Plain Layout
21892 svn update –accept mine-full $path
21900 \begin_layout Standard
21902 \begin_inset Flex Code
21905 \begin_layout Plain Layout
21911 stands for the path to the document.
21914 \begin_layout Subsubsection
21920 \begin_layout Standard
21921 This shows the complete history of the SVN document.
21925 \begin_inset Quotes eld
21929 \begin_inset Quotes erd
21934 is shown in a browser.
21937 \begin_layout Subsubsection
21939 \begin_inset CommandInset label
21941 name "subsec:SVN-File-Locking"
21948 \begin_layout Standard
21949 The file exchange through various revision control systems brings the problem
21950 of merge conflicts in case two different users try to edit the same (parts
21952 When such a conflict happens it needs manual resolving and one reasonable
21953 alternative is to provide some kind of locking mechanism, which guarantees
21954 that only one user is allowed to edit file at the given time.
21957 \begin_layout Standard
21958 SVN has two such mechanisms to provide mutual exclusivity for file access
21959 - locks and automatic setting of write permissions (see sec.
21961 \begin_inset CommandInset ref
21963 reference "subsec:Automatical-Locking-Property"
21968 \begin_inset Flex Code
21971 \begin_layout Plain Layout
21981 \begin_layout Plain Layout
21982 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21988 If this property is detected for a given document \SpecialChar LyX
21989 starts to use SVN locks
21990 for document editing automatically and the whole check-in/out mechanism
21991 switches to the same regimen as for RCS.
21992 This in particular means there are two different modes of file use in \SpecialChar LyX
21996 \begin_layout Itemize
21998 The loaded file is in the read-only mode.
21999 For editing on needs to check-out.
22004 consists of updating from the repository and gaining write lock.
22005 If the lock is not possible to obtain, we remain in unlocked state.
22008 \begin_layout Itemize
22010 The loaded file is in the 'normal' edit mode.
22011 No other user is allowed to edit the file.
22016 consists of commiting changes and releasing write-lock.
22017 If no changes have been made to the document, no commit will be produced
22021 \begin_layout Plain Layout
22022 Don't be puzzled by the fact that you will be asked for commit message anyway.
22027 and only the write-lock will be released.
22030 \begin_layout Standard
22034 \begin_layout Labeling
22035 \labelwidthstring 00.00.0000
22038 svn commit -q -m"<description>" "<file-name>"
22039 \begin_inset Newline newline
22042 svn unlock "<file-name>"
22045 \begin_layout Labeling
22046 \labelwidthstring 00.00.0000
22049 svn update "<file-name>"
22050 \begin_inset Newline newline
22053 svn lock "<file-name>"
22056 \begin_layout Subsubsection
22059 \begin_inset CommandInset label
22061 name "subsec:Automatical-Locking-Property"
22067 Automatic Locking Property
22070 \begin_layout Standard
22071 The above mentioned automatic setting of write permissions of the .lyx file
22074 File\SpecialChar menuseparator
22076 \begin_inset space ~
22079 Control\SpecialChar menuseparator
22080 Toggle locking property
22083 This command is active only when the file is not locked on the svn server
22085 you need to check-out before proceeding).
22088 \begin_layout Labeling
22089 \labelwidthstring 00.00.0000
22091 \begin_inset space ~
22097 \begin_layout Labeling
22098 \labelwidthstring 00.00.0000
22101 svn propset svn:needs-lock ON "<file-name>"
22104 \begin_layout Labeling
22105 \labelwidthstring 00.00.0000
22108 svn propdel svn:needs-lock "<file-name>"
22111 \begin_layout Subsubsection
22112 \begin_inset CommandInset label
22114 name "subsec:VCS-Revision-Information"
22118 Revision Information in Documents
22121 \begin_layout Standard
22122 There are more possibilities how to activate revision information in our
22126 \begin_layout Itemize
22132 \begin_layout Itemize
22133 tree revision information (
22134 \begin_inset Flex Code
22137 \begin_layout Plain Layout
22144 The result is the output of the
22145 \begin_inset Flex Code
22148 \begin_layout Plain Layout
22154 command, the following table gives you an idea, how to read the results.
22157 \begin_layout Standard
22159 \begin_inset Tabular
22160 <lyxtabular version="3" rows="6" columns="2">
22161 <features tabularvalignment="middle">
22162 <column alignment="center" valignment="top">
22163 <column alignment="center" valignment="top">
22165 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22168 \begin_layout Plain Layout
22174 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22177 \begin_layout Plain Layout
22185 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22188 \begin_layout Plain Layout
22194 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22197 \begin_layout Plain Layout
22198 mixed revision working copy
22205 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22208 \begin_layout Plain Layout
22214 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22217 \begin_layout Plain Layout
22218 modified working copy
22225 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22228 \begin_layout Plain Layout
22234 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22237 \begin_layout Plain Layout
22238 switched working copy
22245 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
22248 \begin_layout Plain Layout
22254 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22257 \begin_layout Plain Layout
22258 partial working copy, from a sparse checkout
22265 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22268 \begin_layout Plain Layout
22274 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22277 \begin_layout Plain Layout
22278 mixed revision, modified, switched working copy
22291 \begin_layout Itemize
22292 file revision information.
22293 The result comes from parsing the output of
22294 \begin_inset Flex Code
22297 \begin_layout Plain Layout
22299 \begin_inset space ~
22303 \begin_inset space ~
22307 \begin_inset space ~
22316 Supported flags are:
22320 \begin_layout Itemize
22321 version number of the last commit (
22322 \begin_inset Flex Code
22325 \begin_layout Plain Layout
22334 \begin_layout Itemize
22335 author of the last commit (
22336 \begin_inset Flex Code
22339 \begin_layout Plain Layout
22348 \begin_layout Itemize
22349 date of the last commit (
22350 \begin_inset Flex Code
22353 \begin_layout Plain Layout
22362 \begin_layout Itemize
22363 time of the last commit (
22364 \begin_inset Flex Code
22367 \begin_layout Plain Layout
22377 \begin_layout Standard
22378 You can obtain this info via InsetInfo (e.g.
22380 \begin_inset Flex Code
22383 \begin_layout Plain Layout
22384 info-insert buffer vcs-date
22390 The information will be available only when you have the file stored under
22391 svn managment (i.e.
22393 \begin_inset Flex Code
22396 \begin_layout Plain Layout
22402 directory is available with your document).
22406 \begin_layout Itemize
22407 Another—a hacking one—possibility is to use svn keywords
22411 \begin_layout Plain Layout
22412 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22418 In short – you set file keywords property (e.g.
22421 svn propset svn:keywords 'Rev' file.lyx
22423 ) and then paste keyword \SpecialChar TeX
22428 \begin_layout Plain Layout
22429 This is an easy way how to ensure that \SpecialChar LyX
22430 won't break the line in the middle
22436 tag in your document (e.g.
22441 \begin_layout Plain Layout
22449 This way svn client will automatically substitute revision number (e.g.
22454 \begin_layout Plain Layout
22461 ) after each update and commit.
22462 There are more problems with this approach.
22463 Firstly, the '$' character is used in \SpecialChar TeX
22464 world for math equations, so any
22465 occurence of math formula
22466 \begin_inset Formula $Rev$
22470 \begin_inset Formula $Rev:59$
22473 in your \SpecialChar LyX
22475 Similarly for other keywords like Id, Date, Author, etc.
22476 Secondly svn output is dependent on your locales, so its very easy that
22477 svn would produce some problematic strings once Date is used.
22478 Thirdly you get the whole 'Rev: 59' string in your document instead of
22480 Until subversion implements user's custom keywords it will be hard to use
22481 this approach reliably or let \SpecialChar LyX
22482 to support it directly.
22485 \begin_layout Subsection
22486 SVN and Windows Environment
22489 \begin_layout Quote
22490 My inclination is to say that if the user cannot figure out the command
22491 line operations on their own fairly quickly, they would be well advised
22492 to use TortoiseSVN.
22498 \begin_layout Subsubsection
22502 \begin_layout Standard
22503 In addition to installing \SpecialChar LyX
22504 , and having access to a Subversion repository,
22505 the user will need to install the Subversion client program.
22506 A Windows installer for the client program is available from
22507 \begin_inset CommandInset href
22510 target "http://www.collab.net/nonav/downloads/subversion/"
22515 The user may also want to install
22516 \begin_inset CommandInset href
22519 target "http://tortoisesvn.tigris.org/"
22523 , which integrates Subversion operations into the context (rightclick) menu
22524 of Windows Explorer.
22525 Operations done outside \SpecialChar LyX
22526 will typically be more convenient using the Explorer
22528 Note that TortoiseSVN is not a replacement for the client program, which
22529 is what \SpecialChar LyX
22533 \begin_layout Subsubsection
22534 Bringing a document under Subversion control
22537 \begin_layout Standard
22538 Before a \SpecialChar LyX
22539 document can be brought under version control in Subversion, its
22540 parent directory needs to be under version control.
22541 If the document is being added to a project already in the repository,
22542 this is accomplished by checking the project out to the directory where
22543 the new document will be placed.
22544 If the project itself is not yet under version control (for instance, if
22545 this document starts a new project), the directory must be imported into
22547 This is done outside \SpecialChar LyX
22549 Both import and checkout are easily accomplished from the Explorer context
22550 menu using TortoiseSVN, or alternatively can be done using the command
22551 line client at a DOS prompt.
22552 The procedure for importing the project using TortoiseSVN is described
22553 below, assuming an existing repository and a new project being started
22561 For information on using the Subversion client program, run
22568 \begin_layout Enumerate
22575 in Windows Explorer, right click it, and select
22577 TortoiseSVN\SpecialChar menuseparator
22581 If necessary, adjust the URL for the repository, then click OK.
22584 \begin_layout Enumerate
22585 Right click the level of the repository under which you want to place the
22586 new project folder (typically the top level) and click
22590 Supply a name for the project folder and click OK.
22591 Add a message for the log file if desired, then click OK again.
22592 The new project folder should appear in the repository.
22593 Finally, click OK again to exit the repository browser.
22596 \begin_layout Enumerate
22597 Once again right click
22603 , this time selecting SVN Checkout\SpecialChar ldots
22604 Select the URL of the project folder
22605 you just created in the repository, and set the checkout directory to
22613 You will be warned about a non-empty folder; click OK to proceed.
22614 You should now have a
22625 \begin_layout Enumerate
22626 Create or open your document in \SpecialChar LyX
22629 File\SpecialChar menuseparator
22631 \begin_inset space ~
22634 Control\SpecialChar menuseparator
22638 Add a log message and click OK to commit the document to version control.
22641 \begin_layout Standard
22642 From this point onward, you should have full functionality in the
22644 File\SpecialChar menuseparator
22646 \begin_inset space ~
22652 You also have the option of checking the document in and out, viewing its
22654 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22655 client program from a command prompt.
22658 \begin_layout Subsubsection
22659 SSH tunnel used with SVN under Windows
22662 \begin_layout Standard
22663 Compared with Linux setting up an svn client to communicate over ssh under
22664 Windows is a rather troublesome task.
22665 We will at least offer some hints how to setup the client side but prior
22666 knowledge about ssh and the Windows command line is needed, also be prepared
22667 for a great deal of frustration\SpecialChar ldots
22671 \begin_layout Enumerate
22672 Get an svn client for windows, as described in the previous sections.
22673 When it is a fresh install run some svn command (e.g.
22675 \begin_inset Flex Code
22678 \begin_layout Plain Layout
22684 ) to create config files, which you will need to change later on.
22687 \begin_layout Enumerate
22688 Choose an ssh client for Windows.
22689 There are several possibilities, we will use the one from Putty tools
22693 \begin_layout Plain Layout
22694 \begin_inset Flex URL
22697 \begin_layout Plain Layout
22699 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22710 You will need to set the connection up so that the client doesn't ask for
22711 any password from you.
22712 To keep things easy we will use only keys without any additional password
22717 \begin_layout Enumerate
22719 \begin_inset Flex Code
22722 \begin_layout Plain Layout
22729 Save your private .ppk key file and put the public one on the server side.
22730 If the SVN server runs on Linux, note that the format of the public key
22731 is not compatible with Linux openssh and you will need to direcly copy-paste
22734 Public key for pasting into OpenSSH authorized_keys file
22736 :” edit field into the server's
22737 \begin_inset Flex Code
22740 \begin_layout Plain Layout
22741 ~/.ssh/authorized_keys
22747 \begin_inset Flex Code
22750 \begin_layout Plain Layout
22759 \begin_layout Enumerate
22761 \begin_inset Flex Code
22764 \begin_layout Plain Layout
22771 In the SVN config file
22775 \begin_layout Plain Layout
22776 Exact path depends on Windows version, usually somewhere around
22777 \begin_inset Flex Code
22780 \begin_layout Plain Layout
22783 Documents and Settings
22797 \begin_inset Flex Code
22800 \begin_layout Plain Layout
22815 , section [tunnels], setup ssh command, e.g.
22817 \begin_inset Flex Code
22820 \begin_layout Plain Layout
22821 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22830 \begin_layout Plain Layout
22831 It will usually take a lot of time to get exact command right and it depends
22833 For example do not have some remote server saved as a default session in
22835 If things fail, try to connect via plink without SVN first.
22844 \begin_layout Enumerate
22845 Checkout the SVN archive, e.
22846 \begin_inset space \thinspace{}
22850 \begin_inset Newline newline
22854 \begin_inset Flex Code
22857 \begin_layout Plain Layout
22858 svn co svn+ssh://user@server/repository_path
22866 \begin_layout Subsubsection
22867 End-of-Line Conversions
22870 \begin_layout Standard
22871 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22873 use different line endings inside the .lyx files.
22874 This is not a problem as far as \SpecialChar LyX
22875 functionality is concerned, but the commit
22876 diffs will be huge and merge-conflicts prone.
22877 Fortunately SVN itself knows
22881 \begin_layout Plain Layout
22882 \begin_inset Flex URL
22885 \begin_layout Plain Layout
22887 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22897 how to deal with CR/LF problems when switching .lyx files to the
22898 \begin_inset Flex Code
22901 \begin_layout Plain Layout
22911 \begin_layout Plain Layout
22913 \begin_inset Flex Code
22916 \begin_layout Plain Layout
22917 svn propset svn:eol-style native FILE_NAME
22930 \begin_layout Subsection
22931 GIT commands in \SpecialChar LyX
22935 \begin_layout Standard
22936 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22938 You can find the commands in the
22940 File\SpecialChar menuseparator
22942 \begin_inset space ~
22948 Please note that if you use password protected access to repository via
22949 ssh, you will be asked in terminal window.
22951 was tested against GIT 1.7.
22955 \begin_layout Plain Layout
22956 Windows users please note that you need to ensure that git is on the path.
22957 This can be set from within \SpecialChar LyX
22960 Tools\SpecialChar menuseparator
22961 Preferences\SpecialChar menuseparator
22962 Paths\SpecialChar menuseparator
22973 \begin_layout Standard
22974 One big difference of GIT and the other supported version control systems
22975 is the distributed nature of GIT: With traditional version control systems
22976 there is one central server which hosts the repository.
22977 Users commit their changes to the server, and get updates made by other
22979 With GIT, users commit to a local repository.
22980 The local repository can be synchronized with one or more remote repositories
22982 \begin_inset Flex Code
22985 \begin_layout Plain Layout
22992 \begin_inset Flex Code
22995 \begin_layout Plain Layout
23003 does not interact in any way with remote GIT repositories.
23004 It works exclusively with the local repository in a very similar way as
23005 with a central CVS or SVN repository.
23006 If you use remote GIT repositories you need to do the
23007 \begin_inset Flex Code
23010 \begin_layout Plain Layout
23017 \begin_inset Flex Code
23020 \begin_layout Plain Layout
23026 operations with your favourite GIT client.
23029 \begin_layout Subsubsection
23035 \begin_layout Standard
23036 If your document is not under revision control, this is the only item shown
23038 And if it is under revision control, the
23042 item is not visible.
23045 \begin_layout Standard
23046 This command registers in GIT your document ONLY in case you have already
23047 the documents directory under GIT control (in particular
23052 This means you have to checkout the archive by yourself.
23055 \begin_layout Standard
23056 Then you are asked interactively to supply an initial description of the
23058 Don't forget that registered file is not yet commited.
23061 \begin_layout Standard
23062 GIT command that is run:
23065 \begin_inset Quotes eld
23069 \begin_inset Quotes erd
23075 \begin_layout Standard
23080 to understand the switches.
23083 \begin_layout Subsubsection
23089 \begin_layout Standard
23090 When you are finished editing a file, you commit your changes.
23091 When you do this, you are asked for a description of the changes.
23092 After that changes are commited.
23095 \begin_layout Standard
23098 git commit -q -m"<description>" <file-name>
23101 \begin_layout Subsubsection
23104 Revert To Repository Version
23107 \begin_layout Standard
23108 This will discard all changes made to the document since the last check
23110 You get a warning before changes are discarded.
23113 \begin_layout Standard
23117 \begin_inset Quotes eld
23121 \begin_inset Quotes erd
23127 \begin_layout Subsubsection
23133 \begin_layout Standard
23134 This will rename the current document including the version history.
23135 It requires a clean document without any changes since the last checkin.
23136 You are asked for a file name and a description of the rename operation.
23137 After that the document is renamed, both locally and in the repository.
23138 If the parent directories of the new and old file names differ, all relative
23139 paths of included files are adjusted (like in
23141 File\SpecialChar menuseparator
23146 Finally, the document is reloaded using the new name.
23149 \begin_layout Labeling
23150 \labelwidthstring 00.00.0000
23152 \begin_inset space ~
23156 \begin_inset space ~
23160 \begin_inset Newline newline
23164 \begin_inset Flex Code
23167 \begin_layout Plain Layout
23171 \begin_inset Quotes eld
23175 \begin_inset Quotes erd
23179 \begin_inset Quotes eld
23183 \begin_inset Quotes erd
23192 \begin_inset Newline newline
23196 \begin_inset Flex Code
23199 \begin_layout Plain Layout
23208 \begin_layout Subsubsection
23214 \begin_layout Standard
23215 This shows the complete history of the GIT document.
23219 \begin_inset Quotes eld
23223 \begin_inset Quotes erd
23228 is shown in a browser.
23231 \begin_layout Subsubsection
23235 \begin_layout Standard
23237 supports GIT hash number of the last commit to the file, author name, date
23238 and time of last commit.
23239 All those are extracted from
23241 git log -n 1 --pretty=format:%H%n%an%n%ai
23244 Tree version information is obtained via
23246 git describe --abbrev --dirty --long
23250 \begin_inset CommandInset ref
23252 reference "subsec:VCS-Revision-Information"
23259 \begin_layout Subsection
23263 \begin_layout Standard
23264 With the recent addition of the vc-command function \SpecialChar LyX
23265 power users are allowed
23266 to create their own commands for revision control.
23269 \begin_layout Standard
23270 As an example you can see how two TortoiseSVN commands could be integrated
23274 \begin_layout Description
23276 \begin_inset Flex Code
23279 \begin_layout Plain Layout
23280 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23288 \begin_layout Description
23290 \begin_inset Flex Code
23293 \begin_layout Plain Layout
23294 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23302 \begin_layout Subsection
23303 Version control and Document comparison
23306 \begin_layout Standard
23307 One of the typical uses of version control is to inspect the changes between
23308 revisions, usually by creating
23309 \begin_inset Flex Code
23312 \begin_layout Plain Layout
23319 While this is useful for plain text files, it is much less useful in the
23320 case of \SpecialChar LyX
23321 files, which have more a complicated structure.
23322 Hence we provide binding to the Document comparison feature.
23323 There are two ways of calling this feature - either by direct call of
23324 \begin_inset Flex Code
23327 \begin_layout Plain Layout
23334 function (for details see \SpecialChar LyX
23335 functions manual) or by icon/menu item
23336 \begin_inset Flex Noun
23339 \begin_layout Plain Layout
23340 Compare with older revision...
23346 One can either compare two chosen revisions of the document or he can simply
23347 compare the current version of edited text with older revisions (where
23349 \begin_inset Flex Noun
23352 \begin_layout Plain Layout
23358 ' revisions back means comparison of the edited file with last commited
23363 \begin_layout Standard
23364 This feature is supported for SVN and RCS though due to the more complicated
23365 versioning scheme of RCS there is a constraint – when addressing the revisions
23366 in dialog, numbers always point to the last number in RCS revision number,
23369 We don't currently support GIT addressing of revisions, one can just compare
23370 edited document with its revision X steps backs, where X is addressed as
23374 \begin_layout Section
23375 Literate Programming
23378 \begin_layout Standard
23383 (kayvan@sylvan.com)
23387 original documentation written by
23389 Edmar Wienskoski Jr.
23392 (edmar-w-jr@technologist.com)
23395 \begin_layout Subsection
23399 \begin_layout Standard
23400 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23402 programming, where it is assumed that you are familiar with this programming
23403 technique, and know what
23404 \begin_inset Quotes eld
23408 \begin_inset Quotes erd
23412 \begin_inset Quotes eld
23416 \begin_inset Quotes erd
23420 If that is not the case, please follow the web links provided in the following
23422 There is a lot of good documentation out there covering old development
23423 history to the latest tools tips.
23426 \begin_layout Standard
23427 It is also assumed that you are familiar with \SpecialChar LyX
23428 itself to a point that you
23429 are comfortable changing your \SpecialChar LyX
23430 preferences, and X resources file.
23431 If that is not the case please refer to other \SpecialChar LyX
23432 documentation to cover your
23436 \begin_layout Subsection
23437 Literate Programming
23440 \begin_layout Standard
23441 From the Literate Programming FAQ:
23444 \begin_layout Quotation
23445 Literate programming is the combination of documentation and source together
23446 in a fashion suited for reading by human beings.
23447 In fact, literate programs should be enjoyable reading, even inviting!
23448 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23449 and documentation in a single file.
23450 Literate programming tools then parse the file to produce either readable
23451 documentation or compilable source.
23452 The WEB style of literate programming was created by D.
23453 \begin_inset space \thinspace{}
23457 Knuth during the development of his \SpecialChar TeX
23458 typesetting software.
23462 \begin_layout Standard
23463 Another excerpt says:
23466 \begin_layout Quotation
23469 How is literate programming different from verbose commenting?
23472 \begin_layout Quotation
23473 There are three distinguishing characteristics.
23474 In order of importance, they are:
23478 \begin_layout Itemize
23479 flexible order of elaboration
23482 \begin_layout Itemize
23483 automatic support for browsing
23486 \begin_layout Itemize
23487 typeset documentation, especially diagrams and mathematics
23491 \begin_layout Standard
23492 Now that I sparked your curiosity, take a look in the references.
23495 \begin_layout Subsubsection
23499 \begin_layout Standard
23500 The complete Literate Programming FAQ can be found at:
23503 \begin_layout Quote
23504 Literate Programming FAQ
23505 \begin_inset Flex URL
23508 \begin_layout Plain Layout
23510 http://www.literateprogramming.com/lpfaq.pdf
23518 \begin_layout Standard
23519 The FAQ lists 23 (twenty three!) different literate programming tools.
23520 Where some are specialized or
23521 \begin_inset Quotes eld
23525 \begin_inset Quotes erd
23528 for particular programming languages, while other have general scope.
23533 for my own use for several reasons:
23536 \begin_layout Itemize
23537 It can generate the documentation either in \SpecialChar LaTeX
23541 \begin_layout Itemize
23542 It has a open architecture, i.
23543 \begin_inset space \thinspace{}
23547 \begin_inset space \space{}
23550 it is easy to plug in new filters and to perform special processing that
23555 \begin_layout Itemize
23556 There is a good selection of filters available already (the HTML is one
23560 \begin_layout Itemize
23564 \begin_layout Standard
23565 The Noweb web page can be found at:
23568 \begin_layout Quote
23570 \begin_inset Flex URL
23573 \begin_layout Plain Layout
23575 http://www.cs.virginia.edu/~nr/noweb/
23583 \begin_layout Standard
23584 Starting from there you can reach many other interesting links and even
23585 some literate program examples.
23588 \begin_layout Subsection
23590 and Literate Programming with Noweb
23593 \begin_layout Standard
23594 The \SpecialChar LyX
23595 support for Literate Programming is provided by using the generic \SpecialChar LyX
23597 converters mechanism.
23598 This support is provided in a
23599 \begin_inset Quotes eld
23603 \begin_inset Quotes erd
23607 \begin_inset space \thinspace{}
23611 \begin_inset space \space{}
23614 you will be able to use this new \SpecialChar LyX
23615 feature with some other literate programming
23616 tool of your choice by just changing your \SpecialChar LyX
23620 \begin_layout Subsubsection
23621 Generating documents and code (weaving and tangling)
23624 \begin_layout Paragraph
23625 Using the noweb module
23628 \begin_layout Standard
23629 If you have installed Noweb and \SpecialChar LyX
23630 successfully, whenever you open a new document,
23631 after you have chosen its document class, use the Document->Settings menu
23633 \begin_inset Quotes eld
23637 \begin_inset Quotes erd
23641 If Noweb is correctly installed, when you click on the
23642 \begin_inset Quotes eld
23646 \begin_inset Quotes erd
23649 link, you will see the
23650 \begin_inset Quotes eld
23654 \begin_inset Quotes erd
23657 module in the available list and you can add it to your document.
23660 \begin_layout Paragraph
23664 \begin_layout Standard
23666 enables you to write code with a layout named
23667 \begin_inset Flex Noun
23670 \begin_layout Plain Layout
23677 Noweb delimits chunks like this:
23680 \begin_layout LyX-Code
23684 \begin_layout LyX-Code
23688 \begin_layout LyX-Code
23692 \begin_layout LyX-Code
23696 \begin_layout LyX-Code
23700 \begin_layout Standard
23701 The problem is that whatever is written in between the << and the
23705 must be taken literally, i.
23706 \begin_inset space \thinspace{}
23710 \begin_inset space \space{}
23714 should be prevented from making any special interpretation of what has
23716 This is also handled by
23717 \begin_inset Flex Noun
23720 \begin_layout Plain Layout
23726 , that works like a normal paragraph but has a free spacing capability.
23729 \begin_layout Standard
23730 As a special note, you can also use the
23731 \begin_inset Quotes eld
23735 \begin_inset Quotes erd
23738 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23742 \begin_layout LyX-Code
23746 \begin_layout LyX-Code
23747 def some_function(args):
23750 \begin_layout LyX-Code
23751 "This is the doc string for this function."
23754 \begin_layout LyX-Code
23755 print "My args: ", args
23758 \begin_layout LyX-Code
23759 @ %def some_function
23762 \begin_layout Standard
23763 For an example of this usage and the resulting cross-reference output, look
23764 at the Literate python program in
23766 LIBDIR/examples/listerrors.lyx
23768 which should make this all clear.
23771 \begin_layout Paragraph
23772 Generating the documentation
23775 \begin_layout Standard
23776 At this point you already have a new document file with a proper document
23777 class, and with some code and text on it.
23778 How do I print it? The answer is simple, you select
23780 View\SpecialChar menuseparator
23784 Just like you would do for a plain document.
23785 No special procedure is required.
23788 \begin_layout Standard
23789 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23793 \begin_layout Enumerate
23796 Update\SpecialChar menuseparator
23799 menu option is chosen, a \SpecialChar LaTeX
23805 \begin_layout Standard
23806 If the document is of any literate class the generated file will be named
23807 with an extension name defined by the
23808 \begin_inset Quotes eld
23812 \begin_inset Quotes erd
23815 format (defined in the Preferences panel), otherwise the file will have
23824 \begin_layout Enumerate
23825 Note that the only difference so far is in the name of the file, no special
23826 processing is required by \SpecialChar LyX
23828 Given that you formatted the code using the
23829 \begin_inset Flex Noun
23832 \begin_layout Plain Layout
23838 layout that, by itself, takes care of the business.
23841 \begin_layout Enumerate
23842 If the document is of any literate class \SpecialChar LyX
23843 will then use the internal \SpecialChar LyX
23845 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23850 \begin_layout Plain Layout
23851 The converters are defined in the
23853 Tools\SpecialChar menuseparator
23857 \begin_inset Quotes eld
23861 \begin_inset Quotes erd
23873 manual for general information about converters.
23878 to generate the \SpecialChar LaTeX
23883 \begin_layout Standard
23884 Otherwise it will just skip this step.
23888 \begin_layout Enumerate
23889 Finally, \SpecialChar LaTeX
23890 is invoked and the regular post processing continues as in a plain
23894 \begin_layout Standard
23895 Independence from a particular
23896 \begin_inset Quotes eld
23900 \begin_inset Quotes erd
23903 is easily achieved by changing the commands that are run by the various
23907 \begin_layout Paragraph
23908 Generating the code
23911 \begin_layout Standard
23912 When the build menu option is chosen or the corresponding button in the
23913 toolbar is pressed, a \SpecialChar LaTeX
23914 file is generated just like step 1 above.
23915 Next, \SpecialChar LyX
23921 This converter needs to be defined by the user and is not installed by
23922 default, though the Program format is.
23923 This converter (like any other converter) will have two parts:
23926 \begin_layout Enumerate
23927 The converter program itself.
23928 This program performs the conversion from the one format to the other (in
23929 this case, from the Noweb format to the Program pseudo-format).
23932 \begin_layout Enumerate
23933 The error log parser.
23934 This is a program whose sole purpose is to rewrite error messages in a
23935 format that \SpecialChar LyX
23937 This makes it possible for \SpecialChar LyX
23938 to place error boxes in the right places in
23942 \begin_layout Standard
23943 The first part, the
23944 \begin_inset Quotes eld
23948 \begin_inset Quotes erd
23951 setting, should be set to
23952 \begin_inset Newline newline
23956 \begin_inset Quotes eld
23964 \begin_inset Quotes erd
23968 \begin_inset Newline newline
23971 This basically means that \SpecialChar LyX
23973 \begin_inset Quotes eld
23977 \begin_inset Quotes erd
23980 (a program or script) with the name of the Noweb file (normally a file
23981 in the \SpecialChar LyX
23982 temp directory) and the directory path of the original \SpecialChar LyX
23987 \begin_layout Standard
23988 This is an implementation of
23989 \begin_inset Quotes eld
23993 \begin_inset Quotes erd
23996 that you can place in a directory on your path:
23999 \begin_layout Standard
24000 \begin_inset VSpace defskip
24006 \begin_layout Standard
24007 \begin_inset Newpage pagebreak
24013 \begin_layout Standard
24019 \begin_layout Standard
24025 \begin_layout Standard
24028 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
24031 \begin_layout Standard
24032 \begin_inset VSpace defskip
24038 \begin_layout Standard
24039 The next part of the converter setting is the
24040 \begin_inset Quotes eld
24044 \begin_inset Quotes erd
24047 which is to be set to
24048 \begin_inset Newline newline
24052 \begin_inset Quotes eld
24057 parselog=$$s/scripts/listerrors
24060 \begin_inset Quotes erd
24064 \begin_inset Newline newline
24067 This will run any errors that are generated by the
24068 \begin_inset Quotes eld
24072 \begin_inset Quotes erd
24075 process through the
24076 \begin_inset Quotes eld
24080 \begin_inset Quotes erd
24086 \begin_layout Standard
24087 The build will normally take place in \SpecialChar LyX
24088 's temporary directory, so the files
24089 produced by the conversion will be in that directory.
24091 will copy out what it regards as the `main' file, but the
24095 conversion may produce several files, and so most of these would then be
24096 deleted when \SpecialChar LyX
24098 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
24099 the build-script chunk can place the generated files in that location.
24102 \begin_layout Paragraph
24103 Build instructions in the document
24106 \begin_layout Standard
24107 The last piece of the integration between \SpecialChar LyX
24109 \begin_inset Quotes eld
24113 \begin_inset Quotes erd
24117 Generally, the instructions for building your program should be embedded
24118 in a chunk of its own.
24120 \begin_inset Quotes eld
24124 \begin_inset Quotes erd
24127 above uses the notangle command to look for this chunk (called
24128 \begin_inset Quotes eld
24132 \begin_inset Quotes erd
24135 ) and runs its contents through
24136 \begin_inset Quotes eld
24140 \begin_inset Quotes erd
24146 \begin_layout Standard
24147 Typically, such a chunk would look something like this:
24150 \begin_layout LyX-Code
24154 \begin_layout LyX-Code
24156 \begin_inset Newline newline
24159 if [ -z "${NOWEB_SOURCE}" ]
24160 \begin_inset Newline newline
24166 \begin_layout LyX-Code
24167 NOWEB_SOURCE=myfile.nw
24168 \begin_inset Newline newline
24172 \begin_inset Newline newline
24176 code to extract files ...
24177 use NOWEB_OUTPUT_DIR here ...]
24178 \begin_inset Newline newline
24182 code to compile files ...]
24183 \begin_inset Newline newline
24189 \begin_layout Standard
24192 LIBDIR/examples/listerrors.lyx
24196 LIBDIR/examples/Literate.lyx
24198 which implement two versions of the
24199 \begin_inset Quotes eld
24203 \begin_inset Quotes erd
24206 program for some illustrations of how all of these pieces go together or
24209 LIBDIR/examples/noweb2lyx.lyx.
24212 Interestingly, these three files show off the language-indepence of the
24214 literate programming support since they are written in Python, C and Perl
24218 \begin_layout Subsubsection
24219 Configuring \SpecialChar LyX
24223 \begin_layout Standard
24224 All the Literate Programming support is configured by the
24226 Tools\SpecialChar menuseparator
24230 \begin_inset Quotes eld
24234 \begin_inset Quotes erd
24238 The important parts are:
24241 \begin_layout Description
24243 \begin_inset space ~
24247 \begin_inset Quotes eld
24251 \begin_inset Quotes erd
24255 \begin_inset space ~
24258 format Set up via the File Formats tab, this is where the Noweb-specific
24268 , the file extension is set to
24273 This tells \SpecialChar LyX
24274 to create a file with a
24278 extension in the first step of the conversion process.
24281 \begin_layout Description
24283 \begin_inset space ~
24291 \begin_inset space ~
24294 format This is an empty format whose sole purpose is to be the endpoint
24295 of a conversion (which then allows us to set up a converter for it).
24298 \begin_layout Description
24308 This converter performs the
24309 \begin_inset Quotes eld
24313 \begin_inset Quotes erd
24316 of the literate document.
24317 For Noweb, it is set to
24318 \begin_inset Quotes eld
24323 noweave -delay -index $$i > $$o
24326 \begin_inset Quotes erd
24332 \begin_layout Description
24342 \begin_inset Quotes eld
24346 \begin_inset Quotes erd
24350 As stated above, the Converter is set to
24351 \begin_inset Quotes eld
24359 \begin_inset Quotes erd
24362 , with Flags set to
24363 \begin_inset Newline newline
24367 \begin_inset Quotes eld
24372 parselog=$$s/scripts/listerrors
24375 \begin_inset Quotes erd
24381 \begin_layout Subsubsection
24385 \begin_layout Standard
24386 There is also a new function implemented in the \SpecialChar LyX
24388 \begin_inset Quotes eld
24391 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24395 \begin_layout Standard
24396 When debugging code with ddd/gdb, it is possible to invoke a text editor
24397 at the current execution position with a single key stroke.
24398 The default ddd configuration for that is shift-ctrl-V.
24399 It happens that you can define the editor command line invocation in ddd
24402 Edit\SpecialChar menuseparator
24403 Preferences\SpecialChar menuseparator
24406 dialog and changing the "Edit Sources" entry.
24409 \begin_layout Standard
24410 I take advantage of the newly created \SpecialChar LyX
24411 server function and this ddd feature,
24413 \begin_inset Quotes eld
24417 \begin_inset Quotes erd
24423 \begin_layout Standard
24424 \begin_inset VSpace defskip
24430 \begin_layout Standard
24433 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24436 \begin_layout Standard
24437 \begin_inset VSpace defskip
24443 \begin_layout Standard
24444 With this, whenever you are using ddd and find a point in the program that
24445 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24446 ddd will forward this information to \SpecialChar LyX
24447 through the \SpecialChar LyX
24448 server and then the
24450 window will show the same file with the cursor at the same position ddd
24452 No more guessing or long scrolling to locate a point in the program back
24456 \begin_layout Standard
24457 Note however that you must enable the \SpecialChar LyX
24458 server to get this feature working
24459 (it is disabled by default).
24460 You can enable it in
24472 ) by entering in the
24478 \begin_inset Quotes eld
24483 /home/<your-home-directory>/.lyx/lyxpipe
24486 \begin_inset Quotes erd
24492 \begin_layout Standard
24493 Read the \SpecialChar LyX
24494 server documentation in the
24496 Customization Manual
24498 for further information.
24501 \begin_layout Subsubsection
24505 \begin_layout Standard
24506 There are six new buttons that can be added to your \SpecialChar LyX
24508 Five of these buttons are short cuts to layout styles:
24531 The last one is a short cut to the
24532 \begin_inset Quotes eld
24536 \begin_inset Quotes erd
24543 \begin_layout Standard
24545 has a range of buttons that are available for tool bar customization.
24546 In my toolbar I like to combine the six short cuts above with two more:
24551 \SpecialChar menuseparator
24556 \SpecialChar menuseparator
24563 Document\SpecialChar menuseparator
24564 View\SpecialChar menuseparator
24568 Here is how it looks like:
24571 \begin_layout LyX-Code
24575 \begin_layout LyX-Code
24579 \begin_layout LyX-Code
24580 Icon "layout Standard"
24583 \begin_layout LyX-Code
24584 Icon "layout Section"
24587 \begin_layout LyX-Code
24588 Icon "layout \SpecialChar LaTeX
24592 \begin_layout LyX-Code
24593 Icon "layout \SpecialChar LyX
24597 \begin_layout LyX-Code
24598 Icon "layout Chunk"
24601 \begin_layout LyX-Code
24605 \begin_layout LyX-Code
24609 \begin_layout LyX-Code
24610 Icon "buffer-typeset"
24613 \begin_layout LyX-Code
24614 Icon "build-program"
24617 \begin_layout LyX-Code
24621 \begin_layout LyX-Code
24625 \begin_layout LyX-Code
24629 \begin_layout LyX-Code
24633 \begin_layout LyX-Code
24637 \begin_layout Subsubsection
24638 Colors customization
24641 \begin_layout Standard
24642 There are a number of colors in \SpecialChar LyX
24643 that can be customized in
24648 One of the things that bothers people is the \SpecialChar LaTeX
24650 The default color is red, since the chunks uses \SpecialChar LaTeX
24651 font, and there is a lot
24652 of chunks in literate documents, you may get tired of seeing everything
24654 You can change it by going to the tabs
24663 \begin_layout Standard
24664 The next thing is the visible presence of the newline character in the screen.
24665 You can choose the color of this particular character and make it blend
24667 I recommend you choosing a color that is close to the background but not
24668 equal, that way you still can see it is there, but it is not bothering
24672 \begin_layout Subsection
24677 \begin_layout Standard
24686 is documented in the
24690 example file and in the Sweave manual (menu
24692 Help\SpecialChar menuseparator
24698 \begin_layout Chapter
24702 \begin_layout Standard
24703 You can do everything with \SpecialChar LyX
24704 that you can do with \SpecialChar LaTeX
24706 However, \SpecialChar LyX
24707 cannot support every \SpecialChar LaTeX
24709 But you can always use \SpecialChar TeX
24711 This chapter shows you some more special things you might want to use.
24712 For other special things you can do with figures, tables, floats, boxes
24713 and notes, have a look at the
24716 \begin_inset space ~
24724 \begin_layout Section
24725 Multiple Text Columns
24728 \begin_layout Standard
24729 This feature is independent of the option
24731 Two-column document
24733 in the document settings under
24738 If you want to have 2
24739 \begin_inset space ~
24742 columns for the whole document, it is recommended to use the
24744 Two-column document
24747 For all other cases use this feature.
24750 \begin_layout Standard
24751 To use multiple text columns in your document, you have to load the module
24758 Document\SpecialChar menuseparator
24759 Settings\SpecialChar menuseparator
24762 ) and must have the \SpecialChar LaTeX
24770 \begin_layout Standard
24771 Footnotes within multiple columns will be placed at the bottom of the page
24772 and not under each column.
24773 Within the different columns you can use everything, with the limitation
24774 that for floats you need to use the float option
24781 \begin_layout Subsection
24785 \begin_layout Standard
24786 If you want to have 2
24787 \begin_inset space ~
24790 columns in your text, insert a multicolumn inset via the menu
24792 Insert\SpecialChar menuseparator
24794 \begin_inset space ~
24797 Insets\SpecialChar menuseparator
24799 \begin_inset space ~
24804 where the columns should start.
24805 Write all text that should be printed in 2
24806 \begin_inset space ~
24809 columns into this inset.
24812 \begin_layout Standard
24813 Here is an example:
24816 \begin_layout Standard
24818 \begin_inset Flex Multiple Columns
24821 \begin_layout Plain Layout
24826 The Adventure of the Empty House
24829 \begin_inset Newline newline
24832 by Sir Arthur Conan Doyle
24835 \begin_layout Plain Layout
24838 It was in the spring of the year 1894 that all London was interested, and
24839 the fashionable world dismayed, by the murder of the Honourable Ronald
24840 Adair under most unusual and inexplicable circumstances.
24841 The public has already learned those particulars of the crime which came
24842 out in the police investigation, but a good deal was suppressed upon that
24843 occasion, since the case for the prosecution was so overwhelmingly strong
24844 that it was not necessary to bring forward all the facts.
24845 Only now, at the end of nearly ten years, am I allowed to supply those
24846 missing links which make up the whole of that remarkable chain.
24847 The crime was of interest in itself, but that interest was as nothing to
24848 me compared to the inconceivable sequel, which afforded me the greatest
24849 shock and surprise of any event in my adventurous life.
24850 Even now, after this long interval, I find myself thrilling as I think
24851 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24852 ty which utterly submerged my mind.
24853 Let me say to that public, which has shown some interest in those glimpses
24854 which I have occasionally given them of the thoughts and actions of a very
24855 remarkable man, that they are not to blame me if I have not shared my knowledge
24856 with them, for I should have considered it my first duty to do so, had
24857 I not been barred by a positive prohibition from his own lips, which was
24858 only withdrawn upon the third of last month.
24866 \begin_layout Standard
24867 To get 3 or more columns, set the cursor into the multicolumn inset and
24870 Insert\SpecialChar menuseparator
24872 \begin_inset space ~
24876 \begin_inset space ~
24882 The number of the desired columns is written into that inset (for 3
24883 \begin_inset space ~
24887 \begin_inset Quotes eld
24891 \begin_inset Quotes erd
24895 \begin_inset Newline newline
24898 Here is an example with 3
24899 \begin_inset space ~
24905 \begin_layout Standard
24906 \begin_inset Flex Multiple Columns
24909 \begin_layout Plain Layout
24912 \begin_inset Argument 1
24915 \begin_layout Plain Layout
24921 It can be imagined that my close intimacy with Sherlock Holmes had interested
24922 me deeply in crime, and that after his disappearance I never failed to
24923 read with care the various problems which came before the public.
24924 And I even attempted, more than once, for my own private satisfaction,
24925 to employ his methods in their solution, though with indifferent success.
24926 There was none, however, which appealed to me like this tragedy of Ronald
24928 As I read the evidence at the inquest, which led up to a verdict of willful
24929 murder against some person or persons unknown, I realized more clearly
24930 than I had ever done the loss which the community had sustained by the
24931 death of Sherlock Holmes.
24932 There were points about this strange business which would, I was sure,
24933 have specially appealed to him, and the efforts of the police would have
24934 been supplemented, or more probably anticipated, by the trained observation
24935 and the alert mind of the first criminal agent in Europe.
24936 All day, as I drove upon my round, I turned over the case in my mind and
24937 found no explanation which appeared to me to be adequate.
24938 At the risk of telling a twice-told tale, I will recapitulate the facts
24939 as they were known to the public at the conclusion of the inquest.
24947 \begin_layout Standard
24948 You can have up to 10
24949 \begin_inset space ~
24952 columns if you want to, but that might not be very pleasant for the readers
24956 \begin_layout Standard
24957 \begin_inset Newpage newpage
24963 \begin_layout Subsection
24964 Columns inside Columns
24967 \begin_layout Standard
24968 You can also have columns inside columns:
24971 \begin_layout Standard
24972 \begin_inset Flex Multiple Columns
24975 \begin_layout Plain Layout
24978 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24979 at that time governor of one of the Australian colonies.
24980 Adair's mother had returned from Australia to undergo the operation for
24981 cataract, and she, her son Ronald, and her daughter Hilda were living together
24985 \begin_layout Plain Layout
24986 \begin_inset Flex Multiple Columns
24989 \begin_layout Plain Layout
24992 The youth moved in the best society–had, so far as was known, no enemies
24993 and no particular vices.
24994 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24995 had been broken off by mutual consent some months before, and there was
24996 no sign that it had left any very profound feeling behind it.
24997 For the rest {sic} the man's life moved in a narrow and conventional circle,
24998 for his habits were quiet and his nature unemotional.
24999 Yet it was upon this easy-going young aristocrat that death came, in most
25000 strange and unexpected form, between the hours of ten and eleven-twenty
25001 on the night of March 30, 1894.
25009 \begin_layout Plain Layout
25012 Ronald Adair was fond of cards–playing continually, but never for such stakes
25014 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
25015 It was shown that, after dinner on the day of his death, he had played
25016 a rubber of whist at the latter club.
25017 He had also played there in the afternoon.
25022 The evidence of those who had played with him– Mr.
25023 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
25024 and that there was a fairly equal fall of the cards.
25025 Adair might have lost five pounds, but not more.
25026 His fortune was a considerable one, and such a loss could not in any way
25028 He had played nearly every day at one club or other, but he was a cautious
25029 player, and usually rose a winner.
25030 It came out in evidence that, in partnership with Colonel Moran, he had
25031 actually won as much as four hundred and twenty pounds in a sitting, some
25032 weeks before, from Godfrey Milner and Lord Balmoral.
25033 So much for his recent history as it came out at the inquest.
25041 \begin_layout Subsection
25045 \begin_layout Standard
25046 The examples in this section show some more special features of multiple
25050 \begin_layout Standard
25051 For more features of multiple columns, have a look at the documentation
25052 of the \SpecialChar LaTeX
25058 \begin_inset CommandInset citation
25067 \begin_layout Subsubsection
25071 \begin_layout Standard
25072 To add a preface text for multiple columns, set the cursor into the multicolumn
25073 inset and use the menu
25075 Insert\SpecialChar menuseparator
25079 Write your preface text into that inset.
25080 \begin_inset Newline newline
25083 This is an example with some preface text:
25086 \begin_layout Standard
25087 \begin_inset VSpace bigskip
25093 \begin_layout Standard
25094 \begin_inset Flex Multiple Columns
25097 \begin_layout Plain Layout
25098 \begin_inset Argument 2
25101 \begin_layout Plain Layout
25102 And the story continues and continues and continues and continues\SpecialChar ldots
25110 On the evening of the crime, he returned from the club exactly at ten.
25111 His mother and sister were out spending the evening with a relation.
25112 The servant deposed that she heard him enter the front room on the second
25113 floor, generally used as his sitting-room.
25114 She had lit a fire there, and as it smoked she had opened the window.
25115 No sound was heard from the room until eleven-twenty, the hour of the return
25116 of Lady Maynooth and her daughter.
25117 Desiring to say good-night, she attempted to enter her son's room.
25118 The door was locked on the inside, and no answer could be got to their
25119 cries and knocking.
25120 Help was obtained, and the door forced.
25121 The unfortunate young man was found lying near the table.
25122 His head had been horribly mutilated by an expanding revolver bullet, but
25123 no weapon of any sort was to be found in the room.
25131 \begin_layout Standard
25132 You can also use a section heading as the preface if you use a section command
25133 as \SpecialChar TeX
25135 For example the command
25138 \begin_layout Standard
25143 subsection{subsection title}
25146 \begin_layout Standard
25147 creates a subsection.
25148 In this example the preface is a subsubsection:
25151 \begin_layout Standard
25152 \begin_inset Flex Multiple Columns
25155 \begin_layout Plain Layout
25156 \begin_inset Argument 2
25159 \begin_layout Plain Layout
25163 \begin_layout Plain Layout
25172 This is a subsubsection heading as a preface
25176 \begin_layout Plain Layout
25190 A minute examination of the circumstances served only to make the case more
25192 In the first place, no reason could be given why the young man should have
25193 fastened the door upon the inside.
25194 There was the possibility that the murderer had done this, and had afterwards
25195 escaped by the window.
25196 The drop was at least twenty feet, however, and a bed of crocuses in full
25198 Neither the flowers nor the earth showed any sign of having been disturbed,
25199 nor were there any marks upon the narrow strip of grass which separated
25200 the house from the road.
25201 Apparently, therefore, it was the young man himself who had fastened the
25203 But how did he come by his death? No one could have climbed up to the window
25204 without leaving traces.
25205 Suppose a man had fired through the window, he would indeed be a remarkable
25206 shot who could with a revolver inflict so deadly a wound.
25207 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25208 a hundred yards of the house.
25209 No one had heard a shot.
25217 \begin_layout Standard
25218 If there is less vertical space than 6
25219 \begin_inset space ~
25222 text lines is left on the page at the beginning of the multiple columns,
25223 a page break will be inserted before the multiple columns.
25224 Depending on the number of lines of the preface text, you might want to
25226 This is done by setting the cursor into the mulitcolumn inset behind the
25227 preface (if there is any) and using the menu
25229 Insert\SpecialChar menuseparator
25231 \begin_inset space ~
25235 \begin_inset space ~
25239 \begin_inset space ~
25245 Insert into that inset the amount of space like e.
25246 \begin_inset space \thinspace{}
25250 \begin_inset space \space{}
25254 \begin_inset Quotes eld
25258 \begin_inset Quotes erd
25262 \begin_inset Newline newline
25265 In this example the space is set to 7
25266 \begin_inset space ~
25269 text lines by using
25270 \begin_inset Quotes eld
25276 \begin_inset Quotes erd
25285 needs to be inserted as \SpecialChar TeX
25289 \begin_layout Standard
25290 \begin_inset Flex Multiple Columns
25293 \begin_layout Plain Layout
25294 \begin_inset Argument 3
25297 \begin_layout Plain Layout
25302 \begin_layout Plain Layout
25318 On the evening of the crime, he returned from the club exactly at ten.
25319 His mother and sister were out spending the evening with a relation.
25320 The servant deposed that she heard him enter the front room on the second
25321 floor, generally used as his sitting-room.
25322 She had lit a fire there, and as it smoked she had opened the window.
25323 No sound was heard from the room until eleven-twenty, the hour of the return
25324 of Lady Maynooth and her daughter.
25325 Desiring to say good-night, she attempted to enter her son's room.
25326 The door was locked on the inside, and no answer could be got to their
25327 cries and knocking.
25328 Help was obtained, and the door forced.
25329 The unfortunate young man was found lying near the table.
25330 His head had been horribly mutilated by an expanding revolver bullet, but
25331 no weapon of any sort was to be found in the room.
25339 \begin_layout Subsubsection
25343 \begin_layout Standard
25344 The amount of space before and after multiple columns can be changed by
25345 changing the length
25352 For example the command
25355 \begin_layout Standard
25365 \begin_layout Standard
25366 in \SpecialChar TeX
25367 Code changes its value to 3
25368 \begin_inset space \thinspace{}
25372 The change must be made before the multiple columns' start.
25373 The predefined value is 13
25374 \begin_inset space \thinspace{}
25380 \begin_layout Standard
25388 \begin_inset space \thinspace{}
25394 \begin_layout Standard
25398 \begin_layout Plain Layout
25404 multicolsep}{2.5cm}
25412 \begin_layout Standard
25413 \begin_inset Flex Multiple Columns
25416 \begin_layout Plain Layout
25419 All day I turned these facts over in my mind, endeavouring to hit upon some
25420 theory which could reconcile them all, and to find that line of least resistanc
25421 e which my poor friend had declared to be the starting-point of every investigat
25423 I confess that I made little progress.
25424 In the evening I strolled across the Park, and found myself about six o'clock
25425 at the Oxford Street end of Park Lane.
25426 A group of loafers upon the pavements, all staring up at a particular window,
25427 directed me to the house which I had come to see.
25428 A tall, thin man with coloured glasses, whom I strongly suspected of being
25429 a plain-clothes detective, was pointing out some theory of his own, while
25430 the others crowded round to listen to what he said.
25431 I got as near him as I could, but his observations seemed to me to be absurd,
25432 so I withdrew again in some disgust.
25433 As I did so I struck against an elderly, deformed man, who had been behind
25434 me, and I knocked down several books which he was carrying.
25442 \begin_layout Standard
25443 \begin_inset Note Greyedout
25446 \begin_layout Plain Layout
25451 The values you set with
25457 will be used for all following multiple columns until you change them again.
25465 \begin_layout Standard
25469 \begin_layout Plain Layout
25481 \begin_inset Note Note
25484 \begin_layout Plain Layout
25485 go back to the default
25493 \begin_layout Standard
25494 \begin_inset Newpage newpage
25500 \begin_layout Subsubsection
25504 \begin_layout Standard
25505 A column break can be forced by inserting the command
25511 as \SpecialChar TeX
25512 Code to that position in the text where the column should be broken.
25513 Note that this leads in most cases to whitespace in the text.
25514 \begin_inset Newline newline
25517 Here is an example:
25520 \begin_layout Standard
25521 \begin_inset Flex Multiple Columns
25524 \begin_layout Plain Layout
25527 \begin_inset Quotes eld
25530 You're surprised to see me, sir,
25531 \begin_inset Quotes erd
25534 said he, in a strange, croaking voice.
25537 \begin_layout Plain Layout
25540 I acknowledged that I was.
25543 \begin_layout Plain Layout
25546 \begin_inset Quotes eld
25549 Well, I've a conscience, sir, and when I chanced to see you go into this
25550 house, as I came hobbling after you, I thought to myself, I'll just step
25551 in and see that kind gentleman, and tell him that if I was a bit gruff
25552 in my manner there was not any harm meant, and that I am much obliged to
25553 him for picking up my books.
25554 \begin_inset Quotes erd
25560 \begin_layout Plain Layout
25563 \begin_inset Quotes eld
25566 You make too much of a trifle,
25567 \begin_inset Quotes erd
25572 \begin_inset Quotes eld
25575 May I ask how you knew who I was?
25576 \begin_inset Quotes erd
25579 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25583 \begin_layout Plain Layout
25595 \begin_layout Plain Layout
25598 \begin_inset Quotes eld
25601 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25602 you'll find my little bookshop at the corner of Church Street, and very
25603 happy to see you, I am sure.
25604 Maybe you collect yourself, sir.
25608 \begin_inset space ~
25621 –a bargain, every one of them.
25622 With five volumes you could just fill that gap on that second shelf.
25623 It looks untidy, does it not, sir?
25624 \begin_inset Quotes erd
25635 \begin_layout Subsubsection
25639 \begin_layout Standard
25640 The width of the columns is automatically calculated, but you can modify
25641 the space between the columns.
25642 This is done by changing the length
25649 Its predefined value is 10
25650 \begin_inset space \thinspace{}
25654 Here is an example where
25661 \begin_inset space \thinspace{}
25667 \begin_layout Standard
25671 \begin_layout Plain Layout
25685 \begin_layout Standard
25686 \begin_inset Flex Multiple Columns
25689 \begin_layout Plain Layout
25692 My observations of No.
25693 \begin_inset space \space{}
25696 427 Park Lane did little to clear up the problem in which I was interested.
25697 The house was separated from the street by a low wall and railing, the
25698 whole not more than five feet high.
25699 It was perfectly easy, therefore, for anyone to get into the garden, but
25700 the window was entirely inaccessible, since there was no water pipe or
25701 anything which could help the most active man to climb it.
25702 More puzzled than ever, I retraced my steps to Kensington.
25703 I had not been in my study five minutes when the maid entered to say that
25704 a person desired to see me.
25705 To my astonishment it was none other than my strange old book collector,
25706 his sharp, wizened face peering out from a frame of white hair, and his
25707 precious volumes, a dozen of them at least, wedged under his right arm.
25715 \begin_layout Standard
25719 \begin_layout Plain Layout
25731 \begin_inset Note Note
25734 \begin_layout Plain Layout
25735 go back to the default
25743 \begin_layout Subsubsection
25747 \begin_layout Standard
25748 Between the columns a rule with a width of the length
25755 If this rule width is set to 0
25756 \begin_inset space \thinspace{}
25759 pt (this is the default), the rule is suppressed.
25760 In the following example the rule is 2
25761 \begin_inset space \thinspace{}
25767 \begin_layout Standard
25771 \begin_layout Plain Layout
25777 columnseprule}{2pt}
25785 \begin_layout Standard
25786 \begin_inset Flex Multiple Columns
25789 \begin_layout Plain Layout
25792 \begin_inset Quotes eld
25795 You're surprised to see me, sir,
25796 \begin_inset Quotes erd
25799 said he, in a strange, croaking voice.
25802 \begin_layout Plain Layout
25805 I acknowledged that I was.
25808 \begin_layout Plain Layout
25811 \begin_inset Quotes eld
25814 Well, I've a conscience, sir, and when I chanced to see you go into this
25815 house, as I came hobbling after you, I thought to myself, I'll just step
25816 in and see that kind gentleman, and tell him that if I was a bit gruff
25817 in my manner there was not any harm meant, and that I am much obliged to
25818 him for picking up my books.
25819 \begin_inset Quotes erd
25825 \begin_layout Plain Layout
25828 \begin_inset Quotes eld
25831 You make too much of a trifle,
25832 \begin_inset Quotes erd
25837 \begin_inset Quotes eld
25840 May I ask how you knew who I was?
25841 \begin_inset Quotes erd
25847 \begin_layout Plain Layout
25850 \begin_inset Quotes eld
25853 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25854 you'll find my little bookshop at the corner of Church Street, and very
25855 happy to see you, I am sure.
25856 Maybe you collect yourself, sir.
25860 \begin_inset space ~
25873 –a bargain, every one of them.
25874 With five volumes you could just fill that gap on that second shelf.
25875 It looks untidy, does it not, sir?
25876 \begin_inset Quotes erd
25887 \begin_layout Standard
25888 \begin_inset VSpace defskip
25894 \begin_layout Standard
25895 The rule can be colored by redefining the command
25902 This is done by inserting the command
25903 \begin_inset Newline newline
25912 columnseprulecolor}{
25917 \begin_inset Newline newline
25920 as \SpecialChar TeX
25921 Code before the multicolumn inset.
25926 in this command by a color of your choice.
25927 You can use all pre- and self-defined colors.
25935 \begin_inset space ~
25940 for more information about pre- and self-defined colors.
25941 To go back to the default color insert the command
25942 \begin_inset Newline newline
25951 columnseprulecolor}{
25956 \begin_inset Newline newline
25959 Here is the example with a cyan rule and 1
25960 \begin_inset space \thinspace{}
25963 cm column separation:
25966 \begin_layout Standard
25970 \begin_layout Plain Layout
25979 \begin_layout Plain Layout
25985 columnseprulecolor}{
25995 \begin_layout Standard
25996 \begin_inset Flex Multiple Columns
25999 \begin_layout Plain Layout
26002 \begin_inset Quotes eld
26005 You're surprised to see me, sir,
26006 \begin_inset Quotes erd
26009 said he, in a strange, croaking voice.
26012 \begin_layout Plain Layout
26015 I acknowledged that I was.
26018 \begin_layout Plain Layout
26021 \begin_inset Quotes eld
26024 Well, I've a conscience, sir, and when I chanced to see you go into this
26025 house, as I came hobbling after you, I thought to myself, I'll just step
26026 in and see that kind gentleman, and tell him that if I was a bit gruff
26027 in my manner there was not any harm meant, and that I am much obliged to
26028 him for picking up my books.
26029 \begin_inset Quotes erd
26035 \begin_layout Plain Layout
26038 \begin_inset Quotes eld
26041 You make too much of a trifle,
26042 \begin_inset Quotes erd
26047 \begin_inset Quotes eld
26050 May I ask how you knew who I was?
26051 \begin_inset Quotes erd
26057 \begin_layout Plain Layout
26060 \begin_inset Quotes eld
26063 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26064 you'll find my little bookshop at the corner of Church Street, and very
26065 happy to see you, I am sure.
26066 Maybe you collect yourself, sir.
26070 \begin_inset space ~
26083 –a bargain, every one of them.
26084 With five volumes you could just fill that gap on that second shelf.
26085 It looks untidy, does it not, sir?
26086 \begin_inset Quotes erd
26097 \begin_layout Standard
26101 \begin_layout Plain Layout
26107 columnseprule}{0pt}
26110 \begin_layout Plain Layout
26116 columnseprulecolor}{
26124 \begin_inset Note Note
26127 \begin_layout Plain Layout
26128 go back to the default
26136 \begin_layout Section
26137 Non-standard Paragraph Shapes
26140 \begin_layout Standard
26143 as well as any other text processor uses by default rectangular paragraphs.
26144 For special cases like for example posters, invitation cards or poems you
26145 can modify the paragraph shape to one of your choice.
26146 This can be done by using the \SpecialChar LaTeX
26151 which is loaded by using in the document settings the module
26153 Custom paragraph shapes
26158 \begin_layout Subsection
26162 \begin_layout Standard
26167 provides the following shapes:
26170 \begin_layout Standard
26171 \begin_inset Tabular
26172 <lyxtabular version="3" rows="13" columns="3">
26173 <features booktabs="true" islongtable="true" longtabularalignment="center">
26174 <column alignment="center" valignment="middle" width="16col%">
26175 <column alignment="center" valignment="middle" width="40col%">
26176 <column alignment="center" valignment="middle" width="35col%">
26177 <row endhead="true">
26178 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26181 \begin_layout Plain Layout
26187 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26190 \begin_layout Plain Layout
26196 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26199 \begin_layout Plain Layout
26207 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26210 \begin_layout Plain Layout
26216 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26219 \begin_layout Plain Layout
26220 Circle with circular hole (in the size of a CD/DVD)
26225 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26228 \begin_layout Plain Layout
26229 Cannot be scaled, take care there is not too much text
26236 <cell alignment="center" valignment="top" topline="true" usebox="none">
26239 \begin_layout Plain Layout
26245 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26248 \begin_layout Plain Layout
26254 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26257 \begin_layout Plain Layout
26258 Fragile, calculation might fail
26265 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26268 \begin_layout Plain Layout
26274 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26277 \begin_layout Plain Layout
26278 Rhomboid (symbolizing a
26279 \begin_inset Quotes eld
26283 \begin_inset Quotes erd
26291 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26294 \begin_layout Plain Layout
26302 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26305 \begin_layout Plain Layout
26311 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26314 \begin_layout Plain Layout
26320 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26323 \begin_layout Plain Layout
26331 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26334 \begin_layout Plain Layout
26340 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26343 \begin_layout Plain Layout
26349 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26352 \begin_layout Plain Layout
26360 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26363 \begin_layout Plain Layout
26369 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26372 \begin_layout Plain Layout
26373 Nut for bolt (hexagon with circular hole)
26378 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26381 \begin_layout Plain Layout
26389 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26392 \begin_layout Plain Layout
26398 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26401 \begin_layout Plain Layout
26407 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26410 \begin_layout Plain Layout
26418 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26421 \begin_layout Plain Layout
26427 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26430 \begin_layout Plain Layout
26436 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26439 \begin_layout Plain Layout
26447 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26450 \begin_layout Plain Layout
26456 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26459 \begin_layout Plain Layout
26465 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26468 \begin_layout Plain Layout
26476 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26479 \begin_layout Plain Layout
26485 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26488 \begin_layout Plain Layout
26489 Normal/reversed rain drop
26494 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26497 \begin_layout Plain Layout
26498 Fragile, calculation might fail
26505 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26508 \begin_layout Plain Layout
26515 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
26518 \begin_layout Plain Layout
26519 The \SpecialChar TeX
26525 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26528 \begin_layout Plain Layout
26536 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26539 \begin_layout Plain Layout
26541 \begin_inset Newline newline
26549 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26552 \begin_layout Plain Layout
26553 Triangles in different orientations
26558 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26561 \begin_layout Plain Layout
26575 \begin_layout Standard
26576 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26578 for environments in the toolbar.
26581 \begin_layout Standard
26582 \begin_inset Newpage newpage
26588 \begin_layout Standard
26589 Here is an example paragraph in the shape of a nut:
26592 \begin_layout Standard
26593 \begin_inset VSpace bigskip
26602 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26603 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26605 At vero eos et accusam et justo duo dolores et ea rebum.
26606 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26608 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26609 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26613 \begin_layout Standard
26614 \begin_inset VSpace bigskip
26620 \begin_layout Standard
26621 \begin_inset Note Greyedout
26624 \begin_layout Plain Layout
26629 : shapepar paragraphs cannot run over a page break.
26637 \begin_layout Standard
26638 \begin_inset VSpace bigskip
26644 \begin_layout Standard
26649 takes care that the shape will always be preserved, no matter how much
26650 text is in the paragraph.
26651 Therefore the paragraph size changes with the amount of contained text.
26652 This can lead to paragraph sizes exceeding the page margins.
26653 To demonstrate the size scaling, here is the same example paragraph but
26654 with twice as much text:
26657 \begin_layout Standard
26658 \begin_inset Newpage newpage
26667 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26668 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26670 At vero eos et accusam et justo duo dolores et ea rebum.
26671 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26673 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26674 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26676 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26677 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26679 At vero eos et accusam et justo duo dolores et ea rebum.
26680 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26682 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26683 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26687 \begin_layout Standard
26688 \begin_inset VSpace bigskip
26694 \begin_layout Standard
26695 An exception is the shape
26700 It cannot be scaled because it must fit the size of a CD/DVD.
26701 Therefore the amount of text that fits into the shape is limited.
26702 \begin_inset Newline newline
26713 shape are fragile, meaning that the calculation of their size can fail,
26714 depending on the amount of text.
26715 You will then get the \SpecialChar LaTeX
26717 \begin_inset Quotes eld
26720 Arithmetic overflow
26721 \begin_inset Quotes erd
26725 In this case one can try to remove or add some text; if nothing works one
26726 has to use another shape.
26729 \begin_layout Standard
26730 \begin_inset VSpace bigskip
26736 \begin_layout Standard
26737 For shapes with tips you will maybe see that \SpecialChar LaTeX
26738 's hyphenation routine fails
26739 for text in the tips.
26740 Therefore it is often necessary to add hyphenation points
26745 arg "specialchar-insert hyphenation"
26750 ) to the corresponding text parts.
26753 \begin_layout Standard
26754 \begin_inset VSpace bigskip
26760 \begin_layout Standard
26761 Shapepar paragraphs are either always centered or placed on the page so
26762 that their left border touches the left page margin.
26763 You can therefore not use the paragraph dialog to align such paragraphs.
26764 A solution is to put the paragraph into a minipage or parbox and align
26766 The problem is hereby to find the right width for the box.
26767 Because if it is too wide and you center the box, the paragraph is not
26768 centered too because it sticks at the left side of the box.
26769 So you might have to play a bit with the width until it fits.
26770 Here are two heart-shaped paragraphs, the first one is not aligned, the
26771 second one is right-aligned:
26774 \begin_layout Standard
26775 \begin_inset Newpage newpage
26781 \begin_layout Heart
26785 Lo\SpecialChar softhyphen
26786 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26787 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26789 At vero eos et accusam et justo duo dolores et ea rebum.
26790 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26794 \begin_layout Standard
26795 \begin_inset VSpace bigskip
26801 \begin_layout Standard
26804 \begin_inset Box Frameless
26814 height_special "totalheight"
26819 backgroundcolor "none"
26822 \begin_layout Heart
26826 Lo\SpecialChar softhyphen
26827 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26828 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26830 At vero eos et accusam et justo duo dolores et ea rebum.
26831 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26840 \begin_layout Subsection
26844 \begin_layout Standard
26845 You can define any shape you want.
26846 Doing this manually is a lot of work because every coordinate must be specified.
26847 But there is a way to let the computer calculate the coordinates:
26850 \begin_layout Enumerate
26851 Install the program
26852 \begin_inset CommandInset href
26855 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
26862 \begin_layout Enumerate
26869 TeX/LaTeX\SpecialChar menuseparator
26870 Settings\SpecialChar menuseparator
26873 and select the font size you are using in your document.
26874 For example this document uses the size 12
26875 \begin_inset space \thinspace{}
26881 \begin_layout Enumerate
26885 \begin_layout Enumerate
26888 TeX/LaTeX\SpecialChar menuseparator
26891 to export the shape to coordinates.
26892 In the appearing dialog use either the outline of your shape for the coordinate
26893 s or the path itself.
26897 \begin_layout Plain Layout
26898 For more information see
26899 \begin_inset CommandInset href
26901 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26913 \begin_layout Standard
26914 The coordinates are written into a \SpecialChar TeX
26916 To use it for your \SpecialChar LyX
26920 \begin_layout Enumerate
26921 Place the cursor before the first character of your paragraph (or into a
26925 \begin_layout Enumerate
26926 Open in \SpecialChar LyX
26929 Insert\SpecialChar menuseparator
26930 File\SpecialChar menuseparator
26932 \begin_inset space ~
26937 , select the file and use
26946 \begin_layout Standard
26947 \begin_inset VSpace defskip
26953 \begin_layout Standard
26954 \begin_inset Note Greyedout
26957 \begin_layout Plain Layout
26962 : The changed shape only applies to the current paragraph; everything is
26963 reset to normal for the next paragraph.
26964 Therefore the shape definition file must be input into every paragraph
26965 with the desired shape.
26973 \begin_layout Standard
26974 \begin_inset VSpace bigskip
26980 \begin_layout Standard
26981 Here is an example:
26984 \begin_layout Standard
26985 \begin_inset VSpace bigskip
26991 \begin_layout Standard
26992 \begin_inset CommandInset include
26994 filename "SpecialParagraphShape.tex"
27000 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27001 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27003 At vero eos et accusam et justo duo dolores et ea rebum.
27004 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27006 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27007 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27011 \begin_layout Standard
27012 \begin_inset VSpace bigskip
27018 \begin_layout Standard
27023 to draw complexer shapes in
27027 you can draw the shape in a program of your choice and import the resulting
27033 Then you only need to draw a line or spline along the outline of the image.
27036 \begin_layout Standard
27037 \begin_inset VSpace bigskip
27043 \begin_layout Standard
27046 Custom paragraph shapes
27048 also provides the two commands
27056 which can be used to define custom shapes coordinate by coordinate.
27060 \begin_layout Plain Layout
27061 These commands are internally used for all shapes described here.
27066 For information how these styles are used and about further customization
27067 possibilities, have a look at the documentation of the package
27072 \begin_inset CommandInset citation
27081 \begin_layout Bibliography
27082 \begin_inset CommandInset bibitem
27083 LatexCommand bibitem
27088 Documentation of the \SpecialChar LaTeX
27090 \begin_inset CommandInset href
27093 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
27100 \begin_layout Bibliography
27101 \begin_inset CommandInset bibitem
27102 LatexCommand bibitem
27107 Documentation of the \SpecialChar LaTeX
27109 \begin_inset CommandInset href
27112 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"