1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children no
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
54 \font_typewriter_osf false
55 \font_sf_scale 100 100
56 \font_tt_scale 100 100
58 \use_dash_ligatures true
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX's Additional Features manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX's additional features documentation"
70 \pdf_keywords "LyX, Documentation, Additional"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen false
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 1
84 \use_package amssymb 1
87 \use_package mathdots 1
88 \use_package mathtools 1
90 \use_package stackrel 1
91 \use_package stmaryrd 1
92 \use_package undertilde 1
94 \cite_engine_type default
98 \paperorientation portrait
104 \notefontcolor #0000ff
111 \paragraph_separation indent
112 \paragraph_indentation default
114 \math_indentation default
115 \math_numbering_side default
116 \quotes_style english
120 \paperpagestyle headings
122 \tracking_changes true
123 \output_changes false
125 \postpone_fragile_content false
129 \docbook_table_output 0
130 \author -712698321 "Jürgen Spitzmüller"
132 \author 244031559 "Yuriy"
133 \author 1119979965 "Joel A. Kulesza"
139 Additional \SpecialChar LyX
143 \begin_layout Subtitle
148 by the \SpecialChar LyX
153 \begin_layout Plain Layout
155 Principal maintainer of this file is
160 If you have comments or error corrections, please send them to the \SpecialChar LyX
163 \begin_inset Flex Code
166 \begin_layout Plain Layout
167 <lyx-docs@lists.lyx.org>
180 \begin_layout Standard
181 \begin_inset CommandInset toc
182 LatexCommand tableofcontents
189 \begin_layout Chapter
193 \begin_layout Standard
194 This manual is essentially Part II of the
196 User's Guide\SpecialChar endofsentence
199 The reason for separating the two documents is simple: the
203 is already quite lengthy, and it contains information on all of the basic
204 features one needs to know in order to prepare most documents.
205 However, the \SpecialChar LyX
206 Team has worked to make \SpecialChar LyX
207 extensible through various configuration
208 files and external packages.
209 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
211 create a layout file (or module) for it without having to alter \SpecialChar LyX
213 We've already had contributions of several new features this way, and some
214 of them are documented here.
215 There are also some more `advanced' features, such as how to control the
216 presentation of bibliographies and how to work with multi-part documents,
217 that are not covered in the
221 and are discussed here.
224 \begin_layout Standard
225 This manual also documents some special features, like fax support
226 \change_deleted 244031559 1603802929
228 \change_inserted 244031559 1603802931
232 \change_deleted 244031559 1603802954
235 , which require additional software to work properly.
236 There is also a chapter on \SpecialChar LyX
238 And lastly, there's a chapter of \SpecialChar LaTeX
239 tools and tips, things you can use to
240 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
242 After all, \SpecialChar LyX
247 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
251 \begin_layout Standard
252 If you haven't read the
256 yet, you are definitely in the wrong manual.
261 is the first place to go, since it describes the notation and format of
263 You should also be thoroughly familiar with the
267 and all of the basic features of \SpecialChar LyX
268 before attempting to read this one.
271 \begin_layout Standard
272 Since many of the topics in this manual depend heavily on \SpecialChar LyX
274 with \SpecialChar LaTeX
275 , this first chapter covers the inner workings of \SpecialChar LyX
278 to generate exactly the \SpecialChar LaTeX
280 It is obviously for more seasoned \SpecialChar LyX
284 \begin_layout Chapter
286 and \SpecialChar LaTeX
290 \begin_layout Section
292 Uses \SpecialChar LaTeX
296 \begin_layout Standard
297 This chapter is for both \SpecialChar TeX
298 -nicians and the \SpecialChar LaTeX
300 In it, we'll explain how \SpecialChar LyX
301 and \SpecialChar LaTeX
302 work together to produce printable output.
303 This is the only place in any of the manuals where we assume you know something
304 about \SpecialChar LaTeX
308 \begin_layout Standard
309 At one time, \SpecialChar LyX
311 \begin_inset Quotes eld
314 WYSIWYM frontend to \SpecialChar LaTeX
316 \begin_inset Quotes erd
319 but that's no longer true.
320 There are frontends to \SpecialChar LaTeX
325 \begin_layout Plain Layout
326 Some familar ones are \SpecialChar TeX
327 maker and kile, on Linux, and \SpecialChar TeX
329 There are also the \SpecialChar LaTeX
330 modes for vi and emacs, of course.
335 These are basically text editors with the ability to run \SpecialChar LaTeX
337 errors in the file you're editing.
338 Although \SpecialChar LyX
347 run \SpecialChar LaTeX
348 , and it also indicates errors in the file, it also does much, much
350 For one thing, you don't need to know \SpecialChar LaTeX
351 to use \SpecialChar LyX
354 has added its own extensions to \SpecialChar LaTeX
356 Try the following sometime: select
357 \begin_inset Flex Noun
360 \begin_layout Plain Layout
361 Export\SpecialChar menuseparator
368 \begin_inset Flex Noun
371 \begin_layout Plain Layout
378 \begin_inset Flex Noun
381 \begin_layout Plain Layout
382 View\SpecialChar menuseparator
392 ), then look at the preamble of the resulting
393 \begin_inset Flex Code
396 \begin_layout Plain Layout
403 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
405 These macros are defined automatically, according to the features you use
409 \begin_layout Standard
410 There are several commands that automatically invoke \SpecialChar LaTeX
415 \begin_layout Itemize
416 \begin_inset Flex Noun
419 \begin_layout Plain Layout
420 Document\SpecialChar menuseparator
429 \begin_layout Itemize
430 \begin_inset Flex Noun
433 \begin_layout Plain Layout
434 Document\SpecialChar menuseparator
443 \begin_layout Standard
444 They will only invoke \SpecialChar LaTeX
445 if the file has changed since the last time \SpecialChar LaTeX
451 \begin_layout Standard
452 When \SpecialChar LyX
453 runs \SpecialChar LaTeX
454 on the file you're editing, it performs these steps:
457 \begin_layout Enumerate
458 Convert the document to \SpecialChar LaTeX
459 and save to a file with the extension
460 \begin_inset Flex Code
463 \begin_layout Plain Layout
470 \begin_inset Flex Code
473 \begin_layout Plain Layout
482 \begin_layout Enumerate
483 Run \SpecialChar LaTeX
485 \begin_inset Flex Code
488 \begin_layout Plain Layout
494 file (maybe several times), and run any other commands (such as
495 \begin_inset Flex Code
498 \begin_layout Plain Layout
505 \begin_inset Flex Code
508 \begin_layout Plain Layout
514 ) needed to compile the \SpecialChar LaTeX
518 \begin_layout Enumerate
519 If there are any errors, show the error log.
522 \begin_layout Standard
523 If you have run \SpecialChar LaTeX
525 \begin_inset Flex Noun
528 \begin_layout Plain Layout
529 View\SpecialChar menuseparator
536 then runs a DVI viewer to display the DVI-file.
538 \begin_inset Flex Noun
541 \begin_layout Plain Layout
542 View\SpecialChar menuseparator
549 performs further steps:
552 \begin_layout Enumerate
554 \begin_inset Flex Code
557 \begin_layout Plain Layout
563 to convert the DVI file to PostScript.
566 \begin_layout Enumerate
567 Run a PostScript viewer, such as
568 \begin_inset Flex Code
571 \begin_layout Plain Layout
577 , to display the PostScript file.
580 \begin_layout Standard
582 does similar things when viewing, or exporting, other formats.
585 \begin_layout Section
586 Translating \SpecialChar LaTeX
587 files into \SpecialChar LyX
591 \begin_layout Standard
592 You can import a \SpecialChar LaTeX
593 file into \SpecialChar LyX
595 \begin_inset Flex Noun
598 \begin_layout Plain Layout
599 File\SpecialChar menuseparator
600 Import\SpecialChar menuseparator
606 command in \SpecialChar LyX
608 This will call a program named
609 \begin_inset Flex Code
612 \begin_layout Plain Layout
618 which will create a file
619 \begin_inset Flex Code
622 \begin_layout Plain Layout
629 \begin_inset Flex Code
632 \begin_layout Plain Layout
640 will then open that file.
644 \begin_layout Plain Layout
645 \begin_inset Flex Code
648 \begin_layout Plain Layout
654 can also be run from the command line, of course.
662 \begin_layout Standard
663 \begin_inset Flex Code
666 \begin_layout Plain Layout
672 will translate most legal \SpecialChar LaTeX
673 , but not everything.
674 It will put things it doesn't understand into \SpecialChar TeX
675 code, so after translating
677 \begin_inset Flex Code
680 \begin_layout Plain Layout
686 , you can look for \SpecialChar TeX
687 code and hand-edit it until it looks right.
690 \begin_layout Standard
691 If you don't know what \SpecialChar TeX
692 code is, read the next section.
695 \begin_layout Section
696 \begin_inset CommandInset label
698 name "sec:Inserting-TeX-Code"
702 Inserting \SpecialChar TeX
703 Code into \SpecialChar LyX
707 \begin_layout Standard
708 Anything you can do in \SpecialChar LaTeX
709 you can do in \SpecialChar LyX
710 , for a very simple reason: You can
711 always insert \SpecialChar TeX
712 code into any \SpecialChar LyX
715 cannot, and will never be able to, display every possible \SpecialChar LaTeX
717 If ever you need to insert \SpecialChar LaTeX
718 commands into your \SpecialChar LyX
719 document, you can use the
721 \begin_inset Flex Code
724 \begin_layout Plain Layout
731 box, which you can insert into your document with
732 \begin_inset Flex Noun
735 \begin_layout Plain Layout
736 Insert\SpecialChar menuseparator
746 or the keyboard shortcut
755 \begin_layout Standard
756 Here's an example of inserting \SpecialChar LaTeX
757 commands in a \SpecialChar LyX
759 The code looks like this:
762 \begin_layout LyX-Code
766 \begin_inset Newline newline
772 \begin_inset Newline newline
775 This is an example of a minipage environment.
777 \begin_inset Newline newline
780 can put nearly everything in it, even (non-floating)
781 \begin_inset Newline newline
786 \begin_inset Newline newline
792 \begin_inset Newline newline
796 \begin_inset Newline newline
802 \begin_inset Newline newline
808 \begin_inset Newline newline
814 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
831 \begin_inset Newline newline
837 \begin_inset Newline newline
845 \begin_layout LyX-Code
849 \begin_layout Standard
851 \begin_inset Flex Code
854 \begin_layout Plain Layout
861 box containing this text is directly after this paragraph.
862 Those of you reading the manual in \SpecialChar LyX
863 will only see the \SpecialChar TeX
865 Those reading a printed version of the manuals will see the actual results:
866 \begin_inset VSpace bigskip
872 \begin_layout Standard
876 \begin_layout Plain Layout
883 \begin_layout Plain Layout
890 \begin_layout Plain Layout
892 This is an example of a minipage environment.
893 You can put nearly everything in it, even (non-floating) figures and tables.
897 \begin_layout Plain Layout
904 \begin_layout Plain Layout
909 \begin_layout Plain Layout
916 \begin_layout Plain Layout
923 \begin_layout Plain Layout
930 \begin_layout Plain Layout
936 \begin_layout Plain Layout
943 \begin_layout Plain Layout
950 \begin_layout Plain Layout
957 \begin_layout Plain Layout
967 \begin_inset VSpace bigskip
973 \begin_layout Standard
974 In addition to using \SpecialChar TeX
975 code, you can also create a separate file containing
976 some complex \SpecialChar LaTeX
977 structure and then use
978 \begin_inset Flex Noun
981 \begin_layout Plain Layout
982 Insert\SpecialChar menuseparator
992 to include your file (you should select the type
993 \begin_inset Flex Code
996 \begin_layout Plain Layout
1003 We recommend that you only do this if you have a
1004 \begin_inset Flex Code
1007 \begin_layout Plain Layout
1018 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1022 \begin_layout Standard
1023 There are a few last points to emphasize:
1026 \begin_layout Itemize
1032 check if your \SpecialChar LaTeX
1036 \begin_layout Itemize
1037 Beware of reinventing the wheel.
1040 \begin_layout Standard
1041 On that last point, \SpecialChar LyX
1042 does have quite a few features tucked into it, and
1044 Be sure to check the manuals to make sure that \SpecialChar LyX
1045 doesn't have such-and-such
1046 feature before you decide you have to do it by hand.
1047 Moreover, there are numerous \SpecialChar LaTeX
1048 packages out there to do all sorts of things,
1049 from labels to envelopes to fancy multipage tables.
1051 \change_inserted 244031559 1603815732
1053 \begin_inset CommandInset href
1056 target "https://www.ctan.org/"
1062 \change_deleted 244031559 1603815732
1064 \begin_inset CommandInset href
1067 target "http://www.ctan.org/"
1077 \begin_layout Standard
1078 If you do need to do some wild and fancy things within your document, be
1079 sure to check out a good \SpecialChar LaTeX
1080 book for assistance.
1081 There are a number of them listed in the bibliography of the
1088 \begin_layout Section
1090 and the \SpecialChar LaTeX
1094 \begin_layout Subsection
1095 About the \SpecialChar LaTeX
1099 \begin_layout Standard
1100 If you already know \SpecialChar LaTeX
1101 , there is no need to explain here what the preamble
1103 If you don't, the following will give you some ideas—we recommend again
1104 that you consult a \SpecialChar LaTeX
1105 book for further information.
1106 In any case, you should read the points below, because they explain what
1107 you can do and what you don't need to do in the \SpecialChar LaTeX
1108 preamble of a \SpecialChar LyX
1112 \begin_layout Standard
1113 The \SpecialChar LaTeX
1114 preamble comes at the very beginning of a document,
1122 \begin_layout Itemize
1123 Declare the document class.
1125 \begin_inset Newline newline
1129 already does this for you.
1130 If you're a seasoned \SpecialChar LaTeX
1131 -nician, and you have a custom document class you
1132 want to use, check out the
1134 Customization Manual
1136 for information on how to make \SpecialChar LyX
1140 \begin_layout Itemize
1141 Declare the usage of packages.
1143 \begin_inset Newline newline
1147 packages provide special commands, which are only available within a document
1148 when the package has been declared in the preamble.
1149 In addition to providing special commands, the inclusion of a package can
1150 change the document.
1151 For example, the package
1152 \begin_inset Flex Code
1155 \begin_layout Plain Layout
1161 forces all paragraphs to be indented.
1162 There are other packages for labels, envelopes, margins, etc.
1166 \begin_layout Itemize
1167 Set counters, variables, lengths and widths.
1169 \begin_inset Newline newline
1172 There are several \SpecialChar LaTeX
1173 counters and variables that
1177 be set globally from within the preamble in order to have the desired effect.
1178 (There are variables that you can set and reset inside the document, too.)
1179 Margins are a good example of something that must be set in the preamble.
1180 Another example is the label format for lists.
1181 You can actually set these just about anywhere, but it's best to do it
1182 just once, inside the preamble.
1185 \begin_layout Itemize
1186 Declare user defined commands (with
1187 \begin_inset Flex Code
1190 \begin_layout Plain Layout
1199 \begin_inset Flex Code
1202 \begin_layout Plain Layout
1211 \begin_inset Newline newline
1214 These are abbreviations for \SpecialChar LaTeX
1215 commands which appear very often inside a document.
1216 Although the preamble is a good place to declare such commands, they
1220 be declared anywhere (before they are used for the first time, of course).
1221 This can be useful if there is a lot of raw \SpecialChar LaTeX
1222 code in your document, which
1223 normally should not be the case.
1226 \begin_layout Standard
1228 adds its own set of definitions to the preamble of the
1229 \begin_inset Flex Code
1232 \begin_layout Plain Layout
1239 This makes \SpecialChar LaTeX
1240 files generated by \SpecialChar LyX
1244 \begin_layout Subsection
1245 Changing the Preamble
1248 \begin_layout Standard
1249 The commands which \SpecialChar LyX
1250 adds to the preamble of a \SpecialChar LaTeX
1251 file are fixed; you can't
1252 change them without patching \SpecialChar LyX
1254 You can, however, add your own stuff to the preamble by selecting
1255 \begin_inset Flex Noun
1258 \begin_layout Plain Layout
1261 \begin_inset space ~
1270 \begin_inset Flex Noun
1273 \begin_layout Plain Layout
1274 Document\SpecialChar menuseparator
1282 adds anything in the
1283 \begin_inset Flex Noun
1286 \begin_layout Plain Layout
1292 dialog to its own built-in preamble.
1293 Before adding your own declarations in the preamble, you should make sure
1294 that \SpecialChar LyX
1295 doesn't already support what you want to do.
1296 (Remember what we said about reinventing the wheel?) Also,
1298 make sure your preamble code is correct
1302 doesn't check it for you.
1303 If there is an error, you're likely to get an error like
1304 \begin_inset Quotes eld
1308 \begin_inset Flex Code
1311 \begin_layout Plain Layout
1320 \begin_inset Quotes erd
1324 If you see this error, check your preamble.
1327 \begin_layout Subsection
1331 \begin_layout Standard
1332 Here are some examples of what you can add to a preamble, and what they
1336 \begin_layout Subsubsection
1340 \begin_layout Standard
1341 There are two variables under \SpecialChar LaTeX
1342 that control page position:
1343 \begin_inset Flex Code
1346 \begin_layout Plain Layout
1355 \begin_inset Flex Code
1358 \begin_layout Plain Layout
1367 Their names should be self-explanatory.
1368 These variables are useful if you think for a moment about computer labels.
1369 Sometimes, the size of a print medium and the area of the medium that you
1370 can actually print on aren't the same.
1372 \begin_inset Flex Code
1375 \begin_layout Plain Layout
1384 \begin_inset Flex Code
1387 \begin_layout Plain Layout
1398 \begin_layout Standard
1399 The default values for
1400 \begin_inset Flex Code
1403 \begin_layout Plain Layout
1412 \begin_inset Flex Code
1415 \begin_layout Plain Layout
1424 \begin_inset space \thinspace{}
1428 \begin_inset space \thinspace{}
1432 \begin_inset space \space{}
1435 the page isn't shifted.
1436 Unfortunately, some DVI drivers always seem to shift the page.
1437 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1438 If you're using \SpecialChar LyX
1439 on a system that you don't personally maintain, and your
1440 sysadmin is a doofus,
1441 \begin_inset Flex Code
1444 \begin_layout Plain Layout
1453 \begin_inset Flex Code
1456 \begin_layout Plain Layout
1465 Suppose your left and top margins are always 0.5
1466 \begin_inset space \thinspace{}
1470 You can add this to the preamble:
1473 \begin_layout LyX-Code
1481 \begin_layout LyX-Code
1489 \begin_layout Standard
1490 and your margins should now be correct.
1493 \begin_layout Subsubsection
1497 \begin_layout Standard
1498 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1499 There's a rather nice package, available at your nearest CTAN archive,
1500 for printing sheets of labels:
1501 \begin_inset Flex Code
1504 \begin_layout Plain Layout
1511 Now, your system may not have this package installed by default.
1512 We leave that up to you to check.
1513 You'll also want to read the documentation for it; we're not going to do
1515 Since this is an example, however, we'll give you an example of how you
1519 \begin_layout Standard
1520 First, make sure you're using the
1521 \begin_inset Flex Code
1524 \begin_layout Plain Layout
1531 Next, you need to put the following in your preamble:
1534 \begin_layout LyX-Code
1540 \begin_layout LyX-Code
1546 \begin_layout LyX-Code
1552 \begin_layout LyX-Code
1558 \begin_layout LyX-Code
1564 \begin_layout LyX-Code
1570 \begin_layout LyX-Code
1576 \begin_layout Standard
1577 This sets things up for Avery label sheets, stock #5360.
1578 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1581 \begin_inset Flex Code
1584 \begin_layout Plain Layout
1593 \begin_inset Flex Code
1596 \begin_layout Plain Layout
1604 around each label text.
1605 This and other special features of
1606 \begin_inset Flex Code
1609 \begin_layout Plain Layout
1615 are explained in its documentation.
1618 \begin_layout Standard
1619 Someday, someone may write a \SpecialChar LyX
1620 layout file to support this package directly.
1621 Maybe that someone is you.
1624 \begin_layout Subsubsection
1625 Example #3: Paragraph Indentation
1628 \begin_layout Standard
1629 Americans are trained to indent the first line of
1634 As with all of their other weird quirks, most Americans will whine and
1635 moan until they can have their way and indent the first line of all paragraphs.
1644 \begin_layout Standard
1645 Of course, this behavior isn't standard typography.
1646 In books, you typically only indent the first line of a paragraph
1650 it follows another one.
1651 The idea behind indenting the first line of a paragraph is to distinguish
1652 neighboring paragraphs from one another.
1653 If there is no previous paragraph—for example, if it follows a figure or
1654 is the first paragraph in a section—then there is no need for indentation.
1658 \begin_layout Standard
1659 If you're a typical American (we're still joking!), though, you don't care
1660 about such esoteric things; you want your indentation! Add this to the
1664 \begin_layout LyX-Code
1667 usepackage{indentfirst}
1670 \begin_layout Standard
1671 If your \SpecialChar TeX
1672 distribution isn't braindead, you'll have this package, and all
1673 of your paragraphs will get the indentation the Founding Fathers intended
1677 \begin_layout Subsubsection
1678 Example #4: This Document
1681 \begin_layout Standard
1682 You can also check out the preamble of this document to get an idea of some
1683 of the advanced things you can do.
1686 \begin_layout Section
1688 and \SpecialChar LaTeX
1692 \begin_layout Standard
1693 When \SpecialChar LyX
1694 calls \SpecialChar LaTeX
1695 , it tells \SpecialChar LaTeX
1696 to blithely ignore any errors and keep going.
1697 It then uses the logfile from the \SpecialChar LaTeX
1698 run to do a post-mortem.
1699 After analyzing the logfile, \SpecialChar LyX
1700 displays a dialog listing the errors.
1701 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1703 where the error occurred.
1707 \begin_layout Plain Layout
1709 Analyzing the logfile is a tough job, and \SpecialChar LyX
1710 doesn't always go to the right
1712 There are also cases where \SpecialChar LaTeX
1713 reports the error on one line, but the actual
1715 This is not unlike forgetting a closing brace in a program: You'll get
1716 an error, but only later.
1724 \begin_layout Standard
1725 Some folks also like to look at the log file directly: It is available from
1727 \begin_inset Flex Noun
1730 \begin_layout Plain Layout
1731 Document\SpecialChar menuseparator
1733 \begin_inset space ~
1742 There are some fairly common error messages and warnings.
1743 We'll cover those here.
1744 You should look at a good \SpecialChar LaTeX
1745 book for a complete listing.
1748 \begin_layout Itemize
1749 \begin_inset Flex Code
1752 \begin_layout Plain Layout
1759 \begin_inset Newline newline
1762 Anything beginning with these words is a warning message for the purpose
1764 \begin_inset Quotes eld
1768 \begin_inset Quotes erd
1771 the \SpecialChar LaTeX
1773 You'll get messages like this if you added or changed cross-references
1774 or bibliography entries, in which case, \SpecialChar LaTeX
1775 is trying to tell you that you
1776 need to make another run.
1777 You can by-and-large ignore these.
1780 \begin_layout Itemize
1781 \begin_inset Flex Code
1784 \begin_layout Plain Layout
1791 \begin_inset Newline newline
1794 Another warning message, this time about fonts which \SpecialChar LaTeX
1796 The rest of the message will often say something about a replacement font
1797 that \SpecialChar LaTeX
1799 You can safely ignore these, too.
1802 \begin_layout Itemize
1803 \begin_inset Flex Code
1806 \begin_layout Plain Layout
1815 \begin_inset Newline newline
1824 It seems to generate at least one of these messages for just about any
1826 They are warnings about lines that were too long and run past the right
1828 This happens if \SpecialChar LaTeX
1829 does not find a reasonable way to break the lines (notoriously
1830 often with typewriter font, since this does not allow for automatic break
1832 In many cases, this is unnoticeable in the final output.
1833 (It can be just a point or two.) Sometimes, however, the lines run rather
1834 visibly into the margin; something you will not want to have in your final
1837 \begin_inset Newline newline
1840 There are several global ways to try to minimize the overfull lines.
1843 Enable micro-typographic extensions
1847 Document\SpecialChar menuseparator
1848 Settings\SpecialChar menuseparator
1851 might already improve things a lot.
1852 Furthermore, \SpecialChar LaTeX
1853 code such as the following in
1855 Document\SpecialChar menuseparator
1856 Settings\SpecialChar menuseparator
1859 usually reduces the overfull lines drastically (we use this in the preamble
1864 \begin_layout LyX-Code
1868 \begin_inset Newline newline
1874 \begin_inset Newline newline
1879 emergencystretch 1.5em
1880 \begin_inset Newline newline
1888 \begin_layout Standard
1889 In some cases, however, you eventually have to rewrite the text to get the
1890 line breaking right.
1894 \begin_layout Plain Layout
1895 For more information, see
1896 \begin_inset Flex URL
1899 \begin_layout Plain Layout
1901 http://www.tex.ac.uk/FAQ-overfull.html
1914 \begin_layout Standard
1915 In any case, you should check the respective lines, at least for the final
1916 version of your document.
1917 Your eyes will tell you if there's a problem with something that's too
1922 \begin_layout Plain Layout
1923 You can also enable the `draft' option in
1924 \begin_inset Flex Noun
1927 \begin_layout Plain Layout
1928 Document\SpecialChar menuseparator
1934 , and then \SpecialChar LaTeX
1935 will draw a black box in the margin of lines that are overfull.
1944 \begin_layout Itemize
1945 \begin_inset Flex Code
1948 \begin_layout Plain Layout
1957 \begin_inset Newline newline
1960 Not quite as common as its cousin.
1961 This happens again if \SpecialChar LaTeX
1962 does not find a reasonable break point and consequently
1963 generates too loose lines.
1964 As with the overfull lines, you should check if this is a visible problem.
1967 \begin_layout Itemize
1968 \begin_inset Flex Code
1971 \begin_layout Plain Layout
1980 \begin_inset Flex Code
1983 \begin_layout Plain Layout
1992 \begin_inset Newline newline
1995 Warnings about troubles breaking the page.
1996 Once again, just look at the output.
1997 Your eyes will tell you where something has gone wrong.
2000 \begin_layout Itemize
2001 \begin_inset Flex Code
2004 \begin_layout Plain Layout
2006 \begin_inset Quotes els
2010 \begin_inset Quotes ers
2019 \begin_inset Newline newline
2023 \begin_inset Quotes eld
2027 \begin_inset Quotes erd
2030 isn't installed on this system.
2031 This usually appears because some package your document needs isn't installed.
2032 If you didn't touch the preamble or didn't use the
2033 \begin_inset Flex Code
2036 \begin_layout Plain Layout
2044 command, then one of the packages \SpecialChar LyX
2045 tried to load is missing.
2047 \begin_inset Flex Noun
2050 \begin_layout Plain Layout
2051 Help\SpecialChar menuseparator
2058 to get a list of packages that \SpecialChar LyX
2060 This file is updated whenever you reconfigure \SpecialChar LyX
2062 \begin_inset Flex Noun
2065 \begin_layout Plain Layout
2066 Tools\SpecialChar menuseparator
2072 ) and tells you which packages have been detected and what they do.
2073 \begin_inset Newline newline
2077 \begin_inset Flex Code
2080 \begin_layout Plain Layout
2088 command and the package in question isn't installed, then you'll need to
2089 install it yourself.
2092 \begin_layout Itemize
2093 \begin_inset Flex Code
2096 \begin_layout Plain Layout
2097 LaTeX Error: Unknown option
2103 \begin_inset Newline newline
2106 Error messages beginning with this are trying to tell you that you specified
2107 a bad or undefined option to a package.
2108 Check the package's documentation.
2111 \begin_layout Itemize
2112 \begin_inset Flex Code
2115 \begin_layout Plain Layout
2116 Undefined control sequence
2122 \begin_inset Newline newline
2125 If you've inserted \SpecialChar LaTeX
2126 code into your document, but made a typo, you'll get
2128 You may have forgotten to load a package.
2129 In any case, this error message usually means that you used an undefined
2134 \begin_layout Standard
2135 There are other error and warning messages.
2136 Some are self-explanatory.
2137 These are usually \SpecialChar LaTeX
2139 Others are downright cryptic.
2140 These are usually \SpecialChar TeX
2141 error messages, and we really have
2145 what they mean or how to decipher them.
2149 \begin_layout Standard
2150 There's a general sequence you should follow if you get error messages:
2153 \begin_layout Enumerate
2154 Look at the \SpecialChar LaTeX
2155 code you inserted for typos.
2158 \begin_layout Enumerate
2159 If there are no typos, check that you used the command(s) correctly.
2162 \begin_layout Enumerate
2163 If you get a bunch of error boxes piled up at the very top of the document—and
2164 especially if you see a
2165 \begin_inset Quotes eld
2169 \begin_inset Flex Code
2172 \begin_layout Plain Layout
2181 \begin_inset Quotes erd
2184 error—it means that there are errors in the preamble.
2185 Start debugging your preamble.
2188 \begin_layout Enumerate
2189 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2191 document, the first suspect is your \SpecialChar LaTeX
2192 distribution itself.
2193 Check for missing packages and install them.
2196 \begin_layout Enumerate
2197 Okay, so there are no missing packages.
2198 Did you use any of the fine-tuning options in \SpecialChar LyX
2199 ? Specifically, did you
2203 any of them, like trying to manually insert lots of
2204 \begin_inset Flex Code
2207 \begin_layout Plain Layout
2209 \begin_inset space ~
2218 \begin_inset Flex Code
2221 \begin_layout Plain Layout
2228 \begin_inset Flex Code
2231 \begin_layout Plain Layout
2237 ? Did you try to kludge something together with these instead of using the
2238 appropriate paragraph environment?
2241 \begin_layout Enumerate
2242 All right, you didn't use any of the fine-tuning options, you played by
2244 Did you try to pull a fancy maneuver? Did you do something funky inside
2245 a table or an equation, like inserting a graphic into a table cell?
2248 \begin_layout Enumerate
2249 Do you have long sections of text where \SpecialChar LaTeX
2250 cannot find a place to break a
2251 line? By default, \SpecialChar LaTeX
2252 is rather strict about how much extra inter-word spacing
2253 it will add in order to break a line.
2254 Preferably, you should rework the paragraph to avoid the problem.
2257 \begin_layout Enumerate
2258 Did you go overboard with the nesting? \SpecialChar LyX
2259 (currently) doesn't check to make
2260 sure you're in the limits for nesting environments.
2261 If you nested a bunch of environments to the
2262 \begin_inset Formula $17^{\mathrm{th}}$
2265 level, that's the problem.
2266 (The limit in \SpecialChar LaTeX
2270 \begin_layout Enumerate
2271 Okay, you didn't get any error messages, but your output looks awful.
2272 If you have a table or figure that's too wide or long for the page, you
2277 \begin_layout Enumerate
2278 rescale the figure so it fits.
2281 \begin_layout Enumerate
2282 trim down the table so it fits.
2286 \begin_layout Enumerate
2287 If something else is wrong with the output, and you didn't try to pull anything
2288 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2291 \begin_layout Standard
2292 If all this doesn't help—well, then
2296 you might have found a bug in \SpecialChar LyX
2301 \begin_layout Chapter
2305 \begin_layout Section
2306 Customizing Bibliographies with Bib\SpecialChar TeX
2310 \begin_layout Standard
2311 The most basic information about how to use Bib\SpecialChar TeX
2316 with \SpecialChar LyX
2317 is contained in the section
2319 Bibliography databases
2326 The following subsections explain special bibliography features supported
2331 \begin_layout Subsection
2332 Alternative Citation Styles
2335 \begin_layout Standard
2336 Standard Bib\SpecialChar TeX
2338 \begin_inset space \thinspace{}
2342 \begin_inset space \space{}
2346 \begin_inset Quotes eld
2350 \begin_inset Quotes erd
2353 ) to refer to a cited work.
2354 However, in many scientific disciplines, other citation styles are in use.
2355 The most common one is the author-year style (e.
2356 \begin_inset space \thinspace{}
2360 \begin_inset space \space{}
2364 \begin_inset Quotes eld
2368 \begin_inset Quotes erd
2373 supports three packages that provide this style,
2374 \begin_inset Flex Code
2377 \begin_layout Plain Layout
2384 \begin_inset Flex Code
2387 \begin_layout Plain Layout
2394 \begin_inset Flex Code
2397 \begin_layout Plain Layout
2404 Each of these packages has their pros and cons, which cannot be listed
2406 If you only want to have simple author-year (or author-numerical) style,
2407 or if you want to use one of the countless style files for
2408 \begin_inset Flex Code
2411 \begin_layout Plain Layout
2417 , then the established
2418 \begin_inset Flex Code
2421 \begin_layout Plain Layout
2427 package is probably your choice.
2428 If you look for specific citation styles common in law studies, you might
2430 \begin_inset Flex Code
2433 \begin_layout Plain Layout
2440 If you want to have full control over the formatting or look for advanced
2441 features such as ibidem, footnote citations, full title citations, advanced
2442 date formats (such as 400 BC) or full localization to other languages than
2443 English, you should definitely consider
2444 \begin_inset Flex Code
2447 \begin_layout Plain Layout
2453 , which exceeds all other packages in terms of features, but is also quite
2454 heavy and more resource-hungry.
2457 \begin_layout Standard
2458 The handling of these packages in \SpecialChar LyX
2459 is basically the same.
2461 \begin_inset Flex Noun
2464 \begin_layout Plain Layout
2465 Document\SpecialChar menuseparator
2472 \begin_inset Flex Noun
2475 \begin_layout Plain Layout
2482 \begin_inset Flex Noun
2485 \begin_layout Plain Layout
2492 \begin_inset Flex Noun
2495 \begin_layout Plain Layout
2502 \begin_inset Flex Noun
2505 \begin_layout Plain Layout
2512 \begin_inset Flex Noun
2515 \begin_layout Plain Layout
2516 Biblatex (Natbib mode)
2522 \begin_inset Flex Noun
2525 \begin_layout Plain Layout
2532 \begin_inset Flex Noun
2535 \begin_layout Plain Layout
2542 \begin_inset space ~
2545 6.5.3 in the User's Guide for more information on these choices).
2546 With all these packages, you will get some extra features in the citation
2547 dialog and you can select the style of the reference (
2548 \begin_inset Quotes eld
2552 \begin_inset Quotes erd
2556 \begin_inset Quotes eld
2560 \begin_inset Quotes erd
2564 \begin_inset Quotes eld
2568 \begin_inset Quotes erd
2572 \begin_inset Quotes eld
2576 \begin_inset Quotes erd
2580 Note that either package needs specifically designed style files.
2581 They all ship their own, but there are lots of additional style files,
2582 and there is even an interactive style file builder
2586 \begin_layout Plain Layout
2588 \begin_inset Flex URL
2591 \begin_layout Plain Layout
2593 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2604 \begin_inset Flex Code
2607 \begin_layout Plain Layout
2616 \begin_layout Subsection
2617 Subdivided Bibliographies
2620 \begin_layout Standard
2621 Sometimes you might need to divide your bibliography into several sections.
2622 If you are for instance a historian, the possibility to separate sources
2623 and scientific works is most likely a
2624 \begin_inset Quotes eld
2628 \begin_inset Quotes erd
2632 Unfortunately, Bib\SpecialChar TeX
2633 itself does not allow you to do this.
2634 But with the help of some \SpecialChar LaTeX
2635 packages, Bib\SpecialChar TeX
2636 can be extended to fit your needs.
2639 \begin_layout Standard
2641 provides native support for one of these packages,
2649 \begin_layout Plain Layout
2651 \begin_inset Flex URL
2654 \begin_layout Plain Layout
2656 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2666 The advantage of this package (compared to other packages such as
2670 ) is that you don't need to define new citation commands.
2671 Instead, you need to prepare different bibliographic databases which include
2672 the entries for the different sections of the bibliography.
2673 For example: If you want to divide your bibliography into the sections
2675 \begin_inset Quotes eld
2679 \begin_inset Quotes erd
2683 \begin_inset Quotes eld
2687 \begin_inset Quotes erd
2690 , you first need to create two bibliographic databases, e.
2691 \begin_inset space \thinspace{}
2695 \begin_inset space \space{}
2699 \begin_inset Flex Code
2702 \begin_layout Plain Layout
2709 \begin_inset Flex Code
2712 \begin_layout Plain Layout
2722 \begin_layout Standard
2724 \begin_inset Flex Noun
2727 \begin_layout Plain Layout
2728 Document\SpecialChar menuseparator
2735 \begin_inset Flex Noun
2738 \begin_layout Plain Layout
2745 \begin_inset Flex Noun
2748 \begin_layout Plain Layout
2749 Subdivided bibliography
2755 Now you can insert multiple Bib\SpecialChar TeX
2756 bibliographies, one for each section of
2758 Returning to our example: Insert the Bib\SpecialChar TeX
2760 \begin_inset Flex Code
2763 \begin_layout Plain Layout
2769 and a second one for the database
2770 \begin_inset Flex Code
2773 \begin_layout Plain Layout
2780 You are free to use the same or different styles for each section.
2781 Additionally, you can choose if the bibliography section should contain
2783 \begin_inset Quotes eld
2786 all cited references
2787 \begin_inset Quotes erd
2790 of the specified database(s) (which is the default),
2791 \begin_inset Quotes eld
2794 all uncited references
2795 \begin_inset Quotes erd
2799 \begin_inset Quotes eld
2803 \begin_inset Quotes erd
2807 This might be useful if you would like to separate your bibliography into
2809 \begin_inset Quotes eld
2813 \begin_inset Quotes erd
2817 \begin_inset Quotes eld
2821 \begin_inset Quotes erd
2825 \begin_inset Quotes eld
2829 \begin_inset Quotes erd
2833 The titles for the sections can be added as ordinary sections or subsections.
2835 \begin_inset Flex Code
2838 \begin_layout Plain Layout
2844 removes the bibliography title, you have to manually re-add that, too (as
2845 a chapter* or section*, for instance).
2848 \begin_layout Standard
2853 , the procedure is a bit different.
2862 , the aforementioned
2863 \begin_inset Flex Noun
2866 \begin_layout Plain Layout
2867 Subdivided bibliography
2872 option is disabled if you use
2881 provides its own means to generate subdivided bibliographies.
2882 You can either add keywords to bibliography entries via the
2883 \begin_inset Flex Code
2886 \begin_layout Plain Layout
2892 entry option and then filter bibliography sections by keyword (by adding
2894 \begin_inset Flex Code
2897 \begin_layout Plain Layout
2904 \begin_inset Flex Noun
2907 \begin_layout Plain Layout
2913 field of the dialog that opens if you left-click on the
2914 \begin_inset Flex Noun
2917 \begin_layout Plain Layout
2918 Biblatex Generated Bibliography
2923 button), or you can filter by entry types (such as
2932 \begin_inset space \thinspace{}
2937 \begin_inset Flex Code
2940 \begin_layout Plain Layout
2947 \begin_inset Flex Code
2950 \begin_layout Plain Layout
2957 \begin_inset Flex Noun
2960 \begin_layout Plain Layout
2966 field, or you can create so-called
2967 \begin_inset Quotes eld
2970 Bibliography Categories
2971 \begin_inset Quotes erd
2974 to which you can assign individual entries.
2975 Please refer to the Biblatex manual, section
2977 Subdivided Bibliographies
2982 \begin_layout Subsection
2983 Multiple Bibliographies
2984 \begin_inset CommandInset label
2986 name "subsec:Multiple-Bibliographies"
2993 \begin_layout Standard
2994 Multiple bibliographies, e.
2995 \begin_inset space \thinspace{}
2999 \begin_inset space \space{}
3002 a bibliography for each part, chapter, section, subsection or child (sub-documen
3003 t) of the document, are also supported by \SpecialChar LyX
3005 In order to enable it, go to
3006 \begin_inset Flex Noun
3009 \begin_layout Plain Layout
3010 Document\SpecialChar menuseparator
3011 Settings\SpecialChar menuseparator
3017 and select the relevant unit (e.
3018 \begin_inset space \thinspace{}
3022 \begin_inset Quotes eld
3026 \begin_inset Quotes erd
3030 \begin_inset Flex Noun
3033 \begin_layout Plain Layout
3034 Multiple Bibliographies
3040 Then add a Bib(la)\SpecialChar TeX
3041 bibliography to each unit (e.
3042 \begin_inset space \thinspace{}
3045 g., section) of your document.
3046 In the output, a separate bibliography, containing only the references
3047 done in the current unit is generated.
3050 \begin_layout Standard
3051 If you use Bib\SpecialChar TeX
3053 \begin_inset Flex Code
3056 \begin_layout Plain Layout
3063 \begin_inset Flex Code
3066 \begin_layout Plain Layout
3072 package is used to create multiple bibliographies.
3073 The former package is used if you select
3074 \begin_inset Quotes eld
3078 \begin_inset Quotes erd
3086 \begin_inset Flex Noun
3089 \begin_layout Plain Layout
3090 Sectioned Bibliography
3097 \begin_inset Flex Code
3100 \begin_layout Plain Layout
3110 \begin_layout Plain Layout
3111 An alternative approach, if you are willing to use some
3112 \begin_inset Flex Noun
3115 \begin_layout Plain Layout
3123 \begin_inset space ~
3127 \begin_inset CommandInset ref
3129 reference "sec:Inserting-TeX-Code"
3134 \begin_inset Flex Code
3137 \begin_layout Plain Layout
3149 \begin_inset Flex Code
3152 \begin_layout Plain Layout
3158 is used, \SpecialChar LyX
3159 encloses the specified units in
3160 \begin_inset Flex Code
3163 \begin_layout Plain Layout
3170 \begin_inset Flex Code
3173 \begin_layout Plain Layout
3182 \begin_inset Flex Code
3185 \begin_layout Plain Layout
3193 in order to create the units.
3194 Note that this approach has some limitations.
3195 First, every citation reference has to be inside some
3196 \begin_inset Flex Code
3199 \begin_layout Plain Layout
3206 So citations outside a defined unit (e.
3207 \begin_inset space \thinspace{}
3210 g., before the first section if you use
3211 \begin_inset Quotes eld
3215 \begin_inset Quotes erd
3219 \begin_inset Quotes eld
3223 \begin_inset Quotes erd
3227 You can also create your own units by entering
3228 \begin_inset Flex Code
3231 \begin_layout Plain Layout
3240 \begin_inset Flex Code
3243 \begin_layout Plain Layout
3252 code (for instance to work around the mentioned limitation).
3254 \begin_inset Flex Code
3257 \begin_layout Plain Layout
3264 A second limitation is that
3265 \begin_inset Flex Code
3268 \begin_layout Plain Layout
3274 always processes all references of a bibliography database, even if they
3276 This can result in odd labels (e.
3277 \begin_inset space \thinspace{}
3282 \begin_inset Quotes eld
3286 \begin_inset Quotes erd
3289 if two works of this author from 2014 are in the database, even if only
3293 \begin_layout Standard
3299 \begin_inset Flex Code
3302 \begin_layout Plain Layout
3308 option is used instead.
3309 If you need specific units, you can start them with the \SpecialChar TeX
3311 \begin_inset Flex Code
3314 \begin_layout Plain Layout
3323 \begin_inset Flex Code
3326 \begin_layout Plain Layout
3335 If you also want to control the end of the unit, use the environment
3336 \begin_inset Flex Code
3339 \begin_layout Plain Layout
3349 \begin_inset Flex Code
3352 \begin_layout Plain Layout
3362 \begin_inset Flex Code
3365 \begin_layout Plain Layout
3372 In addition to the individual bibliography of the current unit,
3376 also provides an easy way to output all bibliographies, subsequently, at
3378 \begin_inset space \thinspace{}
3381 g., at the end of the document).
3383 \begin_inset Quotes eld
3387 \begin_inset Quotes erd
3390 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3396 manual for more information on this topic.
3399 \begin_layout Section
3403 \begin_layout Subsection
3407 \begin_layout Standard
3408 When you are working on a large file with many sections, it is often convenient
3409 to break up the document into several files, or perhaps you have something
3410 where a table may change from time to time, but the preceding text does
3412 In these cases, you should seriously consider using multipart documents.
3413 For example, scientific papers often have five major sections: the introduction
3414 , observations, results, discussion, and conclusion.
3415 Each of these could be its own separate \SpecialChar LyX
3417 \begin_inset Quotes eld
3421 \begin_inset Quotes erd
3424 file which contains the title, authors, abstract, references, etc., plus
3425 the five included files.
3426 It is important to note that each of these files is a full \SpecialChar LyX
3428 can be formatted and printed on its own, as well as included in a master
3430 Each of these files must have the same document class, however—don't attempt
3431 to mix book classes with article classes.
3432 You may also include \SpecialChar LaTeX
3433 files; however, these files must not have their own
3435 \begin_inset space \thinspace{}
3439 \begin_inset space \space{}
3442 everything up to and including the
3443 \begin_inset Flex Code
3446 \begin_layout Plain Layout
3455 \begin_inset Flex Code
3458 \begin_layout Plain Layout
3466 line must be deleted) or else errors will be generated when you try to
3470 \begin_layout Standard
3472 allows you to include files quite easily with
3473 \begin_inset Flex Noun
3476 \begin_layout Plain Layout
3477 Insert\SpecialChar menuseparator
3479 \begin_inset space ~
3488 When you click on this selection a small box is inserted into the file
3489 at the current cursor location.
3490 Clicking on the box raises a dialog which allows you to select the file
3491 to be included, and the method of its inclusion.
3495 \begin_layout Standard
3496 The file selection box should by now be obvious.
3497 The three inclusion methods are
3498 \begin_inset Quotes eld
3502 \begin_inset Quotes erd
3506 \begin_inset Quotes eld
3510 \begin_inset Quotes erd
3514 \begin_inset Quotes eld
3518 \begin_inset Quotes erd
3523 \begin_inset Quotes eld
3527 \begin_inset Quotes erd
3531 \begin_inset Quotes eld
3535 \begin_inset Quotes erd
3538 are similar in many ways, but there are also some notable differences:
3541 \begin_layout Enumerate
3543 \begin_inset Quotes eld
3547 \begin_inset Quotes erd
3550 are typeset beginning on a new page, while files that are
3551 \begin_inset Quotes eld
3555 \begin_inset Quotes erd
3558 are typeset starting on the current page.
3561 \begin_layout Enumerate
3562 \begin_inset Quotes eld
3566 \begin_inset Quotes erd
3569 files cannot themselves
3570 \begin_inset Quotes eld
3574 \begin_inset Quotes erd
3578 \begin_inset Quotes eld
3582 \begin_inset Quotes erd
3587 \begin_inset Quotes eld
3591 \begin_inset Quotes erd
3594 , on the other hand, infinite sub-inputting is possible.
3597 \begin_layout Enumerate
3598 \begin_inset Quotes eld
3602 \begin_inset Quotes erd
3605 allow for the output of only selected
3606 \begin_inset Quotes eld
3610 \begin_inset Quotes erd
3613 files, while maintaining the actual counters (pagination etc.) and references
3614 (please refer to the section
3617 \begin_inset space ~
3625 \begin_inset space ~
3630 manual for details).
3633 \begin_layout Standard
3635 \begin_inset Quotes eld
3639 \begin_inset Quotes erd
3642 is the preferred method for chapters that are outsourced to child documents,
3644 \begin_inset Quotes eld
3648 \begin_inset Quotes erd
3651 is more suitable for arbitrary file inheritance.
3654 \begin_layout Standard
3656 \begin_inset Quotes eld
3660 \begin_inset Quotes erd
3663 included file allows you to include a file typeset exactly as it appears
3665 \begin_inset space \thinspace{}
3669 \begin_inset space \space{}
3673 \begin_inset Flex Code
3676 \begin_layout Plain Layout
3682 mode, with the characters set in a fixed-width typewriter font.
3683 Normally, spaces in this file are invisible, though two consecutive spaces
3684 are conserved, unlike \SpecialChar LyX
3685 's normal treatment of spaces.
3686 However, setting the
3687 \begin_inset Flex Noun
3690 \begin_layout Plain Layout
3692 \begin_inset space ~
3696 \begin_inset space ~
3700 \begin_inset space ~
3708 checkbox typesets a mark to unambiguously define the presence of a space.
3712 \begin_layout Standard
3713 Generally, the master file is converted into a full \SpecialChar LaTeX
3714 file before typesetting,
3715 while the included files are converted to \SpecialChar LaTeX
3716 files that do not have all the
3717 preamble information.
3720 \begin_layout Subsection
3721 Cross-References Between Files
3724 \begin_layout Standard
3725 \begin_inset Box Shadowbox
3735 height_special "totalheight"
3740 backgroundcolor "none"
3743 \begin_layout Plain Layout
3744 This section is somewhat out of date.
3745 Need to describe default master documents and how children are opened when
3755 \begin_layout Standard
3756 It is possible to set up cross-references between the different files.
3757 First, open all the files in question: let's call them A and B in a two
3758 file example, where B is included in A.
3759 Let's say you insert a label in A, then want to reference it in B.
3760 Open the cross-reference dialog whilst in document B, and you can select
3762 \begin_inset Quotes eld
3766 \begin_inset Quotes erd
3772 \begin_layout Subsection
3773 Bibliography Lists in all Subdocuments
3776 \begin_layout Standard
3777 If you work with child documents, you might want to have only one main bibliogra
3778 phy at the end, but still be able to have a selected bibliography for the
3779 child if you output it on its own.
3780 Here is how to achieve this.
3783 \begin_layout Standard
3784 For the main document, you just insert a bibliography inset at the place
3785 where the main bibliography has to appear (within the master file or within
3787 If the bibliography inset is in the master file, the references will be
3788 inherited by all children, so they are available in the citation dialog
3792 \begin_layout Standard
3793 For child-specific bibliographies, insert bibliography insets within the
3794 child documents, at the place where the bibliography should appear when
3795 the child is compiled separately.
3796 However, the trick is to insert them into a branch (
3798 Insert\SpecialChar menuseparator
3799 Branch\SpecialChar menuseparator
3800 Insert New Branch...
3803 \begin_inset space \thinspace{}
3808 \begin_inset Quotes eld
3812 \begin_inset Quotes erd
3816 Within the children, activate the branch (
3818 Document\SpecialChar menuseparator
3819 Settings...\SpecialChar menuseparator
3823 Within the master, deactivate the branch (
3825 Document\SpecialChar menuseparator
3826 Settings...\SpecialChar menuseparator
3830 Now the child's bibliography will be ignored by the master, but considered
3834 \begin_layout Standard
3835 If you need multiple bibliographies (e.
3836 \begin_inset space \thinspace{}
3839 g., one per child in the
3843 ), please refer to sec.
3844 \begin_inset space ~
3848 \begin_inset CommandInset ref
3850 reference "subsec:Multiple-Bibliographies"
3857 \begin_layout Section
3862 \begin_layout Standard
3863 Users sometimes need to be able to
3864 \begin_inset Quotes eld
3868 \begin_inset Quotes erd
3872 file together with all the images (and other files) on which it depends,
3873 either for sending to a publisher or for sharing with a co-author.
3875 includes a Python script (
3876 \begin_inset Flex Code
3879 \begin_layout Plain Layout
3885 ) that automates this process.
3886 To use it, you must have either the
3887 \begin_inset Flex Code
3890 \begin_layout Plain Layout
3897 \begin_inset Flex Code
3900 \begin_layout Plain Layout
3906 python modules installed on your system.
3907 By default, the script prefers the
3908 \begin_inset Flex Code
3911 \begin_layout Plain Layout
3918 \begin_inset Flex Code
3921 \begin_layout Plain Layout
3927 format on Unix-like systems and the
3928 \begin_inset Flex Code
3931 \begin_layout Plain Layout
3940 \begin_layout Standard
3942 's configuration process will set the script up to export a `\SpecialChar LyX
3944 and this format will then be available under
3945 \begin_inset Flex Code
3948 \begin_layout Plain Layout
3949 File\SpecialChar menuseparator
3958 \begin_layout Standard
3959 Independently of the platform, the generation of a particular archive format
3960 can be forced by adding either the
3961 \begin_inset Flex Code
3964 \begin_layout Plain Layout
3971 \begin_inset Flex Code
3974 \begin_layout Plain Layout
3981 \begin_inset Flex Code
3984 \begin_layout Plain Layout
3991 \begin_inset Flex Code
3994 \begin_layout Plain Layout
4000 format) switch to the
4001 \begin_inset Flex Code
4004 \begin_layout Plain Layout
4006 \SpecialChar menuseparator
4014 \begin_inset Flex Code
4017 \begin_layout Plain Layout
4018 Tools\SpecialChar menuseparator
4019 Preferences\SpecialChar menuseparator
4020 File Handling\SpecialChar menuseparator
4027 (Make sure you add the switch after the script name, not before it.)
4030 \begin_layout Section
4031 Fancy Headers and Footers
4034 \begin_layout Standard
4035 The default page layout is rather plain; for an
4036 \begin_inset Flex Code
4039 \begin_layout Plain Layout
4045 document class, all you get is a centered page number at the bottom of
4047 This document uses KOMA-script's book class, so it appears to be a bit
4049 But to really put on a show, you need to set the document page style to
4051 \begin_inset Quotes eld
4055 \begin_inset Quotes erd
4058 , as mentioned in the
4063 This section describes the \SpecialChar LaTeX
4064 code you need to insert in your \SpecialChar LaTeX
4066 order to get the desired effects.
4069 \begin_layout Standard
4070 For more information on fancy headers, see the
4071 \begin_inset Flex Code
4074 \begin_layout Plain Layout
4080 package documentation.
4082 \begin_inset Flex URL
4085 \begin_layout Plain Layout
4087 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4095 \begin_layout Standard
4096 The page header is divided into three fields, not surprisingly labeled
4097 \begin_inset Quotes eld
4101 \begin_inset Quotes erd
4105 \begin_inset Quotes eld
4109 \begin_inset Quotes erd
4113 \begin_inset Quotes eld
4117 \begin_inset Quotes erd
4121 The footer is also divided into these three fields.
4122 The \SpecialChar LaTeX
4123 commands to set these fields in the simplest manner are
4124 \begin_inset Flex Code
4127 \begin_layout Plain Layout
4136 \begin_inset Flex Code
4139 \begin_layout Plain Layout
4148 \begin_inset Flex Code
4151 \begin_layout Plain Layout
4160 \begin_inset Flex Code
4163 \begin_layout Plain Layout
4172 Suppose you wish to put your name in the upper left hand corner of each
4174 Simply insert the following command in the preamble:
4177 \begin_layout Standard
4186 \begin_layout Standard
4187 You will now see your name in the upper left.
4188 If a field has a default entry that you would like to get rid of (often
4189 the page number appears in the central footer) simply include a command
4190 with a blank argument, e.
4191 \begin_inset space \thinspace{}
4197 \begin_layout Standard
4205 \begin_layout Standard
4206 Let's get really fancy: lets put the section number with the word
4207 \begin_inset Quotes eld
4211 \begin_inset Quotes erd
4215 \begin_inset space \thinspace{}
4219 \begin_inset space \space{}
4222 Section 3) in the upper left, the page number (e.
4223 \begin_inset space \thinspace{}
4227 \begin_inset space \space{}
4230 Page 4) in the upper right, your name in the lower left, and the date in
4232 The following commands should now appear in the preamble:
4235 \begin_layout Standard
4245 \begin_layout Standard
4253 \begin_layout Standard
4263 \begin_layout Standard
4272 \begin_layout Standard
4280 \begin_layout Standard
4290 \begin_layout Standard
4292 \begin_inset Flex Code
4295 \begin_layout Plain Layout
4304 \begin_inset Flex Code
4307 \begin_layout Plain Layout
4315 access \SpecialChar LaTeX
4316 's section and page counters, and so print out the current section
4319 \begin_inset Flex Code
4322 \begin_layout Plain Layout
4330 simply prints out today's date.
4333 \begin_layout Standard
4334 The thicknesses of the horizontal rules drawn beneath the header and above
4335 the footer can also be modified.
4336 If you don't want one of the rules, set its thickness to 0.
4337 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4343 \begin_inset Flex Code
4346 \begin_layout Plain Layout
4351 headrulewidth}{0.4pt}
4357 \begin_inset Flex Code
4360 \begin_layout Plain Layout
4365 footrulewidth}{0.4pt}
4370 to set the thicknesses.
4373 \begin_layout Standard
4374 You can switch the header/footer settings on and off for individual pages
4376 \begin_inset Flex Code
4379 \begin_layout Plain Layout
4382 thispagestyle{empty}
4388 \begin_inset Flex Code
4391 \begin_layout Plain Layout
4394 thispagestyle{plain}
4400 \begin_inset Flex Code
4403 \begin_layout Plain Layout
4406 thispagestyle{fancy}
4412 Simply insert them in the text on the page you want changed and mark them
4415 In fact, title pages are marked as plain by default, while following pages
4416 are marked fancy when using the global fancy setting.
4419 \begin_layout Standard
4420 As a final example, it is possible to include an image in the header or
4422 Suppose you want to put a company logo in the upper lefthand corner.
4423 You might try something like
4426 \begin_layout Standard
4435 includegraphics{logo.eps}}}
4438 \begin_layout Standard
4440 (you may need to preface this with
4441 \begin_inset Flex Code
4444 \begin_layout Plain Layout
4447 usepackage{graphics}
4452 if you don't include graphics elsewhere in your document).
4455 \begin_layout Section
4456 Itemize Bullet Selection
4457 \begin_inset CommandInset label
4466 \begin_layout Standard
4472 \begin_layout Subsection
4476 \begin_layout Standard
4478 provides 216 bullet shapes that can be accessed from a simple dialog.
4479 Using this dialog you can easily specify what bullet shape to use at each
4480 level of an itemized list.
4481 These settings are document-wide so you won't be able to specify different
4482 sets of bullets for different paragraphs.
4486 \begin_layout Plain Layout
4487 Well, actually you can but you'll have to do it by hand.
4495 \begin_layout Subsection
4499 \begin_layout Standard
4500 Open the dialog by selecting the
4501 \begin_inset Flex Noun
4504 \begin_layout Plain Layout
4505 Document\SpecialChar menuseparator
4511 menu item and then select the
4512 \begin_inset Flex Noun
4515 \begin_layout Plain Layout
4524 \begin_layout Standard
4525 The dialog provides you with a table of bullet shapes.
4526 A column of buttons on the left of the table provides access to the six
4527 different panels of bullet shapes.
4528 The row of buttons across the top is used to select which bullet depth
4531 \change_deleted 244031559 1603875981
4532 A text entry under the table shows the currently selected bullet shape's
4534 equivalent and this can be edited if desired.
4535 If you do modify the text you will also need to specify any needed packages
4536 in the \SpecialChar LaTeX
4542 \begin_layout Standard
4543 The six panels are divided up by the packages they require.
4544 The following table shows the mappings from button name to \SpecialChar LaTeX
4548 \begin_layout Standard
4550 \begin_inset Tabular
4551 <lyxtabular version="3" rows="7" columns="2">
4552 <features tabularvalignment="middle">
4553 <column alignment="center" valignment="top" width="0pt">
4554 <column alignment="center" valignment="top" width="0pt">
4556 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4559 \begin_layout Plain Layout
4574 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4577 \begin_layout Plain Layout
4594 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4597 \begin_layout Plain Layout
4612 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4615 \begin_layout Plain Layout
4624 base \SpecialChar LaTeX
4632 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4635 \begin_layout Plain Layout
4650 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4653 \begin_layout Plain Layout
4670 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4673 \begin_layout Plain Layout
4688 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4691 \begin_layout Plain Layout
4708 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4711 \begin_layout Plain Layout
4726 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4729 \begin_layout Plain Layout
4746 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4749 \begin_layout Plain Layout
4764 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4767 \begin_layout Plain Layout
4784 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4787 \begin_layout Plain Layout
4802 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4805 \begin_layout Plain Layout
4828 \begin_layout Standard
4830 doesn't stop you using bullets from packages you don't have.
4831 If you get errors from \SpecialChar LaTeX
4832 when you try to view or print the file, then it
4833 is likely you are missing a package.
4837 \begin_layout Plain Layout
4839 doesn't restrict your use since you may be editing locally and exporting
4848 \begin_layout Subsection
4852 \begin_layout Standard
4853 Select which bullet depth you want to change then select the bullet shape
4855 Any changes will not be visible in \SpecialChar LyX
4856 , but are visible when viewing the document.
4859 \begin_layout Standard
4860 You can reset a bullet shape to the default simply by clicking your right
4861 mouse button on the appropriate bullet depth button.
4865 \begin_layout Plain Layout
4870 want to have multiple sets of paragraphs with different sets of bullets
4871 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4873 The bullet selection dialog can help though because it provides you with
4874 the \SpecialChar LaTeX
4875 code for a wide range of bullet shapes.
4876 To make your own custom paragraphs you have the following options:
4879 \begin_layout Plain Layout
4883 \begin_layout Plain Layout
4899 \begin_layout Plain Layout
4903 \begin_layout Plain Layout
4925 \begin_layout Itemize
4926 Use the \SpecialChar LaTeX
4928 \begin_inset Flex Code
4931 \begin_layout Plain Layout
4939 to specify a new bullet shape for a given depth.
4940 You'll also need to save the current bullet shape so you can restore it
4942 In this itemized list the following \SpecialChar LaTeX
4943 code was used to change the bullet
4944 used for the first depth.
4948 \begin_layout LyX-Code
4958 \begin_layout LyX-Code
4975 \begin_layout Itemize
4976 Note that the itemize depth is specified in Roman numerals as part of the
4986 \begin_layout Itemize
4987 \begin_inset Argument item:1
4990 \begin_layout Plain Layout
4994 \begin_layout Plain Layout
5012 Specify each individual entry by starting each item with the bullet shape
5014 \begin_inset Quotes eld
5018 \begin_inset Quotes erd
5023 Insert\SpecialChar menuseparator
5027 \begin_inset Flex Noun
5030 \begin_layout Plain Layout
5038 For example, this item was started with
5039 \begin_inset Flex Code
5042 \begin_layout Plain Layout
5057 \begin_layout Plain Layout
5061 \begin_layout Plain Layout
5077 \begin_layout Plain Layout
5078 You'll also need to revert the labelitem back to its previous setting for
5079 the global bullet shape settings to remain in effect.
5080 The way used here was:
5083 \begin_layout LyX-Code
5098 \begin_layout Chapter
5100 and the World Wide Web
5103 \begin_layout Standard
5105 has long supported the export of documents to various web-friendly formats,
5107 Before version 2.0, however, HTML export was always accomplished by the
5108 use of external converters.
5112 \begin_layout Plain Layout
5113 For details on the use of external converters with \SpecialChar LyX
5118 section of the Customization manual.
5123 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5125 intermediate format, such as
5126 \begin_inset Flex Code
5129 \begin_layout Plain Layout
5136 \begin_inset Flex Code
5139 \begin_layout Plain Layout
5146 \begin_inset Flex Code
5149 \begin_layout Plain Layout
5155 , relying upon \SpecialChar LyX
5156 to produce the \SpecialChar LaTeX
5157 ; and there is a converter that works directly
5160 \begin_inset Flex Code
5163 \begin_layout Plain Layout
5171 All of these have different advantages and disadvantages.
5175 \begin_layout Standard
5176 The \SpecialChar LaTeX
5177 -based converters have the advantage that, in principle, they know everythin
5178 g about the exported document that \SpecialChar LaTeX
5180 Such converters do not care, for example, if a certain block of code was
5181 produced by \SpecialChar LyX
5182 or was Evil Red Text.
5183 These converters know about
5184 \begin_inset Flex Code
5187 \begin_layout Plain Layout
5193 files, counters, and references, and can often make use of the
5194 \begin_inset Flex Code
5197 \begin_layout Plain Layout
5203 files generated by Bib\SpecialChar TeX
5205 On the other hand, \SpecialChar LaTeX
5206 is a very hard language to parse—it is sometimes said
5207 that only \SpecialChar TeX
5208 itself understands \SpecialChar TeX
5209 —and \SpecialChar LaTeX
5210 -based converters will often choke on
5211 what seem to be quite simple constructs; complex ones can throw them completely
5212 , and as of this writing, for example, the
5216 manual will not export with
5217 \begin_inset Flex Code
5220 \begin_layout Plain Layout
5226 , though the others will.
5227 The other issue concerns how math is handled.
5228 These converters typically convert the formulae into little pictures that
5229 are then linked from the HTML document.
5230 Since these are actually generated by \SpecialChar LaTeX
5231 , they are accurate.
5232 But they do not scale well, and just getting them to look as if they are
5233 actually meant to be in your document—so that the font sizes seem to be
5234 roughly the same—can be a challenge.
5237 \begin_layout Standard
5239 \begin_inset Flex Code
5242 \begin_layout Plain Layout
5250 \begin_inset CommandInset href
5252 name "http://pinchito.es/elyxer/"
5253 target "http://pinchito.es/elyxer/"
5258 ) solves some of these problems.
5259 In particular, the formulae it produces scale perfectly, since it renders
5260 math using a combination of HTML and CSS rather than converting the formulae
5262 But even moderately complex formula are rendered less well than with
5263 \begin_inset Flex Code
5266 \begin_layout Plain Layout
5272 ; this reflects the limitations of HTML.
5276 \begin_layout Plain Layout
5278 \begin_inset Flex Code
5281 \begin_layout Plain Layout
5288 can also use jsMath and MathJax for equations, but this setting is only
5289 available globally and requires one to have access to a server that runs
5295 More importantly (as of version 1.1.1, at least),
5296 \begin_inset Flex Code
5299 \begin_layout Plain Layout
5306 has limited support for math macros and no support for user-defined paragraph
5307 or character styles.
5308 These limitations make
5309 \begin_inset Flex Code
5312 \begin_layout Plain Layout
5319 unsuitable for many of the documents \SpecialChar LyX
5321 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5323 have decided to follow a different path and have made \SpecialChar LyX
5325 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5326 , DocBook, and plaintext.
5329 \begin_layout Standard
5330 As of this writing, XHTML output remains under development and should probably
5332 \begin_inset Quotes eld
5336 \begin_inset Quotes erd
5343 \begin_layout Plain Layout
5345 \begin_inset Flex Code
5348 \begin_layout Plain Layout
5349 development/HTML/HTML.notes
5354 , which can be found in the \SpecialChar LyX
5356 \begin_inset CommandInset href
5358 name "accessed online"
5359 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5364 , usually contains up-to-date information about the state of XHTML output.
5365 See also the list of XHTML bugs on
5366 \begin_inset CommandInset href
5368 name "the bug tracker"
5369 target "https://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"
5379 Still, the developers have chosen this approach because it has several
5380 potential advantages over the other two.
5383 \begin_layout Standard
5384 These advantages are primarily due to the fact that the XHTML output routines,
5385 since they are part of \SpecialChar LyX
5386 , know everything \SpecialChar LyX
5387 knows about the document being
5392 \begin_layout Plain Layout
5393 Another advantage is that, since these routines are internal to \SpecialChar LyX
5395 immune to changes in \SpecialChar LyX
5396 's file format, or to changes in the semantics of
5402 So they know about the table of contents (as displayed in the outline),
5403 about the counters associated with different paragraph styles, and about
5404 user-defined styles.
5405 The XHTML output routines know what \SpecialChar LyX
5406 knows about internationalization,
5407 too, so they will output
5408 \begin_inset Quotes eld
5412 \begin_inset Quotes erd
5416 \begin_inset Quotes eld
5424 \begin_inset Quotes erd
5427 , depending upon the language in effect at the time.
5431 \begin_layout Standard
5432 Quite generally, the output routines know what \SpecialChar LyX
5433 knows about document layout,
5434 that is, about how the document is to be rendered on screen.
5435 We use this information when we output the document as XHTML.
5436 In particular, \SpecialChar LyX
5441 generates CSS style information corresponding to the layout information
5442 it uses to render the document on screen: if section headings are supposed
5443 to be sans-serif and bold as seen in \SpecialChar LyX
5444 , then (by default) they will be sans-seri
5445 f and bold when viewed in a web browser, too.
5446 And this is true not just for pre-defined styles, like Section, but for
5447 any style, including user-defined styles.
5448 Indeed, the XHTML output routines make no distinction between user-defined
5450 \change_deleted 244031559 1603876931
5452 \change_inserted 244031559 1603876940
5455 styles and \SpecialChar LyX
5456 's own pre-defined styles: in each case, everything \SpecialChar LyX
5458 the styles is contained in the layout files.
5459 And much the same is true as regards pre-defined textual insets, such as
5460 footnotes, and various custom insets.
5464 \begin_layout Standard
5465 The result is that XHTML output can be customized and extended in exactly
5466 the same way \SpecialChar LaTeX
5467 output can be customized and extended: through layout files
5469 See chapter five of the
5473 manual for the details.
5476 \begin_layout Standard
5477 The remainder of this chapter contains more detailed information on XHTML
5478 output, its limitations, and ways to work around those limitations.
5481 \begin_layout Section
5482 Math Output in XHTML
5485 \begin_layout Standard
5487 offers four choices for how math is rendered.
5488 These have various advantages and disadvantages:
5491 \begin_layout Itemize
5493 \begin_inset Newline newline
5496 MathML is a dialect of XML designed specifically for mathematics on the
5497 web, and it typically renders very well in browsers that support it.
5498 The disadvantage is that not all browsers support MathML, and support is
5499 not complete even in the Gecko-based browsers, such as Firefox.
5500 \begin_inset Newline newline
5504 is unable to render a formula as MathML—for example, if the formula
5506 \begin_inset Flex Code
5509 \begin_layout Plain Layout
5515 package or ERT—then it will instead output the formula as an image.
5519 \begin_layout Itemize
5521 \begin_inset Newline newline
5525 \begin_inset Flex Code
5528 \begin_layout Plain Layout
5534 outputs math as HTML, styled by CSS.
5538 \begin_layout Plain Layout
5540 has borrowed some of the CSS for its HTML output from
5541 \begin_inset Flex Code
5544 \begin_layout Plain Layout
5555 For simple formulae, this can work quite well, though with more complicated
5556 formulae it tends to break down.
5557 Still, this method has the advantage that it is very widely supported and
5558 so it may be appropriate for documents that contain only a little, fairly
5560 \begin_inset Newline newline
5563 If Lyx is unable to render a formula as HTML—for example, if the formula
5565 \begin_inset Flex Code
5568 \begin_layout Plain Layout
5574 package or ERT—then it will instead output the formula as an image.
5578 \begin_layout Itemize
5580 \begin_inset Newline newline
5584 \begin_inset Flex Code
5587 \begin_layout Plain Layout
5594 will output formulae as images, the very same images, in fact, that are
5595 used for instant preview.
5599 \begin_layout Plain Layout
5600 Instant preview does
5604 have to be on for images to be output, however.
5609 The advantage to this method is that the images are simply generated by
5611 , so they are very accurate.
5612 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5613 so they do not scale terribly well, and one cannot copy them, etc.
5614 \begin_inset Newline newline
5617 The size of the images can be controlled by setting the
5618 \begin_inset Quotes eld
5622 \begin_inset Quotes erd
5626 \begin_inset Flex Noun
5629 \begin_layout Plain Layout
5630 Document\SpecialChar menuseparator
5631 Settings\SpecialChar menuseparator
5641 \begin_layout Plain Layout
5642 For those who want to know, this controls the resolution of the image in
5643 dots per inch and is based upon a default of 75 dpi.
5649 \begin_inset Newline newline
5653 for some reason fails to create an image for a formula (e.g., if a required
5655 package is not installed), then it will fall back to outputing the raw
5660 \begin_layout Itemize
5663 \begin_inset Newline newline
5666 Finally, \SpecialChar LyX
5667 will happily output math as \SpecialChar LaTeX
5669 As well as being the output of last resort, this method can be used with
5671 \begin_inset CommandInset href
5674 target "http://www.math.union.edu/~dpvc/jsMath/"
5679 , which uses JavaScript to render \SpecialChar LaTeX
5680 embedded in HTML documents.
5682 wraps the \SpecialChar LaTeX
5684 \begin_inset Flex Code
5687 \begin_layout Plain Layout
5693 (for inline formulas) or
5694 \begin_inset Flex Code
5697 \begin_layout Plain Layout
5703 (for displayed formulas) with
5704 \begin_inset Flex Code
5707 \begin_layout Plain Layout
5713 , as is required for jsMath.
5716 \begin_layout Standard
5717 One of these output methods must be selected under
5718 \begin_inset Flex Noun
5721 \begin_layout Plain Layout
5722 Document\SpecialChar menuseparator
5723 Settings\SpecialChar menuseparator
5730 By default, \SpecialChar LyX
5732 This is a document-wide setting, therefore.
5735 \begin_layout Standard
5736 Eventually, \SpecialChar LyX
5737 will offer the user the option to select an alternate output
5738 method for a particular inset, say, one that isn't being rendered very
5743 \begin_layout Plain Layout
5744 That said, since \SpecialChar LyX
5745 falls back to images if the inset contains ERT, then one
5746 can force output as an image by putting some harmless ERT into the math,
5748 \begin_inset Formula $a=b\relax$
5759 \begin_layout Section
5760 Bibliography and Citations
5763 \begin_layout Standard
5764 XHTML output fully supports bibliographies and citations.
5768 \begin_layout Standard
5769 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5771 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5774 If you are using numerical citations, then \SpecialChar LyX
5775 will output numerical labels,
5776 such as [1] or [17], rather than simply showing the citation key in square
5777 brackets, as it does on-screen.
5778 If you are using author-year citations, then \SpecialChar LyX
5779 will add lowercase letters
5780 to the years, just as Bib\SpecialChar TeX
5781 does, if it finds more than one citation for
5782 a given author-year combination.
5783 The labels will be printed with the bibliography entries.
5784 Note that there is, at present, no way to customize the appearance of the
5785 labels, for example, to choose between square brackets and parentheses.
5788 \begin_layout Standard
5789 Bibliography output is handled by the same machinery that handles the presentati
5790 on of reference information in the citation dialog, so you will see in the
5791 XHTML output pretty much what you would see if you were to look at a given
5792 entry in the citation dialog.
5793 The formatting can be customized in your layout file or, preferably, in
5799 manual for the details.
5802 \begin_layout Standard
5803 The main defect at present is that cross-referenced information is printed
5804 with every entry with which it is associated.
5805 So you can see things like this:
5810 \begin_inset Quotes eld
5813 Context and Logical Form
5814 \begin_inset Quotes erd
5819 Language in Context: Selected Essays
5821 (Oxford: Oxford University Press, 2007), pp.
5827 \begin_inset Quotes eld
5830 Semantics in Context
5831 \begin_inset Quotes erd
5836 Language in Context: Selected Essays
5838 (Oxford: Oxford University Press, 2007), pp.
5842 \begin_layout Standard
5843 This should be fixed before long.
5846 \begin_layout Standard
5847 There is no support at present for sectioned bibliographies.
5848 If you have multiple bibliographies, then \SpecialChar LyX
5849 will print the same bibliography
5853 \begin_layout Section
5857 \begin_layout Standard
5859 will happily export indexes as XHTML, but with certain limitations at the
5863 \begin_layout Standard
5864 Index export will be most reliable when you do not attempt to use the fancy
5865 constructs that are described in the section on indexes in the
5873 \begin_layout Plain Layout
5874 The main issue here is that \SpecialChar LyX
5875 itself does not really handle these.
5876 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5882 We'll describe how they are handled using the subsection headings from
5886 \begin_layout Itemize
5887 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5888 makes an effort to support these,
5889 but the entries must be separated by
5890 \begin_inset Quotes eld
5894 \begin_inset Quotes erd
5897 , that is, there must be spaces around the exclamation point.
5898 This is because it is otherwise too difficult to check for escaped exclamation
5899 points, ones in math, and so forth.
5902 \begin_layout Itemize
5903 Page Ranges: There is no support at all for page ranges, since these make
5904 no sense with XHMTL.
5905 Instead, you will just get two index entries, one at either end.
5908 \begin_layout Itemize
5909 Cross-referencing: There is no support for cross-referencing.
5911 finds an entry containing the
5912 \begin_inset Quotes eld
5915 |see\SpecialChar ldots
5917 \begin_inset Quotes erd
5920 construct, it is just dropped, and the rest is treated as an ordinary index
5924 \begin_layout Itemize
5925 Index Entry Order: \SpecialChar LyX
5926 does support attempts to fix the sorting order.
5927 It will take what is before the first `@' it finds and use that for sorting,
5928 taking what follows the first `@' to be the actual entry.
5929 At present, \SpecialChar LyX
5930 does not check for escaped `@', so do not try to index email
5934 \begin_layout Itemize
5935 Index Entry Layout: You can format entries by using the text style dialog,
5936 or by using any other method available within \SpecialChar LyX
5938 There is no support for constructs like:
5939 \begin_inset Quotes eld
5943 \begin_inset Quotes erd
5947 Indeed, if \SpecialChar LyX
5948 finds a pipe symbol, `|', in an entry, it will delete it and
5949 everything that follows it.
5952 \begin_layout Itemize
5953 Multiple Indexes: There is no support for multiple indexes.
5954 Rather, all index entries will be printed as one large index.
5955 To avoid our printing several versions of the index, we print only the
5956 main index, so make sure you have one.
5959 \begin_layout Section
5960 Nomenclature and Glossary
5963 \begin_layout Standard
5964 There is at present no support for glossaries.
5965 Adding it would be fairly trivial, and welcome.
5968 \begin_layout Chapter
5969 The \SpecialChar LyX
5973 \begin_layout Section
5977 \begin_layout Standard
5978 The `\SpecialChar LyX
5979 server' allows other programs to talk to \SpecialChar LyX
5980 , invoke \SpecialChar LyX
5981 commands, and retrieve
5982 information about the \SpecialChar LyX
5984 This is only intended for advanced users, but they should find it useful.
5985 It is by writing to the \SpecialChar LyX
5986 server, for example, that bibliography managers,
5987 such as JabRef, are able to
5988 \begin_inset Quotes eld
5992 \begin_inset Quotes erd
5995 citations to \SpecialChar LyX
5999 \begin_layout Section
6000 Starting the \SpecialChar LyX
6002 \begin_inset CommandInset label
6004 name "sec:Starting-the-Server"
6011 \begin_layout Standard
6012 The \SpecialChar LyX
6013 server works through the use of a pair of named pipes.
6014 These are usually located in
6015 \begin_inset Flex Code
6018 \begin_layout Plain Layout
6024 , (except on Windows, where
6028 named pipes are special objects located in
6029 \begin_inset Flex Code
6032 \begin_layout Plain Layout
6044 ) and have the names
6045 \begin_inset Quotes eld
6049 \begin_inset Flex Code
6052 \begin_layout Plain Layout
6059 \begin_inset Quotes erd
6063 \begin_inset Quotes eld
6067 \begin_inset Flex Code
6070 \begin_layout Plain Layout
6077 \begin_inset Quotes erd
6081 External programs write into
6082 \begin_inset Flex Code
6085 \begin_layout Plain Layout
6091 and read back data from
6092 \begin_inset Flex Code
6095 \begin_layout Plain Layout
6102 The stem of the pipe names can be defined in the
6103 \begin_inset Flex Noun
6106 \begin_layout Plain Layout
6107 Tools\SpecialChar menuseparator
6114 \begin_inset Flex Code
6117 \begin_layout Plain Layout
6118 "/home/myhome/lyxpipe"
6124 \begin_inset Flex Code
6127 \begin_layout Plain Layout
6141 on Windows (where any working path instead of lyxpipe can be used, for
6143 \begin_inset Flex Code
6146 \begin_layout Plain Layout
6169 configure this manually in order for the server to start.
6172 \begin_layout Standard
6175 \begin_inset Flex Code
6178 \begin_layout Plain Layout
6185 \begin_inset Flex Code
6188 \begin_layout Plain Layout
6194 ' to create the pipes.
6195 If one of the pipes already exists, \SpecialChar LyX
6196 will assume that another \SpecialChar LyX
6198 is already running and will not start the server.
6199 On POSIX (Unix like) systems, if for some other reason, an unused
6200 \begin_inset Quotes eld
6204 \begin_inset Quotes erd
6207 pipe is left in existence when \SpecialChar LyX
6208 closes, then \SpecialChar LyX
6209 will try to delete it.
6210 If this fails for some reason, you will need to delete the pipes manually
6211 and then restart \SpecialChar LyX
6213 On Windows, pipes are deleted by the OS on program termination or crash,
6215 \begin_inset Quotes eld
6219 \begin_inset Quotes erd
6222 pipes should not be possible.
6225 \begin_layout Standard
6226 To have several \SpecialChar LyX
6227 processes with servers at the same time, you have to use
6228 different configurations, perhaps by using separate user directories, each
6230 \begin_inset Flex Code
6233 \begin_layout Plain Layout
6239 file, for each process.
6242 \begin_layout Standard
6243 If you are developing a client program, you might find it useful to enable
6244 debugging information from the \SpecialChar LyX
6246 Do this by starting \SpecialChar LyX
6248 \begin_inset Flex Code
6251 \begin_layout Plain Layout
6260 \begin_layout Standard
6261 You can find a complete example client written in C++ in the source distribution
6263 \begin_inset Flex Code
6266 \begin_layout Plain Layout
6267 development/lyxserver/server_monitor.cpp
6275 \begin_layout Standard
6276 Another useful tool is the command-line based client found in
6277 \begin_inset Flex Code
6280 \begin_layout Plain Layout
6281 src/client/lyxclient
6289 \begin_layout Section
6290 Normal communication
6293 \begin_layout Standard
6294 To issue a \SpecialChar LyX
6295 call, the client writes a line of ASCII text into the input
6297 This line has the following format:
6314 \begin_layout Description
6315 clientname is a name that the client can choose arbitrarily.
6316 Its only use is that \SpecialChar LyX
6317 will echo it if it sends an answer—so a client can
6318 dispatch results from different requesters.
6321 \begin_layout Description
6322 function is the function you want \SpecialChar LyX
6324 It is the same as the commands you'd use in the minibuffer.
6327 \begin_layout Description
6328 argument is an optional argument which is meaningful only to some functions
6330 \begin_inset Quotes eld
6334 \begin_inset Quotes erd
6337 LFUN will insert the argument as text at the cursor position).
6340 \begin_layout Standard
6341 The answer from \SpecialChar LyX
6342 will arrive in the output pipe and be of the form
6359 \begin_layout Standard
6368 are just echoed from the command request, while
6372 is more or less useful information filled according to how the command
6373 execution worked out.
6374 Some commands, such as
6375 \begin_inset Quotes eld
6379 \begin_inset Quotes erd
6382 , will return information about the internal state of \SpecialChar LyX
6384 return an empty data-response.
6385 This means that the command execution went fine.
6388 \begin_layout Standard
6389 In case of errors, the response from \SpecialChar LyX
6407 \begin_layout Standard
6412 should contain an explanation of why the command failed.
6415 \begin_layout Standard
6419 \begin_layout LyX-Code
6420 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6421 \begin_inset Newline newline
6424 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6425 \begin_inset Newline newline
6428 read a <~/.lyxpipe.out
6429 \begin_inset Newline newline
6435 \begin_layout Subsection
6436 AppleScript (Mac OS X)
6439 \begin_layout Standard
6440 Since \SpecialChar LyX
6441 2.1, \SpecialChar LyX
6442 supports basic interactions with AppleScript for normal communicatio
6443 n through the command run.
6444 This command takes a direct argument (the
6448 to perform) and an optional argument.
6449 It either returns the output of the function or triggers an error with
6450 the error message and code.
6453 \begin_layout Standard
6457 \begin_layout LyX-Code
6458 tell application "\SpecialChar LyX
6462 \begin_layout LyX-Code
6466 \begin_layout LyX-Code
6467 -- Stores the current file name into f
6470 \begin_layout LyX-Code
6471 set f to (run "server-get-filename" with argument "")
6474 \begin_layout LyX-Code
6475 on error the error_message number the error_number
6478 \begin_layout LyX-Code
6479 display dialog "Error: " & the error_number & ".
6483 \begin_layout LyX-Code
6484 & the error_message buttons {"OK"} default button 1
6487 \begin_layout LyX-Code
6491 \begin_layout LyX-Code
6495 \begin_layout Section
6499 \begin_layout Standard
6501 can notify clients of events going on asynchronously.
6502 Currently it will only do this if the user binds a key sequence with the
6504 \begin_inset Quotes eld
6508 \begin_inset Quotes erd
6512 The format of the string \SpecialChar LyX
6513 sends is as follows:
6517 \begin_inset Flex Code
6520 \begin_layout Plain Layout
6531 \begin_layout Standard
6536 is the printed representation of the key sequence that was actually typed
6540 \begin_layout Standard
6541 This mechanism can be used to extend \SpecialChar LyX
6542 's command set and implement macros.
6543 Bind some key sequence to
6544 \begin_inset Quotes eld
6548 \begin_inset Quotes erd
6552 Then start a client that listens on the output pipe, dispatches the command
6553 according to the sequence, and starts a function that may use \SpecialChar LyX
6556 requests to issue a command or a series of commands to \SpecialChar LyX
6560 \begin_layout Section
6561 The simple \SpecialChar LyX
6565 \begin_layout Standard
6567 implements a simple protocol that can be used for session management.
6568 All messages are of the form
6581 \begin_layout Standard
6587 \begin_inset Quotes eld
6591 \begin_inset Quotes erd
6595 \begin_inset Quotes eld
6599 \begin_inset Quotes erd
6604 \begin_inset Quotes eld
6608 \begin_inset Quotes erd
6611 is received from a client, \SpecialChar LyX
6612 will report back to inform the client that
6613 it's listening to it's messages, while
6614 \begin_inset Quotes eld
6618 \begin_inset Quotes erd
6621 sent from \SpecialChar LyX
6622 will inform clients that \SpecialChar LyX
6626 \begin_layout Section
6627 Reverse DVI/PDF search
6630 \begin_layout Standard
6631 Some DVI/PDF viewers
6635 \begin_layout Plain Layout
6636 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6637 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6646 facility (also called
6651 This means that you can tell \SpecialChar LyX
6652 to put the cursor to a specific line in the
6653 document by clicking at the respective position in the DVI/PDF output.
6654 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6656 This is done via the \SpecialChar LyX
6657 server either by using the named pipe (
6661 ), or the UNIX domain socket (
6665 ) that \SpecialChar LyX
6666 creates in its temporary directory (this is the way the
6667 \begin_inset Flex Code
6670 \begin_layout Plain Layout
6676 program communicates with \SpecialChar LyX
6678 In some cases, you need a helper script that mediates between the viewer
6679 and \SpecialChar LyX
6680 , in others, the viewer can communicate with \SpecialChar LyX
6682 This depends on the selected viewer and on your operating system.
6683 The same applies to the way viewers need to be configured and the way the
6684 reverse search is actually performed.
6685 In what follows, we will thus describe how to setup reverse search for
6687 Before we turn to this, though, we will explain what needs to be done generally
6688 to enable reverse search in the DVI/PDF output.
6691 \begin_layout Subsection
6693 \begin_inset CommandInset label
6695 name "subsec:rev-search"
6702 \begin_layout Standard
6703 In most cases \SpecialChar LyX
6704 will do the work for you by pressing the following button
6708 arg "buffer-toggle-output-sync"
6712 Alternatively, you can also enable the feature by checking
6714 Synchronize with Output
6717 \begin_inset Flex Noun
6720 \begin_layout Plain Layout
6721 Document\SpecialChar menuseparator
6722 Settings\SpecialChar menuseparator
6729 In such a case \SpecialChar LyX
6730 will automatically insert the necessary Sync\SpecialChar TeX
6732 PDF) or load the srcltx package (for DVI) respectively.
6733 This option can be easily reached also on
6734 \begin_inset Flex Code
6737 \begin_layout Plain Layout
6746 \begin_layout Standard
6747 If you need a different setting, you can select or input a custom macro
6748 from the drop down box just below
6749 \begin_inset Flex Noun
6752 \begin_layout Plain Layout
6753 Document\SpecialChar menuseparator
6754 Settings\SpecialChar menuseparator
6755 Output\SpecialChar menuseparator
6756 Synchronize with Output
6764 \begin_layout Standard
6765 Note that the method
6766 \begin_inset Flex Code
6769 \begin_layout Plain Layout
6777 enables gzip compression.
6778 If your viewer does not support it, you should instead use
6779 \begin_inset Flex Code
6782 \begin_layout Plain Layout
6793 \begin_layout Standard
6794 Please also note that including the
6795 \begin_inset Flex Code
6798 \begin_layout Plain Layout
6805 \begin_inset Flex Code
6808 \begin_layout Plain Layout
6814 sometimes has an undesired impact on the typesetting.
6815 Thus, you should switch output synchronization off for the final typesetting
6817 \begin_inset Flex Code
6820 \begin_layout Plain Layout
6827 \begin_inset Flex Code
6830 \begin_layout Plain Layout
6840 \begin_layout Standard
6841 In case you need some more special settings that are not covered by the
6842 automatic settings, read the next section about how to set up output synchroniz
6844 If the automatic setup suits your needs, you can readily jump to section
6845 \begin_inset space ~
6849 \begin_inset CommandInset ref
6851 reference "subsec:configuring-viewers"
6855 , where the necessary configuration steps in your viewer – needed both with
6856 the automatic and the manual setup – are described.
6859 \begin_layout Subsection
6863 \begin_layout Standard
6865 provides several different methods for reverse search.
6866 Some are built-in in the
6867 \begin_inset Flex Code
6870 \begin_layout Plain Layout
6876 program, some are provided by external packages.
6877 Your choice depends on whether your \SpecialChar LaTeX
6878 distribution already provides a given
6879 method (the built-in methods are rather new) and whether your viewer can
6881 The available methods are described in the following.
6884 \begin_layout Subsubsection*
6885 Built-in DVI-search via src-specials (DVI only)
6888 \begin_layout Standard
6889 This method provides the DVI file with the necessary information for reverse
6891 It is available in \SpecialChar LaTeX
6892 since quite some time (any somewhat recent \SpecialChar LaTeX
6894 should include it), and it works reliably.
6895 To enable it, change the
6896 \begin_inset Flex Noun
6899 \begin_layout Plain Layout
6910 \begin_inset Flex Noun
6913 \begin_layout Plain Layout
6924 \begin_inset Flex Noun
6927 \begin_layout Plain Layout
6928 Preferences\SpecialChar menuseparator
6929 File Handling\SpecialChar menuseparator
6936 \begin_inset Flex Code
6939 \begin_layout Plain Layout
6940 latex -src-specials $$i
6946 If this doesn't work, check if your \SpecialChar TeX
6947 engine needs different options (the
6948 syntax might differ in some distributions).
6951 \begin_layout Subsubsection*
6952 External Packages (PDFSync and scrltx)
6955 \begin_layout Standard
6964 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6966 In order to enable it, load the packages in the \SpecialChar LyX
6970 \begin_layout Itemize
6971 \begin_inset Flex Code
6974 \begin_layout Plain Layout
6982 for reverse PDF search,
6985 \begin_layout Itemize
6986 \begin_inset Flex Code
6989 \begin_layout Plain Layout
6992 usepackage[active]{srcltx}
6997 for reverse DVI search.
7000 \begin_layout Standard
7001 If you want to be able to perform both DVI and PDF reverse searches, you
7002 can also insert in the preamble the following lines
7005 \begin_layout LyX-Code
7009 \begin_inset Newline newline
7015 \begin_inset Newline newline
7021 \begin_inset Newline newline
7027 \begin_inset Newline newline
7032 usepackage[active]{srcltx}
7033 \begin_inset Newline newline
7041 \begin_layout Standard
7042 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7043 right package will be used.
7046 \begin_layout Standard
7047 Note that PDFSync might affect the output layout of your document.
7048 It is therefore advised to disable PDFsync for final documents.
7051 \begin_layout Subsubsection*
7052 Built-in reverse search via Sync\SpecialChar TeX
7056 \begin_layout Standard
7058 \begin_inset Flex Code
7061 \begin_layout Plain Layout
7067 have built-in support for both PDF and DVI reverse search.
7070 Sync\SpecialChar TeX
7073 facility is basically the result of the integration of the PDFSync package
7074 to the pdftex program and its merge with the
7079 You need at least \SpecialChar TeX
7080 Live 2008 or a recent Mik\SpecialChar TeX
7081 distribution in order to use
7086 \begin_layout Plain Layout
7087 For some reason, Mik\SpecialChar TeX
7088 does not understand/obey the command \SpecialChar LyX
7090 the preamble when you check the "Enable Forward/Reverse Search" button
7091 in the toolbar and does not generate the necessary info.
7094 \begin_layout Plain Layout
7095 The generation of the required info can be forced by changing the converter
7097 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7098 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7099 the -synctex=1 switch).
7104 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
7105 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
7106 already provide Sync\SpecialChar TeX
7110 \begin_layout Standard
7111 To enable Sync\SpecialChar TeX
7112 for DVI output, change the
7113 \begin_inset Flex Noun
7116 \begin_layout Plain Layout
7127 \begin_inset Flex Noun
7130 \begin_layout Plain Layout
7141 \begin_inset Flex Noun
7144 \begin_layout Plain Layout
7145 Preferences\SpecialChar menuseparator
7146 File Handling\SpecialChar menuseparator
7153 \begin_inset Flex Code
7156 \begin_layout Plain Layout
7157 latex -synctex=1 $$i
7162 , and for PDF output, change the
7163 \begin_inset Flex Noun
7166 \begin_layout Plain Layout
7171 (pdflatex) -> PDF (pdflatex)
7177 \begin_inset Flex Code
7180 \begin_layout Plain Layout
7181 pdflatex -synctex=1 $$i
7187 Should your viewer not be considered in the following description, or in
7188 case of missing success, please check the documentation of your viewer
7189 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
7194 \begin_layout Plain Layout
7195 Note that the option
7196 \begin_inset Flex Code
7199 \begin_layout Plain Layout
7205 option enables gzip compression.
7206 If your viewer does not support it, you should instead use
7207 \begin_inset Flex Code
7210 \begin_layout Plain Layout
7224 \begin_layout Subsection
7225 Configuring and using specific viewers
7226 \begin_inset CommandInset label
7228 name "subsec:configuring-viewers"
7235 \begin_layout Subsubsection*
7236 Xdvi (all platforms)
7239 \begin_layout Standard
7241 \begin_inset Flex Code
7244 \begin_layout Plain Layout
7250 , you don't need to do anything else for performing a reverse DVI search,
7252 already provides the necessary hooks for automatically using the
7253 \begin_inset Flex Code
7256 \begin_layout Plain Layout
7263 Just setup your document as described above (reverse search is triggered
7264 by Ctrl-click or Alt-click on Mac OSX, respectively).
7267 \begin_layout Standard
7268 However, if for whatever reason you want to use the named pipe instead of
7269 the socket for communicating with \SpecialChar LyX
7270 , simply change the DVI viewer in
7271 \begin_inset Flex Noun
7274 \begin_layout Plain Layout
7275 Preferences\SpecialChar menuseparator
7276 File Handling\SpecialChar menuseparator
7286 \begin_layout Plain Layout
7287 On Mac OSX you have to use
7288 \begin_inset Flex Code
7291 \begin_layout Plain Layout
7292 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7303 \begin_inset Flex Code
7306 \begin_layout Plain Layout
7307 xdvi -editor "lyxeditor.sh %f %l"
7313 \begin_inset Flex Code
7316 \begin_layout Plain Layout
7322 is a suitable script.
7323 For example, a minimal shell script is the following one:
7326 \begin_layout LyX-Code
7328 \begin_inset Newline newline
7331 LYXPIPE="/path/to/lyxpipe"
7332 \begin_inset Newline newline
7335 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7336 \begin_inset Newline newline
7339 echo "$COMMAND" > "${LYXPIPE}".in || exit
7340 \begin_inset Newline newline
7343 read TMP < "${LYXPIPE}".out || exit
7346 \begin_layout Standard
7348 \begin_inset Flex Code
7351 \begin_layout Plain Layout
7357 is the LyXServer pipe path specified in
7358 \begin_inset Flex Noun
7361 \begin_layout Plain Layout
7362 Preferences\SpecialChar menuseparator
7372 \begin_layout Plain Layout
7374 \begin_inset Flex Code
7377 \begin_layout Plain Layout
7383 folder of a source distribution you can find a
7384 \begin_inset Flex Code
7387 \begin_layout Plain Layout
7393 script which is able to locate the
7397 based on your preferences.
7405 \begin_layout Subsubsection*
7409 \begin_layout Standard
7411 \begin_inset Flex Code
7414 \begin_layout Plain Layout
7415 /Applications/MacDviX_Folder/calleditor.script
7420 , add the following lines:
7423 \begin_layout LyX-Code
7424 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7425 \begin_inset Newline newline
7431 \begin_layout Standard
7432 Modify the lines accordingly if you install \SpecialChar LyX
7433 somewhere else than in the
7434 Applications folder.
7437 \begin_layout Standard
7438 Reverse search is triggered by Alt-click (OPTION-click).
7441 \begin_layout Subsubsection*
7445 \begin_layout Standard
7447 \begin_inset Flex Code
7450 \begin_layout Plain Layout
7451 open -a Skim.app $$i
7456 to the viewer setting in
7457 \begin_inset Flex Noun
7460 \begin_layout Plain Layout
7461 Preferences\SpecialChar menuseparator
7462 File Handling\SpecialChar menuseparator
7463 File formats\SpecialChar menuseparator
7470 \begin_inset Flex Noun
7473 \begin_layout Plain Layout
7474 Skim\SpecialChar menuseparator
7475 Preferences\SpecialChar menuseparator
7482 \begin_inset Flex Noun
7485 \begin_layout Plain Layout
7491 preset and enter command
7492 \begin_inset Flex Noun
7495 \begin_layout Plain Layout
7496 /Applications/\SpecialChar LyX
7497 .app/Contents/MacOS/lyxeditor
7505 \begin_layout Standard
7506 Reverse search is triggered by COMMAND-SHIFT-click
7509 \begin_layout Subsubsection*
7513 \begin_layout Standard
7514 Reverse search with evince does not work out of the box, but it can be achieved
7515 by means of some third party helper scripts.
7517 \begin_inset CommandInset href
7519 target "https://wiki.lyx.org/LyX/SyncTeX"
7527 \begin_layout Subsubsection*
7531 \begin_layout Standard
7533 \begin_inset Flex Noun
7536 \begin_layout Plain Layout
7537 Settings\SpecialChar menuseparator
7538 Configure Okular\SpecialChar menuseparator
7545 \begin_inset Quotes erd
7549 This inserts the appropriate command (
7550 \begin_inset Flex Code
7553 \begin_layout Plain Layout
7562 \begin_layout Standard
7563 Reverse search is triggered by SHIFT-click.
7565 \change_inserted -712698321 1578211026
7566 Note that this only works if Okular is in
7567 \begin_inset Quotes eld
7571 \begin_inset Quotes erd
7575 \begin_inset space \thinspace{}
7578 e., the hand symbol is clicked).
7583 \begin_layout Subsubsection*
7587 \begin_layout Standard
7588 Qpdfview supports Sync\SpecialChar TeX
7589 since version 0.3.5.
7591 \begin_inset Flex Noun
7594 \begin_layout Plain Layout
7595 Edit\SpecialChar menuseparator
7596 Settings\SpecialChar menuseparator
7602 , click on the input field of the
7603 \begin_inset Quotes eld
7607 \begin_inset Quotes erd
7610 item and add the command
7611 \begin_inset Flex Code
7614 \begin_layout Plain Layout
7623 \begin_layout Standard
7624 Reverse search is triggered by double-click or, in more recent versions,
7628 \begin_layout Subsubsection*
7632 \begin_layout Standard
7633 Launch yap, choose its
7634 \begin_inset Flex Noun
7637 \begin_layout Plain Layout
7638 View\SpecialChar menuseparator
7645 \begin_inset Quotes eld
7649 \begin_inset Quotes erd
7654 \begin_inset Quotes eld
7657 New\SpecialChar ldots
7659 \begin_inset Quotes erd
7662 button and, in the window that opens, enter
7663 \begin_inset Quotes eld
7668 \begin_inset Quotes erd
7671 (or any other name you like) in the
7672 \begin_inset Quotes eld
7676 \begin_inset Quotes erd
7680 Now click on the button labeled
7681 \begin_inset Quotes eld
7686 \begin_inset Quotes erd
7689 to open a file dialog and navigate to the directory containing the batch
7691 \begin_inset Flex Code
7694 \begin_layout Plain Layout
7702 \begin_inset Flex Code
7705 \begin_layout Plain Layout
7711 and then specify the program arguments as
7712 \begin_inset Flex Code
7715 \begin_layout Plain Layout
7723 \begin_inset Flex Code
7726 \begin_layout Plain Layout
7732 wrapper is used for communicating with \SpecialChar LyX
7740 \begin_layout LyX-Code
7742 \begin_inset Newline newline
7745 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7754 \begin_inset Newline newline
7768 \begin_layout Standard
7769 Make sure that the \SpecialChar LyX
7770 Server pipe path you specified in \SpecialChar LyX
7772 \begin_inset Flex Code
7775 \begin_layout Plain Layout
7789 , otherwise change the
7790 \begin_inset Flex Code
7793 \begin_layout Plain Layout
7799 wrapper accordingly.
7802 \begin_layout Standard
7803 In yap, reverse search is triggered by double-click.
7806 \begin_layout Subsubsection*
7807 SumatraPDF (Windows)
7810 \begin_layout Standard
7811 In order to use SumatraPDF for inverse search, enter
7812 \begin_inset Flex Code
7815 \begin_layout Plain Layout
7816 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
7821 in the viewer setting in
7822 \begin_inset Flex Noun
7825 \begin_layout Plain Layout
7826 Preferences\SpecialChar menuseparator
7827 File Handling\SpecialChar menuseparator
7828 File formats\SpecialChar menuseparator
7835 \begin_inset Flex Code
7838 \begin_layout Plain Layout
7844 is the previous wrapper.
7845 If SumatraPDF.exe is not in your command PATH, use its full file name.
7848 \begin_layout Standard
7849 Reverse search is triggered by double-click.
7852 \begin_layout Subsubsection*
7856 \begin_layout Standard
7857 First of all, make sure that yap is your default DVI viewer in the Windows
7858 environment, then launch it, choose its
7859 \begin_inset Flex Noun
7862 \begin_layout Plain Layout
7863 View\SpecialChar menuseparator
7870 \begin_inset Quotes eld
7874 \begin_inset Quotes erd
7879 \begin_inset Quotes eld
7882 New\SpecialChar ldots
7884 \begin_inset Quotes erd
7887 button and, in the window that opens, enter
7888 \begin_inset Quotes eld
7893 \begin_inset Quotes erd
7896 (or any other name you like) in the
7897 \begin_inset Quotes eld
7901 \begin_inset Quotes erd
7905 Now click on the button labeled
7906 \begin_inset Quotes eld
7911 \begin_inset Quotes erd
7914 to open a file dialog and navigate to the directory containing the
7915 \begin_inset Flex Code
7918 \begin_layout Plain Layout
7924 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7927 \begin_inset Flex Code
7930 \begin_layout Plain Layout
7936 and then specify the program arguments as
7937 \begin_inset Flex Code
7940 \begin_layout Plain Layout
7947 In this way, you will be using the
7951 for communicating with \SpecialChar LyX
7953 If, for whatever reason, you want to use the
7958 \begin_inset Flex Code
7961 \begin_layout Plain Layout
7967 option and be sure to specify the \SpecialChar LyX
7968 Server pipe path in the \SpecialChar LyX
7972 \begin_layout Standard
7973 In yap, reverse search is triggered by double-click.
7976 \begin_layout Subsubsection*
7980 \begin_layout Standard
7981 In order to use SumatraPDF for inverse search, enter
7982 \begin_inset Flex Code
7985 \begin_layout Plain Layout
7986 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7991 in the viewer setting in
7992 \begin_inset Flex Noun
7995 \begin_layout Plain Layout
7996 Preferences\SpecialChar menuseparator
7997 File Handling\SpecialChar menuseparator
7998 File formats\SpecialChar menuseparator
8005 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8007 \begin_inset Flex Code
8010 \begin_layout Plain Layout
8016 enables communication via the
8022 \begin_inset Flex Code
8025 \begin_layout Plain Layout
8031 option if you want to use the
8035 , and be sure to specify the \SpecialChar LyX
8036 Server pipe path in the \SpecialChar LyX
8040 \begin_layout Standard
8041 Reverse search is triggered by double-click.
8044 \begin_layout Section
8048 \begin_layout Standard
8049 Forward search is, as the name implies, in a sense the
8050 \begin_inset Quotes eld
8054 \begin_inset Quotes erd
8058 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8060 If forward search is set up (as described in what follows), you can put
8061 the cursor anywhere in your \SpecialChar LyX
8063 \begin_inset Flex Noun
8066 \begin_layout Plain Layout
8067 Navigate\SpecialChar menuseparator
8074 \begin_inset Flex Noun
8077 \begin_layout Plain Layout
8083 in the context menu via right mouse click), and then the viewer will jump
8084 to that position as well.
8085 This implies, of course, that your viewer supports this function.
8088 \begin_layout Standard
8089 To make forward search possible, you first need to provide the generated
8090 output PDF/DVI file with additional information about the \SpecialChar TeX
8092 This can be done via the methods described in the section
8093 \begin_inset CommandInset ref
8095 reference "subsec:rev-search"
8102 \begin_layout Standard
8103 Additionally, you need to configure \SpecialChar LyX
8104 for using your viewers in
8105 \begin_inset Flex Noun
8108 \begin_layout Plain Layout
8109 Tools\SpecialChar menuseparator
8110 Preferences\SpecialChar menuseparator
8111 Output\SpecialChar menuseparator
8118 We provide a range of tested configurations for some viewers, which you
8119 can select from the drop down list.
8120 If none of these configurations suits you, you have to find out and enter
8121 a suitable configuration yourself.
8122 The definition syntax uses the following placeholders:
8125 \begin_layout Itemize
8127 \begin_inset Flex Code
8130 \begin_layout Plain Layout
8139 \begin_layout Itemize
8141 \begin_inset Flex Code
8144 \begin_layout Plain Layout
8150 : name of the (temporary) exported .tex file (without path)
8153 \begin_layout Itemize
8155 \begin_inset Flex Code
8158 \begin_layout Plain Layout
8164 : name of the (temporary) exported .tex file (including path)
8167 \begin_layout Itemize
8169 \begin_inset Flex Code
8172 \begin_layout Plain Layout
8178 : name of the exported output file (either dvi or pdf, depending on which
8179 one exists in the temporary directory)
8182 \begin_layout Standard
8183 Note that only some of the viewers provide full and usable forward search
8184 functionality out of the box, among them yap, xdvi, okular
8188 \begin_layout Plain Layout
8189 You might want to set
8190 \begin_inset Flex Code
8193 \begin_layout Plain Layout
8200 \begin_inset Flex Noun
8203 \begin_layout Plain Layout
8204 Tools\SpecialChar menuseparator
8205 Preferences\SpecialChar menuseparator
8206 File Handling\SpecialChar menuseparator
8208 \begin_inset space ~
8221 , qpdfview, and SumatraPDF
8225 \begin_layout Plain Layout
8226 SumatraPDF can also use DDE commands through the external program CMCDDE
8228 \begin_inset CommandInset href
8230 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8241 Others, such as evince
8245 \begin_layout Plain Layout
8246 Forward search with evince can be achieved by means of third party helper
8249 \begin_inset CommandInset href
8251 target "https://wiki.lyx.org/LyX/SyncTeX"
8261 , require some extra tools in order to use forward search.
8262 While many of the widespread PDF viewers (most notably Adobe Reader) do
8263 not support forward search at all, some other viewers – e.
8264 \begin_inset space \thinspace{}
8268 xpdf – allow at least to reload the document and jump to a specific page
8269 of the file, so you can at least navigate
8270 \begin_inset Quotes eld
8274 \begin_inset Quotes erd
8278 This latter functionality is provided by an external call of synctex (see
8279 the predefined example configurations).
8283 \begin_layout Standard
8284 Forward search works both with DVI and PDF output.
8286 simply checks which preview format you have used before (i.
8287 \begin_inset space \thinspace{}
8290 e., which format is already there in the temporary directory) and chooses
8291 the appropriate configuration for the respective format.
8294 \begin_layout Chapter
8295 Special Document Classes
8298 \begin_layout Section
8302 \begin_layout Standard
8308 \begin_layout Subsection
8312 \begin_layout Standard
8313 This section describes how \SpecialChar LyX
8314 can be used to write articles for submission
8315 to the scientific journal
8317 Astronomy and Astrophysics
8320 \begin_inset Flex URL
8323 \begin_layout Plain Layout
8325 https://www.aanda.org/
8330 ) using Version 5.01 of the document class
8335 This package can be downloaded from the ftp site
8338 \begin_layout Standard
8339 \begin_inset VSpace medskip
8345 \begin_layout Standard
8347 \begin_inset Flex URL
8350 \begin_layout Plain Layout
8352 ftp://ftp.edpsciences.org/pub/aa/readme.html
8360 \begin_layout Standard
8361 \begin_inset VSpace medskip
8367 \begin_layout Standard
8368 A manual comes together with that package, and this text is not meant to
8369 replace the original manual but is merely a short guide in how to realize
8370 the correct form of your paper.
8374 \begin_layout Standard
8375 Please note that the publisher of the journal was changed from Springer
8376 to EDP Sciences starting January 1, 2001.
8377 That change involved also some slight changes to the style files, namely
8378 the removal of the thesaurus command.
8379 The \SpecialChar LyX
8380 class aa supports the newest version of these style files, V 5.01.
8381 If you have an older version installed, please upgrade.
8382 For compatibility, the old (version 4) layout has been kept as
8387 Please refer to the comments in
8390 Dir/layouts/aapaper.layout
8395 \begin_layout Subsection
8399 \begin_layout Standard
8400 It is recommended you start from the example template distributed with \SpecialChar LyX
8402 If you are not using a template, note the following settings:
8405 \begin_layout Itemize
8412 Document\SpecialChar menuseparator
8415 dialog (OK, that one was obvious).
8418 \begin_layout Itemize
8419 Don't change the option
8422 \begin_inset space ~
8432 The whole layout is done by the macros, you shouldn't change anything.
8435 \begin_layout Subsection
8439 \begin_layout Standard
8440 First thing to enter is the header information.
8441 It consists of seven entries, of which some are optional.
8445 \begin_layout Itemize
8453 \begin_layout Itemize
8461 \begin_layout Itemize
8469 \begin_layout Itemize
8477 \begin_layout Itemize
8482 : [optional] if more than one author: whom to contact for offprint requests.
8485 \begin_layout Itemize
8490 : [optional] mail address for contacts.
8493 \begin_layout Itemize
8501 Received: <date>; Accepted <date>
8504 \begin_layout Standard
8505 There is no need to issue the
8511 command, this is done automatically by \SpecialChar LyX
8512 when the header is finished.
8513 Although the order of the single header entries doesn't matter it is advised
8514 to keep the above sequence, just to get the best optics and meets the layout
8515 of the real document.
8518 \begin_layout Standard
8519 If you want to place footnotes in the header block, e.
8520 \begin_inset space \thinspace{}
8524 \begin_inset space \space{}
8527 to state your present address, just use the standard footnote via the menu
8530 Insert\SpecialChar menuseparator
8535 will automagically use the term
8544 \begin_layout Standard
8547 Edit\SpecialChar menuseparator
8550 , you'll find two insets which are relevant for the titling:
8553 \begin_layout Itemize
8560 to mark corresponding author\SpecialChar breakableslash
8562 The institutes are numbered sequentially as they appear in the
8566 field, so you have to put a marker to each author.
8569 \begin_layout Itemize
8574 to supply an email address for fast contact.
8577 \begin_layout Standard
8578 In addition to these topics, the macros use one additional \SpecialChar LaTeX
8580 has no counterpart in \SpecialChar LyX
8584 \begin_layout Itemize
8591 to separate different names for more than one author and institute, respectivel
8595 \begin_layout Standard
8596 The appropriate command has to be entered in \SpecialChar LyX
8597 and marked as \SpecialChar LaTeX
8603 \begin_layout Subsection
8607 \begin_layout Standard
8608 The abstract should immediately follow the header block.
8609 With version 5 the abstract environment was changed to a command, and there
8610 is now a restriction to only one paragraph.
8611 In addition, it should contain an entry with the keywords.
8612 This is done via the paragraph style
8617 Refer to the example paper.
8620 \begin_layout Subsection
8621 Supported environments
8624 \begin_layout Standard
8625 The A&A paper layout supports the following environments for structuring
8629 \begin_layout Itemize
8635 \begin_layout Itemize
8641 \begin_layout Itemize
8647 \begin_layout Itemize
8653 \begin_layout Itemize
8659 \begin_layout Itemize
8665 \begin_layout Itemize
8671 \begin_layout Itemize
8677 \begin_layout Itemize
8683 \begin_layout Itemize
8689 \begin_layout Itemize
8695 \begin_layout Itemize
8702 \begin_layout Subsection
8703 Commands not supported by \SpecialChar LyX
8707 \begin_layout Standard
8708 Some commands are not yet supported by the
8712 layout for \SpecialChar LyX
8714 Some have already been mentioned.
8715 For the sake of completeness, they are listed all together here:
8718 \begin_layout Itemize
8726 \begin_layout Itemize
8734 \begin_layout Itemize
8742 \begin_layout Itemize
8750 \begin_layout Standard
8751 If you want to use any of these commands, you have to enter them yourself.
8754 Do not forget to mark them as \SpecialChar LaTeX
8758 \begin_layout Subsection
8759 Figure and Table Floats
8762 \begin_layout Standard
8764 provides support for the necessary float environments
8766 figure, figure*, table
8772 , therefore we won't tell much about it here.
8776 \begin_inset space ~
8782 Just remember that tables should be left-aligned.
8783 For that, select the table and change the alignment in
8785 Edit\SpecialChar menuseparator
8787 \begin_inset space ~
8793 \begin_layout Standard
8794 There is only one special thing: the figures with caption besides the figure.
8795 To create such a figure, you have to do the following:
8798 \begin_layout Enumerate
8799 Create a wide figure float:
8801 Insert\SpecialChar menuseparator
8802 Float\SpecialChar menuseparator
8805 , then right click in the figure and select
8808 \begin_inset space ~
8816 \begin_layout Enumerate
8817 Enter your caption text.
8820 \begin_layout Enumerate
8825 to move the cursor above the caption.
8828 \begin_layout Enumerate
8832 \begin_layout Enumerate
8833 Position the cursor behind the figure and insert a horizontal fill:
8835 Insert\SpecialChar menuseparator
8837 \begin_inset space ~
8840 Character\SpecialChar menuseparator
8842 \begin_inset space ~
8850 \begin_layout Enumerate
8851 Switch to \SpecialChar LaTeX
8855 \begin_inset space ~
8863 \begin_layout Enumerate
8873 Do not close the brace!
8876 \begin_layout Enumerate
8877 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8882 \begin_inset space ~
8894 \begin_layout Standard
8895 Also, refer to the figures in the example paper.
8898 \begin_layout Subsection
8902 \begin_layout Standard
8903 For submission, the paper has to be formated in a special double-spacing
8905 For this purpose, you have to give the option
8909 to the document class.
8910 This must be done using the custom class options field in the
8912 Document\SpecialChar menuseparator
8916 Just enter the string
8923 \begin_layout Subsection
8927 \begin_layout Standard
8932 directory contains an example paper written with \SpecialChar LyX
8934 It is the example paper from the original macro package, translated to
8937 Use it for inspiration, and compare the original \SpecialChar LaTeX
8938 code with \SpecialChar LyX
8942 \begin_layout Section
8947 \begin_layout Standard
8953 \begin_layout Subsection
8957 \begin_layout Standard
8959 is a set of macros produced by the American Astronomical Society to
8960 facilitate electronic manuscript submission to the three journals they
8961 publish: the Astrophysical Journal (including the Letters and Supplement),
8962 the Astronomical Journal, and the Publications of the Astronomical Society
8965 has proven to be an excellent tool for generating these documents, especially
8966 given its equation, citation, and figure handling capabilities.
8968 requires version 5.0 (or higher) of these macros; preferably 6.0, which
8969 is the version described here, or higher.
8970 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8971 2.09 and are fundamentally
8972 incompatible with \SpecialChar LyX
8974 The AAS\SpecialChar TeX
8975 package may be downloaded from the AAS\SpecialChar TeX
8979 \begin_layout Standard
8980 \begin_inset VSpace medskip
8986 \begin_layout Standard
8988 \begin_inset Flex URL
8991 \begin_layout Plain Layout
8993 https://aas.org/aastex/aastex-downloads
9001 \begin_layout Standard
9002 \begin_inset VSpace medskip
9008 \begin_layout Standard
9009 A complete user guide is contained in that package and you should familiarize
9010 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9013 will not reduce the need to figure out all the AAS\SpecialChar TeX
9014 commands, it will only
9015 reduce the drudgery of typing everything in.
9016 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9018 completely to the requirements of the journal to which you are submitting
9022 \begin_layout Subsection
9023 Starting a New Paper
9026 \begin_layout Standard
9027 I strongly suggest that you start with the AAS\SpecialChar TeX
9031 File\SpecialChar menuseparator
9038 , enter the new file name, then choose the
9043 This will show the most common fields found in a manuscript.
9044 Simply overwrite the existing text (including the brackets,
9048 ) with the correct information.
9049 Many of the AAS\SpecialChar TeX
9050 commands and environments can be implemented directly in
9053 For commands such as these, the \SpecialChar LaTeX
9054 code must be entered directly and marked
9056 Such commands are referred to as \SpecialChar TeX
9057 code, or Evil Red Text.
9058 I tried to minimize the amount of \SpecialChar TeX
9059 code needed in an AAS\SpecialChar TeX
9063 \begin_layout Subsection
9064 Finishing Your Paper
9067 \begin_layout Standard
9068 When the paper is finished to your satisfaction and previews/prints correctly,
9070 \begin_inset Quotes eld
9074 \begin_inset Quotes erd
9077 actions which need to be done before you submit it to the journals.
9081 \begin_layout Enumerate
9082 Export your paper as a \SpecialChar LaTeX
9085 File\SpecialChar menuseparator
9086 Export\SpecialChar menuseparator
9094 \begin_layout Enumerate
9099 file with your favorite text editor
9103 \begin_layout Enumerate
9104 remove the comment lines before the
9113 \begin_layout Enumerate
9118 usepackage...{fontenc}
9120 line if it appears (usually just after
9135 \begin_layout Enumerate
9136 remove everything between (and including) the
9148 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9150 (which should appear immediately after the
9151 \begin_inset Quotes eld
9154 User specified \SpecialChar LaTeX
9156 \begin_inset Quotes erd
9167 \begin_layout Enumerate
9168 Run the resulting file through \SpecialChar LaTeX
9169 to make sure it still processes correctly.
9172 \begin_layout Enumerate
9173 Reread the journal requirements to make sure your filenames and formats
9177 \begin_layout Enumerate
9181 \begin_layout Subsection
9182 Comments On Specific Commands
9185 \begin_layout Standard
9186 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9193 ) gives a good description of each.
9194 Thus it's probably easiest for me to go down the list as found in the guide
9195 and offer comments where necessary.
9196 So let's begin \SpecialChar ldots
9200 \begin_layout Subsubsection
9201 Things that work as expected
9204 \begin_layout Standard
9205 Because they work as you might expect, I simply list them and the section
9306 begin{thebibliography}
9314 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9315 graphicx figure commands (2.14.1),
9339 (2.15.4, amongst other places),
9366 \begin_layout Standard
9367 The following style options also work correctly:
9388 Simply put them in the
9394 Layout\SpecialChar menuseparator
9400 \begin_layout Subsubsection
9401 Things that work, but require more comment
9404 \begin_layout Standard
9405 The following items work, but require a little more discussion:
9408 \begin_layout Itemize
9409 These items are reserved for use by the journal editors, but you can put
9410 them into the \SpecialChar LaTeX
9411 preamble if you feel compelled to do so:
9444 \begin_layout Itemize
9445 These items may be placed in the \SpecialChar LaTeX
9446 preamble, and are included as blanks in
9468 \begin_layout Itemize
9475 (2.3) – can only be used
9476 \begin_inset Quotes eld
9480 \begin_inset Quotes erd
9483 , not in the middle of a paragraph.
9484 Use \SpecialChar TeX
9485 code if you need to embed it.
9488 \begin_layout Itemize
9495 (2.3) – will have extra {} after it.
9496 This should not cause an error.
9499 \begin_layout Itemize
9506 (2.6) – can only be used
9507 \begin_inset Quotes eld
9511 \begin_inset Quotes erd
9514 , not in the middle of a paragraph.
9515 Use \SpecialChar TeX
9516 code if you need to embed it.
9519 \begin_layout Itemize
9526 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9530 \begin_layout Itemize
9544 \begin_layout Itemize
9551 (2.9) – will have extra {} after it.
9552 This should not cause an error.
9555 \begin_layout Itemize
9562 (2.11) – will have extra {} after it.
9563 This should not cause an error.
9566 \begin_layout Itemize
9573 (2.14.2) – you can insert an optional filename argument by placing the cursor
9574 at the beginning of the text and selecting
9576 Insert\SpecialChar menuseparator
9581 \begin_inset Quotes eld
9585 \begin_inset Quotes erd
9588 inserts an optional argument of the type needed by
9595 Hopefully it will be renamed someday.
9598 \begin_layout Itemize
9611 for the catalog ID optional parameter
9614 \begin_layout Itemize
9627 for the catalog ID optional parameter
9630 \begin_layout Subsubsection
9631 Things not implemented, use \SpecialChar TeX
9635 \begin_layout Standard
9646 setcounter{equation}
9648 (2.12), Journal name abbreviations (2.13.4),
9684 (2.15.4, insert it as the first element in the lefthand cell after where
9686 Don't use any of \SpecialChar LyX
9687 's rules in the table),
9699 (2.15.5), much of Misc (2.17, except
9750 \begin_layout Subsubsection
9751 Things that cannot be implemented
9754 \begin_layout Standard
9756 at least in any meaningful sort of way, so I suggest ignoring them.
9757 They are the references environment (2.13.3), and the deluxetable environment
9759 If you really, really need to use deluxetable, I suggest editing it in
9760 a separate file with a text editor, then using
9762 Insert\SpecialChar menuseparator
9764 \begin_inset space ~
9769 to include it in your \SpecialChar LyX
9775 file to see an example of this.
9778 \begin_layout Subsection
9779 FAQs, Tips, Tricks, and Other Ruminations
9782 \begin_layout Subsubsection
9783 Getting \SpecialChar LyX
9784 and AAS\SpecialChar TeX
9788 \begin_layout Standard
9789 It can be a bit tricky to get \SpecialChar LyX
9790 to recognize a new layout and document class.
9791 When all else fails, do this:
9794 \begin_layout Enumerate
9795 Make certain that \SpecialChar LaTeX
9796 can find AAS\SpecialChar TeX
9798 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9800 directory completely unrelated to \SpecialChar LaTeX
9801 or AAS\SpecialChar TeX
9802 and run \SpecialChar LaTeX
9810 \begin_layout Enumerate
9815 appears in \SpecialChar LyX
9823 \begin_layout Enumerate
9826 Tools\SpecialChar menuseparator
9830 , then restart \SpecialChar LyX
9834 \begin_layout Enumerate
9835 Open a regular new file, not from a template.
9836 Does AAS\SpecialChar TeX
9837 appear in the class list in
9839 Document\SpecialChar menuseparator
9845 \begin_layout Standard
9846 If you get a warning from an existing AAS\SpecialChar TeX
9847 document about not being able
9848 to find the AAS\SpecialChar TeX
9849 layout or a message about
9850 \begin_inset Quotes eld
9853 You should not mix title layouts with normal ones
9854 \begin_inset Quotes erd
9857 , things haven't been installed correctly.
9860 \begin_layout Subsubsection
9862 error processing a table
9865 \begin_layout Standard
9867 , by default, attempts to center the table caption/title.
9868 This seems to produce a bad interaction in AAS\SpecialChar TeX
9869 so you should click somewhere
9870 in the caption/title, then select
9872 Edit\SpecialChar menuseparator
9874 \begin_inset space ~
9888 This took care of it for me.
9891 \begin_layout Subsubsection
9895 \begin_layout Standard
9896 A couple of things: 1) I have noticed some funny spacing in the reference
9897 entries in the text.
9898 When you enter the bibliography item data, make sure their is
9902 space between the last author and the parenthesis setting off the year;
9906 \begin_inset space \thinspace{}
9910 \begin_inset space \space{}
9924 2) Entering the references at all is not obvious.
9925 The easiest thing is to start typing your first reference at the end of
9926 the document, then mark it as type
9931 That will put a small gray box in front of what you just typed.
9932 Click on the box to fill in the rest of the information.
9933 For new references, go to the end of an existing reference and press return.
9934 That will create a new line with its own box, etc.
9937 \begin_layout Subsubsection
9941 \begin_layout Standard
9942 Even though AAS\SpecialChar TeX
9943 provides its own figure commands (
9949 , for example), I much prefer \SpecialChar LaTeX
9950 's standard figure commands (with the default
9959 \begin_inset space ~
9962 commands as \SpecialChar TeX
9963 code into a Figure Float box if you desire, but I never have
9964 much luck getting the layout right.
9965 With the standard graphics, \SpecialChar LyX
9970 usepackage{graphicx}
9972 command into the \SpecialChar LaTeX
9973 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9975 interspersing the figures in the text.
9976 I believe ApJ accepts figures exactly this way now; AJ might still use
9978 \begin_inset Quotes eld
9981 stack everything at the end
9982 \begin_inset Quotes erd
9988 \begin_layout Subsubsection
9989 Things I could have done, but didn't
9992 \begin_layout Standard
9994 \begin_inset Quotes eld
9998 \begin_inset Quotes erd
10001 things I could have implemented, but chose not to.
10002 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10004 even though it is double-spaced in the paper manuscript.
10005 Also, I chose not to make separate layouts for the preprint and preprint2
10007 Since I assume you will spend most of your time in the plain manuscript
10008 mode anyway, I decided not to chew up more disk space with this.
10012 \begin_layout Subsection
10016 \begin_layout Standard
10017 Your mileage may vary.
10018 I've now had papers published by both ApJ and AJ that have had 98% of the
10019 effort done in \SpecialChar LyX
10020 ; the last 2% was the \SpecialChar LaTeX
10021 post-processing and a few cleanups.
10022 I have had no trouble with the submission process, and I'm sure the journals
10023 were never aware that there might be a difference.
10024 So, go forth and publish!
10027 \begin_layout Section
10028 AMS \SpecialChar LaTeX
10032 \begin_layout Standard
10042 \begin_layout Standard
10043 \begin_inset VSpace bigskip
10049 \begin_layout Standard
10051 The AMS \SpecialChar LaTeX
10052 layouts are set up to conform to suggested styles for mathematical
10053 papers to be submitted to American Mathematical Society publications.
10054 The layouts are not tailored to a specific journal, but easily can be.
10055 You should refer to the AMS documentation for specific instructions for
10056 each journal (usually it will entail only changing a single line in the
10059 That documentation is available on the Web at
10060 \begin_inset Flex URL
10063 \begin_layout Plain Layout
10071 \begin_inset Flex URL
10074 \begin_layout Plain Layout
10076 ftp://ftp.ams.org/pub/tex/amslatex/
10082 These layouts are appropriate, and useful, for any mathematical writing.
10086 \begin_layout Standard
10087 There are two basic AMS \SpecialChar LaTeX
10091 \begin_layout Itemize
10092 amsart: The standard AMS article format.
10095 \begin_layout Itemize
10096 amsbook: the standard AMS book (really, monograph) format.
10100 \begin_layout Standard
10101 The layouts themselves contain only the minimum necessary to use the AMS
10103 They do not, in particular, contain any of the `theorem' environments used
10104 for setting theorems, lemmas, and the like.
10105 These are contained, instead, in the
10106 \begin_inset Flex Code
10109 \begin_layout Plain Layout
10115 module, which is loaded by default when you select one of the AMS classes.
10116 (It can also be used with other classes and can be removed, if you would
10117 rather use something else.) Less commonly used environments are in the
10118 \begin_inset Flex Code
10121 \begin_layout Plain Layout
10122 Theorems (AMS-Extended)
10127 module, which must be loaded manually.
10130 \begin_layout Standard
10131 By default, theorems and the like are numbered consecutively throughout
10132 the document, but this may be modified by loading the module
10133 \begin_inset Flex Code
10136 \begin_layout Plain Layout
10137 Theorems (Order by Section)
10142 or, if you are using
10143 \begin_inset Flex Code
10146 \begin_layout Plain Layout
10153 \begin_inset Flex Code
10156 \begin_layout Plain Layout
10157 Theorems (Order by Chapter)
10163 These will number the results as
10164 \begin_inset Formula $n.m$
10167 , where the first number refers to the section (or chapter) and the second
10168 refers to the total number of results so far in that section (or chapter).
10169 Many environments are also available unnumbered.
10170 These are indicated by an asterisk at the end.
10171 If you happen to want
10175 unnumbered results, the module
10176 \begin_inset Flex Code
10179 \begin_layout Plain Layout
10185 provides that option.
10188 \begin_layout Standard
10189 Note that these modules do not
10193 to be used with the AMS classes.
10194 It is perfectly possible to use the
10195 \begin_inset Flex Code
10198 \begin_layout Plain Layout
10204 module, and the others mentioned, with other classes, such as
10205 \begin_inset Flex Code
10208 \begin_layout Plain Layout
10215 \begin_inset Flex Code
10218 \begin_layout Plain Layout
10225 \begin_inset Flex Code
10228 \begin_layout Plain Layout
10237 \begin_layout Subsection
10238 What these layouts provide
10241 \begin_layout Standard
10242 There is a long list of included environments provided by these layouts.
10243 In AMS-\SpecialChar LaTeX
10244 , there is, in fact, an opportunity to define an unlimited variety
10245 of `theorem' environments.
10246 However, the AMS recommends the environments that are available in \SpecialChar LyX
10251 \begin_layout Standard
10252 The following environments—as well as the standard environments, such as
10254 \begin_inset Flex Noun
10257 \begin_layout Plain Layout
10264 \begin_inset Flex Noun
10267 \begin_layout Plain Layout
10274 \begin_inset Flex Noun
10277 \begin_layout Plain Layout
10284 \begin_inset Flex Noun
10287 \begin_layout Plain Layout
10294 \begin_inset Flex Noun
10297 \begin_layout Plain Layout
10304 \begin_inset Flex Code
10307 \begin_layout Plain Layout
10314 \begin_inset Flex Code
10317 \begin_layout Plain Layout
10326 \begin_layout Description
10327 Address This should be the author's permanent address.
10330 \begin_layout Description
10332 \begin_inset space ~
10335 Address This should be the author's temporary address at the time of submission,
10336 if different from the Address.
10339 \begin_layout Description
10340 Email Author's e-mail address
10343 \begin_layout Description
10344 URL Author's Web address, if desired.
10347 \begin_layout Description
10348 Keywords Key words or phrases used to identify specific topics discussed
10352 \begin_layout Description
10353 Subjectclass These refer to the AMS Subject Classifications, published and
10356 Mathematical Reviews
10359 These are also available online at the AMS cites listed above.
10362 \begin_layout Description
10366 \begin_layout Description
10370 \begin_layout Description
10374 \begin_layout Standard
10375 The following environments are provided by both the
10376 \begin_inset Flex Code
10379 \begin_layout Plain Layout
10386 \begin_inset Flex Code
10389 \begin_layout Plain Layout
10395 modules, in the latter case in both starred (unnumbered) and unstarred
10396 (numbered) versions.
10397 These same environments are provided only in the starred versions by the
10399 \begin_inset Flex Code
10402 \begin_layout Plain Layout
10411 \begin_layout Theorem
10412 This is typically used for the statements of major results.
10416 \begin_layout Corollary*
10417 This is used for statements which follow fairly directly from previous statement
10419 Again, these can be major results.
10423 \begin_layout Lemma
10424 These are smaller results needed to prove other statements.
10427 \begin_layout Proposition
10428 These are less major results which (hopefully) add to the general theory
10432 \begin_layout Conjecture
10433 These are statements provided without justification, which the author does
10434 not know how to prove, but which seem to be true (to the author, at least).
10437 \begin_layout Definition*
10438 Guess what this is for.
10439 The font is different for this environment than for the previous ones.
10443 \begin_layout Example*
10444 Used for examples illustrating proven results.
10447 \begin_layout Problem
10448 It's not really known what this is for.
10449 You should figure it out.
10452 \begin_layout Exercise*
10453 Write a description for this one.
10456 \begin_layout Remark
10457 This environment is also a type of theorem, usually a lesser sort of observation.
10460 \begin_layout Claim*
10461 Often used in the course of giving a proof of a larger result.
10465 Generally, these are used to break up long arguments, using specific instances
10471 The numbering scheme for cases is on its own, not together with other numbered
10476 \begin_layout Proof
10477 At the end of this environment, a QED symbol (usually a square, but it can
10478 vary with different styles) is placed.
10479 If you want to have other environments within this one—for example, Case
10480 environments—and have the QED symbol appear only after them, then the other
10481 environments need to be nested within the proof environment.
10484 Nesting Environments
10490 for information on nesting.
10493 \begin_layout Standard
10494 And these environments are provided by
10495 \begin_inset Flex Code
10498 \begin_layout Plain Layout
10499 Theorems (AMS-Extended)
10507 \begin_layout Criterion*
10508 A required condition.
10511 \begin_layout Algorithm*
10512 A general procedure to be used.
10515 \begin_layout Axiom*
10516 This is a property or statement taken as true within the system being discussed.
10519 \begin_layout Condition*
10520 Sometimes used to state a condition assumed within the present context of
10524 \begin_layout Note*
10525 Similar to a Remark.
10528 \begin_layout Notation*
10529 Used for the explanation of, yes, notation.
10532 \begin_layout Summary
10533 Do we really need to tell you?
10536 \begin_layout Acknowledgement*
10540 \begin_layout Conclusion*
10541 Sometimes used at the end of a long train of argument.
10545 Used in a way similar to Proposition, though perhaps lower on the scale.
10548 \begin_layout Standard
10549 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10552 They need to be available on your system in order to use these environments.
10555 \begin_layout Section
10559 \begin_layout Standard
10565 \begin_layout Subsection
10569 \begin_layout Standard
10570 Broadway is for writing plays.
10571 The format is more decorative than Hollywood, and much less standardized.
10572 This format should be suitable for workshops.
10575 \begin_layout Subsection
10579 \begin_layout Standard
10580 The same as in Hollywood.
10583 \begin_layout Subsection
10587 \begin_layout Standard
10592 names as labels then cross-reference the label to insert the name.
10593 The cross-reference dialog will show the current cast of characters.
10596 \begin_layout Subsection
10597 Paper size and Margins
10600 \begin_layout Standard
10601 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10604 \begin_layout Subsection
10608 \begin_layout Standard
10609 The following environments are available.
10610 You can use broadway.bind to get the bind keys shown at the right.
10613 \begin_layout Itemize
10617 \begin_inset Newline newline
10622 You should not have to use this, but it is here for anything that does not
10626 \begin_layout Itemize
10630 \begin_inset space \hfill{}
10634 \begin_inset Newline newline
10639 Used to describe stage setting and the action.
10640 First use of speaker names in all CAPs.
10643 \begin_layout Itemize
10647 \begin_inset space \hfill{}
10651 \begin_inset Newline newline
10656 Automatically numbered.
10657 On screen it will be arabic, but will print as Roman.
10660 \begin_layout Itemize
10664 \begin_inset space \hfill{}
10668 \begin_inset Newline newline
10678 It is just centered text.
10681 \begin_layout Itemize
10685 \begin_inset space \hfill{}
10689 \begin_inset Newline newline
10694 Not automatically numbered.
10695 You supply the number.
10696 This is because I couldn't figure out how.
10699 \begin_layout Itemize
10703 \begin_inset space \hfill{}
10707 \begin_inset Newline newline
10712 A special case of Narrative to describe the setting and action as the curtain
10716 \begin_layout Itemize
10720 \begin_inset space \hfill{}
10724 \begin_inset Newline newline
10729 The speaker's (actor's) title, centered in all CAPS.
10732 \begin_layout Itemize
10736 \begin_inset space \hfill{}
10740 \begin_inset Newline newline
10745 Instructions to the speaker.
10746 The parentheses are automatically inserted.
10747 The ( will appear on screen, but both will be in the printed play.
10748 This environment is only used within
10755 \begin_layout Itemize
10759 \begin_inset space \hfill{}
10763 \begin_inset Newline newline
10768 What the Speaker says.
10771 \begin_layout Itemize
10775 \begin_inset space \hfill{}
10779 \begin_inset Newline newline
10784 The curtain comes down.
10787 \begin_layout Itemize
10791 \begin_inset space \hfill{}
10797 \begin_layout Itemize
10801 \begin_inset space \hfill{}
10807 \begin_layout Itemize
10811 \begin_inset space \hfill{}
10817 \begin_layout Standard
10821 \begin_layout Section
10825 \begin_layout Standard
10830 can be used to type letters according to German conventions.
10831 A template file is included in
10833 .../lyx/share/templates
10835 for you to use as a starting point.
10838 \begin_layout Section
10842 \begin_layout Standard
10843 See the \SpecialChar LyX
10849 It contains all infos you need.
10852 \begin_layout Section
10855 Foil\SpecialChar TeX
10859 \begin_inset CommandInset label
10868 \begin_layout Standard
10874 \begin_layout Subsection
10878 \begin_layout Standard
10879 This section describes how to use \SpecialChar LyX
10880 to make slides for overhead projectors.
10881 There are two document classes that can do this: the default slides class
10884 Foil\SpecialChar TeX
10888 This section documents the latter.
10891 \begin_layout Standard
10892 I'm going to say this again, nice and clear, so that there's no misunderstanding
10896 \begin_layout Standard
10897 \begin_inset VSpace bigskip
10903 \begin_layout Standard
10907 This section documents the class
10908 \begin_inset Quotes eld
10916 \begin_inset Quotes erd
10924 \begin_layout Standard
10925 \begin_inset VSpace bigskip
10931 \begin_layout Standard
10932 If you're looking for the documentation for
10933 \begin_inset Quotes eld
10941 \begin_inset Quotes erd
10944 , check out section
10945 \begin_inset space ~
10949 \begin_inset CommandInset ref
10951 reference "sec:slitex"
10956 If your machine doesn't have the
10964 installed, you'll probably have to use the default
10968 class, which isn't quite as good as
10973 \begin_layout Standard
10978 class is designed for use with version
10979 \begin_inset space ~
10987 class file which is now an integral part of \SpecialChar LaTeX2e
10991 \begin_layout Subsection
10995 \begin_layout Standard
10996 Obviously, to use this document class, you need to select
11007 \begin_inset space ~
11013 There are some settings in the
11016 \begin_inset space ~
11021 dialog that you should know about that are specific to this class:
11024 \begin_layout Itemize
11025 Don't change the options
11036 \begin_inset space ~
11042 They're ignored by the
11049 \begin_layout Itemize
11050 The default font size is 20
11051 \begin_inset space \thinspace{}
11054 pt with the other options being 17
11055 \begin_inset space \thinspace{}
11059 \begin_inset space \thinspace{}
11063 \begin_inset space \thinspace{}
11069 \begin_layout Itemize
11070 The default font is
11078 but all math equations are still typeset in the usual roman font.
11081 \begin_layout Itemize
11084 Foil\SpecialChar TeX
11087 supports A4 and Letter paper sizes as well as a special size for working
11089 \begin_inset space \thinspace{}
11093 It doesn't support A5, B5, legal or executive paper sizes.
11096 \begin_layout Itemize
11097 Don't bother changing the
11101 settings because they are ignored anyway.
11102 All floats appear where they are defined in the text.
11105 \begin_layout Itemize
11110 setting behaves a bit differently for this class.
11113 Foil\SpecialChar TeX
11116 provides extensive footer and header capabilities including a user-defined
11119 \begin_inset space ~
11123 \begin_inset CommandInset ref
11125 reference "sec:foilfoot"
11130 The title page is treated differently to all other pages in the document
11139 has the logo centered at the bottom of the page (if one is defined).
11140 The possible page style choices and what they do are as follows:
11144 \begin_layout Labeling
11145 \labelwidthstring MMMMMMM
11152 The final output contains no page numbers, or other headers or footers
11153 (except footnotes of course).
11157 \begin_layout Labeling
11158 \labelwidthstring MMMMMMM
11165 The final output contains page numbers centered at the bottom of the page.
11166 No other headings or footers (other than footnotes).
11169 \begin_layout Labeling
11170 \labelwidthstring MMMMMMM
11175 Page numbers in lower right corner.
11176 Additional headers and footers are also shown.
11177 This is also the default.
11180 \begin_layout Labeling
11181 \labelwidthstring MMMMMMM
11186 Gives you access to the
11190 package although its use with
11192 Foil\SpecialChar TeX
11195 is discouraged by the writer of the
11197 Foil\SpecialChar TeX
11200 package because of some potential page layout clashes.
11204 \begin_layout Subsubsection
11208 \begin_layout Standard
11209 The following options may be used in the extra class options in the
11211 Document\SpecialChar menuseparator
11217 \begin_layout Labeling
11218 \labelwidthstring MMMMMMx
11223 This sets up the page layout for 7.33
11224 \begin_inset space \thinspace{}
11228 \begin_inset space \thinspace{}
11231 in paper, which is about the same aspect ratio as a 35
11232 \begin_inset space \thinspace{}
11235 mm slide, making it a bit easier to work with this medium.
11238 \begin_layout Labeling
11239 \labelwidthstring MMMMMMx
11244 Places a rule across the page below the header on every page except the
11248 \begin_layout Labeling
11249 \labelwidthstring MMMMMMx
11254 Places a rule across the page above the footer on every page except the
11258 \begin_layout Labeling
11259 \labelwidthstring MMMMMMx
11264 This is automatically set each time you create a new
11271 Foil\SpecialChar TeX
11274 to use the dvips driver to rotate those pages that are set as landscape
11278 \begin_layout Labeling
11279 \labelwidthstring MMMMMMx
11284 Simply changes the page dimensions to those of a landscape page but doesn't
11286 Thus if you use this option you need to use an external program to rotate
11287 each page or feed your paper through your printer as landscape.
11288 Note that this option effectively reverses the roles of the
11296 environments (don't worry these are described in the next section).
11299 \begin_layout Labeling
11300 \labelwidthstring MMMMMMx
11305 Equation numbers on the left.
11308 \begin_layout Labeling
11309 \labelwidthstring MMMMMMx
11314 Flush-left equations.
11317 \begin_layout Subsection
11318 Supported Environments
11321 \begin_layout Standard
11322 Most of the environments commonly supported in other classes are also supported
11328 There are several additional environments provided by
11330 Foil\SpecialChar TeX
11333 as well as a couple added by \SpecialChar LyX
11335 The following environments are shared with other classes:
11338 \begin_layout Standard
11339 \begin_inset Flex Multiple Columns
11342 \begin_layout Itemize
11348 \begin_layout Itemize
11354 \begin_layout Itemize
11360 \begin_layout Itemize
11366 \begin_layout Itemize
11372 \begin_layout Itemize
11379 \begin_layout Itemize
11385 \begin_layout Itemize
11391 \begin_layout Itemize
11397 \begin_layout Itemize
11403 \begin_layout Itemize
11409 \begin_layout Itemize
11415 \begin_layout Itemize
11421 \begin_layout Itemize
11427 \begin_layout Itemize
11438 \begin_layout Standard
11439 That is, all the major environments apart from the sectioning environments.
11440 Since foils are essentially self-contained sections, with a title and body,
11443 Foil\SpecialChar TeX
11446 provides specific commands for starting new foils and these are:
11449 \begin_layout Itemize
11455 \begin_layout Itemize
11461 \begin_layout Standard
11463 also provides slightly modified versions of these two environments called:
11466 \begin_layout Itemize
11472 \begin_layout Itemize
11475 ShortRotatefoilhead
11478 \begin_layout Standard
11479 and the differences will be explained in the next section.
11482 \begin_layout Standard
11483 Since foils are often used in presenting ideas or new theorems and such
11486 Foil\SpecialChar TeX
11489 also provides a comprehensive box of goodies for presenting them:
11492 \begin_layout Standard
11493 \begin_inset Flex Multiple Columns
11496 \begin_layout Itemize
11502 \begin_layout Itemize
11508 \begin_layout Itemize
11514 \begin_layout Itemize
11520 \begin_layout Itemize
11526 \begin_layout Itemize
11532 \begin_layout Itemize
11538 \begin_layout Itemize
11544 \begin_layout Itemize
11550 \begin_layout Itemize
11556 \begin_layout Itemize
11567 \begin_layout Standard
11568 The starred versions are unnumbered while the unstarred versions are numbered.
11569 There are also two list environments added by \SpecialChar LyX
11573 \begin_layout Itemize
11579 \begin_layout Itemize
11585 \begin_layout Standard
11588 Foil\SpecialChar TeX
11591 provides some powerful header and footer capabilities that are best set
11592 in the preamble although they may be set at any point in a document.
11593 If you want to change these settings in your document the best place to
11594 do so is at the very top of a foil, i.
11595 \begin_inset space \thinspace{}
11601 \begin_inset space \space{}
11606 straight after the foilhead.
11609 \begin_layout Standard
11610 For this purpose, the following command styles are provided [
11617 \begin_layout Standard
11618 \begin_inset Flex Multiple Columns
11621 \begin_layout Itemize
11625 \begin_inset space ~
11631 \begin_layout Itemize
11637 \begin_layout Itemize
11641 \begin_inset space ~
11647 \begin_layout Itemize
11651 \begin_inset space ~
11657 \begin_layout Itemize
11661 \begin_inset space ~
11668 \begin_layout Plain Layout
11669 \begin_inset space ~
11681 \begin_layout Standard
11682 There are also a few commands provided by
11684 Foil\SpecialChar TeX
11687 that aren't directly supported by \SpecialChar LyX
11688 but I'll tell you what they do and how
11689 to use them in section
11690 \begin_inset space ~
11694 \begin_inset CommandInset ref
11696 reference "sec:unsuppfoils"
11703 \begin_layout Subsection
11704 Building a Set of Foils
11707 \begin_layout Standard
11708 This section will give a simple introduction to using the different environments
11709 to build a set of foils.
11710 If you want to see an example set of foils, take a look at the
11714 file you find in \SpecialChar LyX
11722 \begin_layout Subsubsection
11723 Give It a Title Page
11726 \begin_layout Standard
11727 Unlike other classes that provide
11747 creates the title on a page of its own.
11748 If you leave out the
11752 environment \SpecialChar LaTeX
11753 will substitute the current date (every time you regenerate
11757 \begin_layout Subsubsection
11761 \begin_layout Standard
11762 As I mentioned earlier, there are four ways of starting a new foil.
11763 For portrait foils you should use
11772 The difference between these two environments is the amount of space between
11773 the title of the foil (the foilhead) and the body of the foil.
11776 \begin_layout Standard
11777 Landscape foils are generated using the
11783 ShortRotatefoilhead
11786 Again the only difference is the spacing between foilhead and body.
11787 Both of the short versions have 0.5
11788 \begin_inset space ~
11791 inches less separation between the foilhead and the body.
11795 \begin_layout Standard
11796 One problem with the support for landscape foils is the requirement that
11797 you have to use the
11801 driver to generate the PostScript output otherwise the foils won't be rotated.
11802 It is possible to get landscape foils even if you haven't got the
11806 driver provided you can feed your foils sideways through your printer ;-)
11809 \begin_layout Subsubsection
11810 Theorems, Lemmas, Proofs and more
11813 \begin_layout Standard
11814 You can't have two of the same type of these environments directly following
11816 If you use a normal paragraph break, , you will just be extending the previous
11817 environment as if you had merged the two environments together.
11818 Rather than that, you need to insert a so-called separator.
11819 Please refer to the section entitled
11830 \begin_layout Subsubsection
11834 \begin_layout Standard
11835 You get all the commonly supported list styles found in other classes as
11836 well as two new ones.
11837 I'll only describe the new ones here.
11838 If you want to find out more about the other list environments check out
11844 If you intend to use itemized lists you might also want to read about the
11848 \begin_inset space ~
11852 \begin_inset space ~
11857 dialog described above in section
11858 \begin_inset space ~
11862 \begin_inset CommandInset ref
11864 reference "sec:bullet"
11871 \begin_layout Standard
11872 The two new list styles,
11880 , are designed to make it easier for you to create lists of do's and don'ts
11881 or right and wrong by providing dedicated environments that use a tick
11882 or a cross as the label of the list.
11883 These lists are in fact dedicated variants of the
11888 They do however require that you have the
11892 packages installed.
11895 \begin_layout Subsubsection
11899 \begin_layout Standard
11902 Foil\SpecialChar TeX
11905 redefines the floating tables and figures so that they appear exactly where
11906 they are in the text rather than pushing them to the top of the page or
11907 to some user specified location.
11908 In fact if you change the float placement settings they are simply ignored.
11911 \begin_layout Subsubsection
11912 Page Headers and Footers
11913 \begin_inset CommandInset label
11915 name "sec:foilfoot"
11922 \begin_layout Standard
11926 \begin_inset space ~
11935 are two commands used to control the left-footer text string.
11936 The first is meant to allow you to include a graphic logo on your foils
11938 \begin_inset Quotes eld
11943 Foil\SpecialChar TeX
11947 \begin_inset Quotes erd
11951 While the second is meant to provide a classification for the audience,
11955 \begin_inset space \thinspace{}
11961 \begin_inset space \space{}
11965 It is empty by default.
11968 \begin_layout Standard
11969 The remaining page corners can be filled by
11972 \begin_inset space ~
11977 (which defaults to page numbers),
11980 \begin_inset space ~
11988 \begin_inset space ~
11996 \begin_layout Subsection
11999 Foil\SpecialChar TeX
12003 \begin_inset CommandInset label
12005 name "sec:unsuppfoils"
12012 \begin_layout Standard
12013 All the commands mentioned below need to be set in a
12023 within another environment.
12026 \begin_layout Subsubsection
12030 \begin_layout Standard
12031 All lengths are adjusted using the
12054 should be replaced by the name given to the length you want to change and
12059 is the length value.
12060 All lengths should be specified in units of length such as inches (
12072 ) or relative to some document or font-based length such as
12082 \begin_layout Standard
12083 It's possible to change the spacing between a foilhead and the body of the
12084 foil by adjusting the length specified by
12091 For example, to make
12096 \begin_inset space \space{}
12099 in closer to their bodies put the following in the preamble:
12105 foilheadskip}{-0.5in}
12108 \begin_layout Standard
12109 The spacings around floats can be adjusted by setting these lengths:
12112 \begin_layout Labeling
12113 \labelwidthstring MMMMMMMMMMM
12120 Separation between the text and the top of the float
12123 \begin_layout Labeling
12124 \labelwidthstring MMMMMMMMMMM
12131 Separation between the float and the caption
12134 \begin_layout Labeling
12135 \labelwidthstring MMMMMMMMMMM
12142 Separation between the caption and the following text
12145 \begin_layout Labeling
12146 \labelwidthstring MMMMMMMMMMM
12153 You can make the captions narrower than the surrounding text by adjusting
12155 Best done relative to
12164 \begin_layout Standard
12165 There are also several title page related lengths that you may find useful
12166 if you have a long title or several authors:
12169 \begin_layout Labeling
12170 \labelwidthstring MMMMMMMMMMM
12177 Separation from headers to
12182 \begin_layout Labeling
12183 \labelwidthstring MMMMMMMMMMM
12201 \begin_layout Labeling
12202 \labelwidthstring MMMMMMMMMMM
12216 \begin_layout Labeling
12217 \labelwidthstring MMMMMMMMMMM
12233 \begin_layout Labeling
12234 \labelwidthstring MMMMMMMMMMM
12250 \begin_layout Standard
12251 The last length related command affects all the list environments.
12262 a list environment then all the vertical spacing between the list items
12264 Note that this is a command not a length so it doesn't require
12270 like the stuff mentioned above.
12273 \begin_layout Subsubsection
12274 Headers and Footers
12277 \begin_layout Standard
12290 commands control whether the logo in the
12294 definition appear on a given page.
12301 in the preamble then none of the foils will have the logo on them.
12302 If you don't want the logo on a particular page place the
12308 directly after the foilhead of that page and the
12314 directly after the next foilhead.
12317 \begin_layout Standard
12318 If you decide to use the
12322 page style setting in the
12325 \begin_inset space ~
12330 dialog you should probably add
12340 to your preamble so headers and footers on landscape pages are correctly
12341 placed when rotated.
12342 This is due to some clashes between the page layouts provided by the
12353 \begin_layout Section
12354 Hollywood (Hollywood spec scripts)
12357 \begin_layout Standard
12363 \begin_layout Subsection
12367 \begin_layout Standard
12368 Getting the format of a Hollywood script right is a
12369 \begin_inset Quotes eld
12373 \begin_inset Quotes erd
12376 It is designed to make the readers focus on content and to be easy and
12377 familiar for the actors to read.
12378 Each page of a script should be one minute of film.
12379 Nothing goes in a script that you cannot see or hear on screen.
12380 The courier 12 pt font should be used throughout.
12384 \begin_layout Subsection
12388 \begin_layout Standard
12389 Speakers' lines should NEVER break in mid-sentence.
12390 If a speaker's lines continue over a page break, repeat the
12394 title followed by (Cont'd).
12397 \begin_layout Subsection
12401 \begin_layout Standard
12406 names as labels then cross-reference the label to insert the name.
12407 The cross-reference dialog will show the current cast of characters.
12408 You can use this to insert the speaker name in narratives also.
12411 \begin_layout Subsection
12412 Paper size and Margins
12415 \begin_layout Standard
12416 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12419 \begin_layout Subsection
12423 \begin_layout Standard
12424 The following environments are available.
12425 You can use hollywood.bind to get the bind keys shown at the right.
12428 \begin_layout Itemize
12432 \begin_inset Newline newline
12437 Used where nothing else works.
12441 \begin_layout Itemize
12447 \begin_inset space \hfill{}
12455 \begin_inset Newline newline
12458 Usually followed by something like
12459 \begin_inset Quotes eld
12462 on Sally waking up.
12463 \begin_inset Quotes erd
12469 \begin_layout Itemize
12473 \begin_inset space \hfill{}
12477 \begin_inset Newline newline
12482 Introduces a new INTERIOR camera set-up.
12483 Always followed by DAY or NIGHT, or something similar to define the lighting
12485 Everthing on this line in CAPS.
12488 \begin_layout Itemize
12492 \begin_inset space \hfill{}
12496 \begin_inset Newline newline
12501 Introduces a new EXTERIOR camera set-up.
12502 Everthing on this line in CAPS.
12505 \begin_layout Itemize
12509 \begin_inset space \hfill{}
12513 \begin_inset Newline newline
12518 The character speaking.
12521 \begin_layout Itemize
12525 \begin_inset space \hfill{}
12529 \begin_inset Newline newline
12534 Instructions to the speaker.
12535 The () are automatically inserted.
12538 \begin_layout Itemize
12542 \begin_inset space \hfill{}
12546 \begin_inset Newline newline
12558 \begin_layout Itemize
12562 \begin_inset space \hfill{}
12566 \begin_inset Newline newline
12571 Camera movement instruction.
12573 \begin_inset space \thinspace{}
12577 \begin_inset space \space{}
12583 \begin_layout Itemize
12587 \begin_inset space \hfill{}
12593 \begin_layout Itemize
12597 \begin_inset space \hfill{}
12603 \begin_layout Itemize
12607 \begin_inset space \hfill{}
12613 \begin_layout Itemize
12617 \begin_inset space \hfill{}
12623 \begin_layout Subsection
12627 \begin_layout Itemize
12631 \begin_layout Itemize
12635 \begin_layout Itemize
12637 \begin_inset space \thinspace{}
12644 \begin_layout Itemize
12649 \begin_layout Itemize
12650 PAN — camera movement
12653 \begin_layout Itemize
12654 INSERT — cut to close-up of
12657 \begin_layout Section
12661 \begin_layout Standard
12664 Panayotis Papasotiriou
12667 \begin_layout Subsection
12671 \begin_layout Standard
12672 The ijmpc package is a set of macros that facilitates electronic manuscript
12675 International Journal of Modern Physics C
12678 Similarly, the ijmpd package is for creating manuscripts to be submitted
12681 International Journal of Modern Physics D
12684 Both journals are published by World Scientific.
12685 The corresponding document classes are named
12694 These files, together with instructions for the authors, can be downloaded
12696 \begin_inset Flex URL
12699 \begin_layout Plain Layout
12701 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12707 \begin_inset Flex URL
12710 \begin_layout Plain Layout
12712 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12718 Both packages are modified versions of the standard
12719 \begin_inset Quotes eld
12723 \begin_inset Quotes erd
12726 package, and they are almost (but not exactly) identical.
12727 Most of their features are supported by \SpecialChar LyX
12729 I have used \SpecialChar LyX
12730 successfully to write articles submitted to both journals
12731 without any problem.
12734 \begin_layout Subsection
12738 \begin_layout Standard
12739 As usual, the easiest way to write a paper is to start with a template.
12742 File\SpecialChar menuseparator
12758 This will give an (almost) empty document that includes the most common
12759 fields found in a manuscript.
12760 Simply overwrite the existing text (including the brackets,
12765 You should keep in mind the following remarks.
12768 \begin_layout Enumerate
12770 won't let you change the font size and the page style of the document,
12771 because such modifications are not allowed by both packages.
12774 \begin_layout Enumerate
12775 The language of the document should not be changed.
12776 Before previewing your paper, be sure that the babel package is not used.
12777 To do this, click on
12780 arg "dialog-show document"
12785 \SpecialChar menuseparator
12789 \begin_inset Quotes eld
12793 \begin_inset Quotes erd
12803 \begin_layout Enumerate
12805 \begin_inset Quotes eld
12809 \begin_inset Quotes erd
12812 style must be used to define keywords.
12815 \begin_layout Enumerate
12816 The ijmpc package provides a style named
12817 \begin_inset Quotes eld
12820 Classification Codes
12821 \begin_inset Quotes erd
12824 , which can be used to define classification codes, such as PACS numbers.
12825 Note that this facility is not supported by the ijmpd package.
12828 \begin_layout Enumerate
12829 Several new environments are available:
12830 \begin_inset Quotes eld
12834 \begin_inset Quotes erd
12838 \begin_inset Quotes eld
12842 \begin_inset Quotes erd
12846 \begin_inset Quotes eld
12850 \begin_inset Quotes erd
12854 \begin_inset Quotes eld
12858 \begin_inset Quotes erd
12862 \begin_inset Quotes eld
12866 \begin_inset Quotes erd
12870 \begin_inset Quotes eld
12874 \begin_inset Quotes erd
12878 \begin_inset Quotes eld
12882 \begin_inset Quotes erd
12886 \begin_inset Quotes eld
12890 \begin_inset Quotes erd
12894 \begin_inset Quotes eld
12898 \begin_inset Quotes erd
12902 \begin_inset Quotes eld
12906 \begin_inset Quotes erd
12910 \begin_inset Quotes eld
12914 \begin_inset Quotes erd
12918 \begin_inset Quotes eld
12922 \begin_inset Quotes erd
12926 \begin_inset Quotes eld
12930 \begin_inset Quotes erd
12934 \begin_inset Quotes eld
12938 \begin_inset Quotes erd
12942 Their use is more or less obvious.
12944 supports all these environments; it will use the proper label, text style,
12945 and numbering scheme for each of them.
12948 \begin_layout Enumerate
12949 Both packages use basic citations; the natbib package should not be used.
12950 In \SpecialChar LyX
12951 , citation references are shown as usual; in the output, citations are
12952 shown as superscripts.
12953 If you want to use a citation as normal text, you should use the
12958 \begin_inset space \thinspace{}
12962 \begin_inset space \space{}
12966 \begin_inset Quotes eld
12970 \begin_inset space \space{}
12980 \begin_inset Quotes erd
12986 \begin_layout Enumerate
12988 \begin_inset Quotes eld
12992 \begin_inset Quotes erd
12995 section in both packages.
12996 To put acknowledgments, just use the
12997 \begin_inset Quotes eld
13001 \begin_inset Quotes erd
13007 \begin_layout Enumerate
13008 Appendices may be added to the paper,
13012 the Acknowledgments and
13018 provides a special environment, called
13019 \begin_inset Quotes eld
13023 \begin_inset Quotes erd
13026 which marks the beginning of the appendices.
13027 This environment should be left blank; it just sends a \SpecialChar LaTeX
13028 command, but nothing
13030 In \SpecialChar LyX
13032 \begin_inset Quotes eld
13036 \begin_inset Quotes erd
13039 is printed with blue letters, as a signal that all sections after that
13040 point are appendices.
13041 To write an appendix, use the
13042 \begin_inset Quotes eld
13046 \begin_inset Quotes erd
13051 will number each appendix with capital letters, as required by both journals.
13053 \begin_inset Quotes eld
13057 \begin_inset Quotes erd
13064 be present before the first appendix; if not, all appendices will be numbered
13065 as normal sections in the output.
13068 \begin_layout Enumerate
13069 The ijmpc and the ijmpd packages use the
13073 command to implement table captions.
13074 As a result, a table created by \SpecialChar LyX
13075 is printed correctly, but its caption
13077 However, you can use some \SpecialChar TeX
13078 code to overcome this problem, so that captions
13079 are printed as expected.
13080 To do so, create a float table as usual, remove the caption, and replace
13081 it with the \SpecialChar TeX
13092 (sic); you must also the \SpecialChar TeX
13097 immediately after the tabular material.
13098 Study the example table included in the template files to see how this
13099 trick is implemented.
13100 Alternatively, If you need table captions, you should implement the whole
13105 file, then include this file to the \SpecialChar LyX
13108 Insert\SpecialChar menuseparator
13109 File\SpecialChar menuseparator
13111 \begin_inset space ~
13117 Details on how to create a table float can be found in the files
13125 , included in the corresponding packages.
13128 \begin_layout Subsection
13129 Preparing a paper for submission
13132 \begin_layout Standard
13133 Before you submit your paper you must export the \SpecialChar LyX
13134 document as a \SpecialChar LaTeX
13137 File\SpecialChar menuseparator
13138 Export\SpecialChar menuseparator
13146 \begin_layout Plain Layout
13147 Actually you have the choice between \SpecialChar LaTeX
13148 (plain) and pdflatex.
13149 If you intend to use pdflatex to prepare the paper, you should use the
13150 pdflatex option so that included graphics are converted to PDF format,
13151 ready for use by pdflatex.
13156 , then make the following changes to the resulting
13163 \begin_layout Enumerate
13164 Remove the comment lines before the
13173 \begin_layout Enumerate
13174 Remove everything between (and including) the
13186 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13190 \begin_layout Standard
13195 file should be saved and processed through \SpecialChar LaTeX
13196 as many times as necessary.
13197 You may also want to check the resulting
13204 \begin_layout Section
13208 \begin_layout Standard
13214 \begin_layout Subsection
13218 \begin_layout Standard
13219 The iopart package provides a document class to create electronic manuscript
13220 submission to the journals published by the Institute of Physics.
13221 Instructions for the authors how to create a paper using the iopart class
13222 can be downloaded together with the iopart package from the site
13223 \begin_inset Flex URL
13226 \begin_layout Plain Layout
13228 ftp://ftp.iop.org/pub/journals/latex2e
13236 \begin_layout Subsection
13240 \begin_layout Standard
13241 The easiest way to write a paper is to start with the template
13245 that is available via
13247 File\SpecialChar menuseparator
13250 The template explains how to use the special text environments.
13251 Here are the most important advices:
13254 \begin_layout Itemize
13255 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13256 no AMS packages are loaded in
13258 Document\SpecialChar menuseparator
13259 Settings\SpecialChar menuseparator
13265 \begin_layout Itemize
13268 The title environment defines the kind of your paper.
13269 So use one of the following environments for the title:
13273 \begin_layout Itemize
13282 \begin_layout Itemize
13291 \begin_layout Itemize
13297 for a Topical review
13300 \begin_layout Itemize
13309 \begin_layout Itemize
13318 \begin_layout Itemize
13324 for a Paper (same as Title)
13327 \begin_layout Itemize
13333 for a Preliminary communication
13336 \begin_layout Itemize
13342 for a Rapid communication
13345 \begin_layout Itemize
13351 for a Letter to the editor
13355 \begin_layout Itemize
13358 All title environments except of
13362 can have an optional short title.
13365 \begin_layout Itemize
13366 There is a general title environment
13370 which is not directly supported by \SpecialChar LyX
13372 This can be used as \SpecialChar TeX
13373 code when your document doesn't fit into one of the
13377 \begin_layout Standard
13378 For more informations like hints for special table and formula formatting,
13379 look at the IOP author guidelines.
13382 \begin_layout Section
13386 \begin_layout Standard
13389 Panayotis Papasotiriou
13392 \begin_layout Subsection
13396 \begin_layout Standard
13397 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13398 that facilitates electronic manuscript submission to the journals they
13400 Most known of them (at least in my domain of interest) are
13402 Astrophysics and Space Science
13408 , but there are many others (see a complete list at
13409 \begin_inset Flex URL
13412 \begin_layout Plain Layout
13414 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13420 The Kluwer package may be downloaded from the site
13421 \begin_inset Flex URL
13424 \begin_layout Plain Layout
13426 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13432 A complete user guide is contained in that package (but it can also be
13433 downloaded separately).
13436 \begin_layout Standard
13438 supports many features of the package but not everything.
13439 However, the \SpecialChar TeX
13440 code needed is reduced to some
13441 \begin_inset Quotes eld
13445 \begin_inset Quotes erd
13448 commands of the package (see
13449 \begin_inset space ~
13453 \begin_inset CommandInset ref
13455 reference "subsec:kluwer_peculiarities"
13460 I have recently used \SpecialChar LyX
13461 to write an article submitted to the
13463 Astrophysics and Space Science
13465 without any problem.
13468 \begin_layout Subsection
13472 \begin_layout Standard
13473 The easiest way to write a paper is to start with the Kluwer template file.
13476 File\SpecialChar menuseparator
13488 This will give an (almost) empty document that includes the most common
13489 fields found in a manuscript and a short description of their use.
13490 As in most templates, simply overwrite the existing text (including the
13495 ) with the correct information.
13498 \begin_layout Subsection
13499 Preparing a paper for submission
13502 \begin_layout Standard
13503 As in the AAS\SpecialChar TeX
13504 package, before you submit your paper to a journal you must
13506 \begin_inset Quotes eld
13510 \begin_inset Quotes erd
13516 \begin_layout Enumerate
13517 Export your paper as a \SpecialChar LaTeX
13519 To do this, click on
13521 File\SpecialChar menuseparator
13522 Export\SpecialChar menuseparator
13530 \begin_layout Enumerate
13535 file with a text editor and make the following changes
13539 \begin_layout Enumerate
13540 remove the comment lines before the
13549 \begin_layout Enumerate
13550 remove everything between (and including) the
13562 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13566 \begin_layout Standard
13575 \begin_layout Enumerate
13580 file through \SpecialChar LaTeX
13581 as many times as necessary (usually up to three).
13584 \begin_layout Enumerate
13590 \begin_inset space \thinspace{}
13594 \begin_inset space \space{}
13601 , and check if everything is OK (it should, if you didn't make any mistake).
13604 \begin_layout Subsection
13605 \begin_inset Quotes eld
13609 \begin_inset Quotes erd
13612 of the Kluwer package
13613 \begin_inset CommandInset label
13615 name "subsec:kluwer_peculiarities"
13622 \begin_layout Standard
13623 The Kluwer package has the following
13624 \begin_inset Quotes eld
13628 \begin_inset Quotes erd
13634 \begin_layout Enumerate
13635 It is possible to write multiple articles in the same \SpecialChar LaTeX
13640 \begin_layout Plain Layout
13641 I can't imagine any good reason to do this.
13647 Each article must be included in the environment
13648 \begin_inset Quotes eld
13652 \begin_inset Quotes erd
13656 Unfortunately, this environment cannot be omitted, even if you write just
13658 Therefore, each article starts with the command
13664 and, obviously, ends with the command
13671 Although this can be implemented in \SpecialChar LyX
13672 , I didn't included it, since it looks
13673 ugly and can confuse the novice user.
13674 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13677 \begin_inset Quotes eld
13682 \begin_inset Quotes erd
13688 \begin_layout Enumerate
13689 Information given at the beginning of the article (i.
13690 \begin_inset space \thinspace{}
13694 \begin_inset space \space{}
13697 title, subtitle, author, institution, running title, running author, abstract
13698 and keywords) must be included in an environment called
13699 \begin_inset Quotes eld
13703 \begin_inset Quotes erd
13707 This is not implemented in \SpecialChar LyX
13708 , so you must enter title, subtitle etc.
13709 \begin_inset space ~
13712 between two \SpecialChar TeX
13728 \begin_layout Enumerate
13729 According to the user manual, the label of each bibliography item must be
13753 \begin_layout Standard
13758 template takes care of all these
13759 \begin_inset Quotes eld
13763 \begin_inset Quotes erd
13767 If you start a new paper using this template you don't need to do anything
13772 \begin_layout Enumerate
13773 don't delete the \SpecialChar TeX
13774 code included in the template, and
13777 \begin_layout Enumerate
13778 copy the example bibliography item included in the template and modify it
13779 as necessary to enter new bibliography items.
13782 \begin_layout Section
13786 \begin_layout Standard
13792 \begin_layout Subsection
13796 \begin_layout Standard
13797 The \SpecialChar LyX
13800 article (koma-script)
13804 report (koma-script)
13822 correspond to the \SpecialChar LaTeX
13840 \begin_inset space ~
13843 of the Koma-Script family.
13844 They are replacements for the standard document classes
13860 , resp., and fit better to European typography conventions in a number of
13864 \begin_layout Itemize
13865 Standard character size is 11pt in
13867 article (koma-script)
13871 report (koma-script)
13879 letter (koma-script)
13884 \begin_layout Itemize
13885 Headings, labels of the description environment, and a number of elements
13888 letter (koma-script)
13890 document class are set in a bold sans serif font.
13894 \begin_layout Plain Layout
13895 There is a big difference between the bold sans serif old cm fonts and new
13896 ec fonts, especially in the appearance of headings.
13897 In comparison, the ec bold sans serif fonts look a bit thin.
13898 Here the \SpecialChar LaTeX
13907 helps to produce the
13908 \begin_inset Quotes eld
13912 \begin_inset Quotes erd
13915 appearance when using the ec fonts.
13920 The numbering of chapter headings is made in the same way as the numbering
13921 of section headings, that is without the extra line
13922 \begin_inset Quotes eld
13925 Chapter\SpecialChar ldots
13927 \begin_inset Quotes erd
13931 In addition, the appearance of the headings can be modified by using a
13932 number of options (in \SpecialChar LyX
13933 to be entered in the field
13936 \begin_inset space ~
13943 Layout\SpecialChar menuseparator
13950 \begin_layout Itemize
13951 The main means in the Koma-Script document classes to design the type area
13960 (in \SpecialChar LyX
13961 to be entered in the extra class options field in the dialog
13963 Document\SpecialChar menuseparator
13967 They make a clearer modification of page margins possible as do the options
13970 Document\SpecialChar menuseparator
13977 \begin_layout Itemize
13978 The \SpecialChar LaTeX
13979 document classes of the Koma-Script family define a number of additional
13981 Those part of it which makes sense in \SpecialChar LyX
13982 is implemented in corresponding
13986 \begin_layout Standard
13987 Detailed descriptions of the \SpecialChar LaTeX
13988 document classes of the Koma-Script family
13989 can be found in the Koma-Script documentation
14000 \begin_layout Subsection
14001 article (koma-script), report (koma-script), and book (koma-script)
14004 \begin_layout Standard
14005 The document classes
14007 article (koma-script)
14011 report (koma-script)
14021 are implemented in the layout files
14034 They contain all the paragraph types of the corresponding standard document
14047 , resp., partly modified, with the exception of the \SpecialChar LyX
14052 -type, which is replaced by the new
14056 -type having the same functionality.
14061 -Type there is a number of new paragraph types added.
14068 letter (koma-script)
14073 \begin_layout Itemize
14082 : are equivalents to
14090 , resp., additionally inserting an entry in the table of contents.
14099 are not contained in
14101 article (koma-script)
14106 \begin_layout Itemize
14115 : behave exactly as
14123 , resp., additionally clearing running heads.
14128 is not contained in
14130 article (koma-script)
14136 \begin_layout Plain Layout
14149 report (koma-script)
14151 , but since this is identical to
14155 , is has not been implemented in \SpecialChar LyX
14164 \begin_layout Itemize
14169 : generates a heading directly above the following paragraph in the standard
14170 character size without affecting the structure of the document.
14173 \begin_layout Itemize
14182 are special captions which respect the different space settings needed
14183 for captions placed above or below an element (if you follow strict typographic
14184 rules, you might want to place table captions always above the table).
14185 You can also use the class option
14189 , which will switch
14202 You need at least Koma-Script version 2.8q to use this.
14205 \begin_layout Itemize
14210 : can be used to set a bonmot, e.
14211 \begin_inset space \thinspace{}
14215 \begin_inset space \space{}
14218 at the beginning of a chapter.
14219 If you use the optional argument (
14221 Insert\SpecialChar menuseparator
14223 \begin_inset space ~
14228 ), you can insert the dictum's author there.
14229 Dictum and author are separated by a line.
14230 You need at least Koma-Script version 2.8q to use this.
14235 is not contained in
14237 article (koma-script)
14242 \begin_layout Standard
14243 The following types, together with the standard types
14255 , form the title area of the document.
14256 They must be entered ahead of the first
14257 \begin_inset Quotes eld
14261 \begin_inset Quotes erd
14268 \begin_layout Plain Layout
14269 The corresponding \SpecialChar LaTeX
14270 commands must appear before the
14281 When such a type is used more than once, the latter usage overwrites the
14282 former one, that means, for every type only the latest usage is valid.
14283 The order of the different types however has, like
14295 , no effect on the appearance of the produced document.
14298 \begin_layout Itemize
14303 : produces a centered paragraph above the ordinary title (
14315 ) for the subject of the document.
14318 \begin_layout Itemize
14323 : produces a centered paragraph below the ordinary title (
14335 ) for the publishers' name.
14338 \begin_layout Itemize
14345 report (koma-script)
14351 produces a centered paragraph on its own page behind the title page, or
14354 article (koma-script)
14356 produces a centered paragraph below the ordinary title (
14372 ) for a dedication.
14375 \begin_layout Itemize
14380 : produces a left aligned paragraph above the ordinary title (
14396 ) for a document`s head.
14399 \begin_layout Itemize
14404 : produces in a double-sided print in
14406 report (koma-script)
14412 a left-aligned paragraph at the top of the title page`s back or has no
14413 effect in a single-sided print or in
14415 article (koma-script)
14420 \begin_layout Itemize
14425 : produces in a double-sided print in
14427 report (koma-script)
14433 a left-aligned paragraph at the bottom of the title page`s back or has
14434 no effect in a single-sided print or in
14436 article (koma-script)
14441 \begin_layout Itemize
14446 : produces a special
14447 \begin_inset Quotes eld
14451 \begin_inset Quotes erd
14454 page ahead of the actual document containing a paragraph without special
14458 \begin_layout Standard
14459 The layout files for the document classes
14461 article (koma-script)
14465 report (koma-script)
14471 do include the file
14476 This is thought of as a place to define your own types.
14481 in your personal layout directory and edit the file!
14484 \begin_layout Subsection
14485 letter (koma-script)
14488 \begin_layout Description
14489 Note: This section discusses the obsolete
14491 KOMA-Script-Letter (v.
14492 \begin_inset space ~
14497 , which is not even included anymore in recent KOMA releases.
14498 Please refer to the next section for the current KOMA-Script-Letter class
14500 \begin_inset space ~
14506 \begin_layout Standard
14510 letter (koma-script)
14512 is implemented in the layout file
14517 It contains all the paragraph types of the corresponding standard document
14522 , partly modified, with the exception of the \SpecialChar LyX
14536 type, which is replaced by the new
14541 In addition, it contains, in contrast to the standard document class, the
14560 Furthermore, there are a number of new letter specific types.
14563 \begin_layout Standard
14564 The appearance of the letter produced by this document class can be controlled
14565 by a number of \SpecialChar LaTeX
14566 commands, which you can put in the \SpecialChar LaTeX
14571 \begin_layout Plain Layout
14572 For example, the standard appearance of the letter`s heading, consisting
14573 of name and address, is quite self-willed.
14575 \begin_inset Quotes eld
14579 \begin_inset Quotes erd
14582 heading is produced by the following \SpecialChar LaTeX
14583 commands in the preamble:
14586 \begin_layout LyX-Code
14596 \begin_layout LyX-Code
14612 \begin_layout LyX-Code
14622 \begin_layout LyX-Code
14642 A detailed German description of such \SpecialChar LaTeX
14643 commands can be found in the Koma-Script
14649 With it, the letter's author can produce his personal letter layout.
14652 \begin_layout Standard
14661 define the beginning of the letter and must be used in every letter.
14662 To emphasize them in the \SpecialChar LyX
14663 document class, they are marked with the letter
14673 \begin_inset space ~
14676 in the left margin.
14677 It is possible to write any number of letters in one file.
14682 type produces a new letter using the same addressee and a
14686 type produces a new addressee.
14703 are ordinary paragraph types and can also be used several times in one
14704 and the same letter.
14707 \begin_layout Itemize
14712 : produces a paragraph for the addressee and implicitly defines the beginning
14716 \begin_layout Itemize
14721 : produces a paragraph for the form of address and implicitly produces a
14725 \begin_layout Itemize
14730 : produces a paragraph for a close.
14733 \begin_layout Itemize
14738 : produces a paragraph for a postscript.
14741 \begin_layout Itemize
14746 : produces a paragraph for a distribution list.
14749 \begin_layout Itemize
14754 : produces a paragraph for enclosures.
14757 \begin_layout Standard
14798 are input types provided with a label to enter information, which will
14799 be processed by the document class.
14803 \begin_layout Plain Layout
14804 It could be seen as a matter of inconsequence, that the types
14812 described above are not such input types as well.
14813 Because of the special meaning of those types, however, I have implemented
14814 them as ordinary paragraph types with a one letter mark in the left margin.
14815 Moreover, it would affect my feeling of symmetry, if the
14823 type had such a serious different appearance.
14828 The types must be used ahead of the corresponding
14835 \begin_layout Standard
14836 An implementation of these types in a WYSIWYG fashion does not seem to make
14837 sense, because the real appearance of the produced letter does not only
14838 depend on the usage of the particular type, but also on other factors.
14839 For example, a signature entered in the
14843 type will in the standard behavior appear in the produced letter only,
14844 when in the same letter also a
14849 The entered value of the
14853 type will in the standard behavior not appear in the produced letter at
14855 The possibility to design the letter`s heading freely is already indicated
14856 in a footnote above.
14859 \begin_layout Standard
14860 The input types can also be used as empty paragraphs.
14861 This makes sense e.
14862 \begin_inset space \thinspace{}
14866 \begin_inset space \space{}
14878 type is not used at all, in the standard behavior the value of the
14882 type is used as signature, whereas if an empty
14886 type is used, no signature value is defined.
14889 \begin_layout Standard
14890 By using the input types it is possible to write a letter template, containing
14891 filled input types with your personal dates (name, address, etc.) and empty
14892 input types for other dates you want to enter.
14895 \begin_layout Itemize
14900 : sender's name, in the standard behavior appears as a centered paragraph
14901 in small caps in the letter`s heading.
14904 \begin_layout Itemize
14909 : sender's signature, in the standard behavior appears below the
14918 type is used, the value of the
14922 type appears instead.
14925 \begin_layout Itemize
14930 : sender's address, in the standard behavior appears in a centered paragraph
14931 in the letter`s heading below the sender's name.
14934 \begin_layout Itemize
14939 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
14950 \begin_layout Itemize
14955 : place of the letter`s making.
14958 \begin_layout Itemize
14963 : date of the letter`s making.
14972 , in the standard behavior, produce the place and the date in a right-aligned
14973 line below the addressee's field.
14978 type is used, neither place nor date appear, independent of the value of
14988 type is used, the date of the letter `s production is used.
14991 \begin_layout Itemize
14996 : sender`s back address, in the standard behavior appears above the addressee's
14997 field in a small sans serif font.
15000 \begin_layout Itemize
15005 : special mail information, in the standard behavior appears underlined
15006 above the addressee's field below the back address.
15009 \begin_layout Itemize
15014 : additional information, in the standard behavior appears on right side
15015 below the addressee`s field.
15018 \begin_layout Itemize
15023 : the letter's title, in the standard behavior appears in a big, bold, sans
15024 serif font above the subject.
15027 \begin_layout Itemize
15032 : the letter's subject, in the standard behavior appears in a bold font
15040 \begin_layout Standard
15061 produce a business letter like line above the
15065 line containing the fields
15066 \begin_inset Quotes eld
15070 \begin_inset Quotes erd
15074 \begin_inset Quotes eld
15078 \begin_inset Quotes erd
15082 \begin_inset Quotes eld
15086 \begin_inset Quotes erd
15090 \begin_inset Quotes eld
15094 \begin_inset Quotes erd
15098 \begin_inset Quotes eld
15102 \begin_inset Quotes erd
15106 \begin_inset Quotes eld
15110 \begin_inset Quotes erd
15114 For the date field, the value of the
15120 \begin_inset Quotes eld
15123 business letter types
15124 \begin_inset Quotes erd
15127 is used, the value of the
15131 type however does not appear, but only the \SpecialChar LaTeX
15139 The ordinary output of place and date in a right-aligned line below the
15140 addressee`s field is suppressed.
15141 The types are implemented as input types provided with a label and must
15142 be used ahead of the corresponding
15149 \begin_layout Itemize
15157 \begin_layout Itemize
15165 \begin_layout Itemize
15173 \begin_layout Itemize
15181 \begin_layout Itemize
15189 \begin_layout Subsection
15190 The new letter class: letter (koma-script v.2)
15193 \begin_layout Standard
15199 \begin_layout Standard
15200 \begin_inset VSpace medskip
15206 \begin_layout Standard
15208 Koma-Script version 2.8 has introduced a new letter class
15212 which supersedes the now unsupported
15217 It has — on the \SpecialChar LaTeX
15218 side — a completely new interface and is not compatible
15219 with the old class.
15220 Therefore, \SpecialChar LyX
15221 supports both, though it is recommended you use the new class.
15224 \begin_layout Standard
15225 This class covers the same functionality as
15227 letter (koma-script),
15230 The basic items are
15234 (receiver's address, same as
15238 in the old layout),
15251 will start a new letter (i.
15252 \begin_inset space \thinspace{}
15256 \begin_inset space \space{}
15259 you can write several letters per document).
15260 New elements are sender's
15276 and the possibility to use a
15282 Insert\SpecialChar menuseparator
15288 \begin_layout Standard
15289 The biggest improvement is, though, that the letter's layout is configurable
15290 to meet almost any needs.
15291 This can be done via the preamble or with a special style file (Letter
15292 Class Option, extension
15296 ), that will be read in as a class option.
15300 \begin_layout Plain Layout
15301 The KOMA package comes with some default
15306 There is, for instance, a
15310 file that follows german typesetting rules, or a
15314 that provides the default layout of the old
15319 The latter can be loaded with the class option
15325 Layout\SpecialChar menuseparator
15326 Document\SpecialChar menuseparator
15338 template that is included in \SpecialChar LyX
15340 A detailed description is to be found in the Koma-Script documentation
15348 \begin_layout Subsection
15352 \begin_layout Standard
15353 Visualizing the Koma-Script document classes in \SpecialChar LyX
15354 , the \SpecialChar LyX
15355 internals cause some
15359 \begin_layout Itemize
15360 The chapter number of a
15364 type appears on a line of its own above the chapter heading instead of
15365 appearing in the same line ahead of it.
15366 The cause for that is the \SpecialChar LyX
15367 internal behavior for the labeltype
15371 in the layout file.
15374 \begin_layout Itemize
15375 The headings of the types
15383 are only put in the
15384 \begin_inset Quotes eld
15388 \begin_inset Quotes erd
15392 table of contents, but not in the \SpecialChar LyX
15393 table of contents (
15395 Document\SpecialChar menuseparator
15397 \begin_inset space ~
15401 \begin_inset space ~
15409 \begin_layout Itemize
15410 The paragraphs in a
15414 document class appear in a skip separation mode, not indented.
15415 This is the standard behavior, no special \SpecialChar LaTeX
15416 commands are needed for that.
15419 Document\SpecialChar menuseparator
15422 dialog the corresponding radio button indicates
15431 value always has the effect that extra \SpecialChar LaTeX
15432 commands are inserted in the document
15433 to produce the gap, which is not what is wanted in this case.
15436 \begin_layout Section
15440 \begin_layout Standard
15446 \begin_layout Subsection
15450 \begin_layout Standard
15451 Memoir is a very powerful and constantly evolving class.
15452 It has been designed with regard to fictional and non-fictional literature.
15453 Its aim is to let the user have maximum control over the typesetting of
15455 Memoir is based on the standard book class, but it can also emulate the
15456 article class (see below).
15459 \begin_layout Standard
15460 Peter Wilson, the developer of Memoir, is known as the author of lots of
15461 useful packages in the \SpecialChar LaTeX
15463 Most of them have been merged with Memoir.
15464 Therefore, it is much easier to layout the table of contents, appendices,
15465 chapter designs and such.
15467 , though, does not support all of these goodies natively.
15468 Some of them might be added to forthcoming releases
15472 \begin_layout Plain Layout
15473 You are invited to send suggestions to
15474 \begin_inset Flex URL
15477 \begin_layout Plain Layout
15479 lyx-devel@lists.lyx.org
15489 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15491 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15493 commands (\SpecialChar TeX
15498 \begin_layout Plain Layout
15503 \begin_layout Plain Layout
15513 \begin_inset space ~
15517 \begin_inset CommandInset ref
15519 reference "sec:Inserting-TeX-Code"
15529 In this section, we can only list those features that are natively supported
15530 by \SpecialChar LyX
15532 For detailed descriptions (and for the rest of features) we recommend you
15533 have a look at the detailed manual of the Memoir class
15537 \begin_layout Plain Layout
15542 \begin_layout Plain Layout
15552 \begin_inset Flex URL
15555 \begin_layout Plain Layout
15557 CTAN:/macros/latex/memoir/memman.pdf
15567 , which is not only a user guide for the class, but also both a comprehensive
15568 description on good typesetting and a superb example for good typesetting
15572 \begin_layout Subsection
15573 Basic features and restrictions
15576 \begin_layout Standard
15577 Memoir supports basically all features of the standard book classes.
15578 There are, however, some differences, as follows:
15581 \begin_layout Description
15583 \begin_inset space ~
15586 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15589 \begin_layout Description
15591 \begin_inset space ~
15594 style: The fancy page style is not supported, due to a command clash between
15595 Memoir and the fancyhdr package (they both define a command with the same
15596 name, which confuses \SpecialChar LaTeX
15598 Instead, Memoir comes with a number of its own page styles (see
15600 Document\SpecialChar menuseparator
15601 Settings\SpecialChar menuseparator
15603 \begin_inset space ~
15609 If you want to use these for the chapter pages, you have to use the command
15616 in the main text or in preamble (e.
15617 \begin_inset space \thinspace{}
15621 \begin_inset space \space{}
15628 chapterstyle{companion}
15633 \begin_layout Description
15634 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15635 optional argument in the standard classes.
15636 With this, you can specify an alternative version of the title for the
15637 table of contents and the headers (for instance, if the title is too long).
15638 In \SpecialChar LyX
15639 , you can do this via
15641 Insert\SpecialChar menuseparator
15643 \begin_inset space ~
15648 at the beginning of a chapter/section.
15649 Memoir features a second optional argument and thus separates the table
15650 of contents from the header.
15651 You can define three variants of a title with this: one for the main text,
15652 one for the table of contents, and one for the headers.
15654 makes these available in form of specific
15665 \begin_layout Description
15666 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15667 of contents, the list of figures and the list of table start a new page
15669 Memoir does not follow this route.
15670 You have to insert a page break yourself, if you want to have one.
15673 \begin_layout Description
15674 Titlepage: For some unknown reason, Memoir uses pagination on the title
15675 page (in the standard classes, title pages are
15676 \begin_inset Quotes eld
15680 \begin_inset Quotes erd
15684 If you want an empty title page, type
15688 aliaspagestyle{title}{empty}
15693 \begin_layout Description
15694 Article: With the class option
15700 Document\SpecialChar menuseparator
15701 Settings\SpecialChar menuseparator
15702 Class Settings\SpecialChar menuseparator
15704 \begin_inset space ~
15709 ), you can emulate article style.
15710 That is, counters (footnotes, figures, tables etc.) will not be reset on
15711 new chapters, chapters don't start a new page (but are—in contrary to
15712 \begin_inset Quotes eld
15716 \begin_inset Quotes erd
15719 article classes—still allowed), parts, though, use their own page, as in
15723 \begin_layout Description
15724 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15725 font commands, which have been used in the old \SpecialChar LaTeX
15727 \begin_inset space \thinspace{}
15731 \begin_inset space \space{}
15747 It produces an error and stops \SpecialChar LaTeX
15748 whenever such a command appears.
15753 reallows the commands and spits out warnings instead (which does at least
15754 not stop \SpecialChar LaTeX
15756 Since a lot of packages and particularly Bib\SpecialChar TeX
15757 style files are still using
15758 those commands, we have decided to use this option by default.
15761 \begin_layout Subsection
15765 \begin_layout Standard
15766 We will only describe the features supported by \SpecialChar LyX
15767 (which is not much currently).
15768 Please consult the Memoir manual
15772 \begin_layout Plain Layout
15777 \begin_layout Plain Layout
15787 \begin_inset Flex URL
15790 \begin_layout Plain Layout
15792 CTAN:/macros/latex/memoir/memman.pdf
15805 \begin_layout Description
15806 Abstract: You may wonder why an abstract is an extra feature.
15807 Well, it is in book class.
15808 Usually books don't have abstracts.
15809 Memoir, however, has.
15810 You can use it wherever and how often you like.
15813 \begin_layout Description
15814 Chapterprecis: You may know this older typesetting style: The contents of
15815 a chapter are summarized below the title and also in the table of contents
15817 \begin_inset space \thinspace{}
15821 \begin_inset space \space{}
15826 Our hero arrives in Troia; he loses some friends; he finds others
15829 Chapterprecis does exactly this.
15830 It is therefore only sensible below a chapter.
15833 \begin_layout Description
15834 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
15835 The epigraph environment provides an elegant way of typesetting such a
15837 The motto itself (text) and its (optional) author (source) are divided
15839 The author (source) can be inserted via
15841 Insert\SpecialChar menuseparator
15848 \begin_layout Description
15849 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
15850 complex figurative poems).
15852 can only support a few of them.
15853 One is poemtitle, which is a centered title for poems, which will also
15854 be added to the table of contents (verse is the standard environment for
15856 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
15858 because they have to be nested inside regular verse environments, which
15859 is not possible with \SpecialChar LyX
15863 \begin_layout Description
15864 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
15867 \begin_layout Section
15868 Article (mwart), book (mwbk) and report (mwrep)
15869 \begin_inset Argument status
15872 \begin_layout Plain Layout
15885 \begin_layout Standard
15891 \begin_layout Standard
15892 The \SpecialChar LyX
15909 correspond to the \SpecialChar LaTeX
15923 They are replacements for the standard document classes
15935 , resp., and fit better to Polish typography conventions in a number of points.
15939 \begin_layout Standard
15943 \begin_layout Itemize
15944 Unnumbered titles (with star, e.
15945 \begin_inset space \thinspace{}
15949 \begin_inset space \space{}
15956 ) are added into table of contents,
15959 \begin_layout Itemize
15960 Additional page styles:
15964 \begin_layout Description
15965 uheadings header with separated lines,
15968 \begin_layout Description
15969 myheadings custom header, contents headers via commands:
15984 \begin_layout Description
15985 myuheadings custom header with separated lines,
15988 \begin_layout Description
15989 outer page number is placed on outer side of page
15993 \begin_layout Itemize
15998 \begin_layout Description
15999 rmheadings serif titles — default,
16002 \begin_layout Description
16003 sfheadings sansserif titles,
16006 \begin_layout Description
16007 authortitle on title page first placed is author next title — default,
16010 \begin_layout Description
16011 titleauthor on title page first placed is title next author,
16014 \begin_layout Description
16015 withmarginpar reserve place on page for margins.
16019 \begin_layout Section
16023 \begin_layout Standard
16028 provides an alternative to the standard
16033 It provides similar functionality, but you might prefer this layout with
16034 sans serif sections, headings, and more.
16037 \begin_layout Section
16038 Rev\SpecialChar TeX
16042 \begin_layout Standard
16048 \begin_layout Standard
16049 \begin_inset VSpace bigskip
16055 \begin_layout Standard
16060 \begin_inset space ~
16065 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16067 \begin_inset Formula $\beta$
16070 release of May, 1999) class.
16073 \begin_layout Standard
16079 textclass, which works with Rev\SpecialChar TeX
16081 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16083 That means that it doesn't interact very well with \SpecialChar LyX
16084 , which requires \SpecialChar LaTeX2e
16086 it has been kludged to work.
16087 Since Rev\SpecialChar TeX
16088 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16093 Rev\SpecialChar TeX
16095 \begin_inset space ~
16100 textclass should also be pretty easy to use.
16103 \begin_layout Standard
16104 These documents are supposed to be used in
16108 to the Rev\SpecialChar TeX
16109 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16111 and assume you'll know what to put in the preamble if necessary.
16114 \begin_layout Subsection
16118 \begin_layout Standard
16119 All you need to do is install Rev\SpecialChar TeX
16120 4, as described in the package's README
16122 The package can be found at The Rev\SpecialChar TeX
16124 \begin_inset Flex URL
16127 \begin_layout Plain Layout
16129 http://publish.aps.org/revtex4/
16135 Install it somewhere that \SpecialChar LaTeX
16137 Test it by trying to \SpecialChar LaTeX
16138 a short Rev\SpecialChar TeX
16139 4 document in some random directory (i.
16140 \begin_inset space \thinspace{}
16144 \begin_inset space \space{}
16147 not the directory where you installed the class file.) Then, if you reconfigure
16149 , it will find the class file and let you use the Rev\SpecialChar TeX
16153 \begin_layout Standard
16154 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16163 \begin_inset space ~
16168 template, found in the templates directory.
16171 \begin_layout Subsection
16175 \begin_layout Standard
16176 Optional arguments to
16183 \begin_inset Quotes eld
16187 \begin_inset Quotes erd
16191 \begin_inset Quotes eld
16195 \begin_inset Quotes erd
16201 \begin_inset space ~
16209 \begin_inset space ~
16215 Remember that in Rev\SpecialChar TeX
16216 , at least one optional argument is required!
16219 \begin_layout Standard
16220 Other preamble matter, like
16227 \begin_inset space ~
16234 \begin_inset space ~
16239 dialog, also as usual.
16242 \begin_layout Subsection
16246 \begin_layout Standard
16247 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16249 For example, the Email layout corresponds to
16256 Note that (at least as of Rev\SpecialChar TeX
16265 layouts are exactly equivalent, so you shouldn't need to use both.
16269 \begin_layout Plain Layout
16270 In case you're curious, both were included so that
16274 would be able to translate both
16294 \begin_layout Subsection
16298 \begin_layout Standard
16299 There are a couple of important unique aspects of Rev\SpecialChar TeX
16300 4 which might cause
16301 bugs that will be even more confusing in \SpecialChar LyX
16305 \begin_layout Standard
16306 In Rev\SpecialChar TeX
16324 The \SpecialChar LyX
16325 equivalent is that there is a separate Thanks layout.
16330 write footnotes in the
16334 layout, or weird things may happen.
16335 See the Rev\SpecialChar TeX
16336 4 documentation for more details.
16339 \begin_layout Standard
16343 \begin_inset space ~
16351 \begin_inset space ~
16360 layouts must be placed
16368 layout and the corresponding
16385 , the \SpecialChar LaTeX
16389 \begin_layout Section
16390 Springer Journals (
16397 \begin_layout Standard
16403 \begin_layout Subsection
16407 \begin_layout Standard
16408 These are the layout files for some of the journal formats used by Springer
16409 Verlag and listed on
16410 \begin_inset Flex URL
16413 \begin_layout Plain Layout
16415 http://www.springer.de/author/tex/help-journals.html
16420 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16422 It is a modular system: the things common to all journals are implemented
16427 , which journal-specific layout files (such as, e.
16428 \begin_inset space \thinspace{}
16432 \begin_inset space \space{}
16439 for Journal of Geodesy) can include.
16442 \begin_layout Standard
16443 This means that implementing support for any other Springer journal on this
16444 list is as simple as writing your own
16452 file following the outline given in
16460 \begin_layout Standard
16461 It is reasonably well tested only for the Journal of Geodesy.
16470 come with the standard \SpecialChar LyX
16472 Install the relevant class file (downloaded from Springer) in a proper
16473 directory, reconfigure \SpecialChar LaTeX
16474 (in the te\SpecialChar TeX
16479 , as root if necessary — doesn't \SpecialChar LyX
16480 take care of this?), reconfigure \SpecialChar LyX
16485 \begin_layout Subsection
16489 \begin_layout Standard
16490 A large number of theorem-like styles —
16502 \begin_layout Standard
16505 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16506 _Title, Author_Running, Institute,
16507 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16510 See the Springer class file documentation for details.
16513 \begin_layout Subsection
16517 \begin_layout Itemize
16529 \begin_layout Itemize
16532 Probability Theory and Related Fields
16538 — Jean-Marc Lasgouttes
16541 \begin_layout Standard
16542 Add your own, it isn't so hard!
16545 \begin_layout Subsection
16549 \begin_layout Standard
16550 These files are partly based on the older
16554 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16556 file from Springer.
16561 layout, are now defunct.
16562 Jean-Marc Lasgouttes helped out big in making me find my way around the
16564 layout file mechanism.
16567 \begin_layout Subsection
16571 \begin_layout Standard
16573 But probably less than in the old hacked-\SpecialChar LaTeX
16581 \begin_layout Section
16584 Sli\SpecialChar TeX
16588 \begin_inset CommandInset label
16597 \begin_layout Standard
16605 \begin_layout Subsection
16609 \begin_layout Standard
16610 This section describes how to use \SpecialChar LyX
16611 to make slides for overhead projectors.
16612 There are two document classes that can do this: the default slides class
16615 Foil\SpecialChar TeX
16619 This section documents the former.
16622 \begin_layout Standard
16623 I'm going to say this again, nice and clear, so that there's no misunderstanding
16627 \begin_layout Standard
16628 \begin_inset VSpace bigskip
16634 \begin_layout Standard
16638 This section documents the class
16639 \begin_inset Quotes eld
16647 \begin_inset Quotes erd
16655 \begin_layout Standard
16656 \begin_inset VSpace bigskip
16662 \begin_layout Standard
16663 If you're looking for the documentation for
16664 \begin_inset Quotes eld
16669 slides (Foil\SpecialChar TeX
16673 \begin_inset Quotes erd
16676 , check out section
16677 \begin_inset space ~
16681 \begin_inset CommandInset ref
16683 reference "sec:foiltex"
16693 \begin_inset Quotes eld
16698 slides (Foil\SpecialChar TeX
16702 \begin_inset Quotes erd
16705 ] is actually somewhat better than the default
16713 \begin_layout Plain Layout
16715 or so I've been told repeatedly by its advocates.
16716 Having never used it, I have no idea if this claim is true or not.
16721 which this section documents.
16724 \begin_layout Standard
16725 This class is the \SpecialChar LaTeX2e
16726 improvement of the old
16728 Sli\SpecialChar TeX
16732 Every \SpecialChar LaTeX2e
16733 distribution includes this class [which I'll just refer to as
16734 \begin_inset Quotes eld
16742 \begin_inset Quotes erd
16745 from now on], so you're bound to have it.
16746 As I noted earlier, there are other classes, such as
16750 , which also produce slides for overhead projectors and do a better job
16752 However, there are some things which
16756 can do which the others can't, such as generate overlays.
16757 Read on to learn more!
16760 \begin_layout Subsection
16762 \begin_inset CommandInset label
16764 name "sec:slidesetup"
16771 \begin_layout Standard
16772 Obviously, to use this document class, you need to select
16773 \begin_inset Quotes eld
16781 \begin_inset Quotes erd
16784 from the class list in the
16786 Document\SpecialChar menuseparator
16790 There are some other special things you should know about this class:
16793 \begin_layout Itemize
16794 Don't bother changing the options
16799 They're not supported by the
16806 \begin_layout Itemize
16810 \begin_inset space ~
16815 behaves a bit differently for this class.
16816 The possible choices and what they do are as follows:
16820 \begin_layout Description
16825 The final output contains page numbers in the lower right corner.
16828 \begin_layout Description
16837 , but also prints out any time markers you've put in.
16838 This is the default.
16841 \begin_layout Description
16846 The final output contains no page numbers, time markers, or alignment markers.
16850 \begin_layout Itemize
16855 class has an extra option:
16861 \begin_inset Quotes eld
16869 \begin_inset Quotes erd
16872 in the extra class options.
16876 \begin_layout Standard
16877 Using this options allows you to add time markers to
16883 \begin_inset space ~
16887 \begin_inset CommandInset ref
16889 reference "sec:slideNote"
16897 \begin_layout Standard
16898 You can also use the template file
16899 \begin_inset Quotes eld
16907 \begin_inset Quotes erd
16910 to automatically set up a document to use the
16916 File\SpecialChar menuseparator
16918 \begin_inset space ~
16922 \begin_inset space ~
16927 to open your new document].
16928 The template file also contains some examples of the special paragraph
16929 environments used by this class.
16930 I'll describe those next.
16933 \begin_layout Subsection
16934 Paragraph Environments
16937 \begin_layout Subsubsection
16938 Supported Environments
16941 \begin_layout Standard
16942 The first thing you'll notice when you start up a new
16946 document is the font size and type: it's the equivalent of the size
16947 \begin_inset Quotes eld
16955 \begin_inset Quotes erd
16961 \begin_inset space ~
16967 This is also what's used in the output.
16969 \begin_inset Quotes eld
16973 \begin_inset Quotes erd
16976 to remind you that this is a slide.
16977 Your final slides will use a larger font; ergo, you'll have less space.
16978 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
16981 \begin_layout Standard
16982 The next thing that becomes obvious is the changes to the paragraph environment
16983 pull-down box [at the far-left end of the toolbar].
16984 Most of the paragraph environments you're used to seeing are missing.
16985 There are also five new ones.
16990 class itself only supports certain paragraph environments:
16993 \begin_layout Itemize
16999 \begin_layout Itemize
17005 \begin_layout Itemize
17011 \begin_layout Itemize
17017 \begin_layout Itemize
17023 \begin_layout Itemize
17029 \begin_layout Itemize
17035 \begin_layout Itemize
17041 \begin_layout Itemize
17047 \begin_layout Itemize
17054 \begin_layout Standard
17055 All of the other standard environments, including the section-heading environmen
17056 ts, aren't used in the
17063 \begin_layout Standard
17064 On the other hand, you'll notice the following new environments:
17067 \begin_layout Itemize
17073 \begin_layout Itemize
17079 \begin_layout Itemize
17085 \begin_layout Itemize
17091 \begin_layout Itemize
17097 \begin_layout Standard
17098 These five are kind of quirky, due to a
17099 \begin_inset Quotes eld
17103 \begin_inset Quotes erd
17106 in \SpecialChar LyX
17108 You see, \SpecialChar LyX
17109 doesn't permit you to nest any other paragraph environment into
17110 an empty environment.
17111 Now, that's fine and dandy, but it means that you wouldn't be able to start
17112 a slide with anything except plain text.
17113 To deal with this, I've performed a little
17114 \begin_inset Quotes eld
17119 \begin_inset Quotes erd
17125 \begin_layout Subsubsection
17126 Quirks of the New Environments
17127 \begin_inset CommandInset label
17129 name "sec:slideQuirk"
17136 \begin_layout Standard
17137 All five of the new paragraph environments are somewhat quirky due to inherent
17138 limitiations in the current version of \SpecialChar LyX
17140 As I just mentioned, \SpecialChar LyX
17141 forbids environments that begin with another environment.
17142 To get around this, the
17146 environment isn't a paragraph environment as described in the
17154 \begin_layout Standard
17155 You should consider
17168 \begin_inset Quotes eld
17171 pseudo-environments.
17172 \begin_inset Quotes erd
17175 They look like a section heading or a
17176 \begin_inset Quotes eld
17184 \begin_inset Quotes erd
17187 but really begin a [and, if necessary, end the previous] paragraph environment.
17197 \begin_inset Quotes eld
17201 \begin_inset Quotes erd
17204 These two perform some action.
17207 \begin_layout Standard
17208 A common feature of all five environments,
17228 , is a rather long-ish label.
17229 The text following this label — ordinarily the contents of the paragraph
17230 environment — is utterly irrelevant for
17252 completely ignores it.
17253 In fact, you can leave these five environments completely empty.
17257 \begin_layout Standard
17262 to put any text after the rather long-ish label, you might want to.
17263 This could be a short description of the contents of the
17268 In that case, enter your descriptive comment and hit
17272 as you normally would.
17275 \begin_layout Standard
17276 If, on the other hand, you don't want to enter any descriptive text, you'll
17277 hit another \SpecialChar LyX
17280 , like nature, abhors a vacuum, and will not let you start a new paragraph
17281 environment until you put something in the old one.
17285 \begin_layout Itemize
17286 Start entering the text that will
17314 \begin_layout Itemize
17315 Now move to the beginning of that paragraph.
17319 \begin_layout Itemize
17328 \begin_layout Itemize
17329 Finally, change this new, empty paragraph to a
17353 \begin_layout Standard
17354 Some future version of \SpecialChar LyX
17355 will, hopefully, resolve this quirkiness\SpecialChar ldots
17359 \begin_layout Subsection
17360 Making a Presentation with
17373 \begin_layout Subsubsection
17381 \begin_layout Standard
17382 If you're expecting this section to teach you how to actually make a presentatio
17383 n, you'll be sorely disappointed.
17384 Naturally, I'll describe all of the ways the
17388 class can assist you in preparing the materials for a presentation.
17389 Filling in the contents, however, is up to you.
17394 the \SpecialChar LyX
17398 \begin_layout Standard
17403 environment [in the manner described in section
17404 \begin_inset space ~
17408 \begin_inset CommandInset ref
17410 reference "sec:slideQuirk"
17414 ] tells \SpecialChar LyX
17415 to begin a new slide [duh].
17416 The label for this environment/
17417 \begin_inset Quotes erd
17421 \begin_inset Quotes erd
17425 \begin_inset Quotes eld
17429 \begin_inset Quotes erd
17432 in cool blue, followed by the label,
17433 \begin_inset Quotes eld
17437 \begin_inset Quotes erd
17441 Any text or paragraph environments that follow this one go on the new slide.
17445 \begin_layout Standard
17446 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17448 (this can be specified in the
17453 In fact, you'll want to, once you finish entering the contents of one slide.
17454 If you've entered more text than can physically fit on a slide, the extra
17455 overflows onto a new slide.
17456 I don't recommend doing this, however, since the overflow slide won't have
17457 any page number on it.
17458 Furthermore, it may interfere with any
17462 you've made to accompany the oversized
17469 \begin_layout Standard
17478 environments work the same way as the
17483 They both create an
17484 \begin_inset Quotes eld
17488 \begin_inset Quotes erd
17491 followed by a label [
17492 \begin_inset Quotes eld
17496 \begin_inset Quotes erd
17500 \begin_inset Quotes eld
17504 \begin_inset Quotes erd
17508 The color is a stunning magenta instead of blue, and the
17509 \begin_inset Quotes eld
17513 \begin_inset Quotes erd
17516 will look different, in style and in length.
17517 The label fonts of all three also differ from one another.
17520 \begin_layout Standard
17525 , if the contents of a
17533 exceed the physical size of a slide or sheet of paper, the extra will overflow
17535 Again, you should avoid this.
17536 It defeats the whole purpose of
17547 \begin_layout Subsubsection
17557 \begin_layout Standard
17562 is a slide that sits atop another slide.
17563 Perhaps you wish to discuss a figure on the main
17567 before displaying the text associated with it.
17568 One way to accomplish this is tape a flap of dark paper over the part of
17573 you want to display later.
17574 This method fails, however, if you wish to overlap one graph with another,
17576 You would then have to fumble while speaking to align the two separate,
17581 s to align the two graphs.
17586 environment in both cases makes life much easier.
17589 \begin_layout Standard
17594 receives the page number of its
17595 \begin_inset Quotes eld
17599 \begin_inset Quotes erd
17607 \begin_inset Quotes eld
17615 \begin_inset Quotes erd
17622 \begin_layout Plain Layout
17623 Presumably, mutliple
17628 \begin_inset Quotes eld
17636 \begin_inset Quotes erd
17640 \begin_inset Quotes eld
17648 \begin_inset Quotes erd
17652 \begin_inset Quotes eld
17660 \begin_inset Quotes erd
17664 \begin_inset space ~
17667 appended to the page number of the parent
17677 Clearly, you want the contents of both the
17685 to each fit on a single physical slide! You should probably consider an
17691 \begin_inset Quotes eld
17695 \begin_inset Quotes erd
17703 Indeed, the \SpecialChar LyX
17708 class provides a visual cue for this: the label at the start of an
17712 is shorter than that at the start of a
17717 Lastly, when you generate printable output, you'll find alignment markers
17718 in all four corners of both the
17722 page and its parent
17727 These will assist you in lining up the two physical slides.
17730 \begin_layout Standard
17731 The major problem in overlaying two slides is aligning the contents of the
17732 two transparencies.
17733 How much space should you leave for that graph on the second slide? Worse
17734 still, what if you want a graph and a sentence on second slide, but there
17735 is text on the main transparency that goes in between them? You could try
17736 and insert vertical space of the right size.
17737 The better way is to use
17748 \begin_layout Standard
17749 As their names imply,
17757 are two command-like paragraph environments that make all subsequent text
17758 invisible and visible, respectively.
17760 \begin_inset space ~
17764 \begin_inset CommandInset ref
17766 reference "sec:slideQuirk"
17770 that you don't place anything
17774 these two environments, however.
17779 , it inserts a centered, sky-blue label into the page reading
17780 \begin_inset Quotes eld
17783 <Invisible Text Follows>
17784 \begin_inset Quotes erd
17788 For paragraphs following this label, the parts of the
17796 ; it doesn't matter which] where they would be contain instead blank space.
17800 \begin_layout Standard
17805 , the corresponding centered label is
17806 \begin_inset Quotes eld
17809 <Visible Text Follows>
17810 \begin_inset Quotes erd
17814 Paragraphs following this label behave normally.
17815 Note that the beginning of a new
17827 automatically shuts off an
17832 It's therefore not necessary to use
17843 \begin_layout Standard
17844 By now, it should be obvious how to create overlay transparencies using
17845 the proper combination of
17864 \begin_layout Enumerate
17869 , including everything that will appear on it, whether on the main slide
17877 \begin_layout Enumerate
17878 Before each figure or paragraph that will appear only on the
17887 If necessary, insert a
17891 environment after the
17898 \begin_layout Enumerate
17903 immediately following the
17910 \begin_layout Enumerate
17911 Copy the contents of this
17922 \begin_layout Enumerate
17927 , change all of the
17938 \begin_layout Standard
17940 You've just made an
17947 \begin_layout Standard
17948 There's one problem with the way I've designed the \SpecialChar LyX
17953 class: you can't make text in the middle of a paragraph invisible, nor
17954 make text in the middle of an invisible paragraph visible again.
17955 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
17960 \begin_layout Plain Layout
17961 The commands of interest are:
17964 \begin_layout Itemize
17969 invisible \SpecialChar ldots
17973 \begin_layout Itemize
17978 visible \SpecialChar ldots
17982 \begin_layout Plain Layout
17984 and need to be marked as \SpecialChar TeX
17987 \begin_inset Quotes eld
17991 \begin_inset Quotes erd
17994 you wish to change goes in between the brackets [and after the
18007 If you don't know how to mark text as \SpecialChar TeX
18008 , see the appropriate section of
18021 \begin_layout Subsubsection
18031 \begin_inset CommandInset label
18033 name "sec:slideNote"
18040 \begin_layout Standard
18049 is associated with a
18050 \begin_inset Quotes eld
18054 \begin_inset Quotes erd
18062 Here, too, the \SpecialChar LyX
18067 class provides visual cues.
18072 is shorter than that of a
18076 [yet longer than that of an
18080 ] and, like the label of an
18084 is shockingly magenta.
18085 Additionally, the printed
18089 has the page number of its
18090 \begin_inset Quotes eld
18094 \begin_inset Quotes erd
18102 \begin_inset Quotes eld
18110 \begin_inset Quotes erd
18114 \begin_inset Quotes eld
18122 \begin_inset Quotes erd
18126 \begin_inset Quotes eld
18134 \begin_inset Quotes erd
18138 You can have multiple
18142 s associated with a single
18154 , you'll probably want to break up long
18158 s so that they fit on a single sheet of paper.
18161 \begin_layout Standard
18166 is obvious: it contains anything additional you might want to say about
18172 It could also be used as a sheet of reminders for a particular
18177 In the case of the latter, you might want to make use of time markers.
18178 Currently, the \SpecialChar LyX
18184 \begin_inset Quotes eld
18188 \begin_inset Quotes erd
18191 support for time markers, a
18193 Sli\SpecialChar TeX
18197 So, you'll have to resort to using the \SpecialChar LaTeX
18201 \begin_layout Standard
18202 To use time markers, you'll need to specify the extra class option
18203 \begin_inset Quotes eld
18211 \begin_inset Quotes erd
18215 \begin_inset space ~
18219 \begin_inset CommandInset ref
18221 reference "sec:slidesetup"
18226 This option turns on timing marks, which will appear in the lower-left-hand
18232 To set what appears in the time marker, you use the \SpecialChar LaTeX
18234 \begin_inset Quotes eld
18244 \begin_inset Quotes erd
18248 \begin_inset Quotes eld
18258 \begin_inset Quotes erd
18262 The arguments of both commands are time measured in seconds.
18264 \begin_inset Quotes eld
18274 \begin_inset Quotes erd
18277 sets the time marker to a given time.
18279 \begin_inset Quotes eld
18289 \begin_inset Quotes erd
18292 increments the time marker by the specified amount.
18293 Using time markers and
18297 s in this fashion, you can remind yourself how much time to spend on a particula
18305 \begin_layout Standard
18306 There's one last feature to describe.
18307 Clearly, you'd like to print out all of your
18315 s on transparencies while printing all of your
18332 with which it is associated.
18333 What's a person to do?
18336 \begin_layout Standard
18337 Luckily, there are two \SpecialChar LaTeX
18338 commands that allow you to select what to print
18340 Both must be placed into the preamble of your document.
18342 \begin_inset Quotes eld
18354 \begin_inset Quotes erd
18357 will cause the output to contain only the
18366 Correspondingly, the command
18367 \begin_inset Quotes eld
18379 \begin_inset Quotes erd
18382 prevents the output of anything but
18387 I'd advise placing both commands in the preamble and initially comment
18389 You can then preview your entire presentation as you write.
18390 When you're done writing, you can then uncomment one of the two to select
18391 what you want to print.
18392 I like to uncomment
18393 \begin_inset Quotes eld
18405 \begin_inset Quotes erd
18408 , print to a file with
18409 \begin_inset Quotes eld
18417 \begin_inset Quotes erd
18420 in its name, comment it back out, then uncomment
18421 \begin_inset Quotes eld
18433 \begin_inset Quotes erd
18437 \begin_inset Quotes eld
18445 \begin_inset Quotes erd
18449 I can then send either file to a printer, loading transparencies or plain
18450 paper as appropriate.
18453 \begin_layout Standard
18454 You can also provide other arguments to the
18455 \begin_inset Quotes eld
18465 \begin_inset Quotes erd
18469 \begin_inset Quotes eld
18479 \begin_inset Quotes erd
18483 See a good \SpecialChar LaTeX
18487 \begin_layout Subsection
18492 Class Template File
18495 \begin_layout Standard
18496 I have also provided a template file,
18497 \begin_inset Quotes eld
18505 \begin_inset Quotes erd
18513 To use it, begin your new presentation with
18515 File\SpecialChar menuseparator
18517 \begin_inset space ~
18521 \begin_inset space ~
18527 Your new \SpecialChar LyX
18528 presentation file will contain an example
18549 additionally contain an example of the use of
18558 Lastly, the preamble will contain:
18561 \begin_layout LyX-Code
18562 % Uncomment to print out only slides and overlays
18565 \begin_layout LyX-Code
18569 \begin_layout LyX-Code
18575 \begin_inset Newline newline
18581 \begin_layout LyX-Code
18582 % Uncomment to print out only notes
18585 \begin_layout LyX-Code
18589 \begin_layout LyX-Code
18597 \begin_layout Standard
18598 One final thing: I created this class to support the \SpecialChar LaTeX2e
18600 \begin_inset Quotes eld
18605 Sli\SpecialChar TeX
18609 \begin_inset Quotes erd
18612 class, one of the built-in \SpecialChar LaTeX2e
18614 Neither I nor the rest of the \SpecialChar LyX
18615 Team endorse or oppose the use of this built-in
18617 It's here if you want it or need it.
18618 There exist other \SpecialChar LaTeX2e
18619 classes for creating presentations, such as the
18624 \begin_inset space ~
18628 \begin_inset CommandInset ref
18630 reference "sec:foiltex"
18635 \begin_inset Quotes eld
18643 \begin_inset Quotes erd
18646 package [present on some \SpecialChar TeX
18648 The latter is not yet supported under \SpecialChar LyX
18653 \begin_layout Plain Layout
18654 Perhaps you can take on the task\SpecialChar ldots
18660 I know nothing about these other classes.
18661 Try them out to see what sort of alternative they provide.
18664 \begin_layout Chapter
18666 Features needing Extra Software
18669 \begin_layout Section
18670 Checking \SpecialChar TeX
18674 \begin_layout Standard
18680 \begin_layout Subsection
18684 \begin_layout Standard
18693 \begin_layout Plain Layout
18698 is not yet available when you are using the \SpecialChar LaTeX
18699 distribution MiK\SpecialChar TeX
18705 , you'll find in the
18712 \begin_inset space ~
18723 \begin_inset Newline newline
18727 \begin_inset CommandInset href
18729 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18737 \begin_layout Standard
18740 Chk\SpecialChar TeX
18743 package is a program that was written by
18744 \begin_inset Flex Noun
18747 \begin_layout Plain Layout
18749 \begin_inset space ~
18757 in frustration because some constructs in \SpecialChar LaTeX
18758 are sometimes non-intuitive,
18759 and easy to forget.
18760 The program runs over your \SpecialChar LaTeX
18761 file, checks the integrity of the file, and
18762 flags some common errors.
18763 In other technical words, it is
18767 for \SpecialChar LaTeX
18771 \begin_layout Standard
18772 Well, what is a syntax checker doing in \SpecialChar LyX
18773 which is supposed to produce correct
18775 anyways? The answer is simple: Just as
18779 not only checks the
18783 of C programs, but also does
18787 checks for type-errors,
18789 Chk\SpecialChar TeX
18792 catches some common
18796 errors, in addition to the syntactical ones.
18799 Chk\SpecialChar TeX
18802 is capable of detecting several common errors, such as
18805 \begin_layout Itemize
18806 Ellipsis detection:
18807 \begin_inset Newline newline
18810 Use \SpecialChar ldots
18814 \begin_layout Itemize
18815 No space in front of/after parenthesis:
18816 \begin_inset Newline newline
18822 \begin_layout Itemize
18823 Enforcement of normal space after common abbreviations:
18824 \begin_inset Newline newline
18828 \begin_inset space \thinspace{}
18832 \begin_inset space \space{}
18835 is too wide spacing.
18838 \begin_layout Itemize
18839 Enforcement of end-of-sentence space when the last sentence ends with a
18841 \begin_inset Newline newline
18845 And this is wrong spacing.
18848 \begin_layout Itemize
18849 Space in front of labels and similar commands:
18850 \begin_inset Newline newline
18853 The label should stick right up to the text to avoid falling to a wrong
18856 \begin_inset CommandInset label
18866 \begin_layout Plain Layout
18867 This footnote is in danger of falling off to a wrong page
18872 The label is separated too much.
18875 \begin_layout Itemize
18876 Space in front of references, instead of hard spaces:
18877 \begin_inset Newline newline
18880 If you have bad luck, the text will break right between the referenced text
18881 and reference number, and that's a pity.
18883 \begin_inset CommandInset ref
18885 reference "sec:chktex"
18892 \begin_layout Itemize
18894 \begin_inset Quotes eld
18898 \begin_inset Quotes erd
18902 \begin_inset Formula $\times$
18906 \begin_inset Newline newline
18909 2x2 looks cheap compared to
18910 \begin_inset Formula $2\times2$
18916 \begin_layout Standard
18917 and more \SpecialChar ldots
18918 It is an invaluable tool when you are
18919 \begin_inset Quotes eld
18923 \begin_inset Quotes erd
18926 your document before printing, and you should run it right after the obligatory
18927 spelling check, and before you go fine tuning the typesetting.
18930 \begin_layout Subsection
18934 \begin_layout Standard
18935 If you have the program installed, usage is as simple as choosing
18937 Tools\SpecialChar menuseparator
18939 \begin_inset space ~
18945 This will make \SpecialChar LyX
18946 generate a \SpecialChar LaTeX
18947 file of your document, start
18949 Chk\SpecialChar TeX
18952 to check it, and then make \SpecialChar LyX
18954 \begin_inset Quotes eld
18958 \begin_inset Quotes erd
18961 with the warnings from
18963 Chk\SpecialChar TeX
18966 , if there were any.
18967 The warnings will be placed close to the point of the mistake, and you
18968 can quickly find them by using the
18970 Navigate\SpecialChar menuseparator
18973 menu item, or the shortcut key
18982 Open the error boxes by clicking on them with the mouse, or use the shortcut
18991 bindings, or the corresponding
19000 Read the warning and correct the mistake, if it is a mistake.
19001 If you have trouble understanding what the warning is about, you can safely
19003 Remember that there is a hidden layer between the document on screen and
19004 the technical details in invoking
19006 Chk\SpecialChar TeX
19009 , and this gap can make some warnings seem arcane or just plain silly.
19012 \begin_layout Standard
19013 This document is an excellent testing bed for the feature, and it should
19014 provide quite a few warnings for you to fiddle with.
19015 Since computers are only so smart, expect most of the warnings to be false
19019 \begin_layout Subsection
19020 How to fine tune it
19023 \begin_layout Standard
19024 Sometimes, you'll find that
19026 Chk\SpecialChar TeX
19029 makes more noise than suits your mood.
19030 Then you can choose not to use it, wait until your mood changes, or try
19033 Chk\SpecialChar TeX
19036 to get better along with you.
19039 \begin_layout Standard
19042 Chk\SpecialChar TeX
19049 very configurable and extensible, you should not expect to solve all problems
19052 Chk\SpecialChar TeX
19055 in \SpecialChar LyX
19057 Since \SpecialChar LyX
19058 has to generate a somewhat special \SpecialChar LaTeX
19059 file to be able to match the
19060 line numbers from the
19062 Chk\SpecialChar TeX
19069 \begin_layout Plain Layout
19070 You can inspect the specific output from
19076 Document\SpecialChar menuseparator
19079 \begin_inset space ~
19093 to the internal document structure, some of the warnings will not appear
19095 There are two things you can do about this:
19098 \begin_layout Itemize
19101 Chk\SpecialChar TeX
19104 invocation command line in
19105 \begin_inset Flex Noun
19108 \begin_layout Plain Layout
19109 Tools\SpecialChar menuseparator
19110 Preferences\SpecialChar menuseparator
19111 Output\SpecialChar menuseparator
19112 LaTeX\SpecialChar menuseparator
19120 Chk\SpecialChar TeX
19123 installation configuration file (usually with the file
19128 See below to learn what warnings can be enabled and disabled on the command
19132 \begin_layout Itemize
19133 Export your document as a raw \SpecialChar LaTeX
19136 File\SpecialChar menuseparator
19137 Export\SpecialChar menuseparator
19146 Invoked in this way, it can be a hassle to find the corresponding place
19147 in the document inside \SpecialChar LyX
19148 , but with a little patience, you should be able
19152 \begin_layout Standard
19153 Here follows the warning messages that can be enabled and disabled in
19162 to disable a warning, and
19166 to enable a warning.
19167 The emphasized entries are disabled by default, because the default is
19170 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19175 \begin_layout Standard
19176 Notice that you should only use the options that enable and disable warnings,
19177 because \SpecialChar LyX
19178 relies on some of the other command line parameters to be set
19179 in a specific way to have a chance to communicate with
19186 \begin_layout Enumerate
19190 Command terminated with space.
19193 \begin_layout Enumerate
19196 Non-breaking space (
19197 \begin_inset Quotes eld
19205 \begin_inset Quotes erd
19208 ) should have been used.
19211 \begin_layout Enumerate
19215 You should enclose the previous parenthesis with
19216 \begin_inset Quotes eld
19224 \begin_inset Quotes erd
19230 \begin_layout Enumerate
19233 Italic correction (
19234 \begin_inset Quotes eld
19244 \begin_inset Quotes erd
19247 ) found in non-italic buffer.
19250 \begin_layout Enumerate
19253 Italic correction (
19254 \begin_inset Quotes eld
19264 \begin_inset Quotes erd
19267 ) found more than once.
19270 \begin_layout Enumerate
19274 No italic correction (
19275 \begin_inset Quotes eld
19285 \begin_inset Quotes erd
19291 \begin_layout Enumerate
19295 \begin_inset Quotes eld
19303 \begin_inset Quotes erd
19307 \begin_inset Quotes eld
19315 \begin_inset Quotes erd
19321 \begin_layout Enumerate
19324 Wrong length of dash may have been used.
19327 \begin_layout Enumerate
19331 \begin_inset Quotes eld
19339 \begin_inset Quotes erd
19343 \begin_inset Quotes eld
19351 \begin_inset Quotes erd
19357 \begin_layout Enumerate
19361 \begin_inset Quotes eld
19369 \begin_inset Quotes erd
19375 \begin_layout Enumerate
19379 \begin_inset Quotes eld
19387 \begin_inset Quotes erd
19390 to achieve an ellipsis.
19393 \begin_layout Enumerate
19396 Inter-word spacing (
19397 \begin_inset Quotes eld
19407 \begin_inset Quotes eld
19410 ) should perhaps be used.
19413 \begin_layout Enumerate
19416 Inter-sentence spacing (
19417 \begin_inset Quotes eld
19427 \begin_inset Quotes erd
19430 ) should perhaps be used.
19433 \begin_layout Enumerate
19436 Could not find argument for command.
19439 \begin_layout Enumerate
19443 \begin_inset Quotes eld
19451 \begin_inset Quotes erd
19457 \begin_layout Enumerate
19460 Math mode still on at end of \SpecialChar LaTeX
19464 \begin_layout Enumerate
19468 \begin_inset Quotes eld
19476 \begin_inset Quotes erd
19479 doesn't match the number of
19480 \begin_inset Quotes eld
19488 \begin_inset Quotes erd
19494 \begin_layout Enumerate
19497 You should use either
19500 \begin_inset Quotes eld
19508 \begin_inset Quotes erd
19513 as an alternative to
19514 \begin_inset Quotes eld
19522 \begin_inset Quotes erd
19528 \begin_layout Enumerate
19535 " (ASCII 39) instead of "
19542 \begin_layout Enumerate
19545 User-specified pattern found.
19548 \begin_layout Enumerate
19551 This command might not be intended.
19554 \begin_layout Enumerate
19561 \begin_layout Enumerate
19579 \begin_layout Enumerate
19582 Delete this space to maintain correct page references.
19585 \begin_layout Enumerate
19589 You might wish to put this between a pair of
19590 \begin_inset Quotes eld
19598 \begin_inset Quotes erd
19604 \begin_layout Enumerate
19607 You ought to remove spaces in front of punctuation.
19610 \begin_layout Enumerate
19613 Could not execute \SpecialChar LaTeX
19617 \begin_layout Enumerate
19626 in front of small punctuation.
19629 \begin_layout Enumerate
19637 may look prettier here.
19640 \begin_layout Enumerate
19644 Multiple spaces detected in output.
19647 \begin_layout Enumerate
19650 This text may be ignored.
19653 \begin_layout Enumerate
19659 \begin_inset Quotes eld
19664 to begin quotation, not
19671 \begin_layout Enumerate
19678 to end quotation, not
19681 \begin_inset Quotes eld
19689 \begin_layout Enumerate
19695 \begin_layout Enumerate
19698 You should perhaps use
19699 \begin_inset Quotes eld
19707 \begin_inset Quotes erd
19713 \begin_layout Enumerate
19716 You should put a space in front of/after parenthesis.
19719 \begin_layout Enumerate
19722 You should avoid spaces in front of/after parenthesis.
19725 \begin_layout Enumerate
19729 You should not use punctuation in front of/after quotes.
19732 \begin_layout Enumerate
19735 Double space found.
19738 \begin_layout Enumerate
19741 You should put punctuation outside inner/inside display math mode.
19744 \begin_layout Enumerate
19747 You ought to not use primitive \SpecialChar TeX
19748 in \SpecialChar LaTeX
19752 \begin_layout Enumerate
19755 You should remove spaces in front of
19756 \begin_inset Quotes eld
19764 \begin_inset Quotes erd
19770 \begin_layout Enumerate
19773 \begin_inset Quotes eld
19781 \begin_inset Quotes erd
19784 is normally not followed by
19785 \begin_inset Quotes eld
19793 \begin_inset Quotes erd
19799 \begin_layout Standard
19800 In later versions of \SpecialChar LyX
19801 , we hope to provide a more complete interface to this
19802 tool (and it's smaller cousin
19806 ) to exploit the full power of it.
19807 But it's not exactly useless as it is now: go try it on one of your existing
19808 documents of a certain length and be surprised.
19811 \begin_layout Section
19812 Version Control in \SpecialChar LyX
19816 \begin_layout Standard
19819 Lars Gullik Bjønnes
19826 \begin_layout Subsection
19830 \begin_layout Standard
19832 supports some of the most basic RCS/CVS/SVN/GIT commands.
19833 If you need something a bit more sophisticated you will have to do that
19834 manually in a terminal.
19837 \begin_layout Standard
19838 Also note that CVS support is not as good as subversion support, so we advise
19840 A good place to start learning Subversion is the SVN Book
19844 \begin_layout Plain Layout
19845 \begin_inset CommandInset href
19847 target "http://svnbook.red-bean.com/"
19858 In the case of RCS you should read
19859 \begin_inset Quotes eld
19863 \begin_inset Quotes erd
19866 (a man file, read it with
19871 This file describes all the basic features of RCS.
19872 You should especially notice the comment about a RCS directory, and the
19873 notion of a master RCS file (the file ending in
19880 \begin_layout Standard
19881 Before you begin to use the version control features in \SpecialChar LyX
19883 familiar with RCS/CVS/SVN/GIT usage.
19884 The implementation in \SpecialChar LyX
19885 assumes a recent version of the GNU RCS or CVS/SVN
19886 package — no guarantees are made for older versions.
19887 Most of the log messages are not currently displayed after operations —
19888 you can check them in the Messages pane if you are unsure.
19889 Regular users of version control will appreciate the VC toolbar, which
19892 View\SpecialChar menuseparator
19893 Toolbars\SpecialChar menuseparator
19895 \begin_inset space ~
19903 \begin_layout Standard
19904 For introducing your own external commands consult
19905 \begin_inset Flex Code
19908 \begin_layout Plain Layout
19922 \begin_layout Standard
19923 It is strongly recommended to store documents in uncompressed format if
19924 using version control (uncheck
19926 Document\SpecialChar menuseparator
19929 if it is checked): Uncompressed LyX documents are text files and therefore
19930 for merging two different versions by version control systems.
19931 Compressed LyX documents are binary files, which cannot be merged by version
19935 \begin_layout Subsection
19936 RCS commands in \SpecialChar LyX
19940 \begin_layout Standard
19941 The following sections describe the RCS commands supported by \SpecialChar LyX
19943 You can find them in the
19945 File\SpecialChar menuseparator
19947 \begin_inset space ~
19954 was tested against RCS 5.7/5.8.
19957 \begin_layout Subsubsection
19963 \begin_layout Standard
19964 If your document is not under revision control, this is the only item shown
19966 And if it is under revision control, the
19970 item is not visible.
19974 \begin_layout Standard
19975 This command registers your document with RCS (unless you are under the
19976 directory managed by CVS)\SpecialChar endofsentence
19977 You are asked interactively to supply an initial
19978 description of the document.
19979 The document is now set in Read-Only mode and you have to
19982 \begin_inset space ~
19986 \begin_inset space ~
19990 \begin_inset space ~
19995 , before making any changes to it.
19996 A document under revision control has a
19997 \begin_inset Quotes eld
20000 [RCS:<version> <locker>]
20001 \begin_inset Quotes erd
20004 item tagged to the filename in the minibuffer.
20007 \begin_layout Standard
20008 RCS command that is run:
20011 \begin_layout LyX-Code
20014 ci -q -u -i -t-"<initial description>" <file-name>
20017 \begin_layout Standard
20022 to understand the switches.
20026 \begin_layout Subsubsection
20032 \begin_layout Standard
20033 When you are finished editing a file, you check in your changes.
20034 When you do this, you are asked for a description of the changes.
20035 This is stored in the history log.
20036 The version number is bumped, your changes are applied to the master RCS
20037 file, the document is unlocked and set to Read-Only mode.
20040 \begin_layout Itemize
20043 ci -q -u -m"<description>" <file-name>
20046 \begin_layout Subsubsection
20052 \begin_layout Standard
20053 By doing this you lock the document so that only you can edit it.
20054 This will also make the document Read-Write only for you.
20055 You will usually continue editing for a while and when you are finished
20056 you check in your changes.
20057 The status line is changed to reflect that you have locked the file.
20060 \begin_layout Itemize
20063 co -q -l <file-name>
20066 \begin_layout Subsubsection
20069 Revert To Repository Version
20072 \begin_layout Standard
20073 This will discard all changes made to the document since the last check
20075 You get a warning before changes are discarded.
20078 \begin_layout Itemize
20081 co -f -u<version> <file-name>
20084 \begin_layout Subsubsection
20090 \begin_layout Standard
20091 This will create a copy of the current document.
20092 Since RCS does not support copy operations natively, the version history
20093 is not preserved, and the copy is added as a new file.
20094 It requires a clean document without any changes since the last checkin.
20095 You are asked for a file name and a description of the copy operation.
20096 After that the copy is created, both locally and in the repository.
20097 If the parent directories of the copied and original document differ, all
20098 relative paths of included files of the copy are adjusted (like in
20100 File\SpecialChar menuseparator
20105 Finally, the copy is loaded instead of the original document.
20108 \begin_layout Labeling
20109 \labelwidthstring 00.00.0000
20111 \begin_inset space ~
20115 \begin_inset space ~
20119 \begin_inset Newline newline
20123 \begin_inset Flex Code
20126 \begin_layout Plain Layout
20129 \begin_inset Quotes qld
20133 \begin_inset Quotes qld
20142 \begin_inset Flex Code
20145 \begin_layout Plain Layout
20148 \begin_inset Quotes qld
20152 \begin_inset Quotes qld
20161 \begin_inset Newline newline
20165 \begin_inset Flex Code
20168 \begin_layout Plain Layout
20172 \begin_inset Quotes qld
20176 \begin_inset Quotes qld
20187 \begin_layout Subsubsection
20193 \begin_layout Standard
20194 This makes as if the last check in never happened.
20195 No changes are made to the document loaded into \SpecialChar LyX
20196 , but the last version
20197 is removed from the master RCS file.
20200 \begin_layout Itemize
20203 rcs -o<version> <file-name>
20206 \begin_layout Subsubsection
20212 \begin_layout Standard
20213 This shows the complete history of the RCS document.
20218 is shown in a browser.
20226 \begin_layout Subsubsection
20230 \begin_layout Standard
20232 supports RCS version number, author name, date and time of last commit.
20233 All those are extracted from
20235 rlog -r <file-name>
20239 \begin_inset CommandInset ref
20241 reference "subsec:VCS-Revision-Information"
20248 \begin_layout Subsection
20249 CVS commands in \SpecialChar LyX
20253 \begin_layout Standard
20254 A subset of CVS operations is supported by \SpecialChar LyX
20256 You can find the commands in the
20258 File\SpecialChar menuseparator
20260 \begin_inset space ~
20266 The version control system SVN is more powerful, so please use it instead
20267 of CVS if possible.
20270 \begin_layout Subsubsection
20276 \begin_layout Standard
20277 If you start from scratch with CVS you have to create your repository and
20278 checkout the working copy with external tools.
20279 If you're using a client-server setup you may need to login before doing
20280 the first repository checkout.
20283 \begin_layout Standard
20284 If your documents are under revision control and others are using the same
20285 repository problems arise when different changes to the same document at
20286 the same location happen.
20287 Standard CVS repositories don't operate with a file locking mechanism.
20288 This may be surprising, but conflicts only occur if people disagree on
20289 the proper content of the same part of a document.
20290 So, if co-workers are used to communicate regularly, these conflicts occur
20292 If they don't communicate they have a fundamental problem anyway.
20293 Nevertheless some people like to work with so called
20294 \begin_inset Quotes eld
20298 \begin_inset Quotes erd
20302 If they do so the working copy of all files is readonly when checked out
20303 first and the user starts editing after using a special command to make
20304 the working copy writable.
20305 When the changes are checked in the working copy returns to readonly state.
20306 With \SpecialChar LyX
20307 one has to edit the
20308 \begin_inset Flex Code
20311 \begin_layout Plain Layout
20317 file and add the line
20318 \begin_inset Flex Code
20321 \begin_layout Plain Layout
20327 to work with reserved checkouts.
20328 The benefit is the possibility to see who is using a writable copy of some
20330 It's not guaranteed only one user makes a copy writable.
20333 \begin_layout Standard
20335 tries to guess if you're using reserved or non-reserved checkouts.
20336 If your working copy is readonly or it is writable and an additional copy
20337 of your document exists in the CVS/Base sub-directory a reserved otherwise
20338 a non-reserved checkout is assumed.
20339 When a reserved checkout is detected you have to use
20340 \begin_inset Flex Noun
20343 \begin_layout Plain Layout
20349 to make your working copy writable if it's readonly.
20351 \begin_inset Flex Noun
20354 \begin_layout Plain Layout
20360 operation is possible and that makes your working copy readonly again after
20361 transferring your changes to the repository.
20364 \begin_layout Standard
20365 More information about CVS can be found here
20366 \begin_inset Flex URL
20369 \begin_layout Plain Layout
20371 http://www.nongnu.org/cvs
20377 \begin_inset Flex URL
20380 \begin_layout Plain Layout
20382 http://ximbiot.com/cvs
20390 \begin_layout Standard
20395 to understand the sub-commands and the switches mentioned below.
20398 \begin_layout Subsubsection
20404 \begin_layout Standard
20405 If your document is not under revision control, this is the only item shown
20407 And if it is under revision control, the
20411 item is not visible.
20415 \begin_layout Standard
20416 This command registers in CVS your document
20417 \begin_inset Flex Strong
20420 \begin_layout Plain Layout
20428 in the case you have already the documents directory under CVS control
20434 This means you have to create or checkout the archive by yourself using
20436 (In case you forget that step \SpecialChar LyX
20437 registers the document with RCS.)
20440 \begin_layout Standard
20441 Then you are asked interactively to supply an initial description of the
20443 Don't forget that registered file is not yet checked in.
20446 \begin_layout Standard
20447 CVS command that is run:
20449 cvs -q add -m"<entered message>" "<file-name>"
20452 \begin_layout Standard
20457 above and for all other CVS commands is an abbreviation for
20458 \begin_inset Quotes eld
20461 change the current working directory to file location and use the file name
20462 without path component as argument
20463 \begin_inset Quotes erd
20469 \begin_layout Subsubsection
20475 \begin_layout Standard
20476 When you are finished editing a file, you commit your changes.
20477 When you do this and you had changed the document, you are asked for a
20478 description of the changes.
20479 After that changes are written to the repository.
20480 In case you didn't change the document and a reserved checkout is detected
20481 the reservation made on
20482 \begin_inset Flex Noun
20485 \begin_layout Plain Layout
20494 \begin_layout Labeling
20495 \labelwidthstring 00.00.0000
20497 \begin_inset space ~
20501 \begin_inset space ~
20505 \begin_inset Newline newline
20509 \begin_inset Flex Code
20512 \begin_layout Plain Layout
20515 -q commit -m"<description>" "<file-name>"
20521 \begin_inset Newline newline
20525 \begin_inset Flex Code
20528 \begin_layout Plain Layout
20539 \begin_layout Subsubsection
20545 \begin_layout Standard
20546 When you are sharing a repository with others, you may have to incorporate
20547 their changes into your working copy.
20550 \begin_layout Standard
20553 cvs -q update "<file-name>"
20556 \begin_layout Standard
20557 If a readonly checkout is detected the working copy is made writable and
20561 \begin_layout Standard
20564 cvs -q edit "<file-name>"
20567 \begin_layout Subsubsection
20570 Revert To Repository Version
20573 \begin_layout Standard
20574 This will discard all changes made to the document since the last check
20576 You get a warning before changes are discarded.
20577 Firstly the file is deleted, secondly CVS update command is run.
20580 \begin_layout Standard
20583 cvs -q update "<file-name>"
20586 \begin_layout Standard
20587 If a reserved checkout is detected and the working copy has no changes only
20588 the reservation is undone.
20591 \begin_layout Standard
20594 cvs -q unedit "<file-name>"
20597 \begin_layout Subsubsection
20603 \begin_layout Standard
20604 This will create a copy of the current document.
20605 Since CVS does not support copy operations natively, the version history
20606 is not preserved, and the copy is added as a new file.
20607 It requires a clean document without any changes since the last checkin.
20608 You are asked for a file name and a description of the copy operation.
20609 After that the copy is created, both locally and in the repository.
20610 If the parent directories of the copied and original document differ, all
20611 relative paths of included files of the copy are adjusted (like in
20613 File\SpecialChar menuseparator
20618 Finally, the copy is loaded instead of the original document.
20621 \begin_layout Labeling
20622 \labelwidthstring 00.00.0000
20624 \begin_inset space ~
20628 \begin_inset space ~
20632 \begin_inset Newline newline
20636 \begin_inset Flex Code
20639 \begin_layout Plain Layout
20646 \begin_inset Flex Code
20649 \begin_layout Plain Layout
20656 \begin_inset Newline newline
20660 \begin_inset Flex Code
20663 \begin_layout Plain Layout
20664 cvs -q add "<new-file-name>"
20672 \begin_layout Subsubsection
20678 \begin_layout Standard
20679 This will rename the current document.
20680 Since CVS does not support rename operations natively, the version history
20681 is not preserved, the renamed document is added as a new file, and the
20682 original document is deleted.
20683 It requires a clean document without any changes since the last checkin.
20684 You are asked for a file name and a description of the rename operation.
20685 After that the document is renamed, both locally and in the repository.
20686 If the parent directories of the new and old file names differ, all relative
20687 paths of included files are adjusted (like in
20689 File\SpecialChar menuseparator
20694 Finally, the document is reloaded using the new name.
20697 \begin_layout Labeling
20698 \labelwidthstring 00.00.0000
20700 \begin_inset space ~
20704 \begin_inset space ~
20708 \begin_inset Newline newline
20712 \begin_inset Flex Code
20715 \begin_layout Plain Layout
20722 \begin_inset Flex Code
20725 \begin_layout Plain Layout
20732 \begin_inset Newline newline
20736 \begin_inset Flex Code
20739 \begin_layout Plain Layout
20740 cvs -q add "<new-file-name>"
20746 \begin_inset Newline newline
20750 \begin_inset Flex Code
20753 \begin_layout Plain Layout
20754 cvs -q remove "<file-name>"
20762 \begin_layout Subsubsection
20763 Update of the local directory checkout from repository
20766 \begin_layout Standard
20767 Once your documents gets more complex, containing sub-documents and pictures,
20769 \begin_inset Flex Code
20772 \begin_layout Plain Layout
20778 files and so on using version control becomes more complicated.
20780 supports updating the whole tree in which resides the document.
20781 This become especially useful once you cooperate with people which neither
20782 have detailed knowledge about CVS usage nor they have ambition to commit
20783 additional material to the repository.
20784 You have to organize the files structure so that all external files are
20785 in the same directory or subdirectories of the document.
20786 It's good practice anyway to store multipart documents in an extra directory.
20789 \begin_layout Standard
20791 \begin_inset Flex Code
20794 \begin_layout Plain Layout
20795 Update local directory from repository
20800 command updates the whole directory.
20801 If local changes are detected user is warned before update starts.
20802 In case of merge conflicts both versions of the conflicting document parts
20803 are placed in the final document.
20804 You have to review and correct the result of the merge.
20805 You'll find the conflicts enclosed in pairs of
20806 \begin_inset Flex Code
20809 \begin_layout Plain Layout
20816 \begin_inset Flex Code
20819 \begin_layout Plain Layout
20826 \begin_inset Flex Code
20829 \begin_layout Plain Layout
20836 The first part is your version as before the update operation with the
20837 document name prepended.
20838 The second one is the repository version with the version number after
20840 \begin_inset Flex Code
20843 \begin_layout Plain Layout
20852 \begin_layout Labeling
20853 \labelwidthstring 00.00.0000
20855 \begin_inset space ~
20859 \begin_inset space ~
20863 \begin_inset Newline newline
20867 \begin_inset Flex Code
20870 \begin_layout Plain Layout
20878 (Ask if changes are detected.)
20879 \begin_inset Newline newline
20883 \begin_inset Flex Code
20886 \begin_layout Plain Layout
20887 cd $path; cvs -q update
20897 \begin_layout Standard
20899 \begin_inset Flex Code
20902 \begin_layout Plain Layout
20908 stands for the path to the document.
20911 \begin_layout Subsubsection
20917 \begin_layout Standard
20918 This shows the complete history of the CVS document.
20921 cvs log "<file-name>"
20923 is shown in a browser.
20926 \begin_layout Subsubsection
20930 \begin_layout Standard
20932 supports CVS version number, author name, date and time of last commit.
20933 All those are extracted from
20935 cvs log -r <file-name>
20939 \begin_inset CommandInset ref
20941 reference "subsec:VCS-Revision-Information"
20948 \begin_layout Subsection
20949 SVN commands in \SpecialChar LyX
20953 \begin_layout Standard
20954 SVN is now partially supported by \SpecialChar LyX
20956 You can find the commands in the
20958 File\SpecialChar menuseparator
20960 \begin_inset space ~
20966 Please note that if you use password protected access to repository via
20967 ssh, you will be asked in terminal window.
20969 was tested against SVN 1.5, 1.6, 1.7 and 1.8
20973 \begin_layout Plain Layout
20974 Most of the commands will work with 1.4 too, see
20975 \begin_inset CommandInset ref
20977 reference "subsec:SVN-Repo-Update"
20982 There seems to be currently unresolved permissions problem under SVN 1.8
20983 with reverting changes when file is locked.
20991 \begin_layout Subsubsection
20997 \begin_layout Standard
20998 If your document is not under revision control, this is the only item shown
21000 And if it is under revision control, the
21004 item is not visible.
21007 \begin_layout Standard
21008 This command registers in SVN your document ONLY in case you have already
21009 the documents directory under SVN control (in particular
21014 This means you have to checkout the archive by yourself.
21017 \begin_layout Standard
21018 Then you are asked interactively to supply an initial description of the
21020 Don't forget that registered file is not yet commited.
21023 \begin_layout Standard
21024 SVN command that is run:
21027 \begin_inset Quotes qld
21031 \begin_inset Quotes qld
21037 \begin_layout Standard
21042 to understand the switches.
21045 \begin_layout Subsubsection
21051 \begin_layout Standard
21052 When you are finished editing a file, you commit your changes.
21053 When you do this, you are asked for a description of the changes.
21054 After that changes are commited.
21057 \begin_layout Standard
21062 \begin_layout Plain Layout
21063 In case locking is not enabled.
21065 \begin_inset CommandInset ref
21067 reference "subsec:SVN-File-Locking"
21078 svn commit -q -m"<description>" <file-name>
21081 \begin_layout Subsubsection
21087 \begin_layout Standard
21088 Updates the changes of this file from the repository.
21089 Be sure you understand SVN merging and conflicts resolving before using
21090 this function, because all conflicts has to be resolved manually by you!
21093 \begin_layout Standard
21098 \begin_layout Plain Layout
21106 svn update --non-interactive
21107 \begin_inset Quotes qld
21111 \begin_inset Quotes qld
21117 \begin_layout Subsubsection
21120 Revert To Repository Version
21123 \begin_layout Standard
21124 This will discard all changes made to the document since the last check
21126 You get a warning before changes are discarded.
21129 \begin_layout Standard
21133 \begin_inset Quotes qld
21137 \begin_inset Quotes qld
21143 \begin_layout Subsubsection
21149 \begin_layout Standard
21150 This will create a copy of the current document including the version history.
21151 It requires a clean document without any changes since the last checkin.
21152 You are asked for a file name and a description of the copy operation.
21153 After that the copy is created, both locally and in the repository.
21154 If the parent directories of the copied and original document differ, all
21155 relative paths of included files of the copy are adjusted (like in
21157 File\SpecialChar menuseparator
21162 Finally, the copy is loaded instead of the original document.
21165 \begin_layout Labeling
21166 \labelwidthstring 00.00.0000
21168 \begin_inset space ~
21172 \begin_inset space ~
21176 \begin_inset Newline newline
21180 \begin_inset Flex Code
21183 \begin_layout Plain Layout
21187 \begin_inset Quotes qld
21191 \begin_inset Quotes qld
21195 \begin_inset Quotes qld
21199 \begin_inset Quotes qld
21208 \begin_inset Newline newline
21212 \begin_inset Flex Code
21215 \begin_layout Plain Layout
21224 \begin_layout Subsubsection
21230 \begin_layout Standard
21231 This will rename the current document including the version history.
21232 It requires a clean document without any changes since the last checkin.
21233 You are asked for a file name and a description of the rename operation.
21234 After that the document is renamed, both locally and in the repository.
21235 If the parent directories of the new and old file names differ, all relative
21236 paths of included files are adjusted (like in
21238 File\SpecialChar menuseparator
21243 Finally, the document is reloaded using the new name.
21246 \begin_layout Labeling
21247 \labelwidthstring 00.00.0000
21249 \begin_inset space ~
21253 \begin_inset space ~
21257 \begin_inset Newline newline
21261 \begin_inset Flex Code
21264 \begin_layout Plain Layout
21268 \begin_inset Quotes qld
21272 \begin_inset Quotes qld
21276 \begin_inset Quotes qld
21280 \begin_inset Quotes qld
21289 \begin_inset Newline newline
21293 \begin_inset Flex Code
21296 \begin_layout Plain Layout
21305 \begin_layout Subsubsection
21306 \begin_inset CommandInset label
21308 name "subsec:SVN-Repo-Update"
21312 Update of the local directory checkout from repository
21316 \begin_layout Plain Layout
21317 Note that this command will work only with subversion
21318 \begin_inset Formula $\geqq1.5$
21329 \begin_layout Standard
21330 All the commands above have one shortcoming – they deal with the current
21332 Once your document contains pictures, includes external
21333 \begin_inset Flex Code
21336 \begin_layout Plain Layout
21342 files and so on administration becomes more complicated.
21344 now supports updating the whole tree in which resides the document
21348 \begin_layout Plain Layout
21349 One need to organize the files structure so that all external files are
21350 in the same directory or subdirectories of the document.
21357 This become especially useful once you cooperate with people which neither
21358 know about subversion management nor they have ambition to commit additional
21359 material to the repository.
21363 \begin_layout Standard
21364 \begin_inset Flex Code
21367 \begin_layout Plain Layout
21368 Update local directory from repository
21373 command updates the whole directory and in case of merge conflicts local
21374 version of the files are left, so no unintended data loss occurs.
21375 If local changes are detected user is warned before update starts.
21378 \begin_layout Labeling
21379 \labelwidthstring 00.00.0000
21381 \begin_inset space ~
21385 \begin_inset space ~
21389 \begin_inset Newline newline
21393 \begin_inset Flex Code
21396 \begin_layout Plain Layout
21402 (Ask if changes are detected.)
21403 \begin_inset Newline newline
21407 \begin_inset Flex Code
21410 \begin_layout Plain Layout
21411 svn update --accept mine-full $path
21419 \begin_layout Standard
21421 \begin_inset Flex Code
21424 \begin_layout Plain Layout
21430 stands for the path to the document.
21433 \begin_layout Subsubsection
21439 \begin_layout Standard
21440 This shows the complete history of the SVN document.
21444 \begin_inset Quotes qld
21448 \begin_inset Quotes qld
21453 is shown in a browser.
21456 \begin_layout Subsubsection
21458 \begin_inset CommandInset label
21460 name "subsec:SVN-File-Locking"
21467 \begin_layout Standard
21468 The file exchange through various revision control systems brings the problem
21469 of merge conflicts in case two different users try to edit the same (parts
21471 When such a conflict happens it needs manual resolving and one reasonable
21472 alternative is to provide some kind of locking mechanism, which guarantees
21473 that only one user is allowed to edit file at the given time.
21476 \begin_layout Standard
21477 SVN has two such mechanisms to provide mutual exclusivity for file access
21478 – locks and automatic setting of write permissions (see sec.
21480 \begin_inset CommandInset ref
21482 reference "subsec:Automatical-Locking-Property"
21487 \begin_inset Flex Code
21490 \begin_layout Plain Layout
21500 \begin_layout Plain Layout
21501 \begin_inset Flex URL
21504 \begin_layout Plain Layout
21506 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21517 If this property is detected for a given document \SpecialChar LyX
21518 starts to use SVN locks
21519 for document editing automatically and the whole check-in/out mechanism
21520 switches to the same regimen as for RCS.
21521 This in particular means there are two different modes of file use in \SpecialChar LyX
21525 \begin_layout Itemize
21527 The loaded file is in the read-only mode.
21528 For editing on needs to check-out.
21533 consists of updating from the repository and gaining write lock.
21534 If the lock is not possible to obtain, we remain in unlocked state.
21537 \begin_layout Itemize
21539 The loaded file is in the
21540 \begin_inset Quotes els
21544 \begin_inset Quotes ers
21548 No other user is allowed to edit the file.
21553 consists of commiting changes and releasing write-lock.
21554 If no changes have been made to the document, no commit will be produced
21558 \begin_layout Plain Layout
21559 Don't be puzzled by the fact that you will be asked for commit message anyway.
21564 and only the write-lock will be released.
21567 \begin_layout Standard
21571 \begin_layout Labeling
21572 \labelwidthstring 00.00.0000
21575 svn commit -q -m"<description>" "<file-name>"
21576 \begin_inset Newline newline
21579 svn unlock "<file-name>"
21582 \begin_layout Labeling
21583 \labelwidthstring 00.00.0000
21586 svn update "<file-name>"
21587 \begin_inset Newline newline
21590 svn lock "<file-name>"
21593 \begin_layout Subsubsection
21596 \begin_inset CommandInset label
21598 name "subsec:Automatical-Locking-Property"
21604 Automatic Locking Property
21607 \begin_layout Standard
21608 The above mentioned automatic setting of write permissions of the .lyx file
21611 File\SpecialChar menuseparator
21613 \begin_inset space ~
21616 Control\SpecialChar menuseparator
21617 Use Locking Property
21620 This command is active only when the file is not locked on the svn server
21622 you need to check-out before proceeding).
21625 \begin_layout Labeling
21626 \labelwidthstring 00.00.0000
21628 \begin_inset space ~
21634 \begin_layout Labeling
21635 \labelwidthstring 00.00.0000
21638 svn propset svn:needs-lock ON "<file-name>"
21641 \begin_layout Labeling
21642 \labelwidthstring 00.00.0000
21645 svn propdel svn:needs-lock "<file-name>"
21648 \begin_layout Subsubsection
21649 \begin_inset CommandInset label
21651 name "subsec:VCS-Revision-Information"
21655 Revision Information in Documents
21658 \begin_layout Standard
21659 There are more possibilities how to activate revision information in our
21663 \begin_layout Itemize
21669 \begin_layout Itemize
21670 tree revision information (
21671 \begin_inset Flex Code
21674 \begin_layout Plain Layout
21681 The result is the output of the
21682 \begin_inset Flex Code
21685 \begin_layout Plain Layout
21691 command, the following table gives you an idea, how to read the results.
21694 \begin_layout Standard
21696 \begin_inset Tabular
21697 <lyxtabular version="3" rows="6" columns="2">
21698 <features tabularvalignment="middle">
21699 <column alignment="left" valignment="top">
21700 <column alignment="left" valignment="top">
21702 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21705 \begin_layout Plain Layout
21713 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21716 \begin_layout Plain Layout
21726 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21729 \begin_layout Plain Layout
21735 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21738 \begin_layout Plain Layout
21739 mixed revision working copy
21746 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21749 \begin_layout Plain Layout
21755 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21758 \begin_layout Plain Layout
21759 modified working copy
21766 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21769 \begin_layout Plain Layout
21775 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21778 \begin_layout Plain Layout
21779 switched working copy
21786 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21789 \begin_layout Plain Layout
21795 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
21798 \begin_layout Plain Layout
21799 partial working copy, from a sparse checkout
21806 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21809 \begin_layout Plain Layout
21815 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21818 \begin_layout Plain Layout
21819 mixed revision, modified, switched working copy
21832 \begin_layout Itemize
21833 file revision information.
21834 The result comes from parsing the output of
21835 \begin_inset Flex Code
21838 \begin_layout Plain Layout
21840 \begin_inset space ~
21844 \begin_inset space ~
21848 \begin_inset space ~
21857 Supported flags are:
21861 \begin_layout Itemize
21862 version number of the last commit (
21863 \begin_inset Flex Code
21866 \begin_layout Plain Layout
21875 \begin_layout Itemize
21876 author of the last commit (
21877 \begin_inset Flex Code
21880 \begin_layout Plain Layout
21889 \begin_layout Itemize
21890 date of the last commit (
21891 \begin_inset Flex Code
21894 \begin_layout Plain Layout
21903 \begin_layout Itemize
21904 time of the last commit (
21905 \begin_inset Flex Code
21908 \begin_layout Plain Layout
21918 \begin_layout Standard
21919 You can obtain this info via InsetInfo (
21920 \change_inserted 5863208 1564400022
21923 Insert\SpecialChar menuseparator
21924 Field\SpecialChar menuseparator
21925 Version Control Revision
21926 \change_deleted 5863208 1564399852
21931 \begin_inset Flex Code
21934 \begin_layout Plain Layout
21935 info-insert buffer vcs-date
21943 The information will be available only when you have the file stored under
21944 svn managment (i.e.
21946 \begin_inset Flex Code
21949 \begin_layout Plain Layout
21955 directory is available with your document).
21959 \begin_layout Itemize
21960 Another—a hacking one—possibility is to use svn keywords
21964 \begin_layout Plain Layout
21965 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
21971 In short – you set file keywords property (e.g.
21974 svn propset svn:keywords 'Rev' file.lyx
21976 ) and then paste keyword \SpecialChar TeX
21981 \begin_layout Plain Layout
21982 This is an easy way how to ensure that \SpecialChar LyX
21983 won't break the line in the middle
21989 tag in your document (e.g.
21991 \begin_inset Flex Code
21994 \begin_layout Plain Layout
22001 This way svn client will automatically substitute revision number (e.g.
22003 \begin_inset Flex Code
22006 \begin_layout Plain Layout
22012 ) after each update and commit.
22013 There are more problems with this approach.
22014 Firstly, the '$' character is used in \SpecialChar TeX
22015 world for math equations, so any
22016 occurence of math formula
22017 \begin_inset Formula $Rev$
22021 \begin_inset Formula $Rev:59$
22024 in your \SpecialChar LyX
22026 Similarly for other keywords like Id, Date, Author, etc.
22027 Secondly svn output is dependent on your locales, so its very easy that
22028 svn would produce some problematic strings once Date is used.
22029 Thirdly you get the whole 'Rev: 59' string in your document instead of
22031 Until subversion implements user's custom keywords it will be hard to use
22032 this approach reliably or let \SpecialChar LyX
22033 to support it directly.
22036 \begin_layout Subsection
22037 SVN and Windows Environment
22040 \begin_layout Quote
22041 My inclination is to say that if the user cannot figure out the command
22042 line operations on their own fairly quickly, they would be well advised
22043 to use TortoiseSVN.
22049 \begin_layout Subsubsection
22053 \begin_layout Standard
22054 In addition to installing \SpecialChar LyX
22055 , and having access to a Subversion repository,
22056 the user will need to install the Subversion client program.
22057 A Windows installer for the client program is available from
22058 \begin_inset CommandInset href
22061 target "http://www.collab.net/nonav/downloads/subversion/"
22067 The user may also want to install
22068 \begin_inset CommandInset href
22071 target "http://tortoisesvn.tigris.org/"
22076 , which integrates Subversion operations into the context (rightclick) menu
22077 of Windows Explorer.
22078 Operations done outside \SpecialChar LyX
22079 will typically be more convenient using the Explorer
22081 Note that TortoiseSVN is not a replacement for the client program, which
22082 is what \SpecialChar LyX
22086 \begin_layout Subsubsection
22087 Bringing a document under Subversion control
22090 \begin_layout Standard
22091 Before a \SpecialChar LyX
22092 document can be brought under version control in Subversion, its
22093 parent directory needs to be under version control.
22094 If the document is being added to a project already in the repository,
22095 this is accomplished by checking the project out to the directory where
22096 the new document will be placed.
22097 If the project itself is not yet under version control (for instance, if
22098 this document starts a new project), the directory must be imported into
22100 This is done outside \SpecialChar LyX
22102 Both import and checkout are easily accomplished from the Explorer context
22103 menu using TortoiseSVN, or alternatively can be done using the command
22104 line client at a DOS prompt.
22105 The procedure for importing the project using TortoiseSVN is described
22106 below, assuming an existing repository and a new project being started
22114 For information on using the Subversion client program, run
22121 \begin_layout Enumerate
22128 in Windows Explorer, right click it, and select
22130 TortoiseSVN\SpecialChar menuseparator
22134 If necessary, adjust the URL for the repository, then click OK.
22137 \begin_layout Enumerate
22138 Right click the level of the repository under which you want to place the
22139 new project folder (typically the top level) and click
22143 Supply a name for the project folder and click OK.
22144 Add a message for the log file if desired, then click OK again.
22145 The new project folder should appear in the repository.
22146 Finally, click OK again to exit the repository browser.
22149 \begin_layout Enumerate
22150 Once again right click
22156 , this time selecting SVN Checkout\SpecialChar ldots
22157 Select the URL of the project folder
22158 you just created in the repository, and set the checkout directory to
22166 You will be warned about a non-empty folder; click OK to proceed.
22167 You should now have a
22178 \begin_layout Enumerate
22179 Create or open your document in \SpecialChar LyX
22182 File\SpecialChar menuseparator
22184 \begin_inset space ~
22187 Control\SpecialChar menuseparator
22191 Add a log message and click OK to commit the document to version control.
22194 \begin_layout Standard
22195 From this point onward, you should have full functionality in the
22197 File\SpecialChar menuseparator
22199 \begin_inset space ~
22205 You also have the option of checking the document in and out, viewing its
22207 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22208 client program from a command prompt.
22211 \begin_layout Subsubsection
22212 SSH tunnel used with SVN under Windows
22215 \begin_layout Standard
22216 Compared with Linux setting up an svn client to communicate over ssh under
22217 Windows is a rather troublesome task.
22218 We will at least offer some hints how to setup the client side but prior
22219 knowledge about ssh and the Windows command line is needed, also be prepared
22220 for a great deal of frustration\SpecialChar ldots
22224 \begin_layout Enumerate
22225 Get an svn client for windows, as described in the previous sections.
22226 When it is a fresh install run some svn command (e.g.
22228 \begin_inset Flex Code
22231 \begin_layout Plain Layout
22237 ) to create config files, which you will need to change later on.
22240 \begin_layout Enumerate
22241 Choose an ssh client for Windows.
22242 There are several possibilities, we will use the one from Putty tools
22246 \begin_layout Plain Layout
22247 \begin_inset Flex URL
22250 \begin_layout Plain Layout
22252 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22263 You will need to set the connection up so that the client doesn't ask for
22264 any password from you.
22265 To keep things easy we will use only keys without any additional password
22270 \begin_layout Enumerate
22272 \begin_inset Flex Code
22275 \begin_layout Plain Layout
22282 Save your private .ppk key file and put the public one on the server side.
22283 If the SVN server runs on Linux, note that the format of the public key
22284 is not compatible with Linux openssh and you will need to direcly copy-paste
22286 \begin_inset Quotes eld
22291 Public key for pasting into OpenSSH authorized_keys file
22294 \begin_inset Quotes erd
22297 edit field into the server's
22298 \begin_inset Flex Code
22301 \begin_layout Plain Layout
22302 ~/.ssh/authorized_keys
22308 \begin_inset Flex Code
22311 \begin_layout Plain Layout
22320 \begin_layout Enumerate
22322 \begin_inset Flex Code
22325 \begin_layout Plain Layout
22332 In the SVN config file
22336 \begin_layout Plain Layout
22337 Exact path depends on Windows version, usually somewhere around
22338 \begin_inset Flex Code
22341 \begin_layout Plain Layout
22344 Documents and Settings
22358 \begin_inset Flex Code
22361 \begin_layout Plain Layout
22376 , section [tunnels], setup ssh command, e.g.
22378 \begin_inset Flex Code
22381 \begin_layout Plain Layout
22382 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22391 \begin_layout Plain Layout
22392 It will usually take a lot of time to get exact command right and it depends
22394 For example do not have some remote server saved as a default session in
22396 If things fail, try to connect via plink without SVN first.
22405 \begin_layout Enumerate
22406 Checkout the SVN archive, e.
22407 \begin_inset space \thinspace{}
22411 \begin_inset Newline newline
22415 \begin_inset Flex Code
22418 \begin_layout Plain Layout
22419 svn co svn+ssh://user@server/repository_path
22427 \begin_layout Subsubsection
22428 End-of-Line Conversions
22431 \begin_layout Standard
22432 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22434 use different line endings inside the .lyx files.
22435 This is not a problem as far as \SpecialChar LyX
22436 functionality is concerned, but the commit
22437 diffs will be huge and merge-conflicts prone.
22438 Fortunately SVN itself knows
22442 \begin_layout Plain Layout
22443 \begin_inset Flex URL
22446 \begin_layout Plain Layout
22448 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22458 how to deal with CR/LF problems when switching .lyx files to the
22459 \begin_inset Flex Code
22462 \begin_layout Plain Layout
22472 \begin_layout Plain Layout
22474 \begin_inset Flex Code
22477 \begin_layout Plain Layout
22478 svn propset svn:eol-style native FILE_NAME
22491 \begin_layout Subsection
22492 GIT commands in \SpecialChar LyX
22496 \begin_layout Standard
22497 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22499 You can find the commands in the
22501 File\SpecialChar menuseparator
22503 \begin_inset space ~
22509 Please note that if you use password protected access to repository via
22510 ssh, you will be asked in terminal window.
22512 was tested against GIT 1.7.
22516 \begin_layout Plain Layout
22517 Windows users please note that you need to ensure that git is on the path.
22518 This can be set from within \SpecialChar LyX
22521 Tools\SpecialChar menuseparator
22522 Preferences\SpecialChar menuseparator
22523 Paths\SpecialChar menuseparator
22534 \begin_layout Standard
22535 One big difference of GIT and the other supported version control systems
22536 is the distributed nature of GIT: With traditional version control systems
22537 there is one central server which hosts the repository.
22538 Users commit their changes to the server, and get updates made by other
22540 With GIT, users commit to a local repository.
22541 The local repository can be synchronized with one or more remote repositories
22543 \begin_inset Flex Code
22546 \begin_layout Plain Layout
22553 \begin_inset Flex Code
22556 \begin_layout Plain Layout
22564 does not interact in any way with remote GIT repositories.
22565 It works exclusively with the local repository in a very similar way as
22566 with a central CVS or SVN repository.
22567 If you use remote GIT repositories you need to do the
22568 \begin_inset Flex Code
22571 \begin_layout Plain Layout
22578 \begin_inset Flex Code
22581 \begin_layout Plain Layout
22587 operations with your favourite GIT client.
22590 \begin_layout Subsubsection
22596 \begin_layout Standard
22597 If your document is not under revision control, this is the only item shown
22599 And if it is under revision control, the
22603 item is not visible.
22606 \begin_layout Standard
22607 This command registers in GIT your document ONLY in case you have already
22608 the documents directory under GIT control (in particular
22613 This means you have to checkout the archive by yourself.
22616 \begin_layout Standard
22617 Then you are asked interactively to supply an initial description of the
22619 Don't forget that registered file is not yet committed.
22622 \begin_layout Standard
22623 GIT command that is run:
22626 \begin_inset Quotes qld
22630 \begin_inset Quotes qld
22636 \begin_layout Standard
22641 to understand the switches.
22644 \begin_layout Subsubsection
22650 \begin_layout Standard
22651 When you are finished editing a file, you commit your changes.
22652 When you do this, you are asked for a description of the changes.
22653 After that changes are committed.
22656 \begin_layout Standard
22659 git commit -q -m"<description>" <file-name>
22662 \begin_layout Subsubsection
22665 Revert To Repository Version
22668 \begin_layout Standard
22669 This will discard all changes made to the document since the last check
22671 You get a warning before changes are discarded.
22674 \begin_layout Standard
22678 \begin_inset Quotes qld
22682 \begin_inset Quotes qld
22688 \begin_layout Subsubsection
22694 \begin_layout Standard
22695 This will rename the current document including the version history.
22696 It requires a clean document without any changes since the last checkin.
22697 You are asked for a file name and a description of the rename operation.
22698 After that the document is renamed, both locally and in the repository.
22699 If the parent directories of the new and old file names differ, all relative
22700 paths of included files are adjusted (like in
22702 File\SpecialChar menuseparator
22707 Finally, the document is reloaded using the new name.
22710 \begin_layout Labeling
22711 \labelwidthstring 00.00.0000
22713 \begin_inset space ~
22717 \begin_inset space ~
22721 \begin_inset Newline newline
22725 \begin_inset Flex Code
22728 \begin_layout Plain Layout
22732 \begin_inset Quotes qld
22736 \begin_inset Quotes qld
22740 \begin_inset Quotes qld
22744 \begin_inset Quotes qld
22753 \begin_inset Newline newline
22757 \begin_inset Flex Code
22760 \begin_layout Plain Layout
22769 \begin_layout Subsubsection
22775 \begin_layout Standard
22776 This shows the complete history of the GIT document.
22780 \begin_inset Quotes qld
22784 \begin_inset Quotes qld
22789 is shown in a browser.
22792 \begin_layout Subsubsection
22796 \begin_layout Standard
22798 supports GIT hash number of the last commit to the file,
22799 \change_inserted 1119979965 1564297456
22800 its abbreviated form,
22802 author name, date and time of last commit.
22803 All those are extracted from
22805 git log -n 1 --pretty=format:%H%n
22806 \change_inserted 1119979965 1564297427
22812 Tree version information is obtained via
22814 git describe --abbrev --dirty --long
22818 \begin_inset CommandInset ref
22820 reference "subsec:VCS-Revision-Information"
22827 \begin_layout Subsection
22831 \begin_layout Standard
22832 With the recent addition of the
22833 \begin_inset Flex Code
22836 \begin_layout Plain Layout
22842 function \SpecialChar LyX
22843 power users are allowed to create their own commands for revision
22847 \begin_layout Standard
22848 As an example you can see how two TortoiseSVN commands could be integrated
22852 \begin_layout Description
22854 \begin_inset Flex Code
22857 \begin_layout Plain Layout
22858 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
22866 \begin_layout Description
22868 \begin_inset Flex Code
22871 \begin_layout Plain Layout
22872 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
22880 \begin_layout Subsection
22881 Version control and Document comparison
22884 \begin_layout Standard
22885 One of the typical uses of version control is to inspect the changes between
22886 revisions, usually by creating
22887 \begin_inset Flex Code
22890 \begin_layout Plain Layout
22897 While this is useful for plain text files, it is much less useful in the
22898 case of \SpecialChar LyX
22899 files, which have more a complicated structure.
22900 Hence we provide binding to the Document comparison feature.
22901 There are two ways of calling this feature – either by direct call of
22902 \begin_inset Flex Code
22905 \begin_layout Plain Layout
22912 function (for details see \SpecialChar LyX
22913 functions manual) or by the toolbar icon
22926 One can either compare two chosen revisions of the document or he can simply
22927 compare the current version of edited text with older revisions (where
22929 \begin_inset Flex Noun
22932 \begin_layout Plain Layout
22938 ' revisions back means comparison of the edited file with last commited
22943 \begin_layout Standard
22944 This feature is supported for SVN and RCS though due to the more complicated
22945 versioning scheme of RCS there is a constraint – when addressing the revisions
22946 in dialog, numbers always point to the last number in RCS revision number,
22949 We don't currently support GIT addressing of revisions, one can just compare
22950 edited document with its revision X steps backs, where X is addressed as
22952 \begin_inset Flex Code
22955 \begin_layout Plain Layout
22964 \begin_layout Section
22965 Literate Programming
22968 \begin_layout Standard
22973 (kayvan@sylvan.com)
22977 original documentation written by
22979 Edmar Wienskoski Jr.
22982 (edmar-w-jr@technologist.com)
22985 \begin_layout Subsection
22989 \begin_layout Standard
22990 The main purpose of this documentation is to show you how to use \SpecialChar LyX
22992 programming, where it is assumed that you are familiar with this programming
22993 technique, and know what
22994 \begin_inset Quotes eld
22998 \begin_inset Quotes erd
23002 \begin_inset Quotes eld
23006 \begin_inset Quotes erd
23010 If that is not the case, please follow the web links provided in the following
23012 There is a lot of good documentation out there covering old development
23013 history to the latest tools tips.
23016 \begin_layout Standard
23017 It is also assumed that you are familiar with \SpecialChar LyX
23018 itself to a point that you
23019 are comfortable changing your \SpecialChar LyX
23020 preferences, and X resources file.
23021 If that is not the case please refer to other \SpecialChar LyX
23022 documentation to cover your
23026 \begin_layout Subsection
23027 Literate Programming
23030 \begin_layout Standard
23031 From the Literate Programming FAQ:
23034 \begin_layout Quotation
23035 Literate programming is the combination of documentation and source together
23036 in a fashion suited for reading by human beings.
23037 In fact, literate programs should be enjoyable reading, even inviting!
23038 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23039 and documentation in a single file.
23040 Literate programming tools then parse the file to produce either readable
23041 documentation or compilable source.
23042 The WEB style of literate programming was created by D.
23043 \begin_inset space \thinspace{}
23047 Knuth during the development of his \SpecialChar TeX
23048 typesetting software.
23052 \begin_layout Standard
23053 Another excerpt says:
23056 \begin_layout Quotation
23059 How is literate programming different from verbose commenting?
23062 \begin_layout Quotation
23063 There are three distinguishing characteristics.
23064 In order of importance, they are:
23068 \begin_layout Itemize
23069 flexible order of elaboration
23072 \begin_layout Itemize
23073 automatic support for browsing
23076 \begin_layout Itemize
23077 typeset documentation, especially diagrams and mathematics
23081 \begin_layout Standard
23082 Now that I sparked your curiosity, take a look in the references.
23085 \begin_layout Subsubsection
23089 \begin_layout Standard
23090 The complete Literate Programming FAQ can be found at:
23093 \begin_layout Quote
23094 Literate Programming FAQ
23095 \begin_inset Flex URL
23098 \begin_layout Plain Layout
23100 http://www.literateprogramming.com/lpfaq.pdf
23108 \begin_layout Standard
23109 The FAQ lists 23 (twenty three!) different literate programming tools.
23110 Where some are specialized or
23111 \begin_inset Quotes eld
23115 \begin_inset Quotes erd
23118 for particular programming languages, while other have general scope.
23123 for my own use for several reasons:
23126 \begin_layout Itemize
23127 It can generate the documentation either in \SpecialChar LaTeX
23131 \begin_layout Itemize
23132 It has a open architecture, i.
23133 \begin_inset space \thinspace{}
23137 \begin_inset space \space{}
23140 it is easy to plug in new filters
23144 \begin_layout Plain Layout
23149 are programs that read a given data stream and output a manipulated data
23151 That way, a WEB file (consisting of literate code) can be turned into a
23152 file consisting only of C program code or \SpecialChar LaTeX
23158 and to perform special processing that you may need.
23162 \begin_layout Itemize
23163 There is a good selection of filters available already (the HTML is one
23167 \begin_layout Itemize
23171 \begin_layout Standard
23172 The Noweb web page can be found at:
23175 \begin_layout Quote
23177 \begin_inset Flex URL
23180 \begin_layout Plain Layout
23182 https://www.cs.tufts.edu/~nr/noweb/
23190 \begin_layout Standard
23191 Starting from there you can reach many other interesting links and even
23192 some literate program examples.
23195 \begin_layout Subsection
23197 and Literate Programming with Noweb
23200 \begin_layout Standard
23201 The \SpecialChar LyX
23202 support for Literate Programming is provided by using the generic \SpecialChar LyX
23204 converters mechanism.
23205 This support is provided in a
23206 \begin_inset Quotes eld
23210 \begin_inset Quotes erd
23214 \begin_inset space \thinspace{}
23218 \begin_inset space \space{}
23221 you will be able to use this new \SpecialChar LyX
23222 feature with some other literate programming
23223 tool of your choice by just changing your \SpecialChar LyX
23227 \begin_layout Subsubsection
23228 Generating documents and code (weaving and tangling)
23231 \begin_layout Paragraph
23232 Using the noweb module
23235 \begin_layout Standard
23236 If you have installed Noweb and \SpecialChar LyX
23237 successfully, whenever you open a new document,
23238 after you have chosen its document class, use the
23240 Document\SpecialChar menuseparator
23244 \begin_inset Quotes eld
23248 \begin_inset Quotes erd
23252 If Noweb is correctly installed, when you click on the
23253 \begin_inset Quotes eld
23257 \begin_inset Quotes erd
23260 link, you will see the
23261 \begin_inset Quotes eld
23265 \begin_inset Quotes erd
23268 module in the available list and you can add it to your document.
23271 \begin_layout Paragraph
23275 \begin_layout Standard
23277 enables you to write code with a custom inset named
23278 \begin_inset Flex Noun
23281 \begin_layout Plain Layout
23288 Noweb delimits chunks like this:
23291 \begin_layout LyX-Code
23295 \begin_layout LyX-Code
23299 \begin_layout LyX-Code
23303 \begin_layout LyX-Code
23307 \begin_layout LyX-Code
23311 \begin_layout Standard
23312 The problem is that whatever is written in between the << and the
23316 must be taken literally, i.
23317 \begin_inset space \thinspace{}
23321 \begin_inset space \space{}
23325 should be prevented from making any special interpretation of what has
23327 This is also handled by
23328 \begin_inset Flex Noun
23331 \begin_layout Plain Layout
23337 , that works like a normal text inset but has a free spacing capability.
23340 \begin_layout Standard
23341 As a special note, you can also use the
23342 \begin_inset Quotes eld
23346 \begin_inset Quotes erd
23349 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23353 \begin_layout LyX-Code
23357 \begin_layout LyX-Code
23358 def some_function(args):
23361 \begin_layout LyX-Code
23362 "This is the doc string for this function."
23365 \begin_layout LyX-Code
23366 print "My args: ", args
23369 \begin_layout LyX-Code
23370 @ %def some_function
23373 \begin_layout Standard
23374 For an example of this usage and the resulting cross-reference output, look
23375 at the Literate python program in
23377 LIBDIR/examples/listerrors.lyx
23379 which should make this all clear.
23382 \begin_layout Paragraph
23383 Generating the documentation
23386 \begin_layout Standard
23387 At this point you already have a new document file with a proper document
23388 class, and with some code and text on it.
23389 How do I print it? The answer is simple, you select
23391 View\SpecialChar menuseparator
23395 Just like you would do for a plain document.
23396 No special procedure is required.
23399 \begin_layout Standard
23400 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23404 \begin_layout Enumerate
23407 Update\SpecialChar menuseparator
23410 menu option is chosen, a \SpecialChar LaTeX
23416 \begin_layout Standard
23417 If the document is of any literate class the generated file will be named
23418 with an extension name defined by the
23419 \begin_inset Quotes eld
23423 \begin_inset Quotes erd
23426 format (defined in the Preferences panel), otherwise the file will have
23435 \begin_layout Enumerate
23436 Note that the only difference so far is in the name of the file, no special
23437 processing is required by \SpecialChar LyX
23439 Given that you formatted the code using the
23440 \begin_inset Flex Noun
23443 \begin_layout Plain Layout
23449 inset that, by itself, takes care of the business.
23452 \begin_layout Enumerate
23453 If the document is of any literate class \SpecialChar LyX
23454 will then use the internal \SpecialChar LyX
23456 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23461 \begin_layout Plain Layout
23462 The converters are defined in the
23464 Tools\SpecialChar menuseparator
23468 \begin_inset Quotes eld
23472 \begin_inset Quotes erd
23484 manual for general information about converters.
23489 to generate the \SpecialChar LaTeX
23494 \begin_layout Standard
23495 Otherwise it will just skip this step.
23499 \begin_layout Enumerate
23500 Finally, \SpecialChar LaTeX
23501 is invoked and the regular post processing continues as in a plain
23505 \begin_layout Standard
23506 Independence from a particular
23507 \begin_inset Quotes eld
23511 \begin_inset Quotes erd
23514 is easily achieved by changing the commands that are run by the various
23518 \begin_layout Paragraph
23519 Generating the code
23522 \begin_layout Standard
23523 When the build menu option is chosen or the corresponding button in the
23524 toolbar is pressed, a \SpecialChar LaTeX
23525 file is generated just like step 1 above.
23526 Next, \SpecialChar LyX
23532 This converter needs to be defined by the user and is not installed by
23533 default, though the Program format is.
23534 This converter (like any other converter) will have two parts:
23537 \begin_layout Enumerate
23538 The converter program itself.
23539 This program performs the conversion from the one format to the other (in
23540 this case, from the Noweb format to the Program pseudo-format).
23543 \begin_layout Enumerate
23544 The error log parser.
23545 This is a program whose sole purpose is to rewrite error messages in a
23546 format that \SpecialChar LyX
23548 This makes it possible for \SpecialChar LyX
23549 to place error boxes in the right places in
23553 \begin_layout Standard
23554 The first part, the
23555 \begin_inset Quotes eld
23559 \begin_inset Quotes erd
23562 setting, should be set to
23565 \begin_layout LyX-Code
23573 \begin_layout Standard
23574 This basically means that \SpecialChar LyX
23576 \begin_inset Quotes eld
23580 \begin_inset Quotes erd
23583 (a program or script) with the name of the Noweb file (normally a file
23584 in the \SpecialChar LyX
23585 temp directory) and the directory path of the original \SpecialChar LyX
23590 \begin_layout Standard
23591 This is an implementation of
23592 \begin_inset Quotes eld
23596 \begin_inset Quotes erd
23599 that you can place in a directory on your path:
23602 \begin_layout LyX-Code
23608 \begin_layout LyX-Code
23614 \begin_layout LyX-Code
23617 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23620 \begin_layout Standard
23621 The next part of the converter setting is the
23622 \begin_inset Quotes eld
23626 \begin_inset Quotes erd
23629 which is to be set to
23632 \begin_layout LyX-Code
23635 parselog=$$s/scripts/listerrors
23638 \begin_layout Standard
23639 This will run any errors that are generated by the
23640 \begin_inset Quotes eld
23644 \begin_inset Quotes erd
23647 process through the
23648 \begin_inset Quotes eld
23652 \begin_inset Quotes erd
23658 \begin_layout Standard
23659 The build will normally take place in \SpecialChar LyX
23660 's temporary directory, so the files
23661 produced by the conversion will be in that directory.
23663 will copy out what it regards as the `main' file, but the
23667 conversion may produce several files, and so most of these would then be
23668 deleted when \SpecialChar LyX
23670 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23671 the build-script chunk can place the generated files in that location.
23674 \begin_layout Paragraph
23675 Build instructions in the document
23678 \begin_layout Standard
23679 The last piece of the integration between \SpecialChar LyX
23681 \begin_inset Quotes eld
23685 \begin_inset Quotes erd
23689 Generally, the instructions for building your program should be embedded
23690 in a chunk of its own.
23692 \begin_inset Quotes eld
23696 \begin_inset Quotes erd
23699 above uses the notangle command to look for this chunk (called
23700 \begin_inset Quotes eld
23704 \begin_inset Quotes erd
23707 ) and runs its contents through
23708 \begin_inset Quotes eld
23712 \begin_inset Quotes erd
23718 \begin_layout Standard
23719 Typically, such a chunk would look something like this:
23722 \begin_layout LyX-Code
23726 \begin_layout LyX-Code
23728 \begin_inset Newline newline
23731 if [ -z "${NOWEB_SOURCE}" ]
23732 \begin_inset Newline newline
23738 \begin_layout LyX-Code
23739 NOWEB_SOURCE=myfile.nw
23740 \begin_inset Newline newline
23744 \begin_inset Newline newline
23748 code to extract files ...
23749 use NOWEB_OUTPUT_DIR here ...]
23750 \begin_inset Newline newline
23754 code to compile files ...]
23755 \begin_inset Newline newline
23761 \begin_layout Standard
23764 LIBDIR/examples/listerrors.lyx
23768 LIBDIR/examples/Literate.lyx
23770 which implement two versions of the
23771 \begin_inset Quotes eld
23775 \begin_inset Quotes erd
23778 program for some illustrations of how all of these pieces go together or
23781 LIBDIR/examples/noweb2lyx.lyx.
23784 Interestingly, these three files show off the language-indepence of the
23786 literate programming support since they are written in Python, C and Perl
23790 \begin_layout Subsubsection
23791 Configuring \SpecialChar LyX
23795 \begin_layout Standard
23796 All the Literate Programming support is configured by the
23798 Tools\SpecialChar menuseparator
23802 \begin_inset Quotes eld
23806 \begin_inset Quotes erd
23810 The important parts are:
23813 \begin_layout Description
23815 \begin_inset space ~
23819 \begin_inset Quotes eld
23823 \begin_inset Quotes erd
23827 \begin_inset space ~
23830 format Set up via the File Formats tab, this is where the Noweb-specific
23840 , the file extension is set to
23845 This tells \SpecialChar LyX
23846 to create a file with a
23850 extension in the first step of the conversion process.
23853 \begin_layout Description
23855 \begin_inset space ~
23863 \begin_inset space ~
23866 format This is an empty format whose sole purpose is to be the endpoint
23867 of a conversion (which then allows us to set up a converter for it).
23870 \begin_layout Description
23880 This converter performs the
23881 \begin_inset Quotes eld
23885 \begin_inset Quotes erd
23888 of the literate document.
23889 For Noweb, it is set to
23890 \begin_inset Quotes eld
23895 noweave -delay -index $$i > $$o
23898 \begin_inset Quotes erd
23904 \begin_layout Description
23914 \begin_inset Quotes eld
23918 \begin_inset Quotes erd
23922 As stated above, the Converter is set to
23923 \begin_inset Quotes eld
23931 \begin_inset Quotes erd
23934 , with Flags set to
23935 \begin_inset Newline newline
23939 \begin_inset Quotes eld
23944 parselog=$$s/scripts/listerrors
23947 \begin_inset Quotes erd
23953 \begin_layout Subsubsection
23957 \begin_layout Standard
23958 There is also a new function implemented in the \SpecialChar LyX
23960 \begin_inset Quotes eld
23963 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
23967 \begin_layout Standard
23968 When debugging code with ddd/gdb, it is possible to invoke a text editor
23969 at the current execution position with a single key stroke.
23970 The default ddd configuration for that is shift-ctrl-V.
23971 It happens that you can define the editor command line invocation in ddd
23974 Edit\SpecialChar menuseparator
23975 Preferences\SpecialChar menuseparator
23978 dialog and changing the "Edit Sources" entry.
23981 \begin_layout Standard
23982 I take advantage of the newly created \SpecialChar LyX
23983 server function and this ddd feature,
23985 \begin_inset Quotes eld
23989 \begin_inset Quotes erd
23995 \begin_layout LyX-Code
23996 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
23999 \begin_layout Standard
24000 With this, whenever you are using ddd and find a point in the program that
24001 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24002 ddd will forward this information to \SpecialChar LyX
24003 through the \SpecialChar LyX
24004 server and then the
24006 window will show the same file with the cursor at the same position ddd
24008 No more guessing or long scrolling to locate a point in the program back
24012 \begin_layout Standard
24013 Note however that you must enable the \SpecialChar LyX
24014 server to get this feature working
24015 (it is disabled by default).
24017 \begin_inset space ~
24021 \begin_inset CommandInset ref
24023 reference "sec:Starting-the-Server"
24027 explains how to do that.
24030 \begin_layout Subsubsection
24034 \begin_layout Standard
24035 There are six new buttons that can be added to your \SpecialChar LyX
24037 Four of these buttons are short cuts to layout styles:
24055 , one for the custom inset
24060 The last one is a short cut to the
24061 \begin_inset Quotes eld
24065 \begin_inset Quotes erd
24072 \begin_layout Standard
24074 has a range of buttons that are available for tool bar customization.
24075 In my toolbar I like to combine the six short cuts above with two more:
24080 \SpecialChar menuseparator
24085 \SpecialChar menuseparator
24092 Document\SpecialChar menuseparator
24093 View\SpecialChar menuseparator
24097 Here is how it looks like:
24100 \begin_layout LyX-Code
24104 \begin_layout LyX-Code
24108 \begin_layout LyX-Code
24109 Icon "layout Standard"
24112 \begin_layout LyX-Code
24113 Icon "layout Section"
24116 \begin_layout LyX-Code
24117 Icon "layout \SpecialChar LaTeX
24121 \begin_layout LyX-Code
24122 Icon "layout \SpecialChar LyX
24126 \begin_layout LyX-Code
24127 Icon "flex.insert Chunk"
24130 \begin_layout LyX-Code
24134 \begin_layout LyX-Code
24138 \begin_layout LyX-Code
24139 Icon "buffer-typeset"
24142 \begin_layout LyX-Code
24143 Icon "build-program"
24146 \begin_layout LyX-Code
24150 \begin_layout LyX-Code
24154 \begin_layout LyX-Code
24158 \begin_layout LyX-Code
24162 \begin_layout LyX-Code
24166 \begin_layout Subsubsection
24167 Colors customization
24170 \begin_layout Standard
24171 There are a number of colors in \SpecialChar LyX
24172 that can be customized in
24177 One of the things that bothers people is the \SpecialChar LaTeX
24179 The default color is red, since the chunks uses \SpecialChar LaTeX
24180 font, and there is a lot
24181 of chunks in literate documents, you may get tired of seeing everything
24183 You can change it by going to the tabs
24192 \begin_layout Standard
24193 The next thing is the visible presence of the newline character in the screen.
24194 You can choose the color of this particular character and make it blend
24196 I recommend you choosing a color that is close to the background but not
24197 equal, that way you still can see it is there, but it is not bothering
24201 \begin_layout Subsection
24206 \begin_layout Standard
24215 is documented in the
24219 example file and in the Sweave manual (menu
24221 Help\SpecialChar menuseparator
24227 \begin_layout Chapter
24231 \begin_layout Standard
24232 You can do everything with \SpecialChar LyX
24233 that you can do with \SpecialChar LaTeX
24235 However, \SpecialChar LyX
24236 cannot support every \SpecialChar LaTeX
24238 But you can always use \SpecialChar TeX
24240 This chapter shows you some more special things you might want to use.
24241 For other special things you can do with figures, tables, floats, boxes
24242 and notes, have a look at the
24245 \begin_inset space ~
24253 \begin_layout Section
24254 Multiple Text Columns
24257 \begin_layout Standard
24258 This feature is independent of the option
24260 Two-column document
24262 in the document settings under
24267 If you want to have 2
24268 \begin_inset space ~
24271 columns for the whole document, it is recommended to use the
24273 Two-column document
24276 For all other cases use this feature.
24279 \begin_layout Standard
24280 To use multiple text columns in your document, you have to load the module
24287 Document\SpecialChar menuseparator
24288 Settings\SpecialChar menuseparator
24291 ) and must have the \SpecialChar LaTeX
24293 \begin_inset Flex Code
24296 \begin_layout Plain Layout
24305 \begin_layout Standard
24306 Footnotes within multiple columns will be placed at the bottom of the page
24307 and not under each column.
24308 Within the different columns you can use everything, with the limitation
24309 that for floats you need to use the float option
24316 \begin_layout Subsection
24320 \begin_layout Standard
24321 If you want to have 2
24322 \begin_inset space ~
24325 columns in your text, insert a multicolumn inset via the menu
24327 Insert\SpecialChar menuseparator
24329 \begin_inset space ~
24332 Insets\SpecialChar menuseparator
24334 \begin_inset space ~
24339 where the columns should start.
24340 Write all text that should be printed in 2
24341 \begin_inset space ~
24344 columns into this inset.
24347 \begin_layout Standard
24348 Here is an example:
24351 \begin_layout Standard
24353 \begin_inset Flex Multiple Columns
24356 \begin_layout Plain Layout
24361 The Adventure of the Empty House
24364 \begin_inset Newline newline
24367 by Sir Arthur Conan Doyle
24370 \begin_layout Plain Layout
24373 It was in the spring of the year 1894 that all London was interested, and
24374 the fashionable world dismayed, by the murder of the Honourable Ronald
24375 Adair under most unusual and inexplicable circumstances.
24376 The public has already learned those particulars of the crime which came
24377 out in the police investigation, but a good deal was suppressed upon that
24378 occasion, since the case for the prosecution was so overwhelmingly strong
24379 that it was not necessary to bring forward all the facts.
24380 Only now, at the end of nearly ten years, am I allowed to supply those
24381 missing links which make up the whole of that remarkable chain.
24382 The crime was of interest in itself, but that interest was as nothing to
24383 me compared to the inconceivable sequel, which afforded me the greatest
24384 shock and surprise of any event in my adventurous life.
24385 Even now, after this long interval, I find myself thrilling as I think
24386 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24387 ty which utterly submerged my mind.
24388 Let me say to that public, which has shown some interest in those glimpses
24389 which I have occasionally given them of the thoughts and actions of a very
24390 remarkable man, that they are not to blame me if I have not shared my knowledge
24391 with them, for I should have considered it my first duty to do so, had
24392 I not been barred by a positive prohibition from his own lips, which was
24393 only withdrawn upon the third of last month.
24401 \begin_layout Standard
24402 To get 3 or more columns, set the cursor into the multicolumn inset and
24405 Insert\SpecialChar menuseparator
24407 \begin_inset space ~
24411 \begin_inset space ~
24417 The number of the desired columns is written into that inset (for 3
24418 \begin_inset space ~
24422 \begin_inset Quotes eld
24426 \begin_inset Quotes erd
24430 \begin_inset Newline newline
24433 Here is an example with 3
24434 \begin_inset space ~
24440 \begin_layout Standard
24441 \begin_inset Flex Multiple Columns
24444 \begin_layout Plain Layout
24447 \begin_inset Argument 1
24450 \begin_layout Plain Layout
24457 It can be imagined that my close intimacy with Sherlock Holmes had interested
24458 me deeply in crime, and that after his disappearance I never failed to
24459 read with care the various problems which came before the public.
24460 And I even attempted, more than once, for my own private satisfaction,
24461 to employ his methods in their solution, though with indifferent success.
24462 There was none, however, which appealed to me like this tragedy of Ronald
24464 As I read the evidence at the inquest, which led up to a verdict of willful
24465 murder against some person or persons unknown, I realized more clearly
24466 than I had ever done the loss which the community had sustained by the
24467 death of Sherlock Holmes.
24468 There were points about this strange business which would, I was sure,
24469 have specially appealed to him, and the efforts of the police would have
24470 been supplemented, or more probably anticipated, by the trained observation
24471 and the alert mind of the first criminal agent in Europe.
24472 All day, as I drove upon my round, I turned over the case in my mind and
24473 found no explanation which appeared to me to be adequate.
24474 At the risk of telling a twice-told tale, I will recapitulate the facts
24475 as they were known to the public at the conclusion of the inquest.
24483 \begin_layout Standard
24484 You can have up to 10
24485 \begin_inset space ~
24488 columns if you want to, but that might not be very pleasant for the readers
24492 \begin_layout Standard
24493 \begin_inset Newpage newpage
24499 \begin_layout Subsection
24500 Columns inside Columns
24503 \begin_layout Standard
24504 You can also have columns inside columns:
24507 \begin_layout Standard
24508 \begin_inset Flex Multiple Columns
24511 \begin_layout Plain Layout
24514 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24515 at that time governor of one of the Australian colonies.
24516 Adair's mother had returned from Australia to undergo the operation for
24517 cataract, and she, her son Ronald, and her daughter Hilda were living together
24521 \begin_layout Plain Layout
24522 \begin_inset Flex Multiple Columns
24525 \begin_layout Plain Layout
24528 The youth moved in the best society
24529 \begin_inset space ~
24532 – had, so far as was known, no enemies and no particular vices.
24533 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24534 had been broken off by mutual consent some months before, and there was
24535 no sign that it had left any very profound feeling behind it.
24536 For the rest {sic} the man's life moved in a narrow and conventional circle,
24537 for his habits were quiet and his nature unemotional.
24538 Yet it was upon this easy-going young aristocrat that death came, in most
24539 strange and unexpected form, between the hours of ten and eleven-twenty
24540 on the night of March 30, 1894.
24548 \begin_layout Plain Layout
24551 Ronald Adair was fond of cards
24552 \begin_inset space ~
24555 – playing continually, but never for such stakes as would hurt him.
24556 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24557 It was shown that, after dinner on the day of his death, he had played
24558 a rubber of whist at the latter club.
24559 He had also played there in the afternoon.
24564 The evidence of those who had played with him
24565 \begin_inset space ~
24569 Murray, Sir John Hardy, and Colonel Moran
24570 \begin_inset space ~
24573 – showed that the game was whist, and that there was a fairly equal fall
24575 Adair might have lost five pounds, but not more.
24576 His fortune was a considerable one, and such a loss could not in any way
24578 He had played nearly every day at one club or other, but he was a cautious
24579 player, and usually rose a winner.
24580 It came out in evidence that, in partnership with Colonel Moran, he had
24581 actually won as much as four hundred and twenty pounds in a sitting, some
24582 weeks before, from Godfrey Milner and Lord Balmoral.
24583 So much for his recent history as it came out at the inquest.
24591 \begin_layout Subsection
24595 \begin_layout Standard
24596 The examples in this section show some more special features of multiple
24600 \begin_layout Standard
24601 For more features of multiple columns, have a look at the
24602 \begin_inset CommandInset href
24604 name "documentation"
24605 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24610 of the \SpecialChar LaTeX
24612 \begin_inset Flex Code
24615 \begin_layout Plain Layout
24624 \begin_layout Subsubsection
24628 \begin_layout Standard
24629 To add a preface text for multiple columns, set the cursor into the multicolumn
24630 inset and use the menu
24632 Insert\SpecialChar menuseparator
24636 Write your preface text into that inset.
24637 \begin_inset Newline newline
24640 This is an example with some preface text:
24643 \begin_layout Standard
24644 \begin_inset VSpace bigskip
24650 \begin_layout Standard
24651 \begin_inset Flex Multiple Columns
24654 \begin_layout Plain Layout
24655 \begin_inset Argument 2
24658 \begin_layout Plain Layout
24659 And the story continues and continues and continues and continues\SpecialChar ldots
24667 On the evening of the crime, he returned from the club exactly at ten.
24668 His mother and sister were out spending the evening with a relation.
24669 The servant deposed that she heard him enter the front room on the second
24670 floor, generally used as his sitting-room.
24671 She had lit a fire there, and as it smoked she had opened the window.
24672 No sound was heard from the room until eleven-twenty, the hour of the return
24673 of Lady Maynooth and her daughter.
24674 Desiring to say good-night, she attempted to enter her son's room.
24675 The door was locked on the inside, and no answer could be got to their
24676 cries and knocking.
24677 Help was obtained, and the door forced.
24678 The unfortunate young man was found lying near the table.
24679 His head had been horribly mutilated by an expanding revolver bullet, but
24680 no weapon of any sort was to be found in the room.
24688 \begin_layout Standard
24689 You can also use a section heading as the preface if you use a section command
24690 as \SpecialChar TeX
24692 For example the command
24695 \begin_layout LyX-Code
24698 subsection{subsection title}
24701 \begin_layout Standard
24702 creates a subsection.
24703 In this example the preface is a subsubsection:
24706 \begin_layout Standard
24707 \begin_inset Flex Multiple Columns
24710 \begin_layout Plain Layout
24711 \begin_inset Argument 2
24714 \begin_layout Plain Layout
24718 \begin_layout Plain Layout
24727 This is a subsubsection heading as a preface
24731 \begin_layout Plain Layout
24745 A minute examination of the circumstances served only to make the case more
24747 In the first place, no reason could be given why the young man should have
24748 fastened the door upon the inside.
24749 There was the possibility that the murderer had done this, and had afterwards
24750 escaped by the window.
24751 The drop was at least twenty feet, however, and a bed of crocuses in full
24753 Neither the flowers nor the earth showed any sign of having been disturbed,
24754 nor were there any marks upon the narrow strip of grass which separated
24755 the house from the road.
24756 Apparently, therefore, it was the young man himself who had fastened the
24758 But how did he come by his death? No one could have climbed up to the window
24759 without leaving traces.
24760 Suppose a man had fired through the window, he would indeed be a remarkable
24761 shot who could with a revolver inflict so deadly a wound.
24762 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24763 a hundred yards of the house.
24764 No one had heard a shot.
24772 \begin_layout Standard
24773 If there is less vertical space than 6
24774 \begin_inset space ~
24777 text lines is left on the page at the beginning of the multiple columns,
24778 a page break will be inserted before the multiple columns.
24779 Depending on the number of lines of the preface text, you might want to
24781 This is done by setting the cursor into the mulitcolumn inset behind the
24782 preface (if there is any) and using the menu
24784 Insert\SpecialChar menuseparator
24786 \begin_inset space ~
24790 \begin_inset space ~
24794 \begin_inset space ~
24800 Insert into that inset the amount of space like e.
24801 \begin_inset space \thinspace{}
24805 \begin_inset space \space{}
24809 \begin_inset Quotes eld
24813 \begin_inset Quotes erd
24817 \begin_inset Newline newline
24820 In this example the space is set to 7
24821 \begin_inset space ~
24824 text lines by using
24825 \begin_inset Flex Code
24828 \begin_layout Plain Layout
24837 \begin_inset Flex Code
24840 \begin_layout Plain Layout
24848 needs to be inserted as \SpecialChar TeX
24852 \begin_layout Standard
24853 \begin_inset Flex Multiple Columns
24856 \begin_layout Plain Layout
24857 \begin_inset Argument 3
24860 \begin_layout Plain Layout
24865 \begin_layout Plain Layout
24881 On the evening of the crime, he returned from the club exactly at ten.
24882 His mother and sister were out spending the evening with a relation.
24883 The servant deposed that she heard him enter the front room on the second
24884 floor, generally used as his sitting-room.
24885 She had lit a fire there, and as it smoked she had opened the window.
24886 No sound was heard from the room until eleven-twenty, the hour of the return
24887 of Lady Maynooth and her daughter.
24888 Desiring to say good-night, she attempted to enter her son's room.
24889 The door was locked on the inside, and no answer could be got to their
24890 cries and knocking.
24891 Help was obtained, and the door forced.
24892 The unfortunate young man was found lying near the table.
24893 His head had been horribly mutilated by an expanding revolver bullet, but
24894 no weapon of any sort was to be found in the room.
24902 \begin_layout Subsubsection
24906 \begin_layout Standard
24907 The amount of space before and after multiple columns can be changed by
24908 changing the length
24909 \begin_inset Flex Code
24912 \begin_layout Plain Layout
24921 For example the command
24924 \begin_layout LyX-Code
24932 \begin_layout Standard
24933 in \SpecialChar TeX
24934 Code changes its value to 3
24935 \begin_inset space \thinspace{}
24939 The change must be made before the multiple columns' start.
24940 The predefined value is 13
24941 \begin_inset space \thinspace{}
24947 \begin_layout Standard
24949 \begin_inset Flex Code
24952 \begin_layout Plain Layout
24961 \begin_inset space \thinspace{}
24967 \begin_layout Standard
24971 \begin_layout Plain Layout
24977 multicolsep}{2.5cm}
24985 \begin_layout Standard
24986 \begin_inset Flex Multiple Columns
24989 \begin_layout Plain Layout
24992 All day I turned these facts over in my mind, endeavouring to hit upon some
24993 theory which could reconcile them all, and to find that line of least resistanc
24994 e which my poor friend had declared to be the starting-point of every investigat
24996 I confess that I made little progress.
24997 In the evening I strolled across the Park, and found myself about six o'clock
24998 at the Oxford Street end of Park Lane.
24999 A group of loafers upon the pavements, all staring up at a particular window,
25000 directed me to the house which I had come to see.
25001 A tall, thin man with coloured glasses, whom I strongly suspected of being
25002 a plain-clothes detective, was pointing out some theory of his own, while
25003 the others crowded round to listen to what he said.
25004 I got as near him as I could, but his observations seemed to me to be absurd,
25005 so I withdrew again in some disgust.
25006 As I did so I struck against an elderly, deformed man, who had been behind
25007 me, and I knocked down several books which he was carrying.
25015 \begin_layout Standard
25016 \begin_inset Note Greyedout
25019 \begin_layout Plain Layout
25024 The values you set with
25025 \begin_inset Flex Code
25028 \begin_layout Plain Layout
25036 will be used for all following multiple columns until you change them again.
25044 \begin_layout Standard
25048 \begin_layout Plain Layout
25060 \begin_inset Note Note
25063 \begin_layout Plain Layout
25064 go back to the default
25072 \begin_layout Standard
25073 \begin_inset Newpage newpage
25079 \begin_layout Subsubsection
25083 \begin_layout Standard
25084 A column break can be forced by inserting the command
25085 \begin_inset Flex Code
25088 \begin_layout Plain Layout
25096 as \SpecialChar TeX
25097 Code to that position in the text where the column should be broken.
25098 Note that this leads in most cases to whitespace in the text.
25099 \begin_inset Newline newline
25102 Here is an example:
25105 \begin_layout Standard
25106 \begin_inset Flex Multiple Columns
25109 \begin_layout Plain Layout
25112 \begin_inset Quotes eld
25115 You're surprised to see me, sir,
25116 \begin_inset Quotes erd
25119 said he, in a strange, croaking voice.
25122 \begin_layout Plain Layout
25125 I acknowledged that I was.
25128 \begin_layout Plain Layout
25131 \begin_inset Quotes eld
25134 Well, I've a conscience, sir, and when I chanced to see you go into this
25135 house, as I came hobbling after you, I thought to myself, I'll just step
25136 in and see that kind gentleman, and tell him that if I was a bit gruff
25137 in my manner there was not any harm meant, and that I am much obliged to
25138 him for picking up my books.
25139 \begin_inset Quotes erd
25145 \begin_layout Plain Layout
25148 \begin_inset Quotes eld
25151 You make too much of a trifle,
25152 \begin_inset Quotes erd
25157 \begin_inset Quotes eld
25160 May I ask how you knew who I was?
25161 \begin_inset Quotes erd
25164 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25168 \begin_layout Plain Layout
25180 \begin_layout Plain Layout
25183 \begin_inset Quotes eld
25186 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25187 you'll find my little bookshop at the corner of Church Street, and very
25188 happy to see you, I am sure.
25189 Maybe you collect yourself, sir.
25193 \begin_inset space ~
25207 \begin_inset space ~
25210 – a bargain, every one of them.
25211 With five volumes you could just fill that gap on that second shelf.
25212 It looks untidy, does it not, sir?
25213 \begin_inset Quotes erd
25224 \begin_layout Subsubsection
25228 \begin_layout Standard
25229 The width of the columns is automatically calculated, but you can modify
25230 the space between the columns.
25231 This is done by changing the length
25232 \begin_inset Flex Code
25235 \begin_layout Plain Layout
25244 Its predefined value is 10
25245 \begin_inset space \thinspace{}
25249 Here is an example where
25250 \begin_inset Flex Code
25253 \begin_layout Plain Layout
25262 \begin_inset space \thinspace{}
25268 \begin_layout Standard
25272 \begin_layout Plain Layout
25286 \begin_layout Standard
25287 \begin_inset Flex Multiple Columns
25290 \begin_layout Plain Layout
25293 My observations of No.
25294 \begin_inset space \space{}
25297 427 Park Lane did little to clear up the problem in which I was interested.
25298 The house was separated from the street by a low wall and railing, the
25299 whole not more than five feet high.
25300 It was perfectly easy, therefore, for anyone to get into the garden, but
25301 the window was entirely inaccessible, since there was no water pipe or
25302 anything which could help the most active man to climb it.
25303 More puzzled than ever, I retraced my steps to Kensington.
25304 I had not been in my study five minutes when the maid entered to say that
25305 a person desired to see me.
25306 To my astonishment it was none other than my strange old book collector,
25307 his sharp, wizened face peering out from a frame of white hair, and his
25308 precious volumes, a dozen of them at least, wedged under his right arm.
25316 \begin_layout Standard
25320 \begin_layout Plain Layout
25332 \begin_inset Note Note
25335 \begin_layout Plain Layout
25336 go back to the default
25344 \begin_layout Subsubsection
25348 \begin_layout Standard
25349 Between the columns a rule with a width of the length
25350 \begin_inset Flex Code
25353 \begin_layout Plain Layout
25362 If this rule width is set to 0
25363 \begin_inset space \thinspace{}
25366 pt (this is the default), the rule is suppressed.
25367 In the following example the rule is 2
25368 \begin_inset space \thinspace{}
25374 \begin_layout Standard
25378 \begin_layout Plain Layout
25384 columnseprule}{2pt}
25392 \begin_layout Standard
25393 \begin_inset Flex Multiple Columns
25396 \begin_layout Plain Layout
25399 \begin_inset Quotes eld
25402 You're surprised to see me, sir,
25403 \begin_inset Quotes erd
25406 said he, in a strange, croaking voice.
25409 \begin_layout Plain Layout
25412 I acknowledged that I was.
25415 \begin_layout Plain Layout
25418 \begin_inset Quotes eld
25421 Well, I've a conscience, sir, and when I chanced to see you go into this
25422 house, as I came hobbling after you, I thought to myself, I'll just step
25423 in and see that kind gentleman, and tell him that if I was a bit gruff
25424 in my manner there was not any harm meant, and that I am much obliged to
25425 him for picking up my books.
25426 \begin_inset Quotes erd
25432 \begin_layout Plain Layout
25435 \begin_inset Quotes eld
25438 You make too much of a trifle,
25439 \begin_inset Quotes erd
25444 \begin_inset Quotes eld
25447 May I ask how you knew who I was?
25448 \begin_inset Quotes erd
25454 \begin_layout Plain Layout
25457 \begin_inset Quotes eld
25460 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25461 you'll find my little bookshop at the corner of Church Street, and very
25462 happy to see you, I am sure.
25463 Maybe you collect yourself, sir.
25467 \begin_inset space ~
25481 \begin_inset space ~
25484 – a bargain, every one of them.
25485 With five volumes you could just fill that gap on that second shelf.
25486 It looks untidy, does it not, sir?
25487 \begin_inset Quotes erd
25498 \begin_layout Standard
25499 \begin_inset VSpace defskip
25505 \begin_layout Standard
25506 The rule can be colored by redefining the command
25507 \begin_inset Flex Code
25510 \begin_layout Plain Layout
25519 This is done by inserting the command
25522 \begin_layout LyX-Code
25527 columnseprulecolor}{
25532 \begin_layout Standard
25533 as \SpecialChar TeX
25534 Code before the multicolumn inset.
25536 \begin_inset Flex Code
25539 \begin_layout Plain Layout
25545 in this command by a color of your choice.
25546 You can use all pre- and self-defined colors.
25554 \begin_inset space ~
25559 for more information about pre- and self-defined colors.
25560 To go back to the default color insert the command
25563 \begin_layout LyX-Code
25568 columnseprulecolor}{
25573 \begin_layout Standard
25574 Here is the example with a cyan rule and 1
25575 \begin_inset space \thinspace{}
25578 cm column separation:
25581 \begin_layout Standard
25585 \begin_layout Plain Layout
25594 \begin_layout Plain Layout
25600 columnseprulecolor}{
25610 \begin_layout Standard
25611 \begin_inset Flex Multiple Columns
25614 \begin_layout Plain Layout
25617 \begin_inset Quotes eld
25620 You're surprised to see me, sir,
25621 \begin_inset Quotes erd
25624 said he, in a strange, croaking voice.
25627 \begin_layout Plain Layout
25630 I acknowledged that I was.
25633 \begin_layout Plain Layout
25636 \begin_inset Quotes eld
25639 Well, I've a conscience, sir, and when I chanced to see you go into this
25640 house, as I came hobbling after you, I thought to myself, I'll just step
25641 in and see that kind gentleman, and tell him that if I was a bit gruff
25642 in my manner there was not any harm meant, and that I am much obliged to
25643 him for picking up my books.
25644 \begin_inset Quotes erd
25650 \begin_layout Plain Layout
25653 \begin_inset Quotes eld
25656 You make too much of a trifle,
25657 \begin_inset Quotes erd
25662 \begin_inset Quotes eld
25665 May I ask how you knew who I was?
25666 \begin_inset Quotes erd
25672 \begin_layout Plain Layout
25675 \begin_inset Quotes eld
25678 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25679 you'll find my little bookshop at the corner of Church Street, and very
25680 happy to see you, I am sure.
25681 Maybe you collect yourself, sir.
25685 \begin_inset space ~
25699 \begin_inset space ~
25702 – a bargain, every one of them.
25703 With five volumes you could just fill that gap on that second shelf.
25704 It looks untidy, does it not, sir?
25705 \begin_inset Quotes erd
25716 \begin_layout Standard
25720 \begin_layout Plain Layout
25726 columnseprule}{0pt}
25729 \begin_layout Plain Layout
25735 columnseprulecolor}{
25743 \begin_inset Note Note
25746 \begin_layout Plain Layout
25747 go back to the default
25755 \begin_layout Section
25756 Non-standard Paragraph Shapes
25759 \begin_layout Standard
25762 as well as any other text processor uses by default rectangular paragraphs.
25763 For special cases like for example posters, invitation cards or poems you
25764 can modify the paragraph shape to one of your choice.
25765 This can be done by using the \SpecialChar LaTeX
25767 \begin_inset Flex Code
25770 \begin_layout Plain Layout
25776 which is loaded by using in the document settings the module
25778 Custom paragraph shapes
25783 \begin_layout Subsection
25787 \begin_layout Standard
25792 provides the following shapes:
25795 \begin_layout Standard
25796 \begin_inset Tabular
25797 <lyxtabular version="3" rows="13" columns="3">
25798 <features booktabs="true" islongtable="true" longtabularalignment="center">
25799 <column alignment="left" valignment="middle" width="16col%">
25800 <column alignment="left" valignment="middle" width="40col%">
25801 <column alignment="left" valignment="middle" width="35col%">
25802 <row endhead="true">
25803 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25806 \begin_layout Plain Layout
25815 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
25818 \begin_layout Plain Layout
25827 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
25830 \begin_layout Plain Layout
25840 <row interlinespace="default">
25841 <cell alignment="left" valignment="top" usebox="none">
25844 \begin_layout Plain Layout
25852 <cell alignment="left" valignment="top" usebox="none">
25855 \begin_layout Plain Layout
25858 Circle with circular hole (in the size of a CD/DVD)
25863 <cell alignment="left" valignment="top" usebox="none">
25866 \begin_layout Plain Layout
25869 Cannot be scaled, take care there is not too much text
25875 <row interlinespace="default">
25876 <cell alignment="left" valignment="top" usebox="none">
25879 \begin_layout Plain Layout
25887 <cell alignment="left" valignment="top" usebox="none">
25890 \begin_layout Plain Layout
25898 <cell alignment="left" valignment="top" usebox="none">
25901 \begin_layout Plain Layout
25904 Fragile, calculation might fail
25910 <row interlinespace="default">
25911 <cell alignment="left" valignment="top" usebox="none">
25914 \begin_layout Plain Layout
25922 <cell alignment="left" valignment="top" usebox="none">
25925 \begin_layout Plain Layout
25928 Rhomboid (symbolizing a
25929 \begin_inset Quotes eld
25933 \begin_inset Quotes erd
25941 <cell alignment="left" valignment="top" usebox="none">
25944 \begin_layout Plain Layout
25953 <row interlinespace="default">
25954 <cell alignment="left" valignment="top" usebox="none">
25957 \begin_layout Plain Layout
25965 <cell alignment="left" valignment="top" usebox="none">
25968 \begin_layout Plain Layout
25976 <cell alignment="left" valignment="top" usebox="none">
25979 \begin_layout Plain Layout
25988 <row interlinespace="default">
25989 <cell alignment="left" valignment="top" usebox="none">
25992 \begin_layout Plain Layout
26000 <cell alignment="left" valignment="top" usebox="none">
26003 \begin_layout Plain Layout
26011 <cell alignment="left" valignment="top" usebox="none">
26014 \begin_layout Plain Layout
26023 <row interlinespace="default">
26024 <cell alignment="left" valignment="top" usebox="none">
26027 \begin_layout Plain Layout
26035 <cell alignment="left" valignment="top" usebox="none">
26038 \begin_layout Plain Layout
26041 Nut for bolt (hexagon with circular hole)
26046 <cell alignment="left" valignment="top" usebox="none">
26049 \begin_layout Plain Layout
26058 <row interlinespace="default">
26059 <cell alignment="left" valignment="top" usebox="none">
26062 \begin_layout Plain Layout
26070 <cell alignment="left" valignment="top" usebox="none">
26073 \begin_layout Plain Layout
26081 <cell alignment="left" valignment="top" usebox="none">
26084 \begin_layout Plain Layout
26093 <row interlinespace="default">
26094 <cell alignment="left" valignment="top" usebox="none">
26097 \begin_layout Plain Layout
26105 <cell alignment="left" valignment="top" usebox="none">
26108 \begin_layout Plain Layout
26116 <cell alignment="left" valignment="top" usebox="none">
26119 \begin_layout Plain Layout
26128 <row interlinespace="default">
26129 <cell alignment="left" valignment="top" usebox="none">
26132 \begin_layout Plain Layout
26140 <cell alignment="left" valignment="top" usebox="none">
26143 \begin_layout Plain Layout
26151 <cell alignment="left" valignment="top" usebox="none">
26154 \begin_layout Plain Layout
26163 <row interlinespace="default">
26164 <cell alignment="left" valignment="top" usebox="none">
26167 \begin_layout Plain Layout
26175 <cell alignment="left" valignment="top" usebox="none">
26178 \begin_layout Plain Layout
26181 Normal/reversed rain drop
26186 <cell alignment="left" valignment="top" usebox="none">
26189 \begin_layout Plain Layout
26192 Fragile, calculation might fail
26198 <row interlinespace="default">
26199 <cell alignment="left" valignment="top" usebox="none">
26202 \begin_layout Plain Layout
26211 <cell alignment="left" valignment="top" usebox="none">
26214 \begin_layout Plain Layout
26217 The \SpecialChar TeX
26223 <cell alignment="left" valignment="top" usebox="none">
26226 \begin_layout Plain Layout
26235 <row interlinespace="default">
26236 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26239 \begin_layout Plain Layout
26243 \begin_inset Newline newline
26251 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26254 \begin_layout Plain Layout
26257 Triangles in different orientations
26262 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26265 \begin_layout Plain Layout
26281 \begin_layout Standard
26282 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26284 for environments in the toolbar.
26287 \begin_layout Standard
26288 \begin_inset Newpage newpage
26294 \begin_layout Standard
26295 Here is an example paragraph in the shape of a nut:
26298 \begin_layout Standard
26299 \begin_inset VSpace bigskip
26308 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26309 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26311 At vero eos et accusam et justo duo dolores et ea rebum.
26312 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26314 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26315 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26319 \begin_layout Standard
26320 \begin_inset VSpace bigskip
26326 \begin_layout Standard
26327 \begin_inset Note Greyedout
26330 \begin_layout Plain Layout
26339 paragraphs cannot run over a page break.
26347 \begin_layout Standard
26348 \begin_inset VSpace bigskip
26354 \begin_layout Standard
26356 \begin_inset Flex Code
26359 \begin_layout Plain Layout
26365 takes care that the shape will always be preserved, no matter how much
26366 text is in the paragraph.
26367 Therefore the paragraph size changes with the amount of contained text.
26368 This can lead to paragraph sizes exceeding the page margins.
26369 To demonstrate the size scaling, here is the same example paragraph but
26370 with twice as much text:
26373 \begin_layout Standard
26374 \begin_inset Newpage newpage
26383 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26384 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26386 At vero eos et accusam et justo duo dolores et ea rebum.
26387 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26389 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26390 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26392 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26393 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26395 At vero eos et accusam et justo duo dolores et ea rebum.
26396 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26398 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26399 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26403 \begin_layout Standard
26404 \begin_inset VSpace bigskip
26410 \begin_layout Standard
26411 An exception is the shape
26416 It cannot be scaled because it must fit the size of a CD/DVD.
26417 Therefore the amount of text that fits into the shape is limited.
26418 \begin_inset Newline newline
26429 shape are fragile, meaning that the calculation of their size can fail,
26430 depending on the amount of text.
26431 You will then get the \SpecialChar LaTeX
26433 \begin_inset Quotes eld
26436 Arithmetic overflow
26437 \begin_inset Quotes erd
26441 In this case one can try to remove or add some text; if nothing works one
26442 has to use another shape.
26445 \begin_layout Standard
26446 \begin_inset VSpace bigskip
26452 \begin_layout Standard
26453 For shapes with tips you will maybe see that \SpecialChar LaTeX
26454 's hyphenation routine fails
26455 for text in the tips.
26456 Therefore it is often necessary to add hyphenation points
26461 arg "specialchar-insert hyphenation"
26466 ) to the corresponding text parts.
26469 \begin_layout Standard
26470 \begin_inset VSpace bigskip
26476 \begin_layout Standard
26477 Shapepar paragraphs are either always centered or placed on the page so
26478 that their left border touches the left page margin.
26479 You can therefore not use the paragraph dialog to align such paragraphs.
26480 A solution is to put the paragraph into a minipage or parbox and align
26482 The problem is hereby to find the right width for the box.
26483 Because if it is too wide and you center the box, the paragraph is not
26484 centered too because it sticks at the left side of the box.
26485 So you might have to play a bit with the width until it fits.
26486 Here are two heart-shaped paragraphs, the first one is not aligned, the
26487 second one is right-aligned:
26490 \begin_layout Standard
26491 \begin_inset Newpage newpage
26497 \begin_layout Heart
26501 Lo\SpecialChar softhyphen
26502 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26503 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26505 At vero eos et accusam et justo duo dolores et ea rebum.
26506 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26510 \begin_layout Standard
26511 \begin_inset VSpace bigskip
26517 \begin_layout Standard
26520 \begin_inset Box Frameless
26530 height_special "totalheight"
26535 backgroundcolor "none"
26538 \begin_layout Heart
26542 Lo\SpecialChar softhyphen
26543 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26544 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26546 At vero eos et accusam et justo duo dolores et ea rebum.
26547 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26556 \begin_layout Subsection
26560 \begin_layout Standard
26561 You can define any shape you want.
26562 Doing this manually is a lot of work because every coordinate must be specified.
26563 But there is a way to let the computer calculate the coordinates:
26566 \begin_layout Enumerate
26567 Install the program
26568 \begin_inset CommandInset href
26571 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26579 \begin_layout Enumerate
26586 TeX/LaTeX\SpecialChar menuseparator
26587 Settings\SpecialChar menuseparator
26590 and select the font size you are using in your document.
26591 For example this document uses the size 12
26592 \begin_inset space \thinspace{}
26598 \begin_layout Enumerate
26602 \begin_layout Enumerate
26605 TeX/LaTeX\SpecialChar menuseparator
26608 to export the shape to coordinates.
26609 In the appearing dialog use either the outline of your shape for the coordinate
26610 s or the path itself.
26614 \begin_layout Plain Layout
26615 For more information see
26616 \begin_inset CommandInset href
26618 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26631 \begin_layout Standard
26632 The coordinates are written into a \SpecialChar TeX
26634 To use it for your \SpecialChar LyX
26638 \begin_layout Enumerate
26639 Place the cursor before the first character of your paragraph (or into a
26643 \begin_layout Enumerate
26644 Open in \SpecialChar LyX
26647 Insert\SpecialChar menuseparator
26648 File\SpecialChar menuseparator
26650 \begin_inset space ~
26655 , select the file and use
26664 \begin_layout Standard
26665 \begin_inset VSpace defskip
26671 \begin_layout Standard
26672 \begin_inset Note Greyedout
26675 \begin_layout Plain Layout
26680 : The changed shape only applies to the current paragraph; everything is
26681 reset to normal for the next paragraph.
26682 Therefore the shape definition file must be input into every paragraph
26683 with the desired shape.
26691 \begin_layout Standard
26692 \begin_inset VSpace bigskip
26698 \begin_layout Standard
26699 Here is an example:
26702 \begin_layout Standard
26703 \begin_inset VSpace bigskip
26709 \begin_layout Standard
26710 \begin_inset CommandInset include
26712 filename "SpecialParagraphShape.tex"
26719 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26720 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26722 At vero eos et accusam et justo duo dolores et ea rebum.
26723 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26725 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26726 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26730 \begin_layout Standard
26731 \begin_inset VSpace bigskip
26737 \begin_layout Standard
26742 to draw complexer shapes in
26746 you can draw the shape in a program of your choice and import the resulting
26752 Then you only need to draw a line or spline along the outline of the image.
26755 \begin_layout Standard
26756 \begin_inset VSpace bigskip
26762 \begin_layout Standard
26765 Custom paragraph shapes
26767 also provides the two commands
26775 which can be used to define custom shapes coordinate by coordinate.
26779 \begin_layout Plain Layout
26780 These commands are internally used for all shapes described here.
26785 For information how these styles are used and about further customization
26786 possibilities, have a look at the
26787 \begin_inset CommandInset href
26789 name "documentation"
26790 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
26796 \begin_inset Flex Code
26799 \begin_layout Plain Layout