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 0
94 \use_package stackrel 0
95 \use_package stmaryrd 0
96 \use_package undertilde 0
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 true
125 \output_changes false
129 \author -712698321 "Jürgen Spitzmüller"
130 \author 34634807 "Jean-Pierre"
136 Additional \SpecialChar LyX
140 \begin_layout Subtitle
145 by the \SpecialChar LyX
150 \begin_layout Plain Layout
152 Principal maintainer of this file is
157 If you have comments or error corrections, please send them to the \SpecialChar LyX
160 \begin_inset Flex Code
163 \begin_layout Plain Layout
165 <lyx-docs@lists.lyx.org>
178 \begin_layout Standard
179 \begin_inset CommandInset toc
180 LatexCommand tableofcontents
187 \begin_layout Chapter
191 \begin_layout Standard
192 This manual is essentially Part II of the
194 User's Guide\SpecialChar endofsentence
197 The reason for separating the two documents is simple: the
201 is already quite lengthy, and it contains information on all of the basic
202 features one needs to know in order to prepare most documents.
203 However, the \SpecialChar LyX
204 Team has worked to make \SpecialChar LyX
205 extensible through various configuration
206 files and external packages.
207 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
209 create a layout file (or module) for it without having to alter \SpecialChar LyX
211 We've already had contributions of several new features this way, and some
212 of them are documented here.
213 There are also some more `advanced' features, such as how to control the
214 presentation of bibliographies and how to work with multi-part documents,
215 that are not covered in the
219 and are discussed here.
222 \begin_layout Standard
223 This manual also documents some special features, like fax support, version
224 control, and SGML support, which require additional software to work properly.
225 There is also a chapter on \SpecialChar LyX
227 And lastly, there's a chapter of \SpecialChar LaTeX
228 tools and tips, things you can use to
229 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
231 After all, \SpecialChar LyX
236 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
240 \begin_layout Standard
241 If you haven't read the
245 yet, you are definitely in the wrong manual.
250 is the first place to go, since it describes the notation and format of
252 You should also be thoroughly familiar with the
256 and all of the basic features of \SpecialChar LyX
257 before attempting to read this one.
260 \begin_layout Standard
261 Since many of the topics in this manual depend heavily on \SpecialChar LyX
263 with \SpecialChar LaTeX
264 , this first chapter covers the inner workings of \SpecialChar LyX
267 to generate exactly the \SpecialChar LaTeX
269 It is obviously for more seasoned \SpecialChar LyX
273 \begin_layout Chapter
275 and \SpecialChar LaTeX
279 \begin_layout Section
281 Uses \SpecialChar LaTeX
285 \begin_layout Standard
286 This chapter is for both \SpecialChar TeX
287 -nicians and the \SpecialChar LaTeX
289 In it, we'll explain how \SpecialChar LyX
290 and \SpecialChar LaTeX
291 work together to produce printable output.
292 This is the only place in any of the manuals where we assume you know something
293 about \SpecialChar LaTeX
297 \begin_layout Standard
298 At one time, \SpecialChar LyX
300 \begin_inset Quotes eld
303 WYSIWYM frontend to \SpecialChar LaTeX
305 \begin_inset Quotes erd
308 but that's no longer true.
309 There are frontends to \SpecialChar LaTeX
314 \begin_layout Plain Layout
315 Some familar ones are \SpecialChar TeX
316 maker and kile, on Linux, and \SpecialChar TeX
318 There are also the \SpecialChar LaTeX
319 modes for vi and emacs, of course.
324 These are basically text editors with the ability to run \SpecialChar LaTeX
326 errors in the file you're editing.
327 Although \SpecialChar LyX
336 run \SpecialChar LaTeX
337 , and it also indicates errors in the file, it also does much, much
339 For one thing, you don't need to know \SpecialChar LaTeX
340 to use \SpecialChar LyX
343 has added its own extensions to \SpecialChar LaTeX
345 Try the following sometime: select
346 \begin_inset Flex Noun
349 \begin_layout Plain Layout
350 Export\SpecialChar menuseparator
357 \begin_inset Flex Noun
360 \begin_layout Plain Layout
367 \begin_inset Flex Noun
370 \begin_layout Plain Layout
371 View\SpecialChar menuseparator
381 ), then look at the preamble of the resulting
382 \begin_inset Flex Code
385 \begin_layout Plain Layout
392 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
394 These macros are defined automatically, according to the features you use
398 \begin_layout Standard
399 There are several commands that automatically invoke \SpecialChar LaTeX
404 \begin_layout Itemize
405 \begin_inset Flex Noun
408 \begin_layout Plain Layout
409 Document\SpecialChar menuseparator
418 \begin_layout Itemize
419 \begin_inset Flex Noun
422 \begin_layout Plain Layout
423 Document\SpecialChar menuseparator
432 \begin_layout Standard
433 They will only invoke \SpecialChar LaTeX
434 if the file has changed since the last time \SpecialChar LaTeX
440 \begin_layout Standard
441 When \SpecialChar LyX
442 runs \SpecialChar LaTeX
443 on the file you're editing, it performs these steps:
446 \begin_layout Enumerate
447 Convert the document to \SpecialChar LaTeX
448 and save to a file with the extension
449 \begin_inset Flex Code
452 \begin_layout Plain Layout
459 \begin_inset Flex Code
462 \begin_layout Plain Layout
471 \begin_layout Enumerate
472 Run \SpecialChar LaTeX
474 \begin_inset Flex Code
477 \begin_layout Plain Layout
483 file (maybe several times), and run any other commands (such as
484 \begin_inset Flex Code
487 \begin_layout Plain Layout
494 \begin_inset Flex Code
497 \begin_layout Plain Layout
503 ) needed to compile the \SpecialChar LaTeX
507 \begin_layout Enumerate
508 If there are any errors, show the error log.
511 \begin_layout Standard
512 If you have run \SpecialChar LaTeX
514 \begin_inset Flex Noun
517 \begin_layout Plain Layout
518 View\SpecialChar menuseparator
525 then runs a DVI viewer to display the DVI-file.
527 \begin_inset Flex Noun
530 \begin_layout Plain Layout
531 View\SpecialChar menuseparator
538 performs further steps:
541 \begin_layout Itemize
543 \begin_inset Flex Code
546 \begin_layout Plain Layout
552 to convert the DVI file to PostScript.
555 \begin_layout Itemize
556 Run a PostScript viewer, such as
557 \begin_inset Flex Code
560 \begin_layout Plain Layout
566 , to display the PostScript file.
569 \begin_layout Standard
571 does similar things when viewing, or exporting, other formats.
574 \begin_layout Section
575 Translating \SpecialChar LaTeX
576 files into \SpecialChar LyX
580 \begin_layout Standard
581 You can import a \SpecialChar LaTeX
582 file into \SpecialChar LyX
584 \begin_inset Flex Noun
587 \begin_layout Plain Layout
588 File\SpecialChar menuseparator
589 Import\SpecialChar menuseparator
595 command in \SpecialChar LyX
597 This will call a program named
598 \begin_inset Flex Code
601 \begin_layout Plain Layout
607 which will create a file
608 \begin_inset Flex Code
611 \begin_layout Plain Layout
618 \begin_inset Flex Code
621 \begin_layout Plain Layout
629 will then open that file.
633 \begin_layout Plain Layout
634 \begin_inset Flex Code
637 \begin_layout Plain Layout
643 can also be run from the command line, of course.
651 \begin_layout Standard
652 \begin_inset Flex Code
655 \begin_layout Plain Layout
661 will translate most legal \SpecialChar LaTeX
662 , but not everything.
663 It will put things it doesn't understand into \SpecialChar TeX
664 code, so after translating
666 \begin_inset Flex Code
669 \begin_layout Plain Layout
675 , you can look for \SpecialChar TeX
676 code and hand-edit it until it looks right.
679 \begin_layout Standard
680 If you don't know what \SpecialChar TeX
681 code is, read the next section.
684 \begin_layout Section
685 \begin_inset CommandInset label
687 name "sec:Inserting-TeX-Code"
691 Inserting \SpecialChar TeX
692 Code into \SpecialChar LyX
696 \begin_layout Standard
697 Anything you can do in \SpecialChar LaTeX
698 you can do in \SpecialChar LyX
699 , for a very simple reason: You can
700 always insert \SpecialChar TeX
701 code into any \SpecialChar LyX
704 cannot, and will never be able to, display every possible \SpecialChar LaTeX
706 If ever you need to insert \SpecialChar LaTeX
707 commands into your \SpecialChar LyX
708 document, you can use the
710 \begin_inset Flex Code
713 \begin_layout Plain Layout
720 box, which you can insert into your document with
721 \begin_inset Flex Noun
724 \begin_layout Plain Layout
725 Insert\SpecialChar menuseparator
735 or the keyboard shortcut
744 \begin_layout Standard
745 Here's an example of inserting \SpecialChar LaTeX
746 commands in a \SpecialChar LyX
748 The code looks like this:
751 \begin_layout LyX-Code
755 \begin_inset Newline newline
761 \begin_inset Newline newline
764 This is an example of a minipage environment.
766 \begin_inset Newline newline
769 can put nearly everything in it, even (non-floating)
770 \begin_inset Newline newline
775 \begin_inset Newline newline
781 \begin_inset Newline newline
785 \begin_inset Newline newline
791 \begin_inset Newline newline
797 \begin_inset Newline newline
803 \begin_inset Newline newline
808 \begin_inset Newline newline
814 \begin_inset Newline newline
820 \begin_inset Newline newline
826 \begin_inset Newline newline
834 \begin_layout LyX-Code
838 \begin_layout Standard
840 \begin_inset Flex Code
843 \begin_layout Plain Layout
850 box containing this text is directly after this paragraph.
851 Those of you reading the manual in \SpecialChar LyX
852 will only see the \SpecialChar TeX
854 Those reading a printed version of the manuals will see the actual results:
855 \begin_inset VSpace bigskip
861 \begin_layout Standard
865 \begin_layout Plain Layout
872 \begin_layout Plain Layout
879 \begin_layout Plain Layout
881 This is an example of a minipage environment.
882 You can put nearly everything in it, even (non-floating) figures and tables.
886 \begin_layout Plain Layout
893 \begin_layout Plain Layout
898 \begin_layout Plain Layout
905 \begin_layout Plain Layout
912 \begin_layout Plain Layout
919 \begin_layout Plain Layout
925 \begin_layout Plain Layout
932 \begin_layout Plain Layout
939 \begin_layout Plain Layout
946 \begin_layout Plain Layout
956 \begin_inset VSpace bigskip
962 \begin_layout Standard
963 In addition to using \SpecialChar TeX
964 code, you can also create a separate file containing
965 some complex \SpecialChar LaTeX
966 structure and then use
967 \begin_inset Flex Noun
970 \begin_layout Plain Layout
971 Insert\SpecialChar menuseparator
981 to include your file (you should select the type
982 \begin_inset Flex Code
985 \begin_layout Plain Layout
992 We recommend that you only do this if you have a
993 \begin_inset Flex Code
996 \begin_layout Plain Layout
1007 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1011 \begin_layout Standard
1012 There are a few last points to emphasize:
1015 \begin_layout Itemize
1021 check if your \SpecialChar LaTeX
1025 \begin_layout Itemize
1026 Beware of reinventing the wheel.
1029 \begin_layout Standard
1030 On that last point, \SpecialChar LyX
1031 does have quite a few features tucked into it, and
1033 Be sure to check the manuals to make sure that \SpecialChar LyX
1034 doesn't have such-and-such
1035 feature before you decide you have to do it by hand.
1036 Moreover, there are numerous \SpecialChar LaTeX
1037 packages out there to do all sorts of things,
1038 from labels to envelopes to fancy multipage tables.
1040 \begin_inset CommandInset href
1043 target "http://www.ctan.org/"
1051 \begin_layout Standard
1052 If you do need to do some wild and fancy things within your document, be
1053 sure to check out a good \SpecialChar LaTeX
1054 book for assistance.
1055 There are a number of them listed in the bibliography of the
1062 \begin_layout Section
1064 and the \SpecialChar LaTeX
1068 \begin_layout Subsection
1069 About the \SpecialChar LaTeX
1073 \begin_layout Standard
1074 If you already know \SpecialChar LaTeX
1075 , there is no need to explain here what the preamble
1077 If you don't, the following will give you some ideas—we recommend again
1078 that you consult a \SpecialChar LaTeX
1079 book for further information.
1080 In any case, you should read the points below, because they explain what
1081 you can do and what you don't need to do in the \SpecialChar LaTeX
1082 preamble of a \SpecialChar LyX
1086 \begin_layout Standard
1087 The \SpecialChar LaTeX
1088 preamble comes at the very beginning of a document,
1096 \begin_layout Itemize
1097 Declare the document class.
1099 \begin_inset Newline newline
1103 already does this for you.
1104 If you're a seasoned \SpecialChar LaTeX
1105 -nician, and you have a custom document class you
1106 want to use, check out the
1108 Customization Manual
1110 for information on how to make \SpecialChar LyX
1114 \begin_layout Itemize
1115 Declare the usage of packages.
1117 \begin_inset Newline newline
1121 packages provide special commands, which are only available within a document
1122 when the package has been declared in the preamble.
1123 In addition to providing special commands, the inclusion of a package can
1124 change the document.
1125 For example, the package
1126 \begin_inset Flex Code
1129 \begin_layout Plain Layout
1135 forces all paragraphs to be indented.
1136 There are other packages for labels, envelopes, margins, etc.
1140 \begin_layout Itemize
1141 Set counters, variables, lengths and widths.
1143 \begin_inset Newline newline
1146 There are several \SpecialChar LaTeX
1147 counters and variables that
1151 be set globally from within the preamble in order to have the desired effect.
1152 (There are variables that you can set and reset inside the document, too.)
1153 Margins are a good example of something that must be set in the preamble.
1154 Another example is the label format for lists.
1155 You can actually set these just about anywhere, but it's best to do it
1156 just once, inside the preamble.
1159 \begin_layout Itemize
1160 Declare user defined commands (with
1161 \begin_inset Flex Code
1164 \begin_layout Plain Layout
1173 \begin_inset Flex Code
1176 \begin_layout Plain Layout
1185 \begin_inset Newline newline
1188 These are abbreviations for \SpecialChar LaTeX
1189 commands which appear very often inside a document.
1190 Although the preamble is a good place to declare such commands, they
1194 be declared anywhere (before they are used for the first time, of course).
1195 This can be useful if there is a lot of raw \SpecialChar LaTeX
1196 code in your document, which
1197 normally should not be the case.
1200 \begin_layout Standard
1202 adds its own set of definitions to the preamble of the
1203 \begin_inset Flex Code
1206 \begin_layout Plain Layout
1213 This makes \SpecialChar LaTeX
1214 files generated by \SpecialChar LyX
1218 \begin_layout Subsection
1219 Changing the Preamble
1222 \begin_layout Standard
1223 The commands which \SpecialChar LyX
1224 adds to the preamble of a \SpecialChar LaTeX
1225 file are fixed; you can't
1226 change them without patching \SpecialChar LyX
1228 You can, however, add your own stuff to the preamble by selecting
1229 \begin_inset Flex Noun
1232 \begin_layout Plain Layout
1235 \begin_inset space ~
1244 \begin_inset Flex Noun
1247 \begin_layout Plain Layout
1248 Document\SpecialChar menuseparator
1256 adds anything in the
1257 \begin_inset Flex Noun
1260 \begin_layout Plain Layout
1266 dialog to its own built-in preamble.
1267 Before adding your own declarations in the preamble, you should make sure
1268 that \SpecialChar LyX
1269 doesn't already support what you want to do.
1270 (Remember what we said about reinventing the wheel?) Also,
1272 make sure your preamble code is correct
1276 doesn't check it for you.
1277 If there is an error, you're likely to get an error like
1278 \begin_inset Quotes eld
1282 \begin_inset Flex Code
1285 \begin_layout Plain Layout
1294 \begin_inset Quotes erd
1298 If you see this error, check your preamble.
1301 \begin_layout Subsection
1305 \begin_layout Standard
1306 Here are some examples of what you can add to a preamble, and what they
1310 \begin_layout Subsubsection
1314 \begin_layout Standard
1315 There are two variables under \SpecialChar LaTeX
1316 that control page position:
1317 \begin_inset Flex Code
1320 \begin_layout Plain Layout
1329 \begin_inset Flex Code
1332 \begin_layout Plain Layout
1341 Their names should be self-explanatory.
1342 These variables are useful if you think for a moment about computer labels.
1343 Sometimes, the size of a print medium and the area of the medium that you
1344 can actually print on aren't the same.
1346 \begin_inset Flex Code
1349 \begin_layout Plain Layout
1358 \begin_inset Flex Code
1361 \begin_layout Plain Layout
1372 \begin_layout Standard
1373 The default values for
1374 \begin_inset Flex Code
1377 \begin_layout Plain Layout
1386 \begin_inset Flex Code
1389 \begin_layout Plain Layout
1398 \begin_inset space \thinspace{}
1402 \begin_inset space \thinspace{}
1406 \begin_inset space \space{}
1409 the page isn't shifted.
1410 Unfortunately, some DVI drivers always seem to shift the page.
1411 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1412 If you're using \SpecialChar LyX
1413 on a system that you don't personally maintain, and your
1414 sysadmin is a doofus,
1415 \begin_inset Flex Code
1418 \begin_layout Plain Layout
1427 \begin_inset Flex Code
1430 \begin_layout Plain Layout
1439 Suppose your left and top margins are always 0.5
1440 \begin_inset space \thinspace{}
1444 You can add this to the preamble:
1447 \begin_layout LyX-Code
1455 \begin_layout LyX-Code
1463 \begin_layout Standard
1464 and your margins should now be correct.
1467 \begin_layout Subsubsection
1471 \begin_layout Standard
1472 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1473 There's a rather nice package, available at your nearest CTAN archive,
1474 for printing sheets of labels:
1475 \begin_inset Flex Code
1478 \begin_layout Plain Layout
1485 Now, your system may not have this package installed by default.
1486 We leave that up to you to check.
1487 You'll also want to read the documentation for it; we're not going to do
1489 Since this is an example, however, we'll give you an example of how you
1493 \begin_layout Standard
1494 First, make sure you're using the
1495 \begin_inset Flex Code
1498 \begin_layout Plain Layout
1505 Next, you need to put the following in your preamble:
1508 \begin_layout LyX-Code
1514 \begin_layout LyX-Code
1520 \begin_layout LyX-Code
1526 \begin_layout LyX-Code
1532 \begin_layout LyX-Code
1538 \begin_layout LyX-Code
1544 \begin_layout LyX-Code
1550 \begin_layout Standard
1551 This sets things up for Avery label sheets, stock #5360.
1552 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1555 \begin_inset Flex Code
1558 \begin_layout Plain Layout
1567 \begin_inset Flex Code
1570 \begin_layout Plain Layout
1578 around each label text.
1579 This and other special features of
1580 \begin_inset Flex Code
1583 \begin_layout Plain Layout
1589 are explained in its documentation.
1592 \begin_layout Standard
1593 Someday, someone may write a \SpecialChar LyX
1594 layout file to support this package directly.
1595 Maybe that someone is you.
1598 \begin_layout Subsubsection
1599 Example #3: Paragraph Indentation
1602 \begin_layout Standard
1603 Americans are trained to indent the first line of
1608 As with all of their other weird quirks, most Americans will whine and
1609 moan until they can have their way and indent the first line of all paragraphs.
1618 \begin_layout Standard
1619 Of course, this behavior isn't standard typography.
1620 In books, you typically only indent the first line of a paragraph
1624 it follows another one.
1625 The idea behind indenting the first line of a paragraph is to distinguish
1626 neighboring paragraphs from one another.
1627 If there is no previous paragraph—for example, if it follows a figure or
1628 is the first paragraph in a section—then there is no need for indentation.
1632 \begin_layout Standard
1633 If you're a typical American (we're still joking!), though, you don't care
1634 about such esoteric things; you want your indentation! Add this to the
1638 \begin_layout LyX-Code
1641 usepackage{indentfirst}
1644 \begin_layout Standard
1645 If your \SpecialChar TeX
1646 distribution isn't braindead, you'll have this package, and all
1647 of your paragraphs will get the indentation the Founding Fathers intended
1651 \begin_layout Subsubsection
1652 Example #4: This Document
1655 \begin_layout Standard
1656 You can also check out the preamble of this document to get an idea of some
1657 of the advanced things you can do.
1660 \begin_layout Section
1662 and \SpecialChar LaTeX
1666 \begin_layout Standard
1667 When \SpecialChar LyX
1668 calls \SpecialChar LaTeX
1669 , it tells \SpecialChar LaTeX
1670 to blithely ignore any errors and keep going.
1671 It then uses the logfile from the \SpecialChar LaTeX
1672 run to do a post-mortem.
1673 After analyzing the logfile, \SpecialChar LyX
1674 displays a dialog listing the errors.
1675 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1677 where the error occurred.
1681 \begin_layout Plain Layout
1683 Analyzing the logfile is a tough job, and \SpecialChar LyX
1684 doesn't always go to the right
1686 There are also cases where \SpecialChar LaTeX
1687 reports the error on one line, but the actual
1689 This is not unlike forgetting a closing brace in a program: You'll get
1690 an error, but only later.
1698 \begin_layout Standard
1699 Some folks also like to look at the log file directly: It is available from
1701 \begin_inset Flex Noun
1704 \begin_layout Plain Layout
1705 Document\SpecialChar menuseparator
1707 \begin_inset space ~
1716 There are some fairly common error messages and warnings.
1717 We'll cover those here.
1718 You should look at a good \SpecialChar LaTeX
1719 book for a complete listing.
1722 \begin_layout Itemize
1723 \begin_inset Flex Code
1726 \begin_layout Plain Layout
1733 \begin_inset Newline newline
1736 Anything beginning with these words is a warning message for the purpose
1738 \begin_inset Quotes eld
1742 \begin_inset Quotes erd
1745 the \SpecialChar LaTeX
1747 You'll get messages like this if you added or changed cross-references
1748 or bibliography entries, in which case, \SpecialChar LaTeX
1749 is trying to tell you that you
1750 need to make another run.
1751 You can by-and-large ignore these.
1754 \begin_layout Itemize
1755 \begin_inset Flex Code
1758 \begin_layout Plain Layout
1765 \begin_inset Newline newline
1768 Another warning message, this time about fonts which \SpecialChar LaTeX
1770 The rest of the message will often say something about a replacement font
1771 that \SpecialChar LaTeX
1773 You can safely ignore these, too.
1776 \begin_layout Itemize
1777 \begin_inset Flex Code
1780 \begin_layout Plain Layout
1789 \begin_inset Newline newline
1799 \change_inserted -712698321 1501222056
1800 It seems to generate at least one of these messages for just about any document
1804 They are warnings about lines that were too long and run past the right
1807 \change_inserted -712698321 1501222913
1808 This happens if \SpecialChar LaTeX
1809 does not find a reasonable way to break the lines (notoriously
1810 often with typewriter font, since this does not allow for automatic break
1815 \change_deleted -712698321 1501221633
1817 \change_inserted -712698321 1501221635
1820 , this is unnoticeable in the final output.
1821 (It can be just a point or two.)
1822 \change_deleted -712698321 1501221644
1823 Or, only one or two characters extend past the margin
1824 \change_inserted -712698321 1501222092
1825 Sometimes, however, the lines run rather visibly into the margin; something
1826 you will not want to have in your final print
1830 \change_deleted -712698321 1501222038
1832 seems to generate at least one of these messages for just about any document
1836 \begin_inset Newline newline
1840 \change_deleted -712698321 1501222960
1841 You can ignore these messages.
1842 Your eyes will tell you if there's a problem with something that's too
1843 wide; just look at the output.
1847 \begin_layout Plain Layout
1848 You can also enable the `draft' option in
1849 \begin_inset Flex Noun
1852 \begin_layout Plain Layout
1853 Document\SpecialChar menuseparator
1859 , and then \SpecialChar LaTeX
1860 will draw a black box in the margin of lines that are overfull.
1866 \change_inserted -712698321 1501223436
1867 There are several global ways to try to minimize the overfull lines.
1870 Enable micro-typographic extensions
1874 Document\SpecialChar menuseparator
1875 Settings\SpecialChar menuseparator
1878 might already improve things a lot.
1879 Furthermore, \SpecialChar LaTeX
1880 code such as the following in
1882 Document\SpecialChar menuseparator
1883 Settings\SpecialChar menuseparator
1886 usually reduces the overfull lines drastically (we use this in the preamble
1891 \begin_layout LyX-Code
1893 \change_inserted -712698321 1501223447
1897 \begin_inset Newline newline
1903 \begin_inset Newline newline
1908 emergencystretch 1.5em
1909 \begin_inset Newline newline
1917 \begin_layout Standard
1919 \change_inserted -712698321 1501223436
1920 In some cases, however, you eventually have to rewrite the text to get the
1921 line breaking right.
1925 \begin_layout Plain Layout
1927 \change_inserted -712698321 1501223436
1928 For more information, see
1929 \begin_inset Flex URL
1932 \begin_layout Plain Layout
1934 \change_inserted -712698321 1501223436
1936 http://www.tex.ac.uk/FAQ-overfull.html
1949 \begin_layout Standard
1951 \change_inserted -712698321 1501223436
1952 In any case, you should check the respective lines, at least for the final
1953 version of your document.
1954 Your eyes will tell you if there's a problem with something that's too
1959 \begin_layout Plain Layout
1961 \change_inserted -712698321 1501223436
1962 You can also enable the `draft' option in
1963 \begin_inset Flex Noun
1966 \begin_layout Plain Layout
1968 \change_inserted -712698321 1501223436
1969 Document\SpecialChar menuseparator
1975 , and then \SpecialChar LaTeX
1976 will draw a black box in the margin of lines that are overfull.
1985 \begin_layout Itemize
1986 \begin_inset Flex Code
1989 \begin_layout Plain Layout
1998 \begin_inset Newline newline
2001 Not quite as common as its cousin.
2003 \change_inserted -712698321 1501223875
2004 This happens again if
2008 \change_inserted -712698321 1501223913
2009 does not find a reasonable break point and consequently generates too loose
2012 \change_deleted -712698321 1501223919
2013 seems to like to print lines that are a bit too wide as opposed to ones
2014 that are a bit too narrow.
2015 We have no idea why.
2016 \change_inserted -712698321 1501223940
2017 As with the overfull lines, you should check if this is a visible problem.
2022 \begin_layout Itemize
2023 \begin_inset Flex Code
2026 \begin_layout Plain Layout
2035 \begin_inset Flex Code
2038 \begin_layout Plain Layout
2047 \begin_inset Newline newline
2050 Warnings about troubles breaking the page.
2051 Once again, just look at the output.
2052 Your eyes will tell you where something has gone wrong.
2055 \begin_layout Itemize
2056 \begin_inset Flex Code
2059 \begin_layout Plain Layout
2061 \begin_inset Quotes els
2065 \begin_inset Quotes ers
2074 \begin_inset Newline newline
2078 \begin_inset Quotes eld
2082 \begin_inset Quotes erd
2085 isn't installed on this system.
2086 This usually appears because some package your document needs isn't installed.
2087 If you didn't touch the preamble or didn't use the
2088 \begin_inset Flex Code
2091 \begin_layout Plain Layout
2099 command, then one of the packages \SpecialChar LyX
2100 tried to load is missing.
2102 \begin_inset Flex Noun
2105 \begin_layout Plain Layout
2106 Help\SpecialChar menuseparator
2113 to get a list of packages that \SpecialChar LyX
2115 This file is updated whenever you reconfigure \SpecialChar LyX
2117 \begin_inset Flex Noun
2120 \begin_layout Plain Layout
2121 Tools\SpecialChar menuseparator
2127 ) and tells you which packages have been detected and what they do.
2128 \begin_inset Newline newline
2132 \begin_inset Flex Code
2135 \begin_layout Plain Layout
2143 command and the package in question isn't installed, then you'll need to
2144 install it yourself.
2147 \begin_layout Itemize
2148 \begin_inset Flex Code
2151 \begin_layout Plain Layout
2152 LaTeX Error: Unknown option
2158 \begin_inset Newline newline
2161 Error messages beginning with this are trying to tell you that you specified
2162 a bad or undefined option to a package.
2163 Check the package's documentation.
2166 \begin_layout Itemize
2167 \begin_inset Flex Code
2170 \begin_layout Plain Layout
2171 Undefined control sequence
2177 \begin_inset Newline newline
2180 If you've inserted \SpecialChar LaTeX
2181 code into your document, but made a typo, you'll get
2183 You may have forgotten to load a package.
2184 In any case, this error message usually means that you used an undefined
2189 \begin_layout Standard
2190 There are other error and warning messages.
2191 Some are self-explanatory.
2192 These are usually \SpecialChar LaTeX
2194 Others are downright cryptic.
2195 These are usually \SpecialChar TeX
2196 error messages, and we really have
2200 what they mean or how to decipher them.
2204 \begin_layout Standard
2205 There's a general sequence you should follow if you get error messages:
2208 \begin_layout Enumerate
2209 Look at the \SpecialChar LaTeX
2210 code you inserted for typos.
2213 \begin_layout Enumerate
2214 If there are no typos, check that you used the command(s) correctly.
2217 \begin_layout Enumerate
2218 If you get a bunch of error boxes piled up at the very top of the document—and
2219 especially if you see a
2220 \begin_inset Quotes eld
2224 \begin_inset Flex Code
2227 \begin_layout Plain Layout
2236 \begin_inset Quotes erd
2239 error—it means that there are errors in the preamble.
2240 Start debugging your preamble.
2243 \begin_layout Enumerate
2244 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2246 document, the first suspect is your \SpecialChar LaTeX
2247 distribution itself.
2248 Check for missing packages and install them.
2251 \begin_layout Enumerate
2252 Okay, so there are no missing packages.
2253 Did you use any of the fine-tuning options in \SpecialChar LyX
2254 ? Specifically, did you
2258 any of them, like trying to manually insert lots of
2259 \begin_inset Flex Code
2262 \begin_layout Plain Layout
2264 \begin_inset space ~
2273 \begin_inset Flex Code
2276 \begin_layout Plain Layout
2283 \begin_inset Flex Code
2286 \begin_layout Plain Layout
2292 ? Did you try to kludge something together with these instead of using the
2293 appropriate paragraph environment?
2296 \begin_layout Enumerate
2297 All right, you didn't use any of the fine-tuning options, you played by
2299 Did you try to pull a fancy maneuver? Did you do something funky inside
2300 a table or an equation, like inserting a graphic into a table cell?
2303 \begin_layout Enumerate
2304 Do you have long sections of text where \SpecialChar LaTeX
2305 cannot find a place to break a
2306 line? By default, \SpecialChar LaTeX
2307 is rather strict about how much extra inter-word spacing
2308 it will add in order to break a line.
2309 Preferably, you should rework the paragraph to avoid the problem.
2312 \begin_layout Enumerate
2313 Did you go overboard with the nesting? \SpecialChar LyX
2314 (currently) doesn't check to make
2315 sure you're in the limits for nesting environments.
2316 If you nested a bunch of environments to the
2317 \begin_inset Formula $17^{\mathrm{th}}$
2320 level, that's the problem.
2321 (The limit in \SpecialChar LaTeX
2325 \begin_layout Enumerate
2326 Okay, you didn't get any error messages, but your output looks awful.
2327 If you have a table or figure that's too wide or long for the page, you
2332 \begin_layout Enumerate
2333 rescale the figure so it fits.
2336 \begin_layout Enumerate
2337 trim down the table so it fits.
2341 \begin_layout Enumerate
2342 If something else is wrong with the output, and you didn't try to pull anything
2343 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2346 \begin_layout Standard
2347 If all this doesn't help—well, then
2351 you might have found a bug in \SpecialChar LyX
2356 \begin_layout Chapter
2360 \begin_layout Section
2361 Customizing Bibliographies with Bib\SpecialChar TeX
2365 \begin_layout Standard
2366 The most basic information about how to use Bib\SpecialChar TeX
2371 with \SpecialChar LyX
2372 is contained in the section
2374 Bibliography databases
2381 The following subsections explain special bibliography features supported
2386 \begin_layout Subsection
2387 Alternative Citation Styles
2390 \begin_layout Standard
2391 Standard Bib\SpecialChar TeX
2393 \begin_inset space \thinspace{}
2397 \begin_inset space \space{}
2401 \begin_inset Quotes eld
2405 \begin_inset Quotes erd
2408 ) to refer to a cited work.
2409 However, in many scientific disciplines, other citation styles are in use.
2410 The most common one is the author-year style (e.
2411 \begin_inset space \thinspace{}
2415 \begin_inset space \space{}
2419 \begin_inset Quotes eld
2423 \begin_inset Quotes erd
2428 supports three packages that provide this style,
2429 \begin_inset Flex Code
2432 \begin_layout Plain Layout
2439 \begin_inset Flex Code
2442 \begin_layout Plain Layout
2449 \begin_inset Flex Code
2452 \begin_layout Plain Layout
2459 Each of these packages has their pros and cons, which cannot be listed
2461 If you only want to have simple author-year (or author-numerical) style,
2462 or if you want to use one of the countless style files for
2463 \begin_inset Flex Code
2466 \begin_layout Plain Layout
2472 , then the established
2473 \begin_inset Flex Code
2476 \begin_layout Plain Layout
2482 package is probably your choice.
2483 If you look for specific citation styles common in law studies, you might
2485 \begin_inset Flex Code
2488 \begin_layout Plain Layout
2495 If you want to have full control over the formatting or look for advanced
2496 features such as ibidem, footnote citations, full title citations, advanced
2497 date formats (such as 400 BC) or full localization to other languages than
2498 English, you should definitely consider
2499 \begin_inset Flex Code
2502 \begin_layout Plain Layout
2508 , which exceeds all other packages in terms of features, but is also quite
2509 heavy and more resource-hungry.
2512 \begin_layout Standard
2513 The handling of these packages in \SpecialChar LyX
2514 is basically the same.
2516 \begin_inset Flex Noun
2519 \begin_layout Plain Layout
2520 Document\SpecialChar menuseparator
2527 \begin_inset Flex Noun
2530 \begin_layout Plain Layout
2537 \begin_inset Flex Noun
2540 \begin_layout Plain Layout
2547 \begin_inset Flex Noun
2550 \begin_layout Plain Layout
2557 \begin_inset Flex Noun
2560 \begin_layout Plain Layout
2561 Biblatex (Natbib mode)
2567 \begin_inset Flex Noun
2570 \begin_layout Plain Layout
2577 \begin_inset Flex Noun
2580 \begin_layout Plain Layout
2587 \begin_inset space ~
2590 6.5.3 in the User's Guide for more information on these choices).
2591 With all these packages, you will get some extra features in the citation
2592 dialog and you can select the style of the reference (
2593 \begin_inset Quotes eld
2597 \begin_inset Quotes erd
2601 \begin_inset Quotes eld
2605 \begin_inset Quotes erd
2609 \begin_inset Quotes eld
2613 \begin_inset Quotes erd
2617 \begin_inset Quotes eld
2621 \begin_inset Quotes erd
2625 Note that either package needs specifically designed style files.
2626 They all ship their own, but there are lots of additional style files,
2627 and there is even an interactive style file builder
2631 \begin_layout Plain Layout
2633 \begin_inset Flex URL
2636 \begin_layout Plain Layout
2638 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2649 \begin_inset Flex Code
2652 \begin_layout Plain Layout
2661 \begin_layout Subsection
2662 Subdivided Bibliographies
2665 \begin_layout Standard
2666 Sometimes you might need to divide your bibliography into several sections.
2667 If you are for instance a historian, the possibility to separate sources
2668 and scientific works is most likely a
2669 \begin_inset Quotes eld
2673 \begin_inset Quotes erd
2677 Unfortunately, Bib\SpecialChar TeX
2678 itself does not allow you to do this.
2679 But with the help of some \SpecialChar LaTeX
2680 packages, Bib\SpecialChar TeX
2681 can be extended to fit your needs.
2684 \begin_layout Standard
2686 provides native support for one of these packages,
2694 \begin_layout Plain Layout
2696 \begin_inset Flex URL
2699 \begin_layout Plain Layout
2701 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2711 The advantage of this package (compared to other packages such as
2715 ) is that you don't need to define new citation commands.
2716 Instead, you need to prepare different bibliographic databases which include
2717 the entries for the different sections of the bibliography.
2718 For example: If you want to divide your bibliography into the sections
2720 \begin_inset Quotes eld
2724 \begin_inset Quotes erd
2728 \begin_inset Quotes eld
2732 \begin_inset Quotes erd
2735 , you first need to create two bibliographic databases, e.
2736 \begin_inset space \thinspace{}
2740 \begin_inset space \space{}
2744 \begin_inset Flex Code
2747 \begin_layout Plain Layout
2754 \begin_inset Flex Code
2757 \begin_layout Plain Layout
2767 \begin_layout Standard
2769 \begin_inset Flex Noun
2772 \begin_layout Plain Layout
2773 Document\SpecialChar menuseparator
2780 \begin_inset Flex Noun
2783 \begin_layout Plain Layout
2790 \begin_inset Flex Noun
2793 \begin_layout Plain Layout
2794 Subdivided bibliography
2800 Now you can insert multiple Bib\SpecialChar TeX
2801 bibliographies, one for each section of
2803 Returning to our example: Insert the Bib\SpecialChar TeX
2805 \begin_inset Flex Code
2808 \begin_layout Plain Layout
2814 and a second one for the database
2815 \begin_inset Flex Code
2818 \begin_layout Plain Layout
2825 You are free to use the same or different styles for each section.
2826 Additionally, you can choose if the bibliography section should contain
2828 \begin_inset Quotes eld
2831 all cited references
2832 \begin_inset Quotes erd
2835 of the specified database(s) (which is the default),
2836 \begin_inset Quotes eld
2839 all uncited references
2840 \begin_inset Quotes erd
2844 \begin_inset Quotes eld
2848 \begin_inset Quotes erd
2852 This might be useful if you would like to separate your bibliography into
2854 \begin_inset Quotes eld
2858 \begin_inset Quotes erd
2862 \begin_inset Quotes eld
2866 \begin_inset Quotes erd
2870 \begin_inset Quotes eld
2874 \begin_inset Quotes erd
2878 The titles for the sections can be added as ordinary sections or subsections.
2880 \begin_inset Flex Code
2883 \begin_layout Plain Layout
2889 removes the bibliography title, you have to manually re-add that, too (as
2890 a chapter* or section*, for instance).
2893 \begin_layout Standard
2898 , the procedure is a bit different.
2907 , the aforementioned
2908 \begin_inset Flex Noun
2911 \begin_layout Plain Layout
2912 Subdivided bibliography
2917 option is disabled if you use
2926 provides its own means to generate subdivided bibliographies.
2927 You can either add keywords to bibliography entries via the
2928 \begin_inset Flex Code
2931 \begin_layout Plain Layout
2937 entry option and then filter bibliography sections by keyword (by adding
2939 \begin_inset Flex Code
2942 \begin_layout Plain Layout
2949 \begin_inset Flex Noun
2952 \begin_layout Plain Layout
2958 field of the dialog that opens if you right-click on the
2959 \begin_inset Flex Noun
2962 \begin_layout Plain Layout
2963 Biblatex Generated Bibliography
2968 button), or you can filter by entry types (such as
2977 \begin_inset space \thinspace{}
2982 \begin_inset Flex Code
2985 \begin_layout Plain Layout
2992 \begin_inset Flex Code
2995 \begin_layout Plain Layout
3002 \begin_inset Flex Noun
3005 \begin_layout Plain Layout
3011 field, or you can create so-called
3012 \begin_inset Quotes eld
3015 Bibliography Categories
3016 \begin_inset Quotes erd
3019 to which you can assign individual entries.
3020 Please refer to the Biblatex manual, section
3022 Subdivided Bibliographies
3027 \begin_layout Subsection
3028 Multiple Bibliographies
3029 \change_inserted -712698321 1501227893
3031 \begin_inset CommandInset label
3033 name "subsec:Multiple-Bibliographies"
3042 \begin_layout Standard
3043 Multiple bibliographies, e.
3044 \begin_inset space \thinspace{}
3048 \begin_inset space \space{}
3051 a bibliography for each part, chapter, section, subsection or child (sub-documen
3052 t) of the document, are also supported by \SpecialChar LyX
3054 In order to enable it, go to
3055 \begin_inset Flex Noun
3058 \begin_layout Plain Layout
3059 Document\SpecialChar menuseparator
3060 Settings\SpecialChar menuseparator
3066 and select the relevant unit (e.
3067 \begin_inset space \thinspace{}
3071 \begin_inset Quotes eld
3075 \begin_inset Quotes erd
3079 \begin_inset Flex Noun
3082 \begin_layout Plain Layout
3083 Multiple Bibliographies
3089 Then add a Bib(la)\SpecialChar TeX
3090 bibliography to each unit (e.
3091 \begin_inset space \thinspace{}
3094 g., section) of your document.
3095 In the output, a separate bibliography, containing only the references
3096 done in the current unit is generated.
3099 \begin_layout Standard
3100 If you use Bib\SpecialChar TeX
3102 \begin_inset Flex Code
3105 \begin_layout Plain Layout
3112 \change_deleted -712698321 1501067466
3114 \change_inserted -712698321 1501067466
3118 \begin_inset Flex Code
3121 \begin_layout Plain Layout
3127 package is used to create multiple bibliographies.
3128 The former package is used if you select
3129 \begin_inset Quotes eld
3133 \begin_inset Quotes erd
3141 \begin_inset Flex Noun
3144 \begin_layout Plain Layout
3145 Sectioned Bibliography
3152 \begin_inset Flex Code
3155 \begin_layout Plain Layout
3165 \begin_layout Plain Layout
3166 An alternative approach, if you are willing to use some
3167 \begin_inset Flex Noun
3170 \begin_layout Plain Layout
3178 \begin_inset space ~
3182 \begin_inset CommandInset ref
3184 reference "sec:Inserting-TeX-Code"
3189 \begin_inset Flex Code
3192 \begin_layout Plain Layout
3204 \begin_inset Flex Code
3207 \begin_layout Plain Layout
3213 is used, \SpecialChar LyX
3214 encloses the specified units in
3215 \begin_inset Flex Code
3218 \begin_layout Plain Layout
3225 \begin_inset Flex Code
3228 \begin_layout Plain Layout
3237 \begin_inset Flex Code
3240 \begin_layout Plain Layout
3248 in order to create the units.
3249 Note that this approach has some limitations.
3250 First, every citation reference has to be inside some
3251 \begin_inset Flex Code
3254 \begin_layout Plain Layout
3261 So citations outside a defined unit (e.
3262 \begin_inset space \thinspace{}
3265 g., before the first section if you use
3266 \begin_inset Quotes eld
3270 \begin_inset Quotes erd
3274 \begin_inset Quotes eld
3278 \begin_inset Quotes erd
3282 You can also create your own units by entering
3283 \begin_inset Flex Code
3286 \begin_layout Plain Layout
3295 \begin_inset Flex Code
3298 \begin_layout Plain Layout
3307 code (for instance to work around the mentioned limitation).
3309 \begin_inset Flex Code
3312 \begin_layout Plain Layout
3319 A second limitation is that
3320 \begin_inset Flex Code
3323 \begin_layout Plain Layout
3329 always processes all references of a bibliography database, even if they
3331 This can result in odd labels (e.
3332 \begin_inset space \thinspace{}
3337 \begin_inset Quotes eld
3341 \begin_inset Quotes erd
3344 if two works of this author from 2014 are in the database, even if only
3348 \begin_layout Standard
3354 \begin_inset Flex Code
3357 \begin_layout Plain Layout
3363 option is used instead.
3364 If you need specific units, you can start them with the \SpecialChar TeX
3366 \begin_inset Flex Code
3369 \begin_layout Plain Layout
3378 \begin_inset Flex Code
3381 \begin_layout Plain Layout
3390 If you also want to control the end of the unit, use the environment
3391 \begin_inset Flex Code
3394 \begin_layout Plain Layout
3404 \begin_inset Flex Code
3407 \begin_layout Plain Layout
3417 \begin_inset Flex Code
3420 \begin_layout Plain Layout
3427 In addition to the individual bibliography of the current unit,
3431 also provides an easy way to output all bibliographies, subsequently, at
3433 \begin_inset space \thinspace{}
3436 g., at the end of the document).
3438 \begin_inset Quotes eld
3442 \begin_inset Quotes erd
3445 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3451 manual for more information on this topic.
3454 \begin_layout Section
3458 \begin_layout Subsection
3462 \begin_layout Standard
3463 When you are working on a large file with many sections, it is often convenient
3464 to break up the document into several files, or perhaps you have something
3465 where a table may change from time to time, but the preceding text does
3467 In these cases, you should seriously consider using multipart documents.
3468 For example, scientific papers often have five major sections: the introduction
3469 , observations, results, discussion, and conclusion.
3470 Each of these could be its own separate \SpecialChar LyX
3472 \begin_inset Quotes eld
3476 \begin_inset Quotes erd
3479 file which contains the title, authors, abstract, references, etc., plus
3480 the five included files.
3481 It is important to note that each of these files is a full \SpecialChar LyX
3483 can be formatted and printed on its own, as well as included in a master
3485 Each of these files must have the same document class, however—don't attempt
3486 to mix book classes with article classes.
3487 You may also include \SpecialChar LaTeX
3488 files; however, these files must not have their own
3490 \begin_inset space \thinspace{}
3494 \begin_inset space \space{}
3497 everything up to and including the
3498 \begin_inset Flex Code
3501 \begin_layout Plain Layout
3510 \begin_inset Flex Code
3513 \begin_layout Plain Layout
3521 line must be deleted) or else errors will be generated when you try to
3525 \begin_layout Standard
3527 allows you to include files quite easily with
3528 \begin_inset Flex Noun
3531 \begin_layout Plain Layout
3532 Insert\SpecialChar menuseparator
3534 \change_deleted -712698321 1501147443
3536 \change_inserted -712698321 1501147443
3540 \begin_inset space ~
3549 When you click on this selection a small box is inserted into the file
3550 at the current cursor location.
3551 Clicking on the box raises a dialog which allows you to select the file
3552 to be included, and the method of its inclusion.
3556 \begin_layout Standard
3557 The file selection box should by now be obvious.
3558 The three inclusion methods are
3559 \begin_inset Quotes eld
3563 \begin_inset Quotes erd
3567 \begin_inset Quotes eld
3571 \begin_inset Quotes erd
3575 \begin_inset Quotes eld
3579 \begin_inset Quotes erd
3584 \change_deleted -712698321 1501225702
3586 \change_inserted -712698321 1501225703
3590 \begin_inset Quotes eld
3594 \begin_inset Quotes erd
3598 \begin_inset Quotes eld
3602 \begin_inset Quotes erd
3606 \change_deleted -712698321 1501225710
3607 is really only meaningful to \SpecialChar LaTeX
3609 \change_inserted -712698321 1501225747
3610 are similar in many ways, but there are also some notable differences:
3613 \begin_layout Enumerate
3615 \change_deleted -712698321 1501225754
3616 , but the practical difference is that f
3617 \change_inserted -712698321 1501225754
3621 \begin_inset Quotes eld
3625 \begin_inset Quotes erd
3628 are typeset beginning on a new page, while files that are
3629 \begin_inset Quotes eld
3633 \begin_inset Quotes erd
3636 are typeset starting on the current page.
3637 \change_inserted -712698321 1501225760
3641 \begin_layout Enumerate
3643 \change_inserted -712698321 1501225830
3644 \begin_inset Quotes eld
3648 \begin_inset Quotes erd
3651 files cannot themselves
3652 \begin_inset Quotes eld
3656 \begin_inset Quotes erd
3660 \begin_inset Quotes eld
3664 \begin_inset Quotes erd
3669 \begin_inset Quotes eld
3673 \begin_inset Quotes erd
3676 , on the other hand, infinite sub-inputting is possible.
3679 \begin_layout Enumerate
3681 \change_inserted -712698321 1501226017
3682 \begin_inset Quotes eld
3686 \begin_inset Quotes erd
3689 allow for the output of only selected
3690 \begin_inset Quotes eld
3694 \begin_inset Quotes erd
3697 files, while maintaining the actual counters (pagination etc.) and references
3698 (please refer to the section
3701 \begin_inset space ~
3709 \begin_inset space ~
3714 manual for details).
3719 \begin_layout Standard
3721 \change_inserted -712698321 1501225947
3723 \begin_inset Quotes eld
3727 \begin_inset Quotes erd
3730 is the preferred method for chapters that are outsourced to child documents,
3732 \begin_inset Quotes eld
3736 \begin_inset Quotes erd
3739 is more suitable for arbitrary file inheritance.
3742 \begin_layout Standard
3744 \change_deleted -712698321 1501226562
3745 Generally, the master file is converted into a full \SpecialChar LaTeX
3746 file before typesetting,
3747 while the included files are converted to \SpecialChar LaTeX
3748 files that do not have all the
3749 preamble information.
3754 \begin_layout Standard
3756 \begin_inset Quotes eld
3760 \begin_inset Quotes erd
3763 included file allows you to include a file typeset exactly as it appears
3765 \begin_inset space \thinspace{}
3769 \begin_inset space \space{}
3773 \begin_inset Flex Code
3776 \begin_layout Plain Layout
3782 mode, with the characters set in a fixed-width typewriter font.
3783 Normally, spaces in this file are invisible, though two consecutive spaces
3784 are conserved, unlike \SpecialChar LyX
3785 's normal treatment of spaces.
3786 However, setting the
3787 \begin_inset Flex Noun
3790 \begin_layout Plain Layout
3792 \begin_inset space ~
3796 \begin_inset space ~
3800 \begin_inset space ~
3808 checkbox typesets a mark to unambiguously define the presence of a space.
3810 \change_inserted -712698321 1501226563
3814 \begin_layout Standard
3816 \change_inserted -712698321 1501226564
3817 Generally, the master file is converted into a full \SpecialChar LaTeX
3818 file before typesetting,
3819 while the included files are converted to \SpecialChar LaTeX
3820 files that do not have all the
3821 preamble information.
3826 \begin_layout Subsection
3827 Cross-References Between Files
3830 \begin_layout Standard
3831 \begin_inset Box Shadowbox
3841 height_special "totalheight"
3846 backgroundcolor "none"
3849 \begin_layout Plain Layout
3850 This section is somewhat out of date.
3851 Need to describe default master documents and how children are opened when
3861 \begin_layout Standard
3862 It is possible to set up cross-references between the different files.
3863 First, open all the files in question: let's call them A and B in a two
3864 file example, where B is included in A.
3865 Let's say you insert a label in A, then want to reference it in B.
3866 Open the cross-reference dialog whilst in document B, and you can select
3868 \begin_inset Quotes eld
3872 \begin_inset Quotes erd
3878 \begin_layout Subsection
3879 Bibliography Lists in all Subdocuments
3882 \begin_layout Standard
3884 \change_deleted -712698321 1501227275
3885 \begin_inset Box Frameless
3895 height_special "totalheight"
3900 backgroundcolor "none"
3903 \begin_layout Plain Layout
3904 This section also needs updating.
3905 There is now material about this on the wiki, and it could be copied here.
3915 \begin_layout Standard
3917 \change_inserted -712698321 1501226979
3918 If you work with child documents, you might want to have only one main bibliogra
3919 phy at the end, but still be able to have a selected bibliography for the
3920 child if you output it on its own.
3921 Here is how to achieve this.
3924 \begin_layout Standard
3926 \change_inserted -712698321 1501227105
3927 For the main document, you just insert a bibliography inset at the place
3928 where the main bibliography has to appear (within the master file or within
3930 If the bibliography inset is in the master file, the references will be
3931 inherited by all children, so they are available in the citation dialog
3935 \begin_layout Standard
3937 \change_inserted -712698321 1501227910
3938 For child-specific bibliographies, insert bibliography insets within the
3939 child documents, at the place where the bibliography should appear when
3940 the child is compiled separately.
3941 However, the trick is to insert them into a branch (
3943 Insert\SpecialChar menuseparator
3944 Branch\SpecialChar menuseparator
3945 Insert New Branch...
3948 \begin_inset space \thinspace{}
3953 \begin_inset Quotes eld
3957 \begin_inset Quotes erd
3961 Within the children, activate the branch (
3963 Document\SpecialChar menuseparator
3964 Settings...\SpecialChar menuseparator
3968 Within the master, deactivate the branch (
3970 Document\SpecialChar menuseparator
3971 Settings...\SpecialChar menuseparator
3975 Now the child's bibliography will be ignored by the master, but considered
3979 \begin_layout Standard
3981 \change_inserted -712698321 1501228082
3982 If you need multiple bibliographies (e.
3983 \begin_inset space \thinspace{}
3986 g., one per child in the
3990 ), please refer to sec.
3991 \begin_inset space ~
3995 \begin_inset CommandInset ref
3997 reference "subsec:Multiple-Bibliographies"
4006 \begin_layout Standard
4008 \change_deleted -712698321 1501227257
4009 Copy the bibliography list with all entries to all subdocuments and transform
4011 This way \SpecialChar LyX
4013 \begin_inset Flex Code
4016 \begin_layout Plain Layout
4022 -files and you can easily insert references without making the bibliography
4026 \begin_layout Standard
4028 \change_deleted -712698321 1501227257
4029 As the bibliography list is in a comment, \SpecialChar LaTeX
4030 won't use it and the references
4031 will look like this: [?], instead of like this: [1].
4032 One solution is to use the \SpecialChar LaTeX
4034 \begin_inset Flex Code
4037 \begin_layout Plain Layout
4043 that will only include comments by processing the files separately.
4044 To do this, add in the \SpecialChar LaTeX
4045 preamble of every subdocument the following:
4048 \begin_layout LyX-Code
4050 \change_deleted -712698321 1501227257
4056 \begin_layout LyX-Code
4058 \change_deleted -712698321 1501227257
4061 includecomment{comment}
4064 \begin_layout Standard
4066 \change_deleted -712698321 1501227257
4068 \begin_inset Flex URL
4071 \begin_layout Plain Layout
4073 http://wiki.lyx.org/FAQ/Unsorted#toc31
4083 \begin_layout Section
4088 \begin_layout Standard
4089 Users sometimes need to be able to
4090 \begin_inset Quotes eld
4094 \begin_inset Quotes erd
4098 file together with all the images (and other files) on which it depends,
4099 either for sending to a publisher or for sharing with a co-author.
4101 2.0 includes a Python script (
4102 \begin_inset Flex Code
4105 \begin_layout Plain Layout
4111 ) that automates this process.
4112 To use it, you must have either the
4113 \begin_inset Flex Code
4116 \begin_layout Plain Layout
4123 \begin_inset Flex Code
4126 \begin_layout Plain Layout
4132 python modules installed on your system.
4133 By default, the script prefers the
4134 \begin_inset Flex Code
4137 \begin_layout Plain Layout
4144 \begin_inset Flex Code
4147 \begin_layout Plain Layout
4153 format on Unix-like systems and the
4154 \begin_inset Flex Code
4157 \begin_layout Plain Layout
4166 \begin_layout Standard
4168 's configuration process will set the script up to export a `\SpecialChar LyX
4170 and this format will then be available under
4171 \begin_inset Flex Code
4174 \begin_layout Plain Layout
4175 File\SpecialChar menuseparator
4184 \begin_layout Standard
4185 Independently of the platform, the generation of a particular archive format
4186 can be forced by adding either the
4187 \begin_inset Flex Code
4190 \begin_layout Plain Layout
4197 \begin_inset Flex Code
4200 \begin_layout Plain Layout
4207 \begin_inset Flex Code
4210 \begin_layout Plain Layout
4217 \begin_inset Flex Code
4220 \begin_layout Plain Layout
4226 format) switch to the
4227 \begin_inset Flex Code
4230 \begin_layout Plain Layout
4232 \SpecialChar menuseparator
4240 \begin_inset Flex Code
4243 \begin_layout Plain Layout
4244 Tools\SpecialChar menuseparator
4245 Preferences\SpecialChar menuseparator
4246 File Handling\SpecialChar menuseparator
4253 (Make sure you add the switch after the script name, not before it.)
4256 \begin_layout Section
4257 Fancy Headers and Footers
4260 \begin_layout Standard
4261 The default page layout is rather plain; for an
4262 \begin_inset Flex Code
4265 \begin_layout Plain Layout
4271 document class, all you get is a centered page number at the bottom of
4273 This document uses KOMA-script's book class, so it appears to be a bit
4275 But to really put on a show, you need to set the document page style to
4277 \begin_inset Quotes eld
4281 \begin_inset Quotes erd
4284 , as mentioned in the
4289 This section describes the \SpecialChar LaTeX
4290 code you need to insert in your \SpecialChar LaTeX
4292 order to get the desired effects.
4295 \begin_layout Standard
4296 For more information on fancy headers, see the
4297 \begin_inset Flex Code
4300 \begin_layout Plain Layout
4306 package documentation.
4308 \begin_inset Flex URL
4311 \begin_layout Plain Layout
4313 http://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4321 \begin_layout Standard
4322 The page header is divided into three fields, not surprisingly labeled
4323 \begin_inset Quotes eld
4327 \begin_inset Quotes erd
4331 \begin_inset Quotes eld
4335 \begin_inset Quotes erd
4339 \begin_inset Quotes eld
4343 \begin_inset Quotes erd
4347 The footer is also divided into these three fields.
4348 The \SpecialChar LaTeX
4349 commands to set these fields in the simplest manner are
4350 \begin_inset Flex Code
4353 \begin_layout Plain Layout
4362 \begin_inset Flex Code
4365 \begin_layout Plain Layout
4374 \begin_inset Flex Code
4377 \begin_layout Plain Layout
4386 \begin_inset Flex Code
4389 \begin_layout Plain Layout
4398 Suppose you wish to put your name in the upper left hand corner of each
4400 Simply insert the following command in the preamble:
4403 \begin_layout Standard
4412 \begin_layout Standard
4413 You will now see your name in the upper left.
4414 If a field has a default entry that you would like to get rid of (often
4415 the page number appears in the central footer) simply include a command
4416 with a blank argument, e.
4417 \begin_inset space \thinspace{}
4423 \begin_layout Standard
4431 \begin_layout Standard
4432 Let's get really fancy: lets put the section number with the word
4433 \begin_inset Quotes eld
4437 \begin_inset Quotes erd
4441 \begin_inset space \thinspace{}
4445 \begin_inset space \space{}
4448 Section 3) in the upper left, the page number (e.
4449 \begin_inset space \thinspace{}
4453 \begin_inset space \space{}
4456 Page 4) in the upper right, your name in the lower left, and the date in
4458 The following commands should now appear in the preamble:
4461 \begin_layout Standard
4471 \begin_layout Standard
4479 \begin_layout Standard
4489 \begin_layout Standard
4498 \begin_layout Standard
4506 \begin_layout Standard
4516 \begin_layout Standard
4518 \begin_inset Flex Code
4521 \begin_layout Plain Layout
4530 \begin_inset Flex Code
4533 \begin_layout Plain Layout
4541 access \SpecialChar LaTeX
4542 's section and page counters, and so print out the current section
4545 \begin_inset Flex Code
4548 \begin_layout Plain Layout
4556 simply prints out today's date.
4559 \begin_layout Standard
4560 The thicknesses of the horizontal rules drawn beneath the header and above
4561 the footer can also be modified.
4562 If you don't want one of the rules, set its thickness to 0.
4563 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4569 \begin_inset Flex Code
4572 \begin_layout Plain Layout
4577 headrulewidth}{0.4pt}
4583 \begin_inset Flex Code
4586 \begin_layout Plain Layout
4591 footrulewidth}{0.4pt}
4596 to set the thicknesses.
4599 \begin_layout Standard
4600 You can switch the header/footer settings on and off for individual pages
4602 \begin_inset Flex Code
4605 \begin_layout Plain Layout
4608 thispagestyle{empty}
4614 \begin_inset Flex Code
4617 \begin_layout Plain Layout
4620 thispagestyle{plain}
4626 \begin_inset Flex Code
4629 \begin_layout Plain Layout
4632 thispagestyle{fancy}
4638 Simply insert them in the text on the page you want changed and mark them
4641 In fact, title pages are marked as plain by default, while following pages
4642 are marked fancy when using the global fancy setting.
4645 \begin_layout Standard
4646 As a final example, it is possible to include an image in the header or
4648 Suppose you want to put a company logo in the upper lefthand corner.
4649 You might try something like
4652 \begin_layout Standard
4661 includegraphics{logo.eps}}}
4664 \begin_layout Standard
4666 (you may need to preface this with
4667 \begin_inset Flex Code
4670 \begin_layout Plain Layout
4674 usepackage{graphics}
4679 if you don't include graphics elsewhere in your document).
4682 \begin_layout Section
4683 Itemize Bullet Selection
4684 \begin_inset CommandInset label
4693 \begin_layout Standard
4699 \begin_layout Subsection
4703 \begin_layout Standard
4705 provides 216 bullet shapes that can be accessed from a simple dialog.
4706 Using this dialog you can easily specify what bullet shape to use at each
4707 level of an itemized list.
4708 These settings are document-wide so you won't be able to specify different
4709 sets of bullets for different paragraphs.
4713 \begin_layout Plain Layout
4714 Well, actually you can but you'll have to do it by hand.
4722 \begin_layout Subsection
4726 \begin_layout Standard
4727 Open the dialog by selecting the
4728 \begin_inset Flex Noun
4731 \begin_layout Plain Layout
4732 Document\SpecialChar menuseparator
4738 menu item and then select the
4739 \begin_inset Flex Noun
4742 \begin_layout Plain Layout
4751 \begin_layout Standard
4752 The dialog provides you with a table of bullet shapes.
4753 A column of buttons on the left of the table provides access to the six
4754 different panels of bullet shapes.
4755 The row of buttons across the top is used to select which bullet depth
4757 A text entry under the table shows the currently selected bullet shape's
4759 equivalent and this can be edited if desired.
4760 If you do modify the text you will also need to specify any needed packages
4761 in the \SpecialChar LaTeX
4765 \begin_layout Standard
4766 The six panels are divided up by the packages they require.
4767 The following table shows the mappings from button name to \SpecialChar LaTeX
4771 \begin_layout Standard
4773 \begin_inset Tabular
4774 <lyxtabular version="3" rows="7" columns="2">
4775 <features tabularvalignment="middle">
4776 <column alignment="center" valignment="top" width="0pt">
4777 <column alignment="center" valignment="top" width="0pt">
4779 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4782 \begin_layout Plain Layout
4797 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4800 \begin_layout Plain Layout
4817 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4820 \begin_layout Plain Layout
4835 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4838 \begin_layout Plain Layout
4847 base \SpecialChar LaTeX
4855 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4858 \begin_layout Plain Layout
4873 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4876 \begin_layout Plain Layout
4893 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4896 \begin_layout Plain Layout
4911 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4914 \begin_layout Plain Layout
4931 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4934 \begin_layout Plain Layout
4949 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4952 \begin_layout Plain Layout
4969 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4972 \begin_layout Plain Layout
4987 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4990 \begin_layout Plain Layout
5007 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
5010 \begin_layout Plain Layout
5025 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
5028 \begin_layout Plain Layout
5051 \begin_layout Standard
5053 doesn't stop you using bullets from packages you don't have.
5054 If you get errors from \SpecialChar LaTeX
5055 when you try to view or print the file, then it
5056 is likely you are missing a package.
5060 \begin_layout Plain Layout
5062 doesn't restrict your use since you may be editing locally and exporting
5071 \begin_layout Subsection
5075 \begin_layout Standard
5076 Select which bullet depth you want to change then select the bullet shape
5078 Any changes will not be visible in \SpecialChar LyX
5079 , but are visible when viewing the document.
5082 \begin_layout Standard
5083 You can reset a bullet shape to the default simply by clicking your right
5084 mouse button on the appropriate bullet depth button.
5088 \begin_layout Plain Layout
5093 want to have multiple sets of paragraphs with different sets of bullets
5094 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
5096 The bullet selection dialog can help though because it provides you with
5097 the \SpecialChar LaTeX
5098 code for a wide range of bullet shapes.
5099 To make your own custom paragraphs you have the following options:
5102 \begin_layout Plain Layout
5106 \begin_layout Plain Layout
5122 \begin_layout Plain Layout
5126 \begin_layout Plain Layout
5148 \begin_layout Itemize
5149 Use the \SpecialChar LaTeX
5151 \begin_inset Flex Code
5154 \begin_layout Plain Layout
5162 to specify a new bullet shape for a given depth.
5163 You'll also need to save the current bullet shape so you can restore it
5165 In this itemized list the following \SpecialChar LaTeX
5166 code was used to change the bullet
5167 used for the first depth.
5171 \begin_layout LyX-Code
5181 \begin_layout LyX-Code
5198 \begin_layout Itemize
5199 Note that the itemize depth is specified in Roman numerals as part of the
5209 \begin_layout Itemize
5211 \change_deleted -712698321 1501149643
5215 \begin_layout Plain Layout
5217 \change_deleted -712698321 1501149634
5228 \change_deleted -712698321 1501149636
5237 \change_inserted -712698321 1501149643
5239 \begin_inset Argument item:1
5242 \begin_layout Plain Layout
5244 \change_inserted -712698321 1501149643
5248 \begin_layout Plain Layout
5250 \change_inserted -712698321 1501149643
5272 Specify each individual entry by starting each item with the bullet shape
5274 \change_deleted -712698321 1501149707
5276 \change_inserted -712698321 1501149740
5278 \begin_inset Quotes eld
5282 \begin_inset Quotes erd
5287 Insert\SpecialChar menuseparator
5293 \begin_inset Flex Noun
5296 \begin_layout Plain Layout
5304 For example, this item was started with
5305 \begin_inset Flex Code
5308 \begin_layout Plain Layout
5310 \change_deleted -712698321 1501149692
5320 \change_deleted -712698321 1501149693
5331 \begin_layout Plain Layout
5335 \begin_layout Plain Layout
5351 \begin_layout Plain Layout
5352 You'll also need to revert the labelitem back to its previous setting for
5353 the global bullet shape settings to remain in effect.
5354 The way used here was:
5357 \begin_layout LyX-Code
5372 \begin_layout Chapter
5374 and the World Wide Web
5377 \begin_layout Standard
5379 has long supported the export of documents to various web-friendly formats,
5382 \change_inserted -712698321 1501076595
5385 on 2.0, however, HTML export was always accomplished by the use of external
5390 \begin_layout Plain Layout
5391 For details on the use of external converters with \SpecialChar LyX
5396 section of the Customization manual.
5401 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5403 intermediate format, such as
5404 \begin_inset Flex Code
5407 \begin_layout Plain Layout
5414 \begin_inset Flex Code
5417 \begin_layout Plain Layout
5424 \begin_inset Flex Code
5427 \begin_layout Plain Layout
5433 , relying upon \SpecialChar LyX
5434 to produce the \SpecialChar LaTeX
5435 ; and there is a converter that works directly
5438 \begin_inset Flex Code
5441 \begin_layout Plain Layout
5449 All of these have different advantages and disadvantages.
5453 \begin_layout Standard
5454 The \SpecialChar LaTeX
5455 -based converters have the advantage that, in principle, they know everythin
5456 g about the exported document that \SpecialChar LaTeX
5458 Such converters do not care, for example, if a certain block of code was
5459 produced by \SpecialChar LyX
5460 or was Evil Red Text.
5461 These converters know about
5462 \begin_inset Flex Code
5465 \begin_layout Plain Layout
5471 files, counters, and references, and can often make use of the
5472 \begin_inset Flex Code
5475 \begin_layout Plain Layout
5481 files generated by Bib\SpecialChar TeX
5483 On the other hand, \SpecialChar LaTeX
5484 is a very hard language to parse—it is sometimes said
5485 that only \SpecialChar TeX
5486 itself understands \SpecialChar TeX
5487 —and \SpecialChar LaTeX
5488 -based converters will often choke on
5489 what seem to be quite simple constructs; complex ones can throw them completely
5490 , and as of this writing, for example, the
5494 manual will not export with
5495 \begin_inset Flex Code
5498 \begin_layout Plain Layout
5504 , though the others will.
5505 The other issue concerns how math is handled.
5506 These converters typically convert the formulae into little pictures that
5507 are then linked from the HTML document.
5508 Since these are actually generated by \SpecialChar LaTeX
5509 , they are accurate.
5510 But they do not scale well, and just getting them to look as if they are
5511 actually meant to be in your document—so that the font sizes seem to be
5512 roughly the same—can be a challenge.
5515 \begin_layout Standard
5517 \begin_inset Flex Code
5520 \begin_layout Plain Layout
5528 \begin_inset CommandInset href
5530 name "http://elyxer.nongnu.org/"
5531 target "http://elyxer.nongnu.org/"
5536 ) solves some of these problems.
5537 In particular, the formulae it produces scale perfectly, since it renders
5538 math using a combination of HTML and CSS rather than converting the formulae
5540 But even moderately complex formula are rendered less well than with
5541 \begin_inset Flex Code
5544 \begin_layout Plain Layout
5550 ; this reflects the limitations of HTML.
5554 \begin_layout Plain Layout
5556 \begin_inset Flex Code
5559 \begin_layout Plain Layout
5566 can also use jsMath and MathJax for equations, but this setting is only
5567 available globally and requires one to have access to a server that runs
5573 More importantly (as of version 1.1.1, at least),
5574 \begin_inset Flex Code
5577 \begin_layout Plain Layout
5584 has limited support for math macros and no support for user-defined paragraph
5585 or character styles.
5586 These limitations make
5587 \begin_inset Flex Code
5590 \begin_layout Plain Layout
5597 unsuitable for many of the documents \SpecialChar LyX
5599 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5601 have decided to follow a different path and have made \SpecialChar LyX
5603 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5604 , DocBook, and plaintext.
5607 \begin_layout Standard
5608 As of this writing, XHTML output remains under development and should probably
5610 \begin_inset Quotes eld
5614 \begin_inset Quotes erd
5621 \begin_layout Plain Layout
5623 \begin_inset Flex Code
5626 \begin_layout Plain Layout
5628 \change_inserted -712698321 1501078933
5636 , which can be found in the \SpecialChar LyX
5638 \begin_inset CommandInset href
5640 name "accessed online"
5641 target "http://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5646 , usually contains up-to-date information about the state of XHTML output.
5647 See also the list of XHTML bugs on
5648 \begin_inset CommandInset href
5650 name "the bug tracker"
5651 target "http://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
5661 Still, the developers have chosen this approach because it has several
5662 potential advantages over the other two.
5665 \begin_layout Standard
5666 These advantages are primarily due to the fact that the XHTML output routines,
5667 since they are part of \SpecialChar LyX
5668 , know everything \SpecialChar LyX
5669 knows about the document being
5674 \begin_layout Plain Layout
5675 Another advantage is that, since these routines are internal to \SpecialChar LyX
5677 immune to changes in \SpecialChar LyX
5678 's file format, or to changes in the semantics of
5684 So they know about the table of contents (as displayed in the outline),
5685 about the counters associated with different paragraph styles, and about
5686 user-defined styles.
5687 The XHTML output routines know what \SpecialChar LyX
5688 knows about internationalization,
5689 too, so they will output
5690 \begin_inset Quotes eld
5694 \begin_inset Quotes erd
5698 \begin_inset Quotes eld
5706 \begin_inset Quotes erd
5709 , depending upon the language in effect at the time.
5713 \begin_layout Standard
5714 Quite generally, the output routines know what \SpecialChar LyX
5715 knows about document layout,
5716 that is, about how the document is to be rendered on screen.
5717 We use this information when we output the document as XHTML.
5718 In particular, \SpecialChar LyX
5723 generates CSS style information corresponding to the layout information
5724 it uses to render the document on screen: if section headings are supposed
5725 to be sans-serif and bold as seen in \SpecialChar LyX
5726 , then (by default) they will be sans-seri
5727 f and bold when viewed in a web browser, too.
5728 And this is true not just for pre-defined styles, like Section, but for
5729 any style, including user-defined styles.
5730 Indeed, the XHTML output routines make no distinction between user-defined
5731 paragraph and character styles and \SpecialChar LyX
5732 's own pre-defined styles: in each case,
5733 everything \SpecialChar LyX
5734 knows about the styles is contained in the layout files.
5735 And much the same is true as regards pre-defined textual insets, such as
5736 footnotes, and various custom insets.
5740 \begin_layout Standard
5741 The result is that XHTML output can be customized and extended in exactly
5742 the same way \SpecialChar LaTeX
5743 output can be customized and extended: through layout files
5745 See chapter five of the
5749 manual for the details.
5752 \begin_layout Standard
5753 The remainder of this chapter contains more detailed information on XHTML
5754 output, its limitations, and ways to work around those limitations.
5757 \begin_layout Section
5758 Math Output in XHTML
5761 \begin_layout Standard
5763 offers four choices for how math is rendered.
5764 These have various advantages and disadvantages:
5767 \begin_layout Itemize
5769 \begin_inset Newline newline
5772 MathML is a dialect of XML designed specifically for mathematics on the
5773 web, and it typically renders very well in browsers that support it.
5774 The disadvantage is that not all browsers support MathML, and support is
5775 not complete even in the Gecko-based browsers, such as Firefox.
5776 \begin_inset Newline newline
5780 is unable to render a formula as MathML—for example, if the formula
5782 \begin_inset Flex Code
5785 \begin_layout Plain Layout
5791 package or ERT—then it will instead output the formula as an image.
5795 \begin_layout Itemize
5797 \begin_inset Newline newline
5801 \begin_inset Flex Code
5804 \begin_layout Plain Layout
5810 outputs math as HTML, styled by CSS.
5814 \begin_layout Plain Layout
5816 has borrowed some of the CSS for its HTML output from
5817 \begin_inset Flex Code
5820 \begin_layout Plain Layout
5831 For simple formulae, this can work quite well, though with more complicated
5832 formulae it tends to break down.
5833 Still, this method has the advantage that it is very widely supported and
5834 so it may be appropriate for documents that contain only a little, fairly
5836 \begin_inset Newline newline
5839 If Lyx is unable to render a formula as HTML—for example, if the formula
5841 \begin_inset Flex Code
5844 \begin_layout Plain Layout
5850 package or ERT—then it will instead output the formula as an image.
5854 \begin_layout Itemize
5856 \begin_inset Newline newline
5860 \begin_inset Flex Code
5863 \begin_layout Plain Layout
5870 will output formulae as images, the very same images, in fact, that are
5871 used for instant preview.
5875 \begin_layout Plain Layout
5876 Instant preview does
5880 have to be on for images to be output, however.
5885 The advantage to this method is that the images are simply generated by
5887 , so they are very accurate.
5888 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5889 so they do not scale terribly well, and one cannot copy them, etc.
5891 \change_deleted -712698321 1501075981
5892 (As of this writing, there are also problems about equation numbering.
5894 \begin_inset CommandInset href
5897 target "http://www.lyx.org/trac/ticket/6894"
5905 \begin_inset Newline newline
5908 The size of the images can be controlled by setting the
5909 \begin_inset Quotes eld
5913 \begin_inset Quotes erd
5917 \begin_inset Flex Noun
5920 \begin_layout Plain Layout
5921 Document\SpecialChar menuseparator
5922 Settings\SpecialChar menuseparator
5924 \change_deleted -712698321 1501076136
5926 \change_inserted -712698321 1501076137
5938 \begin_layout Plain Layout
5939 For those who want to know, this controls the resolution of the image in
5940 dots per inch and is based upon a default of 75 dpi.
5946 \begin_inset Newline newline
5950 for some reason fails to create an image for a formula (e.g., if a required
5952 package is not installed), then it will fall back to outputing the raw
5957 \begin_layout Itemize
5960 \begin_inset Newline newline
5963 Finally, \SpecialChar LyX
5964 will happily output math as \SpecialChar LaTeX
5966 As well as being the output of last resort, this method can be used with
5968 \begin_inset CommandInset href
5971 target "http://www.math.union.edu/~dpvc/jsMath/"
5976 , which uses JavaScript to render \SpecialChar LaTeX
5977 embedded in HTML documents.
5979 wraps the \SpecialChar LaTeX
5981 \begin_inset Flex Code
5984 \begin_layout Plain Layout
5990 (for inline formulas) or
5991 \begin_inset Flex Code
5994 \begin_layout Plain Layout
6000 (for displayed formulas) with
6001 \begin_inset Flex Code
6004 \begin_layout Plain Layout
6010 , as is required for jsMath.
6013 \begin_layout Standard
6014 One of these output methods must be selected under
6015 \begin_inset Flex Noun
6018 \begin_layout Plain Layout
6019 Document\SpecialChar menuseparator
6020 Settings\SpecialChar menuseparator
6022 \change_deleted -712698321 1501076586
6024 \change_inserted -712698321 1501076587
6033 By default, \SpecialChar LyX
6035 This is a document-wide setting, therefore.
6038 \begin_layout Standard
6039 Eventually, \SpecialChar LyX
6040 will offer the user the option to select an alternate output
6041 method for a particular inset, say, one that isn't being rendered very
6046 \begin_layout Plain Layout
6047 That said, since \SpecialChar LyX
6048 falls back to images if the inset contains ERT, then one
6049 can force output as an image by putting some harmless ERT into the math,
6051 \begin_inset Formula $a=b\relax$
6062 \begin_layout Section
6063 Bibliography and Citations
6066 \begin_layout Standard
6067 XHTML output fully supports bibliographies and citations.
6071 \begin_layout Standard
6072 Citation labels are generated by the same machinery that generates \SpecialChar LyX
6074 labels, so the labels will look in the output much as they do in \SpecialChar LyX
6077 If you are using numerical citations, then \SpecialChar LyX
6078 will output numerical labels,
6079 such as [1] or [17], rather than simply showing the citation key in square
6080 brackets, as it does on-screen.
6081 If you are using author-year citations, then \SpecialChar LyX
6082 will add lowercase letters
6083 to the years, just as Bib\SpecialChar TeX
6084 does, if it finds more than one citation for
6085 a given author-year combination.
6086 The labels will be printed with the bibliography entries.
6087 Note that there is, at present, no way to customize the appearance of the
6088 labels, for example, to choose between square brackets and parentheses.
6091 \begin_layout Standard
6092 Bibliography output is handled by the same machinery that handles the presentati
6093 on of reference information in the citation dialog, so you will see in the
6094 XHTML output pretty much what you would see if you were to look at a given
6095 entry in the citation dialog.
6096 The formatting can be customized in your layout file or, preferably, in
6102 manual for the details.
6105 \begin_layout Standard
6106 The main defect at present is that cross-referenced information is printed
6107 with every entry with which it is associated.
6108 So you can see things like this:
6113 \begin_inset Quotes eld
6116 Context and Logical Form
6117 \begin_inset Quotes erd
6122 Language in Context: Selected Essays
6124 (Oxford: Oxford University Press, 2007), pp.
6130 \begin_inset Quotes eld
6133 Semantics in Context
6134 \begin_inset Quotes erd
6139 Language in Context: Selected Essays
6141 (Oxford: Oxford University Press, 2007), pp.
6145 \begin_layout Standard
6146 This should be fixed before long.
6149 \begin_layout Standard
6150 There is no support at present for sectioned bibliographies.
6151 If you have multiple bibliographies, then \SpecialChar LyX
6152 will print the same bibliography
6156 \begin_layout Section
6160 \begin_layout Standard
6162 will happily export indexes as XHTML, but with certain limitations at the
6166 \begin_layout Standard
6167 Index export will be most reliable when you do not attempt to use the fancy
6168 constructs that are described in the section on indexes in the
6176 \begin_layout Plain Layout
6177 The main issue here is that \SpecialChar LyX
6178 itself does not really handle these.
6179 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
6185 We'll describe how they are handled using the subsection headings from
6189 \begin_layout Itemize
6190 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
6191 makes an effort to support these,
6192 but the entries must be separated by
6193 \begin_inset Quotes eld
6197 \begin_inset Quotes erd
6200 , that is, there must be spaces around the exclamation point.
6201 This is because it is otherwise too difficult to check for escaped exclamation
6202 points, ones in math, and so forth.
6205 \begin_layout Itemize
6206 Page Ranges: There is no support at all for page ranges, since these make
6207 no sense with XHMTL.
6208 Instead, you will just get two index entries, one at either end.
6211 \begin_layout Itemize
6212 Cross-referencing: There is no support for cross-referencing.
6214 finds an entry containing the
6215 \begin_inset Quotes eld
6218 |see\SpecialChar ldots
6220 \begin_inset Quotes erd
6223 construct, it is just dropped, and the rest is treated as an ordinary index
6227 \begin_layout Itemize
6228 Index Entry Order: \SpecialChar LyX
6229 does support attempts to fix the sorting order.
6230 It will take what is before the first `@' it finds and use that for sorting,
6231 taking what follows the first `@' to be the actual entry.
6232 At present, \SpecialChar LyX
6233 does not check for escaped `@', so do not try to index email
6237 \begin_layout Itemize
6238 Index Entry Layout: You can format entries by using the text style dialog,
6239 or by using any other method available within \SpecialChar LyX
6241 There is no support for constructs like:
6242 \begin_inset Quotes eld
6246 \begin_inset Quotes erd
6250 Indeed, if \SpecialChar LyX
6251 finds a pipe symbol, `|', in an entry, it will delete it and
6252 everything that follows it.
6255 \begin_layout Itemize
6256 Multiple Indexes: There is no support for multiple indexes.
6257 Rather, all index entries will be printed as one large index.
6258 To avoid our printing several versions of the index, we print only the
6259 main index, so make sure you have one.
6262 \begin_layout Section
6263 Nomenclature and Glossary
6266 \begin_layout Standard
6267 There is at present no support for glossaries.
6268 Adding it would be fairly trivial, and welcome.
6271 \begin_layout Chapter
6272 The \SpecialChar LyX
6276 \begin_layout Section
6280 \begin_layout Standard
6281 The `\SpecialChar LyX
6282 server' allows other programs to talk to \SpecialChar LyX
6283 , invoke \SpecialChar LyX
6284 commands, and retrieve
6285 information about the \SpecialChar LyX
6287 This is only intended for advanced users, but they should find it useful.
6288 It is by writing to the \SpecialChar LyX
6289 server, for example, that bibliography managers,
6290 such as JabRef, are able to
6291 \begin_inset Quotes eld
6295 \begin_inset Quotes erd
6298 citations to \SpecialChar LyX
6302 \begin_layout Section
6303 Starting the \SpecialChar LyX
6305 \change_inserted -712698321 1501232552
6307 \begin_inset CommandInset label
6309 name "sec:Starting-the-Server"
6318 \begin_layout Standard
6319 The \SpecialChar LyX
6320 server works through the use of a pair of named pipes.
6321 These are usually located in
6322 \begin_inset Flex Code
6325 \begin_layout Plain Layout
6331 , (except on Windows, where
6335 named pipes are special objects located in
6336 \begin_inset Flex Code
6339 \begin_layout Plain Layout
6351 ) and have the names
6352 \begin_inset Quotes eld
6356 \begin_inset Flex Code
6359 \begin_layout Plain Layout
6366 \begin_inset Quotes erd
6370 \begin_inset Quotes eld
6374 \begin_inset Flex Code
6377 \begin_layout Plain Layout
6384 \begin_inset Quotes erd
6388 External programs write into
6389 \begin_inset Flex Code
6392 \begin_layout Plain Layout
6398 and read back data from
6399 \begin_inset Flex Code
6402 \begin_layout Plain Layout
6409 The stem of the pipe names can be defined in the
6410 \begin_inset Flex Noun
6413 \begin_layout Plain Layout
6414 Tools\SpecialChar menuseparator
6421 \begin_inset Flex Code
6424 \begin_layout Plain Layout
6425 "/home/myhome/lyxpipe"
6431 \begin_inset Flex Code
6434 \begin_layout Plain Layout
6448 on Windows (where any working path instead of lyxpipe can be used, for
6450 \begin_inset Flex Code
6453 \begin_layout Plain Layout
6476 configure this manually in order for the server to start.
6479 \begin_layout Standard
6482 \begin_inset Flex Code
6485 \begin_layout Plain Layout
6492 \begin_inset Flex Code
6495 \begin_layout Plain Layout
6501 ' to create the pipes.
6502 If one of the pipes already exists, \SpecialChar LyX
6503 will assume that another \SpecialChar LyX
6505 is already running and will not start the server.
6506 On POSIX (Unix like) systems, if for some other reason, an unused
6507 \begin_inset Quotes eld
6511 \begin_inset Quotes erd
6514 pipe is left in existence when \SpecialChar LyX
6515 closes, then \SpecialChar LyX
6516 will try to delete it.
6517 If this fails for some reason, you will need to delete the pipes manually
6518 and then restart \SpecialChar LyX
6520 On Windows, pipes are deleted by the OS on program termination or crash,
6522 \begin_inset Quotes eld
6526 \begin_inset Quotes erd
6529 pipes should not be possible.
6532 \begin_layout Standard
6533 To have several \SpecialChar LyX
6534 processes with servers at the same time, you have to use
6535 different configurations, perhaps by using separate user directories, each
6537 \begin_inset Flex Code
6540 \begin_layout Plain Layout
6546 file, for each process.
6549 \begin_layout Standard
6550 If you are developing a client program, you might find it useful to enable
6551 debugging information from the \SpecialChar LyX
6553 Do this by starting \SpecialChar LyX
6555 \begin_inset Flex Code
6558 \begin_layout Plain Layout
6567 \begin_layout Standard
6568 You can find a complete example client written in C++ in the source distribution
6570 \begin_inset Flex Code
6573 \begin_layout Plain Layout
6574 development/lyxserver/server_monitor.cpp
6582 \begin_layout Standard
6583 Another useful tool is the command-line based client found in
6584 \begin_inset Flex Code
6587 \begin_layout Plain Layout
6588 src/client/lyxclient
6596 \begin_layout Section
6597 Normal communication
6600 \begin_layout Standard
6601 To issue a \SpecialChar LyX
6602 call, the client writes a line of ASCII text into the input
6604 This line has the following format:
6621 \begin_layout Description
6622 clientname is a name that the client can choose arbitrarily.
6623 Its only use is that \SpecialChar LyX
6624 will echo it if it sends an answer—so a client can
6625 dispatch results from different requesters.
6628 \begin_layout Description
6629 function is the function you want \SpecialChar LyX
6631 It is the same as the commands you'd use in the minibuffer.
6634 \begin_layout Description
6635 argument is an optional argument which is meaningful only to some functions
6637 \begin_inset Quotes eld
6641 \begin_inset Quotes erd
6644 LFUN will insert the argument as text at the cursor position).
6647 \begin_layout Standard
6648 The answer from \SpecialChar LyX
6649 will arrive in the output pipe and be of the form
6666 \begin_layout Standard
6675 are just echoed from the command request, while
6679 is more or less useful information filled according to how the command
6680 execution worked out.
6681 Some commands, such as
6682 \begin_inset Quotes eld
6686 \begin_inset Quotes erd
6689 , will return information about the internal state of \SpecialChar LyX
6691 return an empty data-response.
6692 This means that the command execution went fine.
6695 \begin_layout Standard
6696 In case of errors, the response from \SpecialChar LyX
6714 \begin_layout Standard
6719 should contain an explanation of why the command failed.
6722 \begin_layout Standard
6726 \begin_layout LyX-Code
6727 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6728 \begin_inset Newline newline
6731 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6732 \begin_inset Newline newline
6735 read a <~/.lyxpipe.out
6736 \begin_inset Newline newline
6742 \begin_layout Subsection
6743 AppleScript (Mac OS X)
6746 \begin_layout Standard
6747 Since \SpecialChar LyX
6748 2.1, \SpecialChar LyX
6749 supports basic interactions with AppleScript for normal communicatio
6750 n through the command run.
6751 This command takes a direct argument (the
6755 to perform) and an optional argument.
6756 It either returns the output of the function or triggers an error with
6757 the error message and code.
6760 \begin_layout Standard
6764 \begin_layout LyX-Code
6765 tell application "\SpecialChar LyX
6769 \begin_layout LyX-Code
6773 \begin_layout LyX-Code
6774 -- Stores the current file name into f
6777 \begin_layout LyX-Code
6778 set f to (run "server-get-filename" with argument "")
6781 \begin_layout LyX-Code
6782 on error the error_message number the error_number
6785 \begin_layout LyX-Code
6786 display dialog "Error: " & the error_number & ".
6790 \begin_layout LyX-Code
6791 & the error_message buttons {"OK"} default button 1
6794 \begin_layout LyX-Code
6798 \begin_layout LyX-Code
6802 \begin_layout Section
6806 \begin_layout Standard
6808 can notify clients of events going on asynchronously.
6809 Currently it will only do this if the user binds a key sequence with the
6811 \begin_inset Quotes eld
6815 \begin_inset Quotes erd
6819 The format of the string \SpecialChar LyX
6820 sends is as follows:
6824 \begin_inset Flex Code
6827 \begin_layout Plain Layout
6838 \begin_layout Standard
6843 is the printed representation of the key sequence that was actually typed
6847 \begin_layout Standard
6848 This mechanism can be used to extend \SpecialChar LyX
6849 's command set and implement macros.
6850 Bind some key sequence to
6851 \begin_inset Quotes eld
6855 \begin_inset Quotes erd
6859 Then start a client that listens on the output pipe, dispatches the command
6860 according to the sequence, and starts a function that may use \SpecialChar LyX
6863 requests to issue a command or a series of commands to \SpecialChar LyX
6867 \begin_layout Section
6868 The simple \SpecialChar LyX
6872 \begin_layout Standard
6874 implements a simple protocol that can be used for session management.
6875 All messages are of the form
6888 \begin_layout Standard
6894 \begin_inset Quotes eld
6898 \begin_inset Quotes erd
6902 \begin_inset Quotes eld
6906 \begin_inset Quotes erd
6911 \begin_inset Quotes eld
6915 \begin_inset Quotes erd
6918 is received from a client, \SpecialChar LyX
6919 will report back to inform the client that
6920 it's listening to it's messages, while
6921 \begin_inset Quotes eld
6925 \begin_inset Quotes erd
6928 sent from \SpecialChar LyX
6929 will inform clients that \SpecialChar LyX
6933 \begin_layout Section
6934 Reverse DVI/PDF search
6937 \begin_layout Standard
6938 Some DVI/PDF viewers
6942 \begin_layout Plain Layout
6943 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6944 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6953 facility (also called
6958 This means that you can tell \SpecialChar LyX
6959 to put the cursor to a specific line in the
6960 document by clicking at the respective position in the DVI/PDF output.
6961 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6963 This is done via the \SpecialChar LyX
6964 server either by using the named pipe (
6968 ), or the UNIX domain socket (
6972 ) that \SpecialChar LyX
6973 creates in its temporary directory (this is the way the
6974 \begin_inset Flex Code
6977 \begin_layout Plain Layout
6983 program communicates with \SpecialChar LyX
6985 In some cases, you need a helper script that mediates between the viewer
6986 and \SpecialChar LyX
6987 , in others, the viewer can communicate with \SpecialChar LyX
6989 This depends on the selected viewer and on your operating system.
6990 The same applies to the way viewers need to be configured and the way the
6991 reverse search is actually performed.
6992 In what follows, we will thus describe how to setup reverse search for
6994 Before we turn to this, though, we will explain what needs to be done generally
6995 to enable reverse search in the DVI/PDF output.
6998 \begin_layout Subsection
7000 \begin_inset CommandInset label
7002 name "subsec:rev-search"
7009 \begin_layout Standard
7010 In most cases \SpecialChar LyX
7011 will do the work for you by
7012 \change_inserted -712698321 1500975045
7013 pressing the following button in the toolbar:
7016 arg "buffer-toggle-output-sync"
7020 Alternatively, you can also enable the feature by checking
7022 Synchronize with Output
7025 \begin_inset Flex Noun
7028 \begin_layout Plain Layout
7030 \change_inserted -712698321 1500975071
7031 Document\SpecialChar menuseparator
7032 Settings\SpecialChar menuseparator
7039 \change_deleted -712698321 1500974764
7041 \begin_inset Flex Noun
7044 \begin_layout Plain Layout
7045 Synchronize with Output
7051 \begin_inset Flex Noun
7054 \begin_layout Plain Layout
7055 Document\SpecialChar menuseparator
7056 Settings\SpecialChar menuseparator
7065 In such a case \SpecialChar LyX
7066 will automatically insert the necessary Sync\SpecialChar TeX
7068 PDF) or load the srcltx package (for DVI) respectively.
7069 This option can be easily reached also on
7070 \begin_inset Flex Code
7073 \begin_layout Plain Layout
7082 \begin_layout Standard
7083 If you need a different setting, you can select or input a custom macro
7084 from the drop down box just below
7085 \begin_inset Flex Noun
7088 \begin_layout Plain Layout
7089 Document\SpecialChar menuseparator
7090 Settings\SpecialChar menuseparator
7091 Output\SpecialChar menuseparator
7092 Synchronize with Output
7100 \begin_layout Standard
7101 Note that the method
7102 \begin_inset Flex Code
7105 \begin_layout Plain Layout
7113 enables gzip compression.
7114 If your viewer does not support it, you should instead use
7115 \begin_inset Flex Code
7118 \begin_layout Plain Layout
7129 \begin_layout Standard
7130 Please also note that including the
7131 \begin_inset Flex Code
7134 \begin_layout Plain Layout
7141 \begin_inset Flex Code
7144 \begin_layout Plain Layout
7150 sometimes has an undesired impact on the typesetting.
7151 Thus, you should switch output synchronization off for the final typesetting
7153 \begin_inset Flex Code
7156 \begin_layout Plain Layout
7163 \begin_inset Flex Code
7166 \begin_layout Plain Layout
7176 \begin_layout Standard
7177 In case you need some more special settings that are not covered by the
7178 automatic settings, read the next section about how to set up output synchroniz
7180 If the automatic setup suits your needs, you can readily jump to section
7181 \begin_inset space ~
7185 \begin_inset CommandInset ref
7187 reference "subsec:configuring-viewers"
7191 , where the necessary configuration steps in your viewer – needed both with
7192 the automatic and the manual setup – are described.
7195 \begin_layout Subsection
7199 \begin_layout Standard
7201 provides several different methods for reverse search.
7202 Some are built-in in the
7203 \begin_inset Flex Code
7206 \begin_layout Plain Layout
7212 program, some are provided by external packages.
7213 Your choice depends on whether your \SpecialChar LaTeX
7214 distribution already provides a given
7215 method (the built-in methods are rather new) and whether your viewer can
7217 The available methods are described in the following.
7220 \begin_layout Subsubsection*
7221 Built-in DVI-search via src-specials (DVI only)
7224 \begin_layout Standard
7225 This method provides the DVI file with the necessary information for reverse
7227 It is available in \SpecialChar LaTeX
7228 since quite some time (any somewhat recent \SpecialChar LaTeX
7230 should include it), and it works reliably.
7231 To enable it, change the
7232 \begin_inset Flex Noun
7235 \begin_layout Plain Layout
7246 \begin_inset Flex Noun
7249 \begin_layout Plain Layout
7260 \begin_inset Flex Noun
7263 \begin_layout Plain Layout
7264 Preferences\SpecialChar menuseparator
7265 File Handling\SpecialChar menuseparator
7272 \begin_inset Flex Code
7275 \begin_layout Plain Layout
7276 latex -src-specials $$i
7282 If this doesn't work, check if your \SpecialChar TeX
7283 engine needs different options (the
7284 syntax might differ in some distributions).
7287 \begin_layout Subsubsection*
7288 External Packages (PDFSync and scrltx)
7291 \begin_layout Standard
7300 provide reverse search facility for PDF output (via pdflatex) and DVI output,
7302 In order to enable it, load the packages in the \SpecialChar LyX
7306 \begin_layout Itemize
7307 \begin_inset Flex Code
7310 \begin_layout Plain Layout
7318 for reverse PDF search,
7321 \begin_layout Itemize
7322 \begin_inset Flex Code
7325 \begin_layout Plain Layout
7328 usepackage[active]{srcltx}
7333 for reverse DVI search.
7336 \begin_layout Standard
7337 If you want to be able to perform both DVI and PDF reverse searches, you
7338 can also insert in the preamble the following lines
7341 \begin_layout LyX-Code
7345 \begin_inset Newline newline
7351 \begin_inset Newline newline
7357 \begin_inset Newline newline
7363 \begin_inset Newline newline
7368 usepackage[active]{srcltx}
7369 \begin_inset Newline newline
7377 \begin_layout Standard
7378 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7379 right package will be used.
7382 \begin_layout Standard
7383 Note that PDFSync might affect the output layout of your document.
7384 It is therefore advised to disable PDFsync for final documents.
7387 \begin_layout Subsubsection*
7388 Built-in reverse search via Sync\SpecialChar TeX
7392 \begin_layout Standard
7394 \begin_inset Flex Code
7397 \begin_layout Plain Layout
7403 have built-in support for both PDF and DVI reverse search.
7406 Sync\SpecialChar TeX
7409 facility is basically the result of the integration of the PDFSync package
7410 to the pdftex program and its merge with the
7415 You need at least \SpecialChar TeX
7416 Live 2008 or a recent Mik\SpecialChar TeX
7417 distribution in order to use
7422 \begin_layout Plain Layout
7423 For some reason, Mik\SpecialChar TeX
7424 does not understand/obey the command \SpecialChar LyX
7426 the preamble when you check the "Enable Forward/Reverse Search" button
7427 in the toolbar and does not generate the necessary info.
7430 \begin_layout Plain Layout
7431 The generation of the required info can be forced by changing the converter
7433 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7434 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7435 the -synctex=1 switch).
7440 Also note that only a few PDF viewers (
7441 \change_inserted -712698321 1500977288
7444 Okular and Qpdfview on Unix, Skim on the Mac, SumatraPDF on Windows
7445 \change_inserted -712698321 1500977299
7446 ; see the next section for details
7448 ) already provide Sync\SpecialChar TeX
7452 \begin_layout Standard
7453 To enable Sync\SpecialChar TeX
7454 for DVI output, change the
7455 \begin_inset Flex Noun
7458 \begin_layout Plain Layout
7469 \begin_inset Flex Noun
7472 \begin_layout Plain Layout
7483 \begin_inset Flex Noun
7486 \begin_layout Plain Layout
7487 Preferences\SpecialChar menuseparator
7488 File Handling\SpecialChar menuseparator
7495 \begin_inset Flex Code
7498 \begin_layout Plain Layout
7499 latex -synctex=1 $$i
7504 , and for PDF output, change the
7505 \begin_inset Flex Noun
7508 \begin_layout Plain Layout
7513 (pdflatex) -> PDF (pdflatex)
7519 \change_deleted -712698321 1500977453
7523 \begin_inset Flex Code
7526 \begin_layout Plain Layout
7527 pdflatex -synctex=1 $$i
7534 \change_inserted -712698321 1500977740
7535 Should your viewer not be considered in the following description, or in
7536 case of missing success, please
7537 \change_deleted -712698321 1500977741
7539 \change_inserted -712698321 1500977744
7542 heck the documentation of your viewer whether the viewer needs to be configured
7543 for the use with Sync\SpecialChar TeX
7548 \begin_layout Plain Layout
7549 Note that the option
7550 \begin_inset Flex Code
7553 \begin_layout Plain Layout
7559 option enables gzip compression.
7560 If your viewer does not support it, you should instead use
7561 \begin_inset Flex Code
7564 \begin_layout Plain Layout
7578 \begin_layout Subsection
7579 Configuring and using specific viewers
7580 \begin_inset CommandInset label
7582 name "subsec:configuring-viewers"
7589 \begin_layout Subsubsection*
7590 Xdvi (all platforms)
7593 \begin_layout Standard
7595 \begin_inset Flex Code
7598 \begin_layout Plain Layout
7604 , you don't need to do anything else for performing a reverse DVI search,
7606 already provides the necessary hooks for automatically using the
7607 \begin_inset Flex Code
7610 \begin_layout Plain Layout
7617 Just setup your document as described above (reverse search is triggered
7618 by Ctrl-click or Alt-click on Mac OSX, respectively).
7621 \begin_layout Standard
7622 However, if for whatever reason you want to use the named pipe instead of
7623 the socket for communicating with \SpecialChar LyX
7624 , simply change the DVI viewer in
7625 \begin_inset Flex Noun
7628 \begin_layout Plain Layout
7629 Preferences\SpecialChar menuseparator
7630 File Handling\SpecialChar menuseparator
7640 \begin_layout Plain Layout
7641 On Mac OSX you have to use
7642 \begin_inset Flex Code
7645 \begin_layout Plain Layout
7646 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7657 \begin_inset Flex Code
7660 \begin_layout Plain Layout
7661 xdvi -editor "lyxeditor.sh %f %l"
7667 \begin_inset Flex Code
7670 \begin_layout Plain Layout
7676 is a suitable script.
7677 For example, a minimal shell script is the following one:
7680 \begin_layout LyX-Code
7682 \begin_inset Newline newline
7685 LYXPIPE="/path/to/lyxpipe"
7686 \begin_inset Newline newline
7689 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7690 \begin_inset Newline newline
7693 echo "$COMMAND" > "${LYXPIPE}".in || exit
7694 \begin_inset Newline newline
7697 read TMP < "${LYXPIPE}".out || exit
7700 \begin_layout Standard
7702 \begin_inset Flex Code
7705 \begin_layout Plain Layout
7711 is the LyXServer pipe path specified in
7712 \begin_inset Flex Noun
7715 \begin_layout Plain Layout
7716 Preferences\SpecialChar menuseparator
7726 \begin_layout Plain Layout
7728 \begin_inset Flex Code
7731 \begin_layout Plain Layout
7737 folder of a source distribution you can find a
7738 \begin_inset Flex Code
7741 \begin_layout Plain Layout
7747 script which is able to locate the
7751 based on your preferences.
7759 \begin_layout Subsubsection*
7763 \begin_layout Standard
7765 \begin_inset Flex Code
7768 \begin_layout Plain Layout
7769 /Applications/MacDviX_Folder/calleditor.script
7774 , add the following lines:
7777 \begin_layout LyX-Code
7778 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7779 \begin_inset Newline newline
7785 \begin_layout Standard
7786 Modify the lines accordingly if you install \SpecialChar LyX
7787 somewhere else than in the
7788 Applications folder.
7791 \begin_layout Standard
7792 Reverse search is triggered by Alt-click (OPTION-click).
7795 \begin_layout Subsubsection*
7799 \begin_layout Standard
7801 \begin_inset Flex Code
7804 \begin_layout Plain Layout
7805 open -a Skim.app $$i
7810 to the viewer setting in
7811 \begin_inset Flex Noun
7814 \begin_layout Plain Layout
7815 Preferences\SpecialChar menuseparator
7816 File Handling\SpecialChar menuseparator
7817 File formats\SpecialChar menuseparator
7824 \begin_inset Flex Noun
7827 \begin_layout Plain Layout
7828 Skim\SpecialChar menuseparator
7829 Preferences\SpecialChar menuseparator
7836 \begin_inset Flex Noun
7839 \begin_layout Plain Layout
7845 preset and enter command
7846 \begin_inset Flex Noun
7849 \begin_layout Plain Layout
7850 /Applications/\SpecialChar LyX
7851 .app/Contents/MacOS/lyxeditor
7859 \begin_layout Standard
7860 Reverse search is triggered by COMMAND-SHIFT-click
7863 \begin_layout Subsubsection*
7867 \begin_layout Standard
7868 Reverse search with evince does not work out of the box, but it can be achieved
7869 by means of some third party helper scripts.
7871 \begin_inset CommandInset href
7873 target "http://wiki.lyx.org/LyX/SyncTeX"
7881 \begin_layout Subsubsection*
7885 \begin_layout Standard
7887 \begin_inset Flex Noun
7890 \begin_layout Plain Layout
7891 Settings\SpecialChar menuseparator
7892 Configure Okular\SpecialChar menuseparator
7899 \change_inserted -712698321 1500981642
7901 \change_deleted -712698321 1500981641
7905 \change_deleted -712698321 1500981634
7907 \begin_inset Quotes eld
7911 \change_inserted -712698321 1500981635
7915 \begin_inset Quotes erd
7919 \change_inserted -712698321 1500981659
7921 This inserts the appropriate
7922 \change_deleted -712698321 1500981663
7926 \change_inserted -712698321 1500981665
7930 \begin_inset Flex Code
7933 \begin_layout Plain Layout
7940 \change_inserted -712698321 1500981668
7946 \begin_layout Standard
7947 Reverse search is triggered by SHIFT-click.
7950 \begin_layout Subsubsection*
7954 \begin_layout Standard
7955 Qpdfview supports Sync\SpecialChar TeX
7956 since version 0.3.5.
7958 \begin_inset Flex Noun
7961 \begin_layout Plain Layout
7962 Edit\SpecialChar menuseparator
7963 Settings\SpecialChar menuseparator
7969 , click on the input field of the
7970 \begin_inset Quotes eld
7974 \begin_inset Quotes erd
7977 item and add the command
7978 \begin_inset Flex Code
7981 \begin_layout Plain Layout
7990 \begin_layout Standard
7991 Reverse search is triggered by double-click or, in more recent versions,
7995 \begin_layout Subsubsection*
7999 \begin_layout Standard
8000 Launch yap, choose its
8001 \begin_inset Flex Noun
8004 \begin_layout Plain Layout
8005 View\SpecialChar menuseparator
8012 \begin_inset Quotes eld
8016 \begin_inset Quotes erd
8021 \begin_inset Quotes eld
8024 New\SpecialChar ldots
8026 \begin_inset Quotes erd
8029 button and, in the window that opens, enter
8030 \begin_inset Quotes eld
8035 \begin_inset Quotes erd
8038 (or any other name you like) in the
8039 \begin_inset Quotes eld
8043 \begin_inset Quotes erd
8047 Now click on the button labeled
8048 \begin_inset Quotes eld
8053 \begin_inset Quotes erd
8056 to open a file dialog and navigate to the directory containing the batch
8058 \begin_inset Flex Code
8061 \begin_layout Plain Layout
8069 \begin_inset Flex Code
8072 \begin_layout Plain Layout
8078 and then specify the program arguments as
8079 \begin_inset Flex Code
8082 \begin_layout Plain Layout
8090 \begin_inset Flex Code
8093 \begin_layout Plain Layout
8099 wrapper is used for communicating with \SpecialChar LyX
8107 \begin_layout LyX-Code
8109 \begin_inset Newline newline
8112 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
8121 \begin_inset Newline newline
8135 \begin_layout Standard
8136 Make sure that the \SpecialChar LyX
8137 Server pipe path you specified in \SpecialChar LyX
8139 \begin_inset Flex Code
8142 \begin_layout Plain Layout
8156 , otherwise change the
8157 \begin_inset Flex Code
8160 \begin_layout Plain Layout
8166 wrapper accordingly.
8169 \begin_layout Standard
8170 In yap, reverse search is triggered by double-click.
8173 \begin_layout Subsubsection*
8174 SumatraPDF (Windows)
8177 \begin_layout Standard
8178 In order to use SumatraPDF for inverse search, enter
8179 \begin_inset Flex Code
8182 \begin_layout Plain Layout
8183 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
8188 in the viewer setting in
8189 \begin_inset Flex Noun
8192 \begin_layout Plain Layout
8193 Preferences\SpecialChar menuseparator
8194 File Handling\SpecialChar menuseparator
8195 File formats\SpecialChar menuseparator
8202 \begin_inset Flex Code
8205 \begin_layout Plain Layout
8211 is the previous wrapper.
8212 If SumatraPDF.exe is not in your command PATH, use its full file name.
8215 \begin_layout Standard
8216 Reverse search is triggered by double-click.
8219 \begin_layout Subsubsection*
8223 \begin_layout Standard
8224 First of all, make sure that yap is your default DVI viewer in the Windows
8225 environment, then launch it, choose its
8226 \begin_inset Flex Noun
8229 \begin_layout Plain Layout
8230 View\SpecialChar menuseparator
8237 \begin_inset Quotes eld
8241 \begin_inset Quotes erd
8246 \begin_inset Quotes eld
8249 New\SpecialChar ldots
8251 \begin_inset Quotes erd
8254 button and, in the window that opens, enter
8255 \begin_inset Quotes eld
8260 \begin_inset Quotes erd
8263 (or any other name you like) in the
8264 \begin_inset Quotes eld
8268 \begin_inset Quotes erd
8272 Now click on the button labeled
8273 \begin_inset Quotes eld
8278 \begin_inset Quotes erd
8281 to open a file dialog and navigate to the directory containing the
8282 \begin_inset Flex Code
8285 \begin_layout Plain Layout
8291 program (which is installed by default on Cygwin along with the \SpecialChar LyX
8294 \begin_inset Flex Code
8297 \begin_layout Plain Layout
8303 and then specify the program arguments as
8304 \begin_inset Flex Code
8307 \begin_layout Plain Layout
8314 In this way, you will be using the
8318 for communicating with \SpecialChar LyX
8320 If, for whatever reason, you want to use the
8325 \begin_inset Flex Code
8328 \begin_layout Plain Layout
8334 option and be sure to specify the \SpecialChar LyX
8335 Server pipe path in the \SpecialChar LyX
8339 \begin_layout Standard
8340 In yap, reverse search is triggered by double-click.
8343 \begin_layout Subsubsection*
8347 \begin_layout Standard
8348 In order to use SumatraPDF for inverse search, enter
8349 \begin_inset Flex Code
8352 \begin_layout Plain Layout
8353 SumatraPDF -inverse-search "lyxeditor -g %f %l"
8358 in the viewer setting in
8359 \begin_inset Flex Noun
8362 \begin_layout Plain Layout
8363 Preferences\SpecialChar menuseparator
8364 File Handling\SpecialChar menuseparator
8365 File formats\SpecialChar menuseparator
8372 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8374 \begin_inset Flex Code
8377 \begin_layout Plain Layout
8383 enables communication via the
8389 \begin_inset Flex Code
8392 \begin_layout Plain Layout
8398 option if you want to use the
8402 , and be sure to specify the \SpecialChar LyX
8403 Server pipe path in the \SpecialChar LyX
8407 \begin_layout Standard
8408 Reverse search is triggered by double-click.
8411 \begin_layout Section
8415 \begin_layout Standard
8416 Forward search is, as the name implies, in a sense the
8417 \begin_inset Quotes eld
8421 \begin_inset Quotes erd
8425 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8427 If forward search is set up (as described in what follows), you can put
8428 the cursor anywhere in your \SpecialChar LyX
8430 \begin_inset Flex Noun
8433 \begin_layout Plain Layout
8434 Navigate\SpecialChar menuseparator
8441 \begin_inset Flex Noun
8444 \begin_layout Plain Layout
8450 in the context menu via right mouse click), and then the viewer will jump
8451 to that position as well.
8452 This implies, of course, that your viewer supports this function.
8455 \begin_layout Standard
8456 To make forward search possible, you first need to provide the generated
8457 output PDF/DVI file with additional information about the \SpecialChar TeX
8459 This can be done via the methods described in the section
8460 \begin_inset CommandInset ref
8462 reference "subsec:rev-search"
8469 \begin_layout Standard
8470 Additionally, you need to configure \SpecialChar LyX
8471 for using your viewers in
8472 \begin_inset Flex Noun
8475 \begin_layout Plain Layout
8476 Tools\SpecialChar menuseparator
8477 Preferences\SpecialChar menuseparator
8478 Output\SpecialChar menuseparator
8485 We provide a range of tested configurations for some viewers, which you
8486 can select from the drop down list.
8487 If none of these configurations suits you, you have to find out and enter
8488 a suitable configuration yourself.
8489 The definition syntax uses the following placeholders:
8492 \begin_layout Itemize
8494 \begin_inset Flex Code
8497 \begin_layout Plain Layout
8506 \begin_layout Itemize
8508 \begin_inset Flex Code
8511 \begin_layout Plain Layout
8517 : name of the (temporary) exported .tex file (without path)
8520 \begin_layout Itemize
8522 \begin_inset Flex Code
8525 \begin_layout Plain Layout
8531 : name of the (temporary) exported .tex file (including path)
8534 \begin_layout Itemize
8536 \begin_inset Flex Code
8539 \begin_layout Plain Layout
8545 : name of the exported output file (either dvi or pdf, depending on which
8546 one exists in the temporary directory)
8549 \begin_layout Standard
8550 Note that only some of the viewers provide full and usable forward search
8551 functionality out of the box, among them yap, xdvi, okular
8555 \begin_layout Plain Layout
8556 You might want to set
8557 \begin_inset Flex Code
8560 \begin_layout Plain Layout
8567 \begin_inset Flex Noun
8570 \begin_layout Plain Layout
8571 Tools\SpecialChar menuseparator
8572 Preferences\SpecialChar menuseparator
8573 File Handling\SpecialChar menuseparator
8575 \begin_inset space ~
8588 , qpdfview, and SumatraPDF
8592 \begin_layout Plain Layout
8593 SumatraPDF can also use DDE commands through the external program CMCDDE
8595 \begin_inset CommandInset href
8597 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8608 Others, such as evince
8612 \begin_layout Plain Layout
8613 Forward search with evince can be achieved by means of third party helper
8616 \begin_inset CommandInset href
8618 target "http://wiki.lyx.org/LyX/SyncTeX"
8628 , require some extra tools in order to use forward search.
8629 While many of the widespread PDF viewers (most notably Adobe Reader) do
8630 not support forward search at all, some other viewers – e.
8631 \begin_inset space \thinspace{}
8635 xpdf – allow at least to reload the document and jump to a specific page
8636 of the file, so you can at least navigate
8637 \begin_inset Quotes eld
8641 \begin_inset Quotes erd
8645 This latter functionality is provided by an external call of synctex (see
8646 the predefined example configurations).
8650 \begin_layout Standard
8651 Forward search works both with DVI and PDF output.
8653 simply checks which preview format you have used before (i.
8654 \begin_inset space \thinspace{}
8657 e., which format is already there in the temporary directory) and chooses
8658 the appropriate configuration for the respective format.
8661 \begin_layout Chapter
8662 Special Document Classes
8665 \begin_layout Section
8669 \begin_layout Standard
8675 \begin_layout Subsection
8679 \begin_layout Standard
8680 This section describes how \SpecialChar LyX
8681 can be used to write articles for submission
8682 to the scientific journal
8684 Astronomy and Astrophysics
8687 \begin_inset Flex URL
8690 \begin_layout Plain Layout
8692 http://www.edpsciences.fr/aa/
8697 ) using Version 5.01 of the document class
8702 This package can be downloaded from the ftp site
8705 \begin_layout Standard
8706 \begin_inset VSpace medskip
8712 \begin_layout Standard
8714 \begin_inset Flex URL
8717 \begin_layout Plain Layout
8719 ftp://ftp.edpsciences.org/pub/aa/readme.html
8727 \begin_layout Standard
8728 \begin_inset VSpace medskip
8734 \begin_layout Standard
8735 A manual comes together with that package, and this text is not meant to
8736 replace the original manual but is merely a short guide in how to realize
8737 the correct form of your paper.
8741 \begin_layout Standard
8742 Please note that the publisher of the journal was changed from Springer
8743 to EDP Sciences starting January 1, 2001.
8744 That change involved also some slight changes to the style files, namely
8745 the removal of the thesaurus command.
8746 The \SpecialChar LyX
8747 class aa supports the newest version of these style files, V 5.01.
8748 If you have an older version installed, please upgrade.
8749 For compatibility, the old (version 4) layout has been kept as
8754 Please refer to the comments in
8757 Dir/layouts/aapaper.layout
8762 \begin_layout Subsection
8766 \begin_layout Standard
8767 It is recommended you start from the example template distributed with \SpecialChar LyX
8769 If you are not using a template, note the following settings:
8772 \begin_layout Itemize
8779 Document\SpecialChar menuseparator
8782 dialog (OK, that one was obvious).
8785 \begin_layout Itemize
8786 Don't change the option
8789 \begin_inset space ~
8799 The whole layout is done by the macros, you shouldn't change anything.
8802 \begin_layout Subsection
8806 \begin_layout Standard
8807 First thing to enter is the header information.
8808 It consists of seven entries, of which some are optional.
8812 \begin_layout Itemize
8820 \begin_layout Itemize
8828 \begin_layout Itemize
8836 \begin_layout Itemize
8844 \begin_layout Itemize
8849 : [optional] if more than one author: whom to contact for offprint requests.
8852 \begin_layout Itemize
8857 : [optional] mail address for contacts.
8860 \begin_layout Itemize
8868 Received: <date>; Accepted <date>
8871 \begin_layout Standard
8872 There is no need to issue the
8878 command, this is done automatically by \SpecialChar LyX
8879 when the header is finished.
8880 Although the order of the single header entries doesn't matter it is advised
8881 to keep the above sequence, just to get the best optics and meets the layout
8882 of the real document.
8885 \begin_layout Standard
8886 If you want to place footnotes in the header block, e.
8887 \begin_inset space \thinspace{}
8891 \begin_inset space \space{}
8894 to state your present address, just use the standard footnote via the menu
8897 Insert\SpecialChar menuseparator
8902 will automagically use the term
8909 \change_inserted -712698321 1501150851
8913 \begin_layout Standard
8915 \change_inserted -712698321 1501150892
8918 Edit\SpecialChar menuseparator
8921 , you'll find two insets which are relevant for the titling:
8924 \begin_layout Itemize
8926 \change_inserted -712698321 1501150936
8933 to mark corresponding author\SpecialChar breakableslash
8935 The institutes are numbered sequentially as they appear in the
8939 field, so you have to put a marker to each author.
8942 \begin_layout Itemize
8944 \change_inserted -712698321 1501150947
8949 to supply an email address for fast contact.
8954 \begin_layout Standard
8955 In addition to these topics, the macros use
8956 \change_deleted -712698321 1501150958
8958 \change_inserted -712698321 1501150961
8961 additional \SpecialChar LaTeX
8963 \change_deleted -712698321 1501150963
8967 \change_deleted -712698321 1501150967
8969 \change_inserted -712698321 1501150967
8972 no counterpart in \SpecialChar LyX
8976 \begin_layout Itemize
8983 to separate different names for more than one author and institute, respectivel
8987 \begin_layout Itemize
8989 \change_deleted -712698321 1501150911
8996 to mark corresponding author/institute pairs.
8997 The institutes are numbered sequentially as they appear in the
9001 field, so you have to put a marker to each author.
9004 \begin_layout Itemize
9006 \change_deleted -712698321 1501150911
9013 to supply an email address for fast contact.
9018 \begin_layout Standard
9020 \change_deleted -712698321 1501150972
9022 \change_inserted -712698321 1501150972
9025 he appropriate command has to be entered in \SpecialChar LyX
9026 and marked as \SpecialChar LaTeX
9032 \begin_layout Subsection
9036 \begin_layout Standard
9037 The abstract should immediately follow the header block.
9038 With version 5 the abstract environment was changed to a command, and there
9039 is now a resctriction to only one paragraph.
9040 In addition, it should contain an entry with the keywords.
9042 \change_deleted -712698321 1501151111
9043 not yet implemented for \SpecialChar LyX
9044 , therefore you have to enter the \SpecialChar LaTeX
9051 by hand and mark it as \SpecialChar LaTeX
9053 \change_inserted -712698321 1501151122
9054 done via the paragraph style
9061 Refer to the example paper.
9064 \begin_layout Subsection
9065 Supported environments
9068 \begin_layout Standard
9069 The A&A paper layout supports the following environments for structuring
9073 \begin_layout Itemize
9079 \begin_layout Itemize
9085 \begin_layout Itemize
9091 \begin_layout Itemize
9097 \begin_layout Itemize
9103 \begin_layout Itemize
9109 \begin_layout Itemize
9115 \begin_layout Itemize
9121 \begin_layout Itemize
9127 \begin_layout Itemize
9133 \begin_layout Itemize
9139 \begin_layout Itemize
9146 \begin_layout Subsection
9147 Commands not supported by \SpecialChar LyX
9151 \begin_layout Standard
9152 Some commands are not yet supported by the
9156 layout for \SpecialChar LyX
9158 Some have already been mentioned.
9159 For the sake of completeness, they are listed all together here:
9162 \begin_layout Itemize
9170 \begin_layout Itemize
9172 \change_deleted -712698321 1501151229
9182 \begin_layout Itemize
9184 \change_deleted -712698321 1501151308
9194 \begin_layout Itemize
9202 \begin_layout Itemize
9204 \change_deleted -712698321 1501151231
9212 \begin_layout Itemize
9214 \change_deleted -712698321 1501151231
9224 \begin_layout Itemize
9232 \begin_layout Itemize
9240 \begin_layout Standard
9241 If you want to use any of these commands, you have to enter them yourself.
9244 Do not forget to mark them as \SpecialChar LaTeX
9248 \begin_layout Subsection
9249 Figure and Table Floats
9252 \begin_layout Standard
9254 provides support for the necessary float environments
9256 figure, figure*, table
9262 , therefore we won't tell much about it here.
9266 \begin_inset space ~
9272 Just remember that tables should be left-aligned.
9273 For that, select the table and change the alignment in
9275 Edit\SpecialChar menuseparator
9277 \begin_inset space ~
9283 \begin_layout Standard
9284 There is only one special thing: the figures with caption besides the figure.
9285 To create such a figure, you have to do the following:
9288 \begin_layout Enumerate
9289 Create a wide figure float:
9291 Insert\SpecialChar menuseparator
9292 Float\SpecialChar menuseparator
9295 , then right click in the figure and select
9298 \begin_inset space ~
9306 \begin_layout Enumerate
9307 Enter your caption text.
9310 \begin_layout Enumerate
9315 to move the cursor above the caption.
9318 \begin_layout Enumerate
9322 \begin_layout Enumerate
9323 Position the cursor behind the figure and insert a horizontal fill:
9325 Insert\SpecialChar menuseparator
9327 \begin_inset space ~
9330 Character\SpecialChar menuseparator
9332 \begin_inset space ~
9340 \begin_layout Enumerate
9341 Switch to \SpecialChar LaTeX
9345 \begin_inset space ~
9353 \begin_layout Enumerate
9363 Do not close the brace!
9366 \begin_layout Enumerate
9367 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
9372 \begin_inset space ~
9384 \begin_layout Standard
9385 Also, refer to the figures in the example paper.
9388 \begin_layout Subsection
9392 \begin_layout Standard
9393 For submission, the paper has to be formated in a special double-spacing
9395 For this purpose, you have to give the option
9399 to the documentclass.
9400 This must be done using the
9401 \change_deleted -712698321 1501151486
9403 \change_inserted -712698321 1501151487
9406 class options field in the
9408 Document\SpecialChar menuseparator
9412 Just enter the string
9419 \begin_layout Subsection
9423 \begin_layout Standard
9428 directory contains an example paper written with \SpecialChar LyX
9430 It is the example paper from the original macro package, translated to
9433 Use it for inspiration, and compare the original \SpecialChar LaTeX
9434 code with \SpecialChar LyX
9438 \begin_layout Section
9443 \begin_layout Standard
9449 \begin_layout Subsection
9453 \begin_layout Standard
9455 is a set of macros produced by the American Astronomical Society to
9456 facilitate electronic manuscript submission to the three journals they
9457 publish: the Astrophysical Journal (including the Letters and Supplement),
9458 the Astronomical Journal, and the Publications of the Astronomical Society
9461 has proven to be an excellent tool for generating these documents, especially
9462 given its equation, citation, and figure handling capabilities.
9464 requires version 5.0 (or higher) of these macros; preferably
9465 \change_deleted -712698321 1501152764
9467 \change_inserted -712698321 1501152766
9470 , which is the version described here, or higher.
9471 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9472 2.09 and are fundamentally
9473 incompatible with \SpecialChar LyX
9475 The AAS\SpecialChar TeX
9476 package may be downloaded from the AAS\SpecialChar TeX
9480 \begin_layout Standard
9481 \begin_inset VSpace medskip
9487 \begin_layout Standard
9489 \begin_inset Flex URL
9492 \begin_layout Plain Layout
9494 https://aas.org/aastex/aastex-downloads
9502 \begin_layout Standard
9503 \begin_inset VSpace medskip
9509 \begin_layout Standard
9510 A complete user guide is contained in that package and you should familiarize
9511 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9514 will not reduce the need to figure out all the AAS\SpecialChar TeX
9515 commands, it will only
9516 reduce the drudgery of typing everything in.
9517 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9519 completely to the requirements of the journal to which you are submitting
9523 \begin_layout Subsection
9524 Starting a New Paper
9527 \begin_layout Standard
9528 I strongly suggest that you start with the AAS\SpecialChar TeX
9532 File\SpecialChar menuseparator
9539 , enter the new file name, then choose the
9542 \change_inserted -712698321 1501152130
9548 This will show the most common fields found in a manuscript.
9549 Simply overwrite the existing text (including the brackets,
9553 ) with the correct information.
9554 Many of the AAS\SpecialChar TeX
9555 commands and environments can be implemented directly in
9558 \change_deleted -712698321 1501152213
9571 , which should stick out like a sore thumb if you actually just opened the
9575 For commands such as these, the \SpecialChar LaTeX
9576 code must be entered directly and marked
9578 Such commands are referred to as \SpecialChar TeX
9579 code, or Evil Red Text.
9580 I tried to minimize the amount of \SpecialChar TeX
9581 code needed in an AAS\SpecialChar TeX
9583 \change_deleted -712698321 1501152220
9584 , but there is still a bit more required than any of us would like
9589 \begin_layout Subsection
9590 Finishing Your Paper
9593 \begin_layout Standard
9594 When the paper is finished to your satisfaction and previews/prints correctly,
9596 \begin_inset Quotes eld
9600 \begin_inset Quotes erd
9603 actions which need to be done before you submit it to the journals.
9607 \begin_layout Enumerate
9608 Export your paper as a \SpecialChar LaTeX
9611 File\SpecialChar menuseparator
9612 Export\SpecialChar menuseparator
9620 \begin_layout Enumerate
9625 file with your favorite text editor
9629 \begin_layout Enumerate
9630 remove the comment lines before the
9639 \begin_layout Enumerate
9644 usepackage...{fontenc}
9646 line if it appears (usually just after
9661 \begin_layout Enumerate
9662 remove everything between (and including) the
9674 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9676 (which should appear immediately after the
9677 \begin_inset Quotes eld
9680 User specified \SpecialChar LaTeX
9682 \begin_inset Quotes erd
9693 \begin_layout Enumerate
9694 Run the resulting file through \SpecialChar LaTeX
9695 to make sure it still processes correctly.
9698 \begin_layout Enumerate
9699 Reread the journal requirements to make sure your filenames and formats
9703 \begin_layout Enumerate
9707 \begin_layout Subsection
9708 Comments On Specific Commands
9711 \begin_layout Standard
9712 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9719 ) gives a good description of each.
9720 Thus it's probably easiest for me to go down the list as found in the guide
9721 and offer comments where necessary.
9722 So let's begin \SpecialChar ldots
9726 \begin_layout Subsubsection
9727 Things that work as expected
9730 \begin_layout Standard
9731 Because they work as you might expect, I simply list them and the section
9832 begin{thebibliography}
9840 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9841 graphicx figure commands (2.14.1),
9865 (2.15.4, amongst other places),
9892 \begin_layout Standard
9893 The following style options also work correctly:
9914 Simply put them in the
9920 Layout\SpecialChar menuseparator
9926 \begin_layout Subsubsection
9927 Things that work, but require more comment
9930 \begin_layout Standard
9931 The following items work, but require a little more discussion:
9934 \begin_layout Itemize
9935 These items are reserved for use by the journal editors, but you can put
9936 them into the \SpecialChar LaTeX
9937 preamble if you feel compelled to do so:
9970 \begin_layout Itemize
9971 These items may be placed in the \SpecialChar LaTeX
9972 preamble, and are included as blanks in
9994 \begin_layout Itemize
10001 (2.3) – can only be used
10002 \begin_inset Quotes eld
10006 \begin_inset Quotes erd
10009 , not in the middle of a paragraph.
10010 Use \SpecialChar TeX
10011 code if you need to embed it.
10014 \begin_layout Itemize
10021 (2.3) – will have extra {} after it.
10022 This should not cause an error.
10025 \begin_layout Itemize
10032 (2.6) – can only be used
10033 \begin_inset Quotes eld
10037 \begin_inset Quotes erd
10040 , not in the middle of a paragraph.
10041 Use \SpecialChar TeX
10042 code if you need to embed it.
10045 \begin_layout Itemize
10052 (2.8) – can't insert a cross-reference tag, you must type the tag name by
10056 \begin_layout Itemize
10063 (2.8) – same as for
10070 \begin_layout Itemize
10077 (2.9) – will have extra {} after it.
10078 This should not cause an error.
10081 \begin_layout Itemize
10088 (2.11) – will have extra {} after it.
10089 This should not cause an error.
10092 \begin_layout Itemize
10099 (2.14.2) – you can insert an optional filename argument by placing the cursor
10100 at the beginning of the text and selecting
10102 Insert\SpecialChar menuseparator
10107 \begin_inset Quotes eld
10111 \begin_inset Quotes erd
10114 inserts an optional argument of the type needed by
10121 Hopefully it will be renamed someday.
10124 \begin_layout Itemize
10137 for the catalog ID optional parameter
10140 \begin_layout Itemize
10153 for the catalog ID optional parameter
10156 \begin_layout Subsubsection
10157 Things not implemented, use \SpecialChar TeX
10161 \begin_layout Standard
10163 \change_deleted -712698321 1501152401
10188 setcounter{equation}
10190 (2.12), Journal name abbreviations (2.13.4),
10226 (2.15.4, insert it as the first element in the lefthand cell after where
10228 Don't use any of \SpecialChar LyX
10229 's rules in the table),
10241 (2.15.5), much of Misc (2.17, except
10292 \begin_layout Subsubsection
10293 Things that cannot be implemented
10296 \begin_layout Standard
10298 at least in any meaningful sort of way, so I suggest ignoring them.
10299 They are the references environment (2.13.3), and the deluxetable environment
10301 If you really, really need to use deluxetable, I suggest editing it in
10302 a separate file with a text editor, then using
10304 Insert\SpecialChar menuseparator
10306 \begin_inset space ~
10311 to include it in your \SpecialChar LyX
10317 file to see an example of this.
10320 \begin_layout Subsection
10321 FAQs, Tips, Tricks, and Other Ruminations
10324 \begin_layout Subsubsection
10325 Getting \SpecialChar LyX
10326 and AAS\SpecialChar TeX
10330 \begin_layout Standard
10331 It can be a bit tricky to get \SpecialChar LyX
10332 to recognize a new layout and document class.
10333 When all else fails, do this:
10336 \begin_layout Enumerate
10337 Make certain that \SpecialChar LaTeX
10338 can find AAS\SpecialChar TeX
10340 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
10341 distribution into a
10342 directory completely unrelated to \SpecialChar LaTeX
10343 or AAS\SpecialChar TeX
10344 and run \SpecialChar LaTeX
10352 \begin_layout Enumerate
10357 appears in \SpecialChar LyX
10365 \begin_layout Enumerate
10368 Tools\SpecialChar menuseparator
10371 in \SpecialChar LyX
10372 , then restart \SpecialChar LyX
10376 \begin_layout Enumerate
10377 Open a regular new file, not from a template.
10378 Does AAS\SpecialChar TeX
10379 appear in the class list in
10381 Document\SpecialChar menuseparator
10387 \begin_layout Standard
10388 If you get a warning from an existing AAS\SpecialChar TeX
10389 document about not being able
10390 to find the AAS\SpecialChar TeX
10391 layout or a message about
10392 \begin_inset Quotes eld
10395 You should not mix title layouts with normal ones
10396 \begin_inset Quotes erd
10399 , things haven't been installed correctly.
10402 \begin_layout Subsubsection
10404 error processing a table
10407 \begin_layout Standard
10409 , by default, attempts to center the table caption/title.
10410 This seems to produce a bad interaction in AAS\SpecialChar TeX
10411 so you should click somewhere
10412 in the caption/title, then select
10414 Edit\SpecialChar menuseparator
10416 \begin_inset space ~
10430 This took care of it for me.
10433 \begin_layout Subsubsection
10437 \begin_layout Standard
10438 A couple of things: 1) I have noticed some funny spacing in the reference
10439 entries in the text.
10440 When you enter the bibliography item data, make sure their is
10444 space between the last author and the parenthesis setting off the year;
10448 \begin_inset space \thinspace{}
10452 \begin_inset space \space{}
10466 2) Entering the references at all is not obvious.
10467 The easiest thing is to start typing your first reference at the end of
10468 the document, then mark it as type
10473 That will put a small gray box in front of what you just typed.
10474 Click on the box to fill in the rest of the information.
10475 For new references, go to the end of an existing reference and press return.
10476 That will create a new line with its own box, etc.
10479 \begin_layout Subsubsection
10480 Including EPS files
10483 \begin_layout Standard
10484 Even though AAS\SpecialChar TeX
10485 provides its own figure commands (
10491 , for example), I much prefer \SpecialChar LaTeX
10492 's standard figure commands (with the default
10501 \begin_inset space ~
10504 commands as \SpecialChar TeX
10505 code into a Figure Float box if you desire, but I never have
10506 much luck getting the layout right.
10507 With the standard graphics, \SpecialChar LyX
10512 usepackage{graphicx}
10514 command into the \SpecialChar LaTeX
10515 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10517 interspersing the figures in the text.
10518 I believe ApJ accepts figures exactly this way now; AJ might still use
10520 \begin_inset Quotes eld
10523 stack everything at the end
10524 \begin_inset Quotes erd
10530 \begin_layout Subsubsection
10531 Things I could have done, but didn't
10534 \begin_layout Standard
10536 \begin_inset Quotes eld
10540 \begin_inset Quotes erd
10543 things I could have implemented, but chose not to.
10544 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10546 even though it is double-spaced in the paper manuscript.
10547 Also, I chose not to make separate layouts for the preprint and preprint2
10549 Since I assume you will spend most of your time in the plain manuscript
10550 mode anyway, I decided not to chew up more disk space with this.
10554 \begin_layout Subsection
10558 \begin_layout Standard
10559 Your mileage may vary.
10560 I've now had papers published by both ApJ and AJ that have had 98% of the
10561 effort done in \SpecialChar LyX
10562 ; the last 2% was the \SpecialChar LaTeX
10563 post-processing and a few cleanups.
10564 I have had no trouble with the submission process, and I'm sure the journals
10565 were never aware that there might be a difference.
10566 So, go forth and publish!
10569 \begin_layout Section
10570 AMS \SpecialChar LaTeX
10574 \begin_layout Standard
10584 \begin_layout Standard
10585 \begin_inset VSpace bigskip
10591 \begin_layout Standard
10593 The AMS \SpecialChar LaTeX
10594 layouts are set up to conform to suggested styles for mathematical
10595 papers to be submitted to American Mathematical Society publications.
10596 The layouts are not tailored to a specific journal, but easily can be.
10597 You should refer to the AMS documentation for specific instructions for
10598 each journal (usually it will entail only changing a single line in the
10601 That documentation is available on the Web at
10602 \begin_inset Flex URL
10605 \begin_layout Plain Layout
10613 \begin_inset Flex URL
10616 \begin_layout Plain Layout
10618 ftp://ftp.ams.org/pub/tex/amslatex/
10624 These layouts are appropriate, and useful, for any mathematical writing.
10628 \begin_layout Standard
10629 There are two basic AMS \SpecialChar LaTeX
10633 \begin_layout Itemize
10634 amsart: The standard AMS article format.
10637 \begin_layout Itemize
10638 amsbook: the standard AMS book (really, monograph) format.
10642 \begin_layout Standard
10643 The layouts themselves contain only the minimum necessary to use the AMS
10645 They do not, in particular, contain any of the `theorem' environments used
10646 for setting theorems, lemmas, and the like.
10647 These are contained, instead, in the
10648 \begin_inset Flex Code
10651 \begin_layout Plain Layout
10657 module, which is loaded by default when you select one of the AMS classes.
10658 (It can also be used with other classes and can be removed, if you would
10659 rather use something else.) Less commonly used environments are in the
10660 \begin_inset Flex Code
10663 \begin_layout Plain Layout
10664 Theorems (AMS-Extended)
10669 module, which must be loaded manually.
10672 \begin_layout Standard
10673 By default, theorems and the like are numbered consecutively throughout
10674 the document, but this may be modified by loading the module
10675 \begin_inset Flex Code
10678 \begin_layout Plain Layout
10679 Theorems (Order by Section)
10684 or, if you are using
10685 \begin_inset Flex Code
10688 \begin_layout Plain Layout
10695 \begin_inset Flex Code
10698 \begin_layout Plain Layout
10699 Theorems (Order by Chapter)
10705 These will number the results as
10706 \begin_inset Formula $n.m$
10709 , where the first number refers to the section (or chapter) and the second
10710 refers to the total number of results so far in that section (or chapter).
10711 Many environments are also available unnumbered.
10712 These are indicated by an asterisk at the end.
10713 If you happen to want
10717 unnumbered results, the module
10718 \begin_inset Flex Code
10721 \begin_layout Plain Layout
10727 provides that option.
10730 \begin_layout Standard
10731 Note that these modules do not
10735 to be used with the AMS classes.
10736 It is perfectly possible to use the
10737 \begin_inset Flex Code
10740 \begin_layout Plain Layout
10746 module, and the others mentioned, with other classes, such as
10747 \begin_inset Flex Code
10750 \begin_layout Plain Layout
10757 \begin_inset Flex Code
10760 \begin_layout Plain Layout
10767 \begin_inset Flex Code
10770 \begin_layout Plain Layout
10779 \begin_layout Subsection
10780 What these layouts provide
10783 \begin_layout Standard
10784 There is a long list of included environments provided by these layouts.
10785 In AMS-\SpecialChar LaTeX
10786 , there is, in fact, an opportunity to define an unlimited variety
10787 of `theorem' environments.
10788 However, the AMS recommends the environments that are available in \SpecialChar LyX
10793 \begin_layout Standard
10794 The following environments—as well as the standard environments, such as
10796 \begin_inset Flex Noun
10799 \begin_layout Plain Layout
10806 \begin_inset Flex Noun
10809 \begin_layout Plain Layout
10816 \begin_inset Flex Noun
10819 \begin_layout Plain Layout
10826 \begin_inset Flex Noun
10829 \begin_layout Plain Layout
10836 \begin_inset Flex Noun
10839 \begin_layout Plain Layout
10846 \begin_inset Flex Code
10849 \begin_layout Plain Layout
10856 \begin_inset Flex Code
10859 \begin_layout Plain Layout
10868 \begin_layout Description
10869 Address This should be the author's permanent address.
10872 \begin_layout Description
10874 \begin_inset space ~
10877 Address This should be the author's temporary address at the time of submission,
10878 if different from the Address.
10881 \begin_layout Description
10882 Email Author's e-mail address
10885 \begin_layout Description
10886 URL Author's Web address, if desired.
10889 \begin_layout Description
10890 Keywords Key words or phrases used to identify specific topics discussed
10894 \begin_layout Description
10895 Subjectclass These refer to the AMS Subject Classifications, published and
10898 Mathematical Reviews
10901 These are also available online at the AMS cites listed above.
10904 \begin_layout Description
10908 \begin_layout Description
10912 \begin_layout Description
10916 \begin_layout Standard
10917 The following environments are provided by both the
10918 \begin_inset Flex Code
10921 \begin_layout Plain Layout
10928 \begin_inset Flex Code
10931 \begin_layout Plain Layout
10937 modules, in the latter case in both starred (unnumbered) and unstarred
10938 (numbered) versions.
10939 These same environments are provided only in the starred versions by the
10941 \begin_inset Flex Code
10944 \begin_layout Plain Layout
10953 \begin_layout Theorem
10954 This is typically used for the statements of major results.
10958 \begin_layout Corollary*
10959 This is used for statements which follow fairly directly from previous statement
10961 Again, these can be major results.
10965 \begin_layout Lemma
10966 These are smaller results needed to prove other statements.
10969 \begin_layout Proposition
10970 These are less major results which (hopefully) add to the general theory
10974 \begin_layout Conjecture
10975 These are statements provided without justification, which the author does
10976 not know how to prove, but which seem to be true (to the author, at least).
10979 \begin_layout Definition*
10980 Guess what this is for.
10981 The font is different for this environment than for the previous ones.
10985 \begin_layout Example*
10986 Used for examples illustrating proven results.
10989 \begin_layout Problem
10990 It's not really known what this is for.
10991 You should figure it out.
10994 \begin_layout Exercise*
10995 Write a description for this one.
10998 \begin_layout Remark
10999 This environment is also a type of theorem, usually a lesser sort of observation.
11002 \begin_layout Claim*
11003 Often used in the course of giving a proof of a larger result.
11007 Generally, these are used to break up long arguments, using specific instances
11013 The numbering scheme for cases is on its own, not together with other numbered
11018 \begin_layout Proof
11019 At the end of this environment, a QED symbol (usually a square, but it can
11020 vary with different styles) is placed.
11021 If you want to have other environments within this one—for example, Case
11022 environments—and have the QED symbol appear only after them, then the other
11023 environments need to be nested within the proof environment.
11026 Nesting Environments
11032 for information on nesting.
11035 \begin_layout Standard
11036 And these environments are provided by
11037 \begin_inset Flex Code
11040 \begin_layout Plain Layout
11041 Theorems (AMS-Extended)
11049 \begin_layout Criterion*
11050 A required condition.
11053 \begin_layout Algorithm*
11054 A general procedure to be used.
11057 \begin_layout Axiom*
11058 This is a property or statement taken as true within the system being discussed.
11061 \begin_layout Condition*
11062 Sometimes used to state a condition assumed within the present context of
11066 \begin_layout Note*
11067 Similar to a Remark.
11070 \begin_layout Notation*
11071 Used for the explanation of, yes, notation.
11074 \begin_layout Summary
11075 Do we really need to tell you?
11078 \begin_layout Acknowledgement*
11082 \begin_layout Conclusion*
11083 Sometimes used at the end of a long train of argument.
11087 Used in a way similar to Proposition, though perhaps lower on the scale.
11090 \begin_layout Standard
11091 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
11094 They need to be available on your system in order to use these environments.
11097 \begin_layout Section
11105 \begin_layout Standard
11111 \begin_layout Subsection
11115 \begin_layout Standard
11116 These are the layout files for some of the journals of the American Geophysical
11118 It is assumed that you have both the AGU's own class files and AGUplus
11119 installed (everything to be found at
11120 \begin_inset Flex URL
11123 \begin_layout Plain Layout
11125 http://publications.agu.org/files/2013/08/AGU-LaTeX.zip
11133 \begin_layout Subsection
11137 \begin_layout Standard
11147 They are still called this in the \SpecialChar LyX
11148 GUI, though their \SpecialChar LaTeX
11161 \begin_layout Standard
11162 Newly defined styles are
11199 These are mostly manuscript attributes and defined in the AGU class documentati
11203 \begin_layout Standard
11204 I suspect this is still badly incomplete.
11207 \begin_layout Subsection
11211 \begin_layout Standard
11228 \begin_layout Subsection
11232 \begin_layout Itemize
11235 Journal of Geophysical Research
11244 \begin_layout Standard
11245 Add your own, it isn't so hard! Look at the
11256 \begin_layout Subsection
11257 Bugs and things to remember
11260 \begin_layout Standard
11261 In order to use the new layouts, you must remember to do the following for
11265 \begin_layout Enumerate
11271 This can be done in the
11273 Layout\SpecialChar menuseparator
11278 Document\SpecialChar menuseparator
11282 (AGU articles are always in English, right? So
11286 choose a language.)
11289 \begin_layout Enumerate
11294 into the document's
11299 (Yes, this is a bug.)
11302 \begin_layout Enumerate
11303 Make sure you use the
11307 bibliography style, by entering
11311 into the second field of the Bib\SpecialChar TeX
11313 None of the standard styles will do.
11316 \begin_layout Section
11320 \begin_layout Standard
11326 \begin_layout Subsection
11330 \begin_layout Standard
11331 Broadway is for writing plays.
11332 The format is more decorative than Hollywood, and much less standardized.
11333 This format should be suitable for workshops.
11336 \begin_layout Subsection
11340 \begin_layout Standard
11341 The same as in Hollywood.
11344 \begin_layout Subsection
11348 \begin_layout Standard
11353 names as labels then cross-reference the label to insert the name.
11354 The cross-reference dialog will show the current cast of characters.
11357 \begin_layout Subsection
11358 Paper size and Margins
11361 \begin_layout Standard
11362 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11365 \begin_layout Subsection
11369 \begin_layout Standard
11370 The following environments are available.
11371 You can use broadway.bind to get the bind keys shown at the right.
11374 \begin_layout Itemize
11378 \begin_inset Newline newline
11383 You should not have to use this, but it is here for anything that does not
11387 \begin_layout Itemize
11391 \begin_inset space \hfill{}
11395 \begin_inset Newline newline
11400 Used to describe stage setting and the action.
11401 First use of speaker names in all CAPs.
11404 \begin_layout Itemize
11408 \begin_inset space \hfill{}
11412 \begin_inset Newline newline
11417 Automatically numbered.
11418 On screen it will be arabic, but will print as Roman.
11421 \begin_layout Itemize
11425 \begin_inset space \hfill{}
11429 \begin_inset Newline newline
11439 It is just centered text.
11442 \begin_layout Itemize
11446 \begin_inset space \hfill{}
11450 \begin_inset Newline newline
11455 Not automatically numbered.
11456 You supply the number.
11457 This is because I couldn't figure out how.
11460 \begin_layout Itemize
11464 \begin_inset space \hfill{}
11468 \begin_inset Newline newline
11473 A special case of Narrative to describe the setting and action as the curtain
11477 \begin_layout Itemize
11481 \begin_inset space \hfill{}
11485 \begin_inset Newline newline
11490 The speaker's (actor's) title, centered in all CAPS.
11493 \begin_layout Itemize
11497 \begin_inset space \hfill{}
11501 \begin_inset Newline newline
11506 Instructions to the speaker.
11507 The parentheses are automatically inserted.
11508 The ( will appear on screen, but both will be in the printed play.
11509 This environment is only used within
11516 \begin_layout Itemize
11520 \begin_inset space \hfill{}
11524 \begin_inset Newline newline
11529 What the Speaker says.
11532 \begin_layout Itemize
11536 \begin_inset space \hfill{}
11540 \begin_inset Newline newline
11545 The curtain comes down.
11548 \begin_layout Itemize
11552 \begin_inset space \hfill{}
11558 \begin_layout Itemize
11562 \begin_inset space \hfill{}
11568 \begin_layout Itemize
11572 \begin_inset space \hfill{}
11578 \begin_layout Standard
11582 \begin_layout Section
11586 \begin_layout Standard
11591 can be used to type letters according to German conventions.
11592 A template file is included in
11594 .../lyx/share/templates
11596 for you to use as a starting point.
11599 \begin_layout Section
11607 \begin_layout Standard
11613 \begin_layout Subsection
11617 \begin_layout Standard
11618 This is the layout file for the European Geophysical Society journals.
11623 can be downloaded from the web site of the EGS under
11624 \begin_inset Flex URL
11627 \begin_layout Plain Layout
11637 \begin_layout Subsection
11641 \begin_layout Standard
11644 Right_address, Latex_Title, Affil, Journal, msnumber, FirstAuthor, Received,
11652 The current layout file is unfortunately very unmodular and would benefit
11653 from using the various
11660 \begin_layout Section
11664 \begin_layout Standard
11665 See the \SpecialChar LyX
11671 It contains all infos you need.
11674 \begin_layout Section
11677 Foil\SpecialChar TeX
11681 \begin_inset CommandInset label
11690 \begin_layout Standard
11696 \begin_layout Subsection
11700 \begin_layout Standard
11701 This section describes how to use \SpecialChar LyX
11702 to make slides for overhead projectors.
11703 There are two document classes that can do this: the default slides class
11706 Foil\SpecialChar TeX
11710 This section documents the latter.
11713 \begin_layout Standard
11714 I'm going to say this again, nice and clear, so that there's no misunderstanding
11718 \begin_layout Standard
11719 \begin_inset VSpace bigskip
11725 \begin_layout Standard
11729 This section documents the class
11730 \begin_inset Quotes eld
11738 \begin_inset Quotes erd
11746 \begin_layout Standard
11747 \begin_inset VSpace bigskip
11753 \begin_layout Standard
11754 If you're looking for the documentation for
11755 \begin_inset Quotes eld
11763 \begin_inset Quotes erd
11766 , check out section
11767 \begin_inset space ~
11771 \begin_inset CommandInset ref
11773 reference "sec:slitex"
11778 If your machine doesn't have the
11786 installed, you'll probably have to use the default
11790 class, which isn't quite as good as
11795 \begin_layout Standard
11800 class is designed for use with version
11801 \begin_inset space ~
11809 class file which is now an integral part of \SpecialChar LaTeX2e
11813 \begin_layout Subsection
11817 \begin_layout Standard
11818 Obviously, to use this document class, you need to select
11829 \begin_inset space ~
11835 There are some settings in the
11838 \begin_inset space ~
11843 dialog that you should know about that are specific to this class:
11846 \begin_layout Itemize
11847 Don't change the options
11858 \begin_inset space ~
11864 They're ignored by the
11871 \begin_layout Itemize
11872 The default font size is 20
11873 \begin_inset space \thinspace{}
11876 pt with the other options being 17
11877 \begin_inset space \thinspace{}
11881 \begin_inset space \thinspace{}
11885 \begin_inset space \thinspace{}
11891 \begin_layout Itemize
11892 The default font is
11900 but all math equations are still typeset in the usual roman font.
11903 \begin_layout Itemize
11906 Foil\SpecialChar TeX
11909 supports A4 and Letter paper sizes as well as a special size for working
11911 \begin_inset space \thinspace{}
11915 It doesn't support A5, B5, legal or executive paper sizes.
11918 \begin_layout Itemize
11919 Don't bother changing the
11923 settings because they are ignored anyway.
11924 All floats appear where they are defined in the text.
11927 \begin_layout Itemize
11932 setting behaves a bit differently for this class.
11935 Foil\SpecialChar TeX
11938 provides extensive footer and header capabilities including a user-defined
11941 \begin_inset space ~
11945 \begin_inset CommandInset ref
11947 reference "sec:foilfoot"
11952 The title page is treated differently to all other pages in the document
11961 has the logo centered at the bottom of the page (if one is defined).
11962 The possible page style choices and what they do are as follows:
11966 \begin_layout Labeling
11967 \labelwidthstring MMMMMMM
11974 The final output contains no page numbers, or other headers or footers
11975 (except footnotes of course).
11979 \begin_layout Labeling
11980 \labelwidthstring MMMMMMM
11987 The final output contains page numbers centered at the bottom of the page.
11988 No other headings or footers (other than footnotes).
11991 \begin_layout Labeling
11992 \labelwidthstring MMMMMMM
11997 Page numbers in lower right corner.
11998 Additional headers and footers are also shown.
11999 This is also the default.
12002 \begin_layout Labeling
12003 \labelwidthstring MMMMMMM
12008 Gives you access to the
12012 package although its use with
12014 Foil\SpecialChar TeX
12017 is discouraged by the writer of the
12019 Foil\SpecialChar TeX
12022 package because of some potential page layout clashes.
12026 \begin_layout Subsubsection
12030 \begin_layout Standard
12031 The following options may be used in the extra class options in the
12033 Document\SpecialChar menuseparator
12039 \begin_layout Labeling
12040 \labelwidthstring MMMMMMx
12045 This sets up the page layout for 7.33
12046 \begin_inset space \thinspace{}
12050 \begin_inset space \thinspace{}
12053 in paper, which is about the same aspect ratio as a 35
12054 \begin_inset space \thinspace{}
12057 mm slide, making it a bit easier to work with this medium.
12060 \begin_layout Labeling
12061 \labelwidthstring MMMMMMx
12066 Places a rule across the page below the header on every page except the
12070 \begin_layout Labeling
12071 \labelwidthstring MMMMMMx
12076 Places a rule across the page above the footer on every page except the
12080 \begin_layout Labeling
12081 \labelwidthstring MMMMMMx
12086 This is automatically set each time you create a new
12093 Foil\SpecialChar TeX
12096 to use the dvips driver to rotate those pages that are set as landscape
12100 \begin_layout Labeling
12101 \labelwidthstring MMMMMMx
12106 Simply changes the page dimensions to those of a landscape page but doesn't
12108 Thus if you use this option you need to use an external program to rotate
12109 each page or feed your paper through your printer as landscape.
12110 Note that this option effectively reverses the roles of the
12118 environments (don't worry these are described in the next section).
12121 \begin_layout Labeling
12122 \labelwidthstring MMMMMMx
12127 Equation numbers on the left.
12130 \begin_layout Labeling
12131 \labelwidthstring MMMMMMx
12136 Flush-left equations.
12139 \begin_layout Subsection
12140 Supported Environments
12143 \begin_layout Standard
12144 Most of the environments commonly supported in other classes are also supported
12150 There are several additional environments provided by
12152 Foil\SpecialChar TeX
12155 as well as a couple added by \SpecialChar LyX
12157 The following environments are shared with other classes:
12160 \begin_layout Standard
12161 \begin_inset Flex Multiple Columns
12164 \begin_layout Itemize
12170 \begin_layout Itemize
12176 \begin_layout Itemize
12182 \begin_layout Itemize
12188 \begin_layout Itemize
12194 \begin_layout Itemize
12201 \begin_layout Itemize
12207 \begin_layout Itemize
12213 \begin_layout Itemize
12219 \begin_layout Itemize
12223 \change_deleted -712698321 1501158884
12227 \begin_layout Itemize
12233 \begin_layout Itemize
12239 \begin_layout Itemize
12245 \begin_layout Itemize
12251 \begin_layout Itemize
12257 \begin_layout Itemize
12263 \begin_layout Itemize
12265 \change_deleted -712698321 1501158888
12273 \begin_layout Itemize
12275 \change_deleted -712698321 1501158891
12288 \begin_layout Standard
12289 That is, all the major environments apart from the sectioning environments.
12290 Since foils are essentially self-contained sections, with a title and body,
12293 Foil\SpecialChar TeX
12296 provides specific commands for starting new foils and these are:
12299 \begin_layout Itemize
12305 \begin_layout Itemize
12311 \begin_layout Standard
12313 also provides slightly modified versions of these two environments called:
12316 \begin_layout Itemize
12322 \begin_layout Itemize
12325 ShortRotatefoilhead
12328 \begin_layout Standard
12329 and the differences will be explained in the next section.
12332 \begin_layout Standard
12333 Since foils are often used in presenting ideas or new theorems and such
12336 Foil\SpecialChar TeX
12339 also provides a comprehensive box of goodies for presenting them:
12342 \begin_layout Standard
12343 \begin_inset Flex Multiple Columns
12346 \begin_layout Itemize
12352 \begin_layout Itemize
12358 \begin_layout Itemize
12364 \begin_layout Itemize
12370 \begin_layout Itemize
12376 \begin_layout Itemize
12382 \begin_layout Itemize
12388 \begin_layout Itemize
12394 \begin_layout Itemize
12400 \begin_layout Itemize
12406 \begin_layout Itemize
12417 \begin_layout Standard
12418 The starred versions are unnumbered while the unstarred versions are numbered.
12419 There are also two list environments added by \SpecialChar LyX
12423 \begin_layout Itemize
12429 \begin_layout Itemize
12435 \begin_layout Standard
12438 Foil\SpecialChar TeX
12441 provides some powerful header and footer capabilities that are best set
12442 in the preamble although they may be set at any point in a document.
12443 If you want to change these settings in your document the best place to
12444 do so is at the very top of a foil, i.
12445 \begin_inset space \thinspace{}
12451 \begin_inset space \space{}
12456 straight after the foilhead.
12459 \begin_layout Standard
12460 For this purpose, the following command styles are provided [
12467 \begin_layout Standard
12468 \begin_inset Flex Multiple Columns
12471 \begin_layout Itemize
12475 \begin_inset space ~
12481 \begin_layout Itemize
12487 \begin_layout Itemize
12491 \begin_inset space ~
12497 \begin_layout Itemize
12501 \begin_inset space ~
12507 \begin_layout Itemize
12511 \begin_inset space ~
12518 \begin_layout Plain Layout
12519 \begin_inset space ~
12531 \begin_layout Standard
12532 There are also a few commands provided by
12534 Foil\SpecialChar TeX
12537 that aren't directly supported by \SpecialChar LyX
12538 but I'll tell you what they do and how
12539 to use them in section
12540 \begin_inset space ~
12544 \begin_inset CommandInset ref
12546 reference "sec:unsuppfoils"
12553 \begin_layout Subsection
12554 Building a Set of Foils
12557 \begin_layout Standard
12558 This section will give a simple introduction to using the different environments
12559 to build a set of foils.
12560 If you want to see an example set of foils, take a look at the
12564 file you find in \SpecialChar LyX
12572 \begin_layout Subsubsection
12573 Give It a Title Page
12576 \begin_layout Standard
12577 Unlike other classes that provide
12597 creates the title on a page of its own.
12598 If you leave out the
12602 environment \SpecialChar LaTeX
12603 will substitute the current date (every time you regenerate
12607 \begin_layout Subsubsection
12611 \begin_layout Standard
12612 As I mentioned earlier, there are four ways of starting a new foil.
12613 For portrait foils you should use
12622 The difference between these two environments is the amount of space between
12623 the title of the foil (the foilhead) and the body of the foil.
12626 \begin_layout Standard
12627 Landscape foils are generated using the
12633 ShortRotatefoilhead
12636 Again the only difference is the spacing between foilhead and body.
12637 Both of the short versions have 0.5
12638 \begin_inset space ~
12641 inches less separation between the foilhead and the body.
12645 \begin_layout Standard
12646 One problem with the support for landscape foils is the requirement that
12647 you have to use the
12651 driver to generate the PostScript output otherwise the foils won't be rotated.
12652 It is possible to get landscape foils even if you haven't got the
12656 driver provided you can feed your foils sideways through your printer ;-)
12659 \begin_layout Subsubsection
12660 Theorems, Lemmas, Proofs and more
12663 \begin_layout Standard
12665 \change_deleted -712698321 1501160146
12666 Due to a small bug in \SpecialChar LyX
12668 \change_inserted -712698321 1501160146
12671 ou can't have two of the same type of these environments directly following
12674 \change_inserted -712698321 1501160182
12675 If you use a normal paragraph break,
12676 \change_deleted -712698321 1501160188
12677 They must be separated by something.
12680 , you will just be extending the previous environment as if you had merged
12681 the two environments together.
12683 \change_deleted -712698321 1501160194
12684 So, how do you get around this problem? The simplest option is to insert
12685 some text between the two environments or add a
12690 environment between the two with just a
12691 \begin_inset Quotes eld
12699 \begin_inset Quotes erd
12703 This will force \SpecialChar LyX
12704 to produce two separate environments and hence the correct
12707 An example is provided in the example file included with the \SpecialChar LyX
12709 Remember, this problem only occurs if you are trying to place two of the
12710 same type of theorem-like environments one directly after the other.
12712 \change_inserted -712698321 1501160255
12713 Rather than that, you need to insert a so-called separator.
12714 Please refer to the section entitled
12727 \begin_layout Subsubsection
12731 \begin_layout Standard
12732 You get all the commonly supported list styles found in other classes as
12733 well as two new ones.
12734 I'll only describe the new ones here.
12735 If you want to find out more about the other list environments check out
12741 If you intend to use itemized lists you might also want to read about the
12745 \begin_inset space ~
12749 \begin_inset space ~
12754 dialog described above in section
12755 \begin_inset space ~
12759 \begin_inset CommandInset ref
12761 reference "sec:bullet"
12768 \begin_layout Standard
12769 The two new list styles,
12777 , are designed to make it easier for you to create lists of do's and don'ts
12778 or right and wrong by providing dedicated environments that use a tick
12779 or a cross as the label of the list.
12780 These lists are in fact dedicated variants of the
12785 They do however require that you have the
12789 packages installed.
12792 \begin_layout Subsubsection
12796 \begin_layout Standard
12799 Foil\SpecialChar TeX
12802 redefines the floating tables and figures so that they appear exactly where
12803 they are in the text rather than pushing them to the top of the page or
12804 to some user specified location.
12805 In fact if you change the float placement settings they are simply ignored.
12808 \begin_layout Subsubsection
12809 Page Headers and Footers
12810 \begin_inset CommandInset label
12812 name "sec:foilfoot"
12819 \begin_layout Standard
12823 \begin_inset space ~
12832 are two commands used to control the left-footer text string.
12833 The first is meant to allow you to include a graphic logo on your foils
12835 \begin_inset Quotes eld
12840 Foil\SpecialChar TeX
12844 \begin_inset Quotes erd
12848 While the second is meant to provide a classification for the audience,
12852 \begin_inset space \thinspace{}
12858 \begin_inset space \space{}
12862 It is empty by default.
12865 \begin_layout Standard
12866 The remaining page corners can be filled by
12869 \begin_inset space ~
12874 (which defaults to page numbers),
12877 \begin_inset space ~
12885 \begin_inset space ~
12893 \begin_layout Subsection
12896 Foil\SpecialChar TeX
12900 \begin_inset CommandInset label
12902 name "sec:unsuppfoils"
12909 \begin_layout Standard
12910 All the commands mentioned below need to be set in a
12920 within another environment.
12923 \begin_layout Subsubsection
12927 \begin_layout Standard
12928 All lengths are adjusted using the
12951 should be replaced by the name given to the length you want to change and
12956 is the length value.
12957 All lengths should be specified in units of length such as inches (
12969 ) or relative to some document or font-based length such as
12979 \begin_layout Standard
12980 It's possible to change the spacing between a foilhead and the body of the
12981 foil by adjusting the length specified by
12988 For example, to make
12993 \begin_inset space \space{}
12996 in closer to their bodies put the following in the preamble:
13002 foilheadskip}{-0.5in}
13005 \begin_layout Standard
13006 The spacings around floats can be adjusted by setting these lengths:
13009 \begin_layout Labeling
13010 \labelwidthstring MMMMMMMMMMM
13017 Separation between the text and the top of the float
13020 \begin_layout Labeling
13021 \labelwidthstring MMMMMMMMMMM
13028 Separation between the float and the caption
13031 \begin_layout Labeling
13032 \labelwidthstring MMMMMMMMMMM
13039 Separation between the caption and the following text
13042 \begin_layout Labeling
13043 \labelwidthstring MMMMMMMMMMM
13050 You can make the captions narrower than the surrounding text by adjusting
13052 Best done relative to
13061 \begin_layout Standard
13062 There are also several title page related lengths that you may find useful
13063 if you have a long title or several authors:
13066 \begin_layout Labeling
13067 \labelwidthstring MMMMMMMMMMM
13074 Separation from headers to
13079 \begin_layout Labeling
13080 \labelwidthstring MMMMMMMMMMM
13098 \begin_layout Labeling
13099 \labelwidthstring MMMMMMMMMMM
13113 \begin_layout Labeling
13114 \labelwidthstring MMMMMMMMMMM
13130 \begin_layout Labeling
13131 \labelwidthstring MMMMMMMMMMM
13147 \begin_layout Standard
13148 The last length related command affects all the list environments.
13159 a list environment then all the vertical spacing between the list items
13161 Note that this is a command not a length so it doesn't require
13167 like the stuff mentioned above.
13170 \begin_layout Subsubsection
13171 Headers and Footers
13174 \begin_layout Standard
13187 commands control whether the logo in the
13191 definition appear on a given page.
13198 in the preamble then none of the foils will have the logo on them.
13199 If you don't want the logo on a particular page place the
13205 directly after the foilhead of that page and the
13211 directly after the next foilhead.
13214 \begin_layout Standard
13215 If you decide to use the
13219 page style setting in the
13222 \begin_inset space ~
13227 dialog you should probably add
13237 to your preamble so headers and footers on landscape pages are correctly
13238 placed when rotated.
13239 This is due to some clashes between the page layouts provided by the
13250 \begin_layout Section
13251 Hollywood (Hollywood spec scripts)
13254 \begin_layout Standard
13260 \begin_layout Subsection
13264 \begin_layout Standard
13265 Getting the format of a Hollywood script right is a
13266 \begin_inset Quotes eld
13270 \begin_inset Quotes erd
13273 It is designed to make the readers focus on content and to be easy and
13274 familiar for the actors to read.
13275 Each page of a script should be one minute of film.
13276 Nothing goes in a script that you cannot see or hear on screen.
13277 The courier 12 pt font should be used throughout.
13281 \begin_layout Subsection
13285 \begin_layout Standard
13286 Speakers' lines should NEVER break in mid-sentence.
13287 If a speaker's lines continue over a page break, repeat the
13291 title followed by (Cont'd).
13294 \begin_layout Subsection
13298 \begin_layout Standard
13303 names as labels then cross-reference the label to insert the name.
13304 The cross-reference dialog will show the current cast of characters.
13305 You can use this to insert the speaker name in narratives also.
13308 \begin_layout Subsection
13309 Paper size and Margins
13312 \begin_layout Standard
13313 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
13316 \begin_layout Subsection
13320 \begin_layout Standard
13321 The following environments are available.
13322 You can use hollywood.bind to get the bind keys shown at the right.
13325 \begin_layout Itemize
13329 \begin_inset Newline newline
13334 Used where nothing else works.
13338 \begin_layout Itemize
13344 \begin_inset space \hfill{}
13352 \begin_inset Newline newline
13355 Usually followed by something like
13356 \begin_inset Quotes eld
13359 on Sally waking up.
13360 \begin_inset Quotes erd
13366 \begin_layout Itemize
13370 \begin_inset space \hfill{}
13374 \begin_inset Newline newline
13379 Introduces a new INTERIOR camera set-up.
13380 Always followed by DAY or NIGHT, or something similar to define the lighting
13382 Everthing on this line in CAPS.
13385 \begin_layout Itemize
13389 \begin_inset space \hfill{}
13393 \begin_inset Newline newline
13398 Introduces a new EXTERIOR camera set-up.
13399 Everthing on this line in CAPS.
13402 \begin_layout Itemize
13406 \begin_inset space \hfill{}
13410 \begin_inset Newline newline
13415 The character speaking.
13418 \begin_layout Itemize
13422 \begin_inset space \hfill{}
13426 \begin_inset Newline newline
13431 Instructions to the speaker.
13432 The () are automatically inserted
13433 \change_deleted -712698321 1501161286
13434 , but only the ( will show in \SpecialChar LyX
13436 Both will be printed
13441 \begin_layout Itemize
13445 \begin_inset space \hfill{}
13449 \begin_inset Newline newline
13461 \begin_layout Itemize
13465 \begin_inset space \hfill{}
13469 \begin_inset Newline newline
13474 Camera movement instruction.
13476 \begin_inset space \thinspace{}
13480 \begin_inset space \space{}
13486 \begin_layout Itemize
13490 \begin_inset space \hfill{}
13496 \begin_layout Itemize
13500 \begin_inset space \hfill{}
13506 \begin_layout Itemize
13510 \begin_inset space \hfill{}
13516 \begin_layout Itemize
13520 \begin_inset space \hfill{}
13526 \begin_layout Subsection
13530 \begin_layout Itemize
13534 \begin_layout Itemize
13538 \begin_layout Itemize
13540 \begin_inset space \thinspace{}
13547 \begin_layout Itemize
13552 \begin_layout Itemize
13553 PAN — camera movement
13556 \begin_layout Itemize
13557 INSERT — cut to close-up of
13560 \begin_layout Section
13564 \begin_layout Standard
13567 Panayotis Papasotiriou
13570 \begin_layout Subsection
13574 \begin_layout Standard
13575 The ijmpc package is a set of macros that facilitates electronic manuscript
13578 International Journal of Modern Physics C
13581 Similarly, the ijmpd package is for creating manuscripts to be submitted
13584 International Journal of Modern Physics D
13587 Both journals are published by World Scientific.
13588 The corresponding document classes are named
13597 These files, together with instructions for the authors, can be downloaded
13599 \begin_inset Flex URL
13602 \begin_layout Plain Layout
13604 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
13610 \begin_inset Flex URL
13613 \begin_layout Plain Layout
13615 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
13621 Both packages are modified versions of the standard
13622 \begin_inset Quotes eld
13626 \begin_inset Quotes erd
13629 package, and they are almost (but not exactly) identical.
13630 Most of their features are supported by \SpecialChar LyX
13632 I have used \SpecialChar LyX
13633 successfully to write articles submitted to both journals
13634 without any problem.
13637 \begin_layout Subsection
13641 \begin_layout Standard
13642 As usual, the easiest way to write a paper is to start with a template.
13645 File\SpecialChar menuseparator
13661 This will give an (almost) empty document that includes the most common
13662 fields found in a manuscript.
13663 Simply overwrite the existing text (including the brackets,
13668 You should keep in mind the following remarks.
13671 \begin_layout Enumerate
13673 won't let you change the font size and the page style of the document,
13674 because such modifications are not allowed by both packages.
13677 \begin_layout Enumerate
13678 The language of the document should not be changed.
13679 Before previewing your paper, be sure that the babel package is not used.
13680 To do this, click on
13681 \change_inserted -712698321 1501082726
13685 arg "dialog-show document"
13691 \change_deleted -712698321 1501082743
13696 \SpecialChar menuseparator
13698 \change_deleted -712698321 1501082747
13700 \change_inserted -712698321 1501082748
13706 \change_deleted -712698321 1501082762
13715 checkbox in the language settings, and click on
13723 , if you wish to make this change permanent)
13724 \change_inserted -712698321 1501082770
13726 \begin_inset Quotes eld
13730 \begin_inset Quotes erd
13742 \begin_layout Enumerate
13744 \begin_inset Quotes eld
13748 \begin_inset Quotes erd
13751 style must be used to define keywords.
13754 \begin_layout Enumerate
13755 The ijmpc package provides a style named
13756 \begin_inset Quotes eld
13759 Classification Codes
13760 \begin_inset Quotes erd
13763 , which can be used to define classification codes, such as PACS numbers.
13764 Note that this facility is not supported by the ijmpd package.
13767 \begin_layout Enumerate
13768 Several new environments are available:
13769 \begin_inset Quotes eld
13773 \begin_inset Quotes erd
13777 \begin_inset Quotes eld
13781 \begin_inset Quotes erd
13785 \begin_inset Quotes eld
13789 \begin_inset Quotes erd
13793 \begin_inset Quotes eld
13797 \begin_inset Quotes erd
13801 \begin_inset Quotes eld
13805 \begin_inset Quotes erd
13809 \begin_inset Quotes eld
13813 \begin_inset Quotes erd
13817 \begin_inset Quotes eld
13821 \begin_inset Quotes erd
13825 \begin_inset Quotes eld
13829 \begin_inset Quotes erd
13833 \begin_inset Quotes eld
13837 \begin_inset Quotes erd
13841 \begin_inset Quotes eld
13845 \begin_inset Quotes erd
13849 \begin_inset Quotes eld
13853 \begin_inset Quotes erd
13857 \begin_inset Quotes eld
13861 \begin_inset Quotes erd
13865 \begin_inset Quotes eld
13869 \begin_inset Quotes erd
13873 \begin_inset Quotes eld
13877 \begin_inset Quotes erd
13881 Their use is more or less obvious.
13883 supports all these environments; it will use the proper label, text style,
13884 and numbering scheme for each of them.
13887 \begin_layout Enumerate
13888 Both packages use basic citations; the natbib package should not be used.
13889 In \SpecialChar LyX
13890 , citation references are shown as usual; in the output, citations are
13891 shown as superscripts.
13892 If you want to use a citation as normal text, you should use the
13897 \begin_inset space \thinspace{}
13901 \begin_inset space \space{}
13905 \begin_inset Quotes eld
13909 \begin_inset space \space{}
13919 \begin_inset Quotes erd
13925 \begin_layout Enumerate
13927 \begin_inset Quotes eld
13931 \begin_inset Quotes erd
13934 section in both packages.
13935 To put acknowledgments, just use the
13936 \begin_inset Quotes eld
13940 \begin_inset Quotes erd
13946 \begin_layout Enumerate
13947 Appendices may be added to the paper,
13951 the Acknowledgments and
13957 provides a special environment, called
13958 \begin_inset Quotes eld
13962 \begin_inset Quotes erd
13965 which marks the beginning of the appendices.
13966 This environment should be left blank; it just sends a \SpecialChar LaTeX
13967 command, but nothing
13969 In \SpecialChar LyX
13971 \begin_inset Quotes eld
13975 \begin_inset Quotes erd
13978 is printed with blue letters, as a signal that all sections after that
13979 point are appendices.
13980 To write an appendix, use the
13981 \begin_inset Quotes eld
13985 \begin_inset Quotes erd
13990 will number each appendix with capital letters, as required by both journals.
13992 \begin_inset Quotes eld
13996 \begin_inset Quotes erd
14003 be present before the first appendix; if not, all appendices will be numbered
14004 as normal sections in the output.
14007 \begin_layout Enumerate
14008 The ijmpc and the ijmpd packages use the
14012 command to implement table captions.
14013 As a result, a table created by \SpecialChar LyX
14014 is printed correctly, but its caption
14016 However, you can use some \SpecialChar TeX
14017 code to overcome this problem, so that captions
14018 are printed as expected.
14019 To do so, create a float table as usual, remove the caption, and replace
14020 it with the \SpecialChar TeX
14031 (sic); you must also the \SpecialChar TeX
14036 immediately after the tabular material.
14037 Study the example table included in the template files to see how this
14038 trick is implemented.
14039 Alternatively, If you need table captions, you should implement the whole
14044 file, then include this file to the \SpecialChar LyX
14047 Insert\SpecialChar menuseparator
14048 File\SpecialChar menuseparator
14050 \begin_inset space ~
14056 Details on how to create a table float can be found in the files
14064 , included in the corresponding packages.
14067 \begin_layout Subsection
14068 Preparing a paper for submission
14071 \begin_layout Standard
14072 Before you submit your paper you must export the \SpecialChar LyX
14073 document as a \SpecialChar LaTeX
14076 File\SpecialChar menuseparator
14077 Export\SpecialChar menuseparator
14085 \begin_layout Plain Layout
14086 Actually you have the choice between \SpecialChar LaTeX
14087 (plain) and pdflatex.
14088 If you intend to use pdflatex to prepare the paper, you should use the
14089 pdflatex option so that included graphics are converted to PDF format,
14090 ready for use by pdflatex.
14095 , then make the following changes to the resulting
14102 \begin_layout Enumerate
14103 Remove the comment lines before the
14112 \begin_layout Enumerate
14113 Remove everything between (and including) the
14125 commands, except for any commands you specifically put into the \SpecialChar LaTeX
14129 \begin_layout Standard
14134 file should be saved and processed through \SpecialChar LaTeX
14135 as many times as necessary.
14136 You may also want to check the resulting
14143 \begin_layout Subsection
14145 \change_deleted -712698321 1501082212
14146 Use of \SpecialChar TeX
14150 \begin_layout Standard
14152 \change_deleted -712698321 1501082212
14153 The use of \SpecialChar TeX
14154 code is reduced to two commands, which must be placed at the
14155 top of the document.
14156 If you started writing your paper by using the
14164 template, the \SpecialChar TeX
14165 code needed is already in its place; you usually don't need
14167 You may only modify the first \SpecialChar TeX
14168 code to specify the information printed
14169 to the top of odd and even pages (authors' names and short paper's title,
14171 This \SpecialChar TeX
14172 code must have the form
14176 markboth{Authors' Names}{Short Paper's Title}
14183 \begin_layout Section
14187 \begin_layout Standard
14193 \begin_layout Subsection
14197 \begin_layout Standard
14198 The iopart package provides a document class to create electronic manuscript
14199 submission to the journals published by the Institute of Physics.
14200 Instructions for the authors how to create a paper using the iopart class
14201 can be downloaded together with the iopart package from the site
14202 \begin_inset Flex URL
14205 \begin_layout Plain Layout
14207 ftp://ftp.iop.org/pub/journals/latex2e
14215 \begin_layout Subsection
14219 \begin_layout Standard
14220 The easiest way to write a paper is to start with the
14221 \change_deleted -712698321 1501162201
14223 \change_inserted -712698321 1501162202
14231 \change_deleted -712698321 1501162208
14232 in \SpecialChar LyX
14233 's examples files folder
14234 \change_inserted -712698321 1501162222
14237 File\SpecialChar menuseparator
14238 New From Template\SpecialChar ldots
14240 \change_deleted -712698321 1501162219
14247 \change_deleted -712698321 1501162234
14248 Open this file, save it under a new name, and start writing.
14252 \change_deleted -712698321 1501162238
14254 \change_inserted -712698321 1501162239
14257 explains how to use the special text environments.
14258 Here are the most important advices:
14261 \begin_layout Itemize
14262 To be able to compile your document to a PDF, PS, or DVI, ensure that the
14264 \change_deleted -712698321 1501162254
14267 Use AMS math package
14269 in the document settings under
14274 \change_inserted -712698321 1501162277
14275 no AMS packages are loaded in
14277 Document\SpecialChar menuseparator
14278 Settings\SpecialChar menuseparator
14286 \begin_layout Itemize
14289 The title environment defines the kind of your paper.
14290 So use one of the following environments for the title:
14294 \begin_layout Itemize
14303 \begin_layout Itemize
14312 \begin_layout Itemize
14318 for a Topical review
14321 \begin_layout Itemize
14330 \begin_layout Itemize
14339 \begin_layout Itemize
14345 for a Paper (same as Title)
14348 \begin_layout Itemize
14354 for a Preliminary communication
14357 \begin_layout Itemize
14363 for a Rapid communication
14366 \begin_layout Itemize
14372 for a Letter to the editor
14376 \begin_layout Itemize
14379 All title environments except of
14383 can have an optional short title.
14386 \begin_layout Itemize
14387 There is a general title environment
14391 which is not directly supported by
14392 \change_deleted -712698321 1501162663
14397 This can be used as \SpecialChar TeX
14398 code when your document doesn't fit into one of the
14402 \begin_layout Standard
14403 For more informations like hints for special table and formula formatting,
14404 look at the IOP author guidelines.
14407 \begin_layout Section
14411 \begin_layout Standard
14414 Panayotis Papasotiriou
14417 \begin_layout Subsection
14421 \begin_layout Standard
14422 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
14423 that facilitates electronic manuscript submission to the journals they
14425 Most known of them (at least in my domain of interest) are
14427 Astrophysics and Space Science
14433 , but there are many others (see a complete list at
14434 \begin_inset Flex URL
14437 \begin_layout Plain Layout
14439 http://www.wkap.nl/jrnllist.htm/JRNLHOME
14445 The Kluwer package may be downloaded from the site
14446 \begin_inset Flex URL
14449 \begin_layout Plain Layout
14451 http://www.wkap.nl/kaphtml.htm/STYLEFILES
14457 A complete user guide is contained in that package (but it can also be
14458 downloaded separately).
14461 \begin_layout Standard
14463 supports many features of the package but not everything.
14464 However, the \SpecialChar TeX
14465 code needed is reduced to some
14466 \begin_inset Quotes eld
14470 \begin_inset Quotes erd
14473 commands of the package (see
14474 \begin_inset space ~
14478 \begin_inset CommandInset ref
14480 reference "subsec:kluwer_peculiarities"
14485 I have recently used \SpecialChar LyX
14486 to write an article submitted to the
14488 Astrophysics and Space Science
14490 without any problem.
14493 \begin_layout Subsection
14497 \begin_layout Standard
14498 The easiest way to write a paper is to start with the Kluwer template file.
14501 File\SpecialChar menuseparator
14513 This will give an (almost) empty document that includes the most common
14514 fields found in a manuscript and a short description of their use.
14515 As in most templates, simply overwrite the existing text (including the
14520 ) with the correct information.
14523 \begin_layout Subsection
14524 Preparing a paper for submission
14527 \begin_layout Standard
14528 As in the AAS\SpecialChar TeX
14529 package, before you submit your paper to a journal you must
14531 \begin_inset Quotes eld
14535 \begin_inset Quotes erd
14541 \begin_layout Enumerate
14542 Export your paper as a \SpecialChar LaTeX
14544 To do this, click on
14546 File\SpecialChar menuseparator
14547 Export\SpecialChar menuseparator
14555 \begin_layout Enumerate
14560 file with a text editor and make the following changes
14564 \begin_layout Enumerate
14565 remove the comment lines before the
14574 \begin_layout Enumerate
14575 remove everything between (and including) the
14587 commands, except for any commands you specifically put into the \SpecialChar LaTeX
14591 \begin_layout Standard
14600 \begin_layout Enumerate
14605 file through \SpecialChar LaTeX
14606 as many times as necessary (usually up to three).
14609 \begin_layout Enumerate
14615 \begin_inset space \thinspace{}
14619 \begin_inset space \space{}
14626 , and check if everything is OK (it should, if you didn't make any mistake).
14629 \begin_layout Subsection
14630 \begin_inset Quotes eld
14634 \begin_inset Quotes erd
14637 of the Kluwer package
14638 \begin_inset CommandInset label
14640 name "subsec:kluwer_peculiarities"
14647 \begin_layout Standard
14648 The Kluwer package has the following
14649 \begin_inset Quotes eld
14653 \begin_inset Quotes erd
14659 \begin_layout Enumerate
14660 It is possible to write multiple articles in the same \SpecialChar LaTeX
14665 \begin_layout Plain Layout
14666 I can't imagine any good reason to do this.
14672 Each article must be included in the environment
14673 \begin_inset Quotes eld
14677 \begin_inset Quotes erd
14681 Unfortunately, this environment cannot be omitted, even if you write just
14683 Therefore, each article starts with the command
14689 and, obviously, ends with the command
14696 Although this can be implemented in \SpecialChar LyX
14697 , I didn't included it, since it looks
14698 ugly and can confuse the novice user.
14699 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
14702 \begin_inset Quotes eld
14707 \begin_inset Quotes erd
14713 \begin_layout Enumerate
14714 Information given at the beginning of the article (i.
14715 \begin_inset space \thinspace{}
14719 \begin_inset space \space{}
14722 title, subtitle, author, institution, running title, running author, abstract
14723 and keywords) must be included in an environment called
14724 \begin_inset Quotes eld
14728 \begin_inset Quotes erd
14732 This is not implemented in \SpecialChar LyX
14733 , so you must enter title, subtitle etc.
14734 \begin_inset space ~
14737 between two \SpecialChar TeX
14753 \begin_layout Enumerate
14754 According to the user manual, the label of each bibliography item must be
14778 \begin_layout Standard
14783 template takes care of all these
14784 \begin_inset Quotes eld
14788 \begin_inset Quotes erd
14792 If you start a new paper using this template you don't need to do anything
14797 \begin_layout Enumerate
14798 don't delete the \SpecialChar TeX
14799 code included in the template, and
14802 \begin_layout Enumerate
14803 copy the example bibliography item included in the template and modify it
14804 as necessary to enter new bibliography items.
14807 \begin_layout Section
14811 \begin_layout Standard
14817 \begin_layout Subsection
14821 \begin_layout Standard
14822 The \SpecialChar LyX
14825 article (koma-script)
14829 report (koma-script)
14847 correspond to the \SpecialChar LaTeX
14865 \begin_inset space ~
14868 of the Koma-Script family.
14869 They are replacements for the standard document classes
14885 , resp., and fit better to European typography conventions in a number of
14889 \begin_layout Itemize
14890 Standard character size is 11pt in
14892 article (koma-script)
14896 report (koma-script)
14904 letter (koma-script)
14909 \begin_layout Itemize
14910 Headings, labels of the description environment, and a number of elements
14913 letter (koma-script)
14915 document class are set in a bold sans serif font.
14919 \begin_layout Plain Layout
14920 There is a big difference between the bold sans serif old cm fonts and new
14921 ec fonts, especially in the appearance of headings.
14922 In comparison, the ec bold sans serif fonts look a bit thin.
14923 Here the \SpecialChar LaTeX
14932 helps to produce the
14933 \begin_inset Quotes eld
14937 \begin_inset Quotes erd
14940 appearance when using the ec fonts.
14945 The numbering of chapter headings is made in the same way as the numbering
14946 of section headings, that is without the extra line
14947 \begin_inset Quotes eld
14950 Chapter\SpecialChar ldots
14952 \begin_inset Quotes erd
14956 In addition, the appearance of the headings can be modified by using a
14957 number of options (in \SpecialChar LyX
14958 to be entered in the field
14961 \begin_inset space ~
14968 Layout\SpecialChar menuseparator
14975 \begin_layout Itemize
14976 The main means in the Koma-Script document classes to design the type area
14985 (in \SpecialChar LyX
14986 to be entered in the extra class options field in the dialog
14988 Document\SpecialChar menuseparator
14992 They make a clearer modification of page margins possible as do the options
14995 Document\SpecialChar menuseparator
15002 \begin_layout Itemize
15003 The \SpecialChar LaTeX
15004 document classes of the Koma-Script family define a number of additional
15006 Those part of it which makes sense in \SpecialChar LyX
15007 is implemented in corresponding
15011 \begin_layout Standard
15012 Detailed descriptions of the \SpecialChar LaTeX
15013 document classes of the Koma-Script family
15014 can be found in the Koma-Script documentation
15025 \begin_layout Subsection
15026 article (koma-script), report (koma-script), and book (koma-script)
15029 \begin_layout Standard
15030 The document classes
15032 article (koma-script)
15036 report (koma-script)
15046 are implemented in the layout files
15059 They contain all the paragraph types of the corresponding standard document
15072 , resp., partly modified, with the exception of the \SpecialChar LyX
15077 -type, which is replaced by the new
15081 -type having the same functionality.
15086 -Type there is a number of new paragraph types added.
15093 letter (koma-script)
15098 \begin_layout Itemize
15107 : are equivalents to
15115 , resp., additionally inserting an entry in the table of contents.
15124 are not contained in
15126 article (koma-script)
15131 \begin_layout Itemize
15140 : behave exactly as
15148 , resp., additionally clearing running heads.
15153 is not contained in
15155 article (koma-script)
15161 \begin_layout Plain Layout
15174 report (koma-script)
15176 , but since this is identical to
15180 , is has not been implemented in \SpecialChar LyX
15189 \begin_layout Itemize
15194 : generates a heading directly above the following paragraph in the standard
15195 character size without affecting the structure of the document.
15198 \begin_layout Itemize
15207 are special captions which respect the different space settings needed
15208 for captions placed above or below an element (if you follow strict typographic
15209 rules, you might want to place table captions always above the table).
15210 You can also use the class option
15214 , which will switch
15227 You need at least Koma-Script version 2.8q to use this.
15230 \begin_layout Itemize
15235 : can be used to set a bonmot, e.
15236 \begin_inset space \thinspace{}
15240 \begin_inset space \space{}
15243 at the beginning of a chapter.
15244 If you use the optional argument (
15246 Insert\SpecialChar menuseparator
15248 \change_deleted -712698321 1501163301
15250 \begin_inset space ~
15254 \change_inserted -712698321 1501163306
15256 \begin_inset space ~
15263 ), you can insert the dictum's author there.
15264 Dictum and author are separated by a line.
15265 You need at least Koma-Script version 2.8q to use this.
15270 is not contained in
15272 article (koma-script)
15277 \begin_layout Standard
15278 The following types, together with the standard types
15290 , form the title area of the document.
15291 They must be entered ahead of the first
15292 \begin_inset Quotes eld
15296 \begin_inset Quotes erd
15303 \begin_layout Plain Layout
15304 The corresponding \SpecialChar LaTeX
15305 commands must appear before the
15316 When such a type is used more than once, the latter usage overwrites the
15317 former one, that means, for every type only the latest usage is valid.
15318 The order of the different types however has, like
15330 , no effect on the appearance of the produced document.
15333 \begin_layout Itemize
15338 : produces a centered paragraph above the ordinary title (
15350 ) for the subject of the document.
15353 \begin_layout Itemize
15358 : produces a centered paragraph below the ordinary title (
15370 ) for the publishers' name.
15373 \begin_layout Itemize
15380 report (koma-script)
15386 produces a centered paragraph on its own page behind the title page, or
15389 article (koma-script)
15391 produces a centered paragraph below the ordinary title (
15407 ) for a dedication.
15410 \begin_layout Itemize
15415 : produces a left aligned paragraph above the ordinary title (
15431 ) for a document`s head.
15434 \begin_layout Itemize
15439 : produces in a double-sided print in
15441 report (koma-script)
15447 a left-aligned paragraph at the top of the title page`s back or has no
15448 effect in a single-sided print or in
15450 article (koma-script)
15455 \begin_layout Itemize
15460 : produces in a double-sided print in
15462 report (koma-script)
15468 a left-aligned paragraph at the bottom of the title page`s back or has
15469 no effect in a single-sided print or in
15471 article (koma-script)
15476 \begin_layout Itemize
15481 : produces a special
15482 \begin_inset Quotes eld
15486 \begin_inset Quotes erd
15489 page ahead of the actual document containing a paragraph without special
15493 \begin_layout Standard
15494 The layout files for the document classes
15496 article (koma-script)
15500 report (koma-script)
15506 do include the file
15511 This is thought of as a place to define your own types.
15516 in your personal layout directory and edit the file!
15519 \begin_layout Subsection
15520 letter (koma-script)
15523 \begin_layout Description
15525 \change_inserted -712698321 1501163945
15526 Note: This section discusses the obsolete
15528 KOMA-Script-Letter (v.
15529 \begin_inset space ~
15534 , which is not even included anymore in recent KOMA releases.
15535 Please refer to the next section for the current KOMA-Script-Letter class
15537 \begin_inset space ~
15543 \begin_layout Standard
15547 letter (koma-script)
15549 is implemented in the layout file
15554 It contains all the paragraph types of the corresponding standard document
15559 , partly modified, with the exception of the \SpecialChar LyX
15573 type, which is replaced by the new
15578 In addition, it contains, in contrast to the standard document class, the
15597 Furthermore, there are a number of new letter specific types.
15600 \begin_layout Standard
15601 The appearance of the letter produced by this document class can be controlled
15602 by a number of \SpecialChar LaTeX
15603 commands, which you can put in the \SpecialChar LaTeX
15608 \begin_layout Plain Layout
15609 For example, the standard appearance of the letter`s heading, consisting
15610 of name and address, is quite self-willed.
15612 \begin_inset Quotes eld
15616 \begin_inset Quotes erd
15619 heading is produced by the following \SpecialChar LaTeX
15620 commands in the preamble:
15623 \begin_layout LyX-Code
15633 \begin_layout LyX-Code
15649 \begin_layout LyX-Code
15659 \begin_layout LyX-Code
15679 A detailed German description of such \SpecialChar LaTeX
15680 commands can be found in the Koma-Script
15686 With it, the letter's author can produce his personal letter layout.
15689 \begin_layout Standard
15698 define the beginning of the letter and must be used in every letter.
15699 To emphasize them in the \SpecialChar LyX
15700 document class, they are marked with the letter
15710 \begin_inset space ~
15713 in the left margin.
15714 It is possible to write any number of letters in one file.
15719 type produces a new letter using the same addressee and a
15723 type produces a new addressee.
15740 are ordinary paragraph types and can also be used several times in one
15741 and the same letter.
15744 \begin_layout Itemize
15749 : produces a paragraph for the addressee and implicitly defines the beginning
15753 \begin_layout Itemize
15758 : produces a paragraph for the form of address and implicitly produces a
15762 \begin_layout Itemize
15767 : produces a paragraph for a close.
15770 \begin_layout Itemize
15775 : produces a paragraph for a postscript.
15778 \begin_layout Itemize
15783 : produces a paragraph for a distribution list.
15786 \begin_layout Itemize
15791 : produces a paragraph for enclosures.
15794 \begin_layout Standard
15835 are input types provided with a label to enter information, which will
15836 be processed by the document class.
15840 \begin_layout Plain Layout
15841 It could be seen as a matter of inconsequence, that the types
15849 described above are not such input types as well.
15850 Because of the special meaning of those types, however, I have implemented
15851 them as ordinary paragraph types with a one letter mark in the left margin.
15852 Moreover, it would affect my feeling of symmetry, if the
15860 type had such a serious different appearance.
15865 The types must be used ahead of the corresponding
15872 \begin_layout Standard
15873 An implementation of these types in a WYSIWYG fashion does not seem to make
15874 sense, because the real appearance of the produced letter does not only
15875 depend on the usage of the particular type, but also on other factors.
15876 For example, a signature entered in the
15880 type will in the standard behavior appear in the produced letter only,
15881 when in the same letter also a
15886 The entered value of the
15890 type will in the standard behavior not appear in the produced letter at
15892 The possibility to design the letter`s heading freely is already indicated
15893 in a footnote above.
15896 \begin_layout Standard
15897 The input types can also be used as empty paragraphs.
15898 This makes sense e.
15899 \begin_inset space \thinspace{}
15903 \begin_inset space \space{}
15915 type is not used at all, in the standard behavior the value of the
15919 type is used as signature, whereas if an empty
15923 type is used, no signature value is defined.
15926 \begin_layout Standard
15927 By using the input types it is possible to write a letter template, containing
15928 filled input types with your personal dates (name, address, etc.) and empty
15929 input types for other dates you want to enter.
15932 \begin_layout Itemize
15937 : sender's name, in the standard behavior appears as a centered paragraph
15938 in small caps in the letter`s heading.
15941 \begin_layout Itemize
15946 : sender's signature, in the standard behavior appears below the
15955 type is used, the value of the
15959 type appears instead.
15962 \begin_layout Itemize
15967 : sender's address, in the standard behavior appears in a centered paragraph
15968 in the letter`s heading below the sender's name.
15971 \begin_layout Itemize
15976 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15987 \begin_layout Itemize
15992 : place of the letter`s making.
15995 \begin_layout Itemize
16000 : date of the letter`s making.
16009 , in the standard behavior, produce the place and the date in a right-aligned
16010 line below the addressee's field.
16015 type is used, neither place nor date appear, independent of the value of
16025 type is used, the date of the letter `s production is used.
16028 \begin_layout Itemize
16033 : sender`s back address, in the standard behavior appears above the addressee's
16034 field in a small sans serif font.
16037 \begin_layout Itemize
16042 : special mail information, in the standard behavior appears underlined
16043 above the addressee's field below the back address.
16046 \begin_layout Itemize
16051 : additional information, in the standard behavior appears on right side
16052 below the addressee`s field.
16055 \begin_layout Itemize
16060 : the letter's title, in the standard behavior appears in a big, bold, sans
16061 serif font above the subject.
16064 \begin_layout Itemize
16069 : the letter's subject, in the standard behavior appears in a bold font
16077 \begin_layout Standard
16098 produce a business letter like line above the
16102 line containing the fields
16103 \begin_inset Quotes eld
16107 \begin_inset Quotes erd
16111 \begin_inset Quotes eld
16115 \begin_inset Quotes erd
16119 \begin_inset Quotes eld
16123 \begin_inset Quotes erd
16127 \begin_inset Quotes eld
16131 \begin_inset Quotes erd
16135 \begin_inset Quotes eld
16139 \begin_inset Quotes erd
16143 \begin_inset Quotes eld
16147 \begin_inset Quotes erd
16151 For the date field, the value of the
16157 \begin_inset Quotes eld
16160 business letter types
16161 \begin_inset Quotes erd
16164 is used, the value of the
16168 type however does not appear, but only the \SpecialChar LaTeX
16176 The ordinary output of place and date in a right-aligned line below the
16177 addressee`s field is suppressed.
16178 The types are implemented as input types provided with a label and must
16179 be used ahead of the corresponding
16186 \begin_layout Itemize
16194 \begin_layout Itemize
16202 \begin_layout Itemize
16210 \begin_layout Itemize
16218 \begin_layout Itemize
16226 \begin_layout Subsection
16227 The new letter class: letter (koma-script v.2)
16230 \begin_layout Standard
16236 \begin_layout Standard
16237 \begin_inset VSpace medskip
16243 \begin_layout Standard
16245 Koma-Script version 2.8 has introduced a new letter class
16249 which supersedes the now unsupported
16254 It has — on the \SpecialChar LaTeX
16255 side — a completely new interface and is not compatible
16256 with the old class.
16257 Therefore, \SpecialChar LyX
16258 supports both, though it is recommended you use the new class.
16261 \begin_layout Standard
16262 This class covers the same functionality as
16264 letter (koma-script),
16267 The basic items are
16271 (receiver's address, same as
16275 in the old layout),
16288 will start a new letter (i.
16289 \begin_inset space \thinspace{}
16293 \begin_inset space \space{}
16296 you can write several letters per document).
16297 New elements are sender's
16313 and the possibility to use a
16319 Insert\SpecialChar menuseparator
16325 \begin_layout Standard
16326 The biggest improvement is, though, that the letter's layout is configurable
16327 to meet almost any needs.
16328 This can be done via the preamble or with a special style file (Letter
16329 Class Option, extension
16333 ), that will be read in as a class option.
16337 \begin_layout Plain Layout
16338 The KOMA package comes with some default
16343 There is, for instance, a
16347 file that follows german typesetting rules, or a
16351 that provides the default layout of the old
16356 The latter can be loaded with the class option
16362 Layout\SpecialChar menuseparator
16363 Document\SpecialChar menuseparator
16375 template that is included in \SpecialChar LyX
16377 A detailed description is to be found in the Koma-Script documentation
16385 \begin_layout Subsection
16389 \begin_layout Standard
16390 Visualizing the Koma-Script document classes in \SpecialChar LyX
16391 , the \SpecialChar LyX
16392 internals cause some
16396 \begin_layout Itemize
16397 The chapter number of a
16401 type appears on a line of its own above the chapter heading instead of
16402 appearing in the same line ahead of it.
16403 The cause for that is the \SpecialChar LyX
16404 internal behavior for the labeltype
16408 in the layout file.
16411 \begin_layout Itemize
16412 The headings of the types
16420 are only put in the
16421 \begin_inset Quotes eld
16425 \begin_inset Quotes erd
16429 table of contents, but not in the \SpecialChar LyX
16430 table of contents (
16432 Document\SpecialChar menuseparator
16434 \begin_inset space ~
16438 \begin_inset space ~
16446 \begin_layout Itemize
16447 The paragraphs in a
16451 document class appear in a skip separation mode, not indented.
16452 This is the standard behavior, no special \SpecialChar LaTeX
16453 commands are needed for that.
16456 Document\SpecialChar menuseparator
16459 dialog the corresponding radio button indicates
16468 value always has the effect that extra \SpecialChar LaTeX
16469 commands are inserted in the document
16470 to produce the gap, which is not what is wanted in this case.
16473 \begin_layout Section
16477 \begin_layout Standard
16483 \begin_layout Subsection
16487 \begin_layout Standard
16488 Memoir is a very powerful and constantly evolving class.
16489 It has been designed with regard to fictional and non-fictional literature.
16490 Its aim is to let the user have maximum control over the typesetting of
16492 Memoir is based on the standard book class, but it can also emulate the
16493 article class (see below).
16496 \begin_layout Standard
16497 Peter Wilson, the developer of Memoir, is known as the author of lots of
16498 useful packages in the \SpecialChar LaTeX
16500 Most of them have been merged with Memoir.
16501 Therefore, it is much easier to layout the table of contents, appendices,
16502 chapter designs and such.
16504 , though, does not support all of these goodies natively.
16505 Some of them might be added to forthcoming releases
16509 \begin_layout Plain Layout
16510 You are invited to send suggestions to
16511 \begin_inset Flex URL
16514 \begin_layout Plain Layout
16516 lyx-devel@lists.lyx.org
16526 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
16528 Of course you can still use all features with the help of some native \SpecialChar LaTeX
16530 commands (\SpecialChar TeX
16535 \begin_layout Plain Layout
16540 \begin_layout Plain Layout
16550 \begin_inset space ~
16554 \begin_inset CommandInset ref
16556 reference "sec:Inserting-TeX-Code"
16566 In this section, we can only list those features that are natively supported
16567 by \SpecialChar LyX
16569 For detailed descriptions (and for the rest of features) we recommend you
16570 have a look at the detailed manual of the Memoir class
16574 \begin_layout Plain Layout
16579 \begin_layout Plain Layout
16589 \begin_inset Flex URL
16592 \begin_layout Plain Layout
16594 CTAN:/macros/latex/memoir/memman.pdf
16604 , which is not only a user guide for the class, but also both a comprehensive
16605 description on good typesetting and a superb example for good typesetting
16609 \begin_layout Subsection
16610 Basic features and restrictions
16613 \begin_layout Standard
16614 Memoir supports basically all features of the standard book classes.
16615 There are, however, some differences, as follows:
16618 \begin_layout Description
16620 \begin_inset space ~
16623 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
16626 \begin_layout Description
16628 \begin_inset space ~
16631 style: The fancy page style is not supported, due to a command clash between
16632 Memoir and the fancyhdr package (they both define a command with the same
16633 name, which confuses \SpecialChar LaTeX
16635 Instead, Memoir comes with a number of its own page styles (see
16636 \change_deleted -712698321 1501165256
16639 Layout\SpecialChar menuseparator
16642 Document\SpecialChar menuseparator
16644 \change_inserted -712698321 1501165264
16645 Settings\SpecialChar menuseparator
16649 \begin_inset space ~
16655 If you want to use these for the chapter pages, you have to use the command
16662 in the main text or in preamble (e.
16663 \begin_inset space \thinspace{}
16667 \begin_inset space \space{}
16674 chapterstyle{companion}
16679 \begin_layout Description
16680 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
16681 optional argument in the standard classes.
16682 With this, you can specify an alternative version of the title for the
16683 table of contents and the headers (for instance, if the title is too long).
16684 In \SpecialChar LyX
16685 , you can do this via
16687 Insert\SpecialChar menuseparator
16689 \begin_inset space ~
16694 at the beginning of a chapter/section.
16695 Memoir features a second optional argument and thus separates the table
16696 of contents from the header.
16697 You can define three variants of a title with this: one for the main text,
16698 one for the table of contents, and one for the headers.
16700 \change_deleted -712698321 1501165686
16701 Simply insert two optional arguments if you need this feature, the first
16702 one containing the short title for the Table of Contents, the second one
16703 containing an alternative short title for the headers
16704 \change_inserted -712698321 1501165708
16706 makes these available in form of specific
16719 \begin_layout Description
16720 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
16721 of contents, the list of figures and the list of table start a new page
16723 Memoir does not follow this route.
16724 You have to insert a page break yourself, if you want to have one.
16727 \begin_layout Description
16728 Titlepage: For some unknown reason, Memoir uses pagination on the title
16729 page (in the standard classes, title pages are
16730 \begin_inset Quotes eld
16734 \begin_inset Quotes erd
16738 If you want an empty title page, type
16742 aliaspagestyle{title}{empty}
16747 \begin_layout Description
16748 Article: With the class option
16753 \change_deleted -712698321 1501165976
16756 Layout\SpecialChar menuseparator
16759 Document\SpecialChar menuseparator
16761 \change_inserted -712698321 1501165986
16762 Settings\SpecialChar menuseparator
16763 Class Settings\SpecialChar menuseparator
16765 \change_deleted -712698321 1501165988
16767 \change_inserted -712698321 1501165989
16771 \begin_inset space ~
16776 ), you can emulate article style.
16777 That is, counters (footnotes, figures, tables etc.) will not be reset on
16778 new chapters, chapters don't start a new page (but are—in contrary to
16779 \begin_inset Quotes eld
16783 \begin_inset Quotes erd
16786 article classes—still allowed), parts, though, use their own page, as in
16790 \begin_layout Description
16791 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
16792 font commands, which have been used in the old \SpecialChar LaTeX
16794 \begin_inset space \thinspace{}
16798 \begin_inset space \space{}
16814 It produces an error and stops \SpecialChar LaTeX
16815 whenever such a command appears.
16820 reallows the commands and spits out warnings instead (which does at least
16821 not stop \SpecialChar LaTeX
16823 Since a lot of packages and particularly Bib\SpecialChar TeX
16824 style files are still using
16825 those commands, we have decided to use this option by default.
16828 \begin_layout Subsection
16832 \begin_layout Standard
16833 We will only describe the features supported by \SpecialChar LyX
16834 (which is not much currently).
16835 Please consult the Memoir manual
16839 \begin_layout Plain Layout
16844 \begin_layout Plain Layout
16854 \begin_inset Flex URL
16857 \begin_layout Plain Layout
16859 CTAN:/macros/latex/memoir/memman.pdf
16872 \begin_layout Description
16873 Abstract: You may wonder why an abstract is an extra feature.
16874 Well, it is in book class.
16875 Usually books don't have abstracts.
16876 Memoir, however, has.
16877 You can use it wherever and how often you like.
16880 \begin_layout Description
16881 Chapterprecis: You may know this older typesetting style: The contents of
16882 a chapter are summarized below the title and also in the table of contents
16884 \begin_inset space \thinspace{}
16888 \begin_inset space \space{}
16893 Our hero arrives in Troia; he loses some friends; he finds others
16896 Chapterprecis does exactly this.
16897 It is therefore only sensible below a chapter.
16900 \begin_layout Description
16901 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16902 The epigraph environment provides an elegant way of typesetting such a
16904 The motto itself (text) and its
16905 \change_inserted -712698321 1501166968
16908 author (source) are divided by a short line.
16910 \change_deleted -712698321 1501166972
16911 Unfortunately, we have to fool \SpecialChar LyX
16912 a bit here again, since the environment
16913 needs two arguments (text and source).
16914 In this case, we have to use curly brackets (in \SpecialChar TeX
16915 mode) between the two
16926 <author of the slogan>
16927 \change_inserted -712698321 1501166996
16930 The author (source) can be inserted via
16932 Insert\SpecialChar menuseparator
16941 \begin_layout Description
16942 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16943 complex figurative poems).
16945 can only support a few of them.
16946 One is poemtitle, which is a centered title for poems, which will also
16947 be added to the table of contents (verse is the standard environment for
16949 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16951 because they have to be nested inside regular verse environments, which
16952 is not possible with \SpecialChar LyX
16956 \begin_layout Description
16957 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16960 \begin_layout Section
16961 Article (mwart), book (mwbk) and report (mwrep)
16962 \begin_inset Argument status
16965 \begin_layout Plain Layout
16978 \begin_layout Standard
16984 \begin_layout Standard
16985 The \SpecialChar LyX
17002 correspond to the \SpecialChar LaTeX
17016 They are replacements for the standard document classes
17028 , resp., and fit better to Polish typography conventions in a number of points.
17032 \begin_layout Standard
17036 \begin_layout Itemize
17037 Unnumbered titles (with star, e.
17038 \begin_inset space \thinspace{}
17042 \begin_inset space \space{}
17049 ) are added into table of contents,
17052 \begin_layout Itemize
17053 Additional page styles:
17057 \begin_layout Description
17058 uheadings header with separated lines,
17061 \begin_layout Description
17062 myheadings custom header, contents headers via commands:
17077 \begin_layout Description
17078 myuheadings custom header with separated lines,
17081 \begin_layout Description
17082 outer page number is placed on outer side of page
17086 \begin_layout Itemize
17091 \begin_layout Description
17092 rmheadings serif titles — default,
17095 \begin_layout Description
17096 sfheadings sansserif titles,
17099 \begin_layout Description
17100 authortitle on title page first placed is author next title — default,
17103 \begin_layout Description
17104 titleauthor on title page first placed is title next author,
17107 \begin_layout Description
17108 withmarginpar reserve place on page for margins.
17112 \begin_layout Section
17116 \begin_layout Standard
17121 provides an alternative to the standard
17126 It provides similar functionality, but you might prefer this layout with
17127 sans serif sections, headings, and more.
17130 \begin_layout Section
17131 Rev\SpecialChar TeX
17135 \begin_layout Standard
17141 \begin_layout Standard
17142 \begin_inset VSpace bigskip
17148 \begin_layout Standard
17153 \begin_inset space ~
17158 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
17160 \begin_inset Formula $\beta$
17163 release of May, 1999) class.
17166 \begin_layout Standard
17172 textclass, which works with Rev\SpecialChar TeX
17174 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
17176 That means that it doesn't interact very well with \SpecialChar LyX
17177 , which requires \SpecialChar LaTeX2e
17179 it has been kludged to work.
17180 Since Rev\SpecialChar TeX
17181 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
17186 Rev\SpecialChar TeX
17188 \begin_inset space ~
17193 textclass should also be pretty easy to use.
17196 \begin_layout Standard
17197 These documents are supposed to be used in
17201 to the Rev\SpecialChar TeX
17202 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
17204 and assume you'll know what to put in the preamble if necessary.
17207 \begin_layout Subsection
17211 \begin_layout Standard
17212 All you need to do is install Rev\SpecialChar TeX
17213 4, as described in the package's README
17215 The package can be found at The Rev\SpecialChar TeX
17217 \begin_inset Flex URL
17220 \begin_layout Plain Layout
17222 http://publish.aps.org/revtex4/
17228 Install it somewhere that \SpecialChar LaTeX
17230 Test it by trying to \SpecialChar LaTeX
17231 a short Rev\SpecialChar TeX
17232 4 document in some random directory (i.
17233 \begin_inset space \thinspace{}
17237 \begin_inset space \space{}
17240 not the directory where you installed the class file.) Then, if you reconfigure
17242 , it will find the class file and let you use the Rev\SpecialChar TeX
17246 \begin_layout Standard
17247 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
17256 \begin_inset space ~
17261 template, found in the templates directory.
17264 \begin_layout Subsection
17268 \begin_layout Standard
17269 Optional arguments to
17276 \begin_inset Quotes eld
17280 \begin_inset Quotes erd
17284 \begin_inset Quotes eld
17288 \begin_inset Quotes erd
17294 \begin_inset space ~
17302 \begin_inset space ~
17308 Remember that in Rev\SpecialChar TeX
17309 , at least one optional argument is required!
17312 \begin_layout Standard
17313 Other preamble matter, like
17320 \begin_inset space ~
17327 \begin_inset space ~
17332 dialog, also as usual.
17335 \begin_layout Subsection
17339 \begin_layout Standard
17340 The layouts basically correspond to the commands in Rev\SpecialChar TeX
17342 For example, the Email layout corresponds to
17349 Note that (at least as of Rev\SpecialChar TeX
17358 layouts are exactly equivalent, so you shouldn't need to use both.
17362 \begin_layout Plain Layout
17363 In case you're curious, both were included so that
17367 would be able to translate both
17387 \begin_layout Subsection
17391 \begin_layout Standard
17392 There are a couple of important unique aspects of Rev\SpecialChar TeX
17393 4 which might cause
17394 bugs that will be even more confusing in \SpecialChar LyX
17398 \begin_layout Standard
17399 In Rev\SpecialChar TeX
17417 The \SpecialChar LyX
17418 equivalent is that there is a separate Thanks layout.
17423 write footnotes in the
17427 layout, or weird things may happen.
17428 See the Rev\SpecialChar TeX
17429 4 documentation for more details.
17432 \begin_layout Standard
17436 \begin_inset space ~
17444 \begin_inset space ~
17453 layouts must be placed
17461 layout and the corresponding
17478 , the \SpecialChar LaTeX
17482 \begin_layout Subsection
17484 \change_deleted -712698321 1501168252
17488 \begin_layout Standard
17490 \change_deleted -712698321 1501168252
17491 The main problem with this layout is that you can't use the optional arguments
17492 to layouts like Email and Title.
17493 (The problem is not unique to this layout; you can't use optional arguments
17494 to the Section layouts either.) This means that after you export that file
17495 to \SpecialChar LaTeX
17496 (which you'll need to do eventually to send it in to APS), you'll need
17497 to edit the \SpecialChar LaTeX
17498 file with a text editor to add the optional arguments to set,
17500 \begin_inset space \thinspace{}
17504 \begin_inset space \space{}
17507 the running title for the page headers.
17508 Lacking these layouts makes the
17514 (and the equivalent
17520 ) useless, so the corresponding layouts don't exist, and will have to be
17525 \begin_layout Plain Layout
17530 actually, \SpecialChar LyX
17531 1.3.0 supports some forms of optional arguments, but this layout
17532 has not been updated yet to take advantage of it.
17542 \begin_layout Section
17543 Springer Journals (
17550 \begin_layout Standard
17556 \begin_layout Subsection
17560 \begin_layout Standard
17561 These are the layout files for some of the journal formats used by Springer
17562 Verlag and listed on
17563 \begin_inset Flex URL
17566 \begin_layout Plain Layout
17568 http://www.springer.de/author/tex/help-journals.html
17573 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
17575 It is a modular system: the things common to all journals are implemented
17580 , which journal-specific layout files (such as, e.
17581 \begin_inset space \thinspace{}
17585 \begin_inset space \space{}
17592 for Journal of Geodesy) can include.
17595 \begin_layout Standard
17596 This means that implementing support for any other Springer journal on this
17597 list is as simple as writing your own
17605 file following the outline given in
17613 \begin_layout Standard
17614 It is reasonably well tested only for the Journal of Geodesy.
17623 come with the standard \SpecialChar LyX
17625 Install the relevant class file (downloaded from Springer) in a proper
17626 directory, reconfigure \SpecialChar LaTeX
17627 (in the te\SpecialChar TeX
17632 , as root if necessary — doesn't \SpecialChar LyX
17633 take care of this?), reconfigure \SpecialChar LyX
17638 \begin_layout Subsection
17642 \begin_layout Standard
17643 A large number of theorem-like styles —
17655 \begin_layout Standard
17658 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
17659 _Title, Author_Running, Institute,
17660 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
17663 See the Springer class file documentation for details.
17666 \begin_layout Subsection
17670 \begin_layout Itemize
17682 \begin_layout Itemize
17685 Probability Theory and Related Fields
17691 — Jean-Marc Lasgouttes
17694 \begin_layout Standard
17695 Add your own, it isn't so hard!
17698 \begin_layout Subsection
17702 \begin_layout Standard
17703 These files are partly based on the older
17707 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
17709 file from Springer.
17714 layout, are now defunct.
17715 Jean-Marc Lasgouttes helped out big in making me find my way around the
17717 layout file mechanism.
17720 \begin_layout Subsection
17724 \begin_layout Standard
17726 But probably less than in the old hacked-\SpecialChar LaTeX
17734 \begin_layout Standard
17736 \change_deleted -712698321 1501168901
17738 \begin_inset space \thinspace{}
17741 g.: does not display the number for theorem-like layouts, just #.
17746 \begin_layout Section
17749 Sli\SpecialChar TeX
17753 \begin_inset CommandInset label
17762 \begin_layout Standard
17770 \begin_layout Subsection
17774 \begin_layout Standard
17775 This section describes how to use \SpecialChar LyX
17776 to make slides for overhead projectors.
17777 There are two document classes that can do this: the default slides class
17780 Foil\SpecialChar TeX
17784 This section documents the former.
17787 \begin_layout Standard
17788 I'm going to say this again, nice and clear, so that there's no misunderstanding
17792 \begin_layout Standard
17793 \begin_inset VSpace bigskip
17799 \begin_layout Standard
17803 This section documents the class
17804 \begin_inset Quotes eld
17812 \begin_inset Quotes erd
17820 \begin_layout Standard
17821 \begin_inset VSpace bigskip
17827 \begin_layout Standard
17828 If you're looking for the documentation for
17829 \begin_inset Quotes eld
17834 slides (Foil\SpecialChar TeX
17838 \begin_inset Quotes erd
17841 , check out section
17842 \begin_inset space ~
17846 \begin_inset CommandInset ref
17848 reference "sec:foiltex"
17858 \begin_inset Quotes eld
17863 slides (Foil\SpecialChar TeX
17867 \begin_inset Quotes erd
17870 ] is actually somewhat better than the default
17878 \begin_layout Plain Layout
17880 or so I've been told repeatedly by its advocates.
17881 Having never used it, I have no idea if this claim is true or not.
17886 which this section documents.
17889 \begin_layout Standard
17890 This class is the \SpecialChar LaTeX2e
17891 improvement of the old
17893 Sli\SpecialChar TeX
17897 Every \SpecialChar LaTeX2e
17898 distribution includes this class [which I'll just refer to as
17899 \begin_inset Quotes eld
17907 \begin_inset Quotes erd
17910 from now on], so you're bound to have it.
17911 As I noted earlier, there are other classes, such as
17915 , which also produce slides for overhead projectors and do a better job
17917 However, there are some things which
17921 can do which the others can't, such as generate overlays.
17922 Read on to learn more!
17925 \begin_layout Subsection
17927 \begin_inset CommandInset label
17929 name "sec:slidesetup"
17936 \begin_layout Standard
17937 Obviously, to use this document class, you need to select
17938 \begin_inset Quotes eld
17946 \begin_inset Quotes erd
17949 from the class list in the
17951 Document\SpecialChar menuseparator
17955 There are some other special things you should know about this class:
17958 \begin_layout Itemize
17959 Don't bother changing the options
17964 They're not supported by the
17971 \begin_layout Itemize
17975 \begin_inset space ~
17980 behaves a bit differently for this class.
17981 The possible choices and what they do are as follows:
17985 \begin_layout Description
17990 The final output contains page numbers in the lower right corner.
17993 \begin_layout Description
18002 , but also prints out any time markers you've put in.
18003 This is the default.
18006 \begin_layout Description
18011 The final output contains no page numbers, time markers, or alignment markers.
18015 \begin_layout Itemize
18020 class has an extra option:
18026 \begin_inset Quotes eld
18034 \begin_inset Quotes erd
18037 in the extra class options.
18041 \begin_layout Standard
18042 Using this options allows you to add time markers to
18048 \begin_inset space ~
18052 \begin_inset CommandInset ref
18054 reference "sec:slideNote"
18062 \begin_layout Standard
18063 You can also use the template file
18064 \begin_inset Quotes eld
18072 \begin_inset Quotes erd
18075 to automatically set up a document to use the
18081 File\SpecialChar menuseparator
18083 \begin_inset space ~
18087 \begin_inset space ~
18092 to open your new document].
18093 The template file also contains some examples of the special paragraph
18094 environments used by this class.
18095 I'll describe those next.
18098 \begin_layout Subsection
18099 Paragraph Environments
18102 \begin_layout Subsubsection
18103 Supported Environments
18106 \begin_layout Standard
18107 The first thing you'll notice when you start up a new
18111 document is the font size and type: it's the equivalent of the size
18112 \begin_inset Quotes eld
18120 \begin_inset Quotes erd
18126 \begin_inset space ~
18132 This is also what's used in the output.
18134 \begin_inset Quotes eld
18138 \begin_inset Quotes erd
18141 to remind you that this is a slide.
18142 Your final slides will use a larger font; ergo, you'll have less space.
18143 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
18146 \begin_layout Standard
18147 The next thing that becomes obvious is the changes to the paragraph environment
18148 pull-down box [at the far-left end of the toolbar].
18149 Most of the paragraph environments you're used to seeing are missing.
18150 There are also five new ones.
18155 class itself only supports certain paragraph environments:
18158 \begin_layout Itemize
18164 \begin_layout Itemize
18170 \begin_layout Itemize
18176 \begin_layout Itemize
18182 \begin_layout Itemize
18188 \begin_layout Itemize
18194 \begin_layout Itemize
18200 \begin_layout Itemize
18206 \begin_layout Itemize
18212 \begin_layout Itemize
18219 \begin_layout Itemize
18221 \change_deleted -712698321 1501169265
18229 \begin_layout Standard
18230 All of the other standard environments, including the section-heading environmen
18231 ts, aren't used in the
18238 \begin_layout Standard
18239 On the other hand, you'll notice the following new environments:
18242 \begin_layout Itemize
18248 \begin_layout Itemize
18254 \begin_layout Itemize
18260 \begin_layout Itemize
18266 \begin_layout Itemize
18272 \begin_layout Standard
18273 These five are kind of quirky, due to a
18274 \begin_inset Quotes eld
18278 \begin_inset Quotes erd
18281 in \SpecialChar LyX
18283 You see, \SpecialChar LyX
18284 doesn't permit you to nest any other paragraph environment into
18285 an empty environment.
18286 Now, that's fine and dandy, but it means that you wouldn't be able to start
18287 a slide with anything except plain text.
18288 To deal with this, I've performed a little
18289 \begin_inset Quotes eld
18294 \begin_inset Quotes erd
18300 \begin_layout Subsubsection
18301 Quirks of the New Environments
18302 \begin_inset CommandInset label
18304 name "sec:slideQuirk"
18311 \begin_layout Standard
18312 All five of the new paragraph environments are somewhat quirky due to inherent
18313 limitiations in the current version of \SpecialChar LyX
18315 As I just mentioned, \SpecialChar LyX
18316 forbids environments that begin with another environment.
18317 To get around this, the
18321 environment isn't a paragraph environment as described in the
18329 \begin_layout Standard
18330 You should consider
18343 \begin_inset Quotes eld
18346 pseudo-environments.
18347 \begin_inset Quotes erd
18350 They look like a section heading or a
18351 \begin_inset Quotes eld
18359 \begin_inset Quotes erd
18362 but really begin a [and, if necessary, end the previous] paragraph environment.
18372 \begin_inset Quotes eld
18376 \begin_inset Quotes erd
18379 These two perform some action.
18382 \begin_layout Standard
18383 A common feature of all five environments,
18403 , is a rather long-ish label.
18404 The text following this label — ordinarily the contents of the paragraph
18405 environment — is utterly irrelevant for
18427 completely ignores it.
18428 In fact, you can leave these five environments completely empty.
18432 \begin_layout Standard
18437 to put any text after the rather long-ish label, you might want to.
18438 This could be a short description of the contents of the
18443 In that case, enter your descriptive comment and hit
18447 as you normally would.
18450 \begin_layout Standard
18451 If, on the other hand, you don't want to enter any descriptive text, you'll
18452 hit another \SpecialChar LyX
18455 , like nature, abhors a vacuum, and will not let you start a new paragraph
18456 environment until you put something in the old one.
18460 \begin_layout Itemize
18461 Start entering the text that will
18489 \begin_layout Itemize
18490 Now move to the beginning of that paragraph.
18494 \begin_layout Itemize
18503 \begin_layout Itemize
18504 Finally, change this new, empty paragraph to a
18528 \begin_layout Standard
18529 Some future version of \SpecialChar LyX
18530 will, hopefully, resolve this quirkiness\SpecialChar ldots
18534 \begin_layout Subsection
18535 Making a Presentation with
18548 \begin_layout Subsubsection
18556 \begin_layout Standard
18557 If you're expecting this section to teach you how to actually make a presentatio
18558 n, you'll be sorely disappointed.
18559 Naturally, I'll describe all of the ways the
18563 class can assist you in preparing the materials for a presentation.
18564 Filling in the contents, however, is up to you.
18569 the \SpecialChar LyX
18573 \begin_layout Standard
18578 environment [in the manner described in section
18579 \begin_inset space ~
18583 \begin_inset CommandInset ref
18585 reference "sec:slideQuirk"
18589 ] tells \SpecialChar LyX
18590 to begin a new slide [duh].
18591 The label for this environment/
18592 \begin_inset Quotes erd
18596 \begin_inset Quotes erd
18600 \begin_inset Quotes eld
18604 \begin_inset Quotes erd
18607 in cool blue, followed by the label,
18608 \begin_inset Quotes eld
18612 \begin_inset Quotes erd
18616 Any text or paragraph environments that follow this one go on the new slide.
18620 \begin_layout Standard
18621 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
18623 (this can be specified in the
18628 In fact, you'll want to, once you finish entering the contents of one slide.
18629 If you've entered more text than can physically fit on a slide, the extra
18630 overflows onto a new slide.
18631 I don't recommend doing this, however, since the overflow slide won't have
18632 any page number on it.
18633 Furthermore, it may interfere with any
18637 you've made to accompany the oversized
18644 \begin_layout Standard
18653 environments work the same way as the
18658 They both create an
18659 \begin_inset Quotes eld
18663 \begin_inset Quotes erd
18666 followed by a label [
18667 \begin_inset Quotes eld
18671 \begin_inset Quotes erd
18675 \begin_inset Quotes eld
18679 \begin_inset Quotes erd
18683 The color is a stunning magenta instead of blue, and the
18684 \begin_inset Quotes eld
18688 \begin_inset Quotes erd
18691 will look different, in style and in length.
18692 The label fonts of all three also differ from one another.
18695 \begin_layout Standard
18700 , if the contents of a
18708 exceed the physical size of a slide or sheet of paper, the extra will overflow
18710 Again, you should avoid this.
18711 It defeats the whole purpose of
18722 \begin_layout Subsubsection
18732 \begin_layout Standard
18737 is a slide that sits atop another slide.
18738 Perhaps you wish to discuss a figure on the main
18742 before displaying the text associated with it.
18743 One way to accomplish this is tape a flap of dark paper over the part of
18748 you want to display later.
18749 This method fails, however, if you wish to overlap one graph with another,
18751 You would then have to fumble while speaking to align the two separate,
18756 s to align the two graphs.
18761 environment in both cases makes life much easier.
18764 \begin_layout Standard
18769 receives the page number of its
18770 \begin_inset Quotes eld
18774 \begin_inset Quotes erd
18782 \begin_inset Quotes eld
18790 \begin_inset Quotes erd
18797 \begin_layout Plain Layout
18798 Presumably, mutliple
18803 \begin_inset Quotes eld
18811 \begin_inset Quotes erd
18815 \begin_inset Quotes eld
18823 \begin_inset Quotes erd
18827 \begin_inset Quotes eld
18835 \begin_inset Quotes erd
18839 \begin_inset space ~
18842 appended to the page number of the parent
18852 Clearly, you want the contents of both the
18860 to each fit on a single physical slide! You should probably consider an
18866 \begin_inset Quotes eld
18870 \begin_inset Quotes erd
18878 Indeed, the \SpecialChar LyX
18883 class provides a visual cue for this: the label at the start of an
18887 is shorter than that at the start of a
18892 Lastly, when you generate printable output, you'll find alignment markers
18893 in all four corners of both the
18897 page and its parent
18902 These will assist you in lining up the two physical slides.
18905 \begin_layout Standard
18906 The major problem in overlaying two slides is aligning the contents of the
18907 two transparencies.
18908 How much space should you leave for that graph on the second slide? Worse
18909 still, what if you want a graph and a sentence on second slide, but there
18910 is text on the main transparency that goes in between them? You could try
18911 and insert vertical space of the right size.
18912 The better way is to use
18923 \begin_layout Standard
18924 As their names imply,
18932 are two command-like paragraph environments that make all subsequent text
18933 invisible and visible, respectively.
18935 \begin_inset space ~
18939 \begin_inset CommandInset ref
18941 reference "sec:slideQuirk"
18945 that you don't place anything
18949 these two environments, however.
18954 , it inserts a centered, sky-blue label into the page reading
18955 \begin_inset Quotes eld
18958 <Invisible Text Follows>
18959 \begin_inset Quotes erd
18963 For paragraphs following this label, the parts of the
18971 ; it doesn't matter which] where they would be contain instead blank space.
18975 \begin_layout Standard
18980 , the corresponding centered label is
18981 \begin_inset Quotes eld
18984 <Visible Text Follows>
18985 \begin_inset Quotes erd
18989 Paragraphs following this label behave normally.
18990 Note that the beginning of a new
19002 automatically shuts off an
19007 It's therefore not necessary to use
19018 \begin_layout Standard
19019 By now, it should be obvious how to create overlay transparencies using
19020 the proper combination of
19039 \begin_layout Enumerate
19044 , including everything that will appear on it, whether on the main slide
19052 \begin_layout Enumerate
19053 Before each figure or paragraph that will appear only on the
19062 If necessary, insert a
19066 environment after the
19073 \begin_layout Enumerate
19078 immediately following the
19085 \begin_layout Enumerate
19086 Copy the contents of this
19097 \begin_layout Enumerate
19102 , change all of the
19113 \begin_layout Standard
19115 You've just made an
19122 \begin_layout Standard
19123 There's one problem with the way I've designed the \SpecialChar LyX
19128 class: you can't make text in the middle of a paragraph invisible, nor
19129 make text in the middle of an invisible paragraph visible again.
19130 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
19135 \begin_layout Plain Layout
19136 The commands of interest are:
19139 \begin_layout Itemize
19144 invisible \SpecialChar ldots
19148 \begin_layout Itemize
19153 visible \SpecialChar ldots
19157 \begin_layout Plain Layout
19159 and need to be marked as \SpecialChar TeX
19162 \begin_inset Quotes eld
19166 \begin_inset Quotes erd
19169 you wish to change goes in between the brackets [and after the
19182 If you don't know how to mark text as \SpecialChar TeX
19183 , see the appropriate section of
19196 \begin_layout Subsubsection
19206 \begin_inset CommandInset label
19208 name "sec:slideNote"
19215 \begin_layout Standard
19224 is associated with a
19225 \begin_inset Quotes eld
19229 \begin_inset Quotes erd
19237 Here, too, the \SpecialChar LyX
19242 class provides visual cues.
19247 is shorter than that of a
19251 [yet longer than that of an
19255 ] and, like the label of an
19259 is shockingly magenta.
19260 Additionally, the printed
19264 has the page number of its
19265 \begin_inset Quotes eld
19269 \begin_inset Quotes erd
19277 \begin_inset Quotes eld
19285 \begin_inset Quotes erd
19289 \begin_inset Quotes eld
19297 \begin_inset Quotes erd
19301 \begin_inset Quotes eld
19309 \begin_inset Quotes erd
19313 You can have multiple
19317 s associated with a single
19329 , you'll probably want to break up long
19333 s so that they fit on a single sheet of paper.
19336 \begin_layout Standard
19341 is obvious: it contains anything additional you might want to say about
19347 It could also be used as a sheet of reminders for a particular
19352 In the case of the latter, you might want to make use of time markers.
19353 Currently, the \SpecialChar LyX
19359 \begin_inset Quotes eld
19363 \begin_inset Quotes erd
19366 support for time markers, a
19368 Sli\SpecialChar TeX
19372 So, you'll have to resort to using the \SpecialChar LaTeX
19376 \begin_layout Standard
19377 To use time markers, you'll need to specify the extra class option
19378 \begin_inset Quotes eld
19386 \begin_inset Quotes erd
19390 \begin_inset space ~
19394 \begin_inset CommandInset ref
19396 reference "sec:slidesetup"
19401 This option turns on timing marks, which will appear in the lower-left-hand
19407 To set what appears in the time marker, you use the \SpecialChar LaTeX
19409 \begin_inset Quotes eld
19419 \begin_inset Quotes erd
19423 \begin_inset Quotes eld
19433 \begin_inset Quotes erd
19437 The arguments of both commands are time measured in seconds.
19439 \begin_inset Quotes eld
19449 \begin_inset Quotes erd
19452 sets the time marker to a given time.
19454 \begin_inset Quotes eld
19464 \begin_inset Quotes erd
19467 increments the time marker by the specified amount.
19468 Using time markers and
19472 s in this fashion, you can remind yourself how much time to spend on a particula
19480 \begin_layout Standard
19481 There's one last feature to describe.
19482 Clearly, you'd like to print out all of your
19490 s on transparencies while printing all of your
19507 with which it is associated.
19508 What's a person to do?
19511 \begin_layout Standard
19512 Luckily, there are two \SpecialChar LaTeX
19513 commands that allow you to select what to print
19515 Both must be placed into the preamble of your document.
19517 \begin_inset Quotes eld
19529 \begin_inset Quotes erd
19532 will cause the output to contain only the
19541 Correspondingly, the command
19542 \begin_inset Quotes eld
19554 \begin_inset Quotes erd
19557 prevents the output of anything but
19562 I'd advise placing both commands in the preamble and initially comment
19564 You can then preview your entire presentation as you write.
19565 When you're done writing, you can then uncomment one of the two to select
19566 what you want to print.
19567 I like to uncomment
19568 \begin_inset Quotes eld
19580 \begin_inset Quotes erd
19583 , print to a file with
19584 \begin_inset Quotes eld
19592 \begin_inset Quotes erd
19595 in its name, comment it back out, then uncomment
19596 \begin_inset Quotes eld
19608 \begin_inset Quotes erd
19612 \begin_inset Quotes eld
19620 \begin_inset Quotes erd
19624 I can then send either file to a printer, loading transparencies or plain
19625 paper as appropriate.
19628 \begin_layout Standard
19629 You can also provide other arguments to the
19630 \begin_inset Quotes eld
19640 \begin_inset Quotes erd
19644 \begin_inset Quotes eld
19654 \begin_inset Quotes erd
19658 See a good \SpecialChar LaTeX
19662 \begin_layout Subsection
19667 Class Template File
19670 \begin_layout Standard
19671 I have also provided a template file,
19672 \begin_inset Quotes eld
19680 \begin_inset Quotes erd
19688 To use it, begin your new presentation with
19690 File\SpecialChar menuseparator
19692 \begin_inset space ~
19696 \begin_inset space ~
19702 Your new \SpecialChar LyX
19703 presentation file will contain an example
19724 additionally contain an example of the use of
19733 Lastly, the preamble will contain:
19736 \begin_layout LyX-Code
19737 % Uncomment to print out only slides and overlays
19740 \begin_layout LyX-Code
19744 \begin_layout LyX-Code
19750 \begin_inset Newline newline
19756 \begin_layout LyX-Code
19757 % Uncomment to print out only notes
19760 \begin_layout LyX-Code
19764 \begin_layout LyX-Code
19772 \begin_layout Standard
19773 One final thing: I created this class to support the \SpecialChar LaTeX2e
19775 \begin_inset Quotes eld
19780 Sli\SpecialChar TeX
19784 \begin_inset Quotes erd
19787 class, one of the built-in \SpecialChar LaTeX2e
19789 Neither I nor the rest of the \SpecialChar LyX
19790 Team endorse or oppose the use of this built-in
19792 It's here if you want it or need it.
19793 There exist other \SpecialChar LaTeX2e
19794 classes for creating presentations, such as the
19799 \begin_inset space ~
19803 \begin_inset CommandInset ref
19805 reference "sec:foiltex"
19810 \begin_inset Quotes eld
19818 \begin_inset Quotes erd
19821 package [present on some \SpecialChar TeX
19823 The latter is not yet supported under \SpecialChar LyX
19828 \begin_layout Plain Layout
19829 Perhaps you can take on the task\SpecialChar ldots
19835 I know nothing about these other classes.
19836 Try them out to see what sort of alternative they provide.
19839 \begin_layout Chapter
19841 Features needing Extra Software
19844 \begin_layout Section
19845 Checking \SpecialChar TeX
19849 \begin_layout Standard
19855 \begin_layout Subsection
19859 \begin_layout Standard
19868 \begin_layout Plain Layout
19873 is not yet available when you are using the \SpecialChar LaTeX
19874 distribution MiK\SpecialChar TeX
19880 , you'll find in the
19887 \begin_inset space ~
19898 \begin_inset Newline newline
19902 \begin_inset CommandInset href
19904 target "http://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19912 \begin_layout Standard
19915 Chk\SpecialChar TeX
19918 package is a program that was written by
19919 \begin_inset Flex Noun
19922 \begin_layout Plain Layout
19924 \begin_inset space ~
19932 in frustration because some constructs in \SpecialChar LaTeX
19933 are sometimes non-intuitive,
19934 and easy to forget.
19935 The program runs over your \SpecialChar LaTeX
19936 file, checks the integrity of the file, and
19937 flags some common errors.
19938 In other technical words, it is
19942 for \SpecialChar LaTeX
19946 \begin_layout Standard
19947 Well, what is a syntax checker doing in \SpecialChar LyX
19948 which is supposed to produce correct
19950 anyways? The answer is simple: Just as
19954 not only checks the
19958 of C programs, but also does
19962 checks for type-errors,
19964 Chk\SpecialChar TeX
19967 catches some common
19971 errors, in addition to the syntactical ones.
19974 Chk\SpecialChar TeX
19977 is capable of detecting several common errors, such as
19980 \begin_layout Itemize
19981 Ellipsis detection:
19982 \begin_inset Newline newline
19985 Use \SpecialChar ldots
19989 \begin_layout Itemize
19990 No space in front of/after parenthesis:
19991 \begin_inset Newline newline
19997 \begin_layout Itemize
19998 Enforcement of normal space after common abbreviations:
19999 \begin_inset Newline newline
20003 \begin_inset space \thinspace{}
20007 \begin_inset space \space{}
20010 is too wide spacing.
20013 \begin_layout Itemize
20014 Enforcement of end-of-sentence space when the last sentence ends with a
20016 \begin_inset Newline newline
20020 And this is wrong spacing.
20023 \begin_layout Itemize
20024 Space in front of labels and similar commands:
20025 \begin_inset Newline newline
20028 The label should stick right up to the text to avoid falling to a wrong
20031 \begin_inset CommandInset label
20041 \begin_layout Plain Layout
20042 This footnote is in danger of falling off to a wrong page
20047 The label is separated too much.
20050 \begin_layout Itemize
20051 Space in front of references, instead of hard spaces:
20052 \begin_inset Newline newline
20055 If you have bad luck, the text will break right between the referenced text
20056 and reference number, and that's a pity.
20058 \begin_inset CommandInset ref
20060 reference "sec:chktex"
20067 \begin_layout Itemize
20069 \begin_inset Quotes eld
20073 \begin_inset Quotes erd
20077 \begin_inset Formula $\times$
20081 \begin_inset Newline newline
20084 2x2 looks cheap compared to
20085 \begin_inset Formula $2\times2$
20091 \begin_layout Standard
20092 and more \SpecialChar ldots
20093 It is an invaluable tool when you are
20094 \begin_inset Quotes eld
20098 \begin_inset Quotes erd
20101 your document before printing, and you should run it right after the obligatory
20102 spelling check, and before you go fine tuning the typesetting.
20105 \begin_layout Subsection
20109 \begin_layout Standard
20110 If you have the program installed, usage is as simple as choosing
20112 Tools\SpecialChar menuseparator
20114 \begin_inset space ~
20120 This will make \SpecialChar LyX
20121 generate a \SpecialChar LaTeX
20122 file of your document, start
20124 Chk\SpecialChar TeX
20127 to check it, and then make \SpecialChar LyX
20129 \begin_inset Quotes eld
20133 \begin_inset Quotes erd
20136 with the warnings from
20138 Chk\SpecialChar TeX
20141 , if there were any.
20142 The warnings will be placed close to the point of the mistake, and you
20143 can quickly find them by using the
20145 Navigate\SpecialChar menuseparator
20148 menu item, or the shortcut key
20157 Open the error boxes by clicking on them with the mouse, or use the shortcut
20166 bindings, or the corresponding
20175 Read the warning and correct the mistake, if it is a mistake.
20176 If you have trouble understanding what the warning is about, you can safely
20178 Remember that there is a hidden layer between the document on screen and
20179 the technical details in invoking
20181 Chk\SpecialChar TeX
20184 , and this gap can make some warnings seem arcane or just plain silly.
20187 \begin_layout Standard
20188 This document is an excellent testing bed for the feature, and it should
20189 provide quite a few warnings for you to fiddle with.
20190 Since computers are only so smart, expect most of the warnings to be false
20194 \begin_layout Subsection
20195 How to fine tune it
20198 \begin_layout Standard
20199 Sometimes, you'll find that
20201 Chk\SpecialChar TeX
20204 makes more noise than suits your mood.
20205 Then you can choose not to use it, wait until your mood changes, or try
20208 Chk\SpecialChar TeX
20211 to get better along with you.
20214 \begin_layout Standard
20217 Chk\SpecialChar TeX
20224 very configurable and extensible, you should not expect to solve all problems
20227 Chk\SpecialChar TeX
20230 in \SpecialChar LyX
20232 Since \SpecialChar LyX
20233 has to generate a somewhat special \SpecialChar LaTeX
20234 file to be able to match the
20235 line numbers from the
20237 Chk\SpecialChar TeX
20244 \begin_layout Plain Layout
20245 You can inspect the specific output from
20251 Document\SpecialChar menuseparator
20254 \begin_inset space ~
20268 to the internal document structure, some of the warnings will not appear
20270 There are two things you can do about this:
20273 \begin_layout Itemize
20276 Chk\SpecialChar TeX
20279 invocation command line in
20280 \begin_inset Flex Noun
20283 \begin_layout Plain Layout
20284 Tools\SpecialChar menuseparator
20285 Preferences\SpecialChar menuseparator
20286 Output\SpecialChar menuseparator
20287 LaTeX\SpecialChar menuseparator
20295 Chk\SpecialChar TeX
20298 installation configuration file (usually with the file
20303 See below to learn what warnings can be enabled and disabled on the command
20307 \begin_layout Itemize
20308 Export your document as a raw \SpecialChar LaTeX
20311 File\SpecialChar menuseparator
20312 Export\SpecialChar menuseparator
20321 Invoked in this way, it can be a hassle to find the corresponding place
20322 in the document inside \SpecialChar LyX
20323 , but with a little patience, you should be able
20327 \begin_layout Standard
20328 Here follows the warning messages that can be enabled and disabled in
20337 to disable a warning, and
20341 to enable a warning.
20342 The emphasized entries are disabled by default, because the default is
20345 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
20350 \begin_layout Standard
20351 Notice that you should only use the options that enable and disable warnings,
20352 because \SpecialChar LyX
20353 relies on some of the other command line parameters to be set
20354 in a specific way to have a chance to communicate with
20361 \begin_layout Enumerate
20365 Command terminated with space.
20368 \begin_layout Enumerate
20371 Non-breaking space (
20372 \begin_inset Quotes eld
20380 \begin_inset Quotes erd
20383 ) should have been used.
20386 \begin_layout Enumerate
20390 You should enclose the previous parenthesis with
20391 \begin_inset Quotes eld
20399 \begin_inset Quotes erd
20405 \begin_layout Enumerate
20408 Italic correction (
20409 \begin_inset Quotes eld
20419 \begin_inset Quotes erd
20422 ) found in non-italic buffer.
20425 \begin_layout Enumerate
20428 Italic correction (
20429 \begin_inset Quotes eld
20439 \begin_inset Quotes erd
20442 ) found more than once.
20445 \begin_layout Enumerate
20449 No italic correction (
20450 \begin_inset Quotes eld
20460 \begin_inset Quotes erd
20466 \begin_layout Enumerate
20470 \begin_inset Quotes eld
20478 \begin_inset Quotes erd
20482 \begin_inset Quotes eld
20490 \begin_inset Quotes erd
20496 \begin_layout Enumerate
20499 Wrong length of dash may have been used.
20502 \begin_layout Enumerate
20506 \begin_inset Quotes eld
20514 \begin_inset Quotes erd
20518 \begin_inset Quotes eld
20526 \begin_inset Quotes erd
20532 \begin_layout Enumerate
20536 \begin_inset Quotes eld
20544 \begin_inset Quotes erd
20550 \begin_layout Enumerate
20554 \begin_inset Quotes eld
20562 \begin_inset Quotes erd
20565 to achieve an ellipsis.
20568 \begin_layout Enumerate
20571 Inter-word spacing (
20572 \begin_inset Quotes eld
20582 \begin_inset Quotes eld
20585 ) should perhaps be used.
20588 \begin_layout Enumerate
20591 Inter-sentence spacing (
20592 \begin_inset Quotes eld
20602 \begin_inset Quotes erd
20605 ) should perhaps be used.
20608 \begin_layout Enumerate
20611 Could not find argument for command.
20614 \begin_layout Enumerate
20618 \begin_inset Quotes eld
20626 \begin_inset Quotes erd
20632 \begin_layout Enumerate
20635 Math mode still on at end of \SpecialChar LaTeX
20639 \begin_layout Enumerate
20643 \begin_inset Quotes eld
20651 \begin_inset Quotes erd
20654 doesn't match the number of
20655 \begin_inset Quotes eld
20663 \begin_inset Quotes erd
20669 \begin_layout Enumerate
20672 You should use either
20675 \begin_inset Quotes eld
20683 \begin_inset Quotes erd
20688 as an alternative to
20689 \begin_inset Quotes eld
20697 \begin_inset Quotes erd
20703 \begin_layout Enumerate
20710 " (ASCII 39) instead of "
20717 \begin_layout Enumerate
20720 User-specified pattern found.
20723 \begin_layout Enumerate
20726 This command might not be intended.
20729 \begin_layout Enumerate
20736 \begin_layout Enumerate
20754 \begin_layout Enumerate
20757 Delete this space to maintain correct page references.
20760 \begin_layout Enumerate
20764 You might wish to put this between a pair of
20765 \begin_inset Quotes eld
20773 \begin_inset Quotes erd
20779 \begin_layout Enumerate
20782 You ought to remove spaces in front of punctuation.
20785 \begin_layout Enumerate
20788 Could not execute \SpecialChar LaTeX
20792 \begin_layout Enumerate
20801 in front of small punctuation.
20804 \begin_layout Enumerate
20812 may look prettier here.
20815 \begin_layout Enumerate
20819 Multiple spaces detected in output.
20822 \begin_layout Enumerate
20825 This text may be ignored.
20828 \begin_layout Enumerate
20834 \begin_inset Quotes eld
20839 to begin quotation, not
20846 \begin_layout Enumerate
20853 to end quotation, not
20856 \begin_inset Quotes eld
20864 \begin_layout Enumerate
20870 \begin_layout Enumerate
20873 You should perhaps use
20874 \begin_inset Quotes eld
20882 \begin_inset Quotes erd
20888 \begin_layout Enumerate
20891 You should put a space in front of/after parenthesis.
20894 \begin_layout Enumerate
20897 You should avoid spaces in front of/after parenthesis.
20900 \begin_layout Enumerate
20904 You should not use punctuation in front of/after quotes.
20907 \begin_layout Enumerate
20910 Double space found.
20913 \begin_layout Enumerate
20916 You should put punctuation outside inner/inside display math mode.
20919 \begin_layout Enumerate
20922 You ought to not use primitive \SpecialChar TeX
20923 in \SpecialChar LaTeX
20927 \begin_layout Enumerate
20930 You should remove spaces in front of
20931 \begin_inset Quotes eld
20939 \begin_inset Quotes erd
20945 \begin_layout Enumerate
20948 \begin_inset Quotes eld
20956 \begin_inset Quotes erd
20959 is normally not followed by
20960 \begin_inset Quotes eld
20968 \begin_inset Quotes erd
20974 \begin_layout Standard
20975 In later versions of \SpecialChar LyX
20976 , we hope to provide a more complete interface to this
20977 tool (and it's smaller cousin
20981 ) to exploit the full power of it.
20982 But it's not exactly useless as it is now: go try it on one of your existing
20983 documents of a certain length and be surprised.
20986 \begin_layout Section
20987 Version Control in \SpecialChar LyX
20991 \begin_layout Standard
20994 Lars Gullik Bjønnes
21001 \begin_layout Subsection
21005 \begin_layout Standard
21007 supports some of the most basic RCS/CVS/SVN/GIT commands.
21008 If you need something a bit more sophisticated you will have to do that
21009 manually in a terminal.
21012 \begin_layout Standard
21013 Also note that CVS support is not as good as subversion support
21014 \change_inserted -712698321 1501253107
21017 so we advise using SVN instead.
21018 A good place to start learning Subversion is
21019 \change_inserted -712698321 1501253115
21026 \begin_layout Plain Layout
21027 \begin_inset CommandInset href
21029 target "http://svnbook.red-bean.com/"
21040 In the case of RCS you should read
21041 \begin_inset Quotes eld
21045 \begin_inset Quotes erd
21048 (a man file, read it with
21053 This file describes all the basic features of RCS.
21054 You should especially notice the comment about a RCS directory, and the
21055 notion of a master RCS file (the file ending in
21062 \begin_layout Standard
21063 Before you begin to use the version control features in \SpecialChar LyX
21065 familiar with RCS/CVS/SVN/GIT usage.
21066 The implementation in \SpecialChar LyX
21067 assumes a recent version of the GNU RCS or CVS/SVN
21068 package — no guarantees are made for older versions.
21069 Most of the log messages are not currently displayed after operations —
21070 you can check them in the Messages pane if
21071 \change_inserted -712698321 1501253142
21075 Regular users of version control will appreciate
21076 \change_inserted -712698321 1501253149
21079 VC toolbar, which can be enabled via
21081 View\SpecialChar menuseparator
21082 Toolbars\SpecialChar menuseparator
21084 \begin_inset space ~
21092 \begin_layout Standard
21093 For introducing your own external commands consult
21094 \change_deleted -712698321 1501253161
21096 \change_inserted -712698321 1501253161
21098 \begin_inset Flex Code
21101 \begin_layout Plain Layout
21103 \change_inserted -712698321 1501253161
21114 \change_deleted -712698321 1501253168
21121 \change_inserted -712698321 1501253174
21123 \change_deleted -712698321 1501253173
21131 \begin_layout Standard
21132 It is strongly recommended to store documents in uncompressed format if
21133 using version control (uncheck
21135 Document\SpecialChar menuseparator
21138 if it is checked): Uncompressed LyX documents are text files and therefore
21139 for merging two different versions by version control systems.
21140 Compressed LyX documents are binary files, which cannot be merged by version
21144 \begin_layout Subsection
21145 RCS commands in \SpecialChar LyX
21149 \begin_layout Standard
21150 The following sections describe the RCS commands supported by \SpecialChar LyX
21152 You can find them in the
21154 File\SpecialChar menuseparator
21156 \begin_inset space ~
21163 was tested against RCS 5.7/5.8.
21166 \begin_layout Subsubsection
21172 \begin_layout Standard
21173 If your document is not under revision control, this is the only item shown
21175 And if it is under revision control, the
21179 item is not visible.
21183 \begin_layout Standard
21184 This command registers your document with RCS (unless you are under the
21185 directory managed by CVS)\SpecialChar endofsentence
21186 You are asked interactively to supply an initial
21187 description of the document.
21188 The document is now set in Read-Only mode and you have to
21191 \begin_inset space ~
21195 \begin_inset space ~
21199 \begin_inset space ~
21204 , before making any changes to it.
21205 A document under revision control has a
21206 \begin_inset Quotes eld
21209 [RCS:<version> <locker>]
21210 \begin_inset Quotes erd
21213 item tagged to the filename in the minibuffer.
21216 \begin_layout Standard
21217 RCS command that is run:
21218 \change_inserted -712698321 1501253193
21222 \begin_layout LyX-Code
21224 \change_deleted -712698321 1501253193
21229 ci -q -u -i -t-"<initial description>" <file-name>
21232 \begin_layout Standard
21237 to understand the switches.
21241 \begin_layout Subsubsection
21247 \begin_layout Standard
21248 When you are finished editing a file, you check in your changes.
21249 When you do this, you are asked for a description of the changes.
21250 This is stored in the history log.
21251 The version number is bumped, your changes are applied to the master RCS
21252 file, the document is unlocked and set to Read-Only mode.
21255 \begin_layout Itemize
21258 ci -q -u -m"<description>" <file-name>
21261 \begin_layout Subsubsection
21267 \begin_layout Standard
21268 By doing this you lock the document so that only you can edit it.
21269 This will also make the document Read-Write only for you.
21270 You will usually continue editing for a while and when you are finished
21271 you check in your changes.
21272 The status line is changed to reflect that you have locked the file.
21275 \begin_layout Itemize
21278 co -q -l <file-name>
21281 \begin_layout Subsubsection
21284 Revert To Repository Version
21287 \begin_layout Standard
21288 This will discard all changes made to the document since the last check
21290 You get a warning before changes are discarded.
21293 \begin_layout Itemize
21296 co -f -u<version> <file-name>
21299 \begin_layout Subsubsection
21305 \begin_layout Standard
21306 This will create a copy of the current document.
21307 Since RCS does not support copy operations natively, the version history
21308 is not preserved, and the copy is added as a new file.
21309 It requires a clean document without any changes since the last checkin.
21310 You are asked for a file name and a description of the copy operation.
21311 After that the copy is created, both locally and in the repository.
21312 If the parent directories of the copied and original document differ, all
21313 relative paths of included files of the copy are adjusted (like in
21315 File\SpecialChar menuseparator
21320 Finally, the copy is loaded instead of the original document.
21323 \begin_layout Labeling
21324 \labelwidthstring 00.00.0000
21326 \begin_inset space ~
21330 \begin_inset space ~
21334 \begin_inset Newline newline
21338 \begin_inset Flex Code
21341 \begin_layout Plain Layout
21343 \change_deleted -712698321 1501253225
21346 \begin_inset Quotes eld
21350 \change_inserted -712698321 1501253225
21352 \begin_inset Quotes qld
21358 \change_deleted -712698321 1501253231
21360 \begin_inset Quotes erd
21364 \change_inserted -712698321 1501253231
21366 \begin_inset Quotes qld
21377 \begin_inset Flex Code
21380 \begin_layout Plain Layout
21382 \change_deleted -712698321 1501253233
21385 \begin_inset Quotes eld
21389 \change_inserted -712698321 1501253233
21391 \begin_inset Quotes qld
21397 \change_deleted -712698321 1501253234
21399 \begin_inset Quotes erd
21403 \change_inserted -712698321 1501253235
21405 \begin_inset Quotes qld
21416 \begin_inset Newline newline
21420 \begin_inset Flex Code
21423 \begin_layout Plain Layout
21427 \change_deleted -712698321 1501253236
21429 \begin_inset Quotes eld
21433 \change_inserted -712698321 1501253236
21435 \begin_inset Quotes qld
21441 \change_deleted -712698321 1501253239
21443 \begin_inset Quotes erd
21447 \change_inserted -712698321 1501253239
21449 \begin_inset Quotes qld
21462 \begin_layout Subsubsection
21468 \begin_layout Standard
21469 This makes as if the last check in never happened.
21470 No changes are made to the document loaded into \SpecialChar LyX
21471 , but the last version
21472 is removed from the master RCS file.
21475 \begin_layout Itemize
21478 rcs -o<version> <file-name>
21481 \begin_layout Subsubsection
21487 \begin_layout Standard
21488 This shows the complete history of the RCS document.
21493 is shown in a browser.
21501 \begin_layout Subsubsection
21505 \begin_layout Standard
21507 supports RCS version number, author name, date and time of last commit.
21508 All those are extracted from
21510 rlog -r <file-name>
21514 \begin_inset CommandInset ref
21516 reference "subsec:VCS-Revision-Information"
21523 \begin_layout Subsection
21524 CVS commands in \SpecialChar LyX
21528 \begin_layout Standard
21529 A subset of CVS operations is supported by \SpecialChar LyX
21531 You can find the commands in the
21533 File\SpecialChar menuseparator
21535 \begin_inset space ~
21541 The version control system SVN is more powerful, so please use it instead
21542 of CVS if possible.
21545 \begin_layout Subsubsection
21551 \begin_layout Standard
21552 If you start from scratch with CVS you have to create your repository and
21553 checkout the working copy with external tools.
21554 If you're using a client-server setup you may need to login before doing
21555 the first repository checkout.
21558 \begin_layout Standard
21559 If your documents are under revision control and others are using the same
21560 repository problems arise when different changes to the same document at
21561 the same location happen.
21562 Standard CVS repositories don't operate with a file locking mechanism.
21563 This may be surprising, but conflicts only occur if people disagree on
21564 the proper content of the same part of a document.
21565 So, if co-workers are used to communicate regularly, these conflicts occur
21567 If they don't communicate they have a fundamental problem anyway.
21568 Nevertheless some people like to work with so called
21569 \begin_inset Quotes eld
21573 \begin_inset Quotes erd
21577 If they do so the working copy of all files is readonly when checked out
21578 first and the user starts editing after using a special command to make
21579 the working copy writable.
21580 When the changes are checked in the working copy returns to readonly state.
21581 With \SpecialChar LyX
21582 one has to edit the
21583 \begin_inset Flex Code
21586 \begin_layout Plain Layout
21592 file and add the line
21593 \begin_inset Flex Code
21596 \begin_layout Plain Layout
21602 to work with reserved checkouts.
21603 The benefit is the possibility to see who is using a writable copy of some
21605 It's not guaranteed only one user makes a copy writable.
21608 \begin_layout Standard
21610 tries to guess if you're using reserved or non-reserved checkouts.
21611 If your working copy is readonly or it is writable and an additional copy
21612 of your document exists in the CVS/Base sub-directory a reserved otherwise
21613 a non-reserved checkout is assumed.
21614 When a reserved checkout is detected you have to use
21615 \begin_inset Flex Noun
21618 \begin_layout Plain Layout
21624 to make your working copy writable if it's readonly.
21626 \begin_inset Flex Noun
21629 \begin_layout Plain Layout
21635 operation is possible and that makes your working copy readonly again after
21636 transferring your changes to the repository.
21639 \begin_layout Standard
21640 More information about CVS can be found here
21641 \begin_inset Flex URL
21644 \begin_layout Plain Layout
21646 http://www.nongnu.org/cvs
21652 \begin_inset Flex URL
21655 \begin_layout Plain Layout
21657 http://ximbiot.com/cvs
21665 \begin_layout Standard
21670 to understand the sub-commands and the switches mentioned below.
21673 \begin_layout Subsubsection
21679 \begin_layout Standard
21680 If your document is not under revision control, this is the only item shown
21682 And if it is under revision control, the
21686 item is not visible.
21690 \begin_layout Standard
21691 This command registers in CVS your document
21692 \begin_inset Flex Strong
21695 \begin_layout Plain Layout
21703 in the case you have already the documents directory under CVS control
21709 This means you have to create or checkout the archive by yourself using
21711 (In case you forget that step \SpecialChar LyX
21712 registers the document with RCS.)
21715 \begin_layout Standard
21716 Then you are asked interactively to supply an initial description of the
21718 Don't forget that registered file is not yet checked in.
21721 \begin_layout Standard
21722 CVS command that is run:
21724 cvs -q add -m"<entered message>" "<file-name>"
21727 \begin_layout Standard
21732 above and for all other CVS commands is an abbreviation for
21733 \begin_inset Quotes eld
21736 change the current working directory to file location and use the file name
21737 without path component as argument
21738 \begin_inset Quotes erd
21744 \begin_layout Subsubsection
21750 \begin_layout Standard
21751 When you are finished editing a file, you commit your changes.
21752 When you do this and you had changed the document, you are asked for a
21753 description of the changes.
21754 After that changes are written to the repository.
21755 In case you didn't change the document and a reserved checkout is detected
21756 the reservation made on
21757 \begin_inset Flex Noun
21760 \begin_layout Plain Layout
21769 \begin_layout Labeling
21770 \labelwidthstring 00.00.0000
21772 \begin_inset space ~
21776 \begin_inset space ~
21780 \begin_inset Newline newline
21784 \begin_inset Flex Code
21787 \begin_layout Plain Layout
21790 -q commit -m"<description>" "<file-name>"
21796 \begin_inset Newline newline
21800 \begin_inset Flex Code
21803 \begin_layout Plain Layout
21814 \begin_layout Subsubsection
21820 \begin_layout Standard
21821 When you are sharing a repository with others, you may have to incorporate
21822 their changes into your working copy.
21825 \begin_layout Standard
21828 cvs -q update "<file-name>"
21831 \begin_layout Standard
21832 If a readonly checkout is detected the working copy is made writable and
21836 \begin_layout Standard
21839 cvs -q edit "<file-name>"
21842 \begin_layout Subsubsection
21845 Revert To Repository Version
21848 \begin_layout Standard
21849 This will discard all changes made to the document since the last check
21851 You get a warning before changes are discarded.
21852 Firstly the file is deleted, secondly CVS update command is run.
21855 \begin_layout Standard
21858 cvs -q update "<file-name>"
21861 \begin_layout Standard
21862 If a reserved checkout is detected and the working copy has no changes only
21863 the reservation is undone.
21866 \begin_layout Standard
21869 cvs -q unedit "<file-name>"
21872 \begin_layout Subsubsection
21878 \begin_layout Standard
21879 This will create a copy of the current document.
21880 Since CVS does not support copy operations natively, the version history
21881 is not preserved, and the copy is added as a new file.
21882 It requires a clean document without any changes since the last checkin.
21883 You are asked for a file name and a description of the copy operation.
21884 After that the copy is created, both locally and in the repository.
21885 If the parent directories of the copied and original document differ, all
21886 relative paths of included files of the copy are adjusted (like in
21888 File\SpecialChar menuseparator
21893 Finally, the copy is loaded instead of the original document.
21896 \begin_layout Labeling
21897 \labelwidthstring 00.00.0000
21899 \begin_inset space ~
21903 \begin_inset space ~
21907 \begin_inset Newline newline
21911 \begin_inset Flex Code
21914 \begin_layout Plain Layout
21916 \change_deleted -712698321 1501254263
21919 \begin_inset Quotes eld
21923 \change_inserted -712698321 1501254263
21931 \change_deleted -712698321 1501254266
21933 \begin_inset Quotes erd
21937 \change_inserted -712698321 1501254266
21948 \begin_inset Flex Code
21951 \begin_layout Plain Layout
21953 \change_deleted -712698321 1501254267
21956 \begin_inset Quotes eld
21960 \change_inserted -712698321 1501254267
21968 \change_deleted -712698321 1501254269
21970 \begin_inset Quotes erd
21974 \change_inserted -712698321 1501254269
21985 \begin_inset Newline newline
21989 \begin_inset Flex Code
21992 \begin_layout Plain Layout
21994 \change_deleted -712698321 1501254271
21998 \begin_inset Quotes eld
22002 \change_inserted -712698321 1501254271
22010 \change_deleted -712698321 1501254272
22012 \begin_inset Quotes erd
22016 \change_inserted -712698321 1501254272
22029 \begin_layout Subsubsection
22035 \begin_layout Standard
22036 This will rename the current document.
22037 Since CVS does not support rename operations natively, the version history
22038 is not preserved, the renamed document is added as a new file, and the
22039 original document is deleted.
22040 It requires a clean document without any changes since the last checkin.
22041 You are asked for a file name and a description of the rename operation.
22042 After that the document is renamed, both locally and in the repository.
22043 If the parent directories of the new and old file names differ, all relative
22044 paths of included files are adjusted (like in
22046 File\SpecialChar menuseparator
22051 Finally, the document is reloaded using the new name.
22054 \begin_layout Labeling
22055 \labelwidthstring 00.00.0000
22057 \begin_inset space ~
22061 \begin_inset space ~
22065 \begin_inset Newline newline
22069 \begin_inset Flex Code
22072 \begin_layout Plain Layout
22074 \change_deleted -712698321 1501254274
22077 \begin_inset Quotes eld
22081 \change_inserted -712698321 1501254274
22089 \change_deleted -712698321 1501254277
22091 \begin_inset Quotes erd
22095 \change_inserted -712698321 1501254277
22106 \begin_inset Flex Code
22109 \begin_layout Plain Layout
22111 \change_deleted -712698321 1501254278
22114 \begin_inset Quotes eld
22118 \change_inserted -712698321 1501254278
22126 \change_deleted -712698321 1501254279
22128 \begin_inset Quotes erd
22132 \change_inserted -712698321 1501254279
22143 \begin_inset Newline newline
22147 \begin_inset Flex Code
22150 \begin_layout Plain Layout
22152 \change_deleted -712698321 1501254281
22156 \begin_inset Quotes eld
22160 \change_inserted -712698321 1501254281
22168 \change_deleted -712698321 1501254282
22170 \begin_inset Quotes erd
22174 \change_inserted -712698321 1501254282
22185 \begin_inset Newline newline
22189 \begin_inset Flex Code
22192 \begin_layout Plain Layout
22194 \change_deleted -712698321 1501254285
22198 \begin_inset Quotes eld
22202 \change_inserted -712698321 1501254285
22210 \change_deleted -712698321 1501254287
22212 \begin_inset Quotes erd
22216 \change_inserted -712698321 1501254287
22229 \begin_layout Subsubsection
22230 Update of the local directory checkout from repository
22233 \begin_layout Standard
22234 Once your documents gets more complex, containing sub-documents and pictures,
22236 \begin_inset Flex Code
22239 \begin_layout Plain Layout
22245 files and so on using version control becomes more complicated.
22247 supports updating the whole tree in which resides the document.
22248 This become especially useful once you cooperate with people which neither
22249 have detailed knowledge about CVS usage nor they have ambition to commit
22250 additional material to the repository.
22251 You have to organize the files structure so that all external files are
22252 in the same directory or subdirectories of the document.
22253 It's good practice anyway to store multipart documents in an extra directory.
22256 \begin_layout Standard
22258 \begin_inset Flex Code
22261 \begin_layout Plain Layout
22262 Update local directory from repository
22267 command updates the whole directory.
22268 If local changes are detected user is warned before update starts.
22269 In case of merge conflicts both versions of the conflicting document parts
22270 are placed in the final document.
22271 You have to review and correct the result of the merge.
22272 You'll find the conflicts enclosed in pairs of
22273 \begin_inset Flex Code
22276 \begin_layout Plain Layout
22283 \begin_inset Flex Code
22286 \begin_layout Plain Layout
22293 \begin_inset Flex Code
22296 \begin_layout Plain Layout
22303 The first part is your version as before the update operation with the
22304 document name prepended.
22305 The second one is the repository version with the version number after
22307 \begin_inset Flex Code
22310 \begin_layout Plain Layout
22319 \begin_layout Labeling
22320 \labelwidthstring 00.00.0000
22322 \begin_inset space ~
22326 \begin_inset space ~
22330 \begin_inset Newline newline
22334 \begin_inset Flex Code
22337 \begin_layout Plain Layout
22345 (Ask if changes are detected.)
22346 \begin_inset Newline newline
22350 \begin_inset Flex Code
22353 \begin_layout Plain Layout
22354 cd $path; cvs -q update
22364 \begin_layout Standard
22366 \begin_inset Flex Code
22369 \begin_layout Plain Layout
22375 stands for the path to the document.
22378 \begin_layout Subsubsection
22384 \begin_layout Standard
22385 This shows the complete history of the CVS document.
22388 cvs log "<file-name>"
22390 is shown in a browser.
22393 \begin_layout Subsubsection
22397 \begin_layout Standard
22399 supports CVS version number, author name, date and time of last commit.
22400 All those are extracted from
22402 cvs log -r <file-name>
22406 \begin_inset CommandInset ref
22408 reference "subsec:VCS-Revision-Information"
22415 \begin_layout Subsection
22416 SVN commands in \SpecialChar LyX
22420 \begin_layout Standard
22421 SVN is now partially supported by \SpecialChar LyX
22423 You can find the commands in the
22425 File\SpecialChar menuseparator
22427 \begin_inset space ~
22433 Please note that if you use password protected access to repository via
22434 ssh, you will be asked in terminal window.
22436 was tested against SVN 1.5, 1.6, 1.7 and 1.8
22440 \begin_layout Plain Layout
22441 Most of the commands will work with 1.4 too, see
22442 \begin_inset CommandInset ref
22444 reference "subsec:SVN-Repo-Update"
22449 There seems to be currently unresolved permissions problem under SVN 1.8
22450 with reverting changes when file is locked.
22458 \begin_layout Subsubsection
22464 \begin_layout Standard
22465 If your document is not under revision control, this is the only item shown
22467 And if it is under revision control, the
22471 item is not visible.
22474 \begin_layout Standard
22475 This command registers in SVN your document ONLY in case you have already
22476 the documents directory under SVN control (in particular
22481 This means you have to checkout the archive by yourself.
22484 \begin_layout Standard
22485 Then you are asked interactively to supply an initial description of the
22487 Don't forget that registered file is not yet commited.
22490 \begin_layout Standard
22491 SVN command that is run:
22494 \change_deleted -712698321 1501253346
22496 \begin_inset Quotes eld
22500 \change_inserted -712698321 1501253346
22502 \begin_inset Quotes qld
22508 \change_deleted -712698321 1501253348
22510 \begin_inset Quotes erd
22514 \change_inserted -712698321 1501253348
22516 \begin_inset Quotes qld
22524 \begin_layout Standard
22529 to understand the switches.
22532 \begin_layout Subsubsection
22538 \begin_layout Standard
22539 When you are finished editing a file, you commit your changes.
22540 When you do this, you are asked for a description of the changes.
22541 After that changes are commited.
22544 \begin_layout Standard
22549 \begin_layout Plain Layout
22550 In case locking is not enabled.
22552 \begin_inset CommandInset ref
22554 reference "subsec:SVN-File-Locking"
22565 svn commit -q -m"<description>" <file-name>
22568 \begin_layout Subsubsection
22574 \begin_layout Standard
22575 Updates the changes of this file from the repository.
22576 Be sure you understand SVN merging and conflicts resolving before using
22577 this function, because all conflicts has to be resolved manually by you!
22580 \begin_layout Standard
22585 \begin_layout Plain Layout
22593 svn update --non-interactive
22594 \change_deleted -712698321 1501253354
22596 \begin_inset Quotes eld
22600 \change_inserted -712698321 1501253354
22602 \begin_inset Quotes qld
22608 \change_deleted -712698321 1501253356
22610 \begin_inset Quotes erd
22614 \change_inserted -712698321 1501253356
22616 \begin_inset Quotes qld
22624 \begin_layout Subsubsection
22627 Revert To Repository Version
22630 \begin_layout Standard
22631 This will discard all changes made to the document since the last check
22633 You get a warning before changes are discarded.
22636 \begin_layout Standard
22640 \change_deleted -712698321 1501253358
22642 \begin_inset Quotes eld
22646 \change_inserted -712698321 1501253358
22648 \begin_inset Quotes qld
22654 \change_deleted -712698321 1501253360
22656 \begin_inset Quotes erd
22660 \change_inserted -712698321 1501253360
22662 \begin_inset Quotes qld
22670 \begin_layout Subsubsection
22676 \begin_layout Standard
22677 This will create a copy of the current document including the version history.
22678 It requires a clean document without any changes since the last checkin.
22679 You are asked for a file name and a description of the copy operation.
22680 After that the copy is created, both locally and in the repository.
22681 If the parent directories of the copied and original document differ, all
22682 relative paths of included files of the copy are adjusted (like in
22684 File\SpecialChar menuseparator
22689 Finally, the copy is loaded instead of the original document.
22692 \begin_layout Labeling
22693 \labelwidthstring 00.00.0000
22695 \begin_inset space ~
22699 \begin_inset space ~
22703 \begin_inset Newline newline
22707 \begin_inset Flex Code
22710 \begin_layout Plain Layout
22712 \change_deleted -712698321 1501253363
22716 \begin_inset Quotes eld
22720 \change_inserted -712698321 1501253363
22722 \begin_inset Quotes qld
22728 \change_deleted -712698321 1501253365
22730 \begin_inset Quotes erd
22734 \change_inserted -712698321 1501253365
22736 \begin_inset Quotes qld
22742 \change_deleted -712698321 1501253366
22744 \begin_inset Quotes eld
22748 \change_inserted -712698321 1501253366
22750 \begin_inset Quotes qld
22756 \change_deleted -712698321 1501253368
22758 \begin_inset Quotes erd
22762 \change_inserted -712698321 1501253368
22764 \begin_inset Quotes qld
22775 \begin_inset Newline newline
22779 \begin_inset Flex Code
22782 \begin_layout Plain Layout
22791 \begin_layout Subsubsection
22797 \begin_layout Standard
22798 This will rename the current document including the version history.
22799 It requires a clean document without any changes since the last checkin.
22800 You are asked for a file name and a description of the rename operation.
22801 After that the document is renamed, both locally and in the repository.
22802 If the parent directories of the new and old file names differ, all relative
22803 paths of included files are adjusted (like in
22805 File\SpecialChar menuseparator
22810 Finally, the document is reloaded using the new name.
22813 \begin_layout Labeling
22814 \labelwidthstring 00.00.0000
22816 \begin_inset space ~
22820 \begin_inset space ~
22824 \begin_inset Newline newline
22828 \begin_inset Flex Code
22831 \begin_layout Plain Layout
22833 \change_deleted -712698321 1501253375
22837 \begin_inset Quotes eld
22841 \change_inserted -712698321 1501253375
22843 \begin_inset Quotes qld
22849 \change_deleted -712698321 1501253377
22851 \begin_inset Quotes erd
22855 \change_inserted -712698321 1501253377
22857 \begin_inset Quotes qld
22863 \change_deleted -712698321 1501253378
22865 \begin_inset Quotes eld
22869 \change_inserted -712698321 1501253378
22871 \begin_inset Quotes qld
22877 \change_deleted -712698321 1501253380
22879 \begin_inset Quotes erd
22883 \change_inserted -712698321 1501253380
22885 \begin_inset Quotes qld
22896 \begin_inset Newline newline
22900 \begin_inset Flex Code
22903 \begin_layout Plain Layout
22912 \begin_layout Subsubsection
22913 \begin_inset CommandInset label
22915 name "subsec:SVN-Repo-Update"
22919 Update of the local directory checkout from repository
22923 \begin_layout Plain Layout
22924 Note that this command will work only with subversion
22925 \begin_inset Formula $\geqq1.5$
22936 \begin_layout Standard
22937 All the commands above have one shortco
22938 \change_deleted -712698321 1501253385
22942 \change_inserted -712698321 1501253389
22944 \change_deleted -712698321 1501253389
22947 they deal with the current document only.
22948 Once your document contains pictures, includes external
22949 \begin_inset Flex Code
22952 \begin_layout Plain Layout
22958 files and so on administration becomes more complicated.
22960 now supports updating the whole tree in which resides the document
22964 \begin_layout Plain Layout
22965 One need to organize the files structure so that all external files are
22966 in the same directory or subdirectories of the document.
22973 This become especially useful once you cooperate with people which neither
22974 know about subversion management nor they have ambition to commit additional
22975 material to the repository.
22979 \begin_layout Standard
22980 \begin_inset Flex Code
22983 \begin_layout Plain Layout
22984 Update local directory from repository
22989 command updates the whole directory and in case of merge conflicts local
22990 version of the files are left, so no unintended data loss occurs.
22991 If local changes are detected user is warned before update starts.
22994 \begin_layout Labeling
22995 \labelwidthstring 00.00.0000
22997 \begin_inset space ~
23001 \begin_inset space ~
23005 \begin_inset Newline newline
23009 \begin_inset Flex Code
23012 \begin_layout Plain Layout
23018 (Ask if changes are detected.)
23019 \begin_inset Newline newline
23023 \begin_inset Flex Code
23026 \begin_layout Plain Layout
23027 svn update –accept mine-full $path
23035 \begin_layout Standard
23037 \begin_inset Flex Code
23040 \begin_layout Plain Layout
23046 stands for the path to the document.
23049 \begin_layout Subsubsection
23055 \begin_layout Standard
23056 This shows the complete history of the SVN document.
23060 \change_deleted -712698321 1501253404
23062 \begin_inset Quotes eld
23066 \change_inserted -712698321 1501253404
23068 \begin_inset Quotes qld
23074 \change_deleted -712698321 1501253406
23076 \begin_inset Quotes erd
23080 \change_inserted -712698321 1501253406
23082 \begin_inset Quotes qld
23089 is shown in a browser.
23092 \begin_layout Subsubsection
23094 \begin_inset CommandInset label
23096 name "subsec:SVN-File-Locking"
23103 \begin_layout Standard
23104 The file exchange through various revision control systems brings the problem
23105 of merge conflicts in case two different users try to edit the same (parts
23107 When such a conflict happens it needs manual resolving and one reasonable
23108 alternative is to provide some kind of locking mechanism, which guarantees
23109 that only one user is allowed to edit file at the given time.
23112 \begin_layout Standard
23113 SVN has two such mechanisms to provide mutual exclusivity for file access
23115 \change_inserted -712698321 1501253410
23117 \change_deleted -712698321 1501253410
23120 locks and automatic setting of write permissions (see sec.
23122 \begin_inset CommandInset ref
23124 reference "subsec:Automatical-Locking-Property"
23129 \begin_inset Flex Code
23132 \begin_layout Plain Layout
23142 \begin_layout Plain Layout
23144 \change_deleted -712698321 1501253418
23145 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
23146 \change_inserted -712698321 1501253418
23148 \begin_inset Flex URL
23151 \begin_layout Plain Layout
23153 \change_inserted -712698321 1501253418
23155 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
23170 If this property is detected for a given document \SpecialChar LyX
23171 starts to use SVN locks
23172 for document editing automatically and the whole check-in/out mechanism
23173 switches to the same regimen as for RCS.
23174 This in particular means there are two different modes of file use in \SpecialChar LyX
23178 \begin_layout Itemize
23180 The loaded file is in the read-only mode.
23181 For editing on needs to check-out.
23186 consists of updating from the repository and gaining write lock.
23187 If the lock is not possible to obtain, we remain in unlocked state.
23190 \begin_layout Itemize
23192 The loaded file is in the
23193 \change_deleted -712698321 1501253433
23195 \change_inserted -712698321 1501253433
23197 \begin_inset Quotes els
23203 \change_deleted -712698321 1501253435
23205 \change_inserted -712698321 1501253435
23207 \begin_inset Quotes ers
23213 No other user is allowed to edit the file.
23218 consists of commiting changes and releasing write-lock.
23219 If no changes have been made to the document, no commit will be produced
23223 \begin_layout Plain Layout
23224 Don't be puzzled by the fact that you will be asked for commit message anyway.
23229 and only the write-lock will be released.
23232 \begin_layout Standard
23236 \begin_layout Labeling
23237 \labelwidthstring 00.00.0000
23240 svn commit -q -m"<description>" "<file-name>"
23241 \begin_inset Newline newline
23244 svn unlock "<file-name>"
23247 \begin_layout Labeling
23248 \labelwidthstring 00.00.0000
23251 svn update "<file-name>"
23252 \begin_inset Newline newline
23255 svn lock "<file-name>"
23258 \begin_layout Subsubsection
23261 \begin_inset CommandInset label
23263 name "subsec:Automatical-Locking-Property"
23269 Automatic Locking Property
23272 \begin_layout Standard
23273 The above mentioned automatic setting of write permissions of the .lyx file
23276 File\SpecialChar menuseparator
23278 \begin_inset space ~
23281 Control\SpecialChar menuseparator
23283 \change_deleted -712698321 1501244235
23285 \change_inserted -712698321 1501244235
23289 \change_deleted -712698321 1501244236
23291 \change_inserted -712698321 1501244237
23295 \change_inserted -712698321 1501244242
23297 \change_deleted -712698321 1501244242
23303 This command is active only when the file is not locked on the svn server
23305 you need to check-out before proceeding).
23308 \begin_layout Labeling
23309 \labelwidthstring 00.00.0000
23311 \begin_inset space ~
23317 \begin_layout Labeling
23318 \labelwidthstring 00.00.0000
23321 svn propset svn:needs-lock ON "<file-name>"
23324 \begin_layout Labeling
23325 \labelwidthstring 00.00.0000
23328 svn propdel svn:needs-lock "<file-name>"
23331 \begin_layout Subsubsection
23332 \begin_inset CommandInset label
23334 name "subsec:VCS-Revision-Information"
23338 Revision Information in Documents
23341 \begin_layout Standard
23342 There are more possibilities how to activate revision information in our
23346 \begin_layout Itemize
23352 \begin_layout Itemize
23353 tree revision information (
23354 \begin_inset Flex Code
23357 \begin_layout Plain Layout
23364 The result is the output of the
23365 \begin_inset Flex Code
23368 \begin_layout Plain Layout
23374 command, the following table gives you an idea, how to read the results.
23377 \begin_layout Standard
23379 \begin_inset Tabular
23380 <lyxtabular version="3" rows="6" columns="2">
23381 <features tabularvalignment="middle">
23382 <column alignment="left" valignment="top">
23383 <column alignment="left" valignment="top">
23385 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
23388 \begin_layout Plain Layout
23396 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
23399 \begin_layout Plain Layout
23409 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23412 \begin_layout Plain Layout
23418 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23421 \begin_layout Plain Layout
23422 mixed revision working copy
23429 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23432 \begin_layout Plain Layout
23438 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23441 \begin_layout Plain Layout
23442 modified working copy
23449 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23452 \begin_layout Plain Layout
23458 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23461 \begin_layout Plain Layout
23462 switched working copy
23469 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23472 \begin_layout Plain Layout
23478 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23481 \begin_layout Plain Layout
23482 partial working copy, from a sparse checkout
23489 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
23492 \begin_layout Plain Layout
23498 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
23501 \begin_layout Plain Layout
23502 mixed revision, modified, switched working copy
23515 \begin_layout Itemize
23516 file revision information.
23517 The result comes from parsing the output of
23518 \begin_inset Flex Code
23521 \begin_layout Plain Layout
23523 \begin_inset space ~
23527 \begin_inset space ~
23531 \begin_inset space ~
23540 Supported flags are:
23544 \begin_layout Itemize
23545 version number of the last commit (
23546 \begin_inset Flex Code
23549 \begin_layout Plain Layout
23558 \begin_layout Itemize
23559 author of the last commit (
23560 \begin_inset Flex Code
23563 \begin_layout Plain Layout
23572 \begin_layout Itemize
23573 date of the last commit (
23574 \begin_inset Flex Code
23577 \begin_layout Plain Layout
23586 \begin_layout Itemize
23587 time of the last commit (
23588 \begin_inset Flex Code
23591 \begin_layout Plain Layout
23601 \begin_layout Standard
23602 You can obtain this info via InsetInfo (e.g.
23604 \begin_inset Flex Code
23607 \begin_layout Plain Layout
23608 info-insert buffer vcs-date
23614 The information will be available only when you have the file stored under
23615 svn managment (i.e.
23617 \begin_inset Flex Code
23620 \begin_layout Plain Layout
23626 directory is available with your document).
23630 \begin_layout Itemize
23631 Another—a hacking one—possibility is to use svn keywords
23635 \begin_layout Plain Layout
23636 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
23642 In short – you set file keywords property (e.g.
23645 svn propset svn:keywords 'Rev' file.lyx
23647 ) and then paste keyword \SpecialChar TeX
23652 \begin_layout Plain Layout
23653 This is an easy way how to ensure that \SpecialChar LyX
23654 won't break the line in the middle
23660 tag in your document (e.g.
23662 \change_deleted -712698321 1501253475
23667 \begin_layout Plain Layout
23675 \change_inserted -712698321 1501253480
23677 \begin_inset Flex Code
23680 \begin_layout Plain Layout
23682 \change_inserted -712698321 1501253480
23693 This way svn client will automatically substitute revision number (e.g.
23695 \change_deleted -712698321 1501253467
23700 \begin_layout Plain Layout
23708 \change_inserted -712698321 1501253473
23710 \begin_inset Flex Code
23713 \begin_layout Plain Layout
23715 \change_inserted -712698321 1501253473
23725 ) after each update and commit.
23726 There are more problems with this approach.
23727 Firstly, the '$' character is used in \SpecialChar TeX
23728 world for math equations, so any
23729 occurence of math formula
23730 \begin_inset Formula $Rev$
23734 \begin_inset Formula $Rev:59$
23737 in your \SpecialChar LyX
23739 Similarly for other keywords like Id, Date, Author, etc.
23740 Secondly svn output is dependent on your locales, so its very easy that
23741 svn would produce some problematic strings once Date is used.
23742 Thirdly you get the whole 'Rev: 59' string in your document instead of
23744 Until subversion implements user's custom keywords it will be hard to use
23745 this approach reliably or let \SpecialChar LyX
23746 to support it directly.
23749 \begin_layout Subsection
23750 SVN and Windows Environment
23753 \begin_layout Quote
23754 My inclination is to say that if the user cannot figure out the command
23755 line operations on their own fairly quickly, they would be well advised
23756 to use TortoiseSVN.
23762 \begin_layout Subsubsection
23766 \begin_layout Standard
23767 In addition to installing \SpecialChar LyX
23768 , and having access to a Subversion repository,
23769 the user will need to install the Subversion client program.
23770 A Windows installer for the client program is available from
23771 \begin_inset CommandInset href
23774 target "http://www.collab.net/nonav/downloads/subversion/"
23780 The user may also want to install
23781 \begin_inset CommandInset href
23784 target "http://tortoisesvn.tigris.org/"
23789 , which integrates Subversion operations into the context (rightclick) menu
23790 of Windows Explorer.
23791 Operations done outside \SpecialChar LyX
23792 will typically be more convenient using the Explorer
23794 Note that TortoiseSVN is not a replacement for the client program, which
23795 is what \SpecialChar LyX
23799 \begin_layout Subsubsection
23800 Bringing a document under Subversion control
23803 \begin_layout Standard
23804 Before a \SpecialChar LyX
23805 document can be brought under version control in Subversion, its
23806 parent directory needs to be under version control.
23807 If the document is being added to a project already in the repository,
23808 this is accomplished by checking the project out to the directory where
23809 the new document will be placed.
23810 If the project itself is not yet under version control (for instance, if
23811 this document starts a new project), the directory must be imported into
23813 This is done outside \SpecialChar LyX
23815 Both import and checkout are easily accomplished from the Explorer context
23816 menu using TortoiseSVN, or alternatively can be done using the command
23817 line client at a DOS prompt.
23818 The procedure for importing the project using TortoiseSVN is described
23819 below, assuming an existing repository and a new project being started
23827 For information on using the Subversion client program, run
23834 \begin_layout Enumerate
23841 in Windows Explorer, right click it, and select
23843 TortoiseSVN\SpecialChar menuseparator
23847 If necessary, adjust the URL for the repository, then click OK.
23850 \begin_layout Enumerate
23851 Right click the level of the repository under which you want to place the
23852 new project folder (typically the top level) and click
23856 Supply a name for the project folder and click OK.
23857 Add a message for the log file if desired, then click OK again.
23858 The new project folder should appear in the repository.
23859 Finally, click OK again to exit the repository browser.
23862 \begin_layout Enumerate
23863 Once again right click
23869 , this time selecting SVN Checkout\SpecialChar ldots
23870 Select the URL of the project folder
23871 you just created in the repository, and set the checkout directory to
23879 You will be warned about a non-empty folder; click OK to proceed.
23880 You should now have a
23891 \begin_layout Enumerate
23892 Create or open your document in \SpecialChar LyX
23895 File\SpecialChar menuseparator
23897 \begin_inset space ~
23900 Control\SpecialChar menuseparator
23904 Add a log message and click OK to commit the document to version control.
23907 \begin_layout Standard
23908 From this point onward, you should have full functionality in the
23910 File\SpecialChar menuseparator
23912 \begin_inset space ~
23918 You also have the option of checking the document in and out, viewing its
23920 using the TortoiseSVN context menu in Windows Explorer or the Subversion
23921 client program from a command prompt.
23924 \begin_layout Subsubsection
23925 SSH tunnel used with SVN under Windows
23928 \begin_layout Standard
23929 Compared with Linux setting up an svn client to communicate over ssh under
23930 Windows is a rather troublesome task.
23931 We will at least offer some hints how to setup the client side but prior
23932 knowledge about ssh and the Windows command line is needed, also be prepared
23933 for a great deal of frustration\SpecialChar ldots
23937 \begin_layout Enumerate
23938 Get an svn client for windows, as described in the previous sections.
23939 When it is a fresh install run some svn command (e.g.
23941 \begin_inset Flex Code
23944 \begin_layout Plain Layout
23950 ) to create config files, which you will need to change later on.
23953 \begin_layout Enumerate
23954 Choose an ssh client for Windows.
23955 There are several possibilities, we will use the one from Putty tools
23959 \begin_layout Plain Layout
23960 \begin_inset Flex URL
23963 \begin_layout Plain Layout
23965 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
23976 You will need to set the connection up so that the client doesn't ask for
23977 any password from you.
23978 To keep things easy we will use only keys without any additional password
23983 \begin_layout Enumerate
23985 \begin_inset Flex Code
23988 \begin_layout Plain Layout
23995 Save your private .ppk key file and put the public one on the server side.
23996 If the SVN server runs on Linux, note that the format of the public key
23997 is not compatible with Linux openssh and you will need to direcly copy-paste
24000 Public key for pasting into OpenSSH authorized_keys file
24002 :” edit field into the server's
24003 \begin_inset Flex Code
24006 \begin_layout Plain Layout
24007 ~/.ssh/authorized_keys
24013 \begin_inset Flex Code
24016 \begin_layout Plain Layout
24025 \begin_layout Enumerate
24027 \begin_inset Flex Code
24030 \begin_layout Plain Layout
24037 In the SVN config file
24041 \begin_layout Plain Layout
24042 Exact path depends on Windows version, usually somewhere around
24043 \begin_inset Flex Code
24046 \begin_layout Plain Layout
24049 Documents and Settings
24063 \begin_inset Flex Code
24066 \begin_layout Plain Layout
24081 , section [tunnels], setup ssh command, e.g.
24083 \begin_inset Flex Code
24086 \begin_layout Plain Layout
24087 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
24096 \begin_layout Plain Layout
24097 It will usually take a lot of time to get exact command right and it depends
24099 For example do not have some remote server saved as a default session in
24101 If things fail, try to connect via plink without SVN first.
24110 \begin_layout Enumerate
24111 Checkout the SVN archive, e.
24112 \begin_inset space \thinspace{}
24116 \begin_inset Newline newline
24120 \begin_inset Flex Code
24123 \begin_layout Plain Layout
24124 svn co svn+ssh://user@server/repository_path
24132 \begin_layout Subsubsection
24133 End-of-Line Conversions
24136 \begin_layout Standard
24137 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
24139 use different line endings inside the .lyx files.
24140 This is not a problem as far as \SpecialChar LyX
24141 functionality is concerned, but the commit
24142 diffs will be huge and merge-conflicts prone.
24143 Fortunately SVN itself knows
24147 \begin_layout Plain Layout
24148 \begin_inset Flex URL
24151 \begin_layout Plain Layout
24153 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
24163 how to deal with CR/LF problems when switching .lyx files to the
24164 \begin_inset Flex Code
24167 \begin_layout Plain Layout
24177 \begin_layout Plain Layout
24179 \begin_inset Flex Code
24182 \begin_layout Plain Layout
24183 svn propset svn:eol-style native FILE_NAME
24196 \begin_layout Subsection
24197 GIT commands in \SpecialChar LyX
24201 \begin_layout Standard
24202 A minimal subset of GIT commands is now supported by \SpecialChar LyX
24204 You can find the commands in the
24206 File\SpecialChar menuseparator
24208 \begin_inset space ~
24214 Please note that if you use password protected access to repository via
24215 ssh, you will be asked in terminal window.
24217 was tested against GIT 1.7.
24221 \begin_layout Plain Layout
24222 Windows users please note that you need to ensure that git is on the path.
24223 This can be set from within \SpecialChar LyX
24226 Tools\SpecialChar menuseparator
24227 Preferences\SpecialChar menuseparator
24228 Paths\SpecialChar menuseparator
24239 \begin_layout Standard
24240 One big difference of GIT and the other supported version control systems
24241 is the distributed nature of GIT: With traditional version control systems
24242 there is one central server which hosts the repository.
24243 Users commit their changes to the server, and get updates made by other
24245 With GIT, users commit to a local repository.
24246 The local repository can be synchronized with one or more remote repositories
24248 \begin_inset Flex Code
24251 \begin_layout Plain Layout
24258 \begin_inset Flex Code
24261 \begin_layout Plain Layout
24269 does not interact in any way with remote GIT repositories.
24270 It works exclusively with the local repository in a very similar way as
24271 with a central CVS or SVN repository.
24272 If you use remote GIT repositories you need to do the
24273 \begin_inset Flex Code
24276 \begin_layout Plain Layout
24283 \begin_inset Flex Code
24286 \begin_layout Plain Layout
24292 operations with your favourite GIT client.
24295 \begin_layout Subsubsection
24301 \begin_layout Standard
24302 If your document is not under revision control, this is the only item shown
24304 And if it is under revision control, the
24308 item is not visible.
24311 \begin_layout Standard
24312 This command registers in GIT your document ONLY in case you have already
24313 the documents directory under GIT control (in particular
24318 This means you have to checkout the archive by yourself.
24321 \begin_layout Standard
24322 Then you are asked interactively to supply an initial description of the
24324 Don't forget that registered file is not yet commi
24325 \change_inserted -712698321 1501253542
24331 \begin_layout Standard
24332 GIT command that is run:
24335 \change_deleted -712698321 1501253534
24337 \begin_inset Quotes eld
24341 \change_inserted -712698321 1501253534
24343 \begin_inset Quotes qld
24349 \change_deleted -712698321 1501253538
24351 \begin_inset Quotes erd
24355 \change_inserted -712698321 1501253538
24357 \begin_inset Quotes qld
24365 \begin_layout Standard
24370 to understand the switches.
24373 \begin_layout Subsubsection
24379 \begin_layout Standard
24380 When you are finished editing a file, you commit your changes.
24381 When you do this, you are asked for a description of the changes.
24382 After that changes are commit
24383 \change_inserted -712698321 1501253548
24389 \begin_layout Standard
24392 git commit -q -m"<description>" <file-name>
24395 \begin_layout Subsubsection
24398 Revert To Repository Version
24401 \begin_layout Standard
24402 This will discard all changes made to the document since the last check
24404 You get a warning before changes are discarded.
24407 \begin_layout Standard
24411 \change_deleted -712698321 1501253553
24413 \begin_inset Quotes eld
24417 \change_inserted -712698321 1501253553
24419 \begin_inset Quotes qld
24425 \change_deleted -712698321 1501253555
24427 \begin_inset Quotes erd
24431 \change_inserted -712698321 1501253555
24433 \begin_inset Quotes qld
24441 \begin_layout Subsubsection
24447 \begin_layout Standard
24448 This will rename the current document including the version history.
24449 It requires a clean document without any changes since the last checkin.
24450 You are asked for a file name and a description of the rename operation.
24451 After that the document is renamed, both locally and in the repository.
24452 If the parent directories of the new and old file names differ, all relative
24453 paths of included files are adjusted (like in
24455 File\SpecialChar menuseparator
24460 Finally, the document is reloaded using the new name.
24463 \begin_layout Labeling
24464 \labelwidthstring 00.00.0000
24466 \begin_inset space ~
24470 \begin_inset space ~
24474 \begin_inset Newline newline
24478 \begin_inset Flex Code
24481 \begin_layout Plain Layout
24483 \change_deleted -712698321 1501253559
24487 \begin_inset Quotes eld
24491 \change_inserted -712698321 1501253559
24493 \begin_inset Quotes qld
24499 \change_deleted -712698321 1501253561
24501 \begin_inset Quotes erd
24505 \change_inserted -712698321 1501253561
24507 \begin_inset Quotes qld
24513 \change_deleted -712698321 1501253562
24515 \begin_inset Quotes eld
24519 \change_inserted -712698321 1501253562
24521 \begin_inset Quotes qld
24527 \change_deleted -712698321 1501253564
24529 \begin_inset Quotes erd
24533 \change_inserted -712698321 1501253564
24535 \begin_inset Quotes qld
24546 \begin_inset Newline newline
24550 \begin_inset Flex Code
24553 \begin_layout Plain Layout
24562 \begin_layout Subsubsection
24568 \begin_layout Standard
24569 This shows the complete history of the GIT document.
24573 \change_deleted -712698321 1501253567
24575 \begin_inset Quotes eld
24579 \change_inserted -712698321 1501253567
24581 \begin_inset Quotes qld
24587 \change_deleted -712698321 1501253569
24589 \begin_inset Quotes erd
24593 \change_inserted -712698321 1501253569
24595 \begin_inset Quotes qld
24602 is shown in a browser.
24605 \begin_layout Subsubsection
24609 \begin_layout Standard
24611 supports GIT hash number of the last commit to the file, author name, date
24612 and time of last commit.
24613 All those are extracted from
24615 git log -n 1 --pretty=format:%H%n%an%n%ai
24618 Tree version information is obtained via
24620 git describe --abbrev --dirty --long
24624 \begin_inset CommandInset ref
24626 reference "subsec:VCS-Revision-Information"
24633 \begin_layout Subsection
24637 \begin_layout Standard
24638 With the recent addition of the
24639 \change_deleted -712698321 1501253582
24641 \change_inserted -712698321 1501253582
24643 \begin_inset Flex Code
24646 \begin_layout Plain Layout
24648 \change_inserted -712698321 1501253582
24658 function \SpecialChar LyX
24659 power users are allowed to create their own commands for revision
24663 \begin_layout Standard
24664 As an example you can see how two TortoiseSVN commands could be integrated
24668 \begin_layout Description
24670 \begin_inset Flex Code
24673 \begin_layout Plain Layout
24674 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
24682 \begin_layout Description
24684 \begin_inset Flex Code
24687 \begin_layout Plain Layout
24688 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
24696 \begin_layout Subsection
24697 Version control and Document comparison
24700 \begin_layout Standard
24701 One of the typical uses of version control is to inspect the changes between
24702 revisions, usually by creating
24703 \begin_inset Flex Code
24706 \begin_layout Plain Layout
24713 While this is useful for plain text files, it is much less useful in the
24714 case of \SpecialChar LyX
24715 files, which have more a complicated structure.
24716 Hence we provide binding to the Document comparison feature.
24717 There are two ways of calling this feature
24718 \change_inserted -712698321 1501253613
24720 \change_deleted -712698321 1501253613
24723 either by direct call of
24724 \begin_inset Flex Code
24727 \begin_layout Plain Layout
24729 \change_deleted -712698321 1501253619
24731 \change_inserted -712698321 1501253621
24740 function (for details see \SpecialChar LyX
24741 functions manual) or by
24742 \change_inserted -712698321 1501253630
24746 \change_inserted -712698321 1501253655
24754 \change_deleted -712698321 1501253665
24756 \change_inserted -712698321 1501253675
24760 \change_inserted -712698321 1501253679
24768 \change_deleted -712698321 1501253689
24770 \begin_inset Flex Noun
24773 \begin_layout Plain Layout
24774 Compare with older revision...
24780 \change_inserted -712698321 1501253693
24784 One can either compare two chosen revisions of the document or he can simply
24785 compare the current version of edited text with older revisions (where
24787 \begin_inset Flex Noun
24790 \begin_layout Plain Layout
24796 ' revisions back means comparison of the edited file with last commited
24801 \begin_layout Standard
24802 This feature is supported for SVN and RCS though due to the more complicated
24803 versioning scheme of RCS there is a constraint – when addressing the revisions
24804 in dialog, numbers always point to the last number in RCS revision number,
24807 We don't currently support GIT addressing of revisions, one can just compare
24808 edited document with its revision X steps backs, where X is addressed as
24810 \change_deleted -712698321 1501253702
24812 \change_inserted -712698321 1501253702
24814 \begin_inset Flex Code
24817 \begin_layout Plain Layout
24819 \change_inserted -712698321 1501253702
24832 \begin_layout Section
24833 Literate Programming
24836 \begin_layout Standard
24841 (kayvan@sylvan.com)
24845 original documentation written by
24847 Edmar Wienskoski Jr.
24850 (edmar-w-jr@technologist.com)
24853 \begin_layout Subsection
24857 \begin_layout Standard
24858 The main purpose of this documentation is to show you how to use \SpecialChar LyX
24860 programming, where it is assumed that you are familiar with this programming
24861 technique, and know what
24862 \begin_inset Quotes eld
24866 \begin_inset Quotes erd
24870 \begin_inset Quotes eld
24874 \begin_inset Quotes erd
24878 If that is not the case, please follow the web links provided in the following
24880 There is a lot of good documentation out there covering old development
24881 history to the latest tools tips.
24884 \begin_layout Standard
24885 It is also assumed that you are familiar with \SpecialChar LyX
24886 itself to a point that you
24887 are comfortable changing your \SpecialChar LyX
24888 preferences, and X resources file.
24889 If that is not the case please refer to other \SpecialChar LyX
24890 documentation to cover your
24894 \begin_layout Subsection
24895 Literate Programming
24898 \begin_layout Standard
24899 From the Literate Programming FAQ:
24902 \begin_layout Quotation
24903 Literate programming is the combination of documentation and source together
24904 in a fashion suited for reading by human beings.
24905 In fact, literate programs should be enjoyable reading, even inviting!
24906 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
24907 and documentation in a single file.
24908 Literate programming tools then parse the file to produce either readable
24909 documentation or compilable source.
24910 The WEB style of literate programming was created by D.
24911 \begin_inset space \thinspace{}
24915 Knuth during the development of his \SpecialChar TeX
24916 typesetting software.
24920 \begin_layout Standard
24921 Another excerpt says:
24924 \begin_layout Quotation
24927 How is literate programming different from verbose commenting?
24930 \begin_layout Quotation
24931 There are three distinguishing characteristics.
24932 In order of importance, they are:
24936 \begin_layout Itemize
24937 flexible order of elaboration
24940 \begin_layout Itemize
24941 automatic support for browsing
24944 \begin_layout Itemize
24945 typeset documentation, especially diagrams and mathematics
24949 \begin_layout Standard
24950 Now that I sparked your curiosity, take a look in the references.
24953 \begin_layout Subsubsection
24957 \begin_layout Standard
24958 The complete Literate Programming FAQ can be found at:
24961 \begin_layout Quote
24962 Literate Programming FAQ
24963 \begin_inset Flex URL
24966 \begin_layout Plain Layout
24968 http://www.literateprogramming.com/lpfaq.pdf
24976 \begin_layout Standard
24977 The FAQ lists 23 (twenty three!) different literate programming tools.
24978 Where some are specialized or
24979 \begin_inset Quotes eld
24983 \begin_inset Quotes erd
24986 for particular programming languages, while other have general scope.
24991 for my own use for several reasons:
24994 \begin_layout Itemize
24995 It can generate the documentation either in \SpecialChar LaTeX
24999 \begin_layout Itemize
25000 It has a open architecture, i.
25001 \begin_inset space \thinspace{}
25005 \begin_inset space \space{}
25008 it is easy to plug in new filters
25009 \change_inserted -712698321 1501229014
25014 \begin_layout Plain Layout
25016 \change_inserted -712698321 1501229136
25021 are programs that read a given data stream and output a manipulated data
25023 That way, a WEB file (consisting of literate code) can be turned into a
25024 file consisting only of C program code or \SpecialChar LaTeX
25032 and to perform special processing that you may need.
25036 \begin_layout Itemize
25037 There is a good selection of filters available already (the HTML is one
25041 \begin_layout Itemize
25045 \begin_layout Standard
25046 The Noweb web page can be found at:
25049 \begin_layout Quote
25051 \begin_inset Flex URL
25054 \begin_layout Plain Layout
25056 http://www.cs.virginia.edu/~nr/noweb/
25064 \begin_layout Standard
25065 Starting from there you can reach many other interesting links and even
25066 some literate program examples.
25069 \begin_layout Subsection
25071 and Literate Programming with Noweb
25074 \begin_layout Standard
25075 The \SpecialChar LyX
25076 support for Literate Programming is provided by using the generic \SpecialChar LyX
25078 converters mechanism.
25079 This support is provided in a
25080 \begin_inset Quotes eld
25084 \begin_inset Quotes erd
25088 \begin_inset space \thinspace{}
25092 \begin_inset space \space{}
25095 you will be able to use this new \SpecialChar LyX
25096 feature with some other literate programming
25097 tool of your choice by just changing your \SpecialChar LyX
25101 \begin_layout Subsubsection
25102 Generating documents and code (weaving and tangling)
25105 \begin_layout Paragraph
25106 Using the noweb module
25109 \begin_layout Standard
25110 If you have installed Noweb and \SpecialChar LyX
25111 successfully, whenever you open a new document,
25112 after you have chosen its document class, use the
25115 \change_deleted -712698321 1501229457
25117 \change_inserted -712698321 1501229457
25118 \SpecialChar menuseparator
25124 \begin_inset Quotes eld
25128 \begin_inset Quotes erd
25132 If Noweb is correctly installed, when you click on the
25133 \begin_inset Quotes eld
25137 \begin_inset Quotes erd
25140 link, you will see the
25141 \begin_inset Quotes eld
25145 \begin_inset Quotes erd
25148 module in the available list and you can add it to your document.
25151 \begin_layout Paragraph
25155 \begin_layout Standard
25157 enables you to write code with a
25158 \change_deleted -712698321 1501229783
25160 \change_inserted -712698321 1501229785
25164 \begin_inset Flex Noun
25167 \begin_layout Plain Layout
25174 Noweb delimits chunks like this:
25177 \begin_layout LyX-Code
25181 \begin_layout LyX-Code
25185 \begin_layout LyX-Code
25189 \begin_layout LyX-Code
25193 \begin_layout LyX-Code
25197 \begin_layout Standard
25198 The problem is that whatever is written in between the << and the
25202 must be taken literally, i.
25203 \begin_inset space \thinspace{}
25207 \begin_inset space \space{}
25211 should be prevented from making any special interpretation of what has
25213 This is also handled by
25214 \begin_inset Flex Noun
25217 \begin_layout Plain Layout
25223 , that works like a normal
25224 \change_deleted -712698321 1501229871
25226 \change_inserted -712698321 1501229873
25229 but has a free spacing capability.
25232 \begin_layout Standard
25233 As a special note, you can also use the
25234 \begin_inset Quotes eld
25238 \begin_inset Quotes erd
25241 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
25245 \begin_layout LyX-Code
25249 \begin_layout LyX-Code
25250 def some_function(args):
25253 \begin_layout LyX-Code
25254 "This is the doc string for this function."
25257 \begin_layout LyX-Code
25258 print "My args: ", args
25261 \begin_layout LyX-Code
25262 @ %def some_function
25265 \begin_layout Standard
25266 For an example of this usage and the resulting cross-reference output, look
25267 at the Literate python program in
25269 LIBDIR/examples/listerrors.lyx
25271 which should make this all clear.
25274 \begin_layout Paragraph
25275 Generating the documentation
25278 \begin_layout Standard
25279 At this point you already have a new document file with a proper document
25280 class, and with some code and text on it.
25281 How do I print it? The answer is simple, you select
25283 View\SpecialChar menuseparator
25287 Just like you would do for a plain document.
25288 No special procedure is required.
25291 \begin_layout Standard
25292 To help orientate you, I will now explain what happens inside \SpecialChar LyX
25296 \begin_layout Enumerate
25299 Update\SpecialChar menuseparator
25302 menu option is chosen, a \SpecialChar LaTeX
25308 \begin_layout Standard
25309 If the document is of any literate class the generated file will be named
25310 with an extension name defined by the
25311 \begin_inset Quotes eld
25315 \begin_inset Quotes erd
25318 format (defined in the Preferences panel), otherwise the file will have
25327 \begin_layout Enumerate
25328 Note that the only difference so far is in the name of the file, no special
25329 processing is required by \SpecialChar LyX
25331 Given that you formatted the code using the
25332 \begin_inset Flex Noun
25335 \begin_layout Plain Layout
25342 \change_deleted -712698321 1501230025
25344 \change_inserted -712698321 1501230027
25347 that, by itself, takes care of the business.
25350 \begin_layout Enumerate
25351 If the document is of any literate class \SpecialChar LyX
25352 will then use the internal \SpecialChar LyX
25354 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
25359 \begin_layout Plain Layout
25360 The converters are defined in the
25362 Tools\SpecialChar menuseparator
25366 \begin_inset Quotes eld
25370 \begin_inset Quotes erd
25382 manual for general information about converters.
25387 to generate the \SpecialChar LaTeX
25392 \begin_layout Standard
25393 Otherwise it will just skip this step.
25397 \begin_layout Enumerate
25398 Finally, \SpecialChar LaTeX
25399 is invoked and the regular post processing continues as in a plain
25403 \begin_layout Standard
25404 Independence from a particular
25405 \begin_inset Quotes eld
25409 \begin_inset Quotes erd
25412 is easily achieved by changing the commands that are run by the various
25416 \begin_layout Paragraph
25417 Generating the code
25420 \begin_layout Standard
25421 When the build menu option is chosen or the corresponding button in the
25422 toolbar is pressed, a \SpecialChar LaTeX
25423 file is generated just like step 1 above.
25424 Next, \SpecialChar LyX
25430 This converter needs to be defined by the user and is not installed by
25431 default, though the Program format is.
25432 This converter (like any other converter) will have two parts:
25435 \begin_layout Enumerate
25436 The converter program itself.
25437 This program performs the conversion from the one format to the other (in
25438 this case, from the Noweb format to the Program pseudo-format).
25441 \begin_layout Enumerate
25442 The error log parser.
25443 This is a program whose sole purpose is to rewrite error messages in a
25444 format that \SpecialChar LyX
25446 This makes it possible for \SpecialChar LyX
25447 to place error boxes in the right places in
25451 \begin_layout Standard
25452 The first part, the
25453 \begin_inset Quotes eld
25457 \begin_inset Quotes erd
25460 setting, should be set to
25461 \change_inserted -712698321 1501230220
25465 \begin_layout LyX-Code
25467 \change_deleted -712698321 1501230232
25468 \begin_inset Newline newline
25472 \begin_inset Quotes eld
25482 \change_deleted -712698321 1501230236
25484 \begin_inset Quotes erd
25488 \begin_inset Newline newline
25492 \change_inserted -712698321 1501230224
25496 \begin_layout Standard
25497 This basically means that \SpecialChar LyX
25499 \begin_inset Quotes eld
25503 \begin_inset Quotes erd
25506 (a program or script) with the name of the Noweb file (normally a file
25507 in the \SpecialChar LyX
25508 temp directory) and the directory path of the original \SpecialChar LyX
25513 \begin_layout Standard
25514 This is an implementation of
25515 \begin_inset Quotes eld
25519 \begin_inset Quotes erd
25522 that you can place in a directory on your path:
25525 \begin_layout Standard
25527 \change_deleted -712698321 1501230298
25528 \begin_inset VSpace defskip
25536 \begin_layout Standard
25538 \change_deleted -712698321 1501230296
25539 \begin_inset Newpage pagebreak
25547 \begin_layout LyX-Code
25553 \begin_layout LyX-Code
25559 \begin_layout LyX-Code
25562 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
25565 \begin_layout Standard
25567 \change_deleted -712698321 1501230299
25568 \begin_inset VSpace defskip
25576 \begin_layout Standard
25577 The next part of the converter setting is the
25578 \begin_inset Quotes eld
25582 \begin_inset Quotes erd
25585 which is to be set to
25586 \change_inserted -712698321 1501230552
25590 \begin_layout LyX-Code
25592 \change_deleted -712698321 1501230577
25593 \begin_inset Newline newline
25597 \begin_inset Quotes eld
25604 parselog=$$s/scripts/listerrors
25605 \change_deleted -712698321 1501230575
25609 \begin_inset Quotes erd
25613 \begin_inset Newline newline
25617 \change_inserted -712698321 1501230544
25621 \begin_layout Standard
25622 This will run any errors that are generated by the
25623 \begin_inset Quotes eld
25627 \begin_inset Quotes erd
25630 process through the
25631 \begin_inset Quotes eld
25635 \begin_inset Quotes erd
25641 \begin_layout Standard
25642 The build will normally take place in \SpecialChar LyX
25643 's temporary directory, so the files
25644 produced by the conversion will be in that directory.
25646 will copy out what it regards as the `main' file, but the
25650 conversion may produce several files, and so most of these would then be
25651 deleted when \SpecialChar LyX
25653 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
25654 the build-script chunk can place the generated files in that location.
25657 \begin_layout Paragraph
25658 Build instructions in the document
25661 \begin_layout Standard
25662 The last piece of the integration between \SpecialChar LyX
25664 \begin_inset Quotes eld
25668 \begin_inset Quotes erd
25672 Generally, the instructions for building your program should be embedded
25673 in a chunk of its own.
25675 \begin_inset Quotes eld
25679 \begin_inset Quotes erd
25682 above uses the notangle command to look for this chunk (called
25683 \begin_inset Quotes eld
25687 \begin_inset Quotes erd
25690 ) and runs its contents through
25691 \begin_inset Quotes eld
25695 \begin_inset Quotes erd
25701 \begin_layout Standard
25702 Typically, such a chunk would look something like this:
25705 \begin_layout LyX-Code
25709 \begin_layout LyX-Code
25711 \begin_inset Newline newline
25714 if [ -z "${NOWEB_SOURCE}" ]
25715 \begin_inset Newline newline
25721 \begin_layout LyX-Code
25722 NOWEB_SOURCE=myfile.nw
25723 \begin_inset Newline newline
25727 \begin_inset Newline newline
25731 code to extract files ...
25732 use NOWEB_OUTPUT_DIR here ...]
25733 \begin_inset Newline newline
25737 code to compile files ...]
25738 \begin_inset Newline newline
25744 \begin_layout Standard
25747 LIBDIR/examples/listerrors.lyx
25751 LIBDIR/examples/Literate.lyx
25753 which implement two versions of the
25754 \begin_inset Quotes eld
25758 \begin_inset Quotes erd
25761 program for some illustrations of how all of these pieces go together or
25764 LIBDIR/examples/noweb2lyx.lyx.
25767 Interestingly, these three files show off the language-indepence of the
25769 literate programming support since they are written in Python, C and Perl
25773 \begin_layout Subsubsection
25774 Configuring \SpecialChar LyX
25778 \begin_layout Standard
25779 All the Literate Programming support is configured by the
25781 Tools\SpecialChar menuseparator
25785 \begin_inset Quotes eld
25789 \begin_inset Quotes erd
25793 The important parts are:
25796 \begin_layout Description
25798 \begin_inset space ~
25802 \begin_inset Quotes eld
25806 \begin_inset Quotes erd
25810 \begin_inset space ~
25813 format Set up via the File Formats tab, this is where the Noweb-specific
25823 , the file extension is set to
25828 This tells \SpecialChar LyX
25829 to create a file with a
25833 extension in the first step of the conversion process.
25836 \begin_layout Description
25838 \begin_inset space ~
25846 \begin_inset space ~
25849 format This is an empty format whose sole purpose is to be the endpoint
25850 of a conversion (which then allows us to set up a converter for it).
25853 \begin_layout Description
25863 This converter performs the
25864 \begin_inset Quotes eld
25868 \begin_inset Quotes erd
25871 of the literate document.
25872 For Noweb, it is set to
25873 \begin_inset Quotes eld
25878 noweave -delay -index $$i > $$o
25881 \begin_inset Quotes erd
25887 \begin_layout Description
25897 \begin_inset Quotes eld
25901 \begin_inset Quotes erd
25905 As stated above, the Converter is set to
25906 \begin_inset Quotes eld
25914 \begin_inset Quotes erd
25917 , with Flags set to
25918 \begin_inset Newline newline
25922 \begin_inset Quotes eld
25927 parselog=$$s/scripts/listerrors
25930 \begin_inset Quotes erd
25936 \begin_layout Subsubsection
25940 \begin_layout Standard
25941 There is also a new function implemented in the \SpecialChar LyX
25943 \begin_inset Quotes eld
25946 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
25950 \begin_layout Standard
25951 When debugging code with ddd/gdb, it is possible to invoke a text editor
25952 at the current execution position with a single key stroke.
25953 The default ddd configuration for that is shift-ctrl-V.
25954 It happens that you can define the editor command line invocation in ddd
25957 Edit\SpecialChar menuseparator
25958 Preferences\SpecialChar menuseparator
25961 dialog and changing the "Edit Sources" entry.
25964 \begin_layout Standard
25965 I take advantage of the newly created \SpecialChar LyX
25966 server function and this ddd feature,
25968 \begin_inset Quotes eld
25972 \begin_inset Quotes erd
25978 \begin_layout Standard
25980 \change_deleted -712698321 1501232274
25981 \begin_inset VSpace defskip
25985 \change_inserted -712698321 1501232276
25989 \begin_layout LyX-Code
25990 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
25993 \begin_layout Standard
25995 \change_deleted -712698321 1501232278
25996 \begin_inset VSpace defskip
26004 \begin_layout Standard
26005 With this, whenever you are using ddd and find a point in the program that
26006 you want to edit, you just press shift-ctrl-V (in the ddd window), and
26007 ddd will forward this information to \SpecialChar LyX
26008 through the \SpecialChar LyX
26009 server and then the
26011 window will show the same file with the cursor at the same position ddd
26013 No more guessing or long scrolling to locate a point in the program back
26017 \begin_layout Standard
26018 Note however that you must enable the \SpecialChar LyX
26019 server to get this feature working
26020 (it is disabled by default).
26022 \change_deleted -712698321 1501232597
26023 You can enable it in
26035 ) by entering in the
26041 \begin_inset Quotes eld
26046 /home/<your-home-directory>/.lyx/lyxpipe
26049 \begin_inset Quotes erd
26055 \begin_layout Standard
26057 \change_inserted -712698321 1501232576
26059 \begin_inset space ~
26063 \begin_inset CommandInset ref
26065 reference "sec:Starting-the-Server"
26069 explains how to do that
26070 \change_deleted -712698321 1501232579
26071 Read the \SpecialChar LyX
26072 server documentation in the
26074 Customization Manual
26076 for further information
26081 \begin_layout Subsubsection
26085 \begin_layout Standard
26086 There are six new buttons that can be added to your \SpecialChar LyX
26089 \change_deleted -712698321 1501232976
26091 \change_inserted -712698321 1501232977
26094 of these buttons are short cuts to layout styles:
26108 \change_inserted -712698321 1501232982
26117 \change_deleted -712698321 1501232984
26119 \change_inserted -712698321 1501232988
26121 \change_inserted 34634807 1501446371
26123 \change_deleted 34634807 1501446371
26125 \change_inserted -712698321 1501232988
26133 The last one is a short cut to the
26134 \begin_inset Quotes eld
26138 \begin_inset Quotes erd
26145 \begin_layout Standard
26147 has a range of buttons that are available for tool bar customization.
26148 In my toolbar I like to combine the six short cuts above with two more:
26153 \SpecialChar menuseparator
26158 \SpecialChar menuseparator
26165 Document\SpecialChar menuseparator
26166 View\SpecialChar menuseparator
26170 Here is how it looks like:
26173 \begin_layout LyX-Code
26177 \begin_layout LyX-Code
26181 \begin_layout LyX-Code
26182 Icon "layout Standard"
26185 \begin_layout LyX-Code
26186 Icon "layout Section"
26189 \begin_layout LyX-Code
26190 Icon "layout \SpecialChar LaTeX
26194 \begin_layout LyX-Code
26195 Icon "layout \SpecialChar LyX
26199 \begin_layout LyX-Code
26201 \change_deleted -712698321 1501232918
26203 \change_inserted -712698321 1501232921
26209 \begin_layout LyX-Code
26213 \begin_layout LyX-Code
26217 \begin_layout LyX-Code
26218 Icon "buffer-typeset"
26221 \begin_layout LyX-Code
26222 Icon "build-program"
26225 \begin_layout LyX-Code
26229 \begin_layout LyX-Code
26233 \begin_layout LyX-Code
26237 \begin_layout LyX-Code
26241 \begin_layout LyX-Code
26245 \begin_layout Subsubsection
26246 Colors customization
26249 \begin_layout Standard
26250 There are a number of colors in \SpecialChar LyX
26251 that can be customized in
26256 One of the things that bothers people is the \SpecialChar LaTeX
26258 The default color is red, since the chunks uses \SpecialChar LaTeX
26259 font, and there is a lot
26260 of chunks in literate documents, you may get tired of seeing everything
26262 You can change it by going to the tabs
26271 \begin_layout Standard
26272 The next thing is the visible presence of the newline character in the screen.
26273 You can choose the color of this particular character and make it blend
26275 I recommend you choosing a color that is close to the background but not
26276 equal, that way you still can see it is there, but it is not bothering
26280 \begin_layout Subsection
26285 \begin_layout Standard
26294 is documented in the
26298 example file and in the Sweave manual (menu
26300 Help\SpecialChar menuseparator
26306 \begin_layout Chapter
26310 \begin_layout Standard
26311 You can do everything with \SpecialChar LyX
26312 that you can do with \SpecialChar LaTeX
26314 However, \SpecialChar LyX
26315 cannot support every \SpecialChar LaTeX
26317 But you can always use \SpecialChar TeX
26319 This chapter shows you some more special things you might want to use.
26320 For other special things you can do with figures, tables, floats, boxes
26321 and notes, have a look at the
26324 \begin_inset space ~
26332 \begin_layout Section
26333 Multiple Text Columns
26336 \begin_layout Standard
26337 This feature is independent of the option
26339 Two-column document
26341 in the document settings under
26346 If you want to have 2
26347 \begin_inset space ~
26350 columns for the whole document, it is recommended to use the
26352 Two-column document
26355 For all other cases use this feature.
26358 \begin_layout Standard
26359 To use multiple text columns in your document, you have to load the module
26366 Document\SpecialChar menuseparator
26367 Settings\SpecialChar menuseparator
26370 ) and must have the \SpecialChar LaTeX
26372 \change_deleted -712698321 1501235255
26374 \change_inserted -712698321 1501235255
26376 \begin_inset Flex Code
26379 \begin_layout Plain Layout
26381 \change_inserted -712698321 1501235255
26394 \begin_layout Standard
26395 Footnotes within multiple columns will be placed at the bottom of the page
26396 and not under each column.
26397 Within the different columns you can use everything, with the limitation
26398 that for floats you need to use the float option
26405 \begin_layout Subsection
26409 \begin_layout Standard
26410 If you want to have 2
26411 \begin_inset space ~
26414 columns in your text, insert a multicolumn inset via the menu
26416 Insert\SpecialChar menuseparator
26418 \begin_inset space ~
26421 Insets\SpecialChar menuseparator
26423 \begin_inset space ~
26428 where the columns should start.
26429 Write all text that should be printed in 2
26430 \begin_inset space ~
26433 columns into this inset.
26436 \begin_layout Standard
26437 Here is an example:
26440 \begin_layout Standard
26442 \begin_inset Flex Multiple Columns
26445 \begin_layout Plain Layout
26450 The Adventure of the Empty House
26453 \begin_inset Newline newline
26456 by Sir Arthur Conan Doyle
26459 \begin_layout Plain Layout
26462 It was in the spring of the year 1894 that all London was interested, and
26463 the fashionable world dismayed, by the murder of the Honourable Ronald
26464 Adair under most unusual and inexplicable circumstances.
26465 The public has already learned those particulars of the crime which came
26466 out in the police investigation, but a good deal was suppressed upon that
26467 occasion, since the case for the prosecution was so overwhelmingly strong
26468 that it was not necessary to bring forward all the facts.
26469 Only now, at the end of nearly ten years, am I allowed to supply those
26470 missing links which make up the whole of that remarkable chain.
26471 The crime was of interest in itself, but that interest was as nothing to
26472 me compared to the inconceivable sequel, which afforded me the greatest
26473 shock and surprise of any event in my adventurous life.
26474 Even now, after this long interval, I find myself thrilling as I think
26475 of it, and feeling once more that sudden flood of joy, amazement, and increduli
26476 ty which utterly submerged my mind.
26477 Let me say to that public, which has shown some interest in those glimpses
26478 which I have occasionally given them of the thoughts and actions of a very
26479 remarkable man, that they are not to blame me if I have not shared my knowledge
26480 with them, for I should have considered it my first duty to do so, had
26481 I not been barred by a positive prohibition from his own lips, which was
26482 only withdrawn upon the third of last month.
26490 \begin_layout Standard
26491 To get 3 or more columns, set the cursor into the multicolumn inset and
26494 Insert\SpecialChar menuseparator
26496 \begin_inset space ~
26500 \begin_inset space ~
26506 The number of the desired columns is written into that inset (for 3
26507 \begin_inset space ~
26511 \begin_inset Quotes eld
26515 \begin_inset Quotes erd
26519 \begin_inset Newline newline
26522 Here is an example with 3
26523 \begin_inset space ~
26529 \begin_layout Standard
26530 \begin_inset Flex Multiple Columns
26533 \begin_layout Plain Layout
26536 \begin_inset Argument 1
26539 \begin_layout Plain Layout
26545 It can be imagined that my close intimacy with Sherlock Holmes had interested
26546 me deeply in crime, and that after his disappearance I never failed to
26547 read with care the various problems which came before the public.
26548 And I even attempted, more than once, for my own private satisfaction,
26549 to employ his methods in their solution, though with indifferent success.
26550 There was none, however, which appealed to me like this tragedy of Ronald
26552 As I read the evidence at the inquest, which led up to a verdict of willful
26553 murder against some person or persons unknown, I realized more clearly
26554 than I had ever done the loss which the community had sustained by the
26555 death of Sherlock Holmes.
26556 There were points about this strange business which would, I was sure,
26557 have specially appealed to him, and the efforts of the police would have
26558 been supplemented, or more probably anticipated, by the trained observation
26559 and the alert mind of the first criminal agent in Europe.
26560 All day, as I drove upon my round, I turned over the case in my mind and
26561 found no explanation which appeared to me to be adequate.
26562 At the risk of telling a twice-told tale, I will recapitulate the facts
26563 as they were known to the public at the conclusion of the inquest.
26571 \begin_layout Standard
26572 You can have up to 10
26573 \begin_inset space ~
26576 columns if you want to, but that might not be very pleasant for the readers
26580 \begin_layout Standard
26581 \begin_inset Newpage newpage
26587 \begin_layout Subsection
26588 Columns inside Columns
26591 \begin_layout Standard
26592 You can also have columns inside columns:
26595 \begin_layout Standard
26596 \begin_inset Flex Multiple Columns
26599 \begin_layout Plain Layout
26602 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
26603 at that time governor of one of the Australian colonies.
26604 Adair's mother had returned from Australia to undergo the operation for
26605 cataract, and she, her son Ronald, and her daughter Hilda were living together
26609 \begin_layout Plain Layout
26610 \begin_inset Flex Multiple Columns
26613 \begin_layout Plain Layout
26616 The youth moved in the best society–had, so far as was known, no enemies
26617 and no particular vices.
26618 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
26619 had been broken off by mutual consent some months before, and there was
26620 no sign that it had left any very profound feeling behind it.
26621 For the rest {sic} the man's life moved in a narrow and conventional circle,
26622 for his habits were quiet and his nature unemotional.
26623 Yet it was upon this easy-going young aristocrat that death came, in most
26624 strange and unexpected form, between the hours of ten and eleven-twenty
26625 on the night of March 30, 1894.
26633 \begin_layout Plain Layout
26636 Ronald Adair was fond of cards–playing continually, but never for such stakes
26638 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
26639 It was shown that, after dinner on the day of his death, he had played
26640 a rubber of whist at the latter club.
26641 He had also played there in the afternoon.
26646 The evidence of those who had played with him– Mr.
26647 Murray, Sir John Hardy, and Colonel Moran–showed that the game was whist,
26648 and that there was a fairly equal fall of the cards.
26649 Adair might have lost five pounds, but not more.
26650 His fortune was a considerable one, and such a loss could not in any way
26652 He had played nearly every day at one club or other, but he was a cautious
26653 player, and usually rose a winner.
26654 It came out in evidence that, in partnership with Colonel Moran, he had
26655 actually won as much as four hundred and twenty pounds in a sitting, some
26656 weeks before, from Godfrey Milner and Lord Balmoral.
26657 So much for his recent history as it came out at the inquest.
26665 \begin_layout Subsection
26669 \begin_layout Standard
26670 The examples in this section show some more special features of multiple
26674 \begin_layout Standard
26675 For more features of multiple columns, have a look at the
26676 \change_deleted -712698321 1501236578
26678 \change_inserted -712698321 1501236578
26680 \begin_inset CommandInset href
26682 name "documentation"
26683 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26690 of the \SpecialChar LaTeX
26692 \change_deleted -712698321 1501235271
26694 \change_inserted -712698321 1501235271
26696 \begin_inset Flex Code
26699 \begin_layout Plain Layout
26701 \change_inserted -712698321 1501235271
26710 \change_deleted -712698321 1501236609
26712 \begin_inset CommandInset citation
26724 \begin_layout Subsubsection
26728 \begin_layout Standard
26729 To add a preface text for multiple columns, set the cursor into the multicolumn
26730 inset and use the menu
26732 Insert\SpecialChar menuseparator
26736 Write your preface text into that inset.
26737 \begin_inset Newline newline
26740 This is an example with some preface text:
26743 \begin_layout Standard
26744 \begin_inset VSpace bigskip
26750 \begin_layout Standard
26751 \begin_inset Flex Multiple Columns
26754 \begin_layout Plain Layout
26755 \begin_inset Argument 2
26758 \begin_layout Plain Layout
26759 And the story continues and continues and continues and continues\SpecialChar ldots
26767 On the evening of the crime, he returned from the club exactly at ten.
26768 His mother and sister were out spending the evening with a relation.
26769 The servant deposed that she heard him enter the front room on the second
26770 floor, generally used as his sitting-room.
26771 She had lit a fire there, and as it smoked she had opened the window.
26772 No sound was heard from the room until eleven-twenty, the hour of the return
26773 of Lady Maynooth and her daughter.
26774 Desiring to say good-night, she attempted to enter her son's room.
26775 The door was locked on the inside, and no answer could be got to their
26776 cries and knocking.
26777 Help was obtained, and the door forced.
26778 The unfortunate young man was found lying near the table.
26779 His head had been horribly mutilated by an expanding revolver bullet, but
26780 no weapon of any sort was to be found in the room.
26788 \begin_layout Standard
26789 You can also use a section heading as the preface if you use a section command
26790 as \SpecialChar TeX
26792 For example the command
26795 \begin_layout LyX-Code
26798 subsection{subsection title}
26801 \begin_layout Standard
26802 creates a subsection.
26803 In this example the preface is a subsubsection:
26806 \begin_layout Standard
26807 \begin_inset Flex Multiple Columns
26810 \begin_layout Plain Layout
26811 \begin_inset Argument 2
26814 \begin_layout Plain Layout
26818 \begin_layout Plain Layout
26827 This is a subsubsection heading as a preface
26831 \begin_layout Plain Layout
26845 A minute examination of the circumstances served only to make the case more
26847 In the first place, no reason could be given why the young man should have
26848 fastened the door upon the inside.
26849 There was the possibility that the murderer had done this, and had afterwards
26850 escaped by the window.
26851 The drop was at least twenty feet, however, and a bed of crocuses in full
26853 Neither the flowers nor the earth showed any sign of having been disturbed,
26854 nor were there any marks upon the narrow strip of grass which separated
26855 the house from the road.
26856 Apparently, therefore, it was the young man himself who had fastened the
26858 But how did he come by his death? No one could have climbed up to the window
26859 without leaving traces.
26860 Suppose a man had fired through the window, he would indeed be a remarkable
26861 shot who could with a revolver inflict so deadly a wound.
26862 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
26863 a hundred yards of the house.
26864 No one had heard a shot.
26872 \begin_layout Standard
26873 If there is less vertical space than 6
26874 \begin_inset space ~
26877 text lines is left on the page at the beginning of the multiple columns,
26878 a page break will be inserted before the multiple columns.
26879 Depending on the number of lines of the preface text, you might want to
26881 This is done by setting the cursor into the mulitcolumn inset behind the
26882 preface (if there is any) and using the menu
26884 Insert\SpecialChar menuseparator
26886 \begin_inset space ~
26890 \begin_inset space ~
26894 \begin_inset space ~
26900 Insert into that inset the amount of space like e.
26901 \begin_inset space \thinspace{}
26905 \begin_inset space \space{}
26909 \begin_inset Quotes eld
26913 \begin_inset Quotes erd
26917 \begin_inset Newline newline
26920 In this example the space is set to 7
26921 \begin_inset space ~
26924 text lines by using
26925 \change_deleted -712698321 1501235295
26927 \begin_inset Quotes eld
26933 \change_inserted -712698321 1501235293
26935 \begin_inset Flex Code
26938 \begin_layout Plain Layout
26940 \change_inserted -712698321 1501235293
26951 \change_deleted -712698321 1501235296
26953 \begin_inset Quotes erd
26959 \change_deleted -712698321 1501235285
26963 \change_inserted -712698321 1501235285
26965 \begin_inset Flex Code
26968 \begin_layout Plain Layout
26970 \change_inserted -712698321 1501235285
26982 needs to be inserted as \SpecialChar TeX
26986 \begin_layout Standard
26987 \begin_inset Flex Multiple Columns
26990 \begin_layout Plain Layout
26991 \begin_inset Argument 3
26994 \begin_layout Plain Layout
26999 \begin_layout Plain Layout
27015 On the evening of the crime, he returned from the club exactly at ten.
27016 His mother and sister were out spending the evening with a relation.
27017 The servant deposed that she heard him enter the front room on the second
27018 floor, generally used as his sitting-room.
27019 She had lit a fire there, and as it smoked she had opened the window.
27020 No sound was heard from the room until eleven-twenty, the hour of the return
27021 of Lady Maynooth and her daughter.
27022 Desiring to say good-night, she attempted to enter her son's room.
27023 The door was locked on the inside, and no answer could be got to their
27024 cries and knocking.
27025 Help was obtained, and the door forced.
27026 The unfortunate young man was found lying near the table.
27027 His head had been horribly mutilated by an expanding revolver bullet, but
27028 no weapon of any sort was to be found in the room.
27036 \begin_layout Subsubsection
27040 \begin_layout Standard
27041 The amount of space before and after multiple columns can be changed by
27042 changing the length
27043 \change_deleted -712698321 1501235307
27047 \change_inserted -712698321 1501235307
27049 \begin_inset Flex Code
27052 \begin_layout Plain Layout
27054 \change_inserted -712698321 1501235307
27067 For example the command
27070 \begin_layout LyX-Code
27078 \begin_layout Standard
27079 in \SpecialChar TeX
27080 Code changes its value to 3
27081 \begin_inset space \thinspace{}
27085 The change must be made before the multiple columns' start.
27086 The predefined value is 13
27087 \begin_inset space \thinspace{}
27093 \begin_layout Standard
27095 \change_deleted -712698321 1501235314
27099 \change_inserted -712698321 1501235315
27101 \begin_inset Flex Code
27104 \begin_layout Plain Layout
27106 \change_inserted -712698321 1501235315
27119 \begin_inset space \thinspace{}
27125 \begin_layout Standard
27129 \begin_layout Plain Layout
27135 multicolsep}{2.5cm}
27143 \begin_layout Standard
27144 \begin_inset Flex Multiple Columns
27147 \begin_layout Plain Layout
27150 All day I turned these facts over in my mind, endeavouring to hit upon some
27151 theory which could reconcile them all, and to find that line of least resistanc
27152 e which my poor friend had declared to be the starting-point of every investigat
27154 I confess that I made little progress.
27155 In the evening I strolled across the Park, and found myself about six o'clock
27156 at the Oxford Street end of Park Lane.
27157 A group of loafers upon the pavements, all staring up at a particular window,
27158 directed me to the house which I had come to see.
27159 A tall, thin man with coloured glasses, whom I strongly suspected of being
27160 a plain-clothes detective, was pointing out some theory of his own, while
27161 the others crowded round to listen to what he said.
27162 I got as near him as I could, but his observations seemed to me to be absurd,
27163 so I withdrew again in some disgust.
27164 As I did so I struck against an elderly, deformed man, who had been behind
27165 me, and I knocked down several books which he was carrying.
27173 \begin_layout Standard
27174 \begin_inset Note Greyedout
27177 \begin_layout Plain Layout
27182 The values you set with
27183 \change_inserted -712698321 1501235328
27185 \begin_inset Flex Code
27188 \begin_layout Plain Layout
27190 \change_inserted -712698321 1501235333
27201 \change_deleted -712698321 1501235331
27210 will be used for all following multiple columns until you change them again.
27218 \begin_layout Standard
27222 \begin_layout Plain Layout
27234 \begin_inset Note Note
27237 \begin_layout Plain Layout
27238 go back to the default
27246 \begin_layout Standard
27247 \begin_inset Newpage newpage
27253 \begin_layout Subsubsection
27257 \begin_layout Standard
27258 A column break can be forced by inserting the command
27259 \change_deleted -712698321 1501235399
27263 \change_inserted -712698321 1501235399
27265 \begin_inset Flex Code
27268 \begin_layout Plain Layout
27270 \change_inserted -712698321 1501235399
27282 as \SpecialChar TeX
27283 Code to that position in the text where the column should be broken.
27284 Note that this leads in most cases to whitespace in the text.
27285 \begin_inset Newline newline
27288 Here is an example:
27291 \begin_layout Standard
27292 \begin_inset Flex Multiple Columns
27295 \begin_layout Plain Layout
27298 \begin_inset Quotes eld
27301 You're surprised to see me, sir,
27302 \begin_inset Quotes erd
27305 said he, in a strange, croaking voice.
27308 \begin_layout Plain Layout
27311 I acknowledged that I was.
27314 \begin_layout Plain Layout
27317 \begin_inset Quotes eld
27320 Well, I've a conscience, sir, and when I chanced to see you go into this
27321 house, as I came hobbling after you, I thought to myself, I'll just step
27322 in and see that kind gentleman, and tell him that if I was a bit gruff
27323 in my manner there was not any harm meant, and that I am much obliged to
27324 him for picking up my books.
27325 \begin_inset Quotes erd
27331 \begin_layout Plain Layout
27334 \begin_inset Quotes eld
27337 You make too much of a trifle,
27338 \begin_inset Quotes erd
27343 \begin_inset Quotes eld
27346 May I ask how you knew who I was?
27347 \begin_inset Quotes erd
27350 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
27354 \begin_layout Plain Layout
27366 \begin_layout Plain Layout
27369 \begin_inset Quotes eld
27372 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
27373 you'll find my little bookshop at the corner of Church Street, and very
27374 happy to see you, I am sure.
27375 Maybe you collect yourself, sir.
27379 \begin_inset space ~
27392 –a bargain, every one of them.
27393 With five volumes you could just fill that gap on that second shelf.
27394 It looks untidy, does it not, sir?
27395 \begin_inset Quotes erd
27406 \begin_layout Subsubsection
27410 \begin_layout Standard
27411 The width of the columns is automatically calculated, but you can modify
27412 the space between the columns.
27413 This is done by changing the length
27414 \change_deleted -712698321 1501235412
27418 \change_inserted -712698321 1501235412
27420 \begin_inset Flex Code
27423 \begin_layout Plain Layout
27425 \change_inserted -712698321 1501235412
27438 Its predefined value is 10
27439 \begin_inset space \thinspace{}
27443 Here is an example where
27444 \change_deleted -712698321 1501235418
27448 \change_inserted -712698321 1501235418
27450 \begin_inset Flex Code
27453 \begin_layout Plain Layout
27455 \change_inserted -712698321 1501235418
27468 \begin_inset space \thinspace{}
27474 \begin_layout Standard
27478 \begin_layout Plain Layout
27492 \begin_layout Standard
27493 \begin_inset Flex Multiple Columns
27496 \begin_layout Plain Layout
27499 My observations of No.
27500 \begin_inset space \space{}
27503 427 Park Lane did little to clear up the problem in which I was interested.
27504 The house was separated from the street by a low wall and railing, the
27505 whole not more than five feet high.
27506 It was perfectly easy, therefore, for anyone to get into the garden, but
27507 the window was entirely inaccessible, since there was no water pipe or
27508 anything which could help the most active man to climb it.
27509 More puzzled than ever, I retraced my steps to Kensington.
27510 I had not been in my study five minutes when the maid entered to say that
27511 a person desired to see me.
27512 To my astonishment it was none other than my strange old book collector,
27513 his sharp, wizened face peering out from a frame of white hair, and his
27514 precious volumes, a dozen of them at least, wedged under his right arm.
27522 \begin_layout Standard
27526 \begin_layout Plain Layout
27538 \begin_inset Note Note
27541 \begin_layout Plain Layout
27542 go back to the default
27550 \begin_layout Subsubsection
27554 \begin_layout Standard
27555 Between the columns a rule with a width of the length
27556 \change_deleted -712698321 1501235428
27560 \change_inserted -712698321 1501235428
27562 \begin_inset Flex Code
27565 \begin_layout Plain Layout
27567 \change_inserted -712698321 1501235428
27580 If this rule width is set to 0
27581 \begin_inset space \thinspace{}
27584 pt (this is the default), the rule is suppressed.
27585 In the following example the rule is 2
27586 \begin_inset space \thinspace{}
27592 \begin_layout Standard
27596 \begin_layout Plain Layout
27602 columnseprule}{2pt}
27610 \begin_layout Standard
27611 \begin_inset Flex Multiple Columns
27614 \begin_layout Plain Layout
27617 \begin_inset Quotes eld
27620 You're surprised to see me, sir,
27621 \begin_inset Quotes erd
27624 said he, in a strange, croaking voice.
27627 \begin_layout Plain Layout
27630 I acknowledged that I was.
27633 \begin_layout Plain Layout
27636 \begin_inset Quotes eld
27639 Well, I've a conscience, sir, and when I chanced to see you go into this
27640 house, as I came hobbling after you, I thought to myself, I'll just step
27641 in and see that kind gentleman, and tell him that if I was a bit gruff
27642 in my manner there was not any harm meant, and that I am much obliged to
27643 him for picking up my books.
27644 \begin_inset Quotes erd
27650 \begin_layout Plain Layout
27653 \begin_inset Quotes eld
27656 You make too much of a trifle,
27657 \begin_inset Quotes erd
27662 \begin_inset Quotes eld
27665 May I ask how you knew who I was?
27666 \begin_inset Quotes erd
27672 \begin_layout Plain Layout
27675 \begin_inset Quotes eld
27678 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
27679 you'll find my little bookshop at the corner of Church Street, and very
27680 happy to see you, I am sure.
27681 Maybe you collect yourself, sir.
27685 \begin_inset space ~
27698 –a bargain, every one of them.
27699 With five volumes you could just fill that gap on that second shelf.
27700 It looks untidy, does it not, sir?
27701 \begin_inset Quotes erd
27712 \begin_layout Standard
27713 \begin_inset VSpace defskip
27719 \begin_layout Standard
27720 The rule can be colored by redefining the command
27721 \change_deleted -712698321 1501235439
27725 \change_inserted -712698321 1501235439
27727 \begin_inset Flex Code
27730 \begin_layout Plain Layout
27732 \change_inserted -712698321 1501235439
27745 This is done by inserting the command
27746 \change_deleted -712698321 1501235443
27748 \begin_inset Newline newline
27752 \change_inserted -712698321 1501235444
27756 \begin_layout LyX-Code
27761 columnseprulecolor}{
27764 \change_deleted -712698321 1501235445
27766 \begin_inset Newline newline
27770 \change_inserted -712698321 1501235446
27774 \begin_layout Standard
27775 as \SpecialChar TeX
27776 Code before the multicolumn inset.
27778 \change_deleted -712698321 1501235460
27780 \change_inserted -712698321 1501235457
27782 \begin_inset Flex Code
27785 \begin_layout Plain Layout
27787 \change_inserted -712698321 1501235462
27797 in this command by a color of your choice.
27798 You can use all pre- and self-defined colors.
27806 \begin_inset space ~
27811 for more information about pre- and self-defined colors.
27812 To go back to the default color insert the command
27813 \change_inserted -712698321 1501235474
27817 \begin_layout LyX-Code
27819 \change_deleted -712698321 1501235472
27820 \begin_inset Newline newline
27829 columnseprulecolor}{
27832 \change_inserted -712698321 1501235475
27836 \begin_layout Standard
27838 \change_deleted -712698321 1501235473
27839 \begin_inset Newline newline
27844 Here is the example with a cyan rule and 1
27845 \begin_inset space \thinspace{}
27848 cm column separation:
27851 \begin_layout Standard
27855 \begin_layout Plain Layout
27864 \begin_layout Plain Layout
27870 columnseprulecolor}{
27880 \begin_layout Standard
27881 \begin_inset Flex Multiple Columns
27884 \begin_layout Plain Layout
27887 \begin_inset Quotes eld
27890 You're surprised to see me, sir,
27891 \begin_inset Quotes erd
27894 said he, in a strange, croaking voice.
27897 \begin_layout Plain Layout
27900 I acknowledged that I was.
27903 \begin_layout Plain Layout
27906 \begin_inset Quotes eld
27909 Well, I've a conscience, sir, and when I chanced to see you go into this
27910 house, as I came hobbling after you, I thought to myself, I'll just step
27911 in and see that kind gentleman, and tell him that if I was a bit gruff
27912 in my manner there was not any harm meant, and that I am much obliged to
27913 him for picking up my books.
27914 \begin_inset Quotes erd
27920 \begin_layout Plain Layout
27923 \begin_inset Quotes eld
27926 You make too much of a trifle,
27927 \begin_inset Quotes erd
27932 \begin_inset Quotes eld
27935 May I ask how you knew who I was?
27936 \begin_inset Quotes erd
27942 \begin_layout Plain Layout
27945 \begin_inset Quotes eld
27948 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
27949 you'll find my little bookshop at the corner of Church Street, and very
27950 happy to see you, I am sure.
27951 Maybe you collect yourself, sir.
27955 \begin_inset space ~
27968 –a bargain, every one of them.
27969 With five volumes you could just fill that gap on that second shelf.
27970 It looks untidy, does it not, sir?
27971 \begin_inset Quotes erd
27982 \begin_layout Standard
27986 \begin_layout Plain Layout
27992 columnseprule}{0pt}
27995 \begin_layout Plain Layout
28001 columnseprulecolor}{
28009 \begin_inset Note Note
28012 \begin_layout Plain Layout
28013 go back to the default
28021 \begin_layout Section
28022 Non-standard Paragraph Shapes
28025 \begin_layout Standard
28028 as well as any other text processor uses by default rectangular paragraphs.
28029 For special cases like for example posters, invitation cards or poems you
28030 can modify the paragraph shape to one of your choice.
28031 This can be done by using the \SpecialChar LaTeX
28033 \change_deleted -712698321 1501236703
28035 \change_inserted -712698321 1501236703
28037 \begin_inset Flex Code
28040 \begin_layout Plain Layout
28043 \change_inserted -712698321 1501236703
28053 which is loaded by using in the document settings the module
28055 Custom paragraph shapes
28060 \begin_layout Subsection
28064 \begin_layout Standard
28069 provides the following shapes:
28072 \begin_layout Standard
28073 \begin_inset Tabular
28074 <lyxtabular version="3" rows="13" columns="3">
28075 <features booktabs="true" islongtable="true" longtabularalignment="center">
28076 <column alignment="left" valignment="middle" width="16col%">
28077 <column alignment="left" valignment="middle" width="40col%">
28078 <column alignment="left" valignment="middle" width="35col%">
28079 <row endhead="true">
28080 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
28083 \begin_layout Plain Layout
28092 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
28095 \begin_layout Plain Layout
28104 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
28107 \begin_layout Plain Layout
28117 <row interlinespace="default">
28118 <cell alignment="left" valignment="top" usebox="none">
28121 \begin_layout Plain Layout
28129 <cell alignment="left" valignment="top" usebox="none">
28132 \begin_layout Plain Layout
28135 Circle with circular hole (in the size of a CD/DVD)
28140 <cell alignment="left" valignment="top" usebox="none">
28143 \begin_layout Plain Layout
28146 Cannot be scaled, take care there is not too much text
28152 <row interlinespace="default">
28153 <cell alignment="left" valignment="top" usebox="none">
28156 \begin_layout Plain Layout
28164 <cell alignment="left" valignment="top" usebox="none">
28167 \begin_layout Plain Layout
28175 <cell alignment="left" valignment="top" usebox="none">
28178 \begin_layout Plain Layout
28181 Fragile, calculation might fail
28187 <row interlinespace="default">
28188 <cell alignment="left" valignment="top" usebox="none">
28191 \begin_layout Plain Layout
28199 <cell alignment="left" valignment="top" usebox="none">
28202 \begin_layout Plain Layout
28205 Rhomboid (symbolizing a
28206 \begin_inset Quotes eld
28210 \begin_inset Quotes erd
28218 <cell alignment="left" valignment="top" usebox="none">
28221 \begin_layout Plain Layout
28230 <row interlinespace="default">
28231 <cell alignment="left" valignment="top" usebox="none">
28234 \begin_layout Plain Layout
28242 <cell alignment="left" valignment="top" usebox="none">
28245 \begin_layout Plain Layout
28253 <cell alignment="left" valignment="top" usebox="none">
28256 \begin_layout Plain Layout
28265 <row interlinespace="default">
28266 <cell alignment="left" valignment="top" usebox="none">
28269 \begin_layout Plain Layout
28277 <cell alignment="left" valignment="top" usebox="none">
28280 \begin_layout Plain Layout
28288 <cell alignment="left" valignment="top" usebox="none">
28291 \begin_layout Plain Layout
28300 <row interlinespace="default">
28301 <cell alignment="left" valignment="top" usebox="none">
28304 \begin_layout Plain Layout
28312 <cell alignment="left" valignment="top" usebox="none">
28315 \begin_layout Plain Layout
28318 Nut for bolt (hexagon with circular hole)
28323 <cell alignment="left" valignment="top" usebox="none">
28326 \begin_layout Plain Layout
28335 <row interlinespace="default">
28336 <cell alignment="left" valignment="top" usebox="none">
28339 \begin_layout Plain Layout
28347 <cell alignment="left" valignment="top" usebox="none">
28350 \begin_layout Plain Layout
28358 <cell alignment="left" valignment="top" usebox="none">
28361 \begin_layout Plain Layout
28370 <row interlinespace="default">
28371 <cell alignment="left" valignment="top" usebox="none">
28374 \begin_layout Plain Layout
28382 <cell alignment="left" valignment="top" usebox="none">
28385 \begin_layout Plain Layout
28393 <cell alignment="left" valignment="top" usebox="none">
28396 \begin_layout Plain Layout
28405 <row interlinespace="default">
28406 <cell alignment="left" valignment="top" usebox="none">
28409 \begin_layout Plain Layout
28417 <cell alignment="left" valignment="top" usebox="none">
28420 \begin_layout Plain Layout
28428 <cell alignment="left" valignment="top" usebox="none">
28431 \begin_layout Plain Layout
28440 <row interlinespace="default">
28441 <cell alignment="left" valignment="top" usebox="none">
28444 \begin_layout Plain Layout
28452 <cell alignment="left" valignment="top" usebox="none">
28455 \begin_layout Plain Layout
28458 Normal/reversed rain drop
28463 <cell alignment="left" valignment="top" usebox="none">
28466 \begin_layout Plain Layout
28469 Fragile, calculation might fail
28475 <row interlinespace="default">
28476 <cell alignment="left" valignment="top" usebox="none">
28479 \begin_layout Plain Layout
28488 <cell alignment="left" valignment="top" usebox="none">
28491 \begin_layout Plain Layout
28494 The \SpecialChar TeX
28500 <cell alignment="left" valignment="top" usebox="none">
28503 \begin_layout Plain Layout
28512 <row interlinespace="default">
28513 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
28516 \begin_layout Plain Layout
28520 \begin_inset Newline newline
28528 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
28531 \begin_layout Plain Layout
28534 Triangles in different orientations
28539 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
28542 \begin_layout Plain Layout
28558 \begin_layout Standard
28559 To use a shape for your paragraph, simply select it in \SpecialChar LyX
28561 for environments in the toolbar.
28564 \begin_layout Standard
28565 \begin_inset Newpage newpage
28571 \begin_layout Standard
28572 Here is an example paragraph in the shape of a nut:
28575 \begin_layout Standard
28576 \begin_inset VSpace bigskip
28585 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28586 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28588 At vero eos et accusam et justo duo dolores et ea rebum.
28589 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28591 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28592 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28596 \begin_layout Standard
28597 \begin_inset VSpace bigskip
28603 \begin_layout Standard
28604 \begin_inset Note Greyedout
28607 \begin_layout Plain Layout
28616 paragraphs cannot run over a page break.
28624 \begin_layout Standard
28625 \begin_inset VSpace bigskip
28631 \begin_layout Standard
28633 \change_inserted -712698321 1501236716
28635 \change_deleted -712698321 1501236722
28637 \change_inserted -712698321 1501236723
28639 \begin_inset Flex Code
28642 \begin_layout Plain Layout
28644 \change_inserted -712698321 1501236723
28654 takes care that the shape will always be preserved, no matter how much
28655 text is in the paragraph.
28656 Therefore the paragraph size changes with the amount of contained text.
28657 This can lead to paragraph sizes exceeding the page margins.
28658 To demonstrate the size scaling, here is the same example paragraph but
28659 with twice as much text:
28662 \begin_layout Standard
28663 \begin_inset Newpage newpage
28672 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28673 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28675 At vero eos et accusam et justo duo dolores et ea rebum.
28676 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28678 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28679 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28681 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28682 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28684 At vero eos et accusam et justo duo dolores et ea rebum.
28685 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28687 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28688 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28692 \begin_layout Standard
28693 \begin_inset VSpace bigskip
28699 \begin_layout Standard
28700 An exception is the shape
28705 It cannot be scaled because it must fit the size of a CD/DVD.
28706 Therefore the amount of text that fits into the shape is limited.
28707 \begin_inset Newline newline
28718 shape are fragile, meaning that the calculation of their size can fail,
28719 depending on the amount of text.
28720 You will then get the \SpecialChar LaTeX
28722 \begin_inset Quotes eld
28725 Arithmetic overflow
28726 \begin_inset Quotes erd
28730 In this case one can try to remove or add some text; if nothing works one
28731 has to use another shape.
28734 \begin_layout Standard
28735 \begin_inset VSpace bigskip
28741 \begin_layout Standard
28742 For shapes with tips you will maybe see that \SpecialChar LaTeX
28743 's hyphenation routine fails
28744 for text in the tips.
28745 Therefore it is often necessary to add hyphenation points
28750 arg "specialchar-insert hyphenation"
28755 ) to the corresponding text parts.
28758 \begin_layout Standard
28759 \begin_inset VSpace bigskip
28765 \begin_layout Standard
28766 Shapepar paragraphs are either always centered or placed on the page so
28767 that their left border touches the left page margin.
28768 You can therefore not use the paragraph dialog to align such paragraphs.
28769 A solution is to put the paragraph into a minipage or parbox and align
28771 The problem is hereby to find the right width for the box.
28772 Because if it is too wide and you center the box, the paragraph is not
28773 centered too because it sticks at the left side of the box.
28774 So you might have to play a bit with the width until it fits.
28775 Here are two heart-shaped paragraphs, the first one is not aligned, the
28776 second one is right-aligned:
28779 \begin_layout Standard
28780 \begin_inset Newpage newpage
28786 \begin_layout Heart
28790 Lo\SpecialChar softhyphen
28791 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28792 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28794 At vero eos et accusam et justo duo dolores et ea rebum.
28795 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28799 \begin_layout Standard
28800 \begin_inset VSpace bigskip
28806 \begin_layout Standard
28809 \begin_inset Box Frameless
28819 height_special "totalheight"
28824 backgroundcolor "none"
28827 \begin_layout Heart
28831 Lo\SpecialChar softhyphen
28832 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28833 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28835 At vero eos et accusam et justo duo dolores et ea rebum.
28836 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28845 \begin_layout Subsection
28849 \begin_layout Standard
28850 You can define any shape you want.
28851 Doing this manually is a lot of work because every coordinate must be specified.
28852 But there is a way to let the computer calculate the coordinates:
28855 \begin_layout Enumerate
28856 Install the program
28857 \begin_inset CommandInset href
28860 target "http://www.ctan.org/tex-archive/graphics/jpgfdraw"
28868 \begin_layout Enumerate
28875 TeX/LaTeX\SpecialChar menuseparator
28876 Settings\SpecialChar menuseparator
28879 and select the font size you are using in your document.
28880 For example this document uses the size 12
28881 \begin_inset space \thinspace{}
28887 \begin_layout Enumerate
28891 \begin_layout Enumerate
28894 TeX/LaTeX\SpecialChar menuseparator
28897 to export the shape to coordinates.
28898 In the appearing dialog use either the outline of your shape for the coordinate
28899 s or the path itself.
28903 \begin_layout Plain Layout
28904 For more information see
28905 \begin_inset CommandInset href
28907 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
28920 \begin_layout Standard
28921 The coordinates are written into a \SpecialChar TeX
28923 To use it for your \SpecialChar LyX
28927 \begin_layout Enumerate
28928 Place the cursor before the first character of your paragraph (or into a
28932 \begin_layout Enumerate
28933 Open in \SpecialChar LyX
28936 Insert\SpecialChar menuseparator
28937 File\SpecialChar menuseparator
28939 \begin_inset space ~
28944 , select the file and use
28953 \begin_layout Standard
28954 \begin_inset VSpace defskip
28960 \begin_layout Standard
28961 \begin_inset Note Greyedout
28964 \begin_layout Plain Layout
28969 : The changed shape only applies to the current paragraph; everything is
28970 reset to normal for the next paragraph.
28971 Therefore the shape definition file must be input into every paragraph
28972 with the desired shape.
28980 \begin_layout Standard
28981 \begin_inset VSpace bigskip
28987 \begin_layout Standard
28988 Here is an example:
28991 \begin_layout Standard
28992 \begin_inset VSpace bigskip
28998 \begin_layout Standard
28999 \begin_inset CommandInset include
29001 filename "SpecialParagraphShape.tex"
29007 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
29008 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
29010 At vero eos et accusam et justo duo dolores et ea rebum.
29011 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
29013 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
29014 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
29018 \begin_layout Standard
29019 \begin_inset VSpace bigskip
29025 \begin_layout Standard
29030 to draw complexer shapes in
29034 you can draw the shape in a program of your choice and import the resulting
29040 Then you only need to draw a line or spline along the outline of the image.
29043 \begin_layout Standard
29044 \begin_inset VSpace bigskip
29050 \begin_layout Standard
29053 Custom paragraph shapes
29055 also provides the two commands
29063 which can be used to define custom shapes coordinate by coordinate.
29067 \begin_layout Plain Layout
29068 These commands are internally used for all shapes described here.
29073 For information how these styles are used and about further customization
29074 possibilities, have a look at the
29075 \change_inserted -712698321 1501236534
29079 \begin_inset CommandInset href
29081 name "documentation"
29082 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"
29088 \change_deleted -712698321 1501236537
29094 \change_deleted -712698321 1501236618
29096 \change_inserted -712698321 1501236618
29098 \begin_inset Flex Code
29101 \begin_layout Plain Layout
29103 \change_inserted -712698321 1501236618
29112 \change_deleted -712698321 1501236618
29114 \begin_inset CommandInset citation
29124 \change_deleted -712698321 1501236666
29128 \begin_layout Bibliography
29130 \change_deleted -712698321 1501236522
29131 \begin_inset CommandInset bibitem
29132 LatexCommand bibitem
29138 Documentation of the \SpecialChar LaTeX
29140 \begin_inset CommandInset href
29143 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
29151 \begin_layout Bibliography
29153 \change_deleted -712698321 1501236522
29154 \begin_inset CommandInset bibitem
29155 LatexCommand bibitem
29161 Documentation of the \SpecialChar LaTeX
29163 \begin_inset CommandInset href
29166 target "http://mirrors.ctan.org/macros/latex/contrib/shapepar/shapepar.pdf"