1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 % Improve line breaking
34 \emergencystretch 1.5em
37 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
38 \use_default_options false
46 \maintain_unincluded_children false
48 \language_package default
51 \font_roman "lmodern" "default"
52 \font_sans "lmss" "default"
53 \font_typewriter "lmtt" "default"
54 \font_math "auto" "auto"
55 \font_default_family default
56 \use_non_tex_fonts false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
71 \pdf_title "LyX's Additional Features manual"
72 \pdf_author "LyX Team"
73 \pdf_subject "LyX's additional features documentation"
74 \pdf_keywords "LyX, Documentation, Additional"
76 \pdf_bookmarksnumbered true
77 \pdf_bookmarksopen false
78 \pdf_bookmarksopenlevel 1
83 \pdf_pdfusetitle false
84 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
87 \use_package amsmath 1
88 \use_package amssymb 1
91 \use_package mathdots 1
92 \use_package mathtools 1
94 \use_package stackrel 1
95 \use_package stmaryrd 1
96 \use_package undertilde 1
98 \cite_engine_type default
102 \paperorientation portrait
107 \notefontcolor #0000ff
114 \paragraph_separation indent
115 \paragraph_indentation default
117 \math_indentation default
118 \math_numbering_side default
119 \quotes_style english
123 \paperpagestyle headings
124 \tracking_changes false
125 \output_changes false
134 Additional \SpecialChar LyX
138 \begin_layout Subtitle
143 by the \SpecialChar LyX
148 \begin_layout Plain Layout
150 Principal maintainer of this file is
155 If you have comments or error corrections, please send them to the \SpecialChar LyX
158 \begin_inset Flex Code
161 \begin_layout Plain Layout
163 <lyx-docs@lists.lyx.org>
176 \begin_layout Standard
177 \begin_inset CommandInset toc
178 LatexCommand tableofcontents
185 \begin_layout Chapter
189 \begin_layout Standard
190 This manual is essentially Part II of the
192 User's Guide\SpecialChar endofsentence
195 The reason for separating the two documents is simple: the
199 is already quite lengthy, and it contains information on all of the basic
200 features one needs to know in order to prepare most documents.
201 However, the \SpecialChar LyX
202 Team has worked to make \SpecialChar LyX
203 extensible through various configuration
204 files and external packages.
205 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
207 create a layout file (or module) for it without having to alter \SpecialChar LyX
209 We've already had contributions of several new features this way, and some
210 of them are documented here.
211 There are also some more `advanced' features, such as how to control the
212 presentation of bibliographies and how to work with multi-part documents,
213 that are not covered in the
217 and are discussed here.
220 \begin_layout Standard
221 This manual also documents some special features, like fax support, version
222 control, and SGML support, which require additional software to work properly.
223 There is also a chapter on \SpecialChar LyX
225 And lastly, there's a chapter of \SpecialChar LaTeX
226 tools and tips, things you can use to
227 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
229 After all, \SpecialChar LyX
234 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
238 \begin_layout Standard
239 If you haven't read the
243 yet, you are definitely in the wrong manual.
248 is the first place to go, since it describes the notation and format of
250 You should also be thoroughly familiar with the
254 and all of the basic features of \SpecialChar LyX
255 before attempting to read this one.
258 \begin_layout Standard
259 Since many of the topics in this manual depend heavily on \SpecialChar LyX
261 with \SpecialChar LaTeX
262 , this first chapter covers the inner workings of \SpecialChar LyX
265 to generate exactly the \SpecialChar LaTeX
267 It is obviously for more seasoned \SpecialChar LyX
271 \begin_layout Chapter
273 and \SpecialChar LaTeX
277 \begin_layout Section
279 Uses \SpecialChar LaTeX
283 \begin_layout Standard
284 This chapter is for both \SpecialChar TeX
285 -nicians and the \SpecialChar LaTeX
287 In it, we'll explain how \SpecialChar LyX
288 and \SpecialChar LaTeX
289 work together to produce printable output.
290 This is the only place in any of the manuals where we assume you know something
291 about \SpecialChar LaTeX
295 \begin_layout Standard
296 At one time, \SpecialChar LyX
298 \begin_inset Quotes eld
301 WYSIWYM frontend to \SpecialChar LaTeX
303 \begin_inset Quotes erd
306 but that's no longer true.
307 There are frontends to \SpecialChar LaTeX
312 \begin_layout Plain Layout
313 Some familar ones are \SpecialChar TeX
314 maker and kile, on Linux, and \SpecialChar TeX
316 There are also the \SpecialChar LaTeX
317 modes for vi and emacs, of course.
322 These are basically text editors with the ability to run \SpecialChar LaTeX
324 errors in the file you're editing.
325 Although \SpecialChar LyX
334 run \SpecialChar LaTeX
335 , and it also indicates errors in the file, it also does much, much
337 For one thing, you don't need to know \SpecialChar LaTeX
338 to use \SpecialChar LyX
341 has added its own extensions to \SpecialChar LaTeX
343 Try the following sometime: select
344 \begin_inset Flex Noun
347 \begin_layout Plain Layout
348 Export\SpecialChar menuseparator
355 \begin_inset Flex Noun
358 \begin_layout Plain Layout
365 \begin_inset Flex Noun
368 \begin_layout Plain Layout
369 View\SpecialChar menuseparator
379 ), then look at the preamble of the resulting
380 \begin_inset Flex Code
383 \begin_layout Plain Layout
390 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
392 These macros are defined automatically, according to the features you use
396 \begin_layout Standard
397 There are several commands that automatically invoke \SpecialChar LaTeX
402 \begin_layout Itemize
403 \begin_inset Flex Noun
406 \begin_layout Plain Layout
407 Document\SpecialChar menuseparator
416 \begin_layout Itemize
417 \begin_inset Flex Noun
420 \begin_layout Plain Layout
421 Document\SpecialChar menuseparator
430 \begin_layout Standard
431 They will only invoke \SpecialChar LaTeX
432 if the file has changed since the last time \SpecialChar LaTeX
438 \begin_layout Standard
439 When \SpecialChar LyX
440 runs \SpecialChar LaTeX
441 on the file you're editing, it performs these steps:
444 \begin_layout Enumerate
445 Convert the document to \SpecialChar LaTeX
446 and save to a file with the extension
447 \begin_inset Flex Code
450 \begin_layout Plain Layout
457 \begin_inset Flex Code
460 \begin_layout Plain Layout
469 \begin_layout Enumerate
470 Run \SpecialChar LaTeX
472 \begin_inset Flex Code
475 \begin_layout Plain Layout
481 file (maybe several times), and run any other commands (such as
482 \begin_inset Flex Code
485 \begin_layout Plain Layout
492 \begin_inset Flex Code
495 \begin_layout Plain Layout
501 ) needed to compile the \SpecialChar LaTeX
505 \begin_layout Enumerate
506 If there are any errors, show the error log.
509 \begin_layout Standard
510 If you have run \SpecialChar LaTeX
512 \begin_inset Flex Noun
515 \begin_layout Plain Layout
516 View\SpecialChar menuseparator
523 then runs a DVI viewer to display the DVI-file.
525 \begin_inset Flex Noun
528 \begin_layout Plain Layout
529 View\SpecialChar menuseparator
536 performs further steps:
539 \begin_layout Itemize
541 \begin_inset Flex Code
544 \begin_layout Plain Layout
550 to convert the DVI file to PostScript.
553 \begin_layout Itemize
554 Run a PostScript viewer, such as
555 \begin_inset Flex Code
558 \begin_layout Plain Layout
564 , to display the PostScript file.
567 \begin_layout Standard
569 does similar things when viewing, or exporting, other formats.
572 \begin_layout Section
573 Translating \SpecialChar LaTeX
574 files into \SpecialChar LyX
578 \begin_layout Standard
579 You can import a \SpecialChar LaTeX
580 file into \SpecialChar LyX
582 \begin_inset Flex Noun
585 \begin_layout Plain Layout
586 File\SpecialChar menuseparator
587 Import\SpecialChar menuseparator
593 command in \SpecialChar LyX
595 This will call a program named
596 \begin_inset Flex Code
599 \begin_layout Plain Layout
605 which will create a file
606 \begin_inset Flex Code
609 \begin_layout Plain Layout
616 \begin_inset Flex Code
619 \begin_layout Plain Layout
627 will then open that file.
631 \begin_layout Plain Layout
632 \begin_inset Flex Code
635 \begin_layout Plain Layout
641 can also be run from the command line, of course.
649 \begin_layout Standard
650 \begin_inset Flex Code
653 \begin_layout Plain Layout
659 will translate most legal \SpecialChar LaTeX
660 , but not everything.
661 It will put things it doesn't understand into \SpecialChar TeX
662 code, so after translating
664 \begin_inset Flex Code
667 \begin_layout Plain Layout
673 , you can look for \SpecialChar TeX
674 code and hand-edit it until it looks right.
677 \begin_layout Standard
678 If you don't know what \SpecialChar TeX
679 code is, read the next section.
682 \begin_layout Section
683 \begin_inset CommandInset label
685 name "sec:Inserting-TeX-Code"
689 Inserting \SpecialChar TeX
690 Code into \SpecialChar LyX
694 \begin_layout Standard
695 Anything you can do in \SpecialChar LaTeX
696 you can do in \SpecialChar LyX
697 , for a very simple reason: You can
698 always insert \SpecialChar TeX
699 code into any \SpecialChar LyX
702 cannot, and will never be able to, display every possible \SpecialChar LaTeX
704 If ever you need to insert \SpecialChar LaTeX
705 commands into your \SpecialChar LyX
706 document, you can use the
708 \begin_inset Flex Code
711 \begin_layout Plain Layout
718 box, which you can insert into your document with
719 \begin_inset Flex Noun
722 \begin_layout Plain Layout
723 Insert\SpecialChar menuseparator
733 or the keyboard shortcut
742 \begin_layout Standard
743 Here's an example of inserting \SpecialChar LaTeX
744 commands in a \SpecialChar LyX
746 The code looks like this:
749 \begin_layout LyX-Code
753 \begin_inset Newline newline
759 \begin_inset Newline newline
762 This is an example of a minipage environment.
764 \begin_inset Newline newline
767 can put nearly everything in it, even (non-floating)
768 \begin_inset Newline newline
773 \begin_inset Newline newline
779 \begin_inset Newline newline
783 \begin_inset Newline newline
789 \begin_inset Newline newline
795 \begin_inset Newline newline
801 \begin_inset Newline newline
806 \begin_inset Newline newline
812 \begin_inset Newline newline
818 \begin_inset Newline newline
824 \begin_inset Newline newline
832 \begin_layout LyX-Code
836 \begin_layout Standard
838 \begin_inset Flex Code
841 \begin_layout Plain Layout
848 box containing this text is directly after this paragraph.
849 Those of you reading the manual in \SpecialChar LyX
850 will only see the \SpecialChar TeX
852 Those reading a printed version of the manuals will see the actual results:
853 \begin_inset VSpace bigskip
859 \begin_layout Standard
863 \begin_layout Plain Layout
870 \begin_layout Plain Layout
877 \begin_layout Plain Layout
879 This is an example of a minipage environment.
880 You can put nearly everything in it, even (non-floating) figures and tables.
884 \begin_layout Plain Layout
891 \begin_layout Plain Layout
896 \begin_layout Plain Layout
903 \begin_layout Plain Layout
910 \begin_layout Plain Layout
917 \begin_layout Plain Layout
923 \begin_layout Plain Layout
930 \begin_layout Plain Layout
937 \begin_layout Plain Layout
944 \begin_layout Plain Layout
954 \begin_inset VSpace bigskip
960 \begin_layout Standard
961 In addition to using \SpecialChar TeX
962 code, you can also create a separate file containing
963 some complex \SpecialChar LaTeX
964 structure and then use
965 \begin_inset Flex Noun
968 \begin_layout Plain Layout
969 Insert\SpecialChar menuseparator
979 to include your file (you should select the type
980 \begin_inset Flex Code
983 \begin_layout Plain Layout
990 We recommend that you only do this if you have a
991 \begin_inset Flex Code
994 \begin_layout Plain Layout
1005 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1009 \begin_layout Standard
1010 There are a few last points to emphasize:
1013 \begin_layout Itemize
1019 check if your \SpecialChar LaTeX
1023 \begin_layout Itemize
1024 Beware of reinventing the wheel.
1027 \begin_layout Standard
1028 On that last point, \SpecialChar LyX
1029 does have quite a few features tucked into it, and
1031 Be sure to check the manuals to make sure that \SpecialChar LyX
1032 doesn't have such-and-such
1033 feature before you decide you have to do it by hand.
1034 Moreover, there are numerous \SpecialChar LaTeX
1035 packages out there to do all sorts of things,
1036 from labels to envelopes to fancy multipage tables.
1038 \begin_inset CommandInset href
1041 target "http://www.ctan.org/"
1049 \begin_layout Standard
1050 If you do need to do some wild and fancy things within your document, be
1051 sure to check out a good \SpecialChar LaTeX
1052 book for assistance.
1053 There are a number of them listed in the bibliography of the
1060 \begin_layout Section
1062 and the \SpecialChar LaTeX
1066 \begin_layout Subsection
1067 About the \SpecialChar LaTeX
1071 \begin_layout Standard
1072 If you already know \SpecialChar LaTeX
1073 , there is no need to explain here what the preamble
1075 If you don't, the following will give you some ideas—we recommend again
1076 that you consult a \SpecialChar LaTeX
1077 book for further information.
1078 In any case, you should read the points below, because they explain what
1079 you can do and what you don't need to do in the \SpecialChar LaTeX
1080 preamble of a \SpecialChar LyX
1084 \begin_layout Standard
1085 The \SpecialChar LaTeX
1086 preamble comes at the very beginning of a document,
1094 \begin_layout Itemize
1095 Declare the document class.
1097 \begin_inset Newline newline
1101 already does this for you.
1102 If you're a seasoned \SpecialChar LaTeX
1103 -nician, and you have a custom document class you
1104 want to use, check out the
1106 Customization Manual
1108 for information on how to make \SpecialChar LyX
1112 \begin_layout Itemize
1113 Declare the usage of packages.
1115 \begin_inset Newline newline
1119 packages provide special commands, which are only available within a document
1120 when the package has been declared in the preamble.
1121 In addition to providing special commands, the inclusion of a package can
1122 change the document.
1123 For example, the package
1124 \begin_inset Flex Code
1127 \begin_layout Plain Layout
1133 forces all paragraphs to be indented.
1134 There are other packages for labels, envelopes, margins, etc.
1138 \begin_layout Itemize
1139 Set counters, variables, lengths and widths.
1141 \begin_inset Newline newline
1144 There are several \SpecialChar LaTeX
1145 counters and variables that
1149 be set globally from within the preamble in order to have the desired effect.
1150 (There are variables that you can set and reset inside the document, too.)
1151 Margins are a good example of something that must be set in the preamble.
1152 Another example is the label format for lists.
1153 You can actually set these just about anywhere, but it's best to do it
1154 just once, inside the preamble.
1157 \begin_layout Itemize
1158 Declare user defined commands (with
1159 \begin_inset Flex Code
1162 \begin_layout Plain Layout
1171 \begin_inset Flex Code
1174 \begin_layout Plain Layout
1183 \begin_inset Newline newline
1186 These are abbreviations for \SpecialChar LaTeX
1187 commands which appear very often inside a document.
1188 Although the preamble is a good place to declare such commands, they
1192 be declared anywhere (before they are used for the first time, of course).
1193 This can be useful if there is a lot of raw \SpecialChar LaTeX
1194 code in your document, which
1195 normally should not be the case.
1198 \begin_layout Standard
1200 adds its own set of definitions to the preamble of the
1201 \begin_inset Flex Code
1204 \begin_layout Plain Layout
1211 This makes \SpecialChar LaTeX
1212 files generated by \SpecialChar LyX
1216 \begin_layout Subsection
1217 Changing the Preamble
1220 \begin_layout Standard
1221 The commands which \SpecialChar LyX
1222 adds to the preamble of a \SpecialChar LaTeX
1223 file are fixed; you can't
1224 change them without patching \SpecialChar LyX
1226 You can, however, add your own stuff to the preamble by selecting
1227 \begin_inset Flex Noun
1230 \begin_layout Plain Layout
1233 \begin_inset space ~
1242 \begin_inset Flex Noun
1245 \begin_layout Plain Layout
1246 Document\SpecialChar menuseparator
1254 adds anything in the
1255 \begin_inset Flex Noun
1258 \begin_layout Plain Layout
1264 dialog to its own built-in preamble.
1265 Before adding your own declarations in the preamble, you should make sure
1266 that \SpecialChar LyX
1267 doesn't already support what you want to do.
1268 (Remember what we said about reinventing the wheel?) Also,
1270 make sure your preamble code is correct
1274 doesn't check it for you.
1275 If there is an error, you're likely to get an error like
1276 \begin_inset Quotes eld
1280 \begin_inset Flex Code
1283 \begin_layout Plain Layout
1292 \begin_inset Quotes erd
1296 If you see this error, check your preamble.
1299 \begin_layout Subsection
1303 \begin_layout Standard
1304 Here are some examples of what you can add to a preamble, and what they
1308 \begin_layout Subsubsection
1312 \begin_layout Standard
1313 There are two variables under \SpecialChar LaTeX
1314 that control page position:
1315 \begin_inset Flex Code
1318 \begin_layout Plain Layout
1327 \begin_inset Flex Code
1330 \begin_layout Plain Layout
1339 Their names should be self-explanatory.
1340 These variables are useful if you think for a moment about computer labels.
1341 Sometimes, the size of a print medium and the area of the medium that you
1342 can actually print on aren't the same.
1344 \begin_inset Flex Code
1347 \begin_layout Plain Layout
1356 \begin_inset Flex Code
1359 \begin_layout Plain Layout
1370 \begin_layout Standard
1371 The default values for
1372 \begin_inset Flex Code
1375 \begin_layout Plain Layout
1384 \begin_inset Flex Code
1387 \begin_layout Plain Layout
1396 \begin_inset space \thinspace{}
1400 \begin_inset space \thinspace{}
1404 \begin_inset space \space{}
1407 the page isn't shifted.
1408 Unfortunately, some DVI drivers always seem to shift the page.
1409 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1410 If you're using \SpecialChar LyX
1411 on a system that you don't personally maintain, and your
1412 sysadmin is a doofus,
1413 \begin_inset Flex Code
1416 \begin_layout Plain Layout
1425 \begin_inset Flex Code
1428 \begin_layout Plain Layout
1437 Suppose your left and top margins are always 0.5
1438 \begin_inset space \thinspace{}
1442 You can add this to the preamble:
1445 \begin_layout LyX-Code
1453 \begin_layout LyX-Code
1461 \begin_layout Standard
1462 and your margins should now be correct.
1465 \begin_layout Subsubsection
1469 \begin_layout Standard
1470 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1471 There's a rather nice package, available at your nearest CTAN archive,
1472 for printing sheets of labels:
1473 \begin_inset Flex Code
1476 \begin_layout Plain Layout
1483 Now, your system may not have this package installed by default.
1484 We leave that up to you to check.
1485 You'll also want to read the documentation for it; we're not going to do
1487 Since this is an example, however, we'll give you an example of how you
1491 \begin_layout Standard
1492 First, make sure you're using the
1493 \begin_inset Flex Code
1496 \begin_layout Plain Layout
1503 Next, you need to put the following in your preamble:
1506 \begin_layout LyX-Code
1512 \begin_layout LyX-Code
1518 \begin_layout LyX-Code
1524 \begin_layout LyX-Code
1530 \begin_layout LyX-Code
1536 \begin_layout LyX-Code
1542 \begin_layout LyX-Code
1548 \begin_layout Standard
1549 This sets things up for Avery label sheets, stock #5360.
1550 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1553 \begin_inset Flex Code
1556 \begin_layout Plain Layout
1565 \begin_inset Flex Code
1568 \begin_layout Plain Layout
1576 around each label text.
1577 This and other special features of
1578 \begin_inset Flex Code
1581 \begin_layout Plain Layout
1587 are explained in its documentation.
1590 \begin_layout Standard
1591 Someday, someone may write a \SpecialChar LyX
1592 layout file to support this package directly.
1593 Maybe that someone is you.
1596 \begin_layout Subsubsection
1597 Example #3: Paragraph Indentation
1600 \begin_layout Standard
1601 Americans are trained to indent the first line of
1606 As with all of their other weird quirks, most Americans will whine and
1607 moan until they can have their way and indent the first line of all paragraphs.
1616 \begin_layout Standard
1617 Of course, this behavior isn't standard typography.
1618 In books, you typically only indent the first line of a paragraph
1622 it follows another one.
1623 The idea behind indenting the first line of a paragraph is to distinguish
1624 neighboring paragraphs from one another.
1625 If there is no previous paragraph—for example, if it follows a figure or
1626 is the first paragraph in a section—then there is no need for indentation.
1630 \begin_layout Standard
1631 If you're a typical American (we're still joking!), though, you don't care
1632 about such esoteric things; you want your indentation! Add this to the
1636 \begin_layout LyX-Code
1639 usepackage{indentfirst}
1642 \begin_layout Standard
1643 If your \SpecialChar TeX
1644 distribution isn't braindead, you'll have this package, and all
1645 of your paragraphs will get the indentation the Founding Fathers intended
1649 \begin_layout Subsubsection
1650 Example #4: This Document
1653 \begin_layout Standard
1654 You can also check out the preamble of this document to get an idea of some
1655 of the advanced things you can do.
1658 \begin_layout Section
1660 and \SpecialChar LaTeX
1664 \begin_layout Standard
1665 When \SpecialChar LyX
1666 calls \SpecialChar LaTeX
1667 , it tells \SpecialChar LaTeX
1668 to blithely ignore any errors and keep going.
1669 It then uses the logfile from the \SpecialChar LaTeX
1670 run to do a post-mortem.
1671 After analyzing the logfile, \SpecialChar LyX
1672 displays a dialog listing the errors.
1673 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1675 where the error occurred.
1679 \begin_layout Plain Layout
1681 Analyzing the logfile is a tough job, and \SpecialChar LyX
1682 doesn't always go to the right
1684 There are also cases where \SpecialChar LaTeX
1685 reports the error on one line, but the actual
1687 This is not unlike forgetting a closing brace in a program: You'll get
1688 an error, but only later.
1696 \begin_layout Standard
1697 Some folks also like to look at the log file directly: It is available from
1699 \begin_inset Flex Noun
1702 \begin_layout Plain Layout
1703 Document\SpecialChar menuseparator
1705 \begin_inset space ~
1714 There are some fairly common error messages and warnings.
1715 We'll cover those here.
1716 You should look at a good \SpecialChar LaTeX
1717 book for a complete listing.
1720 \begin_layout Itemize
1721 \begin_inset Flex Code
1724 \begin_layout Plain Layout
1731 \begin_inset Newline newline
1734 Anything beginning with these words is a warning message for the purpose
1736 \begin_inset Quotes eld
1740 \begin_inset Quotes erd
1743 the \SpecialChar LaTeX
1745 You'll get messages like this if you added or changed cross-references
1746 or bibliography entries, in which case, \SpecialChar LaTeX
1747 is trying to tell you that you
1748 need to make another run.
1749 You can by-and-large ignore these.
1752 \begin_layout Itemize
1753 \begin_inset Flex Code
1756 \begin_layout Plain Layout
1763 \begin_inset Newline newline
1766 Another warning message, this time about fonts which \SpecialChar LaTeX
1768 The rest of the message will often say something about a replacement font
1769 that \SpecialChar LaTeX
1771 You can safely ignore these, too.
1774 \begin_layout Itemize
1775 \begin_inset Flex Code
1778 \begin_layout Plain Layout
1787 \begin_inset Newline newline
1796 It seems to generate at least one of these messages for just about any
1798 They are warnings about lines that were too long and run past the right
1800 This happens if \SpecialChar LaTeX
1801 does not find a reasonable way to break the lines (notoriously
1802 often with typewriter font, since this does not allow for automatic break
1804 In many cases, this is unnoticeable in the final output.
1805 (It can be just a point or two.) Sometimes, however, the lines run rather
1806 visibly into the margin; something you will not want to have in your final
1809 \begin_inset Newline newline
1812 There are several global ways to try to minimize the overfull lines.
1815 Enable micro-typographic extensions
1819 Document\SpecialChar menuseparator
1820 Settings\SpecialChar menuseparator
1823 might already improve things a lot.
1824 Furthermore, \SpecialChar LaTeX
1825 code such as the following in
1827 Document\SpecialChar menuseparator
1828 Settings\SpecialChar menuseparator
1831 usually reduces the overfull lines drastically (we use this in the preamble
1836 \begin_layout LyX-Code
1840 \begin_inset Newline newline
1846 \begin_inset Newline newline
1851 emergencystretch 1.5em
1852 \begin_inset Newline newline
1860 \begin_layout Standard
1861 In some cases, however, you eventually have to rewrite the text to get the
1862 line breaking right.
1866 \begin_layout Plain Layout
1867 For more information, see
1868 \begin_inset Flex URL
1871 \begin_layout Plain Layout
1873 http://www.tex.ac.uk/FAQ-overfull.html
1886 \begin_layout Standard
1887 In any case, you should check the respective lines, at least for the final
1888 version of your document.
1889 Your eyes will tell you if there's a problem with something that's too
1894 \begin_layout Plain Layout
1895 You can also enable the `draft' option in
1896 \begin_inset Flex Noun
1899 \begin_layout Plain Layout
1900 Document\SpecialChar menuseparator
1906 , and then \SpecialChar LaTeX
1907 will draw a black box in the margin of lines that are overfull.
1916 \begin_layout Itemize
1917 \begin_inset Flex Code
1920 \begin_layout Plain Layout
1929 \begin_inset Newline newline
1932 Not quite as common as its cousin.
1933 This happens again if \SpecialChar LaTeX
1934 does not find a reasonable break point and consequently
1935 generates too loose lines.
1936 As with the overfull lines, you should check if this is a visible problem.
1939 \begin_layout Itemize
1940 \begin_inset Flex Code
1943 \begin_layout Plain Layout
1952 \begin_inset Flex Code
1955 \begin_layout Plain Layout
1964 \begin_inset Newline newline
1967 Warnings about troubles breaking the page.
1968 Once again, just look at the output.
1969 Your eyes will tell you where something has gone wrong.
1972 \begin_layout Itemize
1973 \begin_inset Flex Code
1976 \begin_layout Plain Layout
1978 \begin_inset Quotes els
1982 \begin_inset Quotes ers
1991 \begin_inset Newline newline
1995 \begin_inset Quotes eld
1999 \begin_inset Quotes erd
2002 isn't installed on this system.
2003 This usually appears because some package your document needs isn't installed.
2004 If you didn't touch the preamble or didn't use the
2005 \begin_inset Flex Code
2008 \begin_layout Plain Layout
2016 command, then one of the packages \SpecialChar LyX
2017 tried to load is missing.
2019 \begin_inset Flex Noun
2022 \begin_layout Plain Layout
2023 Help\SpecialChar menuseparator
2030 to get a list of packages that \SpecialChar LyX
2032 This file is updated whenever you reconfigure \SpecialChar LyX
2034 \begin_inset Flex Noun
2037 \begin_layout Plain Layout
2038 Tools\SpecialChar menuseparator
2044 ) and tells you which packages have been detected and what they do.
2045 \begin_inset Newline newline
2049 \begin_inset Flex Code
2052 \begin_layout Plain Layout
2060 command and the package in question isn't installed, then you'll need to
2061 install it yourself.
2064 \begin_layout Itemize
2065 \begin_inset Flex Code
2068 \begin_layout Plain Layout
2069 LaTeX Error: Unknown option
2075 \begin_inset Newline newline
2078 Error messages beginning with this are trying to tell you that you specified
2079 a bad or undefined option to a package.
2080 Check the package's documentation.
2083 \begin_layout Itemize
2084 \begin_inset Flex Code
2087 \begin_layout Plain Layout
2088 Undefined control sequence
2094 \begin_inset Newline newline
2097 If you've inserted \SpecialChar LaTeX
2098 code into your document, but made a typo, you'll get
2100 You may have forgotten to load a package.
2101 In any case, this error message usually means that you used an undefined
2106 \begin_layout Standard
2107 There are other error and warning messages.
2108 Some are self-explanatory.
2109 These are usually \SpecialChar LaTeX
2111 Others are downright cryptic.
2112 These are usually \SpecialChar TeX
2113 error messages, and we really have
2117 what they mean or how to decipher them.
2121 \begin_layout Standard
2122 There's a general sequence you should follow if you get error messages:
2125 \begin_layout Enumerate
2126 Look at the \SpecialChar LaTeX
2127 code you inserted for typos.
2130 \begin_layout Enumerate
2131 If there are no typos, check that you used the command(s) correctly.
2134 \begin_layout Enumerate
2135 If you get a bunch of error boxes piled up at the very top of the document—and
2136 especially if you see a
2137 \begin_inset Quotes eld
2141 \begin_inset Flex Code
2144 \begin_layout Plain Layout
2153 \begin_inset Quotes erd
2156 error—it means that there are errors in the preamble.
2157 Start debugging your preamble.
2160 \begin_layout Enumerate
2161 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2163 document, the first suspect is your \SpecialChar LaTeX
2164 distribution itself.
2165 Check for missing packages and install them.
2168 \begin_layout Enumerate
2169 Okay, so there are no missing packages.
2170 Did you use any of the fine-tuning options in \SpecialChar LyX
2171 ? Specifically, did you
2175 any of them, like trying to manually insert lots of
2176 \begin_inset Flex Code
2179 \begin_layout Plain Layout
2181 \begin_inset space ~
2190 \begin_inset Flex Code
2193 \begin_layout Plain Layout
2200 \begin_inset Flex Code
2203 \begin_layout Plain Layout
2209 ? Did you try to kludge something together with these instead of using the
2210 appropriate paragraph environment?
2213 \begin_layout Enumerate
2214 All right, you didn't use any of the fine-tuning options, you played by
2216 Did you try to pull a fancy maneuver? Did you do something funky inside
2217 a table or an equation, like inserting a graphic into a table cell?
2220 \begin_layout Enumerate
2221 Do you have long sections of text where \SpecialChar LaTeX
2222 cannot find a place to break a
2223 line? By default, \SpecialChar LaTeX
2224 is rather strict about how much extra inter-word spacing
2225 it will add in order to break a line.
2226 Preferably, you should rework the paragraph to avoid the problem.
2229 \begin_layout Enumerate
2230 Did you go overboard with the nesting? \SpecialChar LyX
2231 (currently) doesn't check to make
2232 sure you're in the limits for nesting environments.
2233 If you nested a bunch of environments to the
2234 \begin_inset Formula $17^{\mathrm{th}}$
2237 level, that's the problem.
2238 (The limit in \SpecialChar LaTeX
2242 \begin_layout Enumerate
2243 Okay, you didn't get any error messages, but your output looks awful.
2244 If you have a table or figure that's too wide or long for the page, you
2249 \begin_layout Enumerate
2250 rescale the figure so it fits.
2253 \begin_layout Enumerate
2254 trim down the table so it fits.
2258 \begin_layout Enumerate
2259 If something else is wrong with the output, and you didn't try to pull anything
2260 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2263 \begin_layout Standard
2264 If all this doesn't help—well, then
2268 you might have found a bug in \SpecialChar LyX
2273 \begin_layout Chapter
2277 \begin_layout Section
2278 Customizing Bibliographies with Bib\SpecialChar TeX
2282 \begin_layout Standard
2283 The most basic information about how to use Bib\SpecialChar TeX
2288 with \SpecialChar LyX
2289 is contained in the section
2291 Bibliography databases
2298 The following subsections explain special bibliography features supported
2303 \begin_layout Subsection
2304 Alternative Citation Styles
2307 \begin_layout Standard
2308 Standard Bib\SpecialChar TeX
2310 \begin_inset space \thinspace{}
2314 \begin_inset space \space{}
2318 \begin_inset Quotes eld
2322 \begin_inset Quotes erd
2325 ) to refer to a cited work.
2326 However, in many scientific disciplines, other citation styles are in use.
2327 The most common one is the author-year style (e.
2328 \begin_inset space \thinspace{}
2332 \begin_inset space \space{}
2336 \begin_inset Quotes eld
2340 \begin_inset Quotes erd
2345 supports three packages that provide this style,
2346 \begin_inset Flex Code
2349 \begin_layout Plain Layout
2356 \begin_inset Flex Code
2359 \begin_layout Plain Layout
2366 \begin_inset Flex Code
2369 \begin_layout Plain Layout
2376 Each of these packages has their pros and cons, which cannot be listed
2378 If you only want to have simple author-year (or author-numerical) style,
2379 or if you want to use one of the countless style files for
2380 \begin_inset Flex Code
2383 \begin_layout Plain Layout
2389 , then the established
2390 \begin_inset Flex Code
2393 \begin_layout Plain Layout
2399 package is probably your choice.
2400 If you look for specific citation styles common in law studies, you might
2402 \begin_inset Flex Code
2405 \begin_layout Plain Layout
2412 If you want to have full control over the formatting or look for advanced
2413 features such as ibidem, footnote citations, full title citations, advanced
2414 date formats (such as 400 BC) or full localization to other languages than
2415 English, you should definitely consider
2416 \begin_inset Flex Code
2419 \begin_layout Plain Layout
2425 , which exceeds all other packages in terms of features, but is also quite
2426 heavy and more resource-hungry.
2429 \begin_layout Standard
2430 The handling of these packages in \SpecialChar LyX
2431 is basically the same.
2433 \begin_inset Flex Noun
2436 \begin_layout Plain Layout
2437 Document\SpecialChar menuseparator
2444 \begin_inset Flex Noun
2447 \begin_layout Plain Layout
2454 \begin_inset Flex Noun
2457 \begin_layout Plain Layout
2464 \begin_inset Flex Noun
2467 \begin_layout Plain Layout
2474 \begin_inset Flex Noun
2477 \begin_layout Plain Layout
2478 Biblatex (Natbib mode)
2484 \begin_inset Flex Noun
2487 \begin_layout Plain Layout
2494 \begin_inset Flex Noun
2497 \begin_layout Plain Layout
2504 \begin_inset space ~
2507 6.5.3 in the User's Guide for more information on these choices).
2508 With all these packages, you will get some extra features in the citation
2509 dialog and you can select the style of the reference (
2510 \begin_inset Quotes eld
2514 \begin_inset Quotes erd
2518 \begin_inset Quotes eld
2522 \begin_inset Quotes erd
2526 \begin_inset Quotes eld
2530 \begin_inset Quotes erd
2534 \begin_inset Quotes eld
2538 \begin_inset Quotes erd
2542 Note that either package needs specifically designed style files.
2543 They all ship their own, but there are lots of additional style files,
2544 and there is even an interactive style file builder
2548 \begin_layout Plain Layout
2550 \begin_inset Flex URL
2553 \begin_layout Plain Layout
2555 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2566 \begin_inset Flex Code
2569 \begin_layout Plain Layout
2578 \begin_layout Subsection
2579 Subdivided Bibliographies
2582 \begin_layout Standard
2583 Sometimes you might need to divide your bibliography into several sections.
2584 If you are for instance a historian, the possibility to separate sources
2585 and scientific works is most likely a
2586 \begin_inset Quotes eld
2590 \begin_inset Quotes erd
2594 Unfortunately, Bib\SpecialChar TeX
2595 itself does not allow you to do this.
2596 But with the help of some \SpecialChar LaTeX
2597 packages, Bib\SpecialChar TeX
2598 can be extended to fit your needs.
2601 \begin_layout Standard
2603 provides native support for one of these packages,
2611 \begin_layout Plain Layout
2613 \begin_inset Flex URL
2616 \begin_layout Plain Layout
2618 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2628 The advantage of this package (compared to other packages such as
2632 ) is that you don't need to define new citation commands.
2633 Instead, you need to prepare different bibliographic databases which include
2634 the entries for the different sections of the bibliography.
2635 For example: If you want to divide your bibliography into the sections
2637 \begin_inset Quotes eld
2641 \begin_inset Quotes erd
2645 \begin_inset Quotes eld
2649 \begin_inset Quotes erd
2652 , you first need to create two bibliographic databases, e.
2653 \begin_inset space \thinspace{}
2657 \begin_inset space \space{}
2661 \begin_inset Flex Code
2664 \begin_layout Plain Layout
2671 \begin_inset Flex Code
2674 \begin_layout Plain Layout
2684 \begin_layout Standard
2686 \begin_inset Flex Noun
2689 \begin_layout Plain Layout
2690 Document\SpecialChar menuseparator
2697 \begin_inset Flex Noun
2700 \begin_layout Plain Layout
2707 \begin_inset Flex Noun
2710 \begin_layout Plain Layout
2711 Subdivided bibliography
2717 Now you can insert multiple Bib\SpecialChar TeX
2718 bibliographies, one for each section of
2720 Returning to our example: Insert the Bib\SpecialChar TeX
2722 \begin_inset Flex Code
2725 \begin_layout Plain Layout
2731 and a second one for the database
2732 \begin_inset Flex Code
2735 \begin_layout Plain Layout
2742 You are free to use the same or different styles for each section.
2743 Additionally, you can choose if the bibliography section should contain
2745 \begin_inset Quotes eld
2748 all cited references
2749 \begin_inset Quotes erd
2752 of the specified database(s) (which is the default),
2753 \begin_inset Quotes eld
2756 all uncited references
2757 \begin_inset Quotes erd
2761 \begin_inset Quotes eld
2765 \begin_inset Quotes erd
2769 This might be useful if you would like to separate your bibliography into
2771 \begin_inset Quotes eld
2775 \begin_inset Quotes erd
2779 \begin_inset Quotes eld
2783 \begin_inset Quotes erd
2787 \begin_inset Quotes eld
2791 \begin_inset Quotes erd
2795 The titles for the sections can be added as ordinary sections or subsections.
2797 \begin_inset Flex Code
2800 \begin_layout Plain Layout
2806 removes the bibliography title, you have to manually re-add that, too (as
2807 a chapter* or section*, for instance).
2810 \begin_layout Standard
2815 , the procedure is a bit different.
2824 , the aforementioned
2825 \begin_inset Flex Noun
2828 \begin_layout Plain Layout
2829 Subdivided bibliography
2834 option is disabled if you use
2843 provides its own means to generate subdivided bibliographies.
2844 You can either add keywords to bibliography entries via the
2845 \begin_inset Flex Code
2848 \begin_layout Plain Layout
2854 entry option and then filter bibliography sections by keyword (by adding
2856 \begin_inset Flex Code
2859 \begin_layout Plain Layout
2866 \begin_inset Flex Noun
2869 \begin_layout Plain Layout
2875 field of the dialog that opens if you right-click on the
2876 \begin_inset Flex Noun
2879 \begin_layout Plain Layout
2880 Biblatex Generated Bibliography
2885 button), or you can filter by entry types (such as
2894 \begin_inset space \thinspace{}
2899 \begin_inset Flex Code
2902 \begin_layout Plain Layout
2909 \begin_inset Flex Code
2912 \begin_layout Plain Layout
2919 \begin_inset Flex Noun
2922 \begin_layout Plain Layout
2928 field, or you can create so-called
2929 \begin_inset Quotes eld
2932 Bibliography Categories
2933 \begin_inset Quotes erd
2936 to which you can assign individual entries.
2937 Please refer to the Biblatex manual, section
2939 Subdivided Bibliographies
2944 \begin_layout Subsection
2945 Multiple Bibliographies
2946 \begin_inset CommandInset label
2948 name "subsec:Multiple-Bibliographies"
2955 \begin_layout Standard
2956 Multiple bibliographies, e.
2957 \begin_inset space \thinspace{}
2961 \begin_inset space \space{}
2964 a bibliography for each part, chapter, section, subsection or child (sub-documen
2965 t) of the document, are also supported by \SpecialChar LyX
2967 In order to enable it, go to
2968 \begin_inset Flex Noun
2971 \begin_layout Plain Layout
2972 Document\SpecialChar menuseparator
2973 Settings\SpecialChar menuseparator
2979 and select the relevant unit (e.
2980 \begin_inset space \thinspace{}
2984 \begin_inset Quotes eld
2988 \begin_inset Quotes erd
2992 \begin_inset Flex Noun
2995 \begin_layout Plain Layout
2996 Multiple Bibliographies
3002 Then add a Bib(la)\SpecialChar TeX
3003 bibliography to each unit (e.
3004 \begin_inset space \thinspace{}
3007 g., section) of your document.
3008 In the output, a separate bibliography, containing only the references
3009 done in the current unit is generated.
3012 \begin_layout Standard
3013 If you use Bib\SpecialChar TeX
3015 \begin_inset Flex Code
3018 \begin_layout Plain Layout
3025 \begin_inset Flex Code
3028 \begin_layout Plain Layout
3034 package is used to create multiple bibliographies.
3035 The former package is used if you select
3036 \begin_inset Quotes eld
3040 \begin_inset Quotes erd
3048 \begin_inset Flex Noun
3051 \begin_layout Plain Layout
3052 Sectioned Bibliography
3059 \begin_inset Flex Code
3062 \begin_layout Plain Layout
3072 \begin_layout Plain Layout
3073 An alternative approach, if you are willing to use some
3074 \begin_inset Flex Noun
3077 \begin_layout Plain Layout
3085 \begin_inset space ~
3089 \begin_inset CommandInset ref
3091 reference "sec:Inserting-TeX-Code"
3096 \begin_inset Flex Code
3099 \begin_layout Plain Layout
3111 \begin_inset Flex Code
3114 \begin_layout Plain Layout
3120 is used, \SpecialChar LyX
3121 encloses the specified units in
3122 \begin_inset Flex Code
3125 \begin_layout Plain Layout
3132 \begin_inset Flex Code
3135 \begin_layout Plain Layout
3144 \begin_inset Flex Code
3147 \begin_layout Plain Layout
3155 in order to create the units.
3156 Note that this approach has some limitations.
3157 First, every citation reference has to be inside some
3158 \begin_inset Flex Code
3161 \begin_layout Plain Layout
3168 So citations outside a defined unit (e.
3169 \begin_inset space \thinspace{}
3172 g., before the first section if you use
3173 \begin_inset Quotes eld
3177 \begin_inset Quotes erd
3181 \begin_inset Quotes eld
3185 \begin_inset Quotes erd
3189 You can also create your own units by entering
3190 \begin_inset Flex Code
3193 \begin_layout Plain Layout
3202 \begin_inset Flex Code
3205 \begin_layout Plain Layout
3214 code (for instance to work around the mentioned limitation).
3216 \begin_inset Flex Code
3219 \begin_layout Plain Layout
3226 A second limitation is that
3227 \begin_inset Flex Code
3230 \begin_layout Plain Layout
3236 always processes all references of a bibliography database, even if they
3238 This can result in odd labels (e.
3239 \begin_inset space \thinspace{}
3244 \begin_inset Quotes eld
3248 \begin_inset Quotes erd
3251 if two works of this author from 2014 are in the database, even if only
3255 \begin_layout Standard
3261 \begin_inset Flex Code
3264 \begin_layout Plain Layout
3270 option is used instead.
3271 If you need specific units, you can start them with the \SpecialChar TeX
3273 \begin_inset Flex Code
3276 \begin_layout Plain Layout
3285 \begin_inset Flex Code
3288 \begin_layout Plain Layout
3297 If you also want to control the end of the unit, use the environment
3298 \begin_inset Flex Code
3301 \begin_layout Plain Layout
3311 \begin_inset Flex Code
3314 \begin_layout Plain Layout
3324 \begin_inset Flex Code
3327 \begin_layout Plain Layout
3334 In addition to the individual bibliography of the current unit,
3338 also provides an easy way to output all bibliographies, subsequently, at
3340 \begin_inset space \thinspace{}
3343 g., at the end of the document).
3345 \begin_inset Quotes eld
3349 \begin_inset Quotes erd
3352 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3358 manual for more information on this topic.
3361 \begin_layout Section
3365 \begin_layout Subsection
3369 \begin_layout Standard
3370 When you are working on a large file with many sections, it is often convenient
3371 to break up the document into several files, or perhaps you have something
3372 where a table may change from time to time, but the preceding text does
3374 In these cases, you should seriously consider using multipart documents.
3375 For example, scientific papers often have five major sections: the introduction
3376 , observations, results, discussion, and conclusion.
3377 Each of these could be its own separate \SpecialChar LyX
3379 \begin_inset Quotes eld
3383 \begin_inset Quotes erd
3386 file which contains the title, authors, abstract, references, etc., plus
3387 the five included files.
3388 It is important to note that each of these files is a full \SpecialChar LyX
3390 can be formatted and printed on its own, as well as included in a master
3392 Each of these files must have the same document class, however—don't attempt
3393 to mix book classes with article classes.
3394 You may also include \SpecialChar LaTeX
3395 files; however, these files must not have their own
3397 \begin_inset space \thinspace{}
3401 \begin_inset space \space{}
3404 everything up to and including the
3405 \begin_inset Flex Code
3408 \begin_layout Plain Layout
3417 \begin_inset Flex Code
3420 \begin_layout Plain Layout
3428 line must be deleted) or else errors will be generated when you try to
3432 \begin_layout Standard
3434 allows you to include files quite easily with
3435 \begin_inset Flex Noun
3438 \begin_layout Plain Layout
3439 Insert\SpecialChar menuseparator
3441 \begin_inset space ~
3450 When you click on this selection a small box is inserted into the file
3451 at the current cursor location.
3452 Clicking on the box raises a dialog which allows you to select the file
3453 to be included, and the method of its inclusion.
3457 \begin_layout Standard
3458 The file selection box should by now be obvious.
3459 The three inclusion methods are
3460 \begin_inset Quotes eld
3464 \begin_inset Quotes erd
3468 \begin_inset Quotes eld
3472 \begin_inset Quotes erd
3476 \begin_inset Quotes eld
3480 \begin_inset Quotes erd
3485 \begin_inset Quotes eld
3489 \begin_inset Quotes erd
3493 \begin_inset Quotes eld
3497 \begin_inset Quotes erd
3500 are similar in many ways, but there are also some notable differences:
3503 \begin_layout Enumerate
3505 \begin_inset Quotes eld
3509 \begin_inset Quotes erd
3512 are typeset beginning on a new page, while files that are
3513 \begin_inset Quotes eld
3517 \begin_inset Quotes erd
3520 are typeset starting on the current page.
3523 \begin_layout Enumerate
3524 \begin_inset Quotes eld
3528 \begin_inset Quotes erd
3531 files cannot themselves
3532 \begin_inset Quotes eld
3536 \begin_inset Quotes erd
3540 \begin_inset Quotes eld
3544 \begin_inset Quotes erd
3549 \begin_inset Quotes eld
3553 \begin_inset Quotes erd
3556 , on the other hand, infinite sub-inputting is possible.
3559 \begin_layout Enumerate
3560 \begin_inset Quotes eld
3564 \begin_inset Quotes erd
3567 allow for the output of only selected
3568 \begin_inset Quotes eld
3572 \begin_inset Quotes erd
3575 files, while maintaining the actual counters (pagination etc.) and references
3576 (please refer to the section
3579 \begin_inset space ~
3587 \begin_inset space ~
3592 manual for details).
3595 \begin_layout Standard
3597 \begin_inset Quotes eld
3601 \begin_inset Quotes erd
3604 is the preferred method for chapters that are outsourced to child documents,
3606 \begin_inset Quotes eld
3610 \begin_inset Quotes erd
3613 is more suitable for arbitrary file inheritance.
3616 \begin_layout Standard
3618 \begin_inset Quotes eld
3622 \begin_inset Quotes erd
3625 included file allows you to include a file typeset exactly as it appears
3627 \begin_inset space \thinspace{}
3631 \begin_inset space \space{}
3635 \begin_inset Flex Code
3638 \begin_layout Plain Layout
3644 mode, with the characters set in a fixed-width typewriter font.
3645 Normally, spaces in this file are invisible, though two consecutive spaces
3646 are conserved, unlike \SpecialChar LyX
3647 's normal treatment of spaces.
3648 However, setting the
3649 \begin_inset Flex Noun
3652 \begin_layout Plain Layout
3654 \begin_inset space ~
3658 \begin_inset space ~
3662 \begin_inset space ~
3670 checkbox typesets a mark to unambiguously define the presence of a space.
3674 \begin_layout Standard
3675 Generally, the master file is converted into a full \SpecialChar LaTeX
3676 file before typesetting,
3677 while the included files are converted to \SpecialChar LaTeX
3678 files that do not have all the
3679 preamble information.
3682 \begin_layout Subsection
3683 Cross-References Between Files
3686 \begin_layout Standard
3687 \begin_inset Box Shadowbox
3697 height_special "totalheight"
3702 backgroundcolor "none"
3705 \begin_layout Plain Layout
3706 This section is somewhat out of date.
3707 Need to describe default master documents and how children are opened when
3717 \begin_layout Standard
3718 It is possible to set up cross-references between the different files.
3719 First, open all the files in question: let's call them A and B in a two
3720 file example, where B is included in A.
3721 Let's say you insert a label in A, then want to reference it in B.
3722 Open the cross-reference dialog whilst in document B, and you can select
3724 \begin_inset Quotes eld
3728 \begin_inset Quotes erd
3734 \begin_layout Subsection
3735 Bibliography Lists in all Subdocuments
3738 \begin_layout Standard
3739 If you work with child documents, you might want to have only one main bibliogra
3740 phy at the end, but still be able to have a selected bibliography for the
3741 child if you output it on its own.
3742 Here is how to achieve this.
3745 \begin_layout Standard
3746 For the main document, you just insert a bibliography inset at the place
3747 where the main bibliography has to appear (within the master file or within
3749 If the bibliography inset is in the master file, the references will be
3750 inherited by all children, so they are available in the citation dialog
3754 \begin_layout Standard
3755 For child-specific bibliographies, insert bibliography insets within the
3756 child documents, at the place where the bibliography should appear when
3757 the child is compiled separately.
3758 However, the trick is to insert them into a branch (
3760 Insert\SpecialChar menuseparator
3761 Branch\SpecialChar menuseparator
3762 Insert New Branch...
3765 \begin_inset space \thinspace{}
3770 \begin_inset Quotes eld
3774 \begin_inset Quotes erd
3778 Within the children, activate the branch (
3780 Document\SpecialChar menuseparator
3781 Settings...\SpecialChar menuseparator
3785 Within the master, deactivate the branch (
3787 Document\SpecialChar menuseparator
3788 Settings...\SpecialChar menuseparator
3792 Now the child's bibliography will be ignored by the master, but considered
3796 \begin_layout Standard
3797 If you need multiple bibliographies (e.
3798 \begin_inset space \thinspace{}
3801 g., one per child in the
3805 ), please refer to sec.
3806 \begin_inset space ~
3810 \begin_inset CommandInset ref
3812 reference "subsec:Multiple-Bibliographies"
3819 \begin_layout Section
3824 \begin_layout Standard
3825 Users sometimes need to be able to
3826 \begin_inset Quotes eld
3830 \begin_inset Quotes erd
3834 file together with all the images (and other files) on which it depends,
3835 either for sending to a publisher or for sharing with a co-author.
3837 includes a Python script (
3838 \begin_inset Flex Code
3841 \begin_layout Plain Layout
3847 ) that automates this process.
3848 To use it, you must have either the
3849 \begin_inset Flex Code
3852 \begin_layout Plain Layout
3859 \begin_inset Flex Code
3862 \begin_layout Plain Layout
3868 python modules installed on your system.
3869 By default, the script prefers the
3870 \begin_inset Flex Code
3873 \begin_layout Plain Layout
3880 \begin_inset Flex Code
3883 \begin_layout Plain Layout
3889 format on Unix-like systems and the
3890 \begin_inset Flex Code
3893 \begin_layout Plain Layout
3902 \begin_layout Standard
3904 's configuration process will set the script up to export a `\SpecialChar LyX
3906 and this format will then be available under
3907 \begin_inset Flex Code
3910 \begin_layout Plain Layout
3911 File\SpecialChar menuseparator
3920 \begin_layout Standard
3921 Independently of the platform, the generation of a particular archive format
3922 can be forced by adding either the
3923 \begin_inset Flex Code
3926 \begin_layout Plain Layout
3933 \begin_inset Flex Code
3936 \begin_layout Plain Layout
3943 \begin_inset Flex Code
3946 \begin_layout Plain Layout
3953 \begin_inset Flex Code
3956 \begin_layout Plain Layout
3962 format) switch to the
3963 \begin_inset Flex Code
3966 \begin_layout Plain Layout
3968 \SpecialChar menuseparator
3976 \begin_inset Flex Code
3979 \begin_layout Plain Layout
3980 Tools\SpecialChar menuseparator
3981 Preferences\SpecialChar menuseparator
3982 File Handling\SpecialChar menuseparator
3989 (Make sure you add the switch after the script name, not before it.)
3992 \begin_layout Section
3993 Fancy Headers and Footers
3996 \begin_layout Standard
3997 The default page layout is rather plain; for an
3998 \begin_inset Flex Code
4001 \begin_layout Plain Layout
4007 document class, all you get is a centered page number at the bottom of
4009 This document uses KOMA-script's book class, so it appears to be a bit
4011 But to really put on a show, you need to set the document page style to
4013 \begin_inset Quotes eld
4017 \begin_inset Quotes erd
4020 , as mentioned in the
4025 This section describes the \SpecialChar LaTeX
4026 code you need to insert in your \SpecialChar LaTeX
4028 order to get the desired effects.
4031 \begin_layout Standard
4032 For more information on fancy headers, see the
4033 \begin_inset Flex Code
4036 \begin_layout Plain Layout
4042 package documentation.
4044 \begin_inset Flex URL
4047 \begin_layout Plain Layout
4049 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4057 \begin_layout Standard
4058 The page header is divided into three fields, not surprisingly labeled
4059 \begin_inset Quotes eld
4063 \begin_inset Quotes erd
4067 \begin_inset Quotes eld
4071 \begin_inset Quotes erd
4075 \begin_inset Quotes eld
4079 \begin_inset Quotes erd
4083 The footer is also divided into these three fields.
4084 The \SpecialChar LaTeX
4085 commands to set these fields in the simplest manner are
4086 \begin_inset Flex Code
4089 \begin_layout Plain Layout
4098 \begin_inset Flex Code
4101 \begin_layout Plain Layout
4110 \begin_inset Flex Code
4113 \begin_layout Plain Layout
4122 \begin_inset Flex Code
4125 \begin_layout Plain Layout
4134 Suppose you wish to put your name in the upper left hand corner of each
4136 Simply insert the following command in the preamble:
4139 \begin_layout Standard
4148 \begin_layout Standard
4149 You will now see your name in the upper left.
4150 If a field has a default entry that you would like to get rid of (often
4151 the page number appears in the central footer) simply include a command
4152 with a blank argument, e.
4153 \begin_inset space \thinspace{}
4159 \begin_layout Standard
4167 \begin_layout Standard
4168 Let's get really fancy: lets put the section number with the word
4169 \begin_inset Quotes eld
4173 \begin_inset Quotes erd
4177 \begin_inset space \thinspace{}
4181 \begin_inset space \space{}
4184 Section 3) in the upper left, the page number (e.
4185 \begin_inset space \thinspace{}
4189 \begin_inset space \space{}
4192 Page 4) in the upper right, your name in the lower left, and the date in
4194 The following commands should now appear in the preamble:
4197 \begin_layout Standard
4207 \begin_layout Standard
4215 \begin_layout Standard
4225 \begin_layout Standard
4234 \begin_layout Standard
4242 \begin_layout Standard
4252 \begin_layout Standard
4254 \begin_inset Flex Code
4257 \begin_layout Plain Layout
4266 \begin_inset Flex Code
4269 \begin_layout Plain Layout
4277 access \SpecialChar LaTeX
4278 's section and page counters, and so print out the current section
4281 \begin_inset Flex Code
4284 \begin_layout Plain Layout
4292 simply prints out today's date.
4295 \begin_layout Standard
4296 The thicknesses of the horizontal rules drawn beneath the header and above
4297 the footer can also be modified.
4298 If you don't want one of the rules, set its thickness to 0.
4299 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4305 \begin_inset Flex Code
4308 \begin_layout Plain Layout
4313 headrulewidth}{0.4pt}
4319 \begin_inset Flex Code
4322 \begin_layout Plain Layout
4327 footrulewidth}{0.4pt}
4332 to set the thicknesses.
4335 \begin_layout Standard
4336 You can switch the header/footer settings on and off for individual pages
4338 \begin_inset Flex Code
4341 \begin_layout Plain Layout
4344 thispagestyle{empty}
4350 \begin_inset Flex Code
4353 \begin_layout Plain Layout
4356 thispagestyle{plain}
4362 \begin_inset Flex Code
4365 \begin_layout Plain Layout
4368 thispagestyle{fancy}
4374 Simply insert them in the text on the page you want changed and mark them
4377 In fact, title pages are marked as plain by default, while following pages
4378 are marked fancy when using the global fancy setting.
4381 \begin_layout Standard
4382 As a final example, it is possible to include an image in the header or
4384 Suppose you want to put a company logo in the upper lefthand corner.
4385 You might try something like
4388 \begin_layout Standard
4397 includegraphics{logo.eps}}}
4400 \begin_layout Standard
4402 (you may need to preface this with
4403 \begin_inset Flex Code
4406 \begin_layout Plain Layout
4410 usepackage{graphics}
4415 if you don't include graphics elsewhere in your document).
4418 \begin_layout Section
4419 Itemize Bullet Selection
4420 \begin_inset CommandInset label
4429 \begin_layout Standard
4435 \begin_layout Subsection
4439 \begin_layout Standard
4441 provides 216 bullet shapes that can be accessed from a simple dialog.
4442 Using this dialog you can easily specify what bullet shape to use at each
4443 level of an itemized list.
4444 These settings are document-wide so you won't be able to specify different
4445 sets of bullets for different paragraphs.
4449 \begin_layout Plain Layout
4450 Well, actually you can but you'll have to do it by hand.
4458 \begin_layout Subsection
4462 \begin_layout Standard
4463 Open the dialog by selecting the
4464 \begin_inset Flex Noun
4467 \begin_layout Plain Layout
4468 Document\SpecialChar menuseparator
4474 menu item and then select the
4475 \begin_inset Flex Noun
4478 \begin_layout Plain Layout
4487 \begin_layout Standard
4488 The dialog provides you with a table of bullet shapes.
4489 A column of buttons on the left of the table provides access to the six
4490 different panels of bullet shapes.
4491 The row of buttons across the top is used to select which bullet depth
4493 A text entry under the table shows the currently selected bullet shape's
4495 equivalent and this can be edited if desired.
4496 If you do modify the text you will also need to specify any needed packages
4497 in the \SpecialChar LaTeX
4501 \begin_layout Standard
4502 The six panels are divided up by the packages they require.
4503 The following table shows the mappings from button name to \SpecialChar LaTeX
4507 \begin_layout Standard
4509 \begin_inset Tabular
4510 <lyxtabular version="3" rows="7" columns="2">
4511 <features tabularvalignment="middle">
4512 <column alignment="center" valignment="top" width="0pt">
4513 <column alignment="center" valignment="top" width="0pt">
4515 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4518 \begin_layout Plain Layout
4533 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4536 \begin_layout Plain Layout
4553 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4556 \begin_layout Plain Layout
4571 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4574 \begin_layout Plain Layout
4583 base \SpecialChar LaTeX
4591 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4594 \begin_layout Plain Layout
4609 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4612 \begin_layout Plain Layout
4629 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4632 \begin_layout Plain Layout
4647 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4650 \begin_layout Plain Layout
4667 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4670 \begin_layout Plain Layout
4685 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4688 \begin_layout Plain Layout
4705 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4708 \begin_layout Plain Layout
4723 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4726 \begin_layout Plain Layout
4743 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4746 \begin_layout Plain Layout
4761 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4764 \begin_layout Plain Layout
4787 \begin_layout Standard
4789 doesn't stop you using bullets from packages you don't have.
4790 If you get errors from \SpecialChar LaTeX
4791 when you try to view or print the file, then it
4792 is likely you are missing a package.
4796 \begin_layout Plain Layout
4798 doesn't restrict your use since you may be editing locally and exporting
4807 \begin_layout Subsection
4811 \begin_layout Standard
4812 Select which bullet depth you want to change then select the bullet shape
4814 Any changes will not be visible in \SpecialChar LyX
4815 , but are visible when viewing the document.
4818 \begin_layout Standard
4819 You can reset a bullet shape to the default simply by clicking your right
4820 mouse button on the appropriate bullet depth button.
4824 \begin_layout Plain Layout
4829 want to have multiple sets of paragraphs with different sets of bullets
4830 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4832 The bullet selection dialog can help though because it provides you with
4833 the \SpecialChar LaTeX
4834 code for a wide range of bullet shapes.
4835 To make your own custom paragraphs you have the following options:
4838 \begin_layout Plain Layout
4842 \begin_layout Plain Layout
4858 \begin_layout Plain Layout
4862 \begin_layout Plain Layout
4884 \begin_layout Itemize
4885 Use the \SpecialChar LaTeX
4887 \begin_inset Flex Code
4890 \begin_layout Plain Layout
4898 to specify a new bullet shape for a given depth.
4899 You'll also need to save the current bullet shape so you can restore it
4901 In this itemized list the following \SpecialChar LaTeX
4902 code was used to change the bullet
4903 used for the first depth.
4907 \begin_layout LyX-Code
4917 \begin_layout LyX-Code
4934 \begin_layout Itemize
4935 Note that the itemize depth is specified in Roman numerals as part of the
4945 \begin_layout Itemize
4946 \begin_inset Argument item:1
4949 \begin_layout Plain Layout
4953 \begin_layout Plain Layout
4971 Specify each individual entry by starting each item with the bullet shape
4973 \begin_inset Quotes eld
4977 \begin_inset Quotes erd
4982 Insert\SpecialChar menuseparator
4986 \begin_inset Flex Noun
4989 \begin_layout Plain Layout
4997 For example, this item was started with
4998 \begin_inset Flex Code
5001 \begin_layout Plain Layout
5016 \begin_layout Plain Layout
5020 \begin_layout Plain Layout
5036 \begin_layout Plain Layout
5037 You'll also need to revert the labelitem back to its previous setting for
5038 the global bullet shape settings to remain in effect.
5039 The way used here was:
5042 \begin_layout LyX-Code
5057 \begin_layout Chapter
5059 and the World Wide Web
5062 \begin_layout Standard
5064 has long supported the export of documents to various web-friendly formats,
5066 Before version 2.0, however, HTML export was always accomplished by the
5067 use of external converters.
5071 \begin_layout Plain Layout
5072 For details on the use of external converters with \SpecialChar LyX
5077 section of the Customization manual.
5082 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5084 intermediate format, such as
5085 \begin_inset Flex Code
5088 \begin_layout Plain Layout
5095 \begin_inset Flex Code
5098 \begin_layout Plain Layout
5105 \begin_inset Flex Code
5108 \begin_layout Plain Layout
5114 , relying upon \SpecialChar LyX
5115 to produce the \SpecialChar LaTeX
5116 ; and there is a converter that works directly
5119 \begin_inset Flex Code
5122 \begin_layout Plain Layout
5130 All of these have different advantages and disadvantages.
5134 \begin_layout Standard
5135 The \SpecialChar LaTeX
5136 -based converters have the advantage that, in principle, they know everythin
5137 g about the exported document that \SpecialChar LaTeX
5139 Such converters do not care, for example, if a certain block of code was
5140 produced by \SpecialChar LyX
5141 or was Evil Red Text.
5142 These converters know about
5143 \begin_inset Flex Code
5146 \begin_layout Plain Layout
5152 files, counters, and references, and can often make use of the
5153 \begin_inset Flex Code
5156 \begin_layout Plain Layout
5162 files generated by Bib\SpecialChar TeX
5164 On the other hand, \SpecialChar LaTeX
5165 is a very hard language to parse—it is sometimes said
5166 that only \SpecialChar TeX
5167 itself understands \SpecialChar TeX
5168 —and \SpecialChar LaTeX
5169 -based converters will often choke on
5170 what seem to be quite simple constructs; complex ones can throw them completely
5171 , and as of this writing, for example, the
5175 manual will not export with
5176 \begin_inset Flex Code
5179 \begin_layout Plain Layout
5185 , though the others will.
5186 The other issue concerns how math is handled.
5187 These converters typically convert the formulae into little pictures that
5188 are then linked from the HTML document.
5189 Since these are actually generated by \SpecialChar LaTeX
5190 , they are accurate.
5191 But they do not scale well, and just getting them to look as if they are
5192 actually meant to be in your document—so that the font sizes seem to be
5193 roughly the same—can be a challenge.
5196 \begin_layout Standard
5198 \begin_inset Flex Code
5201 \begin_layout Plain Layout
5209 \begin_inset CommandInset href
5211 name "http://pinchito.es/elyxer/"
5212 target "http://pinchito.es/elyxer/"
5217 ) solves some of these problems.
5218 In particular, the formulae it produces scale perfectly, since it renders
5219 math using a combination of HTML and CSS rather than converting the formulae
5221 But even moderately complex formula are rendered less well than with
5222 \begin_inset Flex Code
5225 \begin_layout Plain Layout
5231 ; this reflects the limitations of HTML.
5235 \begin_layout Plain Layout
5237 \begin_inset Flex Code
5240 \begin_layout Plain Layout
5247 can also use jsMath and MathJax for equations, but this setting is only
5248 available globally and requires one to have access to a server that runs
5254 More importantly (as of version 1.1.1, at least),
5255 \begin_inset Flex Code
5258 \begin_layout Plain Layout
5265 has limited support for math macros and no support for user-defined paragraph
5266 or character styles.
5267 These limitations make
5268 \begin_inset Flex Code
5271 \begin_layout Plain Layout
5278 unsuitable for many of the documents \SpecialChar LyX
5280 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5282 have decided to follow a different path and have made \SpecialChar LyX
5284 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5285 , DocBook, and plaintext.
5288 \begin_layout Standard
5289 As of this writing, XHTML output remains under development and should probably
5291 \begin_inset Quotes eld
5295 \begin_inset Quotes erd
5302 \begin_layout Plain Layout
5304 \begin_inset Flex Code
5307 \begin_layout Plain Layout
5308 development/HTML/HTML.notes
5313 , which can be found in the \SpecialChar LyX
5315 \begin_inset CommandInset href
5317 name "accessed online"
5318 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5323 , usually contains up-to-date information about the state of XHTML output.
5324 See also the list of XHTML bugs on
5325 \begin_inset CommandInset href
5327 name "the bug tracker"
5328 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"
5338 Still, the developers have chosen this approach because it has several
5339 potential advantages over the other two.
5342 \begin_layout Standard
5343 These advantages are primarily due to the fact that the XHTML output routines,
5344 since they are part of \SpecialChar LyX
5345 , know everything \SpecialChar LyX
5346 knows about the document being
5351 \begin_layout Plain Layout
5352 Another advantage is that, since these routines are internal to \SpecialChar LyX
5354 immune to changes in \SpecialChar LyX
5355 's file format, or to changes in the semantics of
5361 So they know about the table of contents (as displayed in the outline),
5362 about the counters associated with different paragraph styles, and about
5363 user-defined styles.
5364 The XHTML output routines know what \SpecialChar LyX
5365 knows about internationalization,
5366 too, so they will output
5367 \begin_inset Quotes eld
5371 \begin_inset Quotes erd
5375 \begin_inset Quotes eld
5383 \begin_inset Quotes erd
5386 , depending upon the language in effect at the time.
5390 \begin_layout Standard
5391 Quite generally, the output routines know what \SpecialChar LyX
5392 knows about document layout,
5393 that is, about how the document is to be rendered on screen.
5394 We use this information when we output the document as XHTML.
5395 In particular, \SpecialChar LyX
5400 generates CSS style information corresponding to the layout information
5401 it uses to render the document on screen: if section headings are supposed
5402 to be sans-serif and bold as seen in \SpecialChar LyX
5403 , then (by default) they will be sans-seri
5404 f and bold when viewed in a web browser, too.
5405 And this is true not just for pre-defined styles, like Section, but for
5406 any style, including user-defined styles.
5407 Indeed, the XHTML output routines make no distinction between user-defined
5408 paragraph and character styles and \SpecialChar LyX
5409 's own pre-defined styles: in each case,
5410 everything \SpecialChar LyX
5411 knows about the styles is contained in the layout files.
5412 And much the same is true as regards pre-defined textual insets, such as
5413 footnotes, and various custom insets.
5417 \begin_layout Standard
5418 The result is that XHTML output can be customized and extended in exactly
5419 the same way \SpecialChar LaTeX
5420 output can be customized and extended: through layout files
5422 See chapter five of the
5426 manual for the details.
5429 \begin_layout Standard
5430 The remainder of this chapter contains more detailed information on XHTML
5431 output, its limitations, and ways to work around those limitations.
5434 \begin_layout Section
5435 Math Output in XHTML
5438 \begin_layout Standard
5440 offers four choices for how math is rendered.
5441 These have various advantages and disadvantages:
5444 \begin_layout Itemize
5446 \begin_inset Newline newline
5449 MathML is a dialect of XML designed specifically for mathematics on the
5450 web, and it typically renders very well in browsers that support it.
5451 The disadvantage is that not all browsers support MathML, and support is
5452 not complete even in the Gecko-based browsers, such as Firefox.
5453 \begin_inset Newline newline
5457 is unable to render a formula as MathML—for example, if the formula
5459 \begin_inset Flex Code
5462 \begin_layout Plain Layout
5468 package or ERT—then it will instead output the formula as an image.
5472 \begin_layout Itemize
5474 \begin_inset Newline newline
5478 \begin_inset Flex Code
5481 \begin_layout Plain Layout
5487 outputs math as HTML, styled by CSS.
5491 \begin_layout Plain Layout
5493 has borrowed some of the CSS for its HTML output from
5494 \begin_inset Flex Code
5497 \begin_layout Plain Layout
5508 For simple formulae, this can work quite well, though with more complicated
5509 formulae it tends to break down.
5510 Still, this method has the advantage that it is very widely supported and
5511 so it may be appropriate for documents that contain only a little, fairly
5513 \begin_inset Newline newline
5516 If Lyx is unable to render a formula as HTML—for example, if the formula
5518 \begin_inset Flex Code
5521 \begin_layout Plain Layout
5527 package or ERT—then it will instead output the formula as an image.
5531 \begin_layout Itemize
5533 \begin_inset Newline newline
5537 \begin_inset Flex Code
5540 \begin_layout Plain Layout
5547 will output formulae as images, the very same images, in fact, that are
5548 used for instant preview.
5552 \begin_layout Plain Layout
5553 Instant preview does
5557 have to be on for images to be output, however.
5562 The advantage to this method is that the images are simply generated by
5564 , so they are very accurate.
5565 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5566 so they do not scale terribly well, and one cannot copy them, etc.
5567 \begin_inset Newline newline
5570 The size of the images can be controlled by setting the
5571 \begin_inset Quotes eld
5575 \begin_inset Quotes erd
5579 \begin_inset Flex Noun
5582 \begin_layout Plain Layout
5583 Document\SpecialChar menuseparator
5584 Settings\SpecialChar menuseparator
5594 \begin_layout Plain Layout
5595 For those who want to know, this controls the resolution of the image in
5596 dots per inch and is based upon a default of 75 dpi.
5602 \begin_inset Newline newline
5606 for some reason fails to create an image for a formula (e.g., if a required
5608 package is not installed), then it will fall back to outputing the raw
5613 \begin_layout Itemize
5616 \begin_inset Newline newline
5619 Finally, \SpecialChar LyX
5620 will happily output math as \SpecialChar LaTeX
5622 As well as being the output of last resort, this method can be used with
5624 \begin_inset CommandInset href
5627 target "http://www.math.union.edu/~dpvc/jsMath/"
5632 , which uses JavaScript to render \SpecialChar LaTeX
5633 embedded in HTML documents.
5635 wraps the \SpecialChar LaTeX
5637 \begin_inset Flex Code
5640 \begin_layout Plain Layout
5646 (for inline formulas) or
5647 \begin_inset Flex Code
5650 \begin_layout Plain Layout
5656 (for displayed formulas) with
5657 \begin_inset Flex Code
5660 \begin_layout Plain Layout
5666 , as is required for jsMath.
5669 \begin_layout Standard
5670 One of these output methods must be selected under
5671 \begin_inset Flex Noun
5674 \begin_layout Plain Layout
5675 Document\SpecialChar menuseparator
5676 Settings\SpecialChar menuseparator
5683 By default, \SpecialChar LyX
5685 This is a document-wide setting, therefore.
5688 \begin_layout Standard
5689 Eventually, \SpecialChar LyX
5690 will offer the user the option to select an alternate output
5691 method for a particular inset, say, one that isn't being rendered very
5696 \begin_layout Plain Layout
5697 That said, since \SpecialChar LyX
5698 falls back to images if the inset contains ERT, then one
5699 can force output as an image by putting some harmless ERT into the math,
5701 \begin_inset Formula $a=b\relax$
5712 \begin_layout Section
5713 Bibliography and Citations
5716 \begin_layout Standard
5717 XHTML output fully supports bibliographies and citations.
5721 \begin_layout Standard
5722 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5724 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5727 If you are using numerical citations, then \SpecialChar LyX
5728 will output numerical labels,
5729 such as [1] or [17], rather than simply showing the citation key in square
5730 brackets, as it does on-screen.
5731 If you are using author-year citations, then \SpecialChar LyX
5732 will add lowercase letters
5733 to the years, just as Bib\SpecialChar TeX
5734 does, if it finds more than one citation for
5735 a given author-year combination.
5736 The labels will be printed with the bibliography entries.
5737 Note that there is, at present, no way to customize the appearance of the
5738 labels, for example, to choose between square brackets and parentheses.
5741 \begin_layout Standard
5742 Bibliography output is handled by the same machinery that handles the presentati
5743 on of reference information in the citation dialog, so you will see in the
5744 XHTML output pretty much what you would see if you were to look at a given
5745 entry in the citation dialog.
5746 The formatting can be customized in your layout file or, preferably, in
5752 manual for the details.
5755 \begin_layout Standard
5756 The main defect at present is that cross-referenced information is printed
5757 with every entry with which it is associated.
5758 So you can see things like this:
5763 \begin_inset Quotes eld
5766 Context and Logical Form
5767 \begin_inset Quotes erd
5772 Language in Context: Selected Essays
5774 (Oxford: Oxford University Press, 2007), pp.
5780 \begin_inset Quotes eld
5783 Semantics in Context
5784 \begin_inset Quotes erd
5789 Language in Context: Selected Essays
5791 (Oxford: Oxford University Press, 2007), pp.
5795 \begin_layout Standard
5796 This should be fixed before long.
5799 \begin_layout Standard
5800 There is no support at present for sectioned bibliographies.
5801 If you have multiple bibliographies, then \SpecialChar LyX
5802 will print the same bibliography
5806 \begin_layout Section
5810 \begin_layout Standard
5812 will happily export indexes as XHTML, but with certain limitations at the
5816 \begin_layout Standard
5817 Index export will be most reliable when you do not attempt to use the fancy
5818 constructs that are described in the section on indexes in the
5826 \begin_layout Plain Layout
5827 The main issue here is that \SpecialChar LyX
5828 itself does not really handle these.
5829 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5835 We'll describe how they are handled using the subsection headings from
5839 \begin_layout Itemize
5840 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5841 makes an effort to support these,
5842 but the entries must be separated by
5843 \begin_inset Quotes eld
5847 \begin_inset Quotes erd
5850 , that is, there must be spaces around the exclamation point.
5851 This is because it is otherwise too difficult to check for escaped exclamation
5852 points, ones in math, and so forth.
5855 \begin_layout Itemize
5856 Page Ranges: There is no support at all for page ranges, since these make
5857 no sense with XHMTL.
5858 Instead, you will just get two index entries, one at either end.
5861 \begin_layout Itemize
5862 Cross-referencing: There is no support for cross-referencing.
5864 finds an entry containing the
5865 \begin_inset Quotes eld
5868 |see\SpecialChar ldots
5870 \begin_inset Quotes erd
5873 construct, it is just dropped, and the rest is treated as an ordinary index
5877 \begin_layout Itemize
5878 Index Entry Order: \SpecialChar LyX
5879 does support attempts to fix the sorting order.
5880 It will take what is before the first `@' it finds and use that for sorting,
5881 taking what follows the first `@' to be the actual entry.
5882 At present, \SpecialChar LyX
5883 does not check for escaped `@', so do not try to index email
5887 \begin_layout Itemize
5888 Index Entry Layout: You can format entries by using the text style dialog,
5889 or by using any other method available within \SpecialChar LyX
5891 There is no support for constructs like:
5892 \begin_inset Quotes eld
5896 \begin_inset Quotes erd
5900 Indeed, if \SpecialChar LyX
5901 finds a pipe symbol, `|', in an entry, it will delete it and
5902 everything that follows it.
5905 \begin_layout Itemize
5906 Multiple Indexes: There is no support for multiple indexes.
5907 Rather, all index entries will be printed as one large index.
5908 To avoid our printing several versions of the index, we print only the
5909 main index, so make sure you have one.
5912 \begin_layout Section
5913 Nomenclature and Glossary
5916 \begin_layout Standard
5917 There is at present no support for glossaries.
5918 Adding it would be fairly trivial, and welcome.
5921 \begin_layout Chapter
5922 The \SpecialChar LyX
5926 \begin_layout Section
5930 \begin_layout Standard
5931 The `\SpecialChar LyX
5932 server' allows other programs to talk to \SpecialChar LyX
5933 , invoke \SpecialChar LyX
5934 commands, and retrieve
5935 information about the \SpecialChar LyX
5937 This is only intended for advanced users, but they should find it useful.
5938 It is by writing to the \SpecialChar LyX
5939 server, for example, that bibliography managers,
5940 such as JabRef, are able to
5941 \begin_inset Quotes eld
5945 \begin_inset Quotes erd
5948 citations to \SpecialChar LyX
5952 \begin_layout Section
5953 Starting the \SpecialChar LyX
5955 \begin_inset CommandInset label
5957 name "sec:Starting-the-Server"
5964 \begin_layout Standard
5965 The \SpecialChar LyX
5966 server works through the use of a pair of named pipes.
5967 These are usually located in
5968 \begin_inset Flex Code
5971 \begin_layout Plain Layout
5977 , (except on Windows, where
5981 named pipes are special objects located in
5982 \begin_inset Flex Code
5985 \begin_layout Plain Layout
5997 ) and have the names
5998 \begin_inset Quotes eld
6002 \begin_inset Flex Code
6005 \begin_layout Plain Layout
6012 \begin_inset Quotes erd
6016 \begin_inset Quotes eld
6020 \begin_inset Flex Code
6023 \begin_layout Plain Layout
6030 \begin_inset Quotes erd
6034 External programs write into
6035 \begin_inset Flex Code
6038 \begin_layout Plain Layout
6044 and read back data from
6045 \begin_inset Flex Code
6048 \begin_layout Plain Layout
6055 The stem of the pipe names can be defined in the
6056 \begin_inset Flex Noun
6059 \begin_layout Plain Layout
6060 Tools\SpecialChar menuseparator
6067 \begin_inset Flex Code
6070 \begin_layout Plain Layout
6071 "/home/myhome/lyxpipe"
6077 \begin_inset Flex Code
6080 \begin_layout Plain Layout
6094 on Windows (where any working path instead of lyxpipe can be used, for
6096 \begin_inset Flex Code
6099 \begin_layout Plain Layout
6122 configure this manually in order for the server to start.
6125 \begin_layout Standard
6128 \begin_inset Flex Code
6131 \begin_layout Plain Layout
6138 \begin_inset Flex Code
6141 \begin_layout Plain Layout
6147 ' to create the pipes.
6148 If one of the pipes already exists, \SpecialChar LyX
6149 will assume that another \SpecialChar LyX
6151 is already running and will not start the server.
6152 On POSIX (Unix like) systems, if for some other reason, an unused
6153 \begin_inset Quotes eld
6157 \begin_inset Quotes erd
6160 pipe is left in existence when \SpecialChar LyX
6161 closes, then \SpecialChar LyX
6162 will try to delete it.
6163 If this fails for some reason, you will need to delete the pipes manually
6164 and then restart \SpecialChar LyX
6166 On Windows, pipes are deleted by the OS on program termination or crash,
6168 \begin_inset Quotes eld
6172 \begin_inset Quotes erd
6175 pipes should not be possible.
6178 \begin_layout Standard
6179 To have several \SpecialChar LyX
6180 processes with servers at the same time, you have to use
6181 different configurations, perhaps by using separate user directories, each
6183 \begin_inset Flex Code
6186 \begin_layout Plain Layout
6192 file, for each process.
6195 \begin_layout Standard
6196 If you are developing a client program, you might find it useful to enable
6197 debugging information from the \SpecialChar LyX
6199 Do this by starting \SpecialChar LyX
6201 \begin_inset Flex Code
6204 \begin_layout Plain Layout
6213 \begin_layout Standard
6214 You can find a complete example client written in C++ in the source distribution
6216 \begin_inset Flex Code
6219 \begin_layout Plain Layout
6220 development/lyxserver/server_monitor.cpp
6228 \begin_layout Standard
6229 Another useful tool is the command-line based client found in
6230 \begin_inset Flex Code
6233 \begin_layout Plain Layout
6234 src/client/lyxclient
6242 \begin_layout Section
6243 Normal communication
6246 \begin_layout Standard
6247 To issue a \SpecialChar LyX
6248 call, the client writes a line of ASCII text into the input
6250 This line has the following format:
6267 \begin_layout Description
6268 clientname is a name that the client can choose arbitrarily.
6269 Its only use is that \SpecialChar LyX
6270 will echo it if it sends an answer—so a client can
6271 dispatch results from different requesters.
6274 \begin_layout Description
6275 function is the function you want \SpecialChar LyX
6277 It is the same as the commands you'd use in the minibuffer.
6280 \begin_layout Description
6281 argument is an optional argument which is meaningful only to some functions
6283 \begin_inset Quotes eld
6287 \begin_inset Quotes erd
6290 LFUN will insert the argument as text at the cursor position).
6293 \begin_layout Standard
6294 The answer from \SpecialChar LyX
6295 will arrive in the output pipe and be of the form
6312 \begin_layout Standard
6321 are just echoed from the command request, while
6325 is more or less useful information filled according to how the command
6326 execution worked out.
6327 Some commands, such as
6328 \begin_inset Quotes eld
6332 \begin_inset Quotes erd
6335 , will return information about the internal state of \SpecialChar LyX
6337 return an empty data-response.
6338 This means that the command execution went fine.
6341 \begin_layout Standard
6342 In case of errors, the response from \SpecialChar LyX
6360 \begin_layout Standard
6365 should contain an explanation of why the command failed.
6368 \begin_layout Standard
6372 \begin_layout LyX-Code
6373 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6374 \begin_inset Newline newline
6377 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6378 \begin_inset Newline newline
6381 read a <~/.lyxpipe.out
6382 \begin_inset Newline newline
6388 \begin_layout Subsection
6389 AppleScript (Mac OS X)
6392 \begin_layout Standard
6393 Since \SpecialChar LyX
6394 2.1, \SpecialChar LyX
6395 supports basic interactions with AppleScript for normal communicatio
6396 n through the command run.
6397 This command takes a direct argument (the
6401 to perform) and an optional argument.
6402 It either returns the output of the function or triggers an error with
6403 the error message and code.
6406 \begin_layout Standard
6410 \begin_layout LyX-Code
6411 tell application "\SpecialChar LyX
6415 \begin_layout LyX-Code
6419 \begin_layout LyX-Code
6420 -- Stores the current file name into f
6423 \begin_layout LyX-Code
6424 set f to (run "server-get-filename" with argument "")
6427 \begin_layout LyX-Code
6428 on error the error_message number the error_number
6431 \begin_layout LyX-Code
6432 display dialog "Error: " & the error_number & ".
6436 \begin_layout LyX-Code
6437 & the error_message buttons {"OK"} default button 1
6440 \begin_layout LyX-Code
6444 \begin_layout LyX-Code
6448 \begin_layout Section
6452 \begin_layout Standard
6454 can notify clients of events going on asynchronously.
6455 Currently it will only do this if the user binds a key sequence with the
6457 \begin_inset Quotes eld
6461 \begin_inset Quotes erd
6465 The format of the string \SpecialChar LyX
6466 sends is as follows:
6470 \begin_inset Flex Code
6473 \begin_layout Plain Layout
6484 \begin_layout Standard
6489 is the printed representation of the key sequence that was actually typed
6493 \begin_layout Standard
6494 This mechanism can be used to extend \SpecialChar LyX
6495 's command set and implement macros.
6496 Bind some key sequence to
6497 \begin_inset Quotes eld
6501 \begin_inset Quotes erd
6505 Then start a client that listens on the output pipe, dispatches the command
6506 according to the sequence, and starts a function that may use \SpecialChar LyX
6509 requests to issue a command or a series of commands to \SpecialChar LyX
6513 \begin_layout Section
6514 The simple \SpecialChar LyX
6518 \begin_layout Standard
6520 implements a simple protocol that can be used for session management.
6521 All messages are of the form
6534 \begin_layout Standard
6540 \begin_inset Quotes eld
6544 \begin_inset Quotes erd
6548 \begin_inset Quotes eld
6552 \begin_inset Quotes erd
6557 \begin_inset Quotes eld
6561 \begin_inset Quotes erd
6564 is received from a client, \SpecialChar LyX
6565 will report back to inform the client that
6566 it's listening to it's messages, while
6567 \begin_inset Quotes eld
6571 \begin_inset Quotes erd
6574 sent from \SpecialChar LyX
6575 will inform clients that \SpecialChar LyX
6579 \begin_layout Section
6580 Reverse DVI/PDF search
6583 \begin_layout Standard
6584 Some DVI/PDF viewers
6588 \begin_layout Plain Layout
6589 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6590 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6599 facility (also called
6604 This means that you can tell \SpecialChar LyX
6605 to put the cursor to a specific line in the
6606 document by clicking at the respective position in the DVI/PDF output.
6607 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6609 This is done via the \SpecialChar LyX
6610 server either by using the named pipe (
6614 ), or the UNIX domain socket (
6618 ) that \SpecialChar LyX
6619 creates in its temporary directory (this is the way the
6620 \begin_inset Flex Code
6623 \begin_layout Plain Layout
6629 program communicates with \SpecialChar LyX
6631 In some cases, you need a helper script that mediates between the viewer
6632 and \SpecialChar LyX
6633 , in others, the viewer can communicate with \SpecialChar LyX
6635 This depends on the selected viewer and on your operating system.
6636 The same applies to the way viewers need to be configured and the way the
6637 reverse search is actually performed.
6638 In what follows, we will thus describe how to setup reverse search for
6640 Before we turn to this, though, we will explain what needs to be done generally
6641 to enable reverse search in the DVI/PDF output.
6644 \begin_layout Subsection
6646 \begin_inset CommandInset label
6648 name "subsec:rev-search"
6655 \begin_layout Standard
6656 In most cases \SpecialChar LyX
6657 will do the work for you by pressing the following button
6661 arg "buffer-toggle-output-sync"
6665 Alternatively, you can also enable the feature by checking
6667 Synchronize with Output
6670 \begin_inset Flex Noun
6673 \begin_layout Plain Layout
6674 Document\SpecialChar menuseparator
6675 Settings\SpecialChar menuseparator
6682 In such a case \SpecialChar LyX
6683 will automatically insert the necessary Sync\SpecialChar TeX
6685 PDF) or load the srcltx package (for DVI) respectively.
6686 This option can be easily reached also on
6687 \begin_inset Flex Code
6690 \begin_layout Plain Layout
6699 \begin_layout Standard
6700 If you need a different setting, you can select or input a custom macro
6701 from the drop down box just below
6702 \begin_inset Flex Noun
6705 \begin_layout Plain Layout
6706 Document\SpecialChar menuseparator
6707 Settings\SpecialChar menuseparator
6708 Output\SpecialChar menuseparator
6709 Synchronize with Output
6717 \begin_layout Standard
6718 Note that the method
6719 \begin_inset Flex Code
6722 \begin_layout Plain Layout
6730 enables gzip compression.
6731 If your viewer does not support it, you should instead use
6732 \begin_inset Flex Code
6735 \begin_layout Plain Layout
6746 \begin_layout Standard
6747 Please also note that including the
6748 \begin_inset Flex Code
6751 \begin_layout Plain Layout
6758 \begin_inset Flex Code
6761 \begin_layout Plain Layout
6767 sometimes has an undesired impact on the typesetting.
6768 Thus, you should switch output synchronization off for the final typesetting
6770 \begin_inset Flex Code
6773 \begin_layout Plain Layout
6780 \begin_inset Flex Code
6783 \begin_layout Plain Layout
6793 \begin_layout Standard
6794 In case you need some more special settings that are not covered by the
6795 automatic settings, read the next section about how to set up output synchroniz
6797 If the automatic setup suits your needs, you can readily jump to section
6798 \begin_inset space ~
6802 \begin_inset CommandInset ref
6804 reference "subsec:configuring-viewers"
6808 , where the necessary configuration steps in your viewer – needed both with
6809 the automatic and the manual setup – are described.
6812 \begin_layout Subsection
6816 \begin_layout Standard
6818 provides several different methods for reverse search.
6819 Some are built-in in the
6820 \begin_inset Flex Code
6823 \begin_layout Plain Layout
6829 program, some are provided by external packages.
6830 Your choice depends on whether your \SpecialChar LaTeX
6831 distribution already provides a given
6832 method (the built-in methods are rather new) and whether your viewer can
6834 The available methods are described in the following.
6837 \begin_layout Subsubsection*
6838 Built-in DVI-search via src-specials (DVI only)
6841 \begin_layout Standard
6842 This method provides the DVI file with the necessary information for reverse
6844 It is available in \SpecialChar LaTeX
6845 since quite some time (any somewhat recent \SpecialChar LaTeX
6847 should include it), and it works reliably.
6848 To enable it, change the
6849 \begin_inset Flex Noun
6852 \begin_layout Plain Layout
6863 \begin_inset Flex Noun
6866 \begin_layout Plain Layout
6877 \begin_inset Flex Noun
6880 \begin_layout Plain Layout
6881 Preferences\SpecialChar menuseparator
6882 File Handling\SpecialChar menuseparator
6889 \begin_inset Flex Code
6892 \begin_layout Plain Layout
6893 latex -src-specials $$i
6899 If this doesn't work, check if your \SpecialChar TeX
6900 engine needs different options (the
6901 syntax might differ in some distributions).
6904 \begin_layout Subsubsection*
6905 External Packages (PDFSync and scrltx)
6908 \begin_layout Standard
6917 provide reverse search facility for PDF output (via pdflatex) and DVI output,
6919 In order to enable it, load the packages in the \SpecialChar LyX
6923 \begin_layout Itemize
6924 \begin_inset Flex Code
6927 \begin_layout Plain Layout
6935 for reverse PDF search,
6938 \begin_layout Itemize
6939 \begin_inset Flex Code
6942 \begin_layout Plain Layout
6945 usepackage[active]{srcltx}
6950 for reverse DVI search.
6953 \begin_layout Standard
6954 If you want to be able to perform both DVI and PDF reverse searches, you
6955 can also insert in the preamble the following lines
6958 \begin_layout LyX-Code
6962 \begin_inset Newline newline
6968 \begin_inset Newline newline
6974 \begin_inset Newline newline
6980 \begin_inset Newline newline
6985 usepackage[active]{srcltx}
6986 \begin_inset Newline newline
6994 \begin_layout Standard
6995 This way, you can preview the file as either DVI or PDF (pdflatex) and the
6996 right package will be used.
6999 \begin_layout Standard
7000 Note that PDFSync might affect the output layout of your document.
7001 It is therefore advised to disable PDFsync for final documents.
7004 \begin_layout Subsubsection*
7005 Built-in reverse search via Sync\SpecialChar TeX
7009 \begin_layout Standard
7011 \begin_inset Flex Code
7014 \begin_layout Plain Layout
7020 have built-in support for both PDF and DVI reverse search.
7023 Sync\SpecialChar TeX
7026 facility is basically the result of the integration of the PDFSync package
7027 to the pdftex program and its merge with the
7032 You need at least \SpecialChar TeX
7033 Live 2008 or a recent Mik\SpecialChar TeX
7034 distribution in order to use
7039 \begin_layout Plain Layout
7040 For some reason, Mik\SpecialChar TeX
7041 does not understand/obey the command \SpecialChar LyX
7043 the preamble when you check the "Enable Forward/Reverse Search" button
7044 in the toolbar and does not generate the necessary info.
7047 \begin_layout Plain Layout
7048 The generation of the required info can be forced by changing the converter
7050 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7051 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7052 the -synctex=1 switch).
7057 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
7058 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
7059 already provide Sync\SpecialChar TeX
7063 \begin_layout Standard
7064 To enable Sync\SpecialChar TeX
7065 for DVI output, change the
7066 \begin_inset Flex Noun
7069 \begin_layout Plain Layout
7080 \begin_inset Flex Noun
7083 \begin_layout Plain Layout
7094 \begin_inset Flex Noun
7097 \begin_layout Plain Layout
7098 Preferences\SpecialChar menuseparator
7099 File Handling\SpecialChar menuseparator
7106 \begin_inset Flex Code
7109 \begin_layout Plain Layout
7110 latex -synctex=1 $$i
7115 , and for PDF output, change the
7116 \begin_inset Flex Noun
7119 \begin_layout Plain Layout
7124 (pdflatex) -> PDF (pdflatex)
7130 \begin_inset Flex Code
7133 \begin_layout Plain Layout
7134 pdflatex -synctex=1 $$i
7140 Should your viewer not be considered in the following description, or in
7141 case of missing success, please check the documentation of your viewer
7142 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
7147 \begin_layout Plain Layout
7148 Note that the option
7149 \begin_inset Flex Code
7152 \begin_layout Plain Layout
7158 option enables gzip compression.
7159 If your viewer does not support it, you should instead use
7160 \begin_inset Flex Code
7163 \begin_layout Plain Layout
7177 \begin_layout Subsection
7178 Configuring and using specific viewers
7179 \begin_inset CommandInset label
7181 name "subsec:configuring-viewers"
7188 \begin_layout Subsubsection*
7189 Xdvi (all platforms)
7192 \begin_layout Standard
7194 \begin_inset Flex Code
7197 \begin_layout Plain Layout
7203 , you don't need to do anything else for performing a reverse DVI search,
7205 already provides the necessary hooks for automatically using the
7206 \begin_inset Flex Code
7209 \begin_layout Plain Layout
7216 Just setup your document as described above (reverse search is triggered
7217 by Ctrl-click or Alt-click on Mac OSX, respectively).
7220 \begin_layout Standard
7221 However, if for whatever reason you want to use the named pipe instead of
7222 the socket for communicating with \SpecialChar LyX
7223 , simply change the DVI viewer in
7224 \begin_inset Flex Noun
7227 \begin_layout Plain Layout
7228 Preferences\SpecialChar menuseparator
7229 File Handling\SpecialChar menuseparator
7239 \begin_layout Plain Layout
7240 On Mac OSX you have to use
7241 \begin_inset Flex Code
7244 \begin_layout Plain Layout
7245 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7256 \begin_inset Flex Code
7259 \begin_layout Plain Layout
7260 xdvi -editor "lyxeditor.sh %f %l"
7266 \begin_inset Flex Code
7269 \begin_layout Plain Layout
7275 is a suitable script.
7276 For example, a minimal shell script is the following one:
7279 \begin_layout LyX-Code
7281 \begin_inset Newline newline
7284 LYXPIPE="/path/to/lyxpipe"
7285 \begin_inset Newline newline
7288 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7289 \begin_inset Newline newline
7292 echo "$COMMAND" > "${LYXPIPE}".in || exit
7293 \begin_inset Newline newline
7296 read TMP < "${LYXPIPE}".out || exit
7299 \begin_layout Standard
7301 \begin_inset Flex Code
7304 \begin_layout Plain Layout
7310 is the LyXServer pipe path specified in
7311 \begin_inset Flex Noun
7314 \begin_layout Plain Layout
7315 Preferences\SpecialChar menuseparator
7325 \begin_layout Plain Layout
7327 \begin_inset Flex Code
7330 \begin_layout Plain Layout
7336 folder of a source distribution you can find a
7337 \begin_inset Flex Code
7340 \begin_layout Plain Layout
7346 script which is able to locate the
7350 based on your preferences.
7358 \begin_layout Subsubsection*
7362 \begin_layout Standard
7364 \begin_inset Flex Code
7367 \begin_layout Plain Layout
7368 /Applications/MacDviX_Folder/calleditor.script
7373 , add the following lines:
7376 \begin_layout LyX-Code
7377 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7378 \begin_inset Newline newline
7384 \begin_layout Standard
7385 Modify the lines accordingly if you install \SpecialChar LyX
7386 somewhere else than in the
7387 Applications folder.
7390 \begin_layout Standard
7391 Reverse search is triggered by Alt-click (OPTION-click).
7394 \begin_layout Subsubsection*
7398 \begin_layout Standard
7400 \begin_inset Flex Code
7403 \begin_layout Plain Layout
7404 open -a Skim.app $$i
7409 to the viewer setting in
7410 \begin_inset Flex Noun
7413 \begin_layout Plain Layout
7414 Preferences\SpecialChar menuseparator
7415 File Handling\SpecialChar menuseparator
7416 File formats\SpecialChar menuseparator
7423 \begin_inset Flex Noun
7426 \begin_layout Plain Layout
7427 Skim\SpecialChar menuseparator
7428 Preferences\SpecialChar menuseparator
7435 \begin_inset Flex Noun
7438 \begin_layout Plain Layout
7444 preset and enter command
7445 \begin_inset Flex Noun
7448 \begin_layout Plain Layout
7449 /Applications/\SpecialChar LyX
7450 .app/Contents/MacOS/lyxeditor
7458 \begin_layout Standard
7459 Reverse search is triggered by COMMAND-SHIFT-click
7462 \begin_layout Subsubsection*
7466 \begin_layout Standard
7467 Reverse search with evince does not work out of the box, but it can be achieved
7468 by means of some third party helper scripts.
7470 \begin_inset CommandInset href
7472 target "https://wiki.lyx.org/LyX/SyncTeX"
7480 \begin_layout Subsubsection*
7484 \begin_layout Standard
7486 \begin_inset Flex Noun
7489 \begin_layout Plain Layout
7490 Settings\SpecialChar menuseparator
7491 Configure Okular\SpecialChar menuseparator
7498 \begin_inset Quotes erd
7502 This inserts the appropriate command (
7503 \begin_inset Flex Code
7506 \begin_layout Plain Layout
7515 \begin_layout Standard
7516 Reverse search is triggered by SHIFT-click.
7519 \begin_layout Subsubsection*
7523 \begin_layout Standard
7524 Qpdfview supports Sync\SpecialChar TeX
7525 since version 0.3.5.
7527 \begin_inset Flex Noun
7530 \begin_layout Plain Layout
7531 Edit\SpecialChar menuseparator
7532 Settings\SpecialChar menuseparator
7538 , click on the input field of the
7539 \begin_inset Quotes eld
7543 \begin_inset Quotes erd
7546 item and add the command
7547 \begin_inset Flex Code
7550 \begin_layout Plain Layout
7559 \begin_layout Standard
7560 Reverse search is triggered by double-click or, in more recent versions,
7564 \begin_layout Subsubsection*
7568 \begin_layout Standard
7569 Launch yap, choose its
7570 \begin_inset Flex Noun
7573 \begin_layout Plain Layout
7574 View\SpecialChar menuseparator
7581 \begin_inset Quotes eld
7585 \begin_inset Quotes erd
7590 \begin_inset Quotes eld
7593 New\SpecialChar ldots
7595 \begin_inset Quotes erd
7598 button and, in the window that opens, enter
7599 \begin_inset Quotes eld
7604 \begin_inset Quotes erd
7607 (or any other name you like) in the
7608 \begin_inset Quotes eld
7612 \begin_inset Quotes erd
7616 Now click on the button labeled
7617 \begin_inset Quotes eld
7622 \begin_inset Quotes erd
7625 to open a file dialog and navigate to the directory containing the batch
7627 \begin_inset Flex Code
7630 \begin_layout Plain Layout
7638 \begin_inset Flex Code
7641 \begin_layout Plain Layout
7647 and then specify the program arguments as
7648 \begin_inset Flex Code
7651 \begin_layout Plain Layout
7659 \begin_inset Flex Code
7662 \begin_layout Plain Layout
7668 wrapper is used for communicating with \SpecialChar LyX
7676 \begin_layout LyX-Code
7678 \begin_inset Newline newline
7681 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7690 \begin_inset Newline newline
7704 \begin_layout Standard
7705 Make sure that the \SpecialChar LyX
7706 Server pipe path you specified in \SpecialChar LyX
7708 \begin_inset Flex Code
7711 \begin_layout Plain Layout
7725 , otherwise change the
7726 \begin_inset Flex Code
7729 \begin_layout Plain Layout
7735 wrapper accordingly.
7738 \begin_layout Standard
7739 In yap, reverse search is triggered by double-click.
7742 \begin_layout Subsubsection*
7743 SumatraPDF (Windows)
7746 \begin_layout Standard
7747 In order to use SumatraPDF for inverse search, enter
7748 \begin_inset Flex Code
7751 \begin_layout Plain Layout
7752 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
7757 in the viewer setting in
7758 \begin_inset Flex Noun
7761 \begin_layout Plain Layout
7762 Preferences\SpecialChar menuseparator
7763 File Handling\SpecialChar menuseparator
7764 File formats\SpecialChar menuseparator
7771 \begin_inset Flex Code
7774 \begin_layout Plain Layout
7780 is the previous wrapper.
7781 If SumatraPDF.exe is not in your command PATH, use its full file name.
7784 \begin_layout Standard
7785 Reverse search is triggered by double-click.
7788 \begin_layout Subsubsection*
7792 \begin_layout Standard
7793 First of all, make sure that yap is your default DVI viewer in the Windows
7794 environment, then launch it, choose its
7795 \begin_inset Flex Noun
7798 \begin_layout Plain Layout
7799 View\SpecialChar menuseparator
7806 \begin_inset Quotes eld
7810 \begin_inset Quotes erd
7815 \begin_inset Quotes eld
7818 New\SpecialChar ldots
7820 \begin_inset Quotes erd
7823 button and, in the window that opens, enter
7824 \begin_inset Quotes eld
7829 \begin_inset Quotes erd
7832 (or any other name you like) in the
7833 \begin_inset Quotes eld
7837 \begin_inset Quotes erd
7841 Now click on the button labeled
7842 \begin_inset Quotes eld
7847 \begin_inset Quotes erd
7850 to open a file dialog and navigate to the directory containing the
7851 \begin_inset Flex Code
7854 \begin_layout Plain Layout
7860 program (which is installed by default on Cygwin along with the \SpecialChar LyX
7863 \begin_inset Flex Code
7866 \begin_layout Plain Layout
7872 and then specify the program arguments as
7873 \begin_inset Flex Code
7876 \begin_layout Plain Layout
7883 In this way, you will be using the
7887 for communicating with \SpecialChar LyX
7889 If, for whatever reason, you want to use the
7894 \begin_inset Flex Code
7897 \begin_layout Plain Layout
7903 option and be sure to specify the \SpecialChar LyX
7904 Server pipe path in the \SpecialChar LyX
7908 \begin_layout Standard
7909 In yap, reverse search is triggered by double-click.
7912 \begin_layout Subsubsection*
7916 \begin_layout Standard
7917 In order to use SumatraPDF for inverse search, enter
7918 \begin_inset Flex Code
7921 \begin_layout Plain Layout
7922 SumatraPDF -inverse-search "lyxeditor -g %f %l"
7927 in the viewer setting in
7928 \begin_inset Flex Noun
7931 \begin_layout Plain Layout
7932 Preferences\SpecialChar menuseparator
7933 File Handling\SpecialChar menuseparator
7934 File formats\SpecialChar menuseparator
7941 If SumatraPDF.exe is not in your command PATH, use its full posix path.
7943 \begin_inset Flex Code
7946 \begin_layout Plain Layout
7952 enables communication via the
7958 \begin_inset Flex Code
7961 \begin_layout Plain Layout
7967 option if you want to use the
7971 , and be sure to specify the \SpecialChar LyX
7972 Server pipe path in the \SpecialChar LyX
7976 \begin_layout Standard
7977 Reverse search is triggered by double-click.
7980 \begin_layout Section
7984 \begin_layout Standard
7985 Forward search is, as the name implies, in a sense the
7986 \begin_inset Quotes eld
7990 \begin_inset Quotes erd
7994 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
7996 If forward search is set up (as described in what follows), you can put
7997 the cursor anywhere in your \SpecialChar LyX
7999 \begin_inset Flex Noun
8002 \begin_layout Plain Layout
8003 Navigate\SpecialChar menuseparator
8010 \begin_inset Flex Noun
8013 \begin_layout Plain Layout
8019 in the context menu via right mouse click), and then the viewer will jump
8020 to that position as well.
8021 This implies, of course, that your viewer supports this function.
8024 \begin_layout Standard
8025 To make forward search possible, you first need to provide the generated
8026 output PDF/DVI file with additional information about the \SpecialChar TeX
8028 This can be done via the methods described in the section
8029 \begin_inset CommandInset ref
8031 reference "subsec:rev-search"
8038 \begin_layout Standard
8039 Additionally, you need to configure \SpecialChar LyX
8040 for using your viewers in
8041 \begin_inset Flex Noun
8044 \begin_layout Plain Layout
8045 Tools\SpecialChar menuseparator
8046 Preferences\SpecialChar menuseparator
8047 Output\SpecialChar menuseparator
8054 We provide a range of tested configurations for some viewers, which you
8055 can select from the drop down list.
8056 If none of these configurations suits you, you have to find out and enter
8057 a suitable configuration yourself.
8058 The definition syntax uses the following placeholders:
8061 \begin_layout Itemize
8063 \begin_inset Flex Code
8066 \begin_layout Plain Layout
8075 \begin_layout Itemize
8077 \begin_inset Flex Code
8080 \begin_layout Plain Layout
8086 : name of the (temporary) exported .tex file (without path)
8089 \begin_layout Itemize
8091 \begin_inset Flex Code
8094 \begin_layout Plain Layout
8100 : name of the (temporary) exported .tex file (including path)
8103 \begin_layout Itemize
8105 \begin_inset Flex Code
8108 \begin_layout Plain Layout
8114 : name of the exported output file (either dvi or pdf, depending on which
8115 one exists in the temporary directory)
8118 \begin_layout Standard
8119 Note that only some of the viewers provide full and usable forward search
8120 functionality out of the box, among them yap, xdvi, okular
8124 \begin_layout Plain Layout
8125 You might want to set
8126 \begin_inset Flex Code
8129 \begin_layout Plain Layout
8136 \begin_inset Flex Noun
8139 \begin_layout Plain Layout
8140 Tools\SpecialChar menuseparator
8141 Preferences\SpecialChar menuseparator
8142 File Handling\SpecialChar menuseparator
8144 \begin_inset space ~
8157 , qpdfview, and SumatraPDF
8161 \begin_layout Plain Layout
8162 SumatraPDF can also use DDE commands through the external program CMCDDE
8163 — downloadable from
8164 \begin_inset CommandInset href
8166 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8177 Others, such as evince
8181 \begin_layout Plain Layout
8182 Forward search with evince can be achieved by means of third party helper
8185 \begin_inset CommandInset href
8187 target "https://wiki.lyx.org/LyX/SyncTeX"
8197 , require some extra tools in order to use forward search.
8198 While many of the widespread PDF viewers (most notably Adobe Reader) do
8199 not support forward search at all, some other viewers – e.
8200 \begin_inset space \thinspace{}
8204 xpdf – allow at least to reload the document and jump to a specific page
8205 of the file, so you can at least navigate
8206 \begin_inset Quotes eld
8210 \begin_inset Quotes erd
8214 This latter functionality is provided by an external call of synctex (see
8215 the predefined example configurations).
8219 \begin_layout Standard
8220 Forward search works both with DVI and PDF output.
8222 simply checks which preview format you have used before (i.
8223 \begin_inset space \thinspace{}
8226 e., which format is already there in the temporary directory) and chooses
8227 the appropriate configuration for the respective format.
8230 \begin_layout Chapter
8231 Special Document Classes
8234 \begin_layout Section
8238 \begin_layout Standard
8244 \begin_layout Subsection
8248 \begin_layout Standard
8249 This section describes how \SpecialChar LyX
8250 can be used to write articles for submission
8251 to the scientific journal
8253 Astronomy and Astrophysics
8256 \begin_inset Flex URL
8259 \begin_layout Plain Layout
8261 https://www.aanda.org/
8266 ) using Version 5.01 of the document class
8271 This package can be downloaded from the ftp site
8274 \begin_layout Standard
8275 \begin_inset VSpace medskip
8281 \begin_layout Standard
8283 \begin_inset Flex URL
8286 \begin_layout Plain Layout
8288 ftp://ftp.edpsciences.org/pub/aa/readme.html
8296 \begin_layout Standard
8297 \begin_inset VSpace medskip
8303 \begin_layout Standard
8304 A manual comes together with that package, and this text is not meant to
8305 replace the original manual but is merely a short guide in how to realize
8306 the correct form of your paper.
8310 \begin_layout Standard
8311 Please note that the publisher of the journal was changed from Springer
8312 to EDP Sciences starting January 1, 2001.
8313 That change involved also some slight changes to the style files, namely
8314 the removal of the thesaurus command.
8315 The \SpecialChar LyX
8316 class aa supports the newest version of these style files, V 5.01.
8317 If you have an older version installed, please upgrade.
8318 For compatibility, the old (version 4) layout has been kept as
8323 Please refer to the comments in
8326 Dir/layouts/aapaper.layout
8331 \begin_layout Subsection
8335 \begin_layout Standard
8336 It is recommended you start from the example template distributed with \SpecialChar LyX
8338 If you are not using a template, note the following settings:
8341 \begin_layout Itemize
8348 Document\SpecialChar menuseparator
8351 dialog (OK, that one was obvious).
8354 \begin_layout Itemize
8355 Don't change the option
8358 \begin_inset space ~
8368 The whole layout is done by the macros, you shouldn't change anything.
8371 \begin_layout Subsection
8375 \begin_layout Standard
8376 First thing to enter is the header information.
8377 It consists of seven entries, of which some are optional.
8381 \begin_layout Itemize
8389 \begin_layout Itemize
8397 \begin_layout Itemize
8405 \begin_layout Itemize
8413 \begin_layout Itemize
8418 : [optional] if more than one author: whom to contact for offprint requests.
8421 \begin_layout Itemize
8426 : [optional] mail address for contacts.
8429 \begin_layout Itemize
8437 Received: <date>; Accepted <date>
8440 \begin_layout Standard
8441 There is no need to issue the
8447 command, this is done automatically by \SpecialChar LyX
8448 when the header is finished.
8449 Although the order of the single header entries doesn't matter it is advised
8450 to keep the above sequence, just to get the best optics and meets the layout
8451 of the real document.
8454 \begin_layout Standard
8455 If you want to place footnotes in the header block, e.
8456 \begin_inset space \thinspace{}
8460 \begin_inset space \space{}
8463 to state your present address, just use the standard footnote via the menu
8466 Insert\SpecialChar menuseparator
8471 will automagically use the term
8480 \begin_layout Standard
8483 Edit\SpecialChar menuseparator
8486 , you'll find two insets which are relevant for the titling:
8489 \begin_layout Itemize
8496 to mark corresponding author\SpecialChar breakableslash
8498 The institutes are numbered sequentially as they appear in the
8502 field, so you have to put a marker to each author.
8505 \begin_layout Itemize
8510 to supply an email address for fast contact.
8513 \begin_layout Standard
8514 In addition to these topics, the macros use one additional \SpecialChar LaTeX
8516 has no counterpart in \SpecialChar LyX
8520 \begin_layout Itemize
8527 to separate different names for more than one author and institute, respectivel
8531 \begin_layout Standard
8532 The appropriate command has to be entered in \SpecialChar LyX
8533 and marked as \SpecialChar LaTeX
8539 \begin_layout Subsection
8543 \begin_layout Standard
8544 The abstract should immediately follow the header block.
8545 With version 5 the abstract environment was changed to a command, and there
8546 is now a resctriction to only one paragraph.
8547 In addition, it should contain an entry with the keywords.
8548 This is done via the paragraph style
8553 Refer to the example paper.
8556 \begin_layout Subsection
8557 Supported environments
8560 \begin_layout Standard
8561 The A&A paper layout supports the following environments for structuring
8565 \begin_layout Itemize
8571 \begin_layout Itemize
8577 \begin_layout Itemize
8583 \begin_layout Itemize
8589 \begin_layout Itemize
8595 \begin_layout Itemize
8601 \begin_layout Itemize
8607 \begin_layout Itemize
8613 \begin_layout Itemize
8619 \begin_layout Itemize
8625 \begin_layout Itemize
8631 \begin_layout Itemize
8638 \begin_layout Subsection
8639 Commands not supported by \SpecialChar LyX
8643 \begin_layout Standard
8644 Some commands are not yet supported by the
8648 layout for \SpecialChar LyX
8650 Some have already been mentioned.
8651 For the sake of completeness, they are listed all together here:
8654 \begin_layout Itemize
8662 \begin_layout Itemize
8670 \begin_layout Itemize
8678 \begin_layout Itemize
8686 \begin_layout Standard
8687 If you want to use any of these commands, you have to enter them yourself.
8690 Do not forget to mark them as \SpecialChar LaTeX
8694 \begin_layout Subsection
8695 Figure and Table Floats
8698 \begin_layout Standard
8700 provides support for the necessary float environments
8702 figure, figure*, table
8708 , therefore we won't tell much about it here.
8712 \begin_inset space ~
8718 Just remember that tables should be left-aligned.
8719 For that, select the table and change the alignment in
8721 Edit\SpecialChar menuseparator
8723 \begin_inset space ~
8729 \begin_layout Standard
8730 There is only one special thing: the figures with caption besides the figure.
8731 To create such a figure, you have to do the following:
8734 \begin_layout Enumerate
8735 Create a wide figure float:
8737 Insert\SpecialChar menuseparator
8738 Float\SpecialChar menuseparator
8741 , then right click in the figure and select
8744 \begin_inset space ~
8752 \begin_layout Enumerate
8753 Enter your caption text.
8756 \begin_layout Enumerate
8761 to move the cursor above the caption.
8764 \begin_layout Enumerate
8768 \begin_layout Enumerate
8769 Position the cursor behind the figure and insert a horizontal fill:
8771 Insert\SpecialChar menuseparator
8773 \begin_inset space ~
8776 Character\SpecialChar menuseparator
8778 \begin_inset space ~
8786 \begin_layout Enumerate
8787 Switch to \SpecialChar LaTeX
8791 \begin_inset space ~
8799 \begin_layout Enumerate
8809 Do not close the brace!
8812 \begin_layout Enumerate
8813 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
8818 \begin_inset space ~
8830 \begin_layout Standard
8831 Also, refer to the figures in the example paper.
8834 \begin_layout Subsection
8838 \begin_layout Standard
8839 For submission, the paper has to be formated in a special double-spacing
8841 For this purpose, you have to give the option
8845 to the documentclass.
8846 This must be done using the custom class options field in the
8848 Document\SpecialChar menuseparator
8852 Just enter the string
8859 \begin_layout Subsection
8863 \begin_layout Standard
8868 directory contains an example paper written with \SpecialChar LyX
8870 It is the example paper from the original macro package, translated to
8873 Use it for inspiration, and compare the original \SpecialChar LaTeX
8874 code with \SpecialChar LyX
8878 \begin_layout Section
8883 \begin_layout Standard
8889 \begin_layout Subsection
8893 \begin_layout Standard
8895 is a set of macros produced by the American Astronomical Society to
8896 facilitate electronic manuscript submission to the three journals they
8897 publish: the Astrophysical Journal (including the Letters and Supplement),
8898 the Astronomical Journal, and the Publications of the Astronomical Society
8901 has proven to be an excellent tool for generating these documents, especially
8902 given its equation, citation, and figure handling capabilities.
8904 requires version 5.0 (or higher) of these macros; preferably 6.0, which
8905 is the version described here, or higher.
8906 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
8907 2.09 and are fundamentally
8908 incompatible with \SpecialChar LyX
8910 The AAS\SpecialChar TeX
8911 package may be downloaded from the AAS\SpecialChar TeX
8915 \begin_layout Standard
8916 \begin_inset VSpace medskip
8922 \begin_layout Standard
8924 \begin_inset Flex URL
8927 \begin_layout Plain Layout
8929 https://aas.org/aastex/aastex-downloads
8937 \begin_layout Standard
8938 \begin_inset VSpace medskip
8944 \begin_layout Standard
8945 A complete user guide is contained in that package and you should familiarize
8946 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
8949 will not reduce the need to figure out all the AAS\SpecialChar TeX
8950 commands, it will only
8951 reduce the drudgery of typing everything in.
8952 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
8954 completely to the requirements of the journal to which you are submitting
8958 \begin_layout Subsection
8959 Starting a New Paper
8962 \begin_layout Standard
8963 I strongly suggest that you start with the AAS\SpecialChar TeX
8967 File\SpecialChar menuseparator
8974 , enter the new file name, then choose the
8979 This will show the most common fields found in a manuscript.
8980 Simply overwrite the existing text (including the brackets,
8984 ) with the correct information.
8985 Many of the AAS\SpecialChar TeX
8986 commands and environments can be implemented directly in
8989 For commands such as these, the \SpecialChar LaTeX
8990 code must be entered directly and marked
8992 Such commands are referred to as \SpecialChar TeX
8993 code, or Evil Red Text.
8994 I tried to minimize the amount of \SpecialChar TeX
8995 code needed in an AAS\SpecialChar TeX
8999 \begin_layout Subsection
9000 Finishing Your Paper
9003 \begin_layout Standard
9004 When the paper is finished to your satisfaction and previews/prints correctly,
9006 \begin_inset Quotes eld
9010 \begin_inset Quotes erd
9013 actions which need to be done before you submit it to the journals.
9017 \begin_layout Enumerate
9018 Export your paper as a \SpecialChar LaTeX
9021 File\SpecialChar menuseparator
9022 Export\SpecialChar menuseparator
9030 \begin_layout Enumerate
9035 file with your favorite text editor
9039 \begin_layout Enumerate
9040 remove the comment lines before the
9049 \begin_layout Enumerate
9054 usepackage...{fontenc}
9056 line if it appears (usually just after
9071 \begin_layout Enumerate
9072 remove everything between (and including) the
9084 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9086 (which should appear immediately after the
9087 \begin_inset Quotes eld
9090 User specified \SpecialChar LaTeX
9092 \begin_inset Quotes erd
9103 \begin_layout Enumerate
9104 Run the resulting file through \SpecialChar LaTeX
9105 to make sure it still processes correctly.
9108 \begin_layout Enumerate
9109 Reread the journal requirements to make sure your filenames and formats
9113 \begin_layout Enumerate
9117 \begin_layout Subsection
9118 Comments On Specific Commands
9121 \begin_layout Standard
9122 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9129 ) gives a good description of each.
9130 Thus it's probably easiest for me to go down the list as found in the guide
9131 and offer comments where necessary.
9132 So let's begin \SpecialChar ldots
9136 \begin_layout Subsubsection
9137 Things that work as expected
9140 \begin_layout Standard
9141 Because they work as you might expect, I simply list them and the section
9242 begin{thebibliography}
9250 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9251 graphicx figure commands (2.14.1),
9275 (2.15.4, amongst other places),
9302 \begin_layout Standard
9303 The following style options also work correctly:
9324 Simply put them in the
9330 Layout\SpecialChar menuseparator
9336 \begin_layout Subsubsection
9337 Things that work, but require more comment
9340 \begin_layout Standard
9341 The following items work, but require a little more discussion:
9344 \begin_layout Itemize
9345 These items are reserved for use by the journal editors, but you can put
9346 them into the \SpecialChar LaTeX
9347 preamble if you feel compelled to do so:
9380 \begin_layout Itemize
9381 These items may be placed in the \SpecialChar LaTeX
9382 preamble, and are included as blanks in
9404 \begin_layout Itemize
9411 (2.3) – can only be used
9412 \begin_inset Quotes eld
9416 \begin_inset Quotes erd
9419 , not in the middle of a paragraph.
9420 Use \SpecialChar TeX
9421 code if you need to embed it.
9424 \begin_layout Itemize
9431 (2.3) – will have extra {} after it.
9432 This should not cause an error.
9435 \begin_layout Itemize
9442 (2.6) – can only be used
9443 \begin_inset Quotes eld
9447 \begin_inset Quotes erd
9450 , not in the middle of a paragraph.
9451 Use \SpecialChar TeX
9452 code if you need to embed it.
9455 \begin_layout Itemize
9462 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9466 \begin_layout Itemize
9473 (2.8) – same as for
9480 \begin_layout Itemize
9487 (2.9) – will have extra {} after it.
9488 This should not cause an error.
9491 \begin_layout Itemize
9498 (2.11) – will have extra {} after it.
9499 This should not cause an error.
9502 \begin_layout Itemize
9509 (2.14.2) – you can insert an optional filename argument by placing the cursor
9510 at the beginning of the text and selecting
9512 Insert\SpecialChar menuseparator
9517 \begin_inset Quotes eld
9521 \begin_inset Quotes erd
9524 inserts an optional argument of the type needed by
9531 Hopefully it will be renamed someday.
9534 \begin_layout Itemize
9541 (2.17.1) – same as
9547 for the catalog ID optional parameter
9550 \begin_layout Itemize
9557 (2.17.1) – same as
9563 for the catalog ID optional parameter
9566 \begin_layout Subsubsection
9567 Things not implemented, use \SpecialChar TeX
9571 \begin_layout Standard
9582 setcounter{equation}
9584 (2.12), Journal name abbreviations (2.13.4),
9620 (2.15.4, insert it as the first element in the lefthand cell after where
9622 Don't use any of \SpecialChar LyX
9623 's rules in the table),
9635 (2.15.5), much of Misc (2.17, except
9686 \begin_layout Subsubsection
9687 Things that cannot be implemented
9690 \begin_layout Standard
9692 at least in any meaningful sort of way, so I suggest ignoring them.
9693 They are the references environment (2.13.3), and the deluxetable environment
9695 If you really, really need to use deluxetable, I suggest editing it in
9696 a separate file with a text editor, then using
9698 Insert\SpecialChar menuseparator
9700 \begin_inset space ~
9705 to include it in your \SpecialChar LyX
9711 file to see an example of this.
9714 \begin_layout Subsection
9715 FAQs, Tips, Tricks, and Other Ruminations
9718 \begin_layout Subsubsection
9719 Getting \SpecialChar LyX
9720 and AAS\SpecialChar TeX
9724 \begin_layout Standard
9725 It can be a bit tricky to get \SpecialChar LyX
9726 to recognize a new layout and document class.
9727 When all else fails, do this:
9730 \begin_layout Enumerate
9731 Make certain that \SpecialChar LaTeX
9732 can find AAS\SpecialChar TeX
9734 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
9736 directory completely unrelated to \SpecialChar LaTeX
9737 or AAS\SpecialChar TeX
9738 and run \SpecialChar LaTeX
9746 \begin_layout Enumerate
9751 appears in \SpecialChar LyX
9759 \begin_layout Enumerate
9762 Tools\SpecialChar menuseparator
9766 , then restart \SpecialChar LyX
9770 \begin_layout Enumerate
9771 Open a regular new file, not from a template.
9772 Does AAS\SpecialChar TeX
9773 appear in the class list in
9775 Document\SpecialChar menuseparator
9781 \begin_layout Standard
9782 If you get a warning from an existing AAS\SpecialChar TeX
9783 document about not being able
9784 to find the AAS\SpecialChar TeX
9785 layout or a message about
9786 \begin_inset Quotes eld
9789 You should not mix title layouts with normal ones
9790 \begin_inset Quotes erd
9793 , things haven't been installed correctly.
9796 \begin_layout Subsubsection
9798 error processing a table
9801 \begin_layout Standard
9803 , by default, attempts to center the table caption/title.
9804 This seems to produce a bad interaction in AAS\SpecialChar TeX
9805 so you should click somewhere
9806 in the caption/title, then select
9808 Edit\SpecialChar menuseparator
9810 \begin_inset space ~
9824 This took care of it for me.
9827 \begin_layout Subsubsection
9831 \begin_layout Standard
9832 A couple of things: 1) I have noticed some funny spacing in the reference
9833 entries in the text.
9834 When you enter the bibliography item data, make sure their is
9838 space between the last author and the parenthesis setting off the year;
9842 \begin_inset space \thinspace{}
9846 \begin_inset space \space{}
9860 2) Entering the references at all is not obvious.
9861 The easiest thing is to start typing your first reference at the end of
9862 the document, then mark it as type
9867 That will put a small gray box in front of what you just typed.
9868 Click on the box to fill in the rest of the information.
9869 For new references, go to the end of an existing reference and press return.
9870 That will create a new line with its own box, etc.
9873 \begin_layout Subsubsection
9877 \begin_layout Standard
9878 Even though AAS\SpecialChar TeX
9879 provides its own figure commands (
9885 , for example), I much prefer \SpecialChar LaTeX
9886 's standard figure commands (with the default
9895 \begin_inset space ~
9898 commands as \SpecialChar TeX
9899 code into a Figure Float box if you desire, but I never have
9900 much luck getting the layout right.
9901 With the standard graphics, \SpecialChar LyX
9906 usepackage{graphicx}
9908 command into the \SpecialChar LaTeX
9909 preamble and handle the figures in the standard \SpecialChar LaTeX2e
9911 interspersing the figures in the text.
9912 I believe ApJ accepts figures exactly this way now; AJ might still use
9914 \begin_inset Quotes eld
9917 stack everything at the end
9918 \begin_inset Quotes erd
9924 \begin_layout Subsubsection
9925 Things I could have done, but didn't
9928 \begin_layout Standard
9930 \begin_inset Quotes eld
9934 \begin_inset Quotes erd
9937 things I could have implemented, but chose not to.
9938 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
9940 even though it is double-spaced in the paper manuscript.
9941 Also, I chose not to make separate layouts for the preprint and preprint2
9943 Since I assume you will spend most of your time in the plain manuscript
9944 mode anyway, I decided not to chew up more disk space with this.
9948 \begin_layout Subsection
9952 \begin_layout Standard
9953 Your mileage may vary.
9954 I've now had papers published by both ApJ and AJ that have had 98% of the
9955 effort done in \SpecialChar LyX
9956 ; the last 2% was the \SpecialChar LaTeX
9957 post-processing and a few cleanups.
9958 I have had no trouble with the submission process, and I'm sure the journals
9959 were never aware that there might be a difference.
9960 So, go forth and publish!
9963 \begin_layout Section
9964 AMS \SpecialChar LaTeX
9968 \begin_layout Standard
9978 \begin_layout Standard
9979 \begin_inset VSpace bigskip
9985 \begin_layout Standard
9987 The AMS \SpecialChar LaTeX
9988 layouts are set up to conform to suggested styles for mathematical
9989 papers to be submitted to American Mathematical Society publications.
9990 The layouts are not tailored to a specific journal, but easily can be.
9991 You should refer to the AMS documentation for specific instructions for
9992 each journal (usually it will entail only changing a single line in the
9995 That documentation is available on the Web at
9996 \begin_inset Flex URL
9999 \begin_layout Plain Layout
10007 \begin_inset Flex URL
10010 \begin_layout Plain Layout
10012 ftp://ftp.ams.org/pub/tex/amslatex/
10018 These layouts are appropriate, and useful, for any mathematical writing.
10022 \begin_layout Standard
10023 There are two basic AMS \SpecialChar LaTeX
10027 \begin_layout Itemize
10028 amsart: The standard AMS article format.
10031 \begin_layout Itemize
10032 amsbook: the standard AMS book (really, monograph) format.
10036 \begin_layout Standard
10037 The layouts themselves contain only the minimum necessary to use the AMS
10039 They do not, in particular, contain any of the `theorem' environments used
10040 for setting theorems, lemmas, and the like.
10041 These are contained, instead, in the
10042 \begin_inset Flex Code
10045 \begin_layout Plain Layout
10051 module, which is loaded by default when you select one of the AMS classes.
10052 (It can also be used with other classes and can be removed, if you would
10053 rather use something else.) Less commonly used environments are in the
10054 \begin_inset Flex Code
10057 \begin_layout Plain Layout
10058 Theorems (AMS-Extended)
10063 module, which must be loaded manually.
10066 \begin_layout Standard
10067 By default, theorems and the like are numbered consecutively throughout
10068 the document, but this may be modified by loading the module
10069 \begin_inset Flex Code
10072 \begin_layout Plain Layout
10073 Theorems (Order by Section)
10078 or, if you are using
10079 \begin_inset Flex Code
10082 \begin_layout Plain Layout
10089 \begin_inset Flex Code
10092 \begin_layout Plain Layout
10093 Theorems (Order by Chapter)
10099 These will number the results as
10100 \begin_inset Formula $n.m$
10103 , where the first number refers to the section (or chapter) and the second
10104 refers to the total number of results so far in that section (or chapter).
10105 Many environments are also available unnumbered.
10106 These are indicated by an asterisk at the end.
10107 If you happen to want
10111 unnumbered results, the module
10112 \begin_inset Flex Code
10115 \begin_layout Plain Layout
10121 provides that option.
10124 \begin_layout Standard
10125 Note that these modules do not
10129 to be used with the AMS classes.
10130 It is perfectly possible to use the
10131 \begin_inset Flex Code
10134 \begin_layout Plain Layout
10140 module, and the others mentioned, with other classes, such as
10141 \begin_inset Flex Code
10144 \begin_layout Plain Layout
10151 \begin_inset Flex Code
10154 \begin_layout Plain Layout
10161 \begin_inset Flex Code
10164 \begin_layout Plain Layout
10173 \begin_layout Subsection
10174 What these layouts provide
10177 \begin_layout Standard
10178 There is a long list of included environments provided by these layouts.
10179 In AMS-\SpecialChar LaTeX
10180 , there is, in fact, an opportunity to define an unlimited variety
10181 of `theorem' environments.
10182 However, the AMS recommends the environments that are available in \SpecialChar LyX
10187 \begin_layout Standard
10188 The following environments—as well as the standard environments, such as
10190 \begin_inset Flex Noun
10193 \begin_layout Plain Layout
10200 \begin_inset Flex Noun
10203 \begin_layout Plain Layout
10210 \begin_inset Flex Noun
10213 \begin_layout Plain Layout
10220 \begin_inset Flex Noun
10223 \begin_layout Plain Layout
10230 \begin_inset Flex Noun
10233 \begin_layout Plain Layout
10240 \begin_inset Flex Code
10243 \begin_layout Plain Layout
10250 \begin_inset Flex Code
10253 \begin_layout Plain Layout
10262 \begin_layout Description
10263 Address This should be the author's permanent address.
10266 \begin_layout Description
10268 \begin_inset space ~
10271 Address This should be the author's temporary address at the time of submission,
10272 if different from the Address.
10275 \begin_layout Description
10276 Email Author's e-mail address
10279 \begin_layout Description
10280 URL Author's Web address, if desired.
10283 \begin_layout Description
10284 Keywords Key words or phrases used to identify specific topics discussed
10288 \begin_layout Description
10289 Subjectclass These refer to the AMS Subject Classifications, published and
10292 Mathematical Reviews
10295 These are also available online at the AMS cites listed above.
10298 \begin_layout Description
10302 \begin_layout Description
10306 \begin_layout Description
10310 \begin_layout Standard
10311 The following environments are provided by both the
10312 \begin_inset Flex Code
10315 \begin_layout Plain Layout
10322 \begin_inset Flex Code
10325 \begin_layout Plain Layout
10331 modules, in the latter case in both starred (unnumbered) and unstarred
10332 (numbered) versions.
10333 These same environments are provided only in the starred versions by the
10335 \begin_inset Flex Code
10338 \begin_layout Plain Layout
10347 \begin_layout Theorem
10348 This is typically used for the statements of major results.
10352 \begin_layout Corollary*
10353 This is used for statements which follow fairly directly from previous statement
10355 Again, these can be major results.
10359 \begin_layout Lemma
10360 These are smaller results needed to prove other statements.
10363 \begin_layout Proposition
10364 These are less major results which (hopefully) add to the general theory
10368 \begin_layout Conjecture
10369 These are statements provided without justification, which the author does
10370 not know how to prove, but which seem to be true (to the author, at least).
10373 \begin_layout Definition*
10374 Guess what this is for.
10375 The font is different for this environment than for the previous ones.
10379 \begin_layout Example*
10380 Used for examples illustrating proven results.
10383 \begin_layout Problem
10384 It's not really known what this is for.
10385 You should figure it out.
10388 \begin_layout Exercise*
10389 Write a description for this one.
10392 \begin_layout Remark
10393 This environment is also a type of theorem, usually a lesser sort of observation.
10396 \begin_layout Claim*
10397 Often used in the course of giving a proof of a larger result.
10401 Generally, these are used to break up long arguments, using specific instances
10407 The numbering scheme for cases is on its own, not together with other numbered
10412 \begin_layout Proof
10413 At the end of this environment, a QED symbol (usually a square, but it can
10414 vary with different styles) is placed.
10415 If you want to have other environments within this one—for example, Case
10416 environments—and have the QED symbol appear only after them, then the other
10417 environments need to be nested within the proof environment.
10420 Nesting Environments
10426 for information on nesting.
10429 \begin_layout Standard
10430 And these environments are provided by
10431 \begin_inset Flex Code
10434 \begin_layout Plain Layout
10435 Theorems (AMS-Extended)
10443 \begin_layout Criterion*
10444 A required condition.
10447 \begin_layout Algorithm*
10448 A general procedure to be used.
10451 \begin_layout Axiom*
10452 This is a property or statement taken as true within the system being discussed.
10455 \begin_layout Condition*
10456 Sometimes used to state a condition assumed within the present context of
10460 \begin_layout Note*
10461 Similar to a Remark.
10464 \begin_layout Notation*
10465 Used for the explanation of, yes, notation.
10468 \begin_layout Summary
10469 Do we really need to tell you?
10472 \begin_layout Acknowledgement*
10476 \begin_layout Conclusion*
10477 Sometimes used at the end of a long train of argument.
10481 Used in a way similar to Proposition, though perhaps lower on the scale.
10484 \begin_layout Standard
10485 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10488 They need to be available on your system in order to use these environments.
10491 \begin_layout Section
10499 \begin_layout Standard
10505 \begin_layout Subsection
10509 \begin_layout Standard
10510 These are the layout files for some of the journals of the American Geophysical
10512 It is assumed that you have both the AGU's own class files and AGUplus
10513 installed (everything to be found at
10514 \begin_inset Flex URL
10517 \begin_layout Plain Layout
10519 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
10527 \begin_layout Subsection
10531 \begin_layout Standard
10541 They are still called this in the \SpecialChar LyX
10542 GUI, though their \SpecialChar LaTeX
10555 \begin_layout Standard
10556 Newly defined styles are
10593 These are mostly manuscript attributes and defined in the AGU class documentati
10597 \begin_layout Standard
10598 I suspect this is still badly incomplete.
10601 \begin_layout Subsection
10605 \begin_layout Standard
10622 \begin_layout Subsection
10626 \begin_layout Itemize
10629 Journal of Geophysical Research
10638 \begin_layout Standard
10639 Add your own, it isn't so hard! Look at the
10650 \begin_layout Subsection
10651 Bugs and things to remember
10654 \begin_layout Standard
10655 In order to use the new layouts, you must remember to do the following for
10659 \begin_layout Enumerate
10665 This can be done in the
10667 Layout\SpecialChar menuseparator
10672 Document\SpecialChar menuseparator
10676 (AGU articles are always in English, right? So
10680 choose a language.)
10683 \begin_layout Enumerate
10688 into the document's
10693 (Yes, this is a bug.)
10696 \begin_layout Enumerate
10697 Make sure you use the
10701 bibliography style, by entering
10705 into the second field of the Bib\SpecialChar TeX
10707 None of the standard styles will do.
10710 \begin_layout Section
10714 \begin_layout Standard
10720 \begin_layout Subsection
10724 \begin_layout Standard
10725 Broadway is for writing plays.
10726 The format is more decorative than Hollywood, and much less standardized.
10727 This format should be suitable for workshops.
10730 \begin_layout Subsection
10734 \begin_layout Standard
10735 The same as in Hollywood.
10738 \begin_layout Subsection
10742 \begin_layout Standard
10747 names as labels then cross-reference the label to insert the name.
10748 The cross-reference dialog will show the current cast of characters.
10751 \begin_layout Subsection
10752 Paper size and Margins
10755 \begin_layout Standard
10756 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10759 \begin_layout Subsection
10763 \begin_layout Standard
10764 The following environments are available.
10765 You can use broadway.bind to get the bind keys shown at the right.
10768 \begin_layout Itemize
10772 \begin_inset Newline newline
10777 You should not have to use this, but it is here for anything that does not
10781 \begin_layout Itemize
10785 \begin_inset space \hfill{}
10789 \begin_inset Newline newline
10794 Used to describe stage setting and the action.
10795 First use of speaker names in all CAPs.
10798 \begin_layout Itemize
10802 \begin_inset space \hfill{}
10806 \begin_inset Newline newline
10811 Automatically numbered.
10812 On screen it will be arabic, but will print as Roman.
10815 \begin_layout Itemize
10819 \begin_inset space \hfill{}
10823 \begin_inset Newline newline
10833 It is just centered text.
10836 \begin_layout Itemize
10840 \begin_inset space \hfill{}
10844 \begin_inset Newline newline
10849 Not automatically numbered.
10850 You supply the number.
10851 This is because I couldn't figure out how.
10854 \begin_layout Itemize
10858 \begin_inset space \hfill{}
10862 \begin_inset Newline newline
10867 A special case of Narrative to describe the setting and action as the curtain
10871 \begin_layout Itemize
10875 \begin_inset space \hfill{}
10879 \begin_inset Newline newline
10884 The speaker's (actor's) title, centered in all CAPS.
10887 \begin_layout Itemize
10891 \begin_inset space \hfill{}
10895 \begin_inset Newline newline
10900 Instructions to the speaker.
10901 The parentheses are automatically inserted.
10902 The ( will appear on screen, but both will be in the printed play.
10903 This environment is only used within
10910 \begin_layout Itemize
10914 \begin_inset space \hfill{}
10918 \begin_inset Newline newline
10923 What the Speaker says.
10926 \begin_layout Itemize
10930 \begin_inset space \hfill{}
10934 \begin_inset Newline newline
10939 The curtain comes down.
10942 \begin_layout Itemize
10946 \begin_inset space \hfill{}
10952 \begin_layout Itemize
10956 \begin_inset space \hfill{}
10962 \begin_layout Itemize
10966 \begin_inset space \hfill{}
10972 \begin_layout Standard
10976 \begin_layout Section
10980 \begin_layout Standard
10985 can be used to type letters according to German conventions.
10986 A template file is included in
10988 .../lyx/share/templates
10990 for you to use as a starting point.
10993 \begin_layout Section
11001 \begin_layout Standard
11007 \begin_layout Subsection
11011 \begin_layout Standard
11012 This is the layout file for the European Geophysical Society journals.
11017 can be downloaded from the web site of the EGS under
11018 \begin_inset Flex URL
11021 \begin_layout Plain Layout
11031 \begin_layout Subsection
11035 \begin_layout Standard
11038 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
11046 The current layout file is unfortunately very unmodular and would benefit
11047 from using the various
11054 \begin_layout Section
11058 \begin_layout Standard
11059 See the \SpecialChar LyX
11065 It contains all infos you need.
11068 \begin_layout Section
11071 Foil\SpecialChar TeX
11075 \begin_inset CommandInset label
11084 \begin_layout Standard
11090 \begin_layout Subsection
11094 \begin_layout Standard
11095 This section describes how to use \SpecialChar LyX
11096 to make slides for overhead projectors.
11097 There are two document classes that can do this: the default slides class
11100 Foil\SpecialChar TeX
11104 This section documents the latter.
11107 \begin_layout Standard
11108 I'm going to say this again, nice and clear, so that there's no misunderstanding
11112 \begin_layout Standard
11113 \begin_inset VSpace bigskip
11119 \begin_layout Standard
11123 This section documents the class
11124 \begin_inset Quotes eld
11132 \begin_inset Quotes erd
11140 \begin_layout Standard
11141 \begin_inset VSpace bigskip
11147 \begin_layout Standard
11148 If you're looking for the documentation for
11149 \begin_inset Quotes eld
11157 \begin_inset Quotes erd
11160 , check out section
11161 \begin_inset space ~
11165 \begin_inset CommandInset ref
11167 reference "sec:slitex"
11172 If your machine doesn't have the
11180 installed, you'll probably have to use the default
11184 class, which isn't quite as good as
11189 \begin_layout Standard
11194 class is designed for use with version
11195 \begin_inset space ~
11203 class file which is now an integral part of \SpecialChar LaTeX2e
11207 \begin_layout Subsection
11211 \begin_layout Standard
11212 Obviously, to use this document class, you need to select
11223 \begin_inset space ~
11229 There are some settings in the
11232 \begin_inset space ~
11237 dialog that you should know about that are specific to this class:
11240 \begin_layout Itemize
11241 Don't change the options
11252 \begin_inset space ~
11258 They're ignored by the
11265 \begin_layout Itemize
11266 The default font size is 20
11267 \begin_inset space \thinspace{}
11270 pt with the other options being 17
11271 \begin_inset space \thinspace{}
11275 \begin_inset space \thinspace{}
11279 \begin_inset space \thinspace{}
11285 \begin_layout Itemize
11286 The default font is
11294 but all math equations are still typeset in the usual roman font.
11297 \begin_layout Itemize
11300 Foil\SpecialChar TeX
11303 supports A4 and Letter paper sizes as well as a special size for working
11305 \begin_inset space \thinspace{}
11309 It doesn't support A5, B5, legal or executive paper sizes.
11312 \begin_layout Itemize
11313 Don't bother changing the
11317 settings because they are ignored anyway.
11318 All floats appear where they are defined in the text.
11321 \begin_layout Itemize
11326 setting behaves a bit differently for this class.
11329 Foil\SpecialChar TeX
11332 provides extensive footer and header capabilities including a user-defined
11335 \begin_inset space ~
11339 \begin_inset CommandInset ref
11341 reference "sec:foilfoot"
11346 The title page is treated differently to all other pages in the document
11355 has the logo centered at the bottom of the page (if one is defined).
11356 The possible page style choices and what they do are as follows:
11360 \begin_layout Labeling
11361 \labelwidthstring MMMMMMM
11368 The final output contains no page numbers, or other headers or footers
11369 (except footnotes of course).
11373 \begin_layout Labeling
11374 \labelwidthstring MMMMMMM
11381 The final output contains page numbers centered at the bottom of the page.
11382 No other headings or footers (other than footnotes).
11385 \begin_layout Labeling
11386 \labelwidthstring MMMMMMM
11391 Page numbers in lower right corner.
11392 Additional headers and footers are also shown.
11393 This is also the default.
11396 \begin_layout Labeling
11397 \labelwidthstring MMMMMMM
11402 Gives you access to the
11406 package although its use with
11408 Foil\SpecialChar TeX
11411 is discouraged by the writer of the
11413 Foil\SpecialChar TeX
11416 package because of some potential page layout clashes.
11420 \begin_layout Subsubsection
11424 \begin_layout Standard
11425 The following options may be used in the extra class options in the
11427 Document\SpecialChar menuseparator
11433 \begin_layout Labeling
11434 \labelwidthstring MMMMMMx
11439 This sets up the page layout for 7.33
11440 \begin_inset space \thinspace{}
11444 \begin_inset space \thinspace{}
11447 in paper, which is about the same aspect ratio as a 35
11448 \begin_inset space \thinspace{}
11451 mm slide, making it a bit easier to work with this medium.
11454 \begin_layout Labeling
11455 \labelwidthstring MMMMMMx
11460 Places a rule across the page below the header on every page except the
11464 \begin_layout Labeling
11465 \labelwidthstring MMMMMMx
11470 Places a rule across the page above the footer on every page except the
11474 \begin_layout Labeling
11475 \labelwidthstring MMMMMMx
11480 This is automatically set each time you create a new
11487 Foil\SpecialChar TeX
11490 to use the dvips driver to rotate those pages that are set as landscape
11494 \begin_layout Labeling
11495 \labelwidthstring MMMMMMx
11500 Simply changes the page dimensions to those of a landscape page but doesn't
11502 Thus if you use this option you need to use an external program to rotate
11503 each page or feed your paper through your printer as landscape.
11504 Note that this option effectively reverses the roles of the
11512 environments (don't worry these are described in the next section).
11515 \begin_layout Labeling
11516 \labelwidthstring MMMMMMx
11521 Equation numbers on the left.
11524 \begin_layout Labeling
11525 \labelwidthstring MMMMMMx
11530 Flush-left equations.
11533 \begin_layout Subsection
11534 Supported Environments
11537 \begin_layout Standard
11538 Most of the environments commonly supported in other classes are also supported
11544 There are several additional environments provided by
11546 Foil\SpecialChar TeX
11549 as well as a couple added by \SpecialChar LyX
11551 The following environments are shared with other classes:
11554 \begin_layout Standard
11555 \begin_inset Flex Multiple Columns
11558 \begin_layout Itemize
11564 \begin_layout Itemize
11570 \begin_layout Itemize
11576 \begin_layout Itemize
11582 \begin_layout Itemize
11588 \begin_layout Itemize
11595 \begin_layout Itemize
11601 \begin_layout Itemize
11607 \begin_layout Itemize
11613 \begin_layout Itemize
11619 \begin_layout Itemize
11625 \begin_layout Itemize
11631 \begin_layout Itemize
11637 \begin_layout Itemize
11643 \begin_layout Itemize
11654 \begin_layout Standard
11655 That is, all the major environments apart from the sectioning environments.
11656 Since foils are essentially self-contained sections, with a title and body,
11659 Foil\SpecialChar TeX
11662 provides specific commands for starting new foils and these are:
11665 \begin_layout Itemize
11671 \begin_layout Itemize
11677 \begin_layout Standard
11679 also provides slightly modified versions of these two environments called:
11682 \begin_layout Itemize
11688 \begin_layout Itemize
11691 ShortRotatefoilhead
11694 \begin_layout Standard
11695 and the differences will be explained in the next section.
11698 \begin_layout Standard
11699 Since foils are often used in presenting ideas or new theorems and such
11702 Foil\SpecialChar TeX
11705 also provides a comprehensive box of goodies for presenting them:
11708 \begin_layout Standard
11709 \begin_inset Flex Multiple Columns
11712 \begin_layout Itemize
11718 \begin_layout Itemize
11724 \begin_layout Itemize
11730 \begin_layout Itemize
11736 \begin_layout Itemize
11742 \begin_layout Itemize
11748 \begin_layout Itemize
11754 \begin_layout Itemize
11760 \begin_layout Itemize
11766 \begin_layout Itemize
11772 \begin_layout Itemize
11783 \begin_layout Standard
11784 The starred versions are unnumbered while the unstarred versions are numbered.
11785 There are also two list environments added by \SpecialChar LyX
11789 \begin_layout Itemize
11795 \begin_layout Itemize
11801 \begin_layout Standard
11804 Foil\SpecialChar TeX
11807 provides some powerful header and footer capabilities that are best set
11808 in the preamble although they may be set at any point in a document.
11809 If you want to change these settings in your document the best place to
11810 do so is at the very top of a foil, i.
11811 \begin_inset space \thinspace{}
11817 \begin_inset space \space{}
11822 straight after the foilhead.
11825 \begin_layout Standard
11826 For this purpose, the following command styles are provided [
11833 \begin_layout Standard
11834 \begin_inset Flex Multiple Columns
11837 \begin_layout Itemize
11841 \begin_inset space ~
11847 \begin_layout Itemize
11853 \begin_layout Itemize
11857 \begin_inset space ~
11863 \begin_layout Itemize
11867 \begin_inset space ~
11873 \begin_layout Itemize
11877 \begin_inset space ~
11884 \begin_layout Plain Layout
11885 \begin_inset space ~
11897 \begin_layout Standard
11898 There are also a few commands provided by
11900 Foil\SpecialChar TeX
11903 that aren't directly supported by \SpecialChar LyX
11904 but I'll tell you what they do and how
11905 to use them in section
11906 \begin_inset space ~
11910 \begin_inset CommandInset ref
11912 reference "sec:unsuppfoils"
11919 \begin_layout Subsection
11920 Building a Set of Foils
11923 \begin_layout Standard
11924 This section will give a simple introduction to using the different environments
11925 to build a set of foils.
11926 If you want to see an example set of foils, take a look at the
11930 file you find in \SpecialChar LyX
11938 \begin_layout Subsubsection
11939 Give It a Title Page
11942 \begin_layout Standard
11943 Unlike other classes that provide
11963 creates the title on a page of its own.
11964 If you leave out the
11968 environment \SpecialChar LaTeX
11969 will substitute the current date (every time you regenerate
11973 \begin_layout Subsubsection
11977 \begin_layout Standard
11978 As I mentioned earlier, there are four ways of starting a new foil.
11979 For portrait foils you should use
11988 The difference between these two environments is the amount of space between
11989 the title of the foil (the foilhead) and the body of the foil.
11992 \begin_layout Standard
11993 Landscape foils are generated using the
11999 ShortRotatefoilhead
12002 Again the only difference is the spacing between foilhead and body.
12003 Both of the short versions have 0.5
12004 \begin_inset space ~
12007 inches less separation between the foilhead and the body.
12011 \begin_layout Standard
12012 One problem with the support for landscape foils is the requirement that
12013 you have to use the
12017 driver to generate the PostScript output otherwise the foils won't be rotated.
12018 It is possible to get landscape foils even if you haven't got the
12022 driver provided you can feed your foils sideways through your printer ;-)
12025 \begin_layout Subsubsection
12026 Theorems, Lemmas, Proofs and more
12029 \begin_layout Standard
12030 You can't have two of the same type of these environments directly following
12032 If you use a normal paragraph break, , you will just be extending the previous
12033 environment as if you had merged the two environments together.
12034 Rather than that, you need to insert a so-called separator.
12035 Please refer to the section entitled
12046 \begin_layout Subsubsection
12050 \begin_layout Standard
12051 You get all the commonly supported list styles found in other classes as
12052 well as two new ones.
12053 I'll only describe the new ones here.
12054 If you want to find out more about the other list environments check out
12060 If you intend to use itemized lists you might also want to read about the
12064 \begin_inset space ~
12068 \begin_inset space ~
12073 dialog described above in section
12074 \begin_inset space ~
12078 \begin_inset CommandInset ref
12080 reference "sec:bullet"
12087 \begin_layout Standard
12088 The two new list styles,
12096 , are designed to make it easier for you to create lists of do's and don'ts
12097 or right and wrong by providing dedicated environments that use a tick
12098 or a cross as the label of the list.
12099 These lists are in fact dedicated variants of the
12104 They do however require that you have the
12108 packages installed.
12111 \begin_layout Subsubsection
12115 \begin_layout Standard
12118 Foil\SpecialChar TeX
12121 redefines the floating tables and figures so that they appear exactly where
12122 they are in the text rather than pushing them to the top of the page or
12123 to some user specified location.
12124 In fact if you change the float placement settings they are simply ignored.
12127 \begin_layout Subsubsection
12128 Page Headers and Footers
12129 \begin_inset CommandInset label
12131 name "sec:foilfoot"
12138 \begin_layout Standard
12142 \begin_inset space ~
12151 are two commands used to control the left-footer text string.
12152 The first is meant to allow you to include a graphic logo on your foils
12154 \begin_inset Quotes eld
12159 Foil\SpecialChar TeX
12163 \begin_inset Quotes erd
12167 While the second is meant to provide a classification for the audience,
12171 \begin_inset space \thinspace{}
12177 \begin_inset space \space{}
12181 It is empty by default.
12184 \begin_layout Standard
12185 The remaining page corners can be filled by
12188 \begin_inset space ~
12193 (which defaults to page numbers),
12196 \begin_inset space ~
12204 \begin_inset space ~
12212 \begin_layout Subsection
12215 Foil\SpecialChar TeX
12219 \begin_inset CommandInset label
12221 name "sec:unsuppfoils"
12228 \begin_layout Standard
12229 All the commands mentioned below need to be set in a
12239 within another environment.
12242 \begin_layout Subsubsection
12246 \begin_layout Standard
12247 All lengths are adjusted using the
12270 should be replaced by the name given to the length you want to change and
12275 is the length value.
12276 All lengths should be specified in units of length such as inches (
12288 ) or relative to some document or font-based length such as
12298 \begin_layout Standard
12299 It's possible to change the spacing between a foilhead and the body of the
12300 foil by adjusting the length specified by
12307 For example, to make
12312 \begin_inset space \space{}
12315 in closer to their bodies put the following in the preamble:
12321 foilheadskip}{-0.5in}
12324 \begin_layout Standard
12325 The spacings around floats can be adjusted by setting these lengths:
12328 \begin_layout Labeling
12329 \labelwidthstring MMMMMMMMMMM
12336 Separation between the text and the top of the float
12339 \begin_layout Labeling
12340 \labelwidthstring MMMMMMMMMMM
12347 Separation between the float and the caption
12350 \begin_layout Labeling
12351 \labelwidthstring MMMMMMMMMMM
12358 Separation between the caption and the following text
12361 \begin_layout Labeling
12362 \labelwidthstring MMMMMMMMMMM
12369 You can make the captions narrower than the surrounding text by adjusting
12371 Best done relative to
12380 \begin_layout Standard
12381 There are also several title page related lengths that you may find useful
12382 if you have a long title or several authors:
12385 \begin_layout Labeling
12386 \labelwidthstring MMMMMMMMMMM
12393 Separation from headers to
12398 \begin_layout Labeling
12399 \labelwidthstring MMMMMMMMMMM
12417 \begin_layout Labeling
12418 \labelwidthstring MMMMMMMMMMM
12432 \begin_layout Labeling
12433 \labelwidthstring MMMMMMMMMMM
12449 \begin_layout Labeling
12450 \labelwidthstring MMMMMMMMMMM
12466 \begin_layout Standard
12467 The last length related command affects all the list environments.
12478 a list environment then all the vertical spacing between the list items
12480 Note that this is a command not a length so it doesn't require
12486 like the stuff mentioned above.
12489 \begin_layout Subsubsection
12490 Headers and Footers
12493 \begin_layout Standard
12506 commands control whether the logo in the
12510 definition appear on a given page.
12517 in the preamble then none of the foils will have the logo on them.
12518 If you don't want the logo on a particular page place the
12524 directly after the foilhead of that page and the
12530 directly after the next foilhead.
12533 \begin_layout Standard
12534 If you decide to use the
12538 page style setting in the
12541 \begin_inset space ~
12546 dialog you should probably add
12556 to your preamble so headers and footers on landscape pages are correctly
12557 placed when rotated.
12558 This is due to some clashes between the page layouts provided by the
12569 \begin_layout Section
12570 Hollywood (Hollywood spec scripts)
12573 \begin_layout Standard
12579 \begin_layout Subsection
12583 \begin_layout Standard
12584 Getting the format of a Hollywood script right is a
12585 \begin_inset Quotes eld
12589 \begin_inset Quotes erd
12592 It is designed to make the readers focus on content and to be easy and
12593 familiar for the actors to read.
12594 Each page of a script should be one minute of film.
12595 Nothing goes in a script that you cannot see or hear on screen.
12596 The courier 12 pt font should be used throughout.
12600 \begin_layout Subsection
12604 \begin_layout Standard
12605 Speakers' lines should NEVER break in mid-sentence.
12606 If a speaker's lines continue over a page break, repeat the
12610 title followed by (Cont'd).
12613 \begin_layout Subsection
12617 \begin_layout Standard
12622 names as labels then cross-reference the label to insert the name.
12623 The cross-reference dialog will show the current cast of characters.
12624 You can use this to insert the speaker name in narratives also.
12627 \begin_layout Subsection
12628 Paper size and Margins
12631 \begin_layout Standard
12632 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12635 \begin_layout Subsection
12639 \begin_layout Standard
12640 The following environments are available.
12641 You can use hollywood.bind to get the bind keys shown at the right.
12644 \begin_layout Itemize
12648 \begin_inset Newline newline
12653 Used where nothing else works.
12657 \begin_layout Itemize
12663 \begin_inset space \hfill{}
12671 \begin_inset Newline newline
12674 Usually followed by something like
12675 \begin_inset Quotes eld
12678 on Sally waking up.
12679 \begin_inset Quotes erd
12685 \begin_layout Itemize
12689 \begin_inset space \hfill{}
12693 \begin_inset Newline newline
12698 Introduces a new INTERIOR camera set-up.
12699 Always followed by DAY or NIGHT, or something similar to define the lighting
12701 Everthing on this line in CAPS.
12704 \begin_layout Itemize
12708 \begin_inset space \hfill{}
12712 \begin_inset Newline newline
12717 Introduces a new EXTERIOR camera set-up.
12718 Everthing on this line in CAPS.
12721 \begin_layout Itemize
12725 \begin_inset space \hfill{}
12729 \begin_inset Newline newline
12734 The character speaking.
12737 \begin_layout Itemize
12741 \begin_inset space \hfill{}
12745 \begin_inset Newline newline
12750 Instructions to the speaker.
12751 The () are automatically inserted.
12754 \begin_layout Itemize
12758 \begin_inset space \hfill{}
12762 \begin_inset Newline newline
12774 \begin_layout Itemize
12778 \begin_inset space \hfill{}
12782 \begin_inset Newline newline
12787 Camera movement instruction.
12789 \begin_inset space \thinspace{}
12793 \begin_inset space \space{}
12799 \begin_layout Itemize
12803 \begin_inset space \hfill{}
12809 \begin_layout Itemize
12813 \begin_inset space \hfill{}
12819 \begin_layout Itemize
12823 \begin_inset space \hfill{}
12829 \begin_layout Itemize
12833 \begin_inset space \hfill{}
12839 \begin_layout Subsection
12843 \begin_layout Itemize
12844 (O.S) — off screen
12847 \begin_layout Itemize
12848 (V.0) — voice over
12851 \begin_layout Itemize
12853 \begin_inset space \thinspace{}
12860 \begin_layout Itemize
12865 \begin_layout Itemize
12866 PAN — camera movement
12869 \begin_layout Itemize
12870 INSERT — cut to close-up of
12873 \begin_layout Section
12877 \begin_layout Standard
12880 Panayotis Papasotiriou
12883 \begin_layout Subsection
12887 \begin_layout Standard
12888 The ijmpc package is a set of macros that facilitates electronic manuscript
12891 International Journal of Modern Physics C
12894 Similarly, the ijmpd package is for creating manuscripts to be submitted
12897 International Journal of Modern Physics D
12900 Both journals are published by World Scientific.
12901 The corresponding document classes are named
12910 These files, together with instructions for the authors, can be downloaded
12912 \begin_inset Flex URL
12915 \begin_layout Plain Layout
12917 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
12923 \begin_inset Flex URL
12926 \begin_layout Plain Layout
12928 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
12934 Both packages are modified versions of the standard
12935 \begin_inset Quotes eld
12939 \begin_inset Quotes erd
12942 package, and they are almost (but not exactly) identical.
12943 Most of their features are supported by \SpecialChar LyX
12945 I have used \SpecialChar LyX
12946 successfully to write articles submitted to both journals
12947 without any problem.
12950 \begin_layout Subsection
12954 \begin_layout Standard
12955 As usual, the easiest way to write a paper is to start with a template.
12958 File\SpecialChar menuseparator
12974 This will give an (almost) empty document that includes the most common
12975 fields found in a manuscript.
12976 Simply overwrite the existing text (including the brackets,
12981 You should keep in mind the following remarks.
12984 \begin_layout Enumerate
12986 won't let you change the font size and the page style of the document,
12987 because such modifications are not allowed by both packages.
12990 \begin_layout Enumerate
12991 The language of the document should not be changed.
12992 Before previewing your paper, be sure that the babel package is not used.
12993 To do this, click on
12996 arg "dialog-show document"
13001 \SpecialChar menuseparator
13005 \begin_inset Quotes eld
13009 \begin_inset Quotes erd
13019 \begin_layout Enumerate
13021 \begin_inset Quotes eld
13025 \begin_inset Quotes erd
13028 style must be used to define keywords.
13031 \begin_layout Enumerate
13032 The ijmpc package provides a style named
13033 \begin_inset Quotes eld
13036 Classification Codes
13037 \begin_inset Quotes erd
13040 , which can be used to define classification codes, such as PACS numbers.
13041 Note that this facility is not supported by the ijmpd package.
13044 \begin_layout Enumerate
13045 Several new environments are available:
13046 \begin_inset Quotes eld
13050 \begin_inset Quotes erd
13054 \begin_inset Quotes eld
13058 \begin_inset Quotes erd
13062 \begin_inset Quotes eld
13066 \begin_inset Quotes erd
13070 \begin_inset Quotes eld
13074 \begin_inset Quotes erd
13078 \begin_inset Quotes eld
13082 \begin_inset Quotes erd
13086 \begin_inset Quotes eld
13090 \begin_inset Quotes erd
13094 \begin_inset Quotes eld
13098 \begin_inset Quotes erd
13102 \begin_inset Quotes eld
13106 \begin_inset Quotes erd
13110 \begin_inset Quotes eld
13114 \begin_inset Quotes erd
13118 \begin_inset Quotes eld
13122 \begin_inset Quotes erd
13126 \begin_inset Quotes eld
13130 \begin_inset Quotes erd
13134 \begin_inset Quotes eld
13138 \begin_inset Quotes erd
13142 \begin_inset Quotes eld
13146 \begin_inset Quotes erd
13150 \begin_inset Quotes eld
13154 \begin_inset Quotes erd
13158 Their use is more or less obvious.
13160 supports all these environments; it will use the proper label, text style,
13161 and numbering scheme for each of them.
13164 \begin_layout Enumerate
13165 Both packages use basic citations; the natbib package should not be used.
13166 In \SpecialChar LyX
13167 , citation references are shown as usual; in the output, citations are
13168 shown as superscripts.
13169 If you want to use a citation as normal text, you should use the
13174 \begin_inset space \thinspace{}
13178 \begin_inset space \space{}
13182 \begin_inset Quotes eld
13186 \begin_inset space \space{}
13196 \begin_inset Quotes erd
13202 \begin_layout Enumerate
13204 \begin_inset Quotes eld
13208 \begin_inset Quotes erd
13211 section in both packages.
13212 To put acknowledgments, just use the
13213 \begin_inset Quotes eld
13217 \begin_inset Quotes erd
13223 \begin_layout Enumerate
13224 Appendices may be added to the paper,
13228 the Acknowledgments and
13234 provides a special environment, called
13235 \begin_inset Quotes eld
13239 \begin_inset Quotes erd
13242 which marks the beginning of the appendices.
13243 This environment should be left blank; it just sends a \SpecialChar LaTeX
13244 command, but nothing
13246 In \SpecialChar LyX
13248 \begin_inset Quotes eld
13252 \begin_inset Quotes erd
13255 is printed with blue letters, as a signal that all sections after that
13256 point are appendices.
13257 To write an appendix, use the
13258 \begin_inset Quotes eld
13262 \begin_inset Quotes erd
13267 will number each appendix with capital letters, as required by both journals.
13269 \begin_inset Quotes eld
13273 \begin_inset Quotes erd
13280 be present before the first appendix; if not, all appendices will be numbered
13281 as normal sections in the output.
13284 \begin_layout Enumerate
13285 The ijmpc and the ijmpd packages use the
13289 command to implement table captions.
13290 As a result, a table created by \SpecialChar LyX
13291 is printed correctly, but its caption
13293 However, you can use some \SpecialChar TeX
13294 code to overcome this problem, so that captions
13295 are printed as expected.
13296 To do so, create a float table as usual, remove the caption, and replace
13297 it with the \SpecialChar TeX
13308 (sic); you must also the \SpecialChar TeX
13313 immediately after the tabular material.
13314 Study the example table included in the template files to see how this
13315 trick is implemented.
13316 Alternatively, If you need table captions, you should implement the whole
13321 file, then include this file to the \SpecialChar LyX
13324 Insert\SpecialChar menuseparator
13325 File\SpecialChar menuseparator
13327 \begin_inset space ~
13333 Details on how to create a table float can be found in the files
13341 , included in the corresponding packages.
13344 \begin_layout Subsection
13345 Preparing a paper for submission
13348 \begin_layout Standard
13349 Before you submit your paper you must export the \SpecialChar LyX
13350 document as a \SpecialChar LaTeX
13353 File\SpecialChar menuseparator
13354 Export\SpecialChar menuseparator
13362 \begin_layout Plain Layout
13363 Actually you have the choice between \SpecialChar LaTeX
13364 (plain) and pdflatex.
13365 If you intend to use pdflatex to prepare the paper, you should use the
13366 pdflatex option so that included graphics are converted to PDF format,
13367 ready for use by pdflatex.
13372 , then make the following changes to the resulting
13379 \begin_layout Enumerate
13380 Remove the comment lines before the
13389 \begin_layout Enumerate
13390 Remove everything between (and including) the
13402 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13406 \begin_layout Standard
13411 file should be saved and processed through \SpecialChar LaTeX
13412 as many times as necessary.
13413 You may also want to check the resulting
13420 \begin_layout Section
13424 \begin_layout Standard
13430 \begin_layout Subsection
13434 \begin_layout Standard
13435 The iopart package provides a document class to create electronic manuscript
13436 submission to the journals published by the Institute of Physics.
13437 Instructions for the authors how to create a paper using the iopart class
13438 can be downloaded together with the iopart package from the site
13439 \begin_inset Flex URL
13442 \begin_layout Plain Layout
13444 ftp://ftp.iop.org/pub/journals/latex2e
13452 \begin_layout Subsection
13456 \begin_layout Standard
13457 The easiest way to write a paper is to start with the template
13461 that is available via
13463 File\SpecialChar menuseparator
13466 The template explains how to use the special text environments.
13467 Here are the most important advices:
13470 \begin_layout Itemize
13471 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13472 no AMS packages are loaded in
13474 Document\SpecialChar menuseparator
13475 Settings\SpecialChar menuseparator
13481 \begin_layout Itemize
13484 The title environment defines the kind of your paper.
13485 So use one of the following environments for the title:
13489 \begin_layout Itemize
13498 \begin_layout Itemize
13507 \begin_layout Itemize
13513 for a Topical review
13516 \begin_layout Itemize
13525 \begin_layout Itemize
13534 \begin_layout Itemize
13540 for a Paper (same as Title)
13543 \begin_layout Itemize
13549 for a Preliminary communication
13552 \begin_layout Itemize
13558 for a Rapid communication
13561 \begin_layout Itemize
13567 for a Letter to the editor
13571 \begin_layout Itemize
13574 All title environments except of
13578 can have an optional short title.
13581 \begin_layout Itemize
13582 There is a general title environment
13586 which is not directly supported by \SpecialChar LyX
13588 This can be used as \SpecialChar TeX
13589 code when your document doesn't fit into one of the
13593 \begin_layout Standard
13594 For more informations like hints for special table and formula formatting,
13595 look at the IOP author guidelines.
13598 \begin_layout Section
13602 \begin_layout Standard
13605 Panayotis Papasotiriou
13608 \begin_layout Subsection
13612 \begin_layout Standard
13613 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13614 that facilitates electronic manuscript submission to the journals they
13616 Most known of them (at least in my domain of interest) are
13618 Astrophysics and Space Science
13624 , but there are many others (see a complete list at
13625 \begin_inset Flex URL
13628 \begin_layout Plain Layout
13630 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13636 The Kluwer package may be downloaded from the site
13637 \begin_inset Flex URL
13640 \begin_layout Plain Layout
13642 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13648 A complete user guide is contained in that package (but it can also be
13649 downloaded separately).
13652 \begin_layout Standard
13654 supports many features of the package but not everything.
13655 However, the \SpecialChar TeX
13656 code needed is reduced to some
13657 \begin_inset Quotes eld
13661 \begin_inset Quotes erd
13664 commands of the package (see
13665 \begin_inset space ~
13669 \begin_inset CommandInset ref
13671 reference "subsec:kluwer_peculiarities"
13676 I have recently used \SpecialChar LyX
13677 to write an article submitted to the
13679 Astrophysics and Space Science
13681 without any problem.
13684 \begin_layout Subsection
13688 \begin_layout Standard
13689 The easiest way to write a paper is to start with the Kluwer template file.
13692 File\SpecialChar menuseparator
13704 This will give an (almost) empty document that includes the most common
13705 fields found in a manuscript and a short description of their use.
13706 As in most templates, simply overwrite the existing text (including the
13711 ) with the correct information.
13714 \begin_layout Subsection
13715 Preparing a paper for submission
13718 \begin_layout Standard
13719 As in the AAS\SpecialChar TeX
13720 package, before you submit your paper to a journal you must
13722 \begin_inset Quotes eld
13726 \begin_inset Quotes erd
13732 \begin_layout Enumerate
13733 Export your paper as a \SpecialChar LaTeX
13735 To do this, click on
13737 File\SpecialChar menuseparator
13738 Export\SpecialChar menuseparator
13746 \begin_layout Enumerate
13751 file with a text editor and make the following changes
13755 \begin_layout Enumerate
13756 remove the comment lines before the
13765 \begin_layout Enumerate
13766 remove everything between (and including) the
13778 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13782 \begin_layout Standard
13791 \begin_layout Enumerate
13796 file through \SpecialChar LaTeX
13797 as many times as necessary (usually up to three).
13800 \begin_layout Enumerate
13806 \begin_inset space \thinspace{}
13810 \begin_inset space \space{}
13817 , and check if everything is OK (it should, if you didn't make any mistake).
13820 \begin_layout Subsection
13821 \begin_inset Quotes eld
13825 \begin_inset Quotes erd
13828 of the Kluwer package
13829 \begin_inset CommandInset label
13831 name "subsec:kluwer_peculiarities"
13838 \begin_layout Standard
13839 The Kluwer package has the following
13840 \begin_inset Quotes eld
13844 \begin_inset Quotes erd
13850 \begin_layout Enumerate
13851 It is possible to write multiple articles in the same \SpecialChar LaTeX
13856 \begin_layout Plain Layout
13857 I can't imagine any good reason to do this.
13863 Each article must be included in the environment
13864 \begin_inset Quotes eld
13868 \begin_inset Quotes erd
13872 Unfortunately, this environment cannot be omitted, even if you write just
13874 Therefore, each article starts with the command
13880 and, obviously, ends with the command
13887 Although this can be implemented in \SpecialChar LyX
13888 , I didn't included it, since it looks
13889 ugly and can confuse the novice user.
13890 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
13893 \begin_inset Quotes eld
13898 \begin_inset Quotes erd
13904 \begin_layout Enumerate
13905 Information given at the beginning of the article (i.
13906 \begin_inset space \thinspace{}
13910 \begin_inset space \space{}
13913 title, subtitle, author, institution, running title, running author, abstract
13914 and keywords) must be included in an environment called
13915 \begin_inset Quotes eld
13919 \begin_inset Quotes erd
13923 This is not implemented in \SpecialChar LyX
13924 , so you must enter title, subtitle etc.
13925 \begin_inset space ~
13928 between two \SpecialChar TeX
13944 \begin_layout Enumerate
13945 According to the user manual, the label of each bibliography item must be
13969 \begin_layout Standard
13974 template takes care of all these
13975 \begin_inset Quotes eld
13979 \begin_inset Quotes erd
13983 If you start a new paper using this template you don't need to do anything
13988 \begin_layout Enumerate
13989 don't delete the \SpecialChar TeX
13990 code included in the template, and
13993 \begin_layout Enumerate
13994 copy the example bibliography item included in the template and modify it
13995 as necessary to enter new bibliography items.
13998 \begin_layout Section
14002 \begin_layout Standard
14008 \begin_layout Subsection
14012 \begin_layout Standard
14013 The \SpecialChar LyX
14016 article (koma-script)
14020 report (koma-script)
14038 correspond to the \SpecialChar LaTeX
14056 \begin_inset space ~
14059 of the Koma-Script family.
14060 They are replacements for the standard document classes
14076 , resp., and fit better to European typography conventions in a number of
14080 \begin_layout Itemize
14081 Standard character size is 11pt in
14083 article (koma-script)
14087 report (koma-script)
14095 letter (koma-script)
14100 \begin_layout Itemize
14101 Headings, labels of the description environment, and a number of elements
14104 letter (koma-script)
14106 document class are set in a bold sans serif font.
14110 \begin_layout Plain Layout
14111 There is a big difference between the bold sans serif old cm fonts and new
14112 ec fonts, especially in the appearance of headings.
14113 In comparison, the ec bold sans serif fonts look a bit thin.
14114 Here the \SpecialChar LaTeX
14123 helps to produce the
14124 \begin_inset Quotes eld
14128 \begin_inset Quotes erd
14131 appearance when using the ec fonts.
14136 The numbering of chapter headings is made in the same way as the numbering
14137 of section headings, that is without the extra line
14138 \begin_inset Quotes eld
14141 Chapter\SpecialChar ldots
14143 \begin_inset Quotes erd
14147 In addition, the appearance of the headings can be modified by using a
14148 number of options (in \SpecialChar LyX
14149 to be entered in the field
14152 \begin_inset space ~
14159 Layout\SpecialChar menuseparator
14166 \begin_layout Itemize
14167 The main means in the Koma-Script document classes to design the type area
14176 (in \SpecialChar LyX
14177 to be entered in the extra class options field in the dialog
14179 Document\SpecialChar menuseparator
14183 They make a clearer modification of page margins possible as do the options
14186 Document\SpecialChar menuseparator
14193 \begin_layout Itemize
14194 The \SpecialChar LaTeX
14195 document classes of the Koma-Script family define a number of additional
14197 Those part of it which makes sense in \SpecialChar LyX
14198 is implemented in corresponding
14202 \begin_layout Standard
14203 Detailed descriptions of the \SpecialChar LaTeX
14204 document classes of the Koma-Script family
14205 can be found in the Koma-Script documentation
14216 \begin_layout Subsection
14217 article (koma-script), report (koma-script), and book (koma-script)
14220 \begin_layout Standard
14221 The document classes
14223 article (koma-script)
14227 report (koma-script)
14237 are implemented in the layout files
14250 They contain all the paragraph types of the corresponding standard document
14263 , resp., partly modified, with the exception of the \SpecialChar LyX
14268 -type, which is replaced by the new
14272 -type having the same functionality.
14277 -Type there is a number of new paragraph types added.
14284 letter (koma-script)
14289 \begin_layout Itemize
14298 : are equivalents to
14306 , resp., additionally inserting an entry in the table of contents.
14315 are not contained in
14317 article (koma-script)
14322 \begin_layout Itemize
14331 : behave exactly as
14339 , resp., additionally clearing running heads.
14344 is not contained in
14346 article (koma-script)
14352 \begin_layout Plain Layout
14365 report (koma-script)
14367 , but since this is identical to
14371 , is has not been implemented in \SpecialChar LyX
14380 \begin_layout Itemize
14385 : generates a heading directly above the following paragraph in the standard
14386 character size without affecting the structure of the document.
14389 \begin_layout Itemize
14398 are special captions which respect the different space settings needed
14399 for captions placed above or below an element (if you follow strict typographic
14400 rules, you might want to place table captions always above the table).
14401 You can also use the class option
14405 , which will switch
14418 You need at least Koma-Script version 2.8q to use this.
14421 \begin_layout Itemize
14426 : can be used to set a bonmot, e.
14427 \begin_inset space \thinspace{}
14431 \begin_inset space \space{}
14434 at the beginning of a chapter.
14435 If you use the optional argument (
14437 Insert\SpecialChar menuseparator
14439 \begin_inset space ~
14444 ), you can insert the dictum's author there.
14445 Dictum and author are separated by a line.
14446 You need at least Koma-Script version 2.8q to use this.
14451 is not contained in
14453 article (koma-script)
14458 \begin_layout Standard
14459 The following types, together with the standard types
14471 , form the title area of the document.
14472 They must be entered ahead of the first
14473 \begin_inset Quotes eld
14477 \begin_inset Quotes erd
14484 \begin_layout Plain Layout
14485 The corresponding \SpecialChar LaTeX
14486 commands must appear before the
14497 When such a type is used more than once, the latter usage overwrites the
14498 former one, that means, for every type only the latest usage is valid.
14499 The order of the different types however has, like
14511 , no effect on the appearance of the produced document.
14514 \begin_layout Itemize
14519 : produces a centered paragraph above the ordinary title (
14531 ) for the subject of the document.
14534 \begin_layout Itemize
14539 : produces a centered paragraph below the ordinary title (
14551 ) for the publishers' name.
14554 \begin_layout Itemize
14561 report (koma-script)
14567 produces a centered paragraph on its own page behind the title page, or
14570 article (koma-script)
14572 produces a centered paragraph below the ordinary title (
14588 ) for a dedication.
14591 \begin_layout Itemize
14596 : produces a left aligned paragraph above the ordinary title (
14612 ) for a document`s head.
14615 \begin_layout Itemize
14620 : produces in a double-sided print in
14622 report (koma-script)
14628 a left-aligned paragraph at the top of the title page`s back or has no
14629 effect in a single-sided print or in
14631 article (koma-script)
14636 \begin_layout Itemize
14641 : produces in a double-sided print in
14643 report (koma-script)
14649 a left-aligned paragraph at the bottom of the title page`s back or has
14650 no effect in a single-sided print or in
14652 article (koma-script)
14657 \begin_layout Itemize
14662 : produces a special
14663 \begin_inset Quotes eld
14667 \begin_inset Quotes erd
14670 page ahead of the actual document containing a paragraph without special
14674 \begin_layout Standard
14675 The layout files for the document classes
14677 article (koma-script)
14681 report (koma-script)
14687 do include the file
14692 This is thought of as a place to define your own types.
14697 in your personal layout directory and edit the file!
14700 \begin_layout Subsection
14701 letter (koma-script)
14704 \begin_layout Description
14705 Note: This section discusses the obsolete
14707 KOMA-Script-Letter (v.
14708 \begin_inset space ~
14713 , which is not even included anymore in recent KOMA releases.
14714 Please refer to the next section for the current KOMA-Script-Letter class
14716 \begin_inset space ~
14722 \begin_layout Standard
14726 letter (koma-script)
14728 is implemented in the layout file
14733 It contains all the paragraph types of the corresponding standard document
14738 , partly modified, with the exception of the \SpecialChar LyX
14752 type, which is replaced by the new
14757 In addition, it contains, in contrast to the standard document class, the
14776 Furthermore, there are a number of new letter specific types.
14779 \begin_layout Standard
14780 The appearance of the letter produced by this document class can be controlled
14781 by a number of \SpecialChar LaTeX
14782 commands, which you can put in the \SpecialChar LaTeX
14787 \begin_layout Plain Layout
14788 For example, the standard appearance of the letter`s heading, consisting
14789 of name and address, is quite self-willed.
14791 \begin_inset Quotes eld
14795 \begin_inset Quotes erd
14798 heading is produced by the following \SpecialChar LaTeX
14799 commands in the preamble:
14802 \begin_layout LyX-Code
14812 \begin_layout LyX-Code
14828 \begin_layout LyX-Code
14838 \begin_layout LyX-Code
14858 A detailed German description of such \SpecialChar LaTeX
14859 commands can be found in the Koma-Script
14865 With it, the letter's author can produce his personal letter layout.
14868 \begin_layout Standard
14877 define the beginning of the letter and must be used in every letter.
14878 To emphasize them in the \SpecialChar LyX
14879 document class, they are marked with the letter
14889 \begin_inset space ~
14892 in the left margin.
14893 It is possible to write any number of letters in one file.
14898 type produces a new letter using the same addressee and a
14902 type produces a new addressee.
14919 are ordinary paragraph types and can also be used several times in one
14920 and the same letter.
14923 \begin_layout Itemize
14928 : produces a paragraph for the addressee and implicitly defines the beginning
14932 \begin_layout Itemize
14937 : produces a paragraph for the form of address and implicitly produces a
14941 \begin_layout Itemize
14946 : produces a paragraph for a close.
14949 \begin_layout Itemize
14954 : produces a paragraph for a postscript.
14957 \begin_layout Itemize
14962 : produces a paragraph for a distribution list.
14965 \begin_layout Itemize
14970 : produces a paragraph for enclosures.
14973 \begin_layout Standard
15014 are input types provided with a label to enter information, which will
15015 be processed by the document class.
15019 \begin_layout Plain Layout
15020 It could be seen as a matter of inconsequence, that the types
15028 described above are not such input types as well.
15029 Because of the special meaning of those types, however, I have implemented
15030 them as ordinary paragraph types with a one letter mark in the left margin.
15031 Moreover, it would affect my feeling of symmetry, if the
15039 type had such a serious different appearance.
15044 The types must be used ahead of the corresponding
15051 \begin_layout Standard
15052 An implementation of these types in a WYSIWYG fashion does not seem to make
15053 sense, because the real appearance of the produced letter does not only
15054 depend on the usage of the particular type, but also on other factors.
15055 For example, a signature entered in the
15059 type will in the standard behavior appear in the produced letter only,
15060 when in the same letter also a
15065 The entered value of the
15069 type will in the standard behavior not appear in the produced letter at
15071 The possibility to design the letter`s heading freely is already indicated
15072 in a footnote above.
15075 \begin_layout Standard
15076 The input types can also be used as empty paragraphs.
15077 This makes sense e.
15078 \begin_inset space \thinspace{}
15082 \begin_inset space \space{}
15094 type is not used at all, in the standard behavior the value of the
15098 type is used as signature, whereas if an empty
15102 type is used, no signature value is defined.
15105 \begin_layout Standard
15106 By using the input types it is possible to write a letter template, containing
15107 filled input types with your personal dates (name, address, etc.) and empty
15108 input types for other dates you want to enter.
15111 \begin_layout Itemize
15116 : sender's name, in the standard behavior appears as a centered paragraph
15117 in small caps in the letter`s heading.
15120 \begin_layout Itemize
15125 : sender's signature, in the standard behavior appears below the
15134 type is used, the value of the
15138 type appears instead.
15141 \begin_layout Itemize
15146 : sender's address, in the standard behavior appears in a centered paragraph
15147 in the letter`s heading below the sender's name.
15150 \begin_layout Itemize
15155 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15166 \begin_layout Itemize
15171 : place of the letter`s making.
15174 \begin_layout Itemize
15179 : date of the letter`s making.
15188 , in the standard behavior, produce the place and the date in a right-aligned
15189 line below the addressee's field.
15194 type is used, neither place nor date appear, independent of the value of
15204 type is used, the date of the letter `s production is used.
15207 \begin_layout Itemize
15212 : sender`s back address, in the standard behavior appears above the addressee's
15213 field in a small sans serif font.
15216 \begin_layout Itemize
15221 : special mail information, in the standard behavior appears underlined
15222 above the addressee's field below the back address.
15225 \begin_layout Itemize
15230 : additional information, in the standard behavior appears on right side
15231 below the addressee`s field.
15234 \begin_layout Itemize
15239 : the letter's title, in the standard behavior appears in a big, bold, sans
15240 serif font above the subject.
15243 \begin_layout Itemize
15248 : the letter's subject, in the standard behavior appears in a bold font
15256 \begin_layout Standard
15277 produce a business letter like line above the
15281 line containing the fields
15282 \begin_inset Quotes eld
15286 \begin_inset Quotes erd
15290 \begin_inset Quotes eld
15294 \begin_inset Quotes erd
15298 \begin_inset Quotes eld
15302 \begin_inset Quotes erd
15306 \begin_inset Quotes eld
15310 \begin_inset Quotes erd
15314 \begin_inset Quotes eld
15318 \begin_inset Quotes erd
15322 \begin_inset Quotes eld
15326 \begin_inset Quotes erd
15330 For the date field, the value of the
15336 \begin_inset Quotes eld
15339 business letter types
15340 \begin_inset Quotes erd
15343 is used, the value of the
15347 type however does not appear, but only the \SpecialChar LaTeX
15355 The ordinary output of place and date in a right-aligned line below the
15356 addressee`s field is suppressed.
15357 The types are implemented as input types provided with a label and must
15358 be used ahead of the corresponding
15365 \begin_layout Itemize
15373 \begin_layout Itemize
15381 \begin_layout Itemize
15389 \begin_layout Itemize
15397 \begin_layout Itemize
15405 \begin_layout Subsection
15406 The new letter class: letter (koma-script v.2)
15409 \begin_layout Standard
15412 Jürgen Spitzmüller
15415 \begin_layout Standard
15416 \begin_inset VSpace medskip
15422 \begin_layout Standard
15424 Koma-Script version 2.8 has introduced a new letter class
15428 which supersedes the now unsupported
15433 It has — on the \SpecialChar LaTeX
15434 side — a completely new interface and is not compatible
15435 with the old class.
15436 Therefore, \SpecialChar LyX
15437 supports both, though it is recommended you use the new class.
15440 \begin_layout Standard
15441 This class covers the same functionality as
15443 letter (koma-script),
15446 The basic items are
15450 (receiver's address, same as
15454 in the old layout),
15467 will start a new letter (i.
15468 \begin_inset space \thinspace{}
15472 \begin_inset space \space{}
15475 you can write several letters per document).
15476 New elements are sender's
15492 and the possibility to use a
15498 Insert\SpecialChar menuseparator
15504 \begin_layout Standard
15505 The biggest improvement is, though, that the letter's layout is configurable
15506 to meet almost any needs.
15507 This can be done via the preamble or with a special style file (Letter
15508 Class Option, extension
15512 ), that will be read in as a class option.
15516 \begin_layout Plain Layout
15517 The KOMA package comes with some default
15522 There is, for instance, a
15526 file that follows german typesetting rules, or a
15530 that provides the default layout of the old
15535 The latter can be loaded with the class option
15541 Layout\SpecialChar menuseparator
15542 Document\SpecialChar menuseparator
15554 template that is included in \SpecialChar LyX
15556 A detailed description is to be found in the Koma-Script documentation
15564 \begin_layout Subsection
15568 \begin_layout Standard
15569 Visualizing the Koma-Script document classes in \SpecialChar LyX
15570 , the \SpecialChar LyX
15571 internals cause some
15575 \begin_layout Itemize
15576 The chapter number of a
15580 type appears on a line of its own above the chapter heading instead of
15581 appearing in the same line ahead of it.
15582 The cause for that is the \SpecialChar LyX
15583 internal behavior for the labeltype
15587 in the layout file.
15590 \begin_layout Itemize
15591 The headings of the types
15599 are only put in the
15600 \begin_inset Quotes eld
15604 \begin_inset Quotes erd
15608 table of contents, but not in the \SpecialChar LyX
15609 table of contents (
15611 Document\SpecialChar menuseparator
15613 \begin_inset space ~
15617 \begin_inset space ~
15625 \begin_layout Itemize
15626 The paragraphs in a
15630 document class appear in a skip separation mode, not indented.
15631 This is the standard behavior, no special \SpecialChar LaTeX
15632 commands are needed for that.
15635 Document\SpecialChar menuseparator
15638 dialog the corresponding radio button indicates
15647 value always has the effect that extra \SpecialChar LaTeX
15648 commands are inserted in the document
15649 to produce the gap, which is not what is wanted in this case.
15652 \begin_layout Section
15656 \begin_layout Standard
15659 Jürgen Spitzmüller
15662 \begin_layout Subsection
15666 \begin_layout Standard
15667 Memoir is a very powerful and constantly evolving class.
15668 It has been designed with regard to fictional and non-fictional literature.
15669 Its aim is to let the user have maximum control over the typesetting of
15671 Memoir is based on the standard book class, but it can also emulate the
15672 article class (see below).
15675 \begin_layout Standard
15676 Peter Wilson, the developer of Memoir, is known as the author of lots of
15677 useful packages in the \SpecialChar LaTeX
15679 Most of them have been merged with Memoir.
15680 Therefore, it is much easier to layout the table of contents, appendices,
15681 chapter designs and such.
15683 , though, does not support all of these goodies natively.
15684 Some of them might be added to forthcoming releases
15688 \begin_layout Plain Layout
15689 You are invited to send suggestions to
15690 \begin_inset Flex URL
15693 \begin_layout Plain Layout
15695 lyx-devel@lists.lyx.org
15705 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15707 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15709 commands (\SpecialChar TeX
15714 \begin_layout Plain Layout
15719 \begin_layout Plain Layout
15729 \begin_inset space ~
15733 \begin_inset CommandInset ref
15735 reference "sec:Inserting-TeX-Code"
15745 In this section, we can only list those features that are natively supported
15746 by \SpecialChar LyX
15748 For detailed descriptions (and for the rest of features) we recommend you
15749 have a look at the detailed manual of the Memoir class
15753 \begin_layout Plain Layout
15758 \begin_layout Plain Layout
15768 \begin_inset Flex URL
15771 \begin_layout Plain Layout
15773 CTAN:/macros/latex/memoir/memman.pdf
15783 , which is not only a user guide for the class, but also both a comprehensive
15784 description on good typesetting and a superb example for good typesetting
15788 \begin_layout Subsection
15789 Basic features and restrictions
15792 \begin_layout Standard
15793 Memoir supports basically all features of the standard book classes.
15794 There are, however, some differences, as follows:
15797 \begin_layout Description
15799 \begin_inset space ~
15802 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15805 \begin_layout Description
15807 \begin_inset space ~
15810 style: The fancy page style is not supported, due to a command clash between
15811 Memoir and the fancyhdr package (they both define a command with the same
15812 name, which confuses \SpecialChar LaTeX
15814 Instead, Memoir comes with a number of its own page styles (see
15816 Document\SpecialChar menuseparator
15817 Settings\SpecialChar menuseparator
15819 \begin_inset space ~
15825 If you want to use these for the chapter pages, you have to use the command
15832 in the main text or in preamble (e.
15833 \begin_inset space \thinspace{}
15837 \begin_inset space \space{}
15844 chapterstyle{companion}
15849 \begin_layout Description
15850 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15851 optional argument in the standard classes.
15852 With this, you can specify an alternative version of the title for the
15853 table of contents and the headers (for instance, if the title is too long).
15854 In \SpecialChar LyX
15855 , you can do this via
15857 Insert\SpecialChar menuseparator
15859 \begin_inset space ~
15864 at the beginning of a chapter/section.
15865 Memoir features a second optional argument and thus separates the table
15866 of contents from the header.
15867 You can define three variants of a title with this: one for the main text,
15868 one for the table of contents, and one for the headers.
15870 makes these available in form of specific
15881 \begin_layout Description
15882 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
15883 of contents, the list of figures and the list of table start a new page
15885 Memoir does not follow this route.
15886 You have to insert a page break yourself, if you want to have one.
15889 \begin_layout Description
15890 Titlepage: For some unknown reason, Memoir uses pagination on the title
15891 page (in the standard classes, title pages are
15892 \begin_inset Quotes eld
15896 \begin_inset Quotes erd
15900 If you want an empty title page, type
15904 aliaspagestyle{title}{empty}
15909 \begin_layout Description
15910 Article: With the class option
15916 Document\SpecialChar menuseparator
15917 Settings\SpecialChar menuseparator
15918 Class Settings\SpecialChar menuseparator
15920 \begin_inset space ~
15925 ), you can emulate article style.
15926 That is, counters (footnotes, figures, tables etc.) will not be reset on
15927 new chapters, chapters don't start a new page (but are—in contrary to
15928 \begin_inset Quotes eld
15932 \begin_inset Quotes erd
15935 article classes—still allowed), parts, though, use their own page, as in
15939 \begin_layout Description
15940 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
15941 font commands, which have been used in the old \SpecialChar LaTeX
15943 \begin_inset space \thinspace{}
15947 \begin_inset space \space{}
15963 It produces an error and stops \SpecialChar LaTeX
15964 whenever such a command appears.
15969 reallows the commands and spits out warnings instead (which does at least
15970 not stop \SpecialChar LaTeX
15972 Since a lot of packages and particularly Bib\SpecialChar TeX
15973 style files are still using
15974 those commands, we have decided to use this option by default.
15977 \begin_layout Subsection
15981 \begin_layout Standard
15982 We will only describe the features supported by \SpecialChar LyX
15983 (which is not much currently).
15984 Please consult the Memoir manual
15988 \begin_layout Plain Layout
15993 \begin_layout Plain Layout
16003 \begin_inset Flex URL
16006 \begin_layout Plain Layout
16008 CTAN:/macros/latex/memoir/memman.pdf
16021 \begin_layout Description
16022 Abstract: You may wonder why an abstract is an extra feature.
16023 Well, it is in book class.
16024 Usually books don't have abstracts.
16025 Memoir, however, has.
16026 You can use it wherever and how often you like.
16029 \begin_layout Description
16030 Chapterprecis: You may know this older typesetting style: The contents of
16031 a chapter are summarized below the title and also in the table of contents
16033 \begin_inset space \thinspace{}
16037 \begin_inset space \space{}
16042 Our hero arrives in Troia; he loses some friends; he finds others
16045 Chapterprecis does exactly this.
16046 It is therefore only sensible below a chapter.
16049 \begin_layout Description
16050 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16051 The epigraph environment provides an elegant way of typesetting such a
16053 The motto itself (text) and its (optional) author (source) are divided
16055 The author (source) can be inserted via
16057 Insert\SpecialChar menuseparator
16064 \begin_layout Description
16065 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16066 complex figurative poems).
16068 can only support a few of them.
16069 One is poemtitle, which is a centered title for poems, which will also
16070 be added to the table of contents (verse is the standard environment for
16072 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16074 because they have to be nested inside regular verse environments, which
16075 is not possible with \SpecialChar LyX
16079 \begin_layout Description
16080 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16083 \begin_layout Section
16084 Article (mwart), book (mwbk) and report (mwrep)
16085 \begin_inset Argument status
16088 \begin_layout Plain Layout
16101 \begin_layout Standard
16107 \begin_layout Standard
16108 The \SpecialChar LyX
16125 correspond to the \SpecialChar LaTeX
16139 They are replacements for the standard document classes
16151 , resp., and fit better to Polish typography conventions in a number of points.
16155 \begin_layout Standard
16159 \begin_layout Itemize
16160 Unnumbered titles (with star, e.
16161 \begin_inset space \thinspace{}
16165 \begin_inset space \space{}
16172 ) are added into table of contents,
16175 \begin_layout Itemize
16176 Additional page styles:
16180 \begin_layout Description
16181 uheadings header with separated lines,
16184 \begin_layout Description
16185 myheadings custom header, contents headers via commands:
16200 \begin_layout Description
16201 myuheadings custom header with separated lines,
16204 \begin_layout Description
16205 outer page number is placed on outer side of page
16209 \begin_layout Itemize
16214 \begin_layout Description
16215 rmheadings serif titles — default,
16218 \begin_layout Description
16219 sfheadings sansserif titles,
16222 \begin_layout Description
16223 authortitle on title page first placed is author next title — default,
16226 \begin_layout Description
16227 titleauthor on title page first placed is title next author,
16230 \begin_layout Description
16231 withmarginpar reserve place on page for margins.
16235 \begin_layout Section
16239 \begin_layout Standard
16244 provides an alternative to the standard
16249 It provides similar functionality, but you might prefer this layout with
16250 sans serif sections, headings, and more.
16253 \begin_layout Section
16254 Rev\SpecialChar TeX
16258 \begin_layout Standard
16264 \begin_layout Standard
16265 \begin_inset VSpace bigskip
16271 \begin_layout Standard
16276 \begin_inset space ~
16281 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16283 \begin_inset Formula $\beta$
16286 release of May, 1999) class.
16289 \begin_layout Standard
16295 textclass, which works with Rev\SpecialChar TeX
16297 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16299 That means that it doesn't interact very well with \SpecialChar LyX
16300 , which requires \SpecialChar LaTeX2e
16302 it has been kludged to work.
16303 Since Rev\SpecialChar TeX
16304 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16309 Rev\SpecialChar TeX
16311 \begin_inset space ~
16316 textclass should also be pretty easy to use.
16319 \begin_layout Standard
16320 These documents are supposed to be used in
16324 to the Rev\SpecialChar TeX
16325 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16327 and assume you'll know what to put in the preamble if necessary.
16330 \begin_layout Subsection
16334 \begin_layout Standard
16335 All you need to do is install Rev\SpecialChar TeX
16336 4, as described in the package's README
16338 The package can be found at The Rev\SpecialChar TeX
16340 \begin_inset Flex URL
16343 \begin_layout Plain Layout
16345 http://publish.aps.org/revtex4/
16351 Install it somewhere that \SpecialChar LaTeX
16353 Test it by trying to \SpecialChar LaTeX
16354 a short Rev\SpecialChar TeX
16355 4 document in some random directory (i.
16356 \begin_inset space \thinspace{}
16360 \begin_inset space \space{}
16363 not the directory where you installed the class file.) Then, if you reconfigure
16365 , it will find the class file and let you use the Rev\SpecialChar TeX
16369 \begin_layout Standard
16370 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16379 \begin_inset space ~
16384 template, found in the templates directory.
16387 \begin_layout Subsection
16391 \begin_layout Standard
16392 Optional arguments to
16399 \begin_inset Quotes eld
16403 \begin_inset Quotes erd
16407 \begin_inset Quotes eld
16411 \begin_inset Quotes erd
16417 \begin_inset space ~
16425 \begin_inset space ~
16431 Remember that in Rev\SpecialChar TeX
16432 , at least one optional argument is required!
16435 \begin_layout Standard
16436 Other preamble matter, like
16443 \begin_inset space ~
16450 \begin_inset space ~
16455 dialog, also as usual.
16458 \begin_layout Subsection
16462 \begin_layout Standard
16463 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16465 For example, the Email layout corresponds to
16472 Note that (at least as of Rev\SpecialChar TeX
16481 layouts are exactly equivalent, so you shouldn't need to use both.
16485 \begin_layout Plain Layout
16486 In case you're curious, both were included so that
16490 would be able to translate both
16510 \begin_layout Subsection
16514 \begin_layout Standard
16515 There are a couple of important unique aspects of Rev\SpecialChar TeX
16516 4 which might cause
16517 bugs that will be even more confusing in \SpecialChar LyX
16521 \begin_layout Standard
16522 In Rev\SpecialChar TeX
16540 The \SpecialChar LyX
16541 equivalent is that there is a separate Thanks layout.
16546 write footnotes in the
16550 layout, or weird things may happen.
16551 See the Rev\SpecialChar TeX
16552 4 documentation for more details.
16555 \begin_layout Standard
16559 \begin_inset space ~
16567 \begin_inset space ~
16576 layouts must be placed
16584 layout and the corresponding
16601 , the \SpecialChar LaTeX
16605 \begin_layout Section
16606 Springer Journals (
16613 \begin_layout Standard
16619 \begin_layout Subsection
16623 \begin_layout Standard
16624 These are the layout files for some of the journal formats used by Springer
16625 Verlag and listed on
16626 \begin_inset Flex URL
16629 \begin_layout Plain Layout
16631 http://www.springer.de/author/tex/help-journals.html
16636 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16638 It is a modular system: the things common to all journals are implemented
16643 , which journal-specific layout files (such as, e.
16644 \begin_inset space \thinspace{}
16648 \begin_inset space \space{}
16655 for Journal of Geodesy) can include.
16658 \begin_layout Standard
16659 This means that implementing support for any other Springer journal on this
16660 list is as simple as writing your own
16668 file following the outline given in
16676 \begin_layout Standard
16677 It is reasonably well tested only for the Journal of Geodesy.
16686 come with the standard \SpecialChar LyX
16688 Install the relevant class file (downloaded from Springer) in a proper
16689 directory, reconfigure \SpecialChar LaTeX
16690 (in the te\SpecialChar TeX
16695 , as root if necessary — doesn't \SpecialChar LyX
16696 take care of this?), reconfigure \SpecialChar LyX
16701 \begin_layout Subsection
16705 \begin_layout Standard
16706 A large number of theorem-like styles —
16718 \begin_layout Standard
16721 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16722 _Title, Author_Running, Institute,
16723 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16726 See the Springer class file documentation for details.
16729 \begin_layout Subsection
16733 \begin_layout Itemize
16745 \begin_layout Itemize
16748 Probability Theory and Related Fields
16754 — Jean-Marc Lasgouttes
16757 \begin_layout Standard
16758 Add your own, it isn't so hard!
16761 \begin_layout Subsection
16765 \begin_layout Standard
16766 These files are partly based on the older
16770 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16772 file from Springer.
16777 layout, are now defunct.
16778 Jean-Marc Lasgouttes helped out big in making me find my way around the
16780 layout file mechanism.
16783 \begin_layout Subsection
16787 \begin_layout Standard
16789 But probably less than in the old hacked-\SpecialChar LaTeX
16797 \begin_layout Section
16800 Sli\SpecialChar TeX
16804 \begin_inset CommandInset label
16813 \begin_layout Standard
16821 \begin_layout Subsection
16825 \begin_layout Standard
16826 This section describes how to use \SpecialChar LyX
16827 to make slides for overhead projectors.
16828 There are two document classes that can do this: the default slides class
16831 Foil\SpecialChar TeX
16835 This section documents the former.
16838 \begin_layout Standard
16839 I'm going to say this again, nice and clear, so that there's no misunderstanding
16843 \begin_layout Standard
16844 \begin_inset VSpace bigskip
16850 \begin_layout Standard
16854 This section documents the class
16855 \begin_inset Quotes eld
16863 \begin_inset Quotes erd
16871 \begin_layout Standard
16872 \begin_inset VSpace bigskip
16878 \begin_layout Standard
16879 If you're looking for the documentation for
16880 \begin_inset Quotes eld
16885 slides (Foil\SpecialChar TeX
16889 \begin_inset Quotes erd
16892 , check out section
16893 \begin_inset space ~
16897 \begin_inset CommandInset ref
16899 reference "sec:foiltex"
16909 \begin_inset Quotes eld
16914 slides (Foil\SpecialChar TeX
16918 \begin_inset Quotes erd
16921 ] is actually somewhat better than the default
16929 \begin_layout Plain Layout
16931 or so I've been told repeatedly by its advocates.
16932 Having never used it, I have no idea if this claim is true or not.
16937 which this section documents.
16940 \begin_layout Standard
16941 This class is the \SpecialChar LaTeX2e
16942 improvement of the old
16944 Sli\SpecialChar TeX
16948 Every \SpecialChar LaTeX2e
16949 distribution includes this class [which I'll just refer to as
16950 \begin_inset Quotes eld
16958 \begin_inset Quotes erd
16961 from now on], so you're bound to have it.
16962 As I noted earlier, there are other classes, such as
16966 , which also produce slides for overhead projectors and do a better job
16968 However, there are some things which
16972 can do which the others can't, such as generate overlays.
16973 Read on to learn more!
16976 \begin_layout Subsection
16978 \begin_inset CommandInset label
16980 name "sec:slidesetup"
16987 \begin_layout Standard
16988 Obviously, to use this document class, you need to select
16989 \begin_inset Quotes eld
16997 \begin_inset Quotes erd
17000 from the class list in the
17002 Document\SpecialChar menuseparator
17006 There are some other special things you should know about this class:
17009 \begin_layout Itemize
17010 Don't bother changing the options
17015 They're not supported by the
17022 \begin_layout Itemize
17026 \begin_inset space ~
17031 behaves a bit differently for this class.
17032 The possible choices and what they do are as follows:
17036 \begin_layout Description
17041 The final output contains page numbers in the lower right corner.
17044 \begin_layout Description
17053 , but also prints out any time markers you've put in.
17054 This is the default.
17057 \begin_layout Description
17062 The final output contains no page numbers, time markers, or alignment markers.
17066 \begin_layout Itemize
17071 class has an extra option:
17077 \begin_inset Quotes eld
17085 \begin_inset Quotes erd
17088 in the extra class options.
17092 \begin_layout Standard
17093 Using this options allows you to add time markers to
17099 \begin_inset space ~
17103 \begin_inset CommandInset ref
17105 reference "sec:slideNote"
17113 \begin_layout Standard
17114 You can also use the template file
17115 \begin_inset Quotes eld
17123 \begin_inset Quotes erd
17126 to automatically set up a document to use the
17132 File\SpecialChar menuseparator
17134 \begin_inset space ~
17138 \begin_inset space ~
17143 to open your new document].
17144 The template file also contains some examples of the special paragraph
17145 environments used by this class.
17146 I'll describe those next.
17149 \begin_layout Subsection
17150 Paragraph Environments
17153 \begin_layout Subsubsection
17154 Supported Environments
17157 \begin_layout Standard
17158 The first thing you'll notice when you start up a new
17162 document is the font size and type: it's the equivalent of the size
17163 \begin_inset Quotes eld
17171 \begin_inset Quotes erd
17177 \begin_inset space ~
17183 This is also what's used in the output.
17185 \begin_inset Quotes eld
17189 \begin_inset Quotes erd
17192 to remind you that this is a slide.
17193 Your final slides will use a larger font; ergo, you'll have less space.
17194 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17197 \begin_layout Standard
17198 The next thing that becomes obvious is the changes to the paragraph environment
17199 pull-down box [at the far-left end of the toolbar].
17200 Most of the paragraph environments you're used to seeing are missing.
17201 There are also five new ones.
17206 class itself only supports certain paragraph environments:
17209 \begin_layout Itemize
17215 \begin_layout Itemize
17221 \begin_layout Itemize
17227 \begin_layout Itemize
17233 \begin_layout Itemize
17239 \begin_layout Itemize
17245 \begin_layout Itemize
17251 \begin_layout Itemize
17257 \begin_layout Itemize
17263 \begin_layout Itemize
17270 \begin_layout Standard
17271 All of the other standard environments, including the section-heading environmen
17272 ts, aren't used in the
17279 \begin_layout Standard
17280 On the other hand, you'll notice the following new environments:
17283 \begin_layout Itemize
17289 \begin_layout Itemize
17295 \begin_layout Itemize
17301 \begin_layout Itemize
17307 \begin_layout Itemize
17313 \begin_layout Standard
17314 These five are kind of quirky, due to a
17315 \begin_inset Quotes eld
17319 \begin_inset Quotes erd
17322 in \SpecialChar LyX
17324 You see, \SpecialChar LyX
17325 doesn't permit you to nest any other paragraph environment into
17326 an empty environment.
17327 Now, that's fine and dandy, but it means that you wouldn't be able to start
17328 a slide with anything except plain text.
17329 To deal with this, I've performed a little
17330 \begin_inset Quotes eld
17335 \begin_inset Quotes erd
17341 \begin_layout Subsubsection
17342 Quirks of the New Environments
17343 \begin_inset CommandInset label
17345 name "sec:slideQuirk"
17352 \begin_layout Standard
17353 All five of the new paragraph environments are somewhat quirky due to inherent
17354 limitiations in the current version of \SpecialChar LyX
17356 As I just mentioned, \SpecialChar LyX
17357 forbids environments that begin with another environment.
17358 To get around this, the
17362 environment isn't a paragraph environment as described in the
17370 \begin_layout Standard
17371 You should consider
17384 \begin_inset Quotes eld
17387 pseudo-environments.
17388 \begin_inset Quotes erd
17391 They look like a section heading or a
17392 \begin_inset Quotes eld
17400 \begin_inset Quotes erd
17403 but really begin a [and, if necessary, end the previous] paragraph environment.
17413 \begin_inset Quotes eld
17417 \begin_inset Quotes erd
17420 These two perform some action.
17423 \begin_layout Standard
17424 A common feature of all five environments,
17444 , is a rather long-ish label.
17445 The text following this label — ordinarily the contents of the paragraph
17446 environment — is utterly irrelevant for
17468 completely ignores it.
17469 In fact, you can leave these five environments completely empty.
17473 \begin_layout Standard
17478 to put any text after the rather long-ish label, you might want to.
17479 This could be a short description of the contents of the
17484 In that case, enter your descriptive comment and hit
17488 as you normally would.
17491 \begin_layout Standard
17492 If, on the other hand, you don't want to enter any descriptive text, you'll
17493 hit another \SpecialChar LyX
17496 , like nature, abhors a vacuum, and will not let you start a new paragraph
17497 environment until you put something in the old one.
17501 \begin_layout Itemize
17502 Start entering the text that will
17530 \begin_layout Itemize
17531 Now move to the beginning of that paragraph.
17535 \begin_layout Itemize
17544 \begin_layout Itemize
17545 Finally, change this new, empty paragraph to a
17569 \begin_layout Standard
17570 Some future version of \SpecialChar LyX
17571 will, hopefully, resolve this quirkiness\SpecialChar ldots
17575 \begin_layout Subsection
17576 Making a Presentation with
17589 \begin_layout Subsubsection
17597 \begin_layout Standard
17598 If you're expecting this section to teach you how to actually make a presentatio
17599 n, you'll be sorely disappointed.
17600 Naturally, I'll describe all of the ways the
17604 class can assist you in preparing the materials for a presentation.
17605 Filling in the contents, however, is up to you.
17610 the \SpecialChar LyX
17614 \begin_layout Standard
17619 environment [in the manner described in section
17620 \begin_inset space ~
17624 \begin_inset CommandInset ref
17626 reference "sec:slideQuirk"
17630 ] tells \SpecialChar LyX
17631 to begin a new slide [duh].
17632 The label for this environment/
17633 \begin_inset Quotes erd
17637 \begin_inset Quotes erd
17641 \begin_inset Quotes eld
17645 \begin_inset Quotes erd
17648 in cool blue, followed by the label,
17649 \begin_inset Quotes eld
17653 \begin_inset Quotes erd
17657 Any text or paragraph environments that follow this one go on the new slide.
17661 \begin_layout Standard
17662 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17664 (this can be specified in the
17669 In fact, you'll want to, once you finish entering the contents of one slide.
17670 If you've entered more text than can physically fit on a slide, the extra
17671 overflows onto a new slide.
17672 I don't recommend doing this, however, since the overflow slide won't have
17673 any page number on it.
17674 Furthermore, it may interfere with any
17678 you've made to accompany the oversized
17685 \begin_layout Standard
17694 environments work the same way as the
17699 They both create an
17700 \begin_inset Quotes eld
17704 \begin_inset Quotes erd
17707 followed by a label [
17708 \begin_inset Quotes eld
17712 \begin_inset Quotes erd
17716 \begin_inset Quotes eld
17720 \begin_inset Quotes erd
17724 The color is a stunning magenta instead of blue, and the
17725 \begin_inset Quotes eld
17729 \begin_inset Quotes erd
17732 will look different, in style and in length.
17733 The label fonts of all three also differ from one another.
17736 \begin_layout Standard
17741 , if the contents of a
17749 exceed the physical size of a slide or sheet of paper, the extra will overflow
17751 Again, you should avoid this.
17752 It defeats the whole purpose of
17763 \begin_layout Subsubsection
17773 \begin_layout Standard
17778 is a slide that sits atop another slide.
17779 Perhaps you wish to discuss a figure on the main
17783 before displaying the text associated with it.
17784 One way to accomplish this is tape a flap of dark paper over the part of
17789 you want to display later.
17790 This method fails, however, if you wish to overlap one graph with another,
17792 You would then have to fumble while speaking to align the two separate,
17797 s to align the two graphs.
17802 environment in both cases makes life much easier.
17805 \begin_layout Standard
17810 receives the page number of its
17811 \begin_inset Quotes eld
17815 \begin_inset Quotes erd
17823 \begin_inset Quotes eld
17831 \begin_inset Quotes erd
17838 \begin_layout Plain Layout
17839 Presumably, mutliple
17844 \begin_inset Quotes eld
17852 \begin_inset Quotes erd
17856 \begin_inset Quotes eld
17864 \begin_inset Quotes erd
17868 \begin_inset Quotes eld
17876 \begin_inset Quotes erd
17880 \begin_inset space ~
17883 appended to the page number of the parent
17893 Clearly, you want the contents of both the
17901 to each fit on a single physical slide! You should probably consider an
17907 \begin_inset Quotes eld
17911 \begin_inset Quotes erd
17919 Indeed, the \SpecialChar LyX
17924 class provides a visual cue for this: the label at the start of an
17928 is shorter than that at the start of a
17933 Lastly, when you generate printable output, you'll find alignment markers
17934 in all four corners of both the
17938 page and its parent
17943 These will assist you in lining up the two physical slides.
17946 \begin_layout Standard
17947 The major problem in overlaying two slides is aligning the contents of the
17948 two transparencies.
17949 How much space should you leave for that graph on the second slide? Worse
17950 still, what if you want a graph and a sentence on second slide, but there
17951 is text on the main transparency that goes in between them? You could try
17952 and insert vertical space of the right size.
17953 The better way is to use
17964 \begin_layout Standard
17965 As their names imply,
17973 are two command-like paragraph environments that make all subsequent text
17974 invisible and visible, respectively.
17976 \begin_inset space ~
17980 \begin_inset CommandInset ref
17982 reference "sec:slideQuirk"
17986 that you don't place anything
17990 these two environments, however.
17995 , it inserts a centered, sky-blue label into the page reading
17996 \begin_inset Quotes eld
17999 <Invisible Text Follows>
18000 \begin_inset Quotes erd
18004 For paragraphs following this label, the parts of the
18012 ; it doesn't matter which] where they would be contain instead blank space.
18016 \begin_layout Standard
18021 , the corresponding centered label is
18022 \begin_inset Quotes eld
18025 <Visible Text Follows>
18026 \begin_inset Quotes erd
18030 Paragraphs following this label behave normally.
18031 Note that the beginning of a new
18043 automatically shuts off an
18048 It's therefore not necessary to use
18059 \begin_layout Standard
18060 By now, it should be obvious how to create overlay transparencies using
18061 the proper combination of
18080 \begin_layout Enumerate
18085 , including everything that will appear on it, whether on the main slide
18093 \begin_layout Enumerate
18094 Before each figure or paragraph that will appear only on the
18103 If necessary, insert a
18107 environment after the
18114 \begin_layout Enumerate
18119 immediately following the
18126 \begin_layout Enumerate
18127 Copy the contents of this
18138 \begin_layout Enumerate
18143 , change all of the
18154 \begin_layout Standard
18156 You've just made an
18163 \begin_layout Standard
18164 There's one problem with the way I've designed the \SpecialChar LyX
18169 class: you can't make text in the middle of a paragraph invisible, nor
18170 make text in the middle of an invisible paragraph visible again.
18171 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18176 \begin_layout Plain Layout
18177 The commands of interest are:
18180 \begin_layout Itemize
18185 invisible \SpecialChar ldots
18189 \begin_layout Itemize
18194 visible \SpecialChar ldots
18198 \begin_layout Plain Layout
18200 and need to be marked as \SpecialChar TeX
18203 \begin_inset Quotes eld
18207 \begin_inset Quotes erd
18210 you wish to change goes in between the brackets [and after the
18223 If you don't know how to mark text as \SpecialChar TeX
18224 , see the appropriate section of
18237 \begin_layout Subsubsection
18247 \begin_inset CommandInset label
18249 name "sec:slideNote"
18256 \begin_layout Standard
18265 is associated with a
18266 \begin_inset Quotes eld
18270 \begin_inset Quotes erd
18278 Here, too, the \SpecialChar LyX
18283 class provides visual cues.
18288 is shorter than that of a
18292 [yet longer than that of an
18296 ] and, like the label of an
18300 is shockingly magenta.
18301 Additionally, the printed
18305 has the page number of its
18306 \begin_inset Quotes eld
18310 \begin_inset Quotes erd
18318 \begin_inset Quotes eld
18326 \begin_inset Quotes erd
18330 \begin_inset Quotes eld
18338 \begin_inset Quotes erd
18342 \begin_inset Quotes eld
18350 \begin_inset Quotes erd
18354 You can have multiple
18358 s associated with a single
18370 , you'll probably want to break up long
18374 s so that they fit on a single sheet of paper.
18377 \begin_layout Standard
18382 is obvious: it contains anything additional you might want to say about
18388 It could also be used as a sheet of reminders for a particular
18393 In the case of the latter, you might want to make use of time markers.
18394 Currently, the \SpecialChar LyX
18400 \begin_inset Quotes eld
18404 \begin_inset Quotes erd
18407 support for time markers, a
18409 Sli\SpecialChar TeX
18413 So, you'll have to resort to using the \SpecialChar LaTeX
18417 \begin_layout Standard
18418 To use time markers, you'll need to specify the extra class option
18419 \begin_inset Quotes eld
18427 \begin_inset Quotes erd
18431 \begin_inset space ~
18435 \begin_inset CommandInset ref
18437 reference "sec:slidesetup"
18442 This option turns on timing marks, which will appear in the lower-left-hand
18448 To set what appears in the time marker, you use the \SpecialChar LaTeX
18450 \begin_inset Quotes eld
18460 \begin_inset Quotes erd
18464 \begin_inset Quotes eld
18474 \begin_inset Quotes erd
18478 The arguments of both commands are time measured in seconds.
18480 \begin_inset Quotes eld
18490 \begin_inset Quotes erd
18493 sets the time marker to a given time.
18495 \begin_inset Quotes eld
18505 \begin_inset Quotes erd
18508 increments the time marker by the specified amount.
18509 Using time markers and
18513 s in this fashion, you can remind yourself how much time to spend on a particula
18521 \begin_layout Standard
18522 There's one last feature to describe.
18523 Clearly, you'd like to print out all of your
18531 s on transparencies while printing all of your
18548 with which it is associated.
18549 What's a person to do?
18552 \begin_layout Standard
18553 Luckily, there are two \SpecialChar LaTeX
18554 commands that allow you to select what to print
18556 Both must be placed into the preamble of your document.
18558 \begin_inset Quotes eld
18570 \begin_inset Quotes erd
18573 will cause the output to contain only the
18582 Correspondingly, the command
18583 \begin_inset Quotes eld
18595 \begin_inset Quotes erd
18598 prevents the output of anything but
18603 I'd advise placing both commands in the preamble and initially comment
18605 You can then preview your entire presentation as you write.
18606 When you're done writing, you can then uncomment one of the two to select
18607 what you want to print.
18608 I like to uncomment
18609 \begin_inset Quotes eld
18621 \begin_inset Quotes erd
18624 , print to a file with
18625 \begin_inset Quotes eld
18633 \begin_inset Quotes erd
18636 in its name, comment it back out, then uncomment
18637 \begin_inset Quotes eld
18649 \begin_inset Quotes erd
18653 \begin_inset Quotes eld
18661 \begin_inset Quotes erd
18665 I can then send either file to a printer, loading transparencies or plain
18666 paper as appropriate.
18669 \begin_layout Standard
18670 You can also provide other arguments to the
18671 \begin_inset Quotes eld
18681 \begin_inset Quotes erd
18685 \begin_inset Quotes eld
18695 \begin_inset Quotes erd
18699 See a good \SpecialChar LaTeX
18703 \begin_layout Subsection
18708 Class Template File
18711 \begin_layout Standard
18712 I have also provided a template file,
18713 \begin_inset Quotes eld
18721 \begin_inset Quotes erd
18729 To use it, begin your new presentation with
18731 File\SpecialChar menuseparator
18733 \begin_inset space ~
18737 \begin_inset space ~
18743 Your new \SpecialChar LyX
18744 presentation file will contain an example
18765 additionally contain an example of the use of
18774 Lastly, the preamble will contain:
18777 \begin_layout LyX-Code
18778 % Uncomment to print out only slides and overlays
18781 \begin_layout LyX-Code
18785 \begin_layout LyX-Code
18791 \begin_inset Newline newline
18797 \begin_layout LyX-Code
18798 % Uncomment to print out only notes
18801 \begin_layout LyX-Code
18805 \begin_layout LyX-Code
18813 \begin_layout Standard
18814 One final thing: I created this class to support the \SpecialChar LaTeX2e
18816 \begin_inset Quotes eld
18821 Sli\SpecialChar TeX
18825 \begin_inset Quotes erd
18828 class, one of the built-in \SpecialChar LaTeX2e
18830 Neither I nor the rest of the \SpecialChar LyX
18831 Team endorse or oppose the use of this built-in
18833 It's here if you want it or need it.
18834 There exist other \SpecialChar LaTeX2e
18835 classes for creating presentations, such as the
18840 \begin_inset space ~
18844 \begin_inset CommandInset ref
18846 reference "sec:foiltex"
18851 \begin_inset Quotes eld
18859 \begin_inset Quotes erd
18862 package [present on some \SpecialChar TeX
18864 The latter is not yet supported under \SpecialChar LyX
18869 \begin_layout Plain Layout
18870 Perhaps you can take on the task\SpecialChar ldots
18876 I know nothing about these other classes.
18877 Try them out to see what sort of alternative they provide.
18880 \begin_layout Chapter
18882 Features needing Extra Software
18885 \begin_layout Section
18886 Checking \SpecialChar TeX
18890 \begin_layout Standard
18896 \begin_layout Subsection
18900 \begin_layout Standard
18909 \begin_layout Plain Layout
18914 is not yet available when you are using the \SpecialChar LaTeX
18915 distribution MiK\SpecialChar TeX
18921 , you'll find in the
18928 \begin_inset space ~
18939 \begin_inset Newline newline
18943 \begin_inset CommandInset href
18945 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
18953 \begin_layout Standard
18956 Chk\SpecialChar TeX
18959 package is a program that was written by
18960 \begin_inset Flex Noun
18963 \begin_layout Plain Layout
18965 \begin_inset space ~
18973 in frustration because some constructs in \SpecialChar LaTeX
18974 are sometimes non-intuitive,
18975 and easy to forget.
18976 The program runs over your \SpecialChar LaTeX
18977 file, checks the integrity of the file, and
18978 flags some common errors.
18979 In other technical words, it is
18983 for \SpecialChar LaTeX
18987 \begin_layout Standard
18988 Well, what is a syntax checker doing in \SpecialChar LyX
18989 which is supposed to produce correct
18991 anyways? The answer is simple: Just as
18995 not only checks the
18999 of C programs, but also does
19003 checks for type-errors,
19005 Chk\SpecialChar TeX
19008 catches some common
19012 errors, in addition to the syntactical ones.
19015 Chk\SpecialChar TeX
19018 is capable of detecting several common errors, such as
19021 \begin_layout Itemize
19022 Ellipsis detection:
19023 \begin_inset Newline newline
19026 Use \SpecialChar ldots
19030 \begin_layout Itemize
19031 No space in front of/after parenthesis:
19032 \begin_inset Newline newline
19038 \begin_layout Itemize
19039 Enforcement of normal space after common abbreviations:
19040 \begin_inset Newline newline
19044 \begin_inset space \thinspace{}
19048 \begin_inset space \space{}
19051 is too wide spacing.
19054 \begin_layout Itemize
19055 Enforcement of end-of-sentence space when the last sentence ends with a
19057 \begin_inset Newline newline
19061 And this is wrong spacing.
19064 \begin_layout Itemize
19065 Space in front of labels and similar commands:
19066 \begin_inset Newline newline
19069 The label should stick right up to the text to avoid falling to a wrong
19072 \begin_inset CommandInset label
19082 \begin_layout Plain Layout
19083 This footnote is in danger of falling off to a wrong page
19088 The label is separated too much.
19091 \begin_layout Itemize
19092 Space in front of references, instead of hard spaces:
19093 \begin_inset Newline newline
19096 If you have bad luck, the text will break right between the referenced text
19097 and reference number, and that's a pity.
19099 \begin_inset CommandInset ref
19101 reference "sec:chktex"
19108 \begin_layout Itemize
19110 \begin_inset Quotes eld
19114 \begin_inset Quotes erd
19118 \begin_inset Formula $\times$
19122 \begin_inset Newline newline
19125 2x2 looks cheap compared to
19126 \begin_inset Formula $2\times2$
19132 \begin_layout Standard
19133 and more \SpecialChar ldots
19134 It is an invaluable tool when you are
19135 \begin_inset Quotes eld
19139 \begin_inset Quotes erd
19142 your document before printing, and you should run it right after the obligatory
19143 spelling check, and before you go fine tuning the typesetting.
19146 \begin_layout Subsection
19150 \begin_layout Standard
19151 If you have the program installed, usage is as simple as choosing
19153 Tools\SpecialChar menuseparator
19155 \begin_inset space ~
19161 This will make \SpecialChar LyX
19162 generate a \SpecialChar LaTeX
19163 file of your document, start
19165 Chk\SpecialChar TeX
19168 to check it, and then make \SpecialChar LyX
19170 \begin_inset Quotes eld
19174 \begin_inset Quotes erd
19177 with the warnings from
19179 Chk\SpecialChar TeX
19182 , if there were any.
19183 The warnings will be placed close to the point of the mistake, and you
19184 can quickly find them by using the
19186 Navigate\SpecialChar menuseparator
19189 menu item, or the shortcut key
19198 Open the error boxes by clicking on them with the mouse, or use the shortcut
19207 bindings, or the corresponding
19216 Read the warning and correct the mistake, if it is a mistake.
19217 If you have trouble understanding what the warning is about, you can safely
19219 Remember that there is a hidden layer between the document on screen and
19220 the technical details in invoking
19222 Chk\SpecialChar TeX
19225 , and this gap can make some warnings seem arcane or just plain silly.
19228 \begin_layout Standard
19229 This document is an excellent testing bed for the feature, and it should
19230 provide quite a few warnings for you to fiddle with.
19231 Since computers are only so smart, expect most of the warnings to be false
19235 \begin_layout Subsection
19236 How to fine tune it
19239 \begin_layout Standard
19240 Sometimes, you'll find that
19242 Chk\SpecialChar TeX
19245 makes more noise than suits your mood.
19246 Then you can choose not to use it, wait until your mood changes, or try
19249 Chk\SpecialChar TeX
19252 to get better along with you.
19255 \begin_layout Standard
19258 Chk\SpecialChar TeX
19265 very configurable and extensible, you should not expect to solve all problems
19268 Chk\SpecialChar TeX
19271 in \SpecialChar LyX
19273 Since \SpecialChar LyX
19274 has to generate a somewhat special \SpecialChar LaTeX
19275 file to be able to match the
19276 line numbers from the
19278 Chk\SpecialChar TeX
19285 \begin_layout Plain Layout
19286 You can inspect the specific output from
19292 Document\SpecialChar menuseparator
19295 \begin_inset space ~
19309 to the internal document structure, some of the warnings will not appear
19311 There are two things you can do about this:
19314 \begin_layout Itemize
19317 Chk\SpecialChar TeX
19320 invocation command line in
19321 \begin_inset Flex Noun
19324 \begin_layout Plain Layout
19325 Tools\SpecialChar menuseparator
19326 Preferences\SpecialChar menuseparator
19327 Output\SpecialChar menuseparator
19328 LaTeX\SpecialChar menuseparator
19336 Chk\SpecialChar TeX
19339 installation configuration file (usually with the file
19344 See below to learn what warnings can be enabled and disabled on the command
19348 \begin_layout Itemize
19349 Export your document as a raw \SpecialChar LaTeX
19352 File\SpecialChar menuseparator
19353 Export\SpecialChar menuseparator
19362 Invoked in this way, it can be a hassle to find the corresponding place
19363 in the document inside \SpecialChar LyX
19364 , but with a little patience, you should be able
19368 \begin_layout Standard
19369 Here follows the warning messages that can be enabled and disabled in
19378 to disable a warning, and
19382 to enable a warning.
19383 The emphasized entries are disabled by default, because the default is
19386 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19391 \begin_layout Standard
19392 Notice that you should only use the options that enable and disable warnings,
19393 because \SpecialChar LyX
19394 relies on some of the other command line parameters to be set
19395 in a specific way to have a chance to communicate with
19402 \begin_layout Enumerate
19406 Command terminated with space.
19409 \begin_layout Enumerate
19412 Non-breaking space (
19413 \begin_inset Quotes eld
19421 \begin_inset Quotes erd
19424 ) should have been used.
19427 \begin_layout Enumerate
19431 You should enclose the previous parenthesis with
19432 \begin_inset Quotes eld
19440 \begin_inset Quotes erd
19446 \begin_layout Enumerate
19449 Italic correction (
19450 \begin_inset Quotes eld
19460 \begin_inset Quotes erd
19463 ) found in non-italic buffer.
19466 \begin_layout Enumerate
19469 Italic correction (
19470 \begin_inset Quotes eld
19480 \begin_inset Quotes erd
19483 ) found more than once.
19486 \begin_layout Enumerate
19490 No italic correction (
19491 \begin_inset Quotes eld
19501 \begin_inset Quotes erd
19507 \begin_layout Enumerate
19511 \begin_inset Quotes eld
19519 \begin_inset Quotes erd
19523 \begin_inset Quotes eld
19531 \begin_inset Quotes erd
19537 \begin_layout Enumerate
19540 Wrong length of dash may have been used.
19543 \begin_layout Enumerate
19547 \begin_inset Quotes eld
19555 \begin_inset Quotes erd
19559 \begin_inset Quotes eld
19567 \begin_inset Quotes erd
19573 \begin_layout Enumerate
19577 \begin_inset Quotes eld
19585 \begin_inset Quotes erd
19591 \begin_layout Enumerate
19595 \begin_inset Quotes eld
19603 \begin_inset Quotes erd
19606 to achieve an ellipsis.
19609 \begin_layout Enumerate
19612 Inter-word spacing (
19613 \begin_inset Quotes eld
19623 \begin_inset Quotes eld
19626 ) should perhaps be used.
19629 \begin_layout Enumerate
19632 Inter-sentence spacing (
19633 \begin_inset Quotes eld
19643 \begin_inset Quotes erd
19646 ) should perhaps be used.
19649 \begin_layout Enumerate
19652 Could not find argument for command.
19655 \begin_layout Enumerate
19659 \begin_inset Quotes eld
19667 \begin_inset Quotes erd
19673 \begin_layout Enumerate
19676 Math mode still on at end of \SpecialChar LaTeX
19680 \begin_layout Enumerate
19684 \begin_inset Quotes eld
19692 \begin_inset Quotes erd
19695 doesn't match the number of
19696 \begin_inset Quotes eld
19704 \begin_inset Quotes erd
19710 \begin_layout Enumerate
19713 You should use either
19716 \begin_inset Quotes eld
19724 \begin_inset Quotes erd
19729 as an alternative to
19730 \begin_inset Quotes eld
19738 \begin_inset Quotes erd
19744 \begin_layout Enumerate
19751 " (ASCII 39) instead of "
19758 \begin_layout Enumerate
19761 User-specified pattern found.
19764 \begin_layout Enumerate
19767 This command might not be intended.
19770 \begin_layout Enumerate
19777 \begin_layout Enumerate
19795 \begin_layout Enumerate
19798 Delete this space to maintain correct page references.
19801 \begin_layout Enumerate
19805 You might wish to put this between a pair of
19806 \begin_inset Quotes eld
19814 \begin_inset Quotes erd
19820 \begin_layout Enumerate
19823 You ought to remove spaces in front of punctuation.
19826 \begin_layout Enumerate
19829 Could not execute \SpecialChar LaTeX
19833 \begin_layout Enumerate
19842 in front of small punctuation.
19845 \begin_layout Enumerate
19853 may look prettier here.
19856 \begin_layout Enumerate
19860 Multiple spaces detected in output.
19863 \begin_layout Enumerate
19866 This text may be ignored.
19869 \begin_layout Enumerate
19875 \begin_inset Quotes eld
19880 to begin quotation, not
19887 \begin_layout Enumerate
19894 to end quotation, not
19897 \begin_inset Quotes eld
19905 \begin_layout Enumerate
19911 \begin_layout Enumerate
19914 You should perhaps use
19915 \begin_inset Quotes eld
19923 \begin_inset Quotes erd
19929 \begin_layout Enumerate
19932 You should put a space in front of/after parenthesis.
19935 \begin_layout Enumerate
19938 You should avoid spaces in front of/after parenthesis.
19941 \begin_layout Enumerate
19945 You should not use punctuation in front of/after quotes.
19948 \begin_layout Enumerate
19951 Double space found.
19954 \begin_layout Enumerate
19957 You should put punctuation outside inner/inside display math mode.
19960 \begin_layout Enumerate
19963 You ought to not use primitive \SpecialChar TeX
19964 in \SpecialChar LaTeX
19968 \begin_layout Enumerate
19971 You should remove spaces in front of
19972 \begin_inset Quotes eld
19980 \begin_inset Quotes erd
19986 \begin_layout Enumerate
19989 \begin_inset Quotes eld
19997 \begin_inset Quotes erd
20000 is normally not followed by
20001 \begin_inset Quotes eld
20009 \begin_inset Quotes erd
20015 \begin_layout Standard
20016 In later versions of \SpecialChar LyX
20017 , we hope to provide a more complete interface to this
20018 tool (and it's smaller cousin
20022 ) to exploit the full power of it.
20023 But it's not exactly useless as it is now: go try it on one of your existing
20024 documents of a certain length and be surprised.
20027 \begin_layout Section
20028 Version Control in \SpecialChar LyX
20032 \begin_layout Standard
20035 Lars Gullik Bjønnes
20042 \begin_layout Subsection
20046 \begin_layout Standard
20048 supports some of the most basic RCS/CVS/SVN/GIT commands.
20049 If you need something a bit more sophisticated you will have to do that
20050 manually in a terminal.
20053 \begin_layout Standard
20054 Also note that CVS support is not as good as subversion support, so we advise
20056 A good place to start learning Subversion is the SVN Book
20060 \begin_layout Plain Layout
20061 \begin_inset CommandInset href
20063 target "http://svnbook.red-bean.com/"
20074 In the case of RCS you should read
20075 \begin_inset Quotes eld
20079 \begin_inset Quotes erd
20082 (a man file, read it with
20087 This file describes all the basic features of RCS.
20088 You should especially notice the comment about a RCS directory, and the
20089 notion of a master RCS file (the file ending in
20096 \begin_layout Standard
20097 Before you begin to use the version control features in \SpecialChar LyX
20099 familiar with RCS/CVS/SVN/GIT usage.
20100 The implementation in \SpecialChar LyX
20101 assumes a recent version of the GNU RCS or CVS/SVN
20102 package — no guarantees are made for older versions.
20103 Most of the log messages are not currently displayed after operations —
20104 you can check them in the Messages pane if you are unsure.
20105 Regular users of version control will appreciate the VC toolbar, which
20108 View\SpecialChar menuseparator
20109 Toolbars\SpecialChar menuseparator
20111 \begin_inset space ~
20119 \begin_layout Standard
20120 For introducing your own external commands consult
20121 \begin_inset Flex Code
20124 \begin_layout Plain Layout
20138 \begin_layout Standard
20139 It is strongly recommended to store documents in uncompressed format if
20140 using version control (uncheck
20142 Document\SpecialChar menuseparator
20145 if it is checked): Uncompressed LyX documents are text files and therefore
20146 for merging two different versions by version control systems.
20147 Compressed LyX documents are binary files, which cannot be merged by version
20151 \begin_layout Subsection
20152 RCS commands in \SpecialChar LyX
20156 \begin_layout Standard
20157 The following sections describe the RCS commands supported by \SpecialChar LyX
20159 You can find them in the
20161 File\SpecialChar menuseparator
20163 \begin_inset space ~
20170 was tested against RCS 5.7/5.8.
20173 \begin_layout Subsubsection
20179 \begin_layout Standard
20180 If your document is not under revision control, this is the only item shown
20182 And if it is under revision control, the
20186 item is not visible.
20190 \begin_layout Standard
20191 This command registers your document with RCS (unless you are under the
20192 directory managed by CVS)\SpecialChar endofsentence
20193 You are asked interactively to supply an initial
20194 description of the document.
20195 The document is now set in Read-Only mode and you have to
20198 \begin_inset space ~
20202 \begin_inset space ~
20206 \begin_inset space ~
20211 , before making any changes to it.
20212 A document under revision control has a
20213 \begin_inset Quotes eld
20216 [RCS:<version> <locker>]
20217 \begin_inset Quotes erd
20220 item tagged to the filename in the minibuffer.
20223 \begin_layout Standard
20224 RCS command that is run:
20227 \begin_layout LyX-Code
20230 ci -q -u -i -t-"<initial description>" <file-name>
20233 \begin_layout Standard
20238 to understand the switches.
20242 \begin_layout Subsubsection
20248 \begin_layout Standard
20249 When you are finished editing a file, you check in your changes.
20250 When you do this, you are asked for a description of the changes.
20251 This is stored in the history log.
20252 The version number is bumped, your changes are applied to the master RCS
20253 file, the document is unlocked and set to Read-Only mode.
20256 \begin_layout Itemize
20259 ci -q -u -m"<description>" <file-name>
20262 \begin_layout Subsubsection
20268 \begin_layout Standard
20269 By doing this you lock the document so that only you can edit it.
20270 This will also make the document Read-Write only for you.
20271 You will usually continue editing for a while and when you are finished
20272 you check in your changes.
20273 The status line is changed to reflect that you have locked the file.
20276 \begin_layout Itemize
20279 co -q -l <file-name>
20282 \begin_layout Subsubsection
20285 Revert To Repository Version
20288 \begin_layout Standard
20289 This will discard all changes made to the document since the last check
20291 You get a warning before changes are discarded.
20294 \begin_layout Itemize
20297 co -f -u<version> <file-name>
20300 \begin_layout Subsubsection
20306 \begin_layout Standard
20307 This will create a copy of the current document.
20308 Since RCS does not support copy operations natively, the version history
20309 is not preserved, and the copy is added as a new file.
20310 It requires a clean document without any changes since the last checkin.
20311 You are asked for a file name and a description of the copy operation.
20312 After that the copy is created, both locally and in the repository.
20313 If the parent directories of the copied and original document differ, all
20314 relative paths of included files of the copy are adjusted (like in
20316 File\SpecialChar menuseparator
20321 Finally, the copy is loaded instead of the original document.
20324 \begin_layout Labeling
20325 \labelwidthstring 00.00.0000
20327 \begin_inset space ~
20331 \begin_inset space ~
20335 \begin_inset Newline newline
20339 \begin_inset Flex Code
20342 \begin_layout Plain Layout
20345 \begin_inset Quotes qld
20349 \begin_inset Quotes qld
20358 \begin_inset Flex Code
20361 \begin_layout Plain Layout
20364 \begin_inset Quotes qld
20368 \begin_inset Quotes qld
20377 \begin_inset Newline newline
20381 \begin_inset Flex Code
20384 \begin_layout Plain Layout
20388 \begin_inset Quotes qld
20392 \begin_inset Quotes qld
20403 \begin_layout Subsubsection
20409 \begin_layout Standard
20410 This makes as if the last check in never happened.
20411 No changes are made to the document loaded into \SpecialChar LyX
20412 , but the last version
20413 is removed from the master RCS file.
20416 \begin_layout Itemize
20419 rcs -o<version> <file-name>
20422 \begin_layout Subsubsection
20428 \begin_layout Standard
20429 This shows the complete history of the RCS document.
20434 is shown in a browser.
20442 \begin_layout Subsubsection
20446 \begin_layout Standard
20448 supports RCS version number, author name, date and time of last commit.
20449 All those are extracted from
20451 rlog -r <file-name>
20455 \begin_inset CommandInset ref
20457 reference "subsec:VCS-Revision-Information"
20464 \begin_layout Subsection
20465 CVS commands in \SpecialChar LyX
20469 \begin_layout Standard
20470 A subset of CVS operations is supported by \SpecialChar LyX
20472 You can find the commands in the
20474 File\SpecialChar menuseparator
20476 \begin_inset space ~
20482 The version control system SVN is more powerful, so please use it instead
20483 of CVS if possible.
20486 \begin_layout Subsubsection
20492 \begin_layout Standard
20493 If you start from scratch with CVS you have to create your repository and
20494 checkout the working copy with external tools.
20495 If you're using a client-server setup you may need to login before doing
20496 the first repository checkout.
20499 \begin_layout Standard
20500 If your documents are under revision control and others are using the same
20501 repository problems arise when different changes to the same document at
20502 the same location happen.
20503 Standard CVS repositories don't operate with a file locking mechanism.
20504 This may be surprising, but conflicts only occur if people disagree on
20505 the proper content of the same part of a document.
20506 So, if co-workers are used to communicate regularly, these conflicts occur
20508 If they don't communicate they have a fundamental problem anyway.
20509 Nevertheless some people like to work with so called
20510 \begin_inset Quotes eld
20514 \begin_inset Quotes erd
20518 If they do so the working copy of all files is readonly when checked out
20519 first and the user starts editing after using a special command to make
20520 the working copy writable.
20521 When the changes are checked in the working copy returns to readonly state.
20522 With \SpecialChar LyX
20523 one has to edit the
20524 \begin_inset Flex Code
20527 \begin_layout Plain Layout
20533 file and add the line
20534 \begin_inset Flex Code
20537 \begin_layout Plain Layout
20543 to work with reserved checkouts.
20544 The benefit is the possibility to see who is using a writable copy of some
20546 It's not guaranteed only one user makes a copy writable.
20549 \begin_layout Standard
20551 tries to guess if you're using reserved or non-reserved checkouts.
20552 If your working copy is readonly or it is writable and an additional copy
20553 of your document exists in the CVS/Base sub-directory a reserved otherwise
20554 a non-reserved checkout is assumed.
20555 When a reserved checkout is detected you have to use
20556 \begin_inset Flex Noun
20559 \begin_layout Plain Layout
20565 to make your working copy writable if it's readonly.
20567 \begin_inset Flex Noun
20570 \begin_layout Plain Layout
20576 operation is possible and that makes your working copy readonly again after
20577 transferring your changes to the repository.
20580 \begin_layout Standard
20581 More information about CVS can be found here
20582 \begin_inset Flex URL
20585 \begin_layout Plain Layout
20587 http://www.nongnu.org/cvs
20593 \begin_inset Flex URL
20596 \begin_layout Plain Layout
20598 http://ximbiot.com/cvs
20606 \begin_layout Standard
20611 to understand the sub-commands and the switches mentioned below.
20614 \begin_layout Subsubsection
20620 \begin_layout Standard
20621 If your document is not under revision control, this is the only item shown
20623 And if it is under revision control, the
20627 item is not visible.
20631 \begin_layout Standard
20632 This command registers in CVS your document
20633 \begin_inset Flex Strong
20636 \begin_layout Plain Layout
20644 in the case you have already the documents directory under CVS control
20650 This means you have to create or checkout the archive by yourself using
20652 (In case you forget that step \SpecialChar LyX
20653 registers the document with RCS.)
20656 \begin_layout Standard
20657 Then you are asked interactively to supply an initial description of the
20659 Don't forget that registered file is not yet checked in.
20662 \begin_layout Standard
20663 CVS command that is run:
20665 cvs -q add -m"<entered message>" "<file-name>"
20668 \begin_layout Standard
20673 above and for all other CVS commands is an abbreviation for
20674 \begin_inset Quotes eld
20677 change the current working directory to file location and use the file name
20678 without path component as argument
20679 \begin_inset Quotes erd
20685 \begin_layout Subsubsection
20691 \begin_layout Standard
20692 When you are finished editing a file, you commit your changes.
20693 When you do this and you had changed the document, you are asked for a
20694 description of the changes.
20695 After that changes are written to the repository.
20696 In case you didn't change the document and a reserved checkout is detected
20697 the reservation made on
20698 \begin_inset Flex Noun
20701 \begin_layout Plain Layout
20710 \begin_layout Labeling
20711 \labelwidthstring 00.00.0000
20713 \begin_inset space ~
20717 \begin_inset space ~
20721 \begin_inset Newline newline
20725 \begin_inset Flex Code
20728 \begin_layout Plain Layout
20731 -q commit -m"<description>" "<file-name>"
20737 \begin_inset Newline newline
20741 \begin_inset Flex Code
20744 \begin_layout Plain Layout
20755 \begin_layout Subsubsection
20761 \begin_layout Standard
20762 When you are sharing a repository with others, you may have to incorporate
20763 their changes into your working copy.
20766 \begin_layout Standard
20769 cvs -q update "<file-name>"
20772 \begin_layout Standard
20773 If a readonly checkout is detected the working copy is made writable and
20777 \begin_layout Standard
20780 cvs -q edit "<file-name>"
20783 \begin_layout Subsubsection
20786 Revert To Repository Version
20789 \begin_layout Standard
20790 This will discard all changes made to the document since the last check
20792 You get a warning before changes are discarded.
20793 Firstly the file is deleted, secondly CVS update command is run.
20796 \begin_layout Standard
20799 cvs -q update "<file-name>"
20802 \begin_layout Standard
20803 If a reserved checkout is detected and the working copy has no changes only
20804 the reservation is undone.
20807 \begin_layout Standard
20810 cvs -q unedit "<file-name>"
20813 \begin_layout Subsubsection
20819 \begin_layout Standard
20820 This will create a copy of the current document.
20821 Since CVS does not support copy operations natively, the version history
20822 is not preserved, and the copy is added as a new file.
20823 It requires a clean document without any changes since the last checkin.
20824 You are asked for a file name and a description of the copy operation.
20825 After that the copy is created, both locally and in the repository.
20826 If the parent directories of the copied and original document differ, all
20827 relative paths of included files of the copy are adjusted (like in
20829 File\SpecialChar menuseparator
20834 Finally, the copy is loaded instead of the original document.
20837 \begin_layout Labeling
20838 \labelwidthstring 00.00.0000
20840 \begin_inset space ~
20844 \begin_inset space ~
20848 \begin_inset Newline newline
20852 \begin_inset Flex Code
20855 \begin_layout Plain Layout
20869 \begin_inset Flex Code
20872 \begin_layout Plain Layout
20886 \begin_inset Newline newline
20890 \begin_inset Flex Code
20893 \begin_layout Plain Layout
20909 \begin_layout Subsubsection
20915 \begin_layout Standard
20916 This will rename the current document.
20917 Since CVS does not support rename operations natively, the version history
20918 is not preserved, the renamed document is added as a new file, and the
20919 original document is deleted.
20920 It requires a clean document without any changes since the last checkin.
20921 You are asked for a file name and a description of the rename operation.
20922 After that the document is renamed, both locally and in the repository.
20923 If the parent directories of the new and old file names differ, all relative
20924 paths of included files are adjusted (like in
20926 File\SpecialChar menuseparator
20931 Finally, the document is reloaded using the new name.
20934 \begin_layout Labeling
20935 \labelwidthstring 00.00.0000
20937 \begin_inset space ~
20941 \begin_inset space ~
20945 \begin_inset Newline newline
20949 \begin_inset Flex Code
20952 \begin_layout Plain Layout
20966 \begin_inset Flex Code
20969 \begin_layout Plain Layout
20983 \begin_inset Newline newline
20987 \begin_inset Flex Code
20990 \begin_layout Plain Layout
21004 \begin_inset Newline newline
21008 \begin_inset Flex Code
21011 \begin_layout Plain Layout
21027 \begin_layout Subsubsection
21028 Update of the local directory checkout from repository
21031 \begin_layout Standard
21032 Once your documents gets more complex, containing sub-documents and pictures,
21034 \begin_inset Flex Code
21037 \begin_layout Plain Layout
21043 files and so on using version control becomes more complicated.
21045 supports updating the whole tree in which resides the document.
21046 This become especially useful once you cooperate with people which neither
21047 have detailed knowledge about CVS usage nor they have ambition to commit
21048 additional material to the repository.
21049 You have to organize the files structure so that all external files are
21050 in the same directory or subdirectories of the document.
21051 It's good practice anyway to store multipart documents in an extra directory.
21054 \begin_layout Standard
21056 \begin_inset Flex Code
21059 \begin_layout Plain Layout
21060 Update local directory from repository
21065 command updates the whole directory.
21066 If local changes are detected user is warned before update starts.
21067 In case of merge conflicts both versions of the conflicting document parts
21068 are placed in the final document.
21069 You have to review and correct the result of the merge.
21070 You'll find the conflicts enclosed in pairs of
21071 \begin_inset Flex Code
21074 \begin_layout Plain Layout
21081 \begin_inset Flex Code
21084 \begin_layout Plain Layout
21091 \begin_inset Flex Code
21094 \begin_layout Plain Layout
21101 The first part is your version as before the update operation with the
21102 document name prepended.
21103 The second one is the repository version with the version number after
21105 \begin_inset Flex Code
21108 \begin_layout Plain Layout
21117 \begin_layout Labeling
21118 \labelwidthstring 00.00.0000
21120 \begin_inset space ~
21124 \begin_inset space ~
21128 \begin_inset Newline newline
21132 \begin_inset Flex Code
21135 \begin_layout Plain Layout
21143 (Ask if changes are detected.)
21144 \begin_inset Newline newline
21148 \begin_inset Flex Code
21151 \begin_layout Plain Layout
21152 cd $path; cvs -q update
21162 \begin_layout Standard
21164 \begin_inset Flex Code
21167 \begin_layout Plain Layout
21173 stands for the path to the document.
21176 \begin_layout Subsubsection
21182 \begin_layout Standard
21183 This shows the complete history of the CVS document.
21186 cvs log "<file-name>"
21188 is shown in a browser.
21191 \begin_layout Subsubsection
21195 \begin_layout Standard
21197 supports CVS version number, author name, date and time of last commit.
21198 All those are extracted from
21200 cvs log -r <file-name>
21204 \begin_inset CommandInset ref
21206 reference "subsec:VCS-Revision-Information"
21213 \begin_layout Subsection
21214 SVN commands in \SpecialChar LyX
21218 \begin_layout Standard
21219 SVN is now partially supported by \SpecialChar LyX
21221 You can find the commands in the
21223 File\SpecialChar menuseparator
21225 \begin_inset space ~
21231 Please note that if you use password protected access to repository via
21232 ssh, you will be asked in terminal window.
21234 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21238 \begin_layout Plain Layout
21239 Most of the commands will work with 1.4 too, see
21240 \begin_inset CommandInset ref
21242 reference "subsec:SVN-Repo-Update"
21247 There seems to be currently unresolved permissions problem under SVN 1.8
21248 with reverting changes when file is locked.
21256 \begin_layout Subsubsection
21262 \begin_layout Standard
21263 If your document is not under revision control, this is the only item shown
21265 And if it is under revision control, the
21269 item is not visible.
21272 \begin_layout Standard
21273 This command registers in SVN your document ONLY in case you have already
21274 the documents directory under SVN control (in particular
21279 This means you have to checkout the archive by yourself.
21282 \begin_layout Standard
21283 Then you are asked interactively to supply an initial description of the
21285 Don't forget that registered file is not yet commited.
21288 \begin_layout Standard
21289 SVN command that is run:
21292 \begin_inset Quotes qld
21296 \begin_inset Quotes qld
21302 \begin_layout Standard
21307 to understand the switches.
21310 \begin_layout Subsubsection
21316 \begin_layout Standard
21317 When you are finished editing a file, you commit your changes.
21318 When you do this, you are asked for a description of the changes.
21319 After that changes are commited.
21322 \begin_layout Standard
21327 \begin_layout Plain Layout
21328 In case locking is not enabled.
21330 \begin_inset CommandInset ref
21332 reference "subsec:SVN-File-Locking"
21343 svn commit -q -m"<description>" <file-name>
21346 \begin_layout Subsubsection
21352 \begin_layout Standard
21353 Updates the changes of this file from the repository.
21354 Be sure you understand SVN merging and conflicts resolving before using
21355 this function, because all conflicts has to be resolved manually by you!
21358 \begin_layout Standard
21363 \begin_layout Plain Layout
21371 svn update --non-interactive
21372 \begin_inset Quotes qld
21376 \begin_inset Quotes qld
21382 \begin_layout Subsubsection
21385 Revert To Repository Version
21388 \begin_layout Standard
21389 This will discard all changes made to the document since the last check
21391 You get a warning before changes are discarded.
21394 \begin_layout Standard
21398 \begin_inset Quotes qld
21402 \begin_inset Quotes qld
21408 \begin_layout Subsubsection
21414 \begin_layout Standard
21415 This will create a copy of the current document including the version history.
21416 It requires a clean document without any changes since the last checkin.
21417 You are asked for a file name and a description of the copy operation.
21418 After that the copy is created, both locally and in the repository.
21419 If the parent directories of the copied and original document differ, all
21420 relative paths of included files of the copy are adjusted (like in
21422 File\SpecialChar menuseparator
21427 Finally, the copy is loaded instead of the original document.
21430 \begin_layout Labeling
21431 \labelwidthstring 00.00.0000
21433 \begin_inset space ~
21437 \begin_inset space ~
21441 \begin_inset Newline newline
21445 \begin_inset Flex Code
21448 \begin_layout Plain Layout
21452 \begin_inset Quotes qld
21456 \begin_inset Quotes qld
21460 \begin_inset Quotes qld
21464 \begin_inset Quotes qld
21473 \begin_inset Newline newline
21477 \begin_inset Flex Code
21480 \begin_layout Plain Layout
21489 \begin_layout Subsubsection
21495 \begin_layout Standard
21496 This will rename the current document including the version history.
21497 It requires a clean document without any changes since the last checkin.
21498 You are asked for a file name and a description of the rename operation.
21499 After that the document is renamed, both locally and in the repository.
21500 If the parent directories of the new and old file names differ, all relative
21501 paths of included files are adjusted (like in
21503 File\SpecialChar menuseparator
21508 Finally, the document is reloaded using the new name.
21511 \begin_layout Labeling
21512 \labelwidthstring 00.00.0000
21514 \begin_inset space ~
21518 \begin_inset space ~
21522 \begin_inset Newline newline
21526 \begin_inset Flex Code
21529 \begin_layout Plain Layout
21533 \begin_inset Quotes qld
21537 \begin_inset Quotes qld
21541 \begin_inset Quotes qld
21545 \begin_inset Quotes qld
21554 \begin_inset Newline newline
21558 \begin_inset Flex Code
21561 \begin_layout Plain Layout
21570 \begin_layout Subsubsection
21571 \begin_inset CommandInset label
21573 name "subsec:SVN-Repo-Update"
21577 Update of the local directory checkout from repository
21581 \begin_layout Plain Layout
21582 Note that this command will work only with subversion
21583 \begin_inset Formula $\geqq1.5$
21594 \begin_layout Standard
21595 All the commands above have one shortcoming – they deal with the current
21597 Once your document contains pictures, includes external
21598 \begin_inset Flex Code
21601 \begin_layout Plain Layout
21607 files and so on administration becomes more complicated.
21609 now supports updating the whole tree in which resides the document
21613 \begin_layout Plain Layout
21614 One need to organize the files structure so that all external files are
21615 in the same directory or subdirectories of the document.
21622 This become especially useful once you cooperate with people which neither
21623 know about subversion management nor they have ambition to commit additional
21624 material to the repository.
21628 \begin_layout Standard
21629 \begin_inset Flex Code
21632 \begin_layout Plain Layout
21633 Update local directory from repository
21638 command updates the whole directory and in case of merge conflicts local
21639 version of the files are left, so no unintended data loss occurs.
21640 If local changes are detected user is warned before update starts.
21643 \begin_layout Labeling
21644 \labelwidthstring 00.00.0000
21646 \begin_inset space ~
21650 \begin_inset space ~
21654 \begin_inset Newline newline
21658 \begin_inset Flex Code
21661 \begin_layout Plain Layout
21667 (Ask if changes are detected.)
21668 \begin_inset Newline newline
21672 \begin_inset Flex Code
21675 \begin_layout Plain Layout
21676 svn update –accept mine-full $path
21684 \begin_layout Standard
21686 \begin_inset Flex Code
21689 \begin_layout Plain Layout
21695 stands for the path to the document.
21698 \begin_layout Subsubsection
21704 \begin_layout Standard
21705 This shows the complete history of the SVN document.
21709 \begin_inset Quotes qld
21713 \begin_inset Quotes qld
21718 is shown in a browser.
21721 \begin_layout Subsubsection
21723 \begin_inset CommandInset label
21725 name "subsec:SVN-File-Locking"
21732 \begin_layout Standard
21733 The file exchange through various revision control systems brings the problem
21734 of merge conflicts in case two different users try to edit the same (parts
21736 When such a conflict happens it needs manual resolving and one reasonable
21737 alternative is to provide some kind of locking mechanism, which guarantees
21738 that only one user is allowed to edit file at the given time.
21741 \begin_layout Standard
21742 SVN has two such mechanisms to provide mutual exclusivity for file access
21743 – locks and automatic setting of write permissions (see sec.
21745 \begin_inset CommandInset ref
21747 reference "subsec:Automatical-Locking-Property"
21752 \begin_inset Flex Code
21755 \begin_layout Plain Layout
21765 \begin_layout Plain Layout
21766 \begin_inset Flex URL
21769 \begin_layout Plain Layout
21771 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21782 If this property is detected for a given document \SpecialChar LyX
21783 starts to use SVN locks
21784 for document editing automatically and the whole check-in/out mechanism
21785 switches to the same regimen as for RCS.
21786 This in particular means there are two different modes of file use in \SpecialChar LyX
21790 \begin_layout Itemize
21792 The loaded file is in the read-only mode.
21793 For editing on needs to check-out.
21798 consists of updating from the repository and gaining write lock.
21799 If the lock is not possible to obtain, we remain in unlocked state.
21802 \begin_layout Itemize
21804 The loaded file is in the
21805 \begin_inset Quotes els
21809 \begin_inset Quotes ers
21813 No other user is allowed to edit the file.
21818 consists of commiting changes and releasing write-lock.
21819 If no changes have been made to the document, no commit will be produced
21823 \begin_layout Plain Layout
21824 Don't be puzzled by the fact that you will be asked for commit message anyway.
21829 and only the write-lock will be released.
21832 \begin_layout Standard
21836 \begin_layout Labeling
21837 \labelwidthstring 00.00.0000
21840 svn commit -q -m"<description>" "<file-name>"
21841 \begin_inset Newline newline
21844 svn unlock "<file-name>"
21847 \begin_layout Labeling
21848 \labelwidthstring 00.00.0000
21851 svn update "<file-name>"
21852 \begin_inset Newline newline
21855 svn lock "<file-name>"
21858 \begin_layout Subsubsection
21861 \begin_inset CommandInset label
21863 name "subsec:Automatical-Locking-Property"
21869 Automatic Locking Property
21872 \begin_layout Standard
21873 The above mentioned automatic setting of write permissions of the .lyx file
21876 File\SpecialChar menuseparator
21878 \begin_inset space ~
21881 Control\SpecialChar menuseparator
21882 Use Locking Property
21885 This command is active only when the file is not locked on the svn server
21887 you need to check-out before proceeding).
21890 \begin_layout Labeling
21891 \labelwidthstring 00.00.0000
21893 \begin_inset space ~
21899 \begin_layout Labeling
21900 \labelwidthstring 00.00.0000
21903 svn propset svn:needs-lock ON "<file-name>"
21906 \begin_layout Labeling
21907 \labelwidthstring 00.00.0000
21910 svn propdel svn:needs-lock "<file-name>"
21913 \begin_layout Subsubsection
21914 \begin_inset CommandInset label
21916 name "subsec:VCS-Revision-Information"
21920 Revision Information in Documents
21923 \begin_layout Standard
21924 There are more possibilities how to activate revision information in our
21928 \begin_layout Itemize
21934 \begin_layout Itemize
21935 tree revision information (
21936 \begin_inset Flex Code
21939 \begin_layout Plain Layout
21946 The result is the output of the
21947 \begin_inset Flex Code
21950 \begin_layout Plain Layout
21956 command, the following table gives you an idea, how to read the results.
21959 \begin_layout Standard
21961 \begin_inset Tabular
21962 <lyxtabular version="3" rows="6" columns="2">
21963 <features tabularvalignment="middle">
21964 <column alignment="left" valignment="top">
21965 <column alignment="left" valignment="top">
21967 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21970 \begin_layout Plain Layout
21978 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21981 \begin_layout Plain Layout
21991 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
21994 \begin_layout Plain Layout
22000 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22003 \begin_layout Plain Layout
22004 mixed revision working copy
22011 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22014 \begin_layout Plain Layout
22020 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22023 \begin_layout Plain Layout
22024 modified working copy
22031 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22034 \begin_layout Plain Layout
22040 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22043 \begin_layout Plain Layout
22044 switched working copy
22051 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22054 \begin_layout Plain Layout
22060 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22063 \begin_layout Plain Layout
22064 partial working copy, from a sparse checkout
22071 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22074 \begin_layout Plain Layout
22080 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22083 \begin_layout Plain Layout
22084 mixed revision, modified, switched working copy
22097 \begin_layout Itemize
22098 file revision information.
22099 The result comes from parsing the output of
22100 \begin_inset Flex Code
22103 \begin_layout Plain Layout
22105 \begin_inset space ~
22109 \begin_inset space ~
22113 \begin_inset space ~
22122 Supported flags are:
22126 \begin_layout Itemize
22127 version number of the last commit (
22128 \begin_inset Flex Code
22131 \begin_layout Plain Layout
22140 \begin_layout Itemize
22141 author of the last commit (
22142 \begin_inset Flex Code
22145 \begin_layout Plain Layout
22154 \begin_layout Itemize
22155 date of the last commit (
22156 \begin_inset Flex Code
22159 \begin_layout Plain Layout
22168 \begin_layout Itemize
22169 time of the last commit (
22170 \begin_inset Flex Code
22173 \begin_layout Plain Layout
22183 \begin_layout Standard
22184 You can obtain this info via InsetInfo (e.g.
22186 \begin_inset Flex Code
22189 \begin_layout Plain Layout
22190 info-insert buffer vcs-date
22196 The information will be available only when you have the file stored under
22197 svn managment (i.e.
22199 \begin_inset Flex Code
22202 \begin_layout Plain Layout
22208 directory is available with your document).
22212 \begin_layout Itemize
22213 Another—a hacking one—possibility is to use svn keywords
22217 \begin_layout Plain Layout
22218 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22224 In short – you set file keywords property (e.g.
22227 svn propset svn:keywords 'Rev' file.lyx
22229 ) and then paste keyword \SpecialChar TeX
22234 \begin_layout Plain Layout
22235 This is an easy way how to ensure that \SpecialChar LyX
22236 won't break the line in the middle
22242 tag in your document (e.g.
22244 \begin_inset Flex Code
22247 \begin_layout Plain Layout
22254 This way svn client will automatically substitute revision number (e.g.
22256 \begin_inset Flex Code
22259 \begin_layout Plain Layout
22265 ) after each update and commit.
22266 There are more problems with this approach.
22267 Firstly, the '$' character is used in \SpecialChar TeX
22268 world for math equations, so any
22269 occurence of math formula
22270 \begin_inset Formula $Rev$
22274 \begin_inset Formula $Rev:59$
22277 in your \SpecialChar LyX
22279 Similarly for other keywords like Id, Date, Author, etc.
22280 Secondly svn output is dependent on your locales, so its very easy that
22281 svn would produce some problematic strings once Date is used.
22282 Thirdly you get the whole 'Rev: 59' string in your document instead of
22284 Until subversion implements user's custom keywords it will be hard to use
22285 this approach reliably or let \SpecialChar LyX
22286 to support it directly.
22289 \begin_layout Subsection
22290 SVN and Windows Environment
22293 \begin_layout Quote
22294 My inclination is to say that if the user cannot figure out the command
22295 line operations on their own fairly quickly, they would be well advised
22296 to use TortoiseSVN.
22302 \begin_layout Subsubsection
22306 \begin_layout Standard
22307 In addition to installing \SpecialChar LyX
22308 , and having access to a Subversion repository,
22309 the user will need to install the Subversion client program.
22310 A Windows installer for the client program is available from
22311 \begin_inset CommandInset href
22314 target "http://www.collab.net/nonav/downloads/subversion/"
22320 The user may also want to install
22321 \begin_inset CommandInset href
22324 target "http://tortoisesvn.tigris.org/"
22329 , which integrates Subversion operations into the context (rightclick) menu
22330 of Windows Explorer.
22331 Operations done outside \SpecialChar LyX
22332 will typically be more convenient using the Explorer
22334 Note that TortoiseSVN is not a replacement for the client program, which
22335 is what \SpecialChar LyX
22339 \begin_layout Subsubsection
22340 Bringing a document under Subversion control
22343 \begin_layout Standard
22344 Before a \SpecialChar LyX
22345 document can be brought under version control in Subversion, its
22346 parent directory needs to be under version control.
22347 If the document is being added to a project already in the repository,
22348 this is accomplished by checking the project out to the directory where
22349 the new document will be placed.
22350 If the project itself is not yet under version control (for instance, if
22351 this document starts a new project), the directory must be imported into
22353 This is done outside \SpecialChar LyX
22355 Both import and checkout are easily accomplished from the Explorer context
22356 menu using TortoiseSVN, or alternatively can be done using the command
22357 line client at a DOS prompt.
22358 The procedure for importing the project using TortoiseSVN is described
22359 below, assuming an existing repository and a new project being started
22367 For information on using the Subversion client program, run
22374 \begin_layout Enumerate
22381 in Windows Explorer, right click it, and select
22383 TortoiseSVN\SpecialChar menuseparator
22387 If necessary, adjust the URL for the repository, then click OK.
22390 \begin_layout Enumerate
22391 Right click the level of the repository under which you want to place the
22392 new project folder (typically the top level) and click
22396 Supply a name for the project folder and click OK.
22397 Add a message for the log file if desired, then click OK again.
22398 The new project folder should appear in the repository.
22399 Finally, click OK again to exit the repository browser.
22402 \begin_layout Enumerate
22403 Once again right click
22409 , this time selecting SVN Checkout\SpecialChar ldots
22410 Select the URL of the project folder
22411 you just created in the repository, and set the checkout directory to
22419 You will be warned about a non-empty folder; click OK to proceed.
22420 You should now have a
22431 \begin_layout Enumerate
22432 Create or open your document in \SpecialChar LyX
22435 File\SpecialChar menuseparator
22437 \begin_inset space ~
22440 Control\SpecialChar menuseparator
22444 Add a log message and click OK to commit the document to version control.
22447 \begin_layout Standard
22448 From this point onward, you should have full functionality in the
22450 File\SpecialChar menuseparator
22452 \begin_inset space ~
22458 You also have the option of checking the document in and out, viewing its
22460 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22461 client program from a command prompt.
22464 \begin_layout Subsubsection
22465 SSH tunnel used with SVN under Windows
22468 \begin_layout Standard
22469 Compared with Linux setting up an svn client to communicate over ssh under
22470 Windows is a rather troublesome task.
22471 We will at least offer some hints how to setup the client side but prior
22472 knowledge about ssh and the Windows command line is needed, also be prepared
22473 for a great deal of frustration\SpecialChar ldots
22477 \begin_layout Enumerate
22478 Get an svn client for windows, as described in the previous sections.
22479 When it is a fresh install run some svn command (e.g.
22481 \begin_inset Flex Code
22484 \begin_layout Plain Layout
22490 ) to create config files, which you will need to change later on.
22493 \begin_layout Enumerate
22494 Choose an ssh client for Windows.
22495 There are several possibilities, we will use the one from Putty tools
22499 \begin_layout Plain Layout
22500 \begin_inset Flex URL
22503 \begin_layout Plain Layout
22505 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22516 You will need to set the connection up so that the client doesn't ask for
22517 any password from you.
22518 To keep things easy we will use only keys without any additional password
22523 \begin_layout Enumerate
22525 \begin_inset Flex Code
22528 \begin_layout Plain Layout
22535 Save your private .ppk key file and put the public one on the server side.
22536 If the SVN server runs on Linux, note that the format of the public key
22537 is not compatible with Linux openssh and you will need to direcly copy-paste
22539 \begin_inset Quotes eld
22544 Public key for pasting into OpenSSH authorized_keys file
22547 \begin_inset Quotes erd
22550 edit field into the server's
22551 \begin_inset Flex Code
22554 \begin_layout Plain Layout
22555 ~/.ssh/authorized_keys
22561 \begin_inset Flex Code
22564 \begin_layout Plain Layout
22573 \begin_layout Enumerate
22575 \begin_inset Flex Code
22578 \begin_layout Plain Layout
22585 In the SVN config file
22589 \begin_layout Plain Layout
22590 Exact path depends on Windows version, usually somewhere around
22591 \begin_inset Flex Code
22594 \begin_layout Plain Layout
22597 Documents and Settings
22611 \begin_inset Flex Code
22614 \begin_layout Plain Layout
22629 , section [tunnels], setup ssh command, e.g.
22631 \begin_inset Flex Code
22634 \begin_layout Plain Layout
22635 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22644 \begin_layout Plain Layout
22645 It will usually take a lot of time to get exact command right and it depends
22647 For example do not have some remote server saved as a default session in
22649 If things fail, try to connect via plink without SVN first.
22658 \begin_layout Enumerate
22659 Checkout the SVN archive, e.
22660 \begin_inset space \thinspace{}
22664 \begin_inset Newline newline
22668 \begin_inset Flex Code
22671 \begin_layout Plain Layout
22672 svn co svn+ssh://user@server/repository_path
22680 \begin_layout Subsubsection
22681 End-of-Line Conversions
22684 \begin_layout Standard
22685 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22687 use different line endings inside the .lyx files.
22688 This is not a problem as far as \SpecialChar LyX
22689 functionality is concerned, but the commit
22690 diffs will be huge and merge-conflicts prone.
22691 Fortunately SVN itself knows
22695 \begin_layout Plain Layout
22696 \begin_inset Flex URL
22699 \begin_layout Plain Layout
22701 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22711 how to deal with CR/LF problems when switching .lyx files to the
22712 \begin_inset Flex Code
22715 \begin_layout Plain Layout
22725 \begin_layout Plain Layout
22727 \begin_inset Flex Code
22730 \begin_layout Plain Layout
22731 svn propset svn:eol-style native FILE_NAME
22744 \begin_layout Subsection
22745 GIT commands in \SpecialChar LyX
22749 \begin_layout Standard
22750 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22752 You can find the commands in the
22754 File\SpecialChar menuseparator
22756 \begin_inset space ~
22762 Please note that if you use password protected access to repository via
22763 ssh, you will be asked in terminal window.
22765 was tested against GIT 1.7.
22769 \begin_layout Plain Layout
22770 Windows users please note that you need to ensure that git is on the path.
22771 This can be set from within \SpecialChar LyX
22774 Tools\SpecialChar menuseparator
22775 Preferences\SpecialChar menuseparator
22776 Paths\SpecialChar menuseparator
22787 \begin_layout Standard
22788 One big difference of GIT and the other supported version control systems
22789 is the distributed nature of GIT: With traditional version control systems
22790 there is one central server which hosts the repository.
22791 Users commit their changes to the server, and get updates made by other
22793 With GIT, users commit to a local repository.
22794 The local repository can be synchronized with one or more remote repositories
22796 \begin_inset Flex Code
22799 \begin_layout Plain Layout
22806 \begin_inset Flex Code
22809 \begin_layout Plain Layout
22817 does not interact in any way with remote GIT repositories.
22818 It works exclusively with the local repository in a very similar way as
22819 with a central CVS or SVN repository.
22820 If you use remote GIT repositories you need to do the
22821 \begin_inset Flex Code
22824 \begin_layout Plain Layout
22831 \begin_inset Flex Code
22834 \begin_layout Plain Layout
22840 operations with your favourite GIT client.
22843 \begin_layout Subsubsection
22849 \begin_layout Standard
22850 If your document is not under revision control, this is the only item shown
22852 And if it is under revision control, the
22856 item is not visible.
22859 \begin_layout Standard
22860 This command registers in GIT your document ONLY in case you have already
22861 the documents directory under GIT control (in particular
22866 This means you have to checkout the archive by yourself.
22869 \begin_layout Standard
22870 Then you are asked interactively to supply an initial description of the
22872 Don't forget that registered file is not yet committed.
22875 \begin_layout Standard
22876 GIT command that is run:
22879 \begin_inset Quotes qld
22883 \begin_inset Quotes qld
22889 \begin_layout Standard
22894 to understand the switches.
22897 \begin_layout Subsubsection
22903 \begin_layout Standard
22904 When you are finished editing a file, you commit your changes.
22905 When you do this, you are asked for a description of the changes.
22906 After that changes are committed.
22909 \begin_layout Standard
22912 git commit -q -m"<description>" <file-name>
22915 \begin_layout Subsubsection
22918 Revert To Repository Version
22921 \begin_layout Standard
22922 This will discard all changes made to the document since the last check
22924 You get a warning before changes are discarded.
22927 \begin_layout Standard
22931 \begin_inset Quotes qld
22935 \begin_inset Quotes qld
22941 \begin_layout Subsubsection
22947 \begin_layout Standard
22948 This will rename the current document including the version history.
22949 It requires a clean document without any changes since the last checkin.
22950 You are asked for a file name and a description of the rename operation.
22951 After that the document is renamed, both locally and in the repository.
22952 If the parent directories of the new and old file names differ, all relative
22953 paths of included files are adjusted (like in
22955 File\SpecialChar menuseparator
22960 Finally, the document is reloaded using the new name.
22963 \begin_layout Labeling
22964 \labelwidthstring 00.00.0000
22966 \begin_inset space ~
22970 \begin_inset space ~
22974 \begin_inset Newline newline
22978 \begin_inset Flex Code
22981 \begin_layout Plain Layout
22985 \begin_inset Quotes qld
22989 \begin_inset Quotes qld
22993 \begin_inset Quotes qld
22997 \begin_inset Quotes qld
23006 \begin_inset Newline newline
23010 \begin_inset Flex Code
23013 \begin_layout Plain Layout
23022 \begin_layout Subsubsection
23028 \begin_layout Standard
23029 This shows the complete history of the GIT document.
23033 \begin_inset Quotes qld
23037 \begin_inset Quotes qld
23042 is shown in a browser.
23045 \begin_layout Subsubsection
23049 \begin_layout Standard
23051 supports GIT hash number of the last commit to the file, author name, date
23052 and time of last commit.
23053 All those are extracted from
23055 git log -n 1 --pretty=format:%H%n%an%n%ai
23058 Tree version information is obtained via
23060 git describe --abbrev --dirty --long
23064 \begin_inset CommandInset ref
23066 reference "subsec:VCS-Revision-Information"
23073 \begin_layout Subsection
23077 \begin_layout Standard
23078 With the recent addition of the
23079 \begin_inset Flex Code
23082 \begin_layout Plain Layout
23088 function \SpecialChar LyX
23089 power users are allowed to create their own commands for revision
23093 \begin_layout Standard
23094 As an example you can see how two TortoiseSVN commands could be integrated
23098 \begin_layout Description
23100 \begin_inset Flex Code
23103 \begin_layout Plain Layout
23104 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23112 \begin_layout Description
23114 \begin_inset Flex Code
23117 \begin_layout Plain Layout
23118 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23126 \begin_layout Subsection
23127 Version control and Document comparison
23130 \begin_layout Standard
23131 One of the typical uses of version control is to inspect the changes between
23132 revisions, usually by creating
23133 \begin_inset Flex Code
23136 \begin_layout Plain Layout
23143 While this is useful for plain text files, it is much less useful in the
23144 case of \SpecialChar LyX
23145 files, which have more a complicated structure.
23146 Hence we provide binding to the Document comparison feature.
23147 There are two ways of calling this feature – either by direct call of
23148 \begin_inset Flex Code
23151 \begin_layout Plain Layout
23158 function (for details see \SpecialChar LyX
23159 functions manual) or by the toolbar icon
23172 One can either compare two chosen revisions of the document or he can simply
23173 compare the current version of edited text with older revisions (where
23175 \begin_inset Flex Noun
23178 \begin_layout Plain Layout
23184 ' revisions back means comparison of the edited file with last commited
23189 \begin_layout Standard
23190 This feature is supported for SVN and RCS though due to the more complicated
23191 versioning scheme of RCS there is a constraint – when addressing the revisions
23192 in dialog, numbers always point to the last number in RCS revision number,
23195 We don't currently support GIT addressing of revisions, one can just compare
23196 edited document with its revision X steps backs, where X is addressed as
23198 \begin_inset Flex Code
23201 \begin_layout Plain Layout
23210 \begin_layout Section
23211 Literate Programming
23214 \begin_layout Standard
23219 (kayvan@sylvan.com)
23223 original documentation written by
23225 Edmar Wienskoski Jr.
23228 (edmar-w-jr@technologist.com)
23231 \begin_layout Subsection
23235 \begin_layout Standard
23236 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23238 programming, where it is assumed that you are familiar with this programming
23239 technique, and know what
23240 \begin_inset Quotes eld
23244 \begin_inset Quotes erd
23248 \begin_inset Quotes eld
23252 \begin_inset Quotes erd
23256 If that is not the case, please follow the web links provided in the following
23258 There is a lot of good documentation out there covering old development
23259 history to the latest tools tips.
23262 \begin_layout Standard
23263 It is also assumed that you are familiar with \SpecialChar LyX
23264 itself to a point that you
23265 are comfortable changing your \SpecialChar LyX
23266 preferences, and X resources file.
23267 If that is not the case please refer to other \SpecialChar LyX
23268 documentation to cover your
23272 \begin_layout Subsection
23273 Literate Programming
23276 \begin_layout Standard
23277 From the Literate Programming FAQ:
23280 \begin_layout Quotation
23281 Literate programming is the combination of documentation and source together
23282 in a fashion suited for reading by human beings.
23283 In fact, literate programs should be enjoyable reading, even inviting!
23284 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23285 and documentation in a single file.
23286 Literate programming tools then parse the file to produce either readable
23287 documentation or compilable source.
23288 The WEB style of literate programming was created by D.
23289 \begin_inset space \thinspace{}
23293 Knuth during the development of his \SpecialChar TeX
23294 typesetting software.
23298 \begin_layout Standard
23299 Another excerpt says:
23302 \begin_layout Quotation
23305 How is literate programming different from verbose commenting?
23308 \begin_layout Quotation
23309 There are three distinguishing characteristics.
23310 In order of importance, they are:
23314 \begin_layout Itemize
23315 flexible order of elaboration
23318 \begin_layout Itemize
23319 automatic support for browsing
23322 \begin_layout Itemize
23323 typeset documentation, especially diagrams and mathematics
23327 \begin_layout Standard
23328 Now that I sparked your curiosity, take a look in the references.
23331 \begin_layout Subsubsection
23335 \begin_layout Standard
23336 The complete Literate Programming FAQ can be found at:
23339 \begin_layout Quote
23340 Literate Programming FAQ
23341 \begin_inset Flex URL
23344 \begin_layout Plain Layout
23346 http://www.literateprogramming.com/lpfaq.pdf
23354 \begin_layout Standard
23355 The FAQ lists 23 (twenty three!) different literate programming tools.
23356 Where some are specialized or
23357 \begin_inset Quotes eld
23361 \begin_inset Quotes erd
23364 for particular programming languages, while other have general scope.
23369 for my own use for several reasons:
23372 \begin_layout Itemize
23373 It can generate the documentation either in \SpecialChar LaTeX
23377 \begin_layout Itemize
23378 It has a open architecture, i.
23379 \begin_inset space \thinspace{}
23383 \begin_inset space \space{}
23386 it is easy to plug in new filters
23390 \begin_layout Plain Layout
23395 are programs that read a given data stream and output a manipulated data
23397 That way, a WEB file (consisting of literate code) can be turned into a
23398 file consisting only of C program code or \SpecialChar LaTeX
23404 and to perform special processing that you may need.
23408 \begin_layout Itemize
23409 There is a good selection of filters available already (the HTML is one
23413 \begin_layout Itemize
23417 \begin_layout Standard
23418 The Noweb web page can be found at:
23421 \begin_layout Quote
23423 \begin_inset Flex URL
23426 \begin_layout Plain Layout
23428 https://www.cs.tufts.edu/~nr/noweb/
23436 \begin_layout Standard
23437 Starting from there you can reach many other interesting links and even
23438 some literate program examples.
23441 \begin_layout Subsection
23443 and Literate Programming with Noweb
23446 \begin_layout Standard
23447 The \SpecialChar LyX
23448 support for Literate Programming is provided by using the generic \SpecialChar LyX
23450 converters mechanism.
23451 This support is provided in a
23452 \begin_inset Quotes eld
23456 \begin_inset Quotes erd
23460 \begin_inset space \thinspace{}
23464 \begin_inset space \space{}
23467 you will be able to use this new \SpecialChar LyX
23468 feature with some other literate programming
23469 tool of your choice by just changing your \SpecialChar LyX
23473 \begin_layout Subsubsection
23474 Generating documents and code (weaving and tangling)
23477 \begin_layout Paragraph
23478 Using the noweb module
23481 \begin_layout Standard
23482 If you have installed Noweb and \SpecialChar LyX
23483 successfully, whenever you open a new document,
23484 after you have chosen its document class, use the
23486 Document\SpecialChar menuseparator
23490 \begin_inset Quotes eld
23494 \begin_inset Quotes erd
23498 If Noweb is correctly installed, when you click on the
23499 \begin_inset Quotes eld
23503 \begin_inset Quotes erd
23506 link, you will see the
23507 \begin_inset Quotes eld
23511 \begin_inset Quotes erd
23514 module in the available list and you can add it to your document.
23517 \begin_layout Paragraph
23521 \begin_layout Standard
23523 enables you to write code with a custom inset named
23524 \begin_inset Flex Noun
23527 \begin_layout Plain Layout
23534 Noweb delimits chunks like this:
23537 \begin_layout LyX-Code
23541 \begin_layout LyX-Code
23545 \begin_layout LyX-Code
23549 \begin_layout LyX-Code
23553 \begin_layout LyX-Code
23557 \begin_layout Standard
23558 The problem is that whatever is written in between the << and the
23562 must be taken literally, i.
23563 \begin_inset space \thinspace{}
23567 \begin_inset space \space{}
23571 should be prevented from making any special interpretation of what has
23573 This is also handled by
23574 \begin_inset Flex Noun
23577 \begin_layout Plain Layout
23583 , that works like a normal text inset but has a free spacing capability.
23586 \begin_layout Standard
23587 As a special note, you can also use the
23588 \begin_inset Quotes eld
23592 \begin_inset Quotes erd
23595 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23599 \begin_layout LyX-Code
23603 \begin_layout LyX-Code
23604 def some_function(args):
23607 \begin_layout LyX-Code
23608 "This is the doc string for this function."
23611 \begin_layout LyX-Code
23612 print "My args: ", args
23615 \begin_layout LyX-Code
23616 @ %def some_function
23619 \begin_layout Standard
23620 For an example of this usage and the resulting cross-reference output, look
23621 at the Literate python program in
23623 LIBDIR/examples/listerrors.lyx
23625 which should make this all clear.
23628 \begin_layout Paragraph
23629 Generating the documentation
23632 \begin_layout Standard
23633 At this point you already have a new document file with a proper document
23634 class, and with some code and text on it.
23635 How do I print it? The answer is simple, you select
23637 View\SpecialChar menuseparator
23641 Just like you would do for a plain document.
23642 No special procedure is required.
23645 \begin_layout Standard
23646 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23650 \begin_layout Enumerate
23653 Update\SpecialChar menuseparator
23656 menu option is chosen, a \SpecialChar LaTeX
23662 \begin_layout Standard
23663 If the document is of any literate class the generated file will be named
23664 with an extension name defined by the
23665 \begin_inset Quotes eld
23669 \begin_inset Quotes erd
23672 format (defined in the Preferences panel), otherwise the file will have
23681 \begin_layout Enumerate
23682 Note that the only difference so far is in the name of the file, no special
23683 processing is required by \SpecialChar LyX
23685 Given that you formatted the code using the
23686 \begin_inset Flex Noun
23689 \begin_layout Plain Layout
23695 inset that, by itself, takes care of the business.
23698 \begin_layout Enumerate
23699 If the document is of any literate class \SpecialChar LyX
23700 will then use the internal \SpecialChar LyX
23702 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23707 \begin_layout Plain Layout
23708 The converters are defined in the
23710 Tools\SpecialChar menuseparator
23714 \begin_inset Quotes eld
23718 \begin_inset Quotes erd
23730 manual for general information about converters.
23735 to generate the \SpecialChar LaTeX
23740 \begin_layout Standard
23741 Otherwise it will just skip this step.
23745 \begin_layout Enumerate
23746 Finally, \SpecialChar LaTeX
23747 is invoked and the regular post processing continues as in a plain
23751 \begin_layout Standard
23752 Independence from a particular
23753 \begin_inset Quotes eld
23757 \begin_inset Quotes erd
23760 is easily achieved by changing the commands that are run by the various
23764 \begin_layout Paragraph
23765 Generating the code
23768 \begin_layout Standard
23769 When the build menu option is chosen or the corresponding button in the
23770 toolbar is pressed, a \SpecialChar LaTeX
23771 file is generated just like step 1 above.
23772 Next, \SpecialChar LyX
23778 This converter needs to be defined by the user and is not installed by
23779 default, though the Program format is.
23780 This converter (like any other converter) will have two parts:
23783 \begin_layout Enumerate
23784 The converter program itself.
23785 This program performs the conversion from the one format to the other (in
23786 this case, from the Noweb format to the Program pseudo-format).
23789 \begin_layout Enumerate
23790 The error log parser.
23791 This is a program whose sole purpose is to rewrite error messages in a
23792 format that \SpecialChar LyX
23794 This makes it possible for \SpecialChar LyX
23795 to place error boxes in the right places in
23799 \begin_layout Standard
23800 The first part, the
23801 \begin_inset Quotes eld
23805 \begin_inset Quotes erd
23808 setting, should be set to
23811 \begin_layout LyX-Code
23819 \begin_layout Standard
23820 This basically means that \SpecialChar LyX
23822 \begin_inset Quotes eld
23826 \begin_inset Quotes erd
23829 (a program or script) with the name of the Noweb file (normally a file
23830 in the \SpecialChar LyX
23831 temp directory) and the directory path of the original \SpecialChar LyX
23836 \begin_layout Standard
23837 This is an implementation of
23838 \begin_inset Quotes eld
23842 \begin_inset Quotes erd
23845 that you can place in a directory on your path:
23848 \begin_layout LyX-Code
23854 \begin_layout LyX-Code
23860 \begin_layout LyX-Code
23863 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23866 \begin_layout Standard
23867 The next part of the converter setting is the
23868 \begin_inset Quotes eld
23872 \begin_inset Quotes erd
23875 which is to be set to
23878 \begin_layout LyX-Code
23881 parselog=$$s/scripts/listerrors
23884 \begin_layout Standard
23885 This will run any errors that are generated by the
23886 \begin_inset Quotes eld
23890 \begin_inset Quotes erd
23893 process through the
23894 \begin_inset Quotes eld
23898 \begin_inset Quotes erd
23904 \begin_layout Standard
23905 The build will normally take place in \SpecialChar LyX
23906 's temporary directory, so the files
23907 produced by the conversion will be in that directory.
23909 will copy out what it regards as the `main' file, but the
23913 conversion may produce several files, and so most of these would then be
23914 deleted when \SpecialChar LyX
23916 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
23917 the build-script chunk can place the generated files in that location.
23920 \begin_layout Paragraph
23921 Build instructions in the document
23924 \begin_layout Standard
23925 The last piece of the integration between \SpecialChar LyX
23927 \begin_inset Quotes eld
23931 \begin_inset Quotes erd
23935 Generally, the instructions for building your program should be embedded
23936 in a chunk of its own.
23938 \begin_inset Quotes eld
23942 \begin_inset Quotes erd
23945 above uses the notangle command to look for this chunk (called
23946 \begin_inset Quotes eld
23950 \begin_inset Quotes erd
23953 ) and runs its contents through
23954 \begin_inset Quotes eld
23958 \begin_inset Quotes erd
23964 \begin_layout Standard
23965 Typically, such a chunk would look something like this:
23968 \begin_layout LyX-Code
23972 \begin_layout LyX-Code
23974 \begin_inset Newline newline
23977 if [ -z "${NOWEB_SOURCE}" ]
23978 \begin_inset Newline newline
23984 \begin_layout LyX-Code
23985 NOWEB_SOURCE=myfile.nw
23986 \begin_inset Newline newline
23990 \begin_inset Newline newline
23994 code to extract files ...
23995 use NOWEB_OUTPUT_DIR here ...]
23996 \begin_inset Newline newline
24000 code to compile files ...]
24001 \begin_inset Newline newline
24007 \begin_layout Standard
24010 LIBDIR/examples/listerrors.lyx
24014 LIBDIR/examples/Literate.lyx
24016 which implement two versions of the
24017 \begin_inset Quotes eld
24021 \begin_inset Quotes erd
24024 program for some illustrations of how all of these pieces go together or
24027 LIBDIR/examples/noweb2lyx.lyx.
24030 Interestingly, these three files show off the language-indepence of the
24032 literate programming support since they are written in Python, C and Perl
24036 \begin_layout Subsubsection
24037 Configuring \SpecialChar LyX
24041 \begin_layout Standard
24042 All the Literate Programming support is configured by the
24044 Tools\SpecialChar menuseparator
24048 \begin_inset Quotes eld
24052 \begin_inset Quotes erd
24056 The important parts are:
24059 \begin_layout Description
24061 \begin_inset space ~
24065 \begin_inset Quotes eld
24069 \begin_inset Quotes erd
24073 \begin_inset space ~
24076 format Set up via the File Formats tab, this is where the Noweb-specific
24086 , the file extension is set to
24091 This tells \SpecialChar LyX
24092 to create a file with a
24096 extension in the first step of the conversion process.
24099 \begin_layout Description
24101 \begin_inset space ~
24109 \begin_inset space ~
24112 format This is an empty format whose sole purpose is to be the endpoint
24113 of a conversion (which then allows us to set up a converter for it).
24116 \begin_layout Description
24126 This converter performs the
24127 \begin_inset Quotes eld
24131 \begin_inset Quotes erd
24134 of the literate document.
24135 For Noweb, it is set to
24136 \begin_inset Quotes eld
24141 noweave -delay -index $$i > $$o
24144 \begin_inset Quotes erd
24150 \begin_layout Description
24160 \begin_inset Quotes eld
24164 \begin_inset Quotes erd
24168 As stated above, the Converter is set to
24169 \begin_inset Quotes eld
24177 \begin_inset Quotes erd
24180 , with Flags set to
24181 \begin_inset Newline newline
24185 \begin_inset Quotes eld
24190 parselog=$$s/scripts/listerrors
24193 \begin_inset Quotes erd
24199 \begin_layout Subsubsection
24203 \begin_layout Standard
24204 There is also a new function implemented in the \SpecialChar LyX
24206 \begin_inset Quotes eld
24209 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24213 \begin_layout Standard
24214 When debugging code with ddd/gdb, it is possible to invoke a text editor
24215 at the current execution position with a single key stroke.
24216 The default ddd configuration for that is shift-ctrl-V.
24217 It happens that you can define the editor command line invocation in ddd
24220 Edit\SpecialChar menuseparator
24221 Preferences\SpecialChar menuseparator
24224 dialog and changing the "Edit Sources" entry.
24227 \begin_layout Standard
24228 I take advantage of the newly created \SpecialChar LyX
24229 server function and this ddd feature,
24231 \begin_inset Quotes eld
24235 \begin_inset Quotes erd
24241 \begin_layout LyX-Code
24242 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24245 \begin_layout Standard
24246 With this, whenever you are using ddd and find a point in the program that
24247 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24248 ddd will forward this information to \SpecialChar LyX
24249 through the \SpecialChar LyX
24250 server and then the
24252 window will show the same file with the cursor at the same position ddd
24254 No more guessing or long scrolling to locate a point in the program back
24258 \begin_layout Standard
24259 Note however that you must enable the \SpecialChar LyX
24260 server to get this feature working
24261 (it is disabled by default).
24263 \begin_inset space ~
24267 \begin_inset CommandInset ref
24269 reference "sec:Starting-the-Server"
24273 explains how to do that.
24276 \begin_layout Subsubsection
24280 \begin_layout Standard
24281 There are six new buttons that can be added to your \SpecialChar LyX
24283 Four of these buttons are short cuts to layout styles:
24301 , one for the custom inset
24306 The last one is a short cut to the
24307 \begin_inset Quotes eld
24311 \begin_inset Quotes erd
24318 \begin_layout Standard
24320 has a range of buttons that are available for tool bar customization.
24321 In my toolbar I like to combine the six short cuts above with two more:
24326 \SpecialChar menuseparator
24331 \SpecialChar menuseparator
24338 Document\SpecialChar menuseparator
24339 View\SpecialChar menuseparator
24343 Here is how it looks like:
24346 \begin_layout LyX-Code
24350 \begin_layout LyX-Code
24354 \begin_layout LyX-Code
24355 Icon "layout Standard"
24358 \begin_layout LyX-Code
24359 Icon "layout Section"
24362 \begin_layout LyX-Code
24363 Icon "layout \SpecialChar LaTeX
24367 \begin_layout LyX-Code
24368 Icon "layout \SpecialChar LyX
24372 \begin_layout LyX-Code
24373 Icon "flex.insert Chunk"
24376 \begin_layout LyX-Code
24380 \begin_layout LyX-Code
24384 \begin_layout LyX-Code
24385 Icon "buffer-typeset"
24388 \begin_layout LyX-Code
24389 Icon "build-program"
24392 \begin_layout LyX-Code
24396 \begin_layout LyX-Code
24400 \begin_layout LyX-Code
24404 \begin_layout LyX-Code
24408 \begin_layout LyX-Code
24412 \begin_layout Subsubsection
24413 Colors customization
24416 \begin_layout Standard
24417 There are a number of colors in \SpecialChar LyX
24418 that can be customized in
24423 One of the things that bothers people is the \SpecialChar LaTeX
24425 The default color is red, since the chunks uses \SpecialChar LaTeX
24426 font, and there is a lot
24427 of chunks in literate documents, you may get tired of seeing everything
24429 You can change it by going to the tabs
24438 \begin_layout Standard
24439 The next thing is the visible presence of the newline character in the screen.
24440 You can choose the color of this particular character and make it blend
24442 I recommend you choosing a color that is close to the background but not
24443 equal, that way you still can see it is there, but it is not bothering
24447 \begin_layout Subsection
24452 \begin_layout Standard
24461 is documented in the
24465 example file and in the Sweave manual (menu
24467 Help\SpecialChar menuseparator
24473 \begin_layout Chapter
24477 \begin_layout Standard
24478 You can do everything with \SpecialChar LyX
24479 that you can do with \SpecialChar LaTeX
24481 However, \SpecialChar LyX
24482 cannot support every \SpecialChar LaTeX
24484 But you can always use \SpecialChar TeX
24486 This chapter shows you some more special things you might want to use.
24487 For other special things you can do with figures, tables, floats, boxes
24488 and notes, have a look at the
24491 \begin_inset space ~
24499 \begin_layout Section
24500 Multiple Text Columns
24503 \begin_layout Standard
24504 This feature is independent of the option
24506 Two-column document
24508 in the document settings under
24513 If you want to have 2
24514 \begin_inset space ~
24517 columns for the whole document, it is recommended to use the
24519 Two-column document
24522 For all other cases use this feature.
24525 \begin_layout Standard
24526 To use multiple text columns in your document, you have to load the module
24533 Document\SpecialChar menuseparator
24534 Settings\SpecialChar menuseparator
24537 ) and must have the \SpecialChar LaTeX
24539 \begin_inset Flex Code
24542 \begin_layout Plain Layout
24551 \begin_layout Standard
24552 Footnotes within multiple columns will be placed at the bottom of the page
24553 and not under each column.
24554 Within the different columns you can use everything, with the limitation
24555 that for floats you need to use the float option
24562 \begin_layout Subsection
24566 \begin_layout Standard
24567 If you want to have 2
24568 \begin_inset space ~
24571 columns in your text, insert a multicolumn inset via the menu
24573 Insert\SpecialChar menuseparator
24575 \begin_inset space ~
24578 Insets\SpecialChar menuseparator
24580 \begin_inset space ~
24585 where the columns should start.
24586 Write all text that should be printed in 2
24587 \begin_inset space ~
24590 columns into this inset.
24593 \begin_layout Standard
24594 Here is an example:
24597 \begin_layout Standard
24599 \begin_inset Flex Multiple Columns
24602 \begin_layout Plain Layout
24607 The Adventure of the Empty House
24610 \begin_inset Newline newline
24613 by Sir Arthur Conan Doyle
24616 \begin_layout Plain Layout
24619 It was in the spring of the year 1894 that all London was interested, and
24620 the fashionable world dismayed, by the murder of the Honourable Ronald
24621 Adair under most unusual and inexplicable circumstances.
24622 The public has already learned those particulars of the crime which came
24623 out in the police investigation, but a good deal was suppressed upon that
24624 occasion, since the case for the prosecution was so overwhelmingly strong
24625 that it was not necessary to bring forward all the facts.
24626 Only now, at the end of nearly ten years, am I allowed to supply those
24627 missing links which make up the whole of that remarkable chain.
24628 The crime was of interest in itself, but that interest was as nothing to
24629 me compared to the inconceivable sequel, which afforded me the greatest
24630 shock and surprise of any event in my adventurous life.
24631 Even now, after this long interval, I find myself thrilling as I think
24632 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24633 ty which utterly submerged my mind.
24634 Let me say to that public, which has shown some interest in those glimpses
24635 which I have occasionally given them of the thoughts and actions of a very
24636 remarkable man, that they are not to blame me if I have not shared my knowledge
24637 with them, for I should have considered it my first duty to do so, had
24638 I not been barred by a positive prohibition from his own lips, which was
24639 only withdrawn upon the third of last month.
24647 \begin_layout Standard
24648 To get 3 or more columns, set the cursor into the multicolumn inset and
24651 Insert\SpecialChar menuseparator
24653 \begin_inset space ~
24657 \begin_inset space ~
24663 The number of the desired columns is written into that inset (for 3
24664 \begin_inset space ~
24668 \begin_inset Quotes eld
24672 \begin_inset Quotes erd
24676 \begin_inset Newline newline
24679 Here is an example with 3
24680 \begin_inset space ~
24686 \begin_layout Standard
24687 \begin_inset Flex Multiple Columns
24690 \begin_layout Plain Layout
24693 \begin_inset Argument 1
24696 \begin_layout Plain Layout
24703 It can be imagined that my close intimacy with Sherlock Holmes had interested
24704 me deeply in crime, and that after his disappearance I never failed to
24705 read with care the various problems which came before the public.
24706 And I even attempted, more than once, for my own private satisfaction,
24707 to employ his methods in their solution, though with indifferent success.
24708 There was none, however, which appealed to me like this tragedy of Ronald
24710 As I read the evidence at the inquest, which led up to a verdict of willful
24711 murder against some person or persons unknown, I realized more clearly
24712 than I had ever done the loss which the community had sustained by the
24713 death of Sherlock Holmes.
24714 There were points about this strange business which would, I was sure,
24715 have specially appealed to him, and the efforts of the police would have
24716 been supplemented, or more probably anticipated, by the trained observation
24717 and the alert mind of the first criminal agent in Europe.
24718 All day, as I drove upon my round, I turned over the case in my mind and
24719 found no explanation which appeared to me to be adequate.
24720 At the risk of telling a twice-told tale, I will recapitulate the facts
24721 as they were known to the public at the conclusion of the inquest.
24729 \begin_layout Standard
24730 You can have up to 10
24731 \begin_inset space ~
24734 columns if you want to, but that might not be very pleasant for the readers
24738 \begin_layout Standard
24739 \begin_inset Newpage newpage
24745 \begin_layout Subsection
24746 Columns inside Columns
24749 \begin_layout Standard
24750 You can also have columns inside columns:
24753 \begin_layout Standard
24754 \begin_inset Flex Multiple Columns
24757 \begin_layout Plain Layout
24760 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24761 at that time governor of one of the Australian colonies.
24762 Adair's mother had returned from Australia to undergo the operation for
24763 cataract, and she, her son Ronald, and her daughter Hilda were living together
24767 \begin_layout Plain Layout
24768 \begin_inset Flex Multiple Columns
24771 \begin_layout Plain Layout
24774 The youth moved in the best society–had, so far as was known, no enemies
24775 and no particular vices.
24776 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24777 had been broken off by mutual consent some months before, and there was
24778 no sign that it had left any very profound feeling behind it.
24779 For the rest {sic} the man's life moved in a narrow and conventional circle,
24780 for his habits were quiet and his nature unemotional.
24781 Yet it was upon this easy-going young aristocrat that death came, in most
24782 strange and unexpected form, between the hours of ten and eleven-twenty
24783 on the night of March 30, 1894.
24791 \begin_layout Plain Layout
24794 Ronald Adair was fond of cards–playing continually, but never for such stakes
24796 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24797 It was shown that, after dinner on the day of his death, he had played
24798 a rubber of whist at the latter club.
24799 He had also played there in the afternoon.
24804 The evidence of those who had played with him– Mr.
24805 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
24806 and that there was a fairly equal fall of the cards.
24807 Adair might have lost five pounds, but not more.
24808 His fortune was a considerable one, and such a loss could not in any way
24810 He had played nearly every day at one club or other, but he was a cautious
24811 player, and usually rose a winner.
24812 It came out in evidence that, in partnership with Colonel Moran, he had
24813 actually won as much as four hundred and twenty pounds in a sitting, some
24814 weeks before, from Godfrey Milner and Lord Balmoral.
24815 So much for his recent history as it came out at the inquest.
24823 \begin_layout Subsection
24827 \begin_layout Standard
24828 The examples in this section show some more special features of multiple
24832 \begin_layout Standard
24833 For more features of multiple columns, have a look at the
24834 \begin_inset CommandInset href
24836 name "documentation"
24837 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24842 of the \SpecialChar LaTeX
24844 \begin_inset Flex Code
24847 \begin_layout Plain Layout
24856 \begin_layout Subsubsection
24860 \begin_layout Standard
24861 To add a preface text for multiple columns, set the cursor into the multicolumn
24862 inset and use the menu
24864 Insert\SpecialChar menuseparator
24868 Write your preface text into that inset.
24869 \begin_inset Newline newline
24872 This is an example with some preface text:
24875 \begin_layout Standard
24876 \begin_inset VSpace bigskip
24882 \begin_layout Standard
24883 \begin_inset Flex Multiple Columns
24886 \begin_layout Plain Layout
24887 \begin_inset Argument 2
24890 \begin_layout Plain Layout
24891 And the story continues and continues and continues and continues\SpecialChar ldots
24899 On the evening of the crime, he returned from the club exactly at ten.
24900 His mother and sister were out spending the evening with a relation.
24901 The servant deposed that she heard him enter the front room on the second
24902 floor, generally used as his sitting-room.
24903 She had lit a fire there, and as it smoked she had opened the window.
24904 No sound was heard from the room until eleven-twenty, the hour of the return
24905 of Lady Maynooth and her daughter.
24906 Desiring to say good-night, she attempted to enter her son's room.
24907 The door was locked on the inside, and no answer could be got to their
24908 cries and knocking.
24909 Help was obtained, and the door forced.
24910 The unfortunate young man was found lying near the table.
24911 His head had been horribly mutilated by an expanding revolver bullet, but
24912 no weapon of any sort was to be found in the room.
24920 \begin_layout Standard
24921 You can also use a section heading as the preface if you use a section command
24922 as \SpecialChar TeX
24924 For example the command
24927 \begin_layout LyX-Code
24930 subsection{subsection title}
24933 \begin_layout Standard
24934 creates a subsection.
24935 In this example the preface is a subsubsection:
24938 \begin_layout Standard
24939 \begin_inset Flex Multiple Columns
24942 \begin_layout Plain Layout
24943 \begin_inset Argument 2
24946 \begin_layout Plain Layout
24950 \begin_layout Plain Layout
24959 This is a subsubsection heading as a preface
24963 \begin_layout Plain Layout
24977 A minute examination of the circumstances served only to make the case more
24979 In the first place, no reason could be given why the young man should have
24980 fastened the door upon the inside.
24981 There was the possibility that the murderer had done this, and had afterwards
24982 escaped by the window.
24983 The drop was at least twenty feet, however, and a bed of crocuses in full
24985 Neither the flowers nor the earth showed any sign of having been disturbed,
24986 nor were there any marks upon the narrow strip of grass which separated
24987 the house from the road.
24988 Apparently, therefore, it was the young man himself who had fastened the
24990 But how did he come by his death? No one could have climbed up to the window
24991 without leaving traces.
24992 Suppose a man had fired through the window, he would indeed be a remarkable
24993 shot who could with a revolver inflict so deadly a wound.
24994 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
24995 a hundred yards of the house.
24996 No one had heard a shot.
25004 \begin_layout Standard
25005 If there is less vertical space than 6
25006 \begin_inset space ~
25009 text lines is left on the page at the beginning of the multiple columns,
25010 a page break will be inserted before the multiple columns.
25011 Depending on the number of lines of the preface text, you might want to
25013 This is done by setting the cursor into the mulitcolumn inset behind the
25014 preface (if there is any) and using the menu
25016 Insert\SpecialChar menuseparator
25018 \begin_inset space ~
25022 \begin_inset space ~
25026 \begin_inset space ~
25032 Insert into that inset the amount of space like e.
25033 \begin_inset space \thinspace{}
25037 \begin_inset space \space{}
25041 \begin_inset Quotes eld
25045 \begin_inset Quotes erd
25049 \begin_inset Newline newline
25052 In this example the space is set to 7
25053 \begin_inset space ~
25056 text lines by using
25057 \begin_inset Flex Code
25060 \begin_layout Plain Layout
25069 \begin_inset Flex Code
25072 \begin_layout Plain Layout
25080 needs to be inserted as \SpecialChar TeX
25084 \begin_layout Standard
25085 \begin_inset Flex Multiple Columns
25088 \begin_layout Plain Layout
25089 \begin_inset Argument 3
25092 \begin_layout Plain Layout
25097 \begin_layout Plain Layout
25113 On the evening of the crime, he returned from the club exactly at ten.
25114 His mother and sister were out spending the evening with a relation.
25115 The servant deposed that she heard him enter the front room on the second
25116 floor, generally used as his sitting-room.
25117 She had lit a fire there, and as it smoked she had opened the window.
25118 No sound was heard from the room until eleven-twenty, the hour of the return
25119 of Lady Maynooth and her daughter.
25120 Desiring to say good-night, she attempted to enter her son's room.
25121 The door was locked on the inside, and no answer could be got to their
25122 cries and knocking.
25123 Help was obtained, and the door forced.
25124 The unfortunate young man was found lying near the table.
25125 His head had been horribly mutilated by an expanding revolver bullet, but
25126 no weapon of any sort was to be found in the room.
25134 \begin_layout Subsubsection
25138 \begin_layout Standard
25139 The amount of space before and after multiple columns can be changed by
25140 changing the length
25141 \begin_inset Flex Code
25144 \begin_layout Plain Layout
25153 For example the command
25156 \begin_layout LyX-Code
25164 \begin_layout Standard
25165 in \SpecialChar TeX
25166 Code changes its value to 3
25167 \begin_inset space \thinspace{}
25171 The change must be made before the multiple columns' start.
25172 The predefined value is 13
25173 \begin_inset space \thinspace{}
25179 \begin_layout Standard
25181 \begin_inset Flex Code
25184 \begin_layout Plain Layout
25193 \begin_inset space \thinspace{}
25199 \begin_layout Standard
25203 \begin_layout Plain Layout
25209 multicolsep}{2.5cm}
25217 \begin_layout Standard
25218 \begin_inset Flex Multiple Columns
25221 \begin_layout Plain Layout
25224 All day I turned these facts over in my mind, endeavouring to hit upon some
25225 theory which could reconcile them all, and to find that line of least resistanc
25226 e which my poor friend had declared to be the starting-point of every investigat
25228 I confess that I made little progress.
25229 In the evening I strolled across the Park, and found myself about six o'clock
25230 at the Oxford Street end of Park Lane.
25231 A group of loafers upon the pavements, all staring up at a particular window,
25232 directed me to the house which I had come to see.
25233 A tall, thin man with coloured glasses, whom I strongly suspected of being
25234 a plain-clothes detective, was pointing out some theory of his own, while
25235 the others crowded round to listen to what he said.
25236 I got as near him as I could, but his observations seemed to me to be absurd,
25237 so I withdrew again in some disgust.
25238 As I did so I struck against an elderly, deformed man, who had been behind
25239 me, and I knocked down several books which he was carrying.
25247 \begin_layout Standard
25248 \begin_inset Note Greyedout
25251 \begin_layout Plain Layout
25256 The values you set with
25257 \begin_inset Flex Code
25260 \begin_layout Plain Layout
25268 will be used for all following multiple columns until you change them again.
25276 \begin_layout Standard
25280 \begin_layout Plain Layout
25292 \begin_inset Note Note
25295 \begin_layout Plain Layout
25296 go back to the default
25304 \begin_layout Standard
25305 \begin_inset Newpage newpage
25311 \begin_layout Subsubsection
25315 \begin_layout Standard
25316 A column break can be forced by inserting the command
25317 \begin_inset Flex Code
25320 \begin_layout Plain Layout
25328 as \SpecialChar TeX
25329 Code to that position in the text where the column should be broken.
25330 Note that this leads in most cases to whitespace in the text.
25331 \begin_inset Newline newline
25334 Here is an example:
25337 \begin_layout Standard
25338 \begin_inset Flex Multiple Columns
25341 \begin_layout Plain Layout
25344 \begin_inset Quotes eld
25347 You're surprised to see me, sir,
25348 \begin_inset Quotes erd
25351 said he, in a strange, croaking voice.
25354 \begin_layout Plain Layout
25357 I acknowledged that I was.
25360 \begin_layout Plain Layout
25363 \begin_inset Quotes eld
25366 Well, I've a conscience, sir, and when I chanced to see you go into this
25367 house, as I came hobbling after you, I thought to myself, I'll just step
25368 in and see that kind gentleman, and tell him that if I was a bit gruff
25369 in my manner there was not any harm meant, and that I am much obliged to
25370 him for picking up my books.
25371 \begin_inset Quotes erd
25377 \begin_layout Plain Layout
25380 \begin_inset Quotes eld
25383 You make too much of a trifle,
25384 \begin_inset Quotes erd
25389 \begin_inset Quotes eld
25392 May I ask how you knew who I was?
25393 \begin_inset Quotes erd
25396 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25400 \begin_layout Plain Layout
25412 \begin_layout Plain Layout
25415 \begin_inset Quotes eld
25418 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25419 you'll find my little bookshop at the corner of Church Street, and very
25420 happy to see you, I am sure.
25421 Maybe you collect yourself, sir.
25425 \begin_inset space ~
25438 –a bargain, every one of them.
25439 With five volumes you could just fill that gap on that second shelf.
25440 It looks untidy, does it not, sir?
25441 \begin_inset Quotes erd
25452 \begin_layout Subsubsection
25456 \begin_layout Standard
25457 The width of the columns is automatically calculated, but you can modify
25458 the space between the columns.
25459 This is done by changing the length
25460 \begin_inset Flex Code
25463 \begin_layout Plain Layout
25472 Its predefined value is 10
25473 \begin_inset space \thinspace{}
25477 Here is an example where
25478 \begin_inset Flex Code
25481 \begin_layout Plain Layout
25490 \begin_inset space \thinspace{}
25496 \begin_layout Standard
25500 \begin_layout Plain Layout
25514 \begin_layout Standard
25515 \begin_inset Flex Multiple Columns
25518 \begin_layout Plain Layout
25521 My observations of No.
25522 \begin_inset space \space{}
25525 427 Park Lane did little to clear up the problem in which I was interested.
25526 The house was separated from the street by a low wall and railing, the
25527 whole not more than five feet high.
25528 It was perfectly easy, therefore, for anyone to get into the garden, but
25529 the window was entirely inaccessible, since there was no water pipe or
25530 anything which could help the most active man to climb it.
25531 More puzzled than ever, I retraced my steps to Kensington.
25532 I had not been in my study five minutes when the maid entered to say that
25533 a person desired to see me.
25534 To my astonishment it was none other than my strange old book collector,
25535 his sharp, wizened face peering out from a frame of white hair, and his
25536 precious volumes, a dozen of them at least, wedged under his right arm.
25544 \begin_layout Standard
25548 \begin_layout Plain Layout
25560 \begin_inset Note Note
25563 \begin_layout Plain Layout
25564 go back to the default
25572 \begin_layout Subsubsection
25576 \begin_layout Standard
25577 Between the columns a rule with a width of the length
25578 \begin_inset Flex Code
25581 \begin_layout Plain Layout
25590 If this rule width is set to 0
25591 \begin_inset space \thinspace{}
25594 pt (this is the default), the rule is suppressed.
25595 In the following example the rule is 2
25596 \begin_inset space \thinspace{}
25602 \begin_layout Standard
25606 \begin_layout Plain Layout
25612 columnseprule}{2pt}
25620 \begin_layout Standard
25621 \begin_inset Flex Multiple Columns
25624 \begin_layout Plain Layout
25627 \begin_inset Quotes eld
25630 You're surprised to see me, sir,
25631 \begin_inset Quotes erd
25634 said he, in a strange, croaking voice.
25637 \begin_layout Plain Layout
25640 I acknowledged that I was.
25643 \begin_layout Plain Layout
25646 \begin_inset Quotes eld
25649 Well, I've a conscience, sir, and when I chanced to see you go into this
25650 house, as I came hobbling after you, I thought to myself, I'll just step
25651 in and see that kind gentleman, and tell him that if I was a bit gruff
25652 in my manner there was not any harm meant, and that I am much obliged to
25653 him for picking up my books.
25654 \begin_inset Quotes erd
25660 \begin_layout Plain Layout
25663 \begin_inset Quotes eld
25666 You make too much of a trifle,
25667 \begin_inset Quotes erd
25672 \begin_inset Quotes eld
25675 May I ask how you knew who I was?
25676 \begin_inset Quotes erd
25682 \begin_layout Plain Layout
25685 \begin_inset Quotes eld
25688 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25689 you'll find my little bookshop at the corner of Church Street, and very
25690 happy to see you, I am sure.
25691 Maybe you collect yourself, sir.
25695 \begin_inset space ~
25708 –a bargain, every one of them.
25709 With five volumes you could just fill that gap on that second shelf.
25710 It looks untidy, does it not, sir?
25711 \begin_inset Quotes erd
25722 \begin_layout Standard
25723 \begin_inset VSpace defskip
25729 \begin_layout Standard
25730 The rule can be colored by redefining the command
25731 \begin_inset Flex Code
25734 \begin_layout Plain Layout
25743 This is done by inserting the command
25746 \begin_layout LyX-Code
25751 columnseprulecolor}{
25756 \begin_layout Standard
25757 as \SpecialChar TeX
25758 Code before the multicolumn inset.
25760 \begin_inset Flex Code
25763 \begin_layout Plain Layout
25769 in this command by a color of your choice.
25770 You can use all pre- and self-defined colors.
25778 \begin_inset space ~
25783 for more information about pre- and self-defined colors.
25784 To go back to the default color insert the command
25787 \begin_layout LyX-Code
25792 columnseprulecolor}{
25797 \begin_layout Standard
25798 Here is the example with a cyan rule and 1
25799 \begin_inset space \thinspace{}
25802 cm column separation:
25805 \begin_layout Standard
25809 \begin_layout Plain Layout
25818 \begin_layout Plain Layout
25824 columnseprulecolor}{
25834 \begin_layout Standard
25835 \begin_inset Flex Multiple Columns
25838 \begin_layout Plain Layout
25841 \begin_inset Quotes eld
25844 You're surprised to see me, sir,
25845 \begin_inset Quotes erd
25848 said he, in a strange, croaking voice.
25851 \begin_layout Plain Layout
25854 I acknowledged that I was.
25857 \begin_layout Plain Layout
25860 \begin_inset Quotes eld
25863 Well, I've a conscience, sir, and when I chanced to see you go into this
25864 house, as I came hobbling after you, I thought to myself, I'll just step
25865 in and see that kind gentleman, and tell him that if I was a bit gruff
25866 in my manner there was not any harm meant, and that I am much obliged to
25867 him for picking up my books.
25868 \begin_inset Quotes erd
25874 \begin_layout Plain Layout
25877 \begin_inset Quotes eld
25880 You make too much of a trifle,
25881 \begin_inset Quotes erd
25886 \begin_inset Quotes eld
25889 May I ask how you knew who I was?
25890 \begin_inset Quotes erd
25896 \begin_layout Plain Layout
25899 \begin_inset Quotes eld
25902 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25903 you'll find my little bookshop at the corner of Church Street, and very
25904 happy to see you, I am sure.
25905 Maybe you collect yourself, sir.
25909 \begin_inset space ~
25922 –a bargain, every one of them.
25923 With five volumes you could just fill that gap on that second shelf.
25924 It looks untidy, does it not, sir?
25925 \begin_inset Quotes erd
25936 \begin_layout Standard
25940 \begin_layout Plain Layout
25946 columnseprule}{0pt}
25949 \begin_layout Plain Layout
25955 columnseprulecolor}{
25963 \begin_inset Note Note
25966 \begin_layout Plain Layout
25967 go back to the default
25975 \begin_layout Section
25976 Non-standard Paragraph Shapes
25979 \begin_layout Standard
25982 as well as any other text processor uses by default rectangular paragraphs.
25983 For special cases like for example posters, invitation cards or poems you
25984 can modify the paragraph shape to one of your choice.
25985 This can be done by using the \SpecialChar LaTeX
25987 \begin_inset Flex Code
25990 \begin_layout Plain Layout
25997 which is loaded by using in the document settings the module
25999 Custom paragraph shapes
26004 \begin_layout Subsection
26008 \begin_layout Standard
26013 provides the following shapes:
26016 \begin_layout Standard
26017 \begin_inset Tabular
26018 <lyxtabular version="3" rows="13" columns="3">
26019 <features booktabs="true" islongtable="true" longtabularalignment="center">
26020 <column alignment="left" valignment="middle" width="16col%">
26021 <column alignment="left" valignment="middle" width="40col%">
26022 <column alignment="left" valignment="middle" width="35col%">
26023 <row endhead="true">
26024 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26027 \begin_layout Plain Layout
26036 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26039 \begin_layout Plain Layout
26048 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26051 \begin_layout Plain Layout
26061 <row interlinespace="default">
26062 <cell alignment="left" valignment="top" usebox="none">
26065 \begin_layout Plain Layout
26073 <cell alignment="left" valignment="top" usebox="none">
26076 \begin_layout Plain Layout
26079 Circle with circular hole (in the size of a CD/DVD)
26084 <cell alignment="left" valignment="top" usebox="none">
26087 \begin_layout Plain Layout
26090 Cannot be scaled, take care there is not too much text
26096 <row interlinespace="default">
26097 <cell alignment="left" valignment="top" usebox="none">
26100 \begin_layout Plain Layout
26108 <cell alignment="left" valignment="top" usebox="none">
26111 \begin_layout Plain Layout
26119 <cell alignment="left" valignment="top" usebox="none">
26122 \begin_layout Plain Layout
26125 Fragile, calculation might fail
26131 <row interlinespace="default">
26132 <cell alignment="left" valignment="top" usebox="none">
26135 \begin_layout Plain Layout
26143 <cell alignment="left" valignment="top" usebox="none">
26146 \begin_layout Plain Layout
26149 Rhomboid (symbolizing a
26150 \begin_inset Quotes eld
26154 \begin_inset Quotes erd
26162 <cell alignment="left" valignment="top" usebox="none">
26165 \begin_layout Plain Layout
26174 <row interlinespace="default">
26175 <cell alignment="left" valignment="top" usebox="none">
26178 \begin_layout Plain Layout
26186 <cell alignment="left" valignment="top" usebox="none">
26189 \begin_layout Plain Layout
26197 <cell alignment="left" valignment="top" usebox="none">
26200 \begin_layout Plain Layout
26209 <row interlinespace="default">
26210 <cell alignment="left" valignment="top" usebox="none">
26213 \begin_layout Plain Layout
26221 <cell alignment="left" valignment="top" usebox="none">
26224 \begin_layout Plain Layout
26232 <cell alignment="left" valignment="top" usebox="none">
26235 \begin_layout Plain Layout
26244 <row interlinespace="default">
26245 <cell alignment="left" valignment="top" usebox="none">
26248 \begin_layout Plain Layout
26256 <cell alignment="left" valignment="top" usebox="none">
26259 \begin_layout Plain Layout
26262 Nut for bolt (hexagon with circular hole)
26267 <cell alignment="left" valignment="top" usebox="none">
26270 \begin_layout Plain Layout
26279 <row interlinespace="default">
26280 <cell alignment="left" valignment="top" usebox="none">
26283 \begin_layout Plain Layout
26291 <cell alignment="left" valignment="top" usebox="none">
26294 \begin_layout Plain Layout
26302 <cell alignment="left" valignment="top" usebox="none">
26305 \begin_layout Plain Layout
26314 <row interlinespace="default">
26315 <cell alignment="left" valignment="top" usebox="none">
26318 \begin_layout Plain Layout
26326 <cell alignment="left" valignment="top" usebox="none">
26329 \begin_layout Plain Layout
26337 <cell alignment="left" valignment="top" usebox="none">
26340 \begin_layout Plain Layout
26349 <row interlinespace="default">
26350 <cell alignment="left" valignment="top" usebox="none">
26353 \begin_layout Plain Layout
26361 <cell alignment="left" valignment="top" usebox="none">
26364 \begin_layout Plain Layout
26372 <cell alignment="left" valignment="top" usebox="none">
26375 \begin_layout Plain Layout
26384 <row interlinespace="default">
26385 <cell alignment="left" valignment="top" usebox="none">
26388 \begin_layout Plain Layout
26396 <cell alignment="left" valignment="top" usebox="none">
26399 \begin_layout Plain Layout
26402 Normal/reversed rain drop
26407 <cell alignment="left" valignment="top" usebox="none">
26410 \begin_layout Plain Layout
26413 Fragile, calculation might fail
26419 <row interlinespace="default">
26420 <cell alignment="left" valignment="top" usebox="none">
26423 \begin_layout Plain Layout
26432 <cell alignment="left" valignment="top" usebox="none">
26435 \begin_layout Plain Layout
26438 The \SpecialChar TeX
26444 <cell alignment="left" valignment="top" usebox="none">
26447 \begin_layout Plain Layout
26456 <row interlinespace="default">
26457 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26460 \begin_layout Plain Layout
26464 \begin_inset Newline newline
26472 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26475 \begin_layout Plain Layout
26478 Triangles in different orientations
26483 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26486 \begin_layout Plain Layout
26502 \begin_layout Standard
26503 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26505 for environments in the toolbar.
26508 \begin_layout Standard
26509 \begin_inset Newpage newpage
26515 \begin_layout Standard
26516 Here is an example paragraph in the shape of a nut:
26519 \begin_layout Standard
26520 \begin_inset VSpace bigskip
26529 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26530 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26532 At vero eos et accusam et justo duo dolores et ea rebum.
26533 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26535 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26536 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26540 \begin_layout Standard
26541 \begin_inset VSpace bigskip
26547 \begin_layout Standard
26548 \begin_inset Note Greyedout
26551 \begin_layout Plain Layout
26560 paragraphs cannot run over a page break.
26568 \begin_layout Standard
26569 \begin_inset VSpace bigskip
26575 \begin_layout Standard
26577 \begin_inset Flex Code
26580 \begin_layout Plain Layout
26586 takes care that the shape will always be preserved, no matter how much
26587 text is in the paragraph.
26588 Therefore the paragraph size changes with the amount of contained text.
26589 This can lead to paragraph sizes exceeding the page margins.
26590 To demonstrate the size scaling, here is the same example paragraph but
26591 with twice as much text:
26594 \begin_layout Standard
26595 \begin_inset Newpage newpage
26604 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26605 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26607 At vero eos et accusam et justo duo dolores et ea rebum.
26608 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26610 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26611 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26613 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26614 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26616 At vero eos et accusam et justo duo dolores et ea rebum.
26617 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26619 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26620 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26624 \begin_layout Standard
26625 \begin_inset VSpace bigskip
26631 \begin_layout Standard
26632 An exception is the shape
26637 It cannot be scaled because it must fit the size of a CD/DVD.
26638 Therefore the amount of text that fits into the shape is limited.
26639 \begin_inset Newline newline
26650 shape are fragile, meaning that the calculation of their size can fail,
26651 depending on the amount of text.
26652 You will then get the \SpecialChar LaTeX
26654 \begin_inset Quotes eld
26657 Arithmetic overflow
26658 \begin_inset Quotes erd
26662 In this case one can try to remove or add some text; if nothing works one
26663 has to use another shape.
26666 \begin_layout Standard
26667 \begin_inset VSpace bigskip
26673 \begin_layout Standard
26674 For shapes with tips you will maybe see that \SpecialChar LaTeX
26675 's hyphenation routine fails
26676 for text in the tips.
26677 Therefore it is often necessary to add hyphenation points
26682 arg "specialchar-insert hyphenation"
26687 ) to the corresponding text parts.
26690 \begin_layout Standard
26691 \begin_inset VSpace bigskip
26697 \begin_layout Standard
26698 Shapepar paragraphs are either always centered or placed on the page so
26699 that their left border touches the left page margin.
26700 You can therefore not use the paragraph dialog to align such paragraphs.
26701 A solution is to put the paragraph into a minipage or parbox and align
26703 The problem is hereby to find the right width for the box.
26704 Because if it is too wide and you center the box, the paragraph is not
26705 centered too because it sticks at the left side of the box.
26706 So you might have to play a bit with the width until it fits.
26707 Here are two heart-shaped paragraphs, the first one is not aligned, the
26708 second one is right-aligned:
26711 \begin_layout Standard
26712 \begin_inset Newpage newpage
26718 \begin_layout Heart
26722 Lo\SpecialChar softhyphen
26723 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26724 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26726 At vero eos et accusam et justo duo dolores et ea rebum.
26727 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26731 \begin_layout Standard
26732 \begin_inset VSpace bigskip
26738 \begin_layout Standard
26741 \begin_inset Box Frameless
26751 height_special "totalheight"
26756 backgroundcolor "none"
26759 \begin_layout Heart
26763 Lo\SpecialChar softhyphen
26764 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26765 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26767 At vero eos et accusam et justo duo dolores et ea rebum.
26768 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26777 \begin_layout Subsection
26781 \begin_layout Standard
26782 You can define any shape you want.
26783 Doing this manually is a lot of work because every coordinate must be specified.
26784 But there is a way to let the computer calculate the coordinates:
26787 \begin_layout Enumerate
26788 Install the program
26789 \begin_inset CommandInset href
26792 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26800 \begin_layout Enumerate
26807 TeX/LaTeX\SpecialChar menuseparator
26808 Settings\SpecialChar menuseparator
26811 and select the font size you are using in your document.
26812 For example this document uses the size 12
26813 \begin_inset space \thinspace{}
26819 \begin_layout Enumerate
26823 \begin_layout Enumerate
26826 TeX/LaTeX\SpecialChar menuseparator
26829 to export the shape to coordinates.
26830 In the appearing dialog use either the outline of your shape for the coordinate
26831 s or the path itself.
26835 \begin_layout Plain Layout
26836 For more information see
26837 \begin_inset CommandInset href
26839 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26852 \begin_layout Standard
26853 The coordinates are written into a \SpecialChar TeX
26855 To use it for your \SpecialChar LyX
26859 \begin_layout Enumerate
26860 Place the cursor before the first character of your paragraph (or into a
26864 \begin_layout Enumerate
26865 Open in \SpecialChar LyX
26868 Insert\SpecialChar menuseparator
26869 File\SpecialChar menuseparator
26871 \begin_inset space ~
26876 , select the file and use
26885 \begin_layout Standard
26886 \begin_inset VSpace defskip
26892 \begin_layout Standard
26893 \begin_inset Note Greyedout
26896 \begin_layout Plain Layout
26901 : The changed shape only applies to the current paragraph; everything is
26902 reset to normal for the next paragraph.
26903 Therefore the shape definition file must be input into every paragraph
26904 with the desired shape.
26912 \begin_layout Standard
26913 \begin_inset VSpace bigskip
26919 \begin_layout Standard
26920 Here is an example:
26923 \begin_layout Standard
26924 \begin_inset VSpace bigskip
26930 \begin_layout Standard
26931 \begin_inset CommandInset include
26933 filename "SpecialParagraphShape.tex"
26939 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26940 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26942 At vero eos et accusam et justo duo dolores et ea rebum.
26943 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26945 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26946 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26950 \begin_layout Standard
26951 \begin_inset VSpace bigskip
26957 \begin_layout Standard
26962 to draw complexer shapes in
26966 you can draw the shape in a program of your choice and import the resulting
26972 Then you only need to draw a line or spline along the outline of the image.
26975 \begin_layout Standard
26976 \begin_inset VSpace bigskip
26982 \begin_layout Standard
26985 Custom paragraph shapes
26987 also provides the two commands
26995 which can be used to define custom shapes coordinate by coordinate.
26999 \begin_layout Plain Layout
27000 These commands are internally used for all shapes described here.
27005 For information how these styles are used and about further customization
27006 possibilities, have a look at the
27007 \begin_inset CommandInset href
27009 name "documentation"
27010 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
27016 \begin_inset Flex Code
27019 \begin_layout Plain Layout