1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
41 \maintain_unincluded_children no
43 \language_package default
46 \font_roman "lmodern" "default"
47 \font_sans "lmss" "default"
48 \font_typewriter "lmtt" "default"
49 \font_math "auto" "auto"
50 \font_default_family default
51 \use_non_tex_fonts false
55 \font_typewriter_osf false
56 \font_sf_scale 100 100
57 \font_tt_scale 100 100
59 \use_dash_ligatures true
61 \default_output_format pdf2
63 \bibtex_command default
64 \index_command default
65 \float_placement class
66 \float_alignment class
70 \pdf_title "LyX's Additional Features manual"
71 \pdf_author "LyX Team"
72 \pdf_subject "LyX's additional features documentation"
73 \pdf_keywords "LyX, Documentation, Additional"
75 \pdf_bookmarksnumbered true
76 \pdf_bookmarksopen false
77 \pdf_bookmarksopenlevel 1
82 \pdf_pdfusetitle false
83 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
86 \use_package amsmath 1
87 \use_package amssymb 1
90 \use_package mathdots 1
91 \use_package mathtools 1
93 \use_package stackrel 1
94 \use_package stmaryrd 1
95 \use_package undertilde 1
97 \cite_engine_type default
101 \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
125 \tracking_changes true
126 \output_changes false
128 \postpone_fragile_content false
132 \docbook_table_output 0
133 \docbook_mathml_prefix 1
134 \author -712698321 "Jürgen Spitzmüller"
137 \author 244031559 "Yuriy"
138 \author 564990737 "John Lyx"
139 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
140 \author 1075283030 "Thibaut"
141 \author 1119979965 "Joel A. Kulesza"
147 Additional \SpecialChar LyX
151 \begin_layout Subtitle
153 \change_deleted 630872221 1622909155
155 \change_inserted 630872221 1622909155
162 by the \SpecialChar LyX
167 \begin_layout Plain Layout
169 Principal maintainer of this file is
171 Richard Kimberly Heck
174 If you have comments or error corrections, please send them to the \SpecialChar LyX
177 \begin_inset Flex Code
180 \begin_layout Plain Layout
181 <lyx-docs@lists.lyx.org>
194 \begin_layout Standard
195 \begin_inset CommandInset toc
196 LatexCommand tableofcontents
203 \begin_layout Chapter
207 \begin_layout Standard
208 This manual is essentially Part II of the
210 User's Guide\SpecialChar endofsentence
213 The reason for separating the two documents is simple: the
217 is already quite lengthy, and it contains information on all of the basic
218 features one needs to know in order to prepare most documents.
219 However, the \SpecialChar LyX
220 Team has worked to make \SpecialChar LyX
221 extensible through various configuration
222 files and external packages.
223 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
225 create a layout file (or module) for it without having to alter \SpecialChar LyX
227 We've already had contributions of several new features this way, and some
228 of them are documented here.
229 There are also some more `advanced' features, such as how to control the
230 presentation of bibliographies and how to work with multi-part documents,
231 that are not covered in the
235 and are discussed here.
238 \begin_layout Standard
239 This manual also documents some special features, like fax support
240 \change_deleted 244031559 1603802929
242 \change_inserted 244031559 1603802931
246 \change_deleted 244031559 1603802954
249 , which require additional software to work properly.
250 There is also a chapter on \SpecialChar LyX
252 And lastly, there's a chapter of \SpecialChar LaTeX
253 tools and tips, things you can use to
254 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
256 After all, \SpecialChar LyX
261 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
265 \begin_layout Standard
266 If you haven't read the
270 yet, you are definitely in the wrong manual.
275 is the first place to go, since it describes the notation and format of
277 You should also be thoroughly familiar with the
281 and all of the basic features of \SpecialChar LyX
282 before attempting to read this one.
285 \begin_layout Standard
286 Since many of the topics in this manual depend heavily on \SpecialChar LyX
288 with \SpecialChar LaTeX
289 , this first chapter covers the inner workings of \SpecialChar LyX
292 to generate exactly the \SpecialChar LaTeX
294 It is obviously for more seasoned \SpecialChar LyX
298 \begin_layout Chapter
300 and \SpecialChar LaTeX
304 \begin_layout Section
306 Uses \SpecialChar LaTeX
310 \begin_layout Standard
311 This chapter is for both \SpecialChar TeX
312 -nicians and the \SpecialChar LaTeX
314 In it, we'll explain how \SpecialChar LyX
315 and \SpecialChar LaTeX
316 work together to produce printable output.
317 This is the only place in any of the manuals where we assume you know something
318 about \SpecialChar LaTeX
322 \begin_layout Standard
323 At one time, \SpecialChar LyX
325 \begin_inset Quotes eld
328 WYSIWYM frontend to \SpecialChar LaTeX
330 \begin_inset Quotes erd
333 but that's no longer true.
334 There are frontends to \SpecialChar LaTeX
339 \begin_layout Plain Layout
340 Some familar ones are \SpecialChar TeX
341 maker and kile, on Linux, and \SpecialChar TeX
343 There are also the \SpecialChar LaTeX
344 modes for vi and emacs, of course.
349 These are basically text editors with the ability to run \SpecialChar LaTeX
351 errors in the file you're editing.
352 Although \SpecialChar LyX
361 run \SpecialChar LaTeX
362 , and it also indicates errors in the file, it also does much, much
364 For one thing, you don't need to know \SpecialChar LaTeX
365 to use \SpecialChar LyX
368 has added its own extensions to \SpecialChar LaTeX
370 Try the following sometime: select
371 \begin_inset Flex Noun
374 \begin_layout Plain Layout
375 Export\SpecialChar menuseparator
382 \begin_inset Flex Noun
385 \begin_layout Plain Layout
392 \begin_inset Flex Noun
395 \begin_layout Plain Layout
396 View\SpecialChar menuseparator
406 ), then look at the preamble of the resulting
407 \begin_inset Flex Code
410 \begin_layout Plain Layout
417 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
419 These macros are defined automatically, according to the features you use
423 \begin_layout Standard
424 There are several commands that automatically invoke \SpecialChar LaTeX
429 \begin_layout Itemize
430 \begin_inset Flex Noun
433 \begin_layout Plain Layout
434 Document\SpecialChar menuseparator
443 \begin_layout Itemize
444 \begin_inset Flex Noun
447 \begin_layout Plain Layout
448 Document\SpecialChar menuseparator
457 \begin_layout Standard
458 They will only invoke \SpecialChar LaTeX
459 if the file has changed since the last time \SpecialChar LaTeX
465 \begin_layout Standard
466 When \SpecialChar LyX
467 runs \SpecialChar LaTeX
468 on the file you're editing, it performs these steps:
471 \begin_layout Enumerate
472 Convert the document to \SpecialChar LaTeX
473 and save to a file with the extension
474 \begin_inset Flex Code
477 \begin_layout Plain Layout
484 \begin_inset Flex Code
487 \begin_layout Plain Layout
496 \begin_layout Enumerate
497 Run \SpecialChar LaTeX
499 \begin_inset Flex Code
502 \begin_layout Plain Layout
508 file (maybe several times), and run any other commands (such as
509 \begin_inset Flex Code
512 \begin_layout Plain Layout
519 \begin_inset Flex Code
522 \begin_layout Plain Layout
528 ) needed to compile the \SpecialChar LaTeX
532 \begin_layout Enumerate
533 If there are any errors, show the error log.
536 \begin_layout Standard
537 If you have run \SpecialChar LaTeX
539 \begin_inset Flex Noun
542 \begin_layout Plain Layout
543 View\SpecialChar menuseparator
550 then runs a DVI viewer to display the DVI-file.
552 \begin_inset Flex Noun
555 \begin_layout Plain Layout
556 View\SpecialChar menuseparator
563 performs further steps:
566 \begin_layout Enumerate
568 \begin_inset Flex Code
571 \begin_layout Plain Layout
577 to convert the DVI file to PostScript.
580 \begin_layout Enumerate
581 Run a PostScript viewer, such as
582 \begin_inset Flex Code
585 \begin_layout Plain Layout
591 , to display the PostScript file.
594 \begin_layout Standard
596 does similar things when viewing, or exporting, other formats.
599 \begin_layout Section
600 Translating \SpecialChar LaTeX
601 files into \SpecialChar LyX
605 \begin_layout Standard
606 You can import a \SpecialChar LaTeX
607 file into \SpecialChar LyX
609 \begin_inset Flex Noun
612 \begin_layout Plain Layout
613 File\SpecialChar menuseparator
614 Import\SpecialChar menuseparator
620 command in \SpecialChar LyX
622 This will call a program named
623 \begin_inset Flex Code
626 \begin_layout Plain Layout
632 which will create a file
633 \begin_inset Flex Code
636 \begin_layout Plain Layout
643 \begin_inset Flex Code
646 \begin_layout Plain Layout
654 will then open that file.
658 \begin_layout Plain Layout
659 \begin_inset Flex Code
662 \begin_layout Plain Layout
668 can also be run from the command line, of course.
676 \begin_layout Standard
677 \begin_inset Flex Code
680 \begin_layout Plain Layout
686 will translate most legal \SpecialChar LaTeX
687 , but not everything.
688 It will put things it doesn't understand into \SpecialChar TeX
689 code, so after translating
691 \begin_inset Flex Code
694 \begin_layout Plain Layout
700 , you can look for \SpecialChar TeX
701 code and hand-edit it until it looks right.
704 \begin_layout Standard
705 If you don't know what \SpecialChar TeX
706 code is, read the next section.
709 \begin_layout Section
710 \begin_inset CommandInset label
712 name "sec:Inserting-TeX-Code"
716 Inserting \SpecialChar TeX
717 Code into \SpecialChar LyX
721 \begin_layout Standard
722 Anything you can do in \SpecialChar LaTeX
723 you can do in \SpecialChar LyX
724 , for a very simple reason: You can
725 always insert \SpecialChar TeX
726 code into any \SpecialChar LyX
729 cannot, and will never be able to, display every possible \SpecialChar LaTeX
731 If ever you need to insert \SpecialChar LaTeX
732 commands into your \SpecialChar LyX
733 document, you can use the
735 \begin_inset Flex Code
738 \begin_layout Plain Layout
745 box, which you can insert into your document with
746 \begin_inset Flex Noun
749 \begin_layout Plain Layout
750 Insert\SpecialChar menuseparator
760 or the keyboard shortcut
769 \begin_layout Standard
770 Here's an example of inserting \SpecialChar LaTeX
771 commands in a \SpecialChar LyX
773 The code looks like this:
776 \begin_layout LyX-Code
780 \begin_inset Newline newline
786 \begin_inset Newline newline
789 This is an example of a minipage environment.
791 \begin_inset Newline newline
794 can put nearly everything in it, even (non-floating)
795 \begin_inset Newline newline
800 \begin_inset Newline newline
806 \begin_inset Newline newline
810 \begin_inset Newline newline
816 \begin_inset Newline newline
822 \begin_inset Newline newline
828 \begin_inset Newline newline
833 \begin_inset Newline newline
839 \begin_inset Newline newline
845 \begin_inset Newline newline
851 \begin_inset Newline newline
859 \begin_layout LyX-Code
863 \begin_layout Standard
865 \begin_inset Flex Code
868 \begin_layout Plain Layout
875 box containing this text is directly after this paragraph.
876 Those of you reading the manual in \SpecialChar LyX
877 will only see the \SpecialChar TeX
879 Those reading a printed version of the manuals will see the actual results:
880 \begin_inset VSpace bigskip
886 \begin_layout Standard
890 \begin_layout Plain Layout
897 \begin_layout Plain Layout
904 \begin_layout Plain Layout
906 This is an example of a minipage environment.
907 You can put nearly everything in it, even (non-floating) figures and tables.
911 \begin_layout Plain Layout
918 \begin_layout Plain Layout
923 \begin_layout Plain Layout
930 \begin_layout Plain Layout
937 \begin_layout Plain Layout
944 \begin_layout Plain Layout
950 \begin_layout Plain Layout
957 \begin_layout Plain Layout
964 \begin_layout Plain Layout
971 \begin_layout Plain Layout
981 \begin_inset VSpace bigskip
987 \begin_layout Standard
988 In addition to using \SpecialChar TeX
989 code, you can also create a separate file containing
990 some complex \SpecialChar LaTeX
991 structure and then use
992 \begin_inset Flex Noun
995 \begin_layout Plain Layout
996 Insert\SpecialChar menuseparator
1006 to include your file (you should select the type
1007 \begin_inset Flex Code
1010 \begin_layout Plain Layout
1017 We recommend that you only do this if you have a
1018 \begin_inset Flex Code
1021 \begin_layout Plain Layout
1032 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1036 \begin_layout Standard
1037 There are a few last points to emphasize:
1040 \begin_layout Itemize
1046 check if your \SpecialChar LaTeX
1050 \begin_layout Itemize
1051 Beware of reinventing the wheel.
1054 \begin_layout Standard
1055 On that last point, \SpecialChar LyX
1056 does have quite a few features tucked into it, and
1058 Be sure to check the manuals to make sure that \SpecialChar LyX
1059 doesn't have such-and-such
1060 feature before you decide you have to do it by hand.
1061 Moreover, there are numerous \SpecialChar LaTeX
1062 packages out there to do all sorts of things,
1063 from labels to envelopes to fancy multipage tables.
1065 \change_inserted 244031559 1603815732
1067 \begin_inset CommandInset href
1070 target "https://www.ctan.org/"
1076 \change_deleted 244031559 1603815732
1078 \begin_inset CommandInset href
1081 target "http://www.ctan.org/"
1091 \begin_layout Standard
1092 If you do need to do some wild and fancy things within your document, be
1093 sure to check out a good \SpecialChar LaTeX
1094 book for assistance.
1095 There are a number of them listed in the bibliography of the
1102 \begin_layout Section
1104 and the \SpecialChar LaTeX
1108 \begin_layout Subsection
1109 About the \SpecialChar LaTeX
1113 \begin_layout Standard
1114 If you already know \SpecialChar LaTeX
1115 , there is no need to explain here what the preamble
1117 If you don't, the following will give you some ideas—we recommend again
1118 that you consult a \SpecialChar LaTeX
1119 book for further information.
1120 In any case, you should read the points below, because they explain what
1121 you can do and what you don't need to do in the \SpecialChar LaTeX
1122 preamble of a \SpecialChar LyX
1126 \begin_layout Standard
1127 The \SpecialChar LaTeX
1128 preamble comes at the very beginning of a document,
1136 \begin_layout Itemize
1137 Declare the document class.
1139 \begin_inset Newline newline
1143 already does this for you.
1144 If you're a seasoned \SpecialChar LaTeX
1145 -nician, and you have a custom document class you
1146 want to use, check out the
1148 Customization Manual
1150 for information on how to make \SpecialChar LyX
1154 \begin_layout Itemize
1155 Declare the usage of packages.
1157 \begin_inset Newline newline
1161 packages provide special commands, which are only available within a document
1162 when the package has been declared in the preamble.
1163 In addition to providing special commands, the inclusion of a package can
1164 change the document.
1165 For example, the package
1166 \begin_inset Flex Code
1169 \begin_layout Plain Layout
1175 forces all paragraphs to be indented.
1176 There are other packages for labels, envelopes, margins, etc.
1180 \begin_layout Itemize
1181 Set counters, variables, lengths and widths.
1183 \begin_inset Newline newline
1186 There are several \SpecialChar LaTeX
1187 counters and variables that
1191 be set globally from within the preamble in order to have the desired effect.
1192 (There are variables that you can set and reset inside the document, too.)
1193 Margins are a good example of something that must be set in the preamble.
1194 Another example is the label format for lists.
1195 You can actually set these just about anywhere, but it's best to do it
1196 just once, inside the preamble.
1199 \begin_layout Itemize
1200 Declare user defined commands (with
1201 \begin_inset Flex Code
1204 \begin_layout Plain Layout
1213 \begin_inset Flex Code
1216 \begin_layout Plain Layout
1225 \begin_inset Newline newline
1228 These are abbreviations for \SpecialChar LaTeX
1229 commands which appear very often inside a document.
1230 Although the preamble is a good place to declare such commands, they
1234 be declared anywhere (before they are used for the first time, of course).
1235 This can be useful if there is a lot of raw \SpecialChar LaTeX
1236 code in your document, which
1237 normally should not be the case.
1240 \begin_layout Standard
1242 adds its own set of definitions to the preamble of the
1243 \begin_inset Flex Code
1246 \begin_layout Plain Layout
1253 This makes \SpecialChar LaTeX
1254 files generated by \SpecialChar LyX
1258 \begin_layout Subsection
1259 Changing the Preamble
1262 \begin_layout Standard
1263 The commands which \SpecialChar LyX
1264 adds to the preamble of a \SpecialChar LaTeX
1265 file are fixed; you can't
1266 change them without patching \SpecialChar LyX
1268 You can, however, add your own stuff to the preamble by selecting
1269 \begin_inset Flex Noun
1272 \begin_layout Plain Layout
1275 \begin_inset space ~
1284 \begin_inset Flex Noun
1287 \begin_layout Plain Layout
1288 Document\SpecialChar menuseparator
1296 adds anything in the
1297 \begin_inset Flex Noun
1300 \begin_layout Plain Layout
1306 dialog to its own built-in preamble.
1307 Before adding your own declarations in the preamble, you should make sure
1308 that \SpecialChar LyX
1309 doesn't already support what you want to do.
1310 (Remember what we said about reinventing the wheel?) Also,
1312 make sure your preamble code is correct
1316 doesn't check it for you.
1317 If there is an error, you're likely to get an error like
1318 \begin_inset Quotes eld
1322 \begin_inset Flex Code
1325 \begin_layout Plain Layout
1334 \begin_inset Quotes erd
1338 If you see this error, check your preamble.
1341 \begin_layout Subsection
1345 \begin_layout Standard
1346 Here are some examples of what you can add to a preamble, and what they
1350 \begin_layout Subsubsection
1354 \begin_layout Standard
1355 There are two variables under \SpecialChar LaTeX
1356 that control page position:
1357 \begin_inset Flex Code
1360 \begin_layout Plain Layout
1369 \begin_inset Flex Code
1372 \begin_layout Plain Layout
1381 Their names should be self-explanatory.
1382 These variables are useful if you think for a moment about computer labels.
1383 Sometimes, the size of a print medium and the area of the medium that you
1384 can actually print on aren't the same.
1386 \begin_inset Flex Code
1389 \begin_layout Plain Layout
1398 \begin_inset Flex Code
1401 \begin_layout Plain Layout
1412 \begin_layout Standard
1413 The default values for
1414 \begin_inset Flex Code
1417 \begin_layout Plain Layout
1426 \begin_inset Flex Code
1429 \begin_layout Plain Layout
1438 \begin_inset space \thinspace{}
1442 \begin_inset space \thinspace{}
1446 \begin_inset space \space{}
1449 the page isn't shifted.
1450 Unfortunately, some DVI drivers always seem to shift the page.
1451 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1452 If you're using \SpecialChar LyX
1453 on a system that you don't personally maintain, and your
1454 sysadmin is a doofus,
1455 \begin_inset Flex Code
1458 \begin_layout Plain Layout
1467 \begin_inset Flex Code
1470 \begin_layout Plain Layout
1479 Suppose your left and top margins are always 0.5
1480 \begin_inset space \thinspace{}
1484 You can add this to the preamble:
1487 \begin_layout LyX-Code
1495 \begin_layout LyX-Code
1503 \begin_layout Standard
1504 and your margins should now be correct.
1507 \begin_layout Subsubsection
1511 \begin_layout Standard
1512 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1513 There's a rather nice package, available at your nearest CTAN archive,
1514 for printing sheets of labels:
1515 \begin_inset Flex Code
1518 \begin_layout Plain Layout
1525 Now, your system may not have this package installed by default.
1526 We leave that up to you to check.
1527 You'll also want to read the documentation for it; we're not going to do
1529 Since this is an example, however, we'll give you an example of how you
1533 \begin_layout Standard
1534 First, make sure you're using the
1535 \begin_inset Flex Code
1538 \begin_layout Plain Layout
1545 Next, you need to put the following in your preamble:
1548 \begin_layout LyX-Code
1554 \begin_layout LyX-Code
1560 \begin_layout LyX-Code
1566 \begin_layout LyX-Code
1572 \begin_layout LyX-Code
1578 \begin_layout LyX-Code
1584 \begin_layout LyX-Code
1590 \begin_layout Standard
1591 This sets things up for Avery label sheets, stock #5360.
1592 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1595 \begin_inset Flex Code
1598 \begin_layout Plain Layout
1607 \begin_inset Flex Code
1610 \begin_layout Plain Layout
1618 around each label text.
1619 This and other special features of
1620 \begin_inset Flex Code
1623 \begin_layout Plain Layout
1629 are explained in its documentation.
1632 \begin_layout Standard
1633 Someday, someone may write a \SpecialChar LyX
1634 layout file to support this package directly.
1635 Maybe that someone is you.
1638 \begin_layout Subsubsection
1639 Example #3: Paragraph Indentation
1642 \begin_layout Standard
1643 Americans are trained to indent the first line of
1648 As with all of their other weird quirks, most Americans will whine and
1649 moan until they can have their way and indent the first line of all paragraphs.
1658 \begin_layout Standard
1659 Of course, this behavior isn't standard typography.
1660 In books, you typically only indent the first line of a paragraph
1664 it follows another one.
1665 The idea behind indenting the first line of a paragraph is to distinguish
1666 neighboring paragraphs from one another.
1667 If there is no previous paragraph—for example, if it follows a figure or
1668 is the first paragraph in a section—then there is no need for indentation.
1672 \begin_layout Standard
1673 If you're a typical American (we're still joking!), though, you don't care
1674 about such esoteric things; you want your indentation! Add this to the
1678 \begin_layout LyX-Code
1681 usepackage{indentfirst}
1684 \begin_layout Standard
1685 If your \SpecialChar TeX
1686 distribution isn't braindead, you'll have this package, and all
1687 of your paragraphs will get the indentation the Founding Fathers intended
1691 \begin_layout Subsubsection
1692 Example #4: This Document
1695 \begin_layout Standard
1696 You can also check out the preamble of this document to get an idea of some
1697 of the advanced things you can do.
1700 \begin_layout Section
1702 and \SpecialChar LaTeX
1706 \begin_layout Standard
1707 When \SpecialChar LyX
1708 calls \SpecialChar LaTeX
1709 , it tells \SpecialChar LaTeX
1710 to blithely ignore any errors and keep going.
1711 It then uses the logfile from the \SpecialChar LaTeX
1712 run to do a post-mortem.
1713 After analyzing the logfile, \SpecialChar LyX
1714 displays a dialog listing the errors.
1715 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1717 where the error occurred.
1721 \begin_layout Plain Layout
1723 Analyzing the logfile is a tough job, and \SpecialChar LyX
1724 doesn't always go to the right
1726 There are also cases where \SpecialChar LaTeX
1727 reports the error on one line, but the actual
1729 This is not unlike forgetting a closing brace in a program: You'll get
1730 an error, but only later.
1738 \begin_layout Standard
1739 Some folks also like to look at the log file directly: It is available from
1741 \begin_inset Flex Noun
1744 \begin_layout Plain Layout
1745 Document\SpecialChar menuseparator
1747 \begin_inset space ~
1756 There are some fairly common error messages and warnings.
1757 We'll cover those here.
1758 You should look at a good \SpecialChar LaTeX
1759 book for a complete listing.
1762 \begin_layout Itemize
1763 \begin_inset Flex Code
1766 \begin_layout Plain Layout
1773 \begin_inset Newline newline
1776 Anything beginning with these words is a warning message for the purpose
1778 \begin_inset Quotes eld
1782 \begin_inset Quotes erd
1785 the \SpecialChar LaTeX
1787 You'll get messages like this if you added or changed cross-references
1788 or bibliography entries, in which case, \SpecialChar LaTeX
1789 is trying to tell you that you
1790 need to make another run.
1791 You can by-and-large ignore these.
1794 \begin_layout Itemize
1795 \begin_inset Flex Code
1798 \begin_layout Plain Layout
1805 \begin_inset Newline newline
1808 Another warning message, this time about fonts which \SpecialChar LaTeX
1810 The rest of the message will often say something about a replacement font
1811 that \SpecialChar LaTeX
1813 You can safely ignore these, too.
1816 \begin_layout Itemize
1817 \begin_inset Flex Code
1820 \begin_layout Plain Layout
1829 \begin_inset Newline newline
1838 It seems to generate at least one of these messages for just about any
1840 They are warnings about lines that were too long and run past the right
1842 This happens if \SpecialChar LaTeX
1843 does not find a reasonable way to break the lines (notoriously
1844 often with typewriter font, since this does not allow for automatic break
1846 In many cases, this is unnoticeable in the final output.
1847 (It can be just a point or two.) Sometimes, however, the lines run rather
1848 visibly into the margin; something you will not want to have in your final
1851 \begin_inset Newline newline
1854 There are several global ways to try to minimize the overfull lines.
1857 Enable micro-typographic extensions
1861 Document\SpecialChar menuseparator
1862 Settings\SpecialChar menuseparator
1865 might already improve things a lot.
1866 Furthermore, \SpecialChar LaTeX
1867 code such as the following in
1869 Document\SpecialChar menuseparator
1870 Settings\SpecialChar menuseparator
1873 usually reduces the overfull lines drastically (we use this in the preamble
1878 \begin_layout LyX-Code
1882 \begin_inset Newline newline
1888 \begin_inset Newline newline
1893 emergencystretch 1.5em
1894 \begin_inset Newline newline
1902 \begin_layout Standard
1903 In some cases, however, you eventually have to rewrite the text to get the
1904 line breaking right.
1908 \begin_layout Plain Layout
1909 For more information, see
1910 \begin_inset Flex URL
1913 \begin_layout Plain Layout
1915 http://www.tex.ac.uk/FAQ-overfull.html
1928 \begin_layout Standard
1929 In any case, you should check the respective lines, at least for the final
1930 version of your document.
1931 Your eyes will tell you if there's a problem with something that's too
1936 \begin_layout Plain Layout
1937 You can also enable the `draft' option in
1938 \begin_inset Flex Noun
1941 \begin_layout Plain Layout
1942 Document\SpecialChar menuseparator
1948 , and then \SpecialChar LaTeX
1949 will draw a black box in the margin of lines that are overfull.
1958 \begin_layout Itemize
1959 \begin_inset Flex Code
1962 \begin_layout Plain Layout
1971 \begin_inset Newline newline
1974 Not quite as common as its cousin.
1975 This happens again if \SpecialChar LaTeX
1976 does not find a reasonable break point and consequently
1977 generates too loose lines.
1978 As with the overfull lines, you should check if this is a visible problem.
1981 \begin_layout Itemize
1982 \begin_inset Flex Code
1985 \begin_layout Plain Layout
1994 \begin_inset Flex Code
1997 \begin_layout Plain Layout
2006 \begin_inset Newline newline
2009 Warnings about troubles breaking the page.
2010 Once again, just look at the output.
2011 Your eyes will tell you where something has gone wrong.
2014 \begin_layout Itemize
2015 \begin_inset Flex Code
2018 \begin_layout Plain Layout
2020 \begin_inset Quotes els
2024 \begin_inset Quotes ers
2033 \begin_inset Newline newline
2037 \begin_inset Quotes eld
2041 \begin_inset Quotes erd
2044 isn't installed on this system.
2045 This usually appears because some package your document needs isn't installed.
2046 If you didn't touch the preamble or didn't use the
2047 \begin_inset Flex Code
2050 \begin_layout Plain Layout
2058 command, then one of the packages \SpecialChar LyX
2059 tried to load is missing.
2061 \begin_inset Flex Noun
2064 \begin_layout Plain Layout
2065 Help\SpecialChar menuseparator
2072 to get a list of packages that \SpecialChar LyX
2074 This file is updated whenever you reconfigure \SpecialChar LyX
2076 \begin_inset Flex Noun
2079 \begin_layout Plain Layout
2080 Tools\SpecialChar menuseparator
2086 ) and tells you which packages have been detected and what they do.
2087 \begin_inset Newline newline
2091 \begin_inset Flex Code
2094 \begin_layout Plain Layout
2102 command and the package in question isn't installed, then you'll need to
2103 install it yourself.
2106 \begin_layout Itemize
2107 \begin_inset Flex Code
2110 \begin_layout Plain Layout
2111 LaTeX Error: Unknown option
2117 \begin_inset Newline newline
2120 Error messages beginning with this are trying to tell you that you specified
2121 a bad or undefined option to a package.
2122 Check the package's documentation.
2125 \begin_layout Itemize
2126 \begin_inset Flex Code
2129 \begin_layout Plain Layout
2130 Undefined control sequence
2136 \begin_inset Newline newline
2139 If you've inserted \SpecialChar LaTeX
2140 code into your document, but made a typo, you'll get
2142 You may have forgotten to load a package.
2143 In any case, this error message usually means that you used an undefined
2148 \begin_layout Standard
2149 There are other error and warning messages.
2150 Some are self-explanatory.
2151 These are usually \SpecialChar LaTeX
2153 Others are downright cryptic.
2154 These are usually \SpecialChar TeX
2155 error messages, and we really have
2159 what they mean or how to decipher them.
2163 \begin_layout Standard
2164 There's a general sequence you should follow if you get error messages:
2167 \begin_layout Enumerate
2168 Look at the \SpecialChar LaTeX
2169 code you inserted for typos.
2172 \begin_layout Enumerate
2173 If there are no typos, check that you used the command(s) correctly.
2176 \begin_layout Enumerate
2177 If you get a bunch of error boxes piled up at the very top of the document—and
2178 especially if you see a
2179 \begin_inset Quotes eld
2183 \begin_inset Flex Code
2186 \begin_layout Plain Layout
2195 \begin_inset Quotes erd
2198 error—it means that there are errors in the preamble.
2199 Start debugging your preamble.
2202 \begin_layout Enumerate
2203 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2205 document, the first suspect is your \SpecialChar LaTeX
2206 distribution itself.
2207 Check for missing packages and install them.
2210 \begin_layout Enumerate
2211 Okay, so there are no missing packages.
2212 Did you use any of the fine-tuning options in \SpecialChar LyX
2213 ? Specifically, did you
2217 any of them, like trying to manually insert lots of
2218 \begin_inset Flex Code
2221 \begin_layout Plain Layout
2223 \change_deleted 177693 1654669036
2225 \change_inserted 177693 1654669038
2229 \begin_inset space ~
2233 \change_deleted 177693 1654669040
2235 \change_inserted 177693 1654669041
2244 \begin_inset Flex Code
2247 \begin_layout Plain Layout
2254 \begin_inset Flex Code
2257 \begin_layout Plain Layout
2263 ? Did you try to kludge something together with these instead of using the
2264 appropriate paragraph environment?
2267 \begin_layout Enumerate
2268 All right, you didn't use any of the fine-tuning options, you played by
2270 Did you try to pull a fancy maneuver? Did you do something funky inside
2271 a table or an equation, like inserting a graphic into a table cell?
2274 \begin_layout Enumerate
2275 Do you have long sections of text where \SpecialChar LaTeX
2276 cannot find a place to break a
2277 line? By default, \SpecialChar LaTeX
2278 is rather strict about how much extra inter-word spacing
2279 it will add in order to break a line.
2280 Preferably, you should rework the paragraph to avoid the problem.
2283 \begin_layout Enumerate
2284 Did you go overboard with the nesting? \SpecialChar LyX
2285 (currently) doesn't check to make
2286 sure you're in the limits for nesting environments.
2287 If you nested a bunch of environments to the
2288 \begin_inset Formula $17^{\mathrm{th}}$
2291 level, that's the problem.
2292 (The limit in \SpecialChar LaTeX
2296 \begin_layout Enumerate
2297 Okay, you didn't get any error messages, but your output looks awful.
2298 If you have a table or figure that's too wide or long for the page, you
2303 \begin_layout Enumerate
2304 rescale the figure so it fits.
2307 \begin_layout Enumerate
2308 trim down the table so it fits.
2312 \begin_layout Enumerate
2313 If something else is wrong with the output, and you didn't try to pull anything
2314 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2317 \begin_layout Standard
2318 If all this doesn't help—well, then
2322 you might have found a bug in \SpecialChar LyX
2327 \begin_layout Chapter
2329 \change_inserted 564990737 1670439508
2333 \begin_layout Section
2335 \change_inserted 564990737 1670439533
2336 \begin_inset CommandInset label
2338 name "sec:Collections"
2345 \begin_layout Subsection
2346 AMS \SpecialChar LaTeX
2350 \begin_layout Standard
2357 Richard Kimberly Heck
2360 \begin_layout Standard
2361 \begin_inset VSpace bigskip
2367 \begin_layout Standard
2369 The AMS \SpecialChar LaTeX
2370 layouts are set up to conform to suggested styles for mathematical
2371 papers to be submitted to American Mathematical Society publications.
2372 The layouts are not tailored to a specific journal, but easily can be.
2373 You should refer to the AMS documentation for specific instructions for
2374 each journal (usually it will entail only changing a single line in the
2377 That documentation is available on the Web at
2378 \begin_inset Flex URL
2381 \begin_layout Plain Layout
2389 \begin_inset Flex URL
2392 \begin_layout Plain Layout
2394 ftp://ftp.ams.org/pub/tex/amslatex/
2400 These layouts are appropriate, and useful, for any mathematical writing.
2404 \begin_layout Standard
2405 There are two basic AMS \SpecialChar LaTeX
2409 \begin_layout Itemize
2410 amsart: The standard AMS article format.
2413 \begin_layout Itemize
2414 amsbook: the standard AMS book (really, monograph) format.
2418 \begin_layout Standard
2419 The layouts themselves contain only the minimum necessary to use the AMS
2421 They do not, in particular, contain any of the `theorem' environments used
2422 for setting theorems, lemmas, and the like.
2423 These are contained, instead, in the
2424 \begin_inset Flex Code
2427 \begin_layout Plain Layout
2433 module, which is loaded by default when you select one of the AMS classes.
2434 (It can also be used with other classes and can be removed, if you would
2435 rather use something else.) Less commonly used environments are in the
2436 \begin_inset Flex Code
2439 \begin_layout Plain Layout
2440 Theorems (AMS-Extended)
2445 module, which must be loaded manually.
2448 \begin_layout Standard
2449 By default, theorems and the like are numbered consecutively throughout
2450 the document, but this may be modified by loading the module
2451 \begin_inset Flex Code
2454 \begin_layout Plain Layout
2455 Theorems (Order by Section)
2460 or, if you are using
2461 \begin_inset Flex Code
2464 \begin_layout Plain Layout
2471 \begin_inset Flex Code
2474 \begin_layout Plain Layout
2475 Theorems (Order by Chapter)
2481 These will number the results as
2482 \begin_inset Formula $n.m$
2485 , where the first number refers to the section (or chapter) and the second
2486 refers to the total number of results so far in that section (or chapter).
2487 Many environments are also available unnumbered.
2488 These are indicated by an asterisk at the end.
2489 If you happen to want
2493 unnumbered results, the module
2494 \begin_inset Flex Code
2497 \begin_layout Plain Layout
2503 provides that option.
2506 \begin_layout Standard
2507 Note that these modules do not
2511 to be used with the AMS classes.
2512 It is perfectly possible to use the
2513 \begin_inset Flex Code
2516 \begin_layout Plain Layout
2522 module, and the others mentioned, with other classes, such as
2523 \begin_inset Flex Code
2526 \begin_layout Plain Layout
2533 \begin_inset Flex Code
2536 \begin_layout Plain Layout
2543 \begin_inset Flex Code
2546 \begin_layout Plain Layout
2555 \begin_layout Subsubsection
2556 What these layouts provide
2559 \begin_layout Standard
2560 There is a long list of included environments provided by these layouts.
2561 In AMS-\SpecialChar LaTeX
2562 , there is, in fact, an opportunity to define an unlimited variety
2563 of `theorem' environments.
2564 However, the AMS recommends the environments that are available in \SpecialChar LyX
2569 \begin_layout Standard
2570 The following environments—as well as the standard environments, such as
2572 \begin_inset Flex Noun
2575 \begin_layout Plain Layout
2582 \begin_inset Flex Noun
2585 \begin_layout Plain Layout
2592 \begin_inset Flex Noun
2595 \begin_layout Plain Layout
2602 \begin_inset Flex Noun
2605 \begin_layout Plain Layout
2612 \begin_inset Flex Noun
2615 \begin_layout Plain Layout
2622 \begin_inset Flex Code
2625 \begin_layout Plain Layout
2632 \begin_inset Flex Code
2635 \begin_layout Plain Layout
2644 \begin_layout Description
2645 Address This should be the author's permanent address.
2648 \begin_layout Description
2650 \begin_inset space ~
2653 Address This should be the author's temporary address at the time of submission,
2654 if different from the Address.
2657 \begin_layout Description
2658 Email Author's e-mail address
2661 \begin_layout Description
2662 URL Author's Web address, if desired.
2665 \begin_layout Description
2666 Keywords Key words or phrases used to identify specific topics discussed
2670 \begin_layout Description
2671 Subjectclass These refer to the AMS Subject Classifications, published and
2674 Mathematical Reviews
2677 These are also available online at the AMS cites listed above.
2680 \begin_layout Description
2684 \begin_layout Description
2688 \begin_layout Description
2692 \begin_layout Standard
2693 The following environments are provided by both the
2694 \begin_inset Flex Code
2697 \begin_layout Plain Layout
2704 \begin_inset Flex Code
2707 \begin_layout Plain Layout
2713 modules, in the latter case in both starred (unnumbered) and unstarred
2714 (numbered) versions.
2715 These same environments are provided only in the starred versions by the
2717 \begin_inset Flex Code
2720 \begin_layout Plain Layout
2729 \begin_layout Theorem
2730 This is typically used for the statements of major results.
2734 \begin_layout Corollary*
2735 This is used for statements which follow fairly directly from previous statement
2737 Again, these can be major results.
2742 These are smaller results needed to prove other statements.
2745 \begin_layout Proposition
2746 These are less major results which (hopefully) add to the general theory
2750 \begin_layout Conjecture
2751 These are statements provided without justification, which the author does
2752 not know how to prove, but which seem to be true (to the author, at least).
2755 \begin_layout Definition*
2756 Guess what this is for.
2757 The font is different for this environment than for the previous ones.
2761 \begin_layout Example*
2762 Used for examples illustrating proven results.
2765 \begin_layout Problem
2766 It's not really known what this is for.
2767 You should figure it out.
2770 \begin_layout Exercise*
2771 Write a description for this one.
2774 \begin_layout Remark
2775 This environment is also a type of theorem, usually a lesser sort of observation.
2778 \begin_layout Claim*
2779 Often used in the course of giving a proof of a larger result.
2783 Generally, these are used to break up long arguments, using specific instances
2789 The numbering scheme for cases is on its own, not together with other numbered
2795 At the end of this environment, a QED symbol (usually a square, but it can
2796 vary with different styles) is placed.
2797 If you want to have other environments within this one—for example, Case
2798 environments—and have the QED symbol appear only after them, then the other
2799 environments need to be nested within the proof environment.
2802 Nesting Environments
2808 for information on nesting.
2811 \begin_layout Standard
2812 And these environments are provided by
2813 \begin_inset Flex Code
2816 \begin_layout Plain Layout
2817 Theorems (AMS-Extended)
2825 \begin_layout Criterion*
2826 A required condition.
2829 \begin_layout Algorithm*
2830 A general procedure to be used.
2833 \begin_layout Axiom*
2834 This is a property or statement taken as true within the system being discussed.
2837 \begin_layout Condition*
2838 Sometimes used to state a condition assumed within the present context of
2843 Similar to a Remark.
2846 \begin_layout Notation*
2847 Used for the explanation of, yes, notation.
2850 \begin_layout Summary
2851 Do we really need to tell you?
2854 \begin_layout Acknowledgement*
2858 \begin_layout Conclusion*
2859 Sometimes used at the end of a long train of argument.
2863 Used in a way similar to Proposition, though perhaps lower on the scale.
2866 \begin_layout Standard
2867 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2870 They need to be available on your system in order to use these environments.
2873 \begin_layout Subsection
2875 \change_inserted 564990737 1671383236
2878 \begin_inset CommandInset label
2880 name "subsec:Extra-font-sizes"
2887 \begin_layout Standard
2889 \change_inserted 564990737 1671383236
2892 The “Extra font sizes” collection provides the document classes
2895 \begin_inset space \thinspace{}
2898 (with extra font sizes)
2903 \begin_inset space \thinspace{}
2906 (with extra font sizes)
2911 \begin_inset space \thinspace{}
2914 (with extra font sizes)
2919 \begin_inset space \thinspace{}
2922 (with extra font sizes)
2940 document classes respectively but offer the additional
2946 \begin_inset space ~
2951 options 8, 9, 14, 17 and 20 in the
2956 ocument\SpecialChar menuseparator
2961 ettings\SpecialChar menuseparator
2967 \begin_layout Subsection
2969 \change_inserted 564990737 1671383236
2975 \begin_layout Standard
2977 \change_inserted 564990737 1671383236
2980 The document classes
2983 \begin_inset space \thinspace{}
2991 \begin_inset space \thinspace{}
3006 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3010 \begin_layout Subsection
3012 \change_inserted 564990737 1671383236
3015 \begin_inset CommandInset label
3017 name "subsec:Japanese"
3024 \begin_layout Standard
3026 \change_inserted 564990737 1671383236
3029 The document classes
3032 \begin_inset space \thinspace{}
3040 \begin_inset space \thinspace{}
3043 (Japanese Standard Class Vertical Writing)
3048 \begin_inset space \thinspace{}
3051 (Japanese Standard Class)
3056 \begin_inset space \thinspace{}
3064 \begin_inset space \thinspace{}
3067 (Japanese Standard Class Vertical Writing)
3072 \begin_inset space \thinspace{}
3075 (Japanese Standard Class)
3080 \begin_inset space \thinspace{}
3083 (Japanese Vertical Writing)
3088 \begin_inset space \thinspace{}
3091 (Japanese Standard Class)
3093 provide document classes for the Japanese language.
3096 \begin_layout Subsection
3100 \begin_layout Standard
3106 \begin_layout Subsubsection
3110 \begin_layout Standard
3111 The \SpecialChar LyX
3114 article (koma-script)
3118 report (koma-script)
3136 correspond to the \SpecialChar LaTeX
3154 \begin_inset space ~
3157 of the Koma-Script family.
3158 They are replacements for the standard document classes
3174 , resp., and fit better to European typography conventions in a number of
3178 \begin_layout Itemize
3179 Standard character size is 11pt in
3181 article (koma-script)
3185 report (koma-script)
3193 letter (koma-script)
3198 \begin_layout Itemize
3199 Headings, labels of the description environment, and a number of elements
3202 letter (koma-script)
3204 document class are set in a bold sans serif font.
3208 \begin_layout Plain Layout
3209 There is a big difference between the bold sans serif old cm fonts and new
3210 ec fonts, especially in the appearance of headings.
3211 In comparison, the ec bold sans serif fonts look a bit thin.
3212 Here the \SpecialChar LaTeX
3221 helps to produce the
3222 \begin_inset Quotes eld
3226 \begin_inset Quotes erd
3229 appearance when using the ec fonts.
3234 The numbering of chapter headings is made in the same way as the numbering
3235 of section headings, that is without the extra line
3236 \begin_inset Quotes eld
3239 Chapter\SpecialChar ldots
3241 \begin_inset Quotes erd
3245 In addition, the appearance of the headings can be modified by using a
3246 number of options (in \SpecialChar LyX
3247 to be entered in the field
3250 \begin_inset space ~
3257 Layout\SpecialChar menuseparator
3264 \begin_layout Itemize
3265 The main means in the Koma-Script document classes to design the type area
3274 (in \SpecialChar LyX
3275 to be entered in the extra class options field in the dialog
3277 Document\SpecialChar menuseparator
3281 They make a clearer modification of page margins possible as do the options
3284 Document\SpecialChar menuseparator
3291 \begin_layout Itemize
3292 The \SpecialChar LaTeX
3293 document classes of the Koma-Script family define a number of additional
3295 Those part of it which makes sense in \SpecialChar LyX
3296 is implemented in corresponding
3300 \begin_layout Standard
3301 Detailed descriptions of the \SpecialChar LaTeX
3302 document classes of the Koma-Script family
3303 can be found in the Koma-Script documentation
3314 \begin_layout Subsubsection
3315 article (koma-script), report (koma-script), and book (koma-script)
3318 \begin_layout Standard
3319 The document classes
3321 article (koma-script)
3325 report (koma-script)
3335 are implemented in the layout files
3348 They contain all the paragraph types of the corresponding standard document
3361 , resp., partly modified, with the exception of the \SpecialChar LyX
3366 -type, which is replaced by the new
3370 -type having the same functionality.
3375 -Type there is a number of new paragraph types added.
3382 letter (koma-script)
3387 \begin_layout Itemize
3396 : are equivalents to
3404 , resp., additionally inserting an entry in the table of contents.
3413 are not contained in
3415 article (koma-script)
3420 \begin_layout Itemize
3437 , resp., additionally clearing running heads.
3444 article (koma-script)
3450 \begin_layout Plain Layout
3463 report (koma-script)
3465 , but since this is identical to
3469 , is has not been implemented in \SpecialChar LyX
3478 \begin_layout Itemize
3483 : generates a heading directly above the following paragraph in the standard
3484 character size without affecting the structure of the document.
3487 \begin_layout Itemize
3496 are special captions which respect the different space settings needed
3497 for captions placed above or below an element (if you follow strict typographic
3498 rules, you might want to place table captions always above the table).
3499 You can also use the class option
3516 You need at least Koma-Script version 2.8q to use this.
3519 \begin_layout Itemize
3524 : can be used to set a bonmot, e.
3525 \begin_inset space \thinspace{}
3529 \begin_inset space \space{}
3532 at the beginning of a chapter.
3533 If you use the optional argument (
3535 Insert\SpecialChar menuseparator
3537 \begin_inset space ~
3542 ), you can insert the dictum's author there.
3543 Dictum and author are separated by a line.
3544 You need at least Koma-Script version 2.8q to use this.
3551 article (koma-script)
3556 \begin_layout Standard
3557 The following types, together with the standard types
3569 , form the title area of the document.
3570 They must be entered ahead of the first
3571 \begin_inset Quotes eld
3575 \begin_inset Quotes erd
3582 \begin_layout Plain Layout
3583 The corresponding \SpecialChar LaTeX
3584 commands must appear before the
3595 When such a type is used more than once, the latter usage overwrites the
3596 former one, that means, for every type only the latest usage is valid.
3597 The order of the different types however has, like
3609 , no effect on the appearance of the produced document.
3612 \begin_layout Itemize
3617 : produces a centered paragraph above the ordinary title (
3629 ) for the subject of the document.
3632 \begin_layout Itemize
3637 : produces a centered paragraph below the ordinary title (
3649 ) for the publishers' name.
3652 \begin_layout Itemize
3659 report (koma-script)
3665 produces a centered paragraph on its own page behind the title page, or
3668 article (koma-script)
3670 produces a centered paragraph below the ordinary title (
3689 \begin_layout Itemize
3694 : produces a left aligned paragraph above the ordinary title (
3710 ) for a document`s head.
3713 \begin_layout Itemize
3718 : produces in a double-sided print in
3720 report (koma-script)
3726 a left-aligned paragraph at the top of the title page`s back or has no
3727 effect in a single-sided print or in
3729 article (koma-script)
3734 \begin_layout Itemize
3739 : produces in a double-sided print in
3741 report (koma-script)
3747 a left-aligned paragraph at the bottom of the title page`s back or has
3748 no effect in a single-sided print or in
3750 article (koma-script)
3755 \begin_layout Itemize
3760 : produces a special
3761 \begin_inset Quotes eld
3765 \begin_inset Quotes erd
3768 page ahead of the actual document containing a paragraph without special
3772 \begin_layout Standard
3773 The layout files for the document classes
3775 article (koma-script)
3779 report (koma-script)
3790 This is thought of as a place to define your own types.
3795 in your personal layout directory and edit the file!
3798 \begin_layout Subsubsection
3799 letter (koma-script)
3802 \begin_layout Description
3803 Note: This section discusses the obsolete
3805 KOMA-Script-Letter (v.
3806 \begin_inset space ~
3811 , which is not even included anymore in recent KOMA releases.
3812 Please refer to the next section for the current KOMA-Script-Letter class
3814 \begin_inset space ~
3820 \begin_layout Standard
3824 letter (koma-script)
3826 is implemented in the layout file
3831 It contains all the paragraph types of the corresponding standard document
3836 , partly modified, with the exception of the \SpecialChar LyX
3850 type, which is replaced by the new
3855 In addition, it contains, in contrast to the standard document class, the
3874 Furthermore, there are a number of new letter specific types.
3877 \begin_layout Standard
3878 The appearance of the letter produced by this document class can be controlled
3879 by a number of \SpecialChar LaTeX
3880 commands, which you can put in the \SpecialChar LaTeX
3885 \begin_layout Plain Layout
3886 For example, the standard appearance of the letter`s heading, consisting
3887 of name and address, is quite self-willed.
3889 \begin_inset Quotes eld
3893 \begin_inset Quotes erd
3896 heading is produced by the following \SpecialChar LaTeX
3897 commands in the preamble:
3900 \begin_layout LyX-Code
3910 \begin_layout LyX-Code
3926 \begin_layout LyX-Code
3936 \begin_layout LyX-Code
3956 A detailed German description of such \SpecialChar LaTeX
3957 commands can be found in the Koma-Script
3963 With it, the letter's author can produce his personal letter layout.
3966 \begin_layout Standard
3975 define the beginning of the letter and must be used in every letter.
3976 To emphasize them in the \SpecialChar LyX
3977 document class, they are marked with the letter
3987 \begin_inset space ~
3991 It is possible to write any number of letters in one file.
3996 type produces a new letter using the same addressee and a
4000 type produces a new addressee.
4017 are ordinary paragraph types and can also be used several times in one
4018 and the same letter.
4021 \begin_layout Itemize
4026 : produces a paragraph for the addressee and implicitly defines the beginning
4030 \begin_layout Itemize
4035 : produces a paragraph for the form of address and implicitly produces a
4039 \begin_layout Itemize
4044 : produces a paragraph for a close.
4047 \begin_layout Itemize
4052 : produces a paragraph for a postscript.
4055 \begin_layout Itemize
4060 : produces a paragraph for a distribution list.
4063 \begin_layout Itemize
4068 : produces a paragraph for enclosures.
4071 \begin_layout Standard
4112 are input types provided with a label to enter information, which will
4113 be processed by the document class.
4117 \begin_layout Plain Layout
4118 It could be seen as a matter of inconsequence, that the types
4126 described above are not such input types as well.
4127 Because of the special meaning of those types, however, I have implemented
4128 them as ordinary paragraph types with a one letter mark in the left margin.
4129 Moreover, it would affect my feeling of symmetry, if the
4137 type had such a serious different appearance.
4142 The types must be used ahead of the corresponding
4149 \begin_layout Standard
4150 An implementation of these types in a WYSIWYG fashion does not seem to make
4151 sense, because the real appearance of the produced letter does not only
4152 depend on the usage of the particular type, but also on other factors.
4153 For example, a signature entered in the
4157 type will in the standard behavior appear in the produced letter only,
4158 when in the same letter also a
4163 The entered value of the
4167 type will in the standard behavior not appear in the produced letter at
4169 The possibility to design the letter`s heading freely is already indicated
4170 in a footnote above.
4173 \begin_layout Standard
4174 The input types can also be used as empty paragraphs.
4176 \begin_inset space \thinspace{}
4180 \begin_inset space \space{}
4192 type is not used at all, in the standard behavior the value of the
4196 type is used as signature, whereas if an empty
4200 type is used, no signature value is defined.
4203 \begin_layout Standard
4204 By using the input types it is possible to write a letter template, containing
4205 filled input types with your personal dates (name, address, etc.) and empty
4206 input types for other dates you want to enter.
4209 \begin_layout Itemize
4214 : sender's name, in the standard behavior appears as a centered paragraph
4215 in small caps in the letter`s heading.
4218 \begin_layout Itemize
4223 : sender's signature, in the standard behavior appears below the
4232 type is used, the value of the
4236 type appears instead.
4239 \begin_layout Itemize
4244 : sender's address, in the standard behavior appears in a centered paragraph
4245 in the letter`s heading below the sender's name.
4248 \begin_layout Itemize
4253 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4264 \begin_layout Itemize
4269 : place of the letter`s making.
4272 \begin_layout Itemize
4277 : date of the letter`s making.
4286 , in the standard behavior, produce the place and the date in a right-aligned
4287 line below the addressee's field.
4292 type is used, neither place nor date appear, independent of the value of
4302 type is used, the date of the letter `s production is used.
4305 \begin_layout Itemize
4310 : sender`s back address, in the standard behavior appears above the addressee's
4311 field in a small sans serif font.
4314 \begin_layout Itemize
4319 : special mail information, in the standard behavior appears underlined
4320 above the addressee's field below the back address.
4323 \begin_layout Itemize
4328 : additional information, in the standard behavior appears on right side
4329 below the addressee`s field.
4332 \begin_layout Itemize
4337 : the letter's title, in the standard behavior appears in a big, bold, sans
4338 serif font above the subject.
4341 \begin_layout Itemize
4346 : the letter's subject, in the standard behavior appears in a bold font
4354 \begin_layout Standard
4375 produce a business letter like line above the
4379 line containing the fields
4380 \begin_inset Quotes eld
4384 \begin_inset Quotes erd
4388 \begin_inset Quotes eld
4392 \begin_inset Quotes erd
4396 \begin_inset Quotes eld
4400 \begin_inset Quotes erd
4404 \begin_inset Quotes eld
4408 \begin_inset Quotes erd
4412 \begin_inset Quotes eld
4416 \begin_inset Quotes erd
4420 \begin_inset Quotes eld
4424 \begin_inset Quotes erd
4428 For the date field, the value of the
4434 \begin_inset Quotes eld
4437 business letter types
4438 \begin_inset Quotes erd
4441 is used, the value of the
4445 type however does not appear, but only the \SpecialChar LaTeX
4453 The ordinary output of place and date in a right-aligned line below the
4454 addressee`s field is suppressed.
4455 The types are implemented as input types provided with a label and must
4456 be used ahead of the corresponding
4463 \begin_layout Itemize
4471 \begin_layout Itemize
4479 \begin_layout Itemize
4487 \begin_layout Itemize
4495 \begin_layout Itemize
4503 \begin_layout Subsubsection
4504 The new letter class: letter (koma-script v.2)
4507 \begin_layout Standard
4513 \begin_layout Standard
4514 \begin_inset VSpace medskip
4520 \begin_layout Standard
4522 Koma-Script version 2.8 has introduced a new letter class
4526 which supersedes the now unsupported
4531 It has — on the \SpecialChar LaTeX
4532 side — a completely new interface and is not compatible
4534 Therefore, \SpecialChar LyX
4535 supports both, though it is recommended you use the new class.
4538 \begin_layout Standard
4539 This class covers the same functionality as
4541 letter (koma-script),
4548 (receiver's address, same as
4565 will start a new letter (i.
4566 \begin_inset space \thinspace{}
4570 \begin_inset space \space{}
4573 you can write several letters per document).
4574 New elements are sender's
4590 and the possibility to use a
4596 Insert\SpecialChar menuseparator
4602 \begin_layout Standard
4603 The biggest improvement is, though, that the letter's layout is configurable
4604 to meet almost any needs.
4605 This can be done via the preamble or with a special style file (Letter
4606 Class Option, extension
4610 ), that will be read in as a class option.
4614 \begin_layout Plain Layout
4615 The KOMA package comes with some default
4620 There is, for instance, a
4624 file that follows german typesetting rules, or a
4628 that provides the default layout of the old
4633 The latter can be loaded with the class option
4639 Layout\SpecialChar menuseparator
4640 Document\SpecialChar menuseparator
4649 \change_deleted 564990737 1671617922
4657 \change_deleted 564990737 1671617938
4658 that is included in \SpecialChar LyX
4660 \change_inserted 564990737 1671617997
4667 ile\SpecialChar menuseparator
4669 \begin_inset space ~
4677 \begin_inset space ~
4680 Template\SpecialChar menuseparator
4683 \SpecialChar menuseparator
4684 KOMA-Script Letter (V.2)
4689 A detailed description is to be found in the Koma-Script documentation
4697 \begin_layout Subsubsection
4701 \begin_layout Standard
4702 Visualizing the Koma-Script document classes in \SpecialChar LyX
4703 , the \SpecialChar LyX
4704 internals cause some
4708 \begin_layout Itemize
4709 The chapter number of a
4713 type appears on a line of its own above the chapter heading instead of
4714 appearing in the same line ahead of it.
4715 The cause for that is the \SpecialChar LyX
4716 internal behavior for the labeltype
4723 \begin_layout Itemize
4724 The headings of the types
4733 \begin_inset Quotes eld
4737 \begin_inset Quotes erd
4741 table of contents, but not in the \SpecialChar LyX
4744 Document\SpecialChar menuseparator
4746 \begin_inset space ~
4750 \begin_inset space ~
4758 \begin_layout Itemize
4763 document class appear in a skip separation mode, not indented.
4764 This is the standard behavior, no special \SpecialChar LaTeX
4765 commands are needed for that.
4768 Document\SpecialChar menuseparator
4771 dialog the corresponding radio button indicates
4780 value always has the effect that extra \SpecialChar LaTeX
4781 commands are inserted in the document
4782 to produce the gap, which is not what is wanted in this case.
4785 \begin_layout Subsection
4787 \change_inserted 564990737 1670924924
4789 \begin_inset space \thinspace{}
4793 \begin_inset space \space{}
4797 \change_deleted 564990737 1670924933
4798 Article (mwart), book (mwbk) and report (mwrep)
4799 \begin_inset Argument status
4802 \begin_layout Plain Layout
4817 \begin_layout Standard
4823 \begin_layout Standard
4824 The \SpecialChar LyX
4841 correspond to the \SpecialChar LaTeX
4855 They are replacements for the standard document classes
4867 , resp., and fit better to Polish typography conventions in a number of points.
4871 \begin_layout Standard
4875 \begin_layout Itemize
4876 Unnumbered titles (with star, e.
4877 \begin_inset space \thinspace{}
4881 \begin_inset space \space{}
4888 ) are added into table of contents,
4891 \begin_layout Itemize
4892 Additional page styles:
4896 \begin_layout Description
4897 uheadings header with separated lines,
4900 \begin_layout Description
4901 myheadings custom header, contents headers via commands:
4916 \begin_layout Description
4917 myuheadings custom header with separated lines,
4920 \begin_layout Description
4921 outer page number is placed on outer side of page
4925 \begin_layout Itemize
4930 \begin_layout Description
4931 rmheadings serif titles — default,
4934 \begin_layout Description
4935 sfheadings sansserif titles,
4938 \begin_layout Description
4939 authortitle on title page first placed is author next title — default,
4942 \begin_layout Description
4943 titleauthor on title page first placed is title next author,
4946 \begin_layout Description
4947 withmarginpar reserve place on page for margins.
4951 \begin_layout Section
4953 \change_inserted 564990737 1670439534
4957 \begin_layout Standard
4959 \change_inserted 564990737 1670794710
4960 See also the document classes in the Collections (section
4961 \begin_inset space ~
4965 \begin_inset CommandInset ref
4967 reference "sec:Collections"
4974 \begin_layout Subsection
4976 \change_inserted 564990737 1670794716
4982 \begin_layout Standard
4984 \change_inserted 564990737 1670794716
4991 ; updated by the \SpecialChar LyX
4995 \begin_layout Subsubsection
4997 \change_inserted 564990737 1670794716
5003 \begin_layout Standard
5005 \change_inserted 564990737 1670794716
5008 This section describes how \SpecialChar LyX
5009 can be used to write articles for submission
5010 to the scientific journal
5012 Astronomy and Astrophysics
5015 \begin_inset CommandInset href
5018 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5023 ) using Version 9.1 of the document class
5027 ; information about it is available at
5028 \begin_inset Flex URL
5031 \begin_layout Plain Layout
5033 \change_inserted 564990737 1670794716
5035 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
5045 \begin_layout Standard
5047 \change_inserted 564990737 1670794716
5050 A manual comes together with the package and should be consulted before
5051 installing this document class as described in the
5053 Installing New Document Classe
5063 \begin_layout Standard
5065 \change_inserted 564990737 1670794716
5068 \begin_inset Note Greyedout
5071 \begin_layout Plain Layout
5073 \change_inserted 564990737 1670794716
5076 Please note that the publisher of the journal was changed from Springer
5077 to EDP Sciences starting January 1, 2001.
5078 That change also involved some slight changes to the style files, namely
5079 the removal of the thesaurus command.
5080 If you have an older version installed, please upgrade.
5081 For information about compatibility with the old (version 4) layout, please
5082 refer to the comments in
5085 Dir/layouts/aapaper.layout
5095 \begin_layout Subsubsection
5097 \change_inserted 564990737 1670794716
5103 \begin_layout Standard
5105 \change_inserted 564990737 1671617129
5108 It is recommended you start from the template in the menu
5113 ile\SpecialChar menuseparator
5115 \begin_inset space ~
5123 \begin_inset space ~
5128 \SpecialChar menuseparator
5129 Articles\SpecialChar menuseparator
5130 Astronomy & Astrophysics
5134 If you are not using the template, note the following settings:
5137 \begin_layout Itemize
5139 \change_inserted 564990737 1670794716
5151 ocument\SpecialChar menuseparator
5156 ettings\SpecialChar menuseparator
5158 \begin_inset space ~
5163 dialog (OK, that one was obvious).
5166 \begin_layout Itemize
5168 \change_inserted 564990737 1670794716
5174 \begin_inset space ~
5186 \begin_inset space ~
5191 dialog: leave it set to
5196 The whole layout is done by the macros, you shouldn't change anything.
5199 \begin_layout Subsubsection
5201 \change_inserted 564990737 1670794716
5207 \begin_layout Standard
5209 \change_inserted 564990737 1670794716
5212 First thing to enter is the header information.
5213 It consists of five entries, of which one is optional.
5217 \begin_layout Itemize
5219 \change_inserted 564990737 1670794716
5228 \begin_layout Itemize
5230 \change_inserted 564990737 1670794716
5239 \begin_layout Itemize
5241 \change_inserted 564990737 1670794716
5250 \begin_layout Itemize
5252 \change_inserted 564990737 1670794716
5261 \begin_layout Itemize
5263 \change_inserted 564990737 1670794716
5272 Received: <date>; Accepted <date>
5275 \begin_layout Standard
5277 \change_inserted 564990737 1670794716
5280 Although the order of the single header entries doesn't matter it is advised
5281 to keep the above sequence, just to get the best optics and meets the layout
5282 of the real document.
5285 \begin_layout Standard
5287 \change_inserted 564990737 1670794716
5290 If you want to place footnotes in the header block, e.
5291 \begin_inset space \thinspace{}
5295 \begin_inset space \space{}
5298 to state your present address, just use the standard footnote via the menu
5304 nsert\SpecialChar menuseparator
5313 will automagically use the term
5322 \begin_layout Standard
5324 \change_inserted 564990737 1670794716
5327 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5329 have no counterpart in \SpecialChar LyX
5333 \begin_layout Itemize
5335 \change_inserted 564990737 1670794716
5343 to separate different names for more than one author and institute, respectivel
5347 \begin_layout Itemize
5349 \change_inserted 564990737 1670794716
5357 to mark corresponding author/institute pairs.
5358 The institutes are numbered sequentially as they appear in the
5362 field, so you have to put a marker to each author.
5365 \begin_layout Itemize
5367 \change_inserted 564990737 1670794716
5375 to supply an email address for fast contact.
5378 \begin_layout Standard
5380 \change_inserted 564990737 1671642374
5383 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5384 code in \SpecialChar LyX
5386 See the examples in the template and in
5389 File\SpecialChar menuseparator
5390 Open Example\SpecialChar menuseparator
5391 Articles\SpecialChar menuseparator
5392 Astronomy & Astrophysics
5400 \begin_layout Subsubsection
5402 \change_inserted 564990737 1670794716
5408 \begin_layout Standard
5410 \change_inserted 564990737 1670794716
5413 The abstract should immediately follow the header block and must contain
5423 \begin_layout Enumerate
5425 \change_inserted 564990737 1670794716
5431 (optional) {} leave it empty if necessary
5434 \begin_layout Enumerate
5436 \change_inserted 564990737 1670794716
5445 \begin_layout Enumerate
5447 \change_inserted 564990737 1670794716
5456 \begin_layout Enumerate
5458 \change_inserted 564990737 1670794716
5467 \begin_layout Enumerate
5469 \change_inserted 564990737 1670794716
5475 (optional) {} leave it empty if necessary
5478 \begin_layout Standard
5480 \change_inserted 564990737 1670794716
5484 This structure not shown in
5491 \begin_layout Subsubsection
5493 \change_inserted 564990737 1670794716
5496 Supported environments
5499 \begin_layout Standard
5501 \change_inserted 564990737 1670794716
5504 The A&A paper layout supports the following environments for structuring
5508 \begin_layout Itemize
5510 \change_inserted 564990737 1670794716
5517 \begin_layout Itemize
5519 \change_inserted 564990737 1670794716
5526 \begin_layout Itemize
5528 \change_inserted 564990737 1670794716
5535 \begin_layout Itemize
5537 \change_inserted 564990737 1670794716
5544 \begin_layout Itemize
5546 \change_inserted 564990737 1670794716
5553 \begin_layout Itemize
5555 \change_inserted 564990737 1670794716
5562 \begin_layout Itemize
5564 \change_inserted 564990737 1670794716
5571 \begin_layout Itemize
5573 \change_inserted 564990737 1670794716
5580 \begin_layout Itemize
5582 \change_inserted 564990737 1670794716
5589 \begin_layout Itemize
5591 \change_inserted 564990737 1670794716
5598 \begin_layout Itemize
5600 \change_inserted 564990737 1670794716
5607 \begin_layout Itemize
5609 \change_inserted 564990737 1670794716
5617 \begin_layout Subsubsection
5619 \change_inserted 564990737 1670794716
5622 Commands not supported by \SpecialChar LyX
5626 \begin_layout Standard
5628 \change_inserted 564990737 1670794716
5631 Some commands are not yet supported by the
5635 layout for \SpecialChar LyX
5637 Some have already been mentioned.
5638 For the sake of completeness, they are listed all together here:
5641 \begin_layout Itemize
5643 \change_inserted 564990737 1670794716
5652 \begin_layout Itemize
5654 \change_inserted 564990737 1670794716
5663 \begin_layout Itemize
5665 \change_inserted 564990737 1670794716
5674 \begin_layout Itemize
5676 \change_inserted 564990737 1670794716
5685 \begin_layout Itemize
5687 \change_inserted 564990737 1670794716
5696 \begin_layout Standard
5698 \change_inserted 564990737 1670794716
5701 If you want to use any of these commands, you have to enter them yourself.
5704 Do not forget to use
5710 nsert\SpecialChar menuseparator
5713 \begin_inset space ~
5722 \begin_layout Subsubsection
5724 \change_inserted 564990737 1670794716
5727 Figure and Table Floats
5730 \begin_layout Standard
5732 \change_inserted 564990737 1670794716
5736 provides support for the necessary float environments
5738 figure, figure*, table
5744 , therefore we won't tell much about it here.
5748 \begin_inset space ~
5754 Just remember that tables should be left-aligned.
5755 For that, select the table and change the alignment in
5760 dit\SpecialChar menuseparator
5766 \begin_inset space ~
5772 \begin_layout Standard
5774 \change_inserted 564990737 1670794716
5777 There is only one special thing: the figures with a caption beside the figure.
5778 To create such a figure, you have to do the following:
5781 \begin_layout Enumerate
5783 \change_inserted 564990737 1670794716
5786 Create a wide figure float:
5791 nsert\SpecialChar menuseparator
5796 t\SpecialChar menuseparator
5799 , then, from within the float, use the menu
5804 dit\SpecialChar menuseparator
5810 \begin_inset space ~
5821 \begin_inset space ~
5833 \begin_layout Enumerate
5835 \change_inserted 564990737 1670794716
5838 Enter your caption text.
5841 \begin_layout Enumerate
5843 \change_inserted 564990737 1670794716
5850 to move the cursor above the caption.
5853 \begin_layout Enumerate
5855 \change_inserted 564990737 1670794716
5861 \begin_layout Enumerate
5863 \change_inserted 564990737 1670794716
5866 Position the cursor after the figure and insert a horizontal fill by using
5872 nsert\SpecialChar menuseparator
5877 rmatting\SpecialChar menuseparator
5883 \begin_inset space ~
5892 dialog and select the
5906 \begin_layout Enumerate
5908 \change_inserted 564990737 1670794716
5911 Switch to \SpecialChar LaTeX
5915 \begin_inset space ~
5923 \begin_layout Enumerate
5925 \change_inserted 564990737 1670794716
5936 Do not close the brace!
5939 \begin_layout Enumerate
5941 \change_inserted 564990737 1670794716
5944 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5949 \begin_inset space ~
5961 \begin_layout Standard
5963 \change_inserted 564990737 1671642458
5966 Also, refer to the figures in the file in
5969 File\SpecialChar menuseparator
5970 Open Example\SpecialChar menuseparator
5971 Articles\SpecialChar menuseparator
5972 Astronomy & Astrophysics
5978 \begin_layout Subsubsection
5980 \change_inserted 564990737 1670794716
5986 \begin_layout Standard
5988 \change_inserted 564990737 1670794716
5991 For submission, the paper has to be formatted in a special double-spacing
5993 For this purpose, you have to add the option
6004 \begin_inset space ~
6014 ocument\SpecialChar menuseparator
6019 ettings\SpecialChar menuseparator
6021 \begin_inset space ~
6030 \begin_layout Subsubsection
6032 \change_inserted 564990737 1670794716
6038 \begin_layout Standard
6040 \change_inserted 564990737 1671642520
6046 File\SpecialChar menuseparator
6047 Open Example\SpecialChar menuseparator
6048 Articles\SpecialChar menuseparator
6049 Astronomy & Astrophysics
6052 was written with \SpecialChar LyX
6054 It is the example paper from the original macro package,
6059 \begin_inset CommandInset href
6062 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6067 , but translated to \SpecialChar LyX
6068 using the older unstructured abstract type.
6069 Use it for inspiration, and compare the \SpecialChar LaTeX
6074 with the \SpecialChar LyX
6078 \begin_layout Subsection
6083 \begin_layout Standard
6089 \begin_layout Subsubsection
6093 \begin_layout Standard
6095 is a set of macros produced by the American Astronomical Society to
6096 facilitate electronic manuscript submission to the three journals they
6097 publish: the Astrophysical Journal (including the Letters and Supplement),
6098 the Astronomical Journal, and the Publications of the Astronomical Society
6101 has proven to be an excellent tool for generating these documents, especially
6102 given its equation, citation, and figure handling capabilities.
6104 requires version 5.0 (or higher) of these macros; preferably 6.0, which
6105 is the version described here, or higher.
6106 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
6107 2.09 and are fundamentally
6108 incompatible with \SpecialChar LyX
6110 The AAS\SpecialChar TeX
6111 package may be downloaded from the AAS\SpecialChar TeX
6115 \begin_layout Standard
6116 \begin_inset VSpace medskip
6122 \begin_layout Standard
6124 \begin_inset Flex URL
6127 \begin_layout Plain Layout
6129 https://aas.org/aastex/aastex-downloads
6137 \begin_layout Standard
6138 \begin_inset VSpace medskip
6144 \begin_layout Standard
6145 A complete user guide is contained in that package and you should familiarize
6146 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
6149 will not reduce the need to figure out all the AAS\SpecialChar TeX
6150 commands, it will only
6151 reduce the drudgery of typing everything in.
6152 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
6154 completely to the requirements of the journal to which you are submitting
6158 \begin_layout Subsubsection
6159 Starting a New Paper
6162 \begin_layout Standard
6163 I strongly suggest that you start with the AAS\SpecialChar TeX
6167 File\SpecialChar menuseparator
6173 \change_inserted 564990737 1671617265
6174 \SpecialChar menuseparator
6175 Articles\SpecialChar menuseparator
6176 American Astronomical Society
6177 \change_deleted 564990737 1671617310
6180 , enter the new file name, then choose the
6187 This will show the most common fields found in a manuscript.
6188 Simply overwrite the existing text (including the brackets,
6192 ) with the correct information.
6193 Many of the AAS\SpecialChar TeX
6194 commands and environments can be implemented directly in
6197 For commands such as these, the \SpecialChar LaTeX
6198 code must be entered directly and marked
6200 Such commands are referred to as \SpecialChar TeX
6201 code, or Evil Red Text.
6202 I tried to minimize the amount of \SpecialChar TeX
6203 code needed in an AAS\SpecialChar TeX
6207 \begin_layout Subsubsection
6208 Finishing Your Paper
6211 \begin_layout Standard
6212 When the paper is finished to your satisfaction and previews/prints correctly,
6214 \begin_inset Quotes eld
6218 \begin_inset Quotes erd
6221 actions which need to be done before you submit it to the journals.
6225 \begin_layout Enumerate
6226 Export your paper as a \SpecialChar LaTeX
6229 File\SpecialChar menuseparator
6230 Export\SpecialChar menuseparator
6238 \begin_layout Enumerate
6243 file with your favorite text editor
6247 \begin_layout Enumerate
6248 remove the comment lines before the
6257 \begin_layout Enumerate
6262 usepackage...{fontenc}
6264 line if it appears (usually just after
6279 \begin_layout Enumerate
6280 remove everything between (and including) the
6292 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6294 (which should appear immediately after the
6295 \begin_inset Quotes eld
6298 User specified \SpecialChar LaTeX
6300 \begin_inset Quotes erd
6311 \begin_layout Enumerate
6312 Run the resulting file through \SpecialChar LaTeX
6313 to make sure it still processes correctly.
6316 \begin_layout Enumerate
6317 Reread the journal requirements to make sure your filenames and formats
6321 \begin_layout Enumerate
6325 \begin_layout Subsubsection
6326 Comments On Specific Commands
6329 \begin_layout Standard
6330 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6337 ) gives a good description of each.
6338 Thus it's probably easiest for me to go down the list as found in the guide
6339 and offer comments where necessary.
6340 So let's begin \SpecialChar ldots
6344 \begin_layout Paragraph
6345 Things that work as expected
6348 \begin_layout Standard
6349 Because they work as you might expect, I simply list them and the section
6450 begin{thebibliography}
6458 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6459 graphicx figure commands (2.14.1),
6483 (2.15.4, amongst other places),
6510 \begin_layout Standard
6511 The following style options also work correctly:
6532 Simply put them in the
6538 Layout\SpecialChar menuseparator
6544 \begin_layout Paragraph
6545 Things that work, but require more comment
6548 \begin_layout Standard
6549 The following items work, but require a little more discussion:
6552 \begin_layout Itemize
6553 These items are reserved for use by the journal editors, but you can put
6554 them into the \SpecialChar LaTeX
6555 preamble if you feel compelled to do so:
6588 \begin_layout Itemize
6589 These items may be placed in the \SpecialChar LaTeX
6590 preamble, and are included as blanks in
6612 \begin_layout Itemize
6619 (2.3) – can only be used
6620 \begin_inset Quotes eld
6624 \begin_inset Quotes erd
6627 , not in the middle of a paragraph.
6628 Use \SpecialChar TeX
6629 code if you need to embed it.
6632 \begin_layout Itemize
6639 (2.3) – will have extra {} after it.
6640 This should not cause an error.
6643 \begin_layout Itemize
6650 (2.6) – can only be used
6651 \begin_inset Quotes eld
6655 \begin_inset Quotes erd
6658 , not in the middle of a paragraph.
6659 Use \SpecialChar TeX
6660 code if you need to embed it.
6663 \begin_layout Itemize
6670 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6674 \begin_layout Itemize
6688 \begin_layout Itemize
6695 (2.9) – will have extra {} after it.
6696 This should not cause an error.
6699 \begin_layout Itemize
6706 (2.11) – will have extra {} after it.
6707 This should not cause an error.
6710 \begin_layout Itemize
6717 (2.14.2) – you can insert an optional filename argument by placing the cursor
6718 at the beginning of the text and selecting
6720 Insert\SpecialChar menuseparator
6725 \begin_inset Quotes eld
6729 \begin_inset Quotes erd
6732 inserts an optional argument of the type needed by
6739 Hopefully it will be renamed someday.
6742 \begin_layout Itemize
6755 for the catalog ID optional parameter
6758 \begin_layout Itemize
6771 for the catalog ID optional parameter
6774 \begin_layout Paragraph
6775 Things not implemented, use \SpecialChar TeX
6779 \begin_layout Standard
6790 setcounter{equation}
6792 (2.12), Journal name abbreviations (2.13.4),
6828 (2.15.4, insert it as the first element in the lefthand cell after where
6830 Don't use any of \SpecialChar LyX
6831 's rules in the table),
6843 (2.15.5), much of Misc (2.17, except
6894 \begin_layout Paragraph
6895 Things that cannot be implemented
6898 \begin_layout Standard
6900 at least in any meaningful sort of way, so I suggest ignoring them.
6901 They are the references environment (2.13.3), and the deluxetable environment
6903 If you really, really need to use deluxetable, I suggest editing it in
6904 a separate file with a text editor, then using
6906 Insert\SpecialChar menuseparator
6908 \begin_inset space ~
6913 to include it in your \SpecialChar LyX
6916 \change_deleted 564990737 1671642564
6922 \change_inserted 564990737 1671642618
6926 File\SpecialChar menuseparator
6927 Open Example\SpecialChar menuseparator
6928 Articles\SpecialChar menuseparator
6929 American Astronomical Society
6935 \change_inserted 564990737 1671642621
6941 \begin_layout Subsubsection
6942 FAQs, Tips, Tricks, and Other Ruminations
6945 \begin_layout Paragraph
6946 Getting \SpecialChar LyX
6947 and AAS\SpecialChar TeX
6951 \begin_layout Standard
6952 It can be a bit tricky to get \SpecialChar LyX
6953 to recognize a new layout and document class.
6954 When all else fails, do this:
6957 \begin_layout Enumerate
6958 Make certain that \SpecialChar LaTeX
6959 can find AAS\SpecialChar TeX
6961 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6963 directory completely unrelated to \SpecialChar LaTeX
6964 or AAS\SpecialChar TeX
6965 and run \SpecialChar LaTeX
6973 \begin_layout Enumerate
6978 appears in \SpecialChar LyX
6986 \begin_layout Enumerate
6989 Tools\SpecialChar menuseparator
6993 , then restart \SpecialChar LyX
6997 \begin_layout Enumerate
6998 Open a regular new file, not from a template.
6999 Does AAS\SpecialChar TeX
7000 appear in the class list in
7002 Document\SpecialChar menuseparator
7008 \begin_layout Standard
7009 If you get a warning from an existing AAS\SpecialChar TeX
7010 document about not being able
7011 to find the AAS\SpecialChar TeX
7012 layout or a message about
7013 \begin_inset Quotes eld
7016 You should not mix title layouts with normal ones
7017 \begin_inset Quotes erd
7020 , things haven't been installed correctly.
7023 \begin_layout Paragraph
7025 error processing a table
7028 \begin_layout Standard
7030 , by default, attempts to center the table caption/title.
7031 This seems to produce a bad interaction in AAS\SpecialChar TeX
7032 so you should click somewhere
7033 in the caption/title, then select
7035 Edit\SpecialChar menuseparator
7037 \begin_inset space ~
7051 This took care of it for me.
7054 \begin_layout Paragraph
7058 \begin_layout Standard
7059 A couple of things: 1) I have noticed some funny spacing in the reference
7060 entries in the text.
7061 When you enter the bibliography item data, make sure their is
7065 space between the last author and the parenthesis setting off the year;
7069 \begin_inset space \thinspace{}
7073 \begin_inset space \space{}
7087 2) Entering the references at all is not obvious.
7088 The easiest thing is to start typing your first reference at the end of
7089 the document, then mark it as type
7094 That will put a small gray box in front of what you just typed.
7095 Click on the box to fill in the rest of the information.
7096 For new references, go to the end of an existing reference and press return.
7097 That will create a new line with its own box, etc.
7100 \begin_layout Paragraph
7104 \begin_layout Standard
7105 Even though AAS\SpecialChar TeX
7106 provides its own figure commands (
7112 , for example), I much prefer \SpecialChar LaTeX
7113 's standard figure commands (with the default
7122 \begin_inset space ~
7125 commands as \SpecialChar TeX
7126 code into a Figure Float box if you desire, but I never have
7127 much luck getting the layout right.
7128 With the standard graphics, \SpecialChar LyX
7133 usepackage{graphicx}
7135 command into the \SpecialChar LaTeX
7136 preamble and handle the figures in the standard \SpecialChar LaTeX2e
7138 interspersing the figures in the text.
7139 I believe ApJ accepts figures exactly this way now; AJ might still use
7141 \begin_inset Quotes eld
7144 stack everything at the end
7145 \begin_inset Quotes erd
7151 \begin_layout Paragraph
7152 Things I could have done, but didn't
7155 \begin_layout Standard
7157 \begin_inset Quotes eld
7161 \begin_inset Quotes erd
7164 things I could have implemented, but chose not to.
7165 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
7167 even though it is double-spaced in the paper manuscript.
7168 Also, I chose not to make separate layouts for the preprint and preprint2
7170 Since I assume you will spend most of your time in the plain manuscript
7171 mode anyway, I decided not to chew up more disk space with this.
7175 \begin_layout Subsubsection
7179 \begin_layout Standard
7180 Your mileage may vary.
7181 I've now had papers published by both ApJ and AJ that have had 98% of the
7182 effort done in \SpecialChar LyX
7183 ; the last 2% was the \SpecialChar LaTeX
7184 post-processing and a few cleanups.
7185 I have had no trouble with the submission process, and I'm sure the journals
7186 were never aware that there might be a difference.
7187 So, go forth and publish!
7190 \begin_layout Subsection
7192 \change_inserted 564990737 1671442131
7198 \begin_layout Standard
7200 \change_inserted 564990737 1671642768
7206 \begin_inset space \thinspace{}
7215 document class together with the style
7219 to facilitate the description of chess games.
7223 File\SpecialChar menuseparator
7226 \SpecialChar menuseparator
7227 Articles\SpecialChar menuseparator
7246 \begin_layout Subsection
7248 \change_inserted 564990737 1671042028
7254 \begin_layout Standard
7256 \change_inserted 564990737 1671617396
7262 \begin_inset space \thinspace{}
7272 This provides the following additional environments:
7275 \begin_inset space ~
7283 \begin_inset space ~
7291 \begin_inset space ~
7309 A template is available in the menu
7314 ile\SpecialChar menuseparator
7316 \begin_inset space ~
7324 \begin_inset space ~
7329 \SpecialChar menuseparator
7330 Articles\SpecialChar menuseparator
7335 It has been customized with further environments and contains all the informati
7337 However, the documentation is also available from
7338 \begin_inset CommandInset href
7341 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
7349 \begin_layout Subsection
7351 \change_inserted 564990737 1671042046
7357 \begin_layout Standard
7359 \change_inserted 564990737 1671042046
7365 \begin_inset space \thinspace{}
7370 provides an alternative to the
7375 It provides similar functionality, but you might prefer this layout with
7376 sans serif sections, headings, and more.
7379 \begin_layout Subsection
7384 \begin_layout Standard
7390 \begin_layout Standard
7391 \begin_inset VSpace bigskip
7397 \begin_layout Standard
7402 \begin_inset space ~
7407 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7409 \begin_inset Formula $\beta$
7412 release of May, 1999) class.
7415 \begin_layout Standard
7421 textclass, which works with Rev\SpecialChar TeX
7423 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7425 That means that it doesn't interact very well with \SpecialChar LyX
7426 , which requires \SpecialChar LaTeX2e
7428 it has been kludged to work.
7429 Since Rev\SpecialChar TeX
7430 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7437 \begin_inset space ~
7442 textclass should also be pretty easy to use.
7445 \begin_layout Standard
7446 These documents are supposed to be used in
7450 to the Rev\SpecialChar TeX
7451 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7453 and assume you'll know what to put in the preamble if necessary.
7456 \begin_layout Subsubsection
7460 \begin_layout Standard
7461 All you need to do is install Rev\SpecialChar TeX
7462 4, as described in the package's README
7464 The package can be found at The Rev\SpecialChar TeX
7466 \begin_inset Flex URL
7469 \begin_layout Plain Layout
7471 http://publish.aps.org/revtex4/
7477 Install it somewhere that \SpecialChar LaTeX
7479 Test it by trying to \SpecialChar LaTeX
7480 a short Rev\SpecialChar TeX
7481 4 document in some random directory (i.
7482 \begin_inset space \thinspace{}
7486 \begin_inset space \space{}
7489 not the directory where you installed the class file.) Then, if you reconfigure
7491 , it will find the class file and let you use the Rev\SpecialChar TeX
7495 \begin_layout Standard
7496 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7505 \begin_inset space ~
7510 template, found in the templates directory.
7513 \begin_layout Subsubsection
7517 \begin_layout Standard
7518 Optional arguments to
7525 \begin_inset Quotes eld
7529 \begin_inset Quotes erd
7533 \begin_inset Quotes eld
7537 \begin_inset Quotes erd
7543 \begin_inset space ~
7551 \begin_inset space ~
7557 Remember that in Rev\SpecialChar TeX
7558 , at least one optional argument is required!
7561 \begin_layout Standard
7562 Other preamble matter, like
7569 \begin_inset space ~
7576 \begin_inset space ~
7581 dialog, also as usual.
7584 \begin_layout Subsubsection
7588 \begin_layout Standard
7589 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7591 For example, the Email layout corresponds to
7598 Note that (at least as of Rev\SpecialChar TeX
7607 layouts are exactly equivalent, so you shouldn't need to use both.
7611 \begin_layout Plain Layout
7612 In case you're curious, both were included so that
7616 would be able to translate both
7636 \begin_layout Subsubsection
7640 \begin_layout Standard
7641 There are a couple of important unique aspects of Rev\SpecialChar TeX
7643 bugs that will be even more confusing in \SpecialChar LyX
7647 \begin_layout Standard
7648 In Rev\SpecialChar TeX
7666 The \SpecialChar LyX
7667 equivalent is that there is a separate Thanks layout.
7672 write footnotes in the
7676 layout, or weird things may happen.
7677 See the Rev\SpecialChar TeX
7678 4 documentation for more details.
7681 \begin_layout Standard
7685 \begin_inset space ~
7693 \begin_inset space ~
7702 layouts must be placed
7710 layout and the corresponding
7727 , the \SpecialChar LaTeX
7731 \begin_layout Subsection
7733 \change_inserted 564990737 1671042072
7739 \begin_layout Standard
7741 \change_inserted 564990737 1671042072
7748 classes were replaced in 2013 with a completely new
7753 This package provides a \SpecialChar LaTeX
7754 class and templates for books to be published
7755 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7756 Research, Springer VS Research, or Springer VS Forschung.
7757 The documentation is available in German from
7758 \begin_inset CommandInset href
7761 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7769 \begin_layout Section
7771 \change_inserted 564990737 1670439560
7775 \begin_layout Standard
7777 \change_inserted 564990737 1670439581
7778 See also the document classes in the Collections (section
7779 \begin_inset space ~
7783 \begin_inset CommandInset ref
7785 reference "sec:Collections"
7792 \begin_layout Subsection
7796 \begin_layout Standard
7802 \begin_layout Subsubsection
7806 \begin_layout Standard
7807 Memoir is a very powerful and constantly evolving class.
7808 It has been designed with regard to fictional and non-fictional literature.
7809 Its aim is to let the user have maximum control over the typesetting of
7811 Memoir is based on the standard book class, but it can also emulate the
7812 article class (see below).
7815 \begin_layout Standard
7816 Peter Wilson, the developer of Memoir, is known as the author of lots of
7817 useful packages in the \SpecialChar LaTeX
7819 Most of them have been merged with Memoir.
7820 Therefore, it is much easier to layout the table of contents, appendices,
7821 chapter designs and such.
7823 , though, does not support all of these goodies natively.
7824 Some of them might be added to forthcoming releases
7828 \begin_layout Plain Layout
7829 You are invited to send suggestions to
7830 \begin_inset Flex URL
7833 \begin_layout Plain Layout
7835 lyx-devel@lists.lyx.org
7845 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7847 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7849 commands (\SpecialChar TeX
7854 \begin_layout Plain Layout
7859 \begin_layout Plain Layout
7869 \begin_inset space ~
7873 \begin_inset CommandInset ref
7875 reference "sec:Inserting-TeX-Code"
7885 In this section, we can only list those features that are natively supported
7888 For detailed descriptions (and for the rest of features) we recommend you
7889 have a look at the detailed manual of the Memoir class
7893 \begin_layout Plain Layout
7898 \begin_layout Plain Layout
7908 \begin_inset Flex URL
7911 \begin_layout Plain Layout
7913 CTAN:/macros/latex/memoir/memman.pdf
7923 , which is not only a user guide for the class, but also both a comprehensive
7924 description on good typesetting and a superb example for good typesetting
7928 \begin_layout Subsubsection
7929 Basic features and restrictions
7932 \begin_layout Standard
7933 Memoir supports basically all features of the standard book classes.
7934 There are, however, some differences, as follows:
7937 \begin_layout Description
7939 \begin_inset space ~
7942 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7945 \begin_layout Description
7947 \begin_inset space ~
7950 style: The fancy page style is not supported, due to a command clash between
7951 Memoir and the fancyhdr package (they both define a command with the same
7952 name, which confuses \SpecialChar LaTeX
7954 Instead, Memoir comes with a number of its own page styles (see
7956 Document\SpecialChar menuseparator
7957 Settings\SpecialChar menuseparator
7959 \begin_inset space ~
7965 If you want to use these for the chapter pages, you have to use the command
7972 in the main text or in preamble (e.
7973 \begin_inset space \thinspace{}
7977 \begin_inset space \space{}
7984 chapterstyle{companion}
7989 \begin_layout Description
7990 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7991 optional argument in the standard classes.
7992 With this, you can specify an alternative version of the title for the
7993 table of contents and the headers (for instance, if the title is too long).
7995 , you can do this via
7997 Insert\SpecialChar menuseparator
7999 \begin_inset space ~
8004 at the beginning of a chapter/section.
8005 Memoir features a second optional argument and thus separates the table
8006 of contents from the header.
8007 You can define three variants of a title with this: one for the main text,
8008 one for the table of contents, and one for the headers.
8010 makes these available in form of specific
8021 \begin_layout Description
8022 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
8023 of contents, the list of figures and the list of table start a new page
8025 Memoir does not follow this route.
8026 You have to insert a page break yourself, if you want to have one.
8029 \begin_layout Description
8030 Titlepage: For some unknown reason, Memoir uses pagination on the title
8031 page (in the standard classes, title pages are
8032 \begin_inset Quotes eld
8036 \begin_inset Quotes erd
8040 If you want an empty title page, type
8044 aliaspagestyle{title}{empty}
8049 \begin_layout Description
8050 Article: With the class option
8056 Document\SpecialChar menuseparator
8057 Settings\SpecialChar menuseparator
8058 Class Settings\SpecialChar menuseparator
8060 \begin_inset space ~
8065 ), you can emulate article style.
8066 That is, counters (footnotes, figures, tables etc.) will not be reset on
8067 new chapters, chapters don't start a new page (but are—in contrary to
8068 \begin_inset Quotes eld
8072 \begin_inset Quotes erd
8075 article classes—still allowed), parts, though, use their own page, as in
8079 \begin_layout Description
8080 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
8081 font commands, which have been used in the old \SpecialChar LaTeX
8083 \begin_inset space \thinspace{}
8087 \begin_inset space \space{}
8103 It produces an error and stops \SpecialChar LaTeX
8104 whenever such a command appears.
8109 reallows the commands and spits out warnings instead (which does at least
8110 not stop \SpecialChar LaTeX
8112 Since a lot of packages and particularly Bib\SpecialChar TeX
8113 style files are still using
8114 those commands, we have decided to use this option by default.
8117 \begin_layout Subsubsection
8121 \begin_layout Standard
8122 We will only describe the features supported by \SpecialChar LyX
8123 (which is not much currently).
8124 Please consult the Memoir manual
8128 \begin_layout Plain Layout
8133 \begin_layout Plain Layout
8143 \begin_inset Flex URL
8146 \begin_layout Plain Layout
8148 CTAN:/macros/latex/memoir/memman.pdf
8161 \begin_layout Description
8162 Abstract: You may wonder why an abstract is an extra feature.
8163 Well, it is in book class.
8164 Usually books don't have abstracts.
8165 Memoir, however, has.
8166 You can use it wherever and how often you like.
8169 \begin_layout Description
8170 Chapterprecis: You may know this older typesetting style: The contents of
8171 a chapter are summarized below the title and also in the table of contents
8173 \begin_inset space \thinspace{}
8177 \begin_inset space \space{}
8182 Our hero arrives in Troia; he loses some friends; he finds others
8185 Chapterprecis does exactly this.
8186 It is therefore only sensible below a chapter.
8189 \begin_layout Description
8190 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
8191 The epigraph environment provides an elegant way of typesetting such a
8193 The motto itself (text) and its (optional) author (source) are divided
8195 The author (source) can be inserted via
8197 Insert\SpecialChar menuseparator
8204 \begin_layout Description
8205 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
8206 complex figurative poems).
8208 can only support a few of them.
8209 One is poemtitle, which is a centered title for poems, which will also
8210 be added to the table of contents (verse is the standard environment for
8212 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
8214 because they have to be nested inside regular verse environments, which
8215 is not possible with \SpecialChar LyX
8219 \begin_layout Description
8220 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
8223 \begin_layout Subsection
8225 \change_inserted 564990737 1671442175
8231 \begin_layout Standard
8233 \change_inserted 564990737 1671442175
8243 \begin_inset space \thinspace{}
8248 document class but adds two environments:
8251 \begin_layout Description
8253 \change_inserted 564990737 1671442175
8256 Recipe a numbered section environment at the
8260 level which generates a bold centered heading above a double horizontal
8264 \begin_layout Description
8266 \change_inserted 564990737 1671442175
8279 are what are being described and the environment ends with a horizontal
8283 \begin_layout Standard
8285 \change_inserted 564990737 1671642866
8289 File\SpecialChar menuseparator
8290 Open Example\SpecialChar menuseparator
8291 Books\SpecialChar menuseparator
8295 illustrates its use.
8298 \begin_layout Standard
8300 \change_inserted 564990737 1671442175
8303 It is designed for typesetting one or two recipes per page, with dimensions
8305 \begin_inset Quotes qrd
8309 \begin_inset Quotes qrd
8313 The hyperlinked table of contents (ToC) and page numbers make browsing
8314 recipes convenient, and the pages can be joined together or printed 2 per
8315 page to normal letterpaper easily.
8316 The size was chosen to work in half-page 3-ring binder cover sheets, because
8317 un-laminated paper just doesn't last in the kitchen.
8320 \begin_layout Standard
8322 \change_inserted 564990737 1671442175
8325 The half-letter pages can be printed two per page using your printer driver,
8326 or bound together using
8328 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
8338 is the compiled version of your recipes.
8341 \begin_layout Section
8343 \change_inserted 564990737 1671442207
8347 \begin_layout Subsection
8349 \change_inserted 564990737 1671442208
8355 \begin_layout Standard
8357 \change_inserted 564990737 1671642942
8363 \begin_inset space \space{}
8367 \begin_inset space \thinspace{}
8376 document class, an unofficial implementation of the ‘Europass CV’ recommended
8377 by the European Commission in 2013.
8381 File\SpecialChar menuseparator
8382 Open Example\SpecialChar menuseparator
8383 Curricula Vitae\SpecialChar menuseparator
8387 offers guidance on its use.
8388 Its documentation is available from
8389 \begin_inset CommandInset href
8392 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
8400 \begin_layout Subsection
8402 \change_inserted 564990737 1671442208
8408 \begin_layout Standard
8410 \change_inserted 564990737 1671642984
8416 \begin_inset space \space{}
8420 \begin_inset space \thinspace{}
8429 document class, an unofficial implementation of the “Europass CV” recommended
8430 by the European Commission in 2002.
8434 File\SpecialChar menuseparator
8435 Open Example\SpecialChar menuseparator
8436 Curricula Vitae\SpecialChar menuseparator
8440 offers guidance on its use.
8441 Its documentation is available from
8442 \begin_inset CommandInset href
8445 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
8453 \begin_layout Subsection
8455 \change_inserted 564990737 1671442208
8461 \begin_layout Standard
8463 \change_inserted 564990737 1671643003
8469 \begin_inset space \space{}
8473 \begin_inset space \thinspace{}
8483 This allows the creation of customizable CVs.
8487 File\SpecialChar menuseparator
8488 Open Example\SpecialChar menuseparator
8489 Curricula Vitae\SpecialChar menuseparator
8493 offers guidance on its use.
8494 Its documentation is available from
8495 \begin_inset CommandInset href
8498 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
8506 \begin_layout Subsection
8508 \change_inserted 564990737 1671442208
8514 \begin_layout Standard
8516 \change_inserted 564990737 1671643024
8522 \begin_inset space \space{}
8526 \begin_inset space \thinspace{}
8535 document class, originally developed for use with \SpecialChar LyX
8540 File\SpecialChar menuseparator
8541 Open Example\SpecialChar menuseparator
8542 Curricula Vitae\SpecialChar menuseparator
8546 offers guidance on its use.
8547 Its documentation is available from
8548 \begin_inset CommandInset href
8551 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
8559 \begin_layout Section
8561 \change_inserted 564990737 1671041968
8565 \begin_layout Subsection
8567 \change_inserted 564990737 1671041970
8573 \begin_layout Standard
8575 \change_inserted 564990737 1671617528
8586 document class for writing letters according to the
8588 Deutsches Institut für Normung
8591 The file in the menu
8596 ile\SpecialChar menuseparator
8598 \begin_inset space ~
8606 \begin_inset space ~
8609 Template\SpecialChar menuseparator
8610 Letters\SpecialChar menuseparator
8613 offers guidance on its use.
8614 The documentation is available from
8615 \begin_inset CommandInset href
8618 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8626 \begin_layout Subsection
8628 \change_inserted 564990737 1671458835
8634 \begin_layout Standard
8636 \change_inserted 564990737 1671617591
8647 document class for English letters and to create mailing labels.
8648 The file in the menu
8653 ile\SpecialChar menuseparator
8655 \begin_inset space ~
8663 \begin_inset space ~
8666 Template\SpecialChar menuseparator
8667 Letters\SpecialChar menuseparator
8668 Letter (Standard Class)
8670 offers guidance on its use.
8673 \begin_layout Section
8675 \change_inserted 564990737 1670439660
8679 \begin_layout Subsection
8681 \change_inserted 564990737 1671458922
8687 \begin_layout Standard
8689 \change_inserted 564990737 1671617655
8695 \begin_inset space \thinspace{}
8704 document class for creating presentations.
8705 The file in the menu
8710 ile\SpecialChar menuseparator
8712 \begin_inset space ~
8720 \begin_inset space ~
8723 Template\SpecialChar menuseparator
8724 Presentations\SpecialChar menuseparator
8727 offers guidance on its use.
8728 The documentation is available from
8729 \begin_inset CommandInset href
8732 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
8740 \begin_layout Subsection
8743 Foil\SpecialChar TeX
8747 \begin_inset CommandInset label
8756 \begin_layout Standard
8762 \begin_layout Subsubsection
8766 \begin_layout Standard
8767 This section describes how to use \SpecialChar LyX
8768 to make slides for overhead projectors.
8769 There are two document classes that can do this: the default slides class
8772 Foil\SpecialChar TeX
8776 This section documents the latter.
8779 \begin_layout Standard
8780 I'm going to say this again, nice and clear, so that there's no misunderstanding
8784 \begin_layout Standard
8785 \begin_inset VSpace bigskip
8791 \begin_layout Standard
8795 This section documents the class
8796 \begin_inset Quotes eld
8804 \begin_inset Quotes erd
8812 \begin_layout Standard
8813 \begin_inset VSpace bigskip
8819 \begin_layout Standard
8820 If you're looking for the documentation for
8821 \begin_inset Quotes eld
8829 \begin_inset Quotes erd
8833 \begin_inset space ~
8837 \begin_inset CommandInset ref
8839 reference "sec:slitex"
8844 If your machine doesn't have the
8852 installed, you'll probably have to use the default
8856 class, which isn't quite as good as
8861 \begin_layout Standard
8866 class is designed for use with version
8867 \begin_inset space ~
8875 class file which is now an integral part of \SpecialChar LaTeX2e
8879 \begin_layout Subsubsection
8883 \begin_layout Standard
8884 Obviously, to use this document class, you need to select
8895 \begin_inset space ~
8901 There are some settings in the
8904 \begin_inset space ~
8909 dialog that you should know about that are specific to this class:
8912 \begin_layout Itemize
8913 Don't change the options
8924 \begin_inset space ~
8930 They're ignored by the
8937 \begin_layout Itemize
8938 The default font size is 20
8939 \begin_inset space \thinspace{}
8942 pt with the other options being 17
8943 \begin_inset space \thinspace{}
8947 \begin_inset space \thinspace{}
8951 \begin_inset space \thinspace{}
8957 \begin_layout Itemize
8966 but all math equations are still typeset in the usual roman font.
8969 \begin_layout Itemize
8972 Foil\SpecialChar TeX
8975 supports A4 and Letter paper sizes as well as a special size for working
8977 \begin_inset space \thinspace{}
8981 It doesn't support A5, B5, legal or executive paper sizes.
8984 \begin_layout Itemize
8985 Don't bother changing the
8989 settings because they are ignored anyway.
8990 All floats appear where they are defined in the text.
8993 \begin_layout Itemize
8998 setting behaves a bit differently for this class.
9001 Foil\SpecialChar TeX
9004 provides extensive footer and header capabilities including a user-defined
9007 \begin_inset space ~
9011 \begin_inset CommandInset ref
9013 reference "sec:foilfoot"
9018 The title page is treated differently to all other pages in the document
9027 has the logo centered at the bottom of the page (if one is defined).
9028 The possible page style choices and what they do are as follows:
9032 \begin_layout Labeling
9033 \labelwidthstring MMMMMMM
9040 The final output contains no page numbers, or other headers or footers
9041 (except footnotes of course).
9045 \begin_layout Labeling
9046 \labelwidthstring MMMMMMM
9053 The final output contains page numbers centered at the bottom of the page.
9054 No other headings or footers (other than footnotes).
9057 \begin_layout Labeling
9058 \labelwidthstring MMMMMMM
9063 Page numbers in lower right corner.
9064 Additional headers and footers are also shown.
9065 This is also the default.
9068 \begin_layout Labeling
9069 \labelwidthstring MMMMMMM
9074 Gives you access to the
9078 package although its use with
9080 Foil\SpecialChar TeX
9083 is discouraged by the writer of the
9085 Foil\SpecialChar TeX
9088 package because of some potential page layout clashes.
9092 \begin_layout Paragraph
9096 \begin_layout Standard
9097 The following options may be used in the extra class options in the
9099 Document\SpecialChar menuseparator
9105 \begin_layout Labeling
9106 \labelwidthstring MMMMMMx
9111 This sets up the page layout for 7.33
9112 \begin_inset space \thinspace{}
9116 \begin_inset space \thinspace{}
9119 in paper, which is about the same aspect ratio as a 35
9120 \begin_inset space \thinspace{}
9123 mm slide, making it a bit easier to work with this medium.
9126 \begin_layout Labeling
9127 \labelwidthstring MMMMMMx
9132 Places a rule across the page below the header on every page except the
9136 \begin_layout Labeling
9137 \labelwidthstring MMMMMMx
9142 Places a rule across the page above the footer on every page except the
9146 \begin_layout Labeling
9147 \labelwidthstring MMMMMMx
9152 This is automatically set each time you create a new
9159 Foil\SpecialChar TeX
9162 to use the dvips driver to rotate those pages that are set as landscape
9166 \begin_layout Labeling
9167 \labelwidthstring MMMMMMx
9172 Simply changes the page dimensions to those of a landscape page but doesn't
9174 Thus if you use this option you need to use an external program to rotate
9175 each page or feed your paper through your printer as landscape.
9176 Note that this option effectively reverses the roles of the
9184 environments (don't worry these are described in the next section).
9187 \begin_layout Labeling
9188 \labelwidthstring MMMMMMx
9193 Equation numbers on the left.
9196 \begin_layout Labeling
9197 \labelwidthstring MMMMMMx
9202 Flush-left equations.
9205 \begin_layout Subsubsection
9206 Supported Environments
9209 \begin_layout Standard
9210 Most of the environments commonly supported in other classes are also supported
9216 There are several additional environments provided by
9218 Foil\SpecialChar TeX
9221 as well as a couple added by \SpecialChar LyX
9223 The following environments are shared with other classes:
9226 \begin_layout Standard
9227 \begin_inset Flex Multiple Columns
9230 \begin_layout Itemize
9236 \begin_layout Itemize
9242 \begin_layout Itemize
9248 \begin_layout Itemize
9254 \begin_layout Itemize
9260 \begin_layout Itemize
9267 \begin_layout Itemize
9273 \begin_layout Itemize
9279 \begin_layout Itemize
9285 \begin_layout Itemize
9291 \begin_layout Itemize
9297 \begin_layout Itemize
9303 \begin_layout Itemize
9309 \begin_layout Itemize
9315 \begin_layout Itemize
9326 \begin_layout Standard
9327 That is, all the major environments apart from the sectioning environments.
9328 Since foils are essentially self-contained sections, with a title and body,
9331 Foil\SpecialChar TeX
9334 provides specific commands for starting new foils and these are:
9337 \begin_layout Itemize
9343 \begin_layout Itemize
9349 \begin_layout Standard
9351 also provides slightly modified versions of these two environments called:
9354 \begin_layout Itemize
9360 \begin_layout Itemize
9366 \begin_layout Standard
9367 and the differences will be explained in the next section.
9370 \begin_layout Standard
9371 Since foils are often used in presenting ideas or new theorems and such
9374 Foil\SpecialChar TeX
9377 also provides a comprehensive box of goodies for presenting them:
9380 \begin_layout Standard
9381 \begin_inset Flex Multiple Columns
9384 \begin_layout Itemize
9390 \begin_layout Itemize
9396 \begin_layout Itemize
9402 \begin_layout Itemize
9408 \begin_layout Itemize
9414 \begin_layout Itemize
9420 \begin_layout Itemize
9426 \begin_layout Itemize
9432 \begin_layout Itemize
9438 \begin_layout Itemize
9444 \begin_layout Itemize
9455 \begin_layout Standard
9456 The starred versions are unnumbered while the unstarred versions are numbered.
9457 There are also two list environments added by \SpecialChar LyX
9461 \begin_layout Itemize
9467 \begin_layout Itemize
9473 \begin_layout Standard
9476 Foil\SpecialChar TeX
9479 provides some powerful header and footer capabilities that are best set
9480 in the preamble although they may be set at any point in a document.
9481 If you want to change these settings in your document the best place to
9482 do so is at the very top of a foil, i.
9483 \begin_inset space \thinspace{}
9489 \begin_inset space \space{}
9494 straight after the foilhead.
9497 \begin_layout Standard
9498 For this purpose, the following command styles are provided [
9505 \begin_layout Standard
9506 \begin_inset Flex Multiple Columns
9509 \begin_layout Itemize
9513 \begin_inset space ~
9519 \begin_layout Itemize
9525 \begin_layout Itemize
9529 \begin_inset space ~
9535 \begin_layout Itemize
9539 \begin_inset space ~
9545 \begin_layout Itemize
9549 \begin_inset space ~
9556 \begin_layout Plain Layout
9557 \begin_inset space ~
9569 \begin_layout Standard
9570 There are also a few commands provided by
9572 Foil\SpecialChar TeX
9575 that aren't directly supported by \SpecialChar LyX
9576 but I'll tell you what they do and how
9577 to use them in section
9578 \begin_inset space ~
9582 \begin_inset CommandInset ref
9584 reference "sec:unsuppfoils"
9591 \begin_layout Subsubsection
9592 Building a Set of Foils
9595 \begin_layout Standard
9596 This section will give a simple introduction to using the different environments
9597 to build a set of foils.
9598 If you want to see an example set of foils, take a look at
9599 \change_deleted 564990737 1671643085
9604 file you find in \SpecialChar LyX
9610 \change_inserted 564990737 1671643099
9614 File\SpecialChar menuseparator
9617 \SpecialChar menuseparator
9618 Presentations\SpecialChar menuseparator
9626 \begin_layout Paragraph
9627 Give It a Title Page
9630 \begin_layout Standard
9631 Unlike other classes that provide
9651 creates the title on a page of its own.
9652 If you leave out the
9656 environment \SpecialChar LaTeX
9657 will substitute the current date (every time you regenerate
9661 \begin_layout Paragraph
9665 \begin_layout Standard
9666 As I mentioned earlier, there are four ways of starting a new foil.
9667 For portrait foils you should use
9676 The difference between these two environments is the amount of space between
9677 the title of the foil (the foilhead) and the body of the foil.
9680 \begin_layout Standard
9681 Landscape foils are generated using the
9690 Again the only difference is the spacing between foilhead and body.
9691 Both of the short versions have 0.5
9692 \begin_inset space ~
9695 inches less separation between the foilhead and the body.
9699 \begin_layout Standard
9700 One problem with the support for landscape foils is the requirement that
9705 driver to generate the PostScript output otherwise the foils won't be rotated.
9706 It is possible to get landscape foils even if you haven't got the
9710 driver provided you can feed your foils sideways through your printer ;-)
9713 \begin_layout Paragraph
9714 Theorems, Lemmas, Proofs and more
9717 \begin_layout Standard
9718 You can't have two of the same type of these environments directly following
9720 If you use a normal paragraph break, , you will just be extending the previous
9721 environment as if you had merged the two environments together.
9722 Rather than that, you need to insert a so-called separator.
9723 Please refer to the section entitled
9734 \begin_layout Paragraph
9738 \begin_layout Standard
9739 You get all the commonly supported list styles found in other classes as
9740 well as two new ones.
9741 I'll only describe the new ones here.
9742 If you want to find out more about the other list environments check out
9748 If you intend to use itemized lists you might also want to read about the
9752 \begin_inset space ~
9756 \begin_inset space ~
9761 dialog described above in section
9762 \begin_inset space ~
9766 \change_inserted 564990737 1671355684
9768 \begin_inset CommandInset ref
9770 reference "chap:bullets"
9775 \change_deleted 564990737 1671355684
9777 \begin_inset CommandInset ref
9779 reference "sec:bullet"
9788 \begin_layout Standard
9789 The two new list styles,
9797 , are designed to make it easier for you to create lists of do's and don'ts
9798 or right and wrong by providing dedicated environments that use a tick
9799 or a cross as the label of the list.
9800 These lists are in fact dedicated variants of the
9805 They do however require that you have the
9812 \begin_layout Paragraph
9816 \begin_layout Standard
9819 Foil\SpecialChar TeX
9822 redefines the floating tables and figures so that they appear exactly where
9823 they are in the text rather than pushing them to the top of the page or
9824 to some user specified location.
9825 In fact if you change the float placement settings they are simply ignored.
9828 \begin_layout Paragraph
9829 Page Headers and Footers
9830 \begin_inset CommandInset label
9839 \begin_layout Standard
9843 \begin_inset space ~
9852 are two commands used to control the left-footer text string.
9853 The first is meant to allow you to include a graphic logo on your foils
9855 \begin_inset Quotes eld
9860 Foil\SpecialChar TeX
9864 \begin_inset Quotes erd
9868 While the second is meant to provide a classification for the audience,
9872 \begin_inset space \thinspace{}
9878 \begin_inset space \space{}
9882 It is empty by default.
9885 \begin_layout Standard
9886 The remaining page corners can be filled by
9889 \begin_inset space ~
9894 (which defaults to page numbers),
9897 \begin_inset space ~
9905 \begin_inset space ~
9913 \begin_layout Subsubsection
9916 Foil\SpecialChar TeX
9920 \begin_inset CommandInset label
9922 name "sec:unsuppfoils"
9929 \begin_layout Standard
9930 All the commands mentioned below need to be set in a
9940 within another environment.
9943 \begin_layout Paragraph
9947 \begin_layout Standard
9948 All lengths are adjusted using the
9971 should be replaced by the name given to the length you want to change and
9976 is the length value.
9977 All lengths should be specified in units of length such as inches (
9989 ) or relative to some document or font-based length such as
9999 \begin_layout Standard
10000 It's possible to change the spacing between a foilhead and the body of the
10001 foil by adjusting the length specified by
10008 For example, to make
10013 \begin_inset space \space{}
10016 in closer to their bodies put the following in the preamble:
10022 foilheadskip}{-0.5in}
10025 \begin_layout Standard
10026 The spacings around floats can be adjusted by setting these lengths:
10029 \begin_layout Labeling
10030 \labelwidthstring MMMMMMMMMMM
10037 Separation between the text and the top of the float
10040 \begin_layout Labeling
10041 \labelwidthstring MMMMMMMMMMM
10048 Separation between the float and the caption
10051 \begin_layout Labeling
10052 \labelwidthstring MMMMMMMMMMM
10059 Separation between the caption and the following text
10062 \begin_layout Labeling
10063 \labelwidthstring MMMMMMMMMMM
10070 You can make the captions narrower than the surrounding text by adjusting
10072 Best done relative to
10081 \begin_layout Standard
10082 There are also several title page related lengths that you may find useful
10083 if you have a long title or several authors:
10086 \begin_layout Labeling
10087 \labelwidthstring MMMMMMMMMMM
10094 Separation from headers to
10099 \begin_layout Labeling
10100 \labelwidthstring MMMMMMMMMMM
10118 \begin_layout Labeling
10119 \labelwidthstring MMMMMMMMMMM
10133 \begin_layout Labeling
10134 \labelwidthstring MMMMMMMMMMM
10150 \begin_layout Labeling
10151 \labelwidthstring MMMMMMMMMMM
10167 \begin_layout Standard
10168 The last length related command affects all the list environments.
10179 a list environment then all the vertical spacing between the list items
10181 Note that this is a command not a length so it doesn't require
10187 like the stuff mentioned above.
10190 \begin_layout Paragraph
10191 Headers and Footers
10194 \begin_layout Standard
10207 commands control whether the logo in the
10211 definition appear on a given page.
10218 in the preamble then none of the foils will have the logo on them.
10219 If you don't want the logo on a particular page place the
10225 directly after the foilhead of that page and the
10231 directly after the next foilhead.
10234 \begin_layout Standard
10235 If you decide to use the
10239 page style setting in the
10242 \begin_inset space ~
10247 dialog you should probably add
10257 to your preamble so headers and footers on landscape pages are correctly
10258 placed when rotated.
10259 This is due to some clashes between the page layouts provided by the
10270 \begin_layout Subsection
10272 \change_inserted 564990737 1671459032
10278 \begin_layout Standard
10280 \change_inserted 564990737 1671643165
10286 \begin_inset space \thinspace{}
10295 document class for creating presentations.
10299 File\SpecialChar menuseparator
10300 Open Example\SpecialChar menuseparator
10301 Presentations\SpecialChar menuseparator
10305 offers guidance on its use.
10306 The documentation is available from
10307 \begin_inset CommandInset href
10310 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
10318 \begin_layout Subsection
10320 \change_inserted 564990737 1671459032
10323 \begin_inset CommandInset label
10325 name "subsec:Seminar"
10334 \begin_layout Standard
10336 \change_inserted 564990737 1671643194
10342 \begin_inset space \thinspace{}
10351 document class for creating presentations.
10355 File\SpecialChar menuseparator
10356 Open Example\SpecialChar menuseparator
10357 Presentations\SpecialChar menuseparator
10361 offers guidance on its use.
10362 The documentation is available from
10363 \begin_inset CommandInset href
10366 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
10374 \begin_layout Subsection
10377 Sli\SpecialChar TeX
10381 \begin_inset CommandInset label
10390 \begin_layout Standard
10398 \begin_layout Subsubsection
10402 \begin_layout Standard
10403 This section describes how to use \SpecialChar LyX
10404 to make slides for overhead projectors.
10405 There are two document classes that can do this: the default slides class
10408 Foil\SpecialChar TeX
10412 This section documents the former.
10415 \begin_layout Standard
10416 I'm going to say this again, nice and clear, so that there's no misunderstanding
10420 \begin_layout Standard
10421 \begin_inset VSpace bigskip
10427 \begin_layout Standard
10431 This section documents the class
10432 \begin_inset Quotes eld
10440 \begin_inset Quotes erd
10448 \begin_layout Standard
10449 \begin_inset VSpace bigskip
10455 \begin_layout Standard
10456 If you're looking for the documentation for
10457 \begin_inset Quotes eld
10462 slides (Foil\SpecialChar TeX
10466 \begin_inset Quotes erd
10469 , check out section
10470 \begin_inset space ~
10474 \begin_inset CommandInset ref
10476 reference "sec:foiltex"
10486 \begin_inset Quotes eld
10491 slides (Foil\SpecialChar TeX
10495 \begin_inset Quotes erd
10498 ] is actually somewhat better than the default
10506 \begin_layout Plain Layout
10508 or so I've been told repeatedly by its advocates.
10509 Having never used it, I have no idea if this claim is true or not.
10514 which this section documents.
10517 \begin_layout Standard
10518 This class is the \SpecialChar LaTeX2e
10519 improvement of the old
10521 Sli\SpecialChar TeX
10525 Every \SpecialChar LaTeX2e
10526 distribution includes this class [which I'll just refer to as
10527 \begin_inset Quotes eld
10535 \begin_inset Quotes erd
10538 from now on], so you're bound to have it.
10539 As I noted earlier, there are other classes, such as
10543 , which also produce slides for overhead projectors and do a better job
10545 However, there are some things which
10549 can do which the others can't, such as generate overlays.
10550 Read on to learn more!
10553 \begin_layout Subsubsection
10555 \begin_inset CommandInset label
10557 name "sec:slidesetup"
10564 \begin_layout Standard
10565 Obviously, to use this document class, you need to select
10566 \begin_inset Quotes eld
10574 \begin_inset Quotes erd
10577 from the class list in the
10579 Document\SpecialChar menuseparator
10583 There are some other special things you should know about this class:
10586 \begin_layout Itemize
10587 Don't bother changing the options
10592 They're not supported by the
10599 \begin_layout Itemize
10603 \begin_inset space ~
10608 behaves a bit differently for this class.
10609 The possible choices and what they do are as follows:
10613 \begin_layout Description
10618 The final output contains page numbers in the lower right corner.
10621 \begin_layout Description
10630 , but also prints out any time markers you've put in.
10631 This is the default.
10634 \begin_layout Description
10639 The final output contains no page numbers, time markers, or alignment markers.
10643 \begin_layout Itemize
10648 class has an extra option:
10654 \begin_inset Quotes eld
10662 \begin_inset Quotes erd
10665 in the extra class options.
10669 \begin_layout Standard
10670 Using this options allows you to add time markers to
10676 \begin_inset space ~
10680 \begin_inset CommandInset ref
10682 reference "sec:slideNote"
10690 \begin_layout Standard
10691 You can also use the template file
10692 \change_deleted 564990737 1671617694
10694 \begin_inset Quotes eld
10702 \begin_inset Quotes erd
10707 to automatically set up a document to use the
10712 \change_deleted 564990737 1671617699
10717 File\SpecialChar menuseparator
10719 \begin_inset space ~
10723 \begin_inset space ~
10727 \change_inserted 564990737 1671617723
10728 \SpecialChar menuseparator
10729 Presentations\SpecialChar menuseparator
10734 to open your new document
10735 \change_deleted 564990737 1671617728
10739 The template file also contains some examples of the special paragraph
10740 environments used by this class.
10741 I'll describe those next.
10744 \begin_layout Subsubsection
10745 Paragraph Environments
10748 \begin_layout Paragraph
10749 Supported Environments
10752 \begin_layout Standard
10753 The first thing you'll notice when you start up a new
10757 document is the font size and type: it's the equivalent of the size
10758 \begin_inset Quotes eld
10766 \begin_inset Quotes erd
10772 \begin_inset space ~
10778 This is also what's used in the output.
10780 \begin_inset Quotes eld
10784 \begin_inset Quotes erd
10787 to remind you that this is a slide.
10788 Your final slides will use a larger font; ergo, you'll have less space.
10789 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10792 \begin_layout Standard
10793 The next thing that becomes obvious is the changes to the paragraph environment
10794 pull-down box [at the far-left end of the toolbar].
10795 Most of the paragraph environments you're used to seeing are missing.
10796 There are also five new ones.
10801 class itself only supports certain paragraph environments:
10804 \begin_layout Itemize
10810 \begin_layout Itemize
10816 \begin_layout Itemize
10822 \begin_layout Itemize
10828 \begin_layout Itemize
10834 \begin_layout Itemize
10840 \begin_layout Itemize
10846 \begin_layout Itemize
10852 \begin_layout Itemize
10858 \begin_layout Itemize
10865 \begin_layout Standard
10866 All of the other standard environments, including the section-heading environmen
10867 ts, aren't used in the
10874 \begin_layout Standard
10875 On the other hand, you'll notice the following new environments:
10878 \begin_layout Itemize
10884 \begin_layout Itemize
10890 \begin_layout Itemize
10896 \begin_layout Itemize
10902 \begin_layout Itemize
10908 \begin_layout Standard
10909 These five are kind of quirky, due to a
10910 \begin_inset Quotes eld
10914 \begin_inset Quotes erd
10917 in \SpecialChar LyX
10919 You see, \SpecialChar LyX
10920 doesn't permit you to nest any other paragraph environment into
10921 an empty environment.
10922 Now, that's fine and dandy, but it means that you wouldn't be able to start
10923 a slide with anything except plain text.
10924 To deal with this, I've performed a little
10925 \begin_inset Quotes eld
10930 \begin_inset Quotes erd
10936 \begin_layout Paragraph
10937 Quirks of the New Environments
10938 \begin_inset CommandInset label
10940 name "sec:slideQuirk"
10947 \begin_layout Standard
10948 All five of the new paragraph environments are somewhat quirky due to inherent
10949 limitiations in the current version of \SpecialChar LyX
10951 As I just mentioned, \SpecialChar LyX
10952 forbids environments that begin with another environment.
10953 To get around this, the
10957 environment isn't a paragraph environment as described in the
10965 \begin_layout Standard
10966 You should consider
10979 \begin_inset Quotes eld
10982 pseudo-environments.
10983 \begin_inset Quotes erd
10986 They look like a section heading or a
10987 \begin_inset Quotes eld
10995 \begin_inset Quotes erd
10998 but really begin a [and, if necessary, end the previous] paragraph environment.
11008 \begin_inset Quotes eld
11012 \begin_inset Quotes erd
11015 These two perform some action.
11018 \begin_layout Standard
11019 A common feature of all five environments,
11039 , is a rather long-ish label.
11040 The text following this label — ordinarily the contents of the paragraph
11041 environment — is utterly irrelevant for
11063 completely ignores it.
11064 In fact, you can leave these five environments completely empty.
11068 \begin_layout Standard
11073 to put any text after the rather long-ish label, you might want to.
11074 This could be a short description of the contents of the
11079 In that case, enter your descriptive comment and hit
11083 as you normally would.
11086 \begin_layout Standard
11087 If, on the other hand, you don't want to enter any descriptive text, you'll
11088 hit another \SpecialChar LyX
11091 , like nature, abhors a vacuum, and will not let you start a new paragraph
11092 environment until you put something in the old one.
11096 \begin_layout Itemize
11097 Start entering the text that will
11125 \begin_layout Itemize
11126 Now move to the beginning of that paragraph.
11130 \begin_layout Itemize
11139 \begin_layout Itemize
11140 Finally, change this new, empty paragraph to a
11164 \begin_layout Standard
11165 Some future version of \SpecialChar LyX
11166 will, hopefully, resolve this quirkiness\SpecialChar ldots
11170 \begin_layout Subsubsection
11171 Making a Presentation with
11184 \begin_layout Paragraph
11192 \begin_layout Standard
11193 If you're expecting this section to teach you how to actually make a presentatio
11194 n, you'll be sorely disappointed.
11195 Naturally, I'll describe all of the ways the
11199 class can assist you in preparing the materials for a presentation.
11200 Filling in the contents, however, is up to you.
11205 the \SpecialChar LyX
11209 \begin_layout Standard
11214 environment [in the manner described in section
11215 \begin_inset space ~
11219 \begin_inset CommandInset ref
11221 reference "sec:slideQuirk"
11225 ] tells \SpecialChar LyX
11226 to begin a new slide [duh].
11227 The label for this environment/
11228 \begin_inset Quotes erd
11232 \begin_inset Quotes erd
11236 \begin_inset Quotes eld
11240 \begin_inset Quotes erd
11243 in cool blue, followed by the label,
11244 \begin_inset Quotes eld
11248 \begin_inset Quotes erd
11252 Any text or paragraph environments that follow this one go on the new slide.
11256 \begin_layout Standard
11257 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
11259 (this can be specified in the
11264 In fact, you'll want to, once you finish entering the contents of one slide.
11265 If you've entered more text than can physically fit on a slide, the extra
11266 overflows onto a new slide.
11267 I don't recommend doing this, however, since the overflow slide won't have
11268 any page number on it.
11269 Furthermore, it may interfere with any
11273 you've made to accompany the oversized
11280 \begin_layout Standard
11289 environments work the same way as the
11294 They both create an
11295 \begin_inset Quotes eld
11299 \begin_inset Quotes erd
11302 followed by a label [
11303 \begin_inset Quotes eld
11307 \begin_inset Quotes erd
11311 \begin_inset Quotes eld
11315 \begin_inset Quotes erd
11319 The color is a stunning magenta instead of blue, and the
11320 \begin_inset Quotes eld
11324 \begin_inset Quotes erd
11327 will look different, in style and in length.
11328 The label fonts of all three also differ from one another.
11331 \begin_layout Standard
11336 , if the contents of a
11344 exceed the physical size of a slide or sheet of paper, the extra will overflow
11346 Again, you should avoid this.
11347 It defeats the whole purpose of
11358 \begin_layout Paragraph
11368 \begin_layout Standard
11373 is a slide that sits atop another slide.
11374 Perhaps you wish to discuss a figure on the main
11378 before displaying the text associated with it.
11379 One way to accomplish this is tape a flap of dark paper over the part of
11384 you want to display later.
11385 This method fails, however, if you wish to overlap one graph with another,
11387 You would then have to fumble while speaking to align the two separate,
11392 s to align the two graphs.
11397 environment in both cases makes life much easier.
11400 \begin_layout Standard
11405 receives the page number of its
11406 \begin_inset Quotes eld
11410 \begin_inset Quotes erd
11418 \begin_inset Quotes eld
11426 \begin_inset Quotes erd
11433 \begin_layout Plain Layout
11434 Presumably, mutliple
11439 \begin_inset Quotes eld
11447 \begin_inset Quotes erd
11451 \begin_inset Quotes eld
11459 \begin_inset Quotes erd
11463 \begin_inset Quotes eld
11471 \begin_inset Quotes erd
11475 \begin_inset space ~
11478 appended to the page number of the parent
11488 Clearly, you want the contents of both the
11496 to each fit on a single physical slide! You should probably consider an
11502 \begin_inset Quotes eld
11506 \begin_inset Quotes erd
11514 Indeed, the \SpecialChar LyX
11519 class provides a visual cue for this: the label at the start of an
11523 is shorter than that at the start of a
11528 Lastly, when you generate printable output, you'll find alignment markers
11529 in all four corners of both the
11533 page and its parent
11538 These will assist you in lining up the two physical slides.
11541 \begin_layout Standard
11542 The major problem in overlaying two slides is aligning the contents of the
11543 two transparencies.
11544 How much space should you leave for that graph on the second slide? Worse
11545 still, what if you want a graph and a sentence on second slide, but there
11546 is text on the main transparency that goes in between them? You could try
11547 and insert vertical space of the right size.
11548 The better way is to use
11559 \begin_layout Standard
11560 As their names imply,
11568 are two command-like paragraph environments that make all subsequent text
11569 invisible and visible, respectively.
11571 \begin_inset space ~
11575 \begin_inset CommandInset ref
11577 reference "sec:slideQuirk"
11581 that you don't place anything
11585 these two environments, however.
11590 , it inserts a centered, sky-blue label into the page reading
11591 \begin_inset Quotes eld
11594 <Invisible Text Follows>
11595 \begin_inset Quotes erd
11599 For paragraphs following this label, the parts of the
11607 ; it doesn't matter which] where they would be contain instead blank space.
11611 \begin_layout Standard
11616 , the corresponding centered label is
11617 \begin_inset Quotes eld
11620 <Visible Text Follows>
11621 \begin_inset Quotes erd
11625 Paragraphs following this label behave normally.
11626 Note that the beginning of a new
11638 automatically shuts off an
11643 It's therefore not necessary to use
11654 \begin_layout Standard
11655 By now, it should be obvious how to create overlay transparencies using
11656 the proper combination of
11675 \begin_layout Enumerate
11680 , including everything that will appear on it, whether on the main slide
11688 \begin_layout Enumerate
11689 Before each figure or paragraph that will appear only on the
11698 If necessary, insert a
11702 environment after the
11709 \begin_layout Enumerate
11714 immediately following the
11721 \begin_layout Enumerate
11722 Copy the contents of this
11733 \begin_layout Enumerate
11738 , change all of the
11749 \begin_layout Standard
11751 You've just made an
11758 \begin_layout Standard
11759 There's one problem with the way I've designed the \SpecialChar LyX
11764 class: you can't make text in the middle of a paragraph invisible, nor
11765 make text in the middle of an invisible paragraph visible again.
11766 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
11771 \begin_layout Plain Layout
11772 The commands of interest are:
11775 \begin_layout Itemize
11780 invisible \SpecialChar ldots
11784 \begin_layout Itemize
11789 visible \SpecialChar ldots
11793 \begin_layout Plain Layout
11795 and need to be marked as \SpecialChar TeX
11798 \begin_inset Quotes eld
11802 \begin_inset Quotes erd
11805 you wish to change goes in between the brackets [and after the
11818 If you don't know how to mark text as \SpecialChar TeX
11819 , see the appropriate section of
11832 \begin_layout Paragraph
11842 \begin_inset CommandInset label
11844 name "sec:slideNote"
11851 \begin_layout Standard
11860 is associated with a
11861 \begin_inset Quotes eld
11865 \begin_inset Quotes erd
11873 Here, too, the \SpecialChar LyX
11878 class provides visual cues.
11883 is shorter than that of a
11887 [yet longer than that of an
11891 ] and, like the label of an
11895 is shockingly magenta.
11896 Additionally, the printed
11900 has the page number of its
11901 \begin_inset Quotes eld
11905 \begin_inset Quotes erd
11913 \begin_inset Quotes eld
11921 \begin_inset Quotes erd
11925 \begin_inset Quotes eld
11933 \begin_inset Quotes erd
11937 \begin_inset Quotes eld
11945 \begin_inset Quotes erd
11949 You can have multiple
11953 s associated with a single
11965 , you'll probably want to break up long
11969 s so that they fit on a single sheet of paper.
11972 \begin_layout Standard
11977 is obvious: it contains anything additional you might want to say about
11983 It could also be used as a sheet of reminders for a particular
11988 In the case of the latter, you might want to make use of time markers.
11989 Currently, the \SpecialChar LyX
11995 \begin_inset Quotes eld
11999 \begin_inset Quotes erd
12002 support for time markers, a
12004 Sli\SpecialChar TeX
12008 So, you'll have to resort to using the \SpecialChar LaTeX
12012 \begin_layout Standard
12013 To use time markers, you'll need to specify the extra class option
12014 \begin_inset Quotes eld
12022 \begin_inset Quotes erd
12026 \begin_inset space ~
12030 \begin_inset CommandInset ref
12032 reference "sec:slidesetup"
12037 This option turns on timing marks, which will appear in the lower-left-hand
12043 To set what appears in the time marker, you use the \SpecialChar LaTeX
12045 \begin_inset Quotes eld
12055 \begin_inset Quotes erd
12059 \begin_inset Quotes eld
12069 \begin_inset Quotes erd
12073 The arguments of both commands are time measured in seconds.
12075 \begin_inset Quotes eld
12085 \begin_inset Quotes erd
12088 sets the time marker to a given time.
12090 \begin_inset Quotes eld
12100 \begin_inset Quotes erd
12103 increments the time marker by the specified amount.
12104 Using time markers and
12108 s in this fashion, you can remind yourself how much time to spend on a particula
12116 \begin_layout Standard
12117 There's one last feature to describe.
12118 Clearly, you'd like to print out all of your
12126 s on transparencies while printing all of your
12143 with which it is associated.
12144 What's a person to do?
12147 \begin_layout Standard
12148 Luckily, there are two \SpecialChar LaTeX
12149 commands that allow you to select what to print
12151 Both must be placed into the preamble of your document.
12153 \begin_inset Quotes eld
12165 \begin_inset Quotes erd
12168 will cause the output to contain only the
12177 Correspondingly, the command
12178 \begin_inset Quotes eld
12190 \begin_inset Quotes erd
12193 prevents the output of anything but
12198 I'd advise placing both commands in the preamble and initially comment
12200 You can then preview your entire presentation as you write.
12201 When you're done writing, you can then uncomment one of the two to select
12202 what you want to print.
12203 I like to uncomment
12204 \begin_inset Quotes eld
12216 \begin_inset Quotes erd
12219 , print to a file with
12220 \begin_inset Quotes eld
12228 \begin_inset Quotes erd
12231 in its name, comment it back out, then uncomment
12232 \begin_inset Quotes eld
12244 \begin_inset Quotes erd
12248 \begin_inset Quotes eld
12256 \begin_inset Quotes erd
12260 I can then send either file to a printer, loading transparencies or plain
12261 paper as appropriate.
12264 \begin_layout Standard
12265 You can also provide other arguments to the
12266 \begin_inset Quotes eld
12276 \begin_inset Quotes erd
12280 \begin_inset Quotes eld
12290 \begin_inset Quotes erd
12294 See a good \SpecialChar LaTeX
12298 \begin_layout Subsubsection
12303 Class Template File
12306 \begin_layout Standard
12307 I have also provided a template file
12308 \change_deleted 564990737 1671617750
12310 \begin_inset Quotes eld
12318 \begin_inset Quotes erd
12328 To use it, begin your new presentation with
12330 File\SpecialChar menuseparator
12332 \begin_inset space ~
12336 \begin_inset space ~
12340 \change_inserted 564990737 1671616988
12341 \SpecialChar menuseparator
12342 Presentations\SpecialChar menuseparator
12348 Your new \SpecialChar LyX
12349 presentation file will contain an example
12370 additionally contain an example of the use of
12379 Lastly, the preamble will contain:
12382 \begin_layout LyX-Code
12383 % Uncomment to print out only slides and overlays
12386 \begin_layout LyX-Code
12390 \begin_layout LyX-Code
12396 \begin_inset Newline newline
12402 \begin_layout LyX-Code
12403 % Uncomment to print out only notes
12406 \begin_layout LyX-Code
12410 \begin_layout LyX-Code
12418 \begin_layout Standard
12419 One final thing: I created this class to support the \SpecialChar LaTeX2e
12421 \begin_inset Quotes eld
12426 Sli\SpecialChar TeX
12430 \begin_inset Quotes erd
12433 class, one of the built-in \SpecialChar LaTeX2e
12435 Neither I nor the rest of the \SpecialChar LyX
12436 Team endorse or oppose the use of this built-in
12438 It's here if you want it or need it.
12439 There exist other \SpecialChar LaTeX2e
12440 classes for creating presentations, such as the
12445 \begin_inset space ~
12449 \begin_inset CommandInset ref
12451 reference "sec:foiltex"
12456 \begin_inset Quotes eld
12464 \begin_inset Quotes erd
12467 package [present on some \SpecialChar TeX
12469 The latter is not yet supported under \SpecialChar LyX
12474 \begin_layout Plain Layout
12475 Perhaps you can take on the task\SpecialChar ldots
12481 I know nothing about these other classes.
12482 Try them out to see what sort of alternative they provide.
12485 \begin_layout Section
12487 \change_inserted 564990737 1670439661
12491 \begin_layout Subsection
12493 \change_inserted 564990737 1670439661
12497 \begin_layout Standard
12499 \change_inserted 564990737 1670439661
12508 document class for preparing reports.
12513 document class, this provides parts, chapters and sections but does not
12514 provide the paragraph styles needed for a book; like the
12518 document class, it provides the abstract paragraph style.
12519 In two-sided mode, it does not start a new chapter on the right hand page.
12522 \begin_layout Standard
12524 \change_inserted 564990737 1670439674
12529 document classes are described in the Collections (section
12530 \begin_inset space ~
12534 \begin_inset CommandInset ref
12536 reference "sec:Collections"
12543 \begin_layout Section
12545 \change_inserted 564990737 1670439674
12549 \begin_layout Subsection
12553 \begin_layout Standard
12559 \begin_layout Subsubsection
12563 \begin_layout Standard
12564 Broadway is for writing plays.
12565 The format is more decorative than Hollywood, and much less standardized.
12566 This format should be suitable for workshops.
12569 \begin_layout Subsubsection
12573 \begin_layout Standard
12574 The same as in Hollywood.
12577 \begin_layout Subsubsection
12581 \begin_layout Standard
12586 names as labels then cross-reference the label to insert the name.
12587 The cross-reference dialog will show the current cast of characters.
12590 \begin_layout Subsubsection
12591 Paper size and Margins
12594 \begin_layout Standard
12595 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12598 \begin_layout Subsubsection
12602 \begin_layout Standard
12603 The following environments are available.
12604 You can use broadway.bind to get the bind keys shown at the right.
12607 \begin_layout Itemize
12611 \begin_inset Newline newline
12616 You should not have to use this, but it is here for anything that does not
12620 \begin_layout Itemize
12624 \begin_inset space \hfill{}
12628 \begin_inset Newline newline
12633 Used to describe stage setting and the action.
12634 First use of speaker names in all CAPs.
12637 \begin_layout Itemize
12641 \begin_inset space \hfill{}
12645 \begin_inset Newline newline
12650 Automatically numbered.
12651 On screen it will be arabic, but will print as Roman.
12654 \begin_layout Itemize
12658 \begin_inset space \hfill{}
12662 \begin_inset Newline newline
12672 It is just centered text.
12675 \begin_layout Itemize
12679 \begin_inset space \hfill{}
12683 \begin_inset Newline newline
12688 Not automatically numbered.
12689 You supply the number.
12690 This is because I couldn't figure out how.
12693 \begin_layout Itemize
12697 \begin_inset space \hfill{}
12701 \begin_inset Newline newline
12706 A special case of Narrative to describe the setting and action as the curtain
12710 \begin_layout Itemize
12714 \begin_inset space \hfill{}
12718 \begin_inset Newline newline
12723 The speaker's (actor's) title, centered in all CAPS.
12726 \begin_layout Itemize
12730 \begin_inset space \hfill{}
12734 \begin_inset Newline newline
12739 Instructions to the speaker.
12740 The parentheses are automatically inserted.
12741 The ( will appear on screen, but both will be in the printed play.
12742 This environment is only used within
12749 \begin_layout Itemize
12753 \begin_inset space \hfill{}
12757 \begin_inset Newline newline
12762 What the Speaker says.
12765 \begin_layout Itemize
12769 \begin_inset space \hfill{}
12773 \begin_inset Newline newline
12778 The curtain comes down.
12781 \begin_layout Itemize
12785 \begin_inset space \hfill{}
12791 \begin_layout Itemize
12795 \begin_inset space \hfill{}
12801 \begin_layout Itemize
12805 \begin_inset space \hfill{}
12811 \begin_layout Standard
12815 \begin_layout Subsection
12816 Hollywood (Hollywood spec scripts)
12819 \begin_layout Standard
12825 \begin_layout Subsubsection
12829 \begin_layout Standard
12830 Getting the format of a Hollywood script right is a
12831 \begin_inset Quotes eld
12835 \begin_inset Quotes erd
12838 It is designed to make the readers focus on content and to be easy and
12839 familiar for the actors to read.
12840 Each page of a script should be one minute of film.
12841 Nothing goes in a script that you cannot see or hear on screen.
12842 The courier 12 pt font should be used throughout.
12846 \begin_layout Subsubsection
12850 \begin_layout Standard
12851 Speakers' lines should NEVER break in mid-sentence.
12852 If a speaker's lines continue over a page break, repeat the
12856 title followed by (Cont'd).
12859 \begin_layout Subsubsection
12863 \begin_layout Standard
12868 names as labels then cross-reference the label to insert the name.
12869 The cross-reference dialog will show the current cast of characters.
12870 You can use this to insert the speaker name in narratives also.
12873 \begin_layout Subsubsection
12874 Paper size and Margins
12877 \begin_layout Standard
12878 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12881 \begin_layout Subsubsection
12885 \begin_layout Standard
12886 The following environments are available.
12887 You can use hollywood.bind to get the bind keys shown at the right.
12890 \begin_layout Itemize
12894 \begin_inset Newline newline
12899 Used where nothing else works.
12903 \begin_layout Itemize
12909 \begin_inset space \hfill{}
12917 \begin_inset Newline newline
12920 Usually followed by something like
12921 \begin_inset Quotes eld
12924 on Sally waking up.
12925 \begin_inset Quotes erd
12931 \begin_layout Itemize
12935 \begin_inset space \hfill{}
12939 \begin_inset Newline newline
12944 Introduces a new INTERIOR camera set-up.
12945 Always followed by DAY or NIGHT, or something similar to define the lighting
12947 Everthing on this line in CAPS.
12950 \begin_layout Itemize
12954 \begin_inset space \hfill{}
12958 \begin_inset Newline newline
12963 Introduces a new EXTERIOR camera set-up.
12964 Everthing on this line in CAPS.
12967 \begin_layout Itemize
12971 \begin_inset space \hfill{}
12975 \begin_inset Newline newline
12980 The character speaking.
12983 \begin_layout Itemize
12987 \begin_inset space \hfill{}
12991 \begin_inset Newline newline
12996 Instructions to the speaker.
12997 The () are automatically inserted.
13000 \begin_layout Itemize
13004 \begin_inset space \hfill{}
13008 \begin_inset Newline newline
13020 \begin_layout Itemize
13024 \begin_inset space \hfill{}
13028 \begin_inset Newline newline
13033 Camera movement instruction.
13035 \begin_inset space \thinspace{}
13039 \begin_inset space \space{}
13045 \begin_layout Itemize
13049 \begin_inset space \hfill{}
13055 \begin_layout Itemize
13059 \begin_inset space \hfill{}
13065 \begin_layout Itemize
13069 \begin_inset space \hfill{}
13075 \begin_layout Itemize
13079 \begin_inset space \hfill{}
13085 \begin_layout Subsubsection
13089 \begin_layout Itemize
13093 \begin_layout Itemize
13097 \begin_layout Itemize
13099 \begin_inset space \thinspace{}
13106 \begin_layout Itemize
13111 \begin_layout Itemize
13112 PAN — camera movement
13115 \begin_layout Itemize
13116 INSERT — cut to close-up of
13119 \begin_layout Chapter
13121 \change_inserted 564990737 1671185876
13125 \begin_layout Section
13127 \change_inserted 564990737 1671716212
13130 Academic Field Specifics
13133 \begin_layout Subsection
13135 \change_inserted 564990737 1671716212
13138 Chemistry: Hazard and Precautionary Statements
13141 \begin_layout Standard
13143 \change_inserted 564990737 1671716212
13146 This module provides two insets to typeset numbers and phrases of chemical
13147 hazard and precautionary statements.
13148 For a description see
13151 File\SpecialChar menuseparator
13152 Open Example\SpecialChar menuseparator
13153 Modules\SpecialChar menuseparator
13154 Hazard and Precautionary Statements
13158 Help\SpecialChar menuseparator
13159 Specific Manuals\SpecialChar menuseparator
13160 Hazard and Precautionary Statements
13166 \begin_layout Subsection
13168 \change_inserted 564990737 1671716212
13172 Chemistry: Risk and Safety Statements
13175 \begin_layout Standard
13177 \change_inserted 564990737 1671716212
13180 This module provides two insets,
13188 , accessible via the menu
13193 nsert\SpecialChar menuseparator
13195 \begin_inset space ~
13200 and an environment to typeset numbers and phrases of chemical risk and
13204 \begin_layout Subsection
13206 \change_inserted 564990737 1671716212
13212 \begin_layout Standard
13214 \change_inserted 564990737 1671716212
13217 This module uses the
13221 package to add environments useful for linguistics (numbered examples,
13222 glosses, semantic markup, tableau floats).
13223 You can obtain information about this module in
13228 elp\SpecialChar menuseparator
13234 \begin_inset space ~
13237 Manuals\SpecialChar menuseparator
13247 File\SpecialChar menuseparator
13248 Open Example\SpecialChar menuseparator
13251 Modules\SpecialChar menuseparator
13257 \begin_layout Section
13259 \change_inserted 564990737 1671788778
13265 \begin_layout Subsection
13267 \change_inserted 564990737 1671788778
13273 \begin_layout Standard
13275 \change_inserted 564990737 1671788778
13278 This module supports the Braille writing system.
13279 It requires the \SpecialChar LaTeX
13285 This and its documentation can be obtained from
13286 \begin_inset CommandInset href
13289 target "https://www.ctan.org/pkg/braille"
13295 You do not have to reconfigure your system after installing it.
13301 elp\SpecialChar menuseparator
13307 \begin_inset space ~
13310 Manuals\SpecialChar menuseparator
13319 File\SpecialChar menuseparator
13320 Open Example\SpecialChar menuseparator
13321 Modules\SpecialChar menuseparator
13327 \begin_layout Section
13329 \change_inserted 564990737 1671788778
13332 Annotation & Revision
13335 \begin_layout Subsection
13337 \change_inserted 564990737 1671788778
13343 \begin_layout Standard
13345 \change_inserted 564990737 1671788778
13348 This module provides “FiXme” (marginal) annotations for document revision
13350 A list of annotations can be produced by using the “List of FIXMEs” paragraph
13352 The annotations are customizable via the LaTeX preamble.
13353 See the FiXme documentation which can be obtained from
13354 \begin_inset CommandInset href
13357 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
13366 \begin_layout Paragraph
13368 \change_inserted 564990737 1671788778
13374 \begin_layout Standard
13376 \change_inserted 564990737 1671788778
13379 by default, the notes are only displayed in “draft” mode (if the option
13380 “draft” has been inserted in
13382 Document\SpecialChar menuseparator
13383 Settings\SpecialChar menuseparator
13384 Document Class\SpecialChar menuseparator
13385 Class Options\SpecialChar menuseparator
13389 To display them always, insert
13397 Document\SpecialChar menuseparator
13398 Settings\SpecialChar menuseparator
13406 \begin_layout Subsection
13408 \change_inserted 564990737 1671788778
13414 \begin_layout Standard
13416 \change_inserted 564990737 1671788778
13419 This module provides various kinds of annotations for PDF output.
13422 Help\SpecialChar menuseparator
13423 Specific Manuals\SpecialChar menuseparator
13424 PDF comments and File\SpecialChar menuseparator
13425 Open Example\SpecialChar menuseparator
13426 Modules\SpecialChar menuseparator
13432 \begin_layout Subsection
13434 \change_inserted 564990737 1671788778
13441 \begin_layout Standard
13443 \change_inserted 564990737 1671788778
13446 This module provides fields and buttons for PDF forms.
13448 \begin_inset CommandInset href
13450 name "hyperref documentation"
13451 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
13458 Help\SpecialChar menuseparator
13459 Specific Manuals\SpecialChar menuseparator
13460 PDF forms and File\SpecialChar menuseparator
13461 Open Example\SpecialChar menuseparator
13462 Modules\SpecialChar menuseparator
13468 \begin_layout Subsection
13470 \change_inserted 564990737 1671788778
13477 \begin_layout Standard
13479 \change_inserted 564990737 1671788778
13482 This module defines an inset to typeset reading aids (ruby, furigana) to
13483 Chinese characters.
13484 It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on
13485 the TeX engine) or a fallback definition.
13489 \begin_layout Subsection
13491 \change_inserted 564990737 1671788778
13498 \begin_layout Standard
13500 \change_inserted 564990737 1671788778
13503 This module provides custom insets to insert TODO items in your document.
13504 In order to generate a “List of TODOs,” the module provides a paragraph
13506 Inserting “final” in
13508 Document\SpecialChar menuseparator
13509 Settings\SpecialChar menuseparator
13510 Document Class\SpecialChar menuseparator
13511 Class Options\SpecialChar menuseparator
13514 ) suppresses the output of TODO notes.
13516 \begin_inset CommandInset href
13518 name "todonotes documentation"
13519 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
13527 \begin_layout Section
13529 \change_inserted 564990737 1671829045
13535 \begin_layout Subsection
13537 \change_inserted 564990737 1671829045
13540 APA Style with NatBib
13543 \begin_layout Standard
13545 \change_inserted 564990737 1671829045
13548 This module adds support for using natbib together with apacite (the bibliograph
13549 y style need not be apacite — it could be apacite, apacitex, or any bibliography
13550 that works with both the natbib and apacite packages.)
13553 \begin_layout Section
13555 \change_inserted 564990737 1671829045
13561 \begin_layout Subsection
13563 \change_inserted 564990737 1671829045
13566 Fancy Colored Boxes
13569 \begin_layout Standard
13571 \change_inserted 564990737 1671829045
13574 This module adds ten custom insets that support colored boxes via the tcolorbox
13578 Help\SpecialChar menuseparator
13579 Specific Manuals\SpecialChar menuseparator
13584 File\SpecialChar menuseparator
13585 Open Example\SpecialChar menuseparator
13586 Modules\SpecialChar menuseparator
13590 \begin_inset CommandInset href
13592 name "tcolorbox documentation"
13593 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
13602 \begin_layout Subsection
13604 \change_inserted 564990737 1671829045
13610 \begin_layout Standard
13612 \change_inserted 564990737 1671829045
13615 This provides the custom insets
13631 to scale and rotate its content.
13634 \begin_layout Standard
13636 \change_inserted 564990737 1671829045
13642 is a simple way of reversing text without any other enhancement:
13645 \begin_layout Standard
13647 \change_inserted 564990737 1671829045
13650 \begin_inset Flex Reflectbox
13653 \begin_layout Plain Layout
13655 \change_inserted 564990737 1671829045
13658 Great Western Railway
13668 \begin_layout Standard
13670 \change_inserted 564990737 1671829045
13673 (You will need to use Ctrl-R to see any of these examples.)
13676 \begin_layout Standard
13678 \change_inserted 564990737 1671829045
13684 allows you to specify the dimensions of the text or image; permissible
13685 units are em, ex, in, pt, pc, cm, mm, dd, cc, nd, nc, bp, or sp; if you
13694 it scales by the width factor:
13697 \begin_layout Standard
13699 \change_inserted 564990737 1671829045
13702 \begin_inset Flex Resizebox
13705 \begin_layout Plain Layout
13707 \change_inserted 564990737 1671829045
13710 \begin_inset Argument 1
13713 \begin_layout Plain Layout
13715 \change_inserted 564990737 1671829045
13726 \begin_inset Argument 2
13729 \begin_layout Plain Layout
13731 \change_inserted 564990737 1671829045
13741 Great Western Railway
13751 \begin_layout Standard
13753 \change_inserted 564990737 1671829045
13759 allows you to rotate text around the reference point of the box.
13760 If you wish to rotate the box around a different origin, place the cursor
13761 inside the box and select Insert\SpecialChar menuseparator
13786 or meaningful combinations of these and the counterclockwise rotation angle
13787 is expressed in degrees.
13791 \begin_layout Standard
13793 \change_inserted 564990737 1671829045
13796 \begin_inset Flex Rotatebox
13799 \begin_layout Plain Layout
13801 \change_inserted 564990737 1671829045
13804 \begin_inset Argument 1
13807 \begin_layout Plain Layout
13809 \change_inserted 564990737 1671829045
13820 \begin_inset Argument 2
13823 \begin_layout Plain Layout
13825 \change_inserted 564990737 1671829045
13835 Great Western Railway
13845 \begin_layout Standard
13847 \change_inserted 564990737 1671829045
13850 You can combine boxes as in:
13853 \begin_layout Standard
13855 \change_inserted 564990737 1671829045
13858 \begin_inset Flex Rotatebox
13861 \begin_layout Plain Layout
13863 \change_inserted 564990737 1671829045
13866 \begin_inset Argument 1
13869 \begin_layout Plain Layout
13871 \change_inserted 564990737 1671829045
13882 \begin_inset Argument 2
13885 \begin_layout Plain Layout
13887 \change_inserted 564990737 1671829045
13898 \begin_inset Flex Resizebox
13901 \begin_layout Plain Layout
13903 \change_inserted 564990737 1671829045
13906 \begin_inset Argument 1
13909 \begin_layout Plain Layout
13911 \change_inserted 564990737 1671829045
13922 \begin_inset Argument 2
13925 \begin_layout Plain Layout
13927 \change_inserted 564990737 1671829045
13938 \begin_inset Flex Reflectbox
13941 \begin_layout Plain Layout
13943 \change_inserted 564990737 1671829045
13946 Great Western Railway
13970 \begin_layout Standard
13972 \change_inserted 564990737 1671829045
13978 scales text; select Insert\SpecialChar menuseparator
13979 V-Factor to add a vertical factor.
13980 If the vertical factor is omitted, the horizontal is used.
13981 Adding different horizontal and vertical values creates distortion as in
13985 \begin_layout Standard
13987 \change_inserted 564990737 1671829045
13991 \begin_inset Flex Scalebox
13994 \begin_layout Plain Layout
13996 \change_inserted 564990737 1671829045
13999 \begin_inset Argument 1
14002 \begin_layout Plain Layout
14004 \change_inserted 564990737 1671829045
14015 \begin_inset Argument 2
14018 \begin_layout Plain Layout
14020 \change_inserted 564990737 1671829045
14032 Great Western Railway
14042 \begin_layout Standard
14044 \change_inserted 564990737 1671829045
14047 A negative horizontal value reverses the text and a negative vertical value
14048 inverts it so that you get
14051 \begin_layout Standard
14053 \change_inserted 564990737 1671829045
14056 \begin_inset Flex Scalebox
14059 \begin_layout Plain Layout
14061 \change_inserted 564990737 1671829045
14064 \begin_inset Argument 1
14067 \begin_layout Plain Layout
14069 \change_inserted 564990737 1671829045
14080 \begin_inset Argument 2
14083 \begin_layout Plain Layout
14085 \change_inserted 564990737 1671829045
14095 Great Western Railway
14103 \begin_inset Flex Scalebox
14106 \begin_layout Plain Layout
14108 \change_inserted 564990737 1671829045
14111 \begin_inset Argument 1
14114 \begin_layout Plain Layout
14116 \change_inserted 564990737 1671829045
14127 \begin_inset Argument 2
14130 \begin_layout Plain Layout
14132 \change_inserted 564990737 1671829045
14142 Great Western Railway
14152 \begin_layout Subsection
14154 \change_inserted 564990737 1671884699
14160 \begin_layout Standard
14162 \change_inserted 564990737 1671884699
14165 This module defines Boxes with section header.
14166 It is mainly intended for the SciPoster Document class.
14170 \begin_layout Subsection
14172 \change_inserted 564990737 1671884699
14175 Variable-width Minipages
14178 \begin_layout Standard
14180 \change_inserted 564990737 1671884699
14186 \begin_inset space \thinspace{}
14193 Insert\SpecialChar menuseparator
14205 package provides a variable-width minipage, whose resulting width is the
14206 width of its contents (if this does not exceed the specified maximum width).
14207 The inset has two optional arguments which can be added by placing the
14208 cursor inside the minipage and entering
14210 Insert\SpecialChar menuseparator
14212 \begin_inset space \thinspace{}
14223 Insert\SpecialChar menuseparator
14225 \begin_inset space \thinspace{}
14239 File\SpecialChar menuseparator
14240 Open Example\SpecialChar menuseparator
14241 Variable-width Minipages
14247 \begin_layout Section
14249 \change_inserted 564990737 1671884699
14255 \begin_layout Subsection
14257 \change_inserted 564990737 1671884699
14260 Fix Computer Modern Fonts
14263 \begin_layout Standard
14265 \change_inserted 564990737 1671884699
14268 This module uses the
14272 package to improve the appearance of Computer Modern fonts and make them
14273 available with arbitrary sizes.
14275 \begin_inset CommandInset href
14277 name "fix-cm documentation"
14278 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
14287 \begin_layout Subsection
14289 \change_inserted 564990737 1671884699
14293 Kernel Fixes (Obsolete)
14296 \begin_layout Standard
14298 \change_inserted 564990737 1671884699
14301 This module loads the \SpecialChar LaTeX
14306 which contains some bug fixes for \SpecialChar LaTeX
14308 If you use this module your typeset document may look different when you
14309 process it, depending on the respective version of
14317 \begin_layout Paragraph
14319 \change_inserted 564990737 1671884699
14325 \begin_layout Standard
14327 \change_inserted 564990737 1671884699
14330 recent \SpecialChar LaTeX
14331 kernels (as of 2015/01/01) include the functionality of
14339 module is obsolete with newer \SpecialChar LaTeX
14344 \begin_layout Subsection
14346 \change_inserted 564990737 1671884699
14349 Minimalistic Insets
14352 \begin_layout Standard
14354 \change_inserted 564990737 1671884699
14357 This module redefines several insets (Index, Branch, URL) as being Minimalistic.
14360 \begin_layout Subsection
14362 \change_inserted 564990737 1671884699
14365 Title and Preamble Hacks
14368 \begin_layout Standard
14370 \change_inserted 564990737 1671884699
14373 This module provides two new paragraph styles:
14376 \begin_layout Enumerate
14378 \change_inserted 564990737 1671884699
14384 which puts whatever is entered into it into the preamble.
14385 This can be used, if one wishes, to include preamble code in the body of
14390 \begin_layout Enumerate
14392 \change_inserted 564990737 1671884699
14398 which that will put its contents into the body of the LaTeX document, but
14406 This is useful for making branches and notes in title-related material.
14407 (However, if you put these in a Standard layout, this signals to LyX to
14414 , which may then come too early.)
14417 \begin_layout Section
14419 \change_inserted 564990737 1672081439
14425 \begin_layout Subsection
14427 \change_inserted 564990737 1672081439
14433 \begin_layout Standard
14435 \change_inserted 564990737 1672081439
14438 This module uses the
14442 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
14443 Use the Algorithm paragraph style to enter and indent the algorithm.
14445 \begin_inset CommandInset href
14447 name "algorithm2e documentation"
14448 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
14456 \begin_layout Subsection
14458 \change_inserted 564990737 1672081439
14461 Bilingual Captions AKA Multilingual Captions
14464 \begin_layout Standard
14466 \change_inserted 564990737 1672081439
14469 This module provides the paragraph style
14472 \begin_inset space ~
14477 with which to typeset multilingual captions.
14478 Within this paragraph style
14480 Insert\SpecialChar menuseparator
14483 allows you to enter the desired language using one of the babel names.
14486 File\SpecialChar menuseparator
14487 Open Example\SpecialChar menuseparator
14488 Multilingual Captions
14492 Help\SpecialChar menuseparator
14493 Specific Manuals\SpecialChar menuseparator
14494 Multilingual Captions
14496 further information on its use.
14499 \begin_layout Subsection
14501 \change_inserted 564990737 1672081439
14504 Number Figures by Section
14507 \begin_layout Standard
14509 \change_inserted 564990737 1672081439
14512 This module resets the figure number at section start and prepends the section
14513 number to the figure number, as in “Figure 2.1.” (By default book and report
14514 document classes number by Chapter and article document classes have a
14518 \begin_layout Subsection
14520 \change_inserted 564990737 1672081439
14523 Number Tables by Section
14526 \begin_layout Standard
14528 \change_inserted 564990737 1672081439
14531 This module resets the table number at section start and prepends the section
14532 number to the table number, as in “Table 2.1.” (By default book and report
14533 document classes number by Chapter and article document classes have a
14537 \begin_layout Section
14539 \change_inserted 564990737 1672081439
14545 \begin_layout Subsection
14547 \change_inserted 564990737 1672081439
14553 \begin_layout Standard
14555 \change_inserted 564990737 1672081439
14558 This module adds an endnote inset, in addition to footnotes.
14563 package, which has some limitations but works with older LaTeX distributions
14567 Insert\SpecialChar menuseparator
14568 Custom Inset\SpecialChar menuseparator
14571 to insert an endnote and
14573 Insert\SpecialChar menuseparator
14574 List/Contents/References\SpecialChar menuseparator
14577 to insert the endnotes list where you want the endnotes to appear.
14580 Help\SpecialChar menuseparator
14581 Embedded\SpecialChar menuseparator
14582 Objects\SpecialChar menuseparator
14583 Notes\SpecialChar menuseparator
14589 \begin_layout Subsection
14591 \change_inserted 564990737 1672081439
14594 Endnotes (Extended)
14597 \begin_layout Standard
14599 \change_inserted 564990737 1672081439
14602 This module adds an endnote inset, in addition to footnotes.
14607 package which is more powerful and customizable than the
14611 package, but requires a fairly modern LaTeX distribution (with LaTeX3).
14614 Insert\SpecialChar menuseparator
14615 Custom Inset\SpecialChar menuseparator
14618 to insert an endnote and
14620 Insert\SpecialChar menuseparator
14621 List/Contents/References\SpecialChar menuseparator
14624 to insert the endnotes list where you want the endnotes to appear.
14627 Help\SpecialChar menuseparator
14628 Embedded\SpecialChar menuseparator
14629 Objects\SpecialChar menuseparator
14630 Notes\SpecialChar menuseparator
14636 \begin_layout Subsection
14638 \change_inserted 564990737 1672081439
14641 Footnotes as Endnotes (Basic)
14644 \begin_layout Standard
14646 \change_inserted 564990737 1672081439
14649 This module sets all footnotes as endnotes.
14654 package, which has some limitations but works with older LaTeX distributions
14658 Insert\SpecialChar menuseparator
14659 List/Contents/References\SpecialChar menuseparator
14662 to insert the endnotes list where you want the endnotes to appear.
14665 Help\SpecialChar menuseparator
14666 Embedded\SpecialChar menuseparator
14667 Objects\SpecialChar menuseparator
14668 Notes\SpecialChar menuseparator
14674 \begin_layout Subsection
14676 \change_inserted 564990737 1672081439
14679 Footnotes as Endnotes (Extended)
14682 \begin_layout Standard
14684 \change_inserted 564990737 1672081439
14687 This module sets all footnotes as endnotes.
14692 package which is more powerful and customizable than then
14696 package, but requires a fairly modern LaTeX distribution (with LaTeX3).
14699 Insert\SpecialChar menuseparator
14700 List/Contents/References\SpecialChar menuseparator
14703 to insert the endnotes list where you want the endnotes to appear.
14706 Help\SpecialChar menuseparator
14707 Embedded\SpecialChar menuseparator
14708 Objects\SpecialChar menuseparator
14709 Notes\SpecialChar menuseparator
14715 \begin_layout Section
14717 \change_inserted 564990737 1672081439
14720 Leisure, Sports and Music
14723 \begin_layout Subsection
14725 \change_inserted 564990737 1672081439
14731 \begin_layout Standard
14733 \change_inserted 564990737 1672081439
14736 This module provides support for the
14740 package to print chess games.
14743 File\SpecialChar menuseparator
14744 Open Example\SpecialChar menuseparator
14745 Articles\SpecialChar menuseparator
14748 where you will find
14757 \begin_inset CommandInset href
14759 name "chessboard documentation"
14760 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
14768 \begin_layout Subsection
14770 \change_inserted 564990737 1672081439
14773 Lilypond Music Notation
14776 \begin_layout Standard
14778 \change_inserted 564990737 1672081439
14781 This module provides an inset via
14786 nsert\SpecialChar menuseparator
14787 Custom Inset\SpecialChar menuseparator
14790 in which to enter code for the LilyPond music editor.
14791 It will then be processed in the output.
14794 Help\SpecialChar menuseparator
14795 Specific Manuals\SpecialChar menuseparator
14800 File\SpecialChar menuseparator
14801 Open Example\SpecialChar menuseparator
14802 Modules\SpecialChar menuseparator
14806 It cannot be used if the modules
14809 \begin_inset space \thinspace{}
14817 \begin_layout Section
14818 Multiple Text Columns
14821 \begin_layout Standard
14822 This feature is independent of the option
14824 Two-column document
14826 in the document settings under
14831 If you want to have 2
14832 \begin_inset space ~
14835 columns for the whole document, it is recommended to use the
14837 Two-column document
14840 For all other cases use this feature.
14843 \begin_layout Standard
14844 To use multiple text columns in your document, you have to load the module
14851 Document\SpecialChar menuseparator
14852 Settings\SpecialChar menuseparator
14855 ) and must have the \SpecialChar LaTeX
14857 \begin_inset Flex Code
14860 \begin_layout Plain Layout
14869 \begin_layout Standard
14870 Footnotes within multiple columns will be placed at the bottom of the page
14871 and not under each column.
14872 Within the different columns you can use everything, with the limitation
14873 that for floats you need to use the float option
14880 \begin_layout Subsection
14884 \begin_layout Standard
14885 If you want to have 2
14886 \begin_inset space ~
14889 columns in your text, insert a multicolumn inset via the menu
14891 Insert\SpecialChar menuseparator
14893 \begin_inset space ~
14896 Insets\SpecialChar menuseparator
14898 \begin_inset space ~
14903 where the columns should start.
14904 Write all text that should be printed in 2
14905 \begin_inset space ~
14908 columns into this inset.
14911 \begin_layout Standard
14912 Here is an example:
14915 \begin_layout Standard
14917 \begin_inset Flex Multiple Columns
14920 \begin_layout Plain Layout
14925 The Adventure of the Empty House
14928 \begin_inset Newline newline
14931 by Sir Arthur Conan Doyle
14934 \begin_layout Plain Layout
14937 It was in the spring of the year 1894 that all London was interested, and
14938 the fashionable world dismayed, by the murder of the Honourable Ronald
14939 Adair under most unusual and inexplicable circumstances.
14940 The public has already learned those particulars of the crime which came
14941 out in the police investigation, but a good deal was suppressed upon that
14942 occasion, since the case for the prosecution was so overwhelmingly strong
14943 that it was not necessary to bring forward all the facts.
14944 Only now, at the end of nearly ten years, am I allowed to supply those
14945 missing links which make up the whole of that remarkable chain.
14946 The crime was of interest in itself, but that interest was as nothing to
14947 me compared to the inconceivable sequel, which afforded me the greatest
14948 shock and surprise of any event in my adventurous life.
14949 Even now, after this long interval, I find myself thrilling as I think
14950 of it, and feeling once more that sudden flood of joy, amazement, and increduli
14951 ty which utterly submerged my mind.
14952 Let me say to that public, which has shown some interest in those glimpses
14953 which I have occasionally given them of the thoughts and actions of a very
14954 remarkable man, that they are not to blame me if I have not shared my knowledge
14955 with them, for I should have considered it my first duty to do so, had
14956 I not been barred by a positive prohibition from his own lips, which was
14957 only withdrawn upon the third of last month.
14965 \begin_layout Standard
14966 To get 3 or more columns, set the cursor into the multicolumn inset and
14969 Insert\SpecialChar menuseparator
14971 \begin_inset space ~
14975 \begin_inset space ~
14981 The number of the desired columns is written into that inset (for 3
14982 \begin_inset space ~
14986 \begin_inset Quotes eld
14990 \begin_inset Quotes erd
14994 \begin_inset Newline newline
14997 Here is an example with 3
14998 \begin_inset space ~
15004 \begin_layout Standard
15005 \begin_inset Flex Multiple Columns
15008 \begin_layout Plain Layout
15011 \begin_inset Argument 1
15014 \begin_layout Plain Layout
15021 It can be imagined that my close intimacy with Sherlock Holmes had interested
15022 me deeply in crime, and that after his disappearance I never failed to
15023 read with care the various problems which came before the public.
15024 And I even attempted, more than once, for my own private satisfaction,
15025 to employ his methods in their solution, though with indifferent success.
15026 There was none, however, which appealed to me like this tragedy of Ronald
15028 As I read the evidence at the inquest, which led up to a verdict of willful
15029 murder against some person or persons unknown, I realized more clearly
15030 than I had ever done the loss which the community had sustained by the
15031 death of Sherlock Holmes.
15032 There were points about this strange business which would, I was sure,
15033 have specially appealed to him, and the efforts of the police would have
15034 been supplemented, or more probably anticipated, by the trained observation
15035 and the alert mind of the first criminal agent in Europe.
15036 All day, as I drove upon my round, I turned over the case in my mind and
15037 found no explanation which appeared to me to be adequate.
15038 At the risk of telling a twice-told tale, I will recapitulate the facts
15039 as they were known to the public at the conclusion of the inquest.
15047 \begin_layout Standard
15048 You can have up to 10
15049 \begin_inset space ~
15052 columns if you want to, but that might not be very pleasant for the readers
15056 \begin_layout Standard
15057 \begin_inset Newpage newpage
15063 \begin_layout Subsection
15064 Columns inside Columns
15067 \begin_layout Standard
15068 You can also have columns inside columns:
15071 \begin_layout Standard
15072 \begin_inset Flex Multiple Columns
15075 \begin_layout Plain Layout
15078 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
15079 at that time governor of one of the Australian colonies.
15080 Adair's mother had returned from Australia to undergo the operation for
15081 cataract, and she, her son Ronald, and her daughter Hilda were living together
15085 \begin_layout Plain Layout
15086 \begin_inset Flex Multiple Columns
15089 \begin_layout Plain Layout
15092 The youth moved in the best society
15093 \begin_inset space ~
15096 – had, so far as was known, no enemies and no particular vices.
15097 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
15098 had been broken off by mutual consent some months before, and there was
15099 no sign that it had left any very profound feeling behind it.
15100 For the rest {sic} the man's life moved in a narrow and conventional circle,
15101 for his habits were quiet and his nature unemotional.
15102 Yet it was upon this easy-going young aristocrat that death came, in most
15103 strange and unexpected form, between the hours of ten and eleven-twenty
15104 on the night of March 30, 1894.
15112 \begin_layout Plain Layout
15115 Ronald Adair was fond of cards
15116 \begin_inset space ~
15119 – playing continually, but never for such stakes as would hurt him.
15120 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
15121 It was shown that, after dinner on the day of his death, he had played
15122 a rubber of whist at the latter club.
15123 He had also played there in the afternoon.
15128 The evidence of those who had played with him
15129 \begin_inset space ~
15133 Murray, Sir John Hardy, and Colonel Moran
15134 \begin_inset space ~
15137 – showed that the game was whist, and that there was a fairly equal fall
15139 Adair might have lost five pounds, but not more.
15140 His fortune was a considerable one, and such a loss could not in any way
15142 He had played nearly every day at one club or other, but he was a cautious
15143 player, and usually rose a winner.
15144 It came out in evidence that, in partnership with Colonel Moran, he had
15145 actually won as much as four hundred and twenty pounds in a sitting, some
15146 weeks before, from Godfrey Milner and Lord Balmoral.
15147 So much for his recent history as it came out at the inquest.
15155 \begin_layout Subsection
15159 \begin_layout Standard
15160 The examples in this section show some more special features of multiple
15164 \begin_layout Standard
15165 For more features of multiple columns, have a look at the
15166 \begin_inset CommandInset href
15168 name "documentation"
15169 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
15174 of the \SpecialChar LaTeX
15176 \begin_inset Flex Code
15179 \begin_layout Plain Layout
15188 \begin_layout Subsubsection
15192 \begin_layout Standard
15193 To add a preface text for multiple columns, set the cursor into the multicolumn
15194 inset and use the menu
15196 Insert\SpecialChar menuseparator
15200 Write your preface text into that inset.
15201 \begin_inset Newline newline
15204 This is an example with some preface text:
15207 \begin_layout Standard
15208 \begin_inset VSpace bigskip
15214 \begin_layout Standard
15215 \begin_inset Flex Multiple Columns
15218 \begin_layout Plain Layout
15219 \begin_inset Argument 2
15222 \begin_layout Plain Layout
15223 And the story continues and continues and continues and continues\SpecialChar ldots
15231 On the evening of the crime, he returned from the club exactly at ten.
15232 His mother and sister were out spending the evening with a relation.
15233 The servant deposed that she heard him enter the front room on the second
15234 floor, generally used as his sitting-room.
15235 She had lit a fire there, and as it smoked she had opened the window.
15236 No sound was heard from the room until eleven-twenty, the hour of the return
15237 of Lady Maynooth and her daughter.
15238 Desiring to say good-night, she attempted to enter her son's room.
15239 The door was locked on the inside, and no answer could be got to their
15240 cries and knocking.
15241 Help was obtained, and the door forced.
15242 The unfortunate young man was found lying near the table.
15243 His head had been horribly mutilated by an expanding revolver bullet, but
15244 no weapon of any sort was to be found in the room.
15252 \begin_layout Standard
15253 You can also use a section heading as the preface if you use a section command
15254 as \SpecialChar TeX
15256 For example the command
15259 \begin_layout LyX-Code
15262 subsection{subsection title}
15265 \begin_layout Standard
15266 creates a subsection.
15267 In this example the preface is a subsubsection:
15270 \begin_layout Standard
15271 \begin_inset Flex Multiple Columns
15274 \begin_layout Plain Layout
15275 \begin_inset Argument 2
15278 \begin_layout Plain Layout
15282 \begin_layout Plain Layout
15291 This is a subsubsection heading as a preface
15295 \begin_layout Plain Layout
15309 A minute examination of the circumstances served only to make the case more
15311 In the first place, no reason could be given why the young man should have
15312 fastened the door upon the inside.
15313 There was the possibility that the murderer had done this, and had afterwards
15314 escaped by the window.
15315 The drop was at least twenty feet, however, and a bed of crocuses in full
15317 Neither the flowers nor the earth showed any sign of having been disturbed,
15318 nor were there any marks upon the narrow strip of grass which separated
15319 the house from the road.
15320 Apparently, therefore, it was the young man himself who had fastened the
15322 But how did he come by his death? No one could have climbed up to the window
15323 without leaving traces.
15324 Suppose a man had fired through the window, he would indeed be a remarkable
15325 shot who could with a revolver inflict so deadly a wound.
15326 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
15327 a hundred yards of the house.
15328 No one had heard a shot.
15336 \begin_layout Standard
15337 If there is less vertical space than 6
15338 \begin_inset space ~
15341 text lines is left on the page at the beginning of the multiple columns,
15342 a page break will be inserted before the multiple columns.
15343 Depending on the number of lines of the preface text, you might want to
15345 This is done by setting the cursor into the mulitcolumn inset behind the
15346 preface (if there is any) and using the menu
15348 Insert\SpecialChar menuseparator
15350 \begin_inset space ~
15354 \begin_inset space ~
15358 \begin_inset space ~
15364 Insert into that inset the amount of space like e.
15365 \begin_inset space \thinspace{}
15369 \begin_inset space \space{}
15373 \begin_inset Quotes eld
15377 \begin_inset Quotes erd
15381 \begin_inset Newline newline
15384 In this example the space is set to 7
15385 \begin_inset space ~
15388 text lines by using
15389 \begin_inset Flex Code
15392 \begin_layout Plain Layout
15401 \begin_inset Flex Code
15404 \begin_layout Plain Layout
15412 needs to be inserted as \SpecialChar TeX
15416 \begin_layout Standard
15417 \begin_inset Flex Multiple Columns
15420 \begin_layout Plain Layout
15421 \begin_inset Argument 3
15424 \begin_layout Plain Layout
15429 \begin_layout Plain Layout
15445 On the evening of the crime, he returned from the club exactly at ten.
15446 His mother and sister were out spending the evening with a relation.
15447 The servant deposed that she heard him enter the front room on the second
15448 floor, generally used as his sitting-room.
15449 She had lit a fire there, and as it smoked she had opened the window.
15450 No sound was heard from the room until eleven-twenty, the hour of the return
15451 of Lady Maynooth and her daughter.
15452 Desiring to say good-night, she attempted to enter her son's room.
15453 The door was locked on the inside, and no answer could be got to their
15454 cries and knocking.
15455 Help was obtained, and the door forced.
15456 The unfortunate young man was found lying near the table.
15457 His head had been horribly mutilated by an expanding revolver bullet, but
15458 no weapon of any sort was to be found in the room.
15466 \begin_layout Subsubsection
15470 \begin_layout Standard
15471 The amount of space before and after multiple columns can be changed by
15472 changing the length
15473 \begin_inset Flex Code
15476 \begin_layout Plain Layout
15485 For example the command
15488 \begin_layout LyX-Code
15496 \begin_layout Standard
15497 in \SpecialChar TeX
15498 Code changes its value to 3
15499 \begin_inset space \thinspace{}
15503 The change must be made before the multiple columns' start.
15504 The predefined value is 13
15505 \begin_inset space \thinspace{}
15511 \begin_layout Standard
15513 \begin_inset Flex Code
15516 \begin_layout Plain Layout
15525 \begin_inset space \thinspace{}
15531 \begin_layout Standard
15535 \begin_layout Plain Layout
15541 multicolsep}{2.5cm}
15549 \begin_layout Standard
15550 \begin_inset Flex Multiple Columns
15553 \begin_layout Plain Layout
15556 All day I turned these facts over in my mind, endeavouring to hit upon some
15557 theory which could reconcile them all, and to find that line of least resistanc
15558 e which my poor friend had declared to be the starting-point of every investigat
15560 I confess that I made little progress.
15561 In the evening I strolled across the Park, and found myself about six o'clock
15562 at the Oxford Street end of Park Lane.
15563 A group of loafers upon the pavements, all staring up at a particular window,
15564 directed me to the house which I had come to see.
15565 A tall, thin man with coloured glasses, whom I strongly suspected of being
15566 a plain-clothes detective, was pointing out some theory of his own, while
15567 the others crowded round to listen to what he said.
15568 I got as near him as I could, but his observations seemed to me to be absurd,
15569 so I withdrew again in some disgust.
15570 As I did so I struck against an elderly, deformed man, who had been behind
15571 me, and I knocked down several books which he was carrying.
15579 \begin_layout Standard
15580 \begin_inset Note Greyedout
15583 \begin_layout Plain Layout
15588 The values you set with
15589 \begin_inset Flex Code
15592 \begin_layout Plain Layout
15600 will be used for all following multiple columns until you change them again.
15608 \begin_layout Standard
15612 \begin_layout Plain Layout
15624 \begin_inset Note Note
15627 \begin_layout Plain Layout
15628 go back to the default
15636 \begin_layout Standard
15637 \begin_inset Newpage newpage
15643 \begin_layout Subsubsection
15647 \begin_layout Standard
15648 A column break can be forced by inserting the command
15649 \begin_inset Flex Code
15652 \begin_layout Plain Layout
15660 as \SpecialChar TeX
15661 Code to that position in the text where the column should be broken.
15662 Note that this leads in most cases to whitespace in the text.
15663 \begin_inset Newline newline
15666 Here is an example:
15669 \begin_layout Standard
15670 \begin_inset Flex Multiple Columns
15673 \begin_layout Plain Layout
15676 \begin_inset Quotes eld
15679 You're surprised to see me, sir,
15680 \begin_inset Quotes erd
15683 said he, in a strange, croaking voice.
15686 \begin_layout Plain Layout
15689 I acknowledged that I was.
15692 \begin_layout Plain Layout
15695 \begin_inset Quotes eld
15698 Well, I've a conscience, sir, and when I chanced to see you go into this
15699 house, as I came hobbling after you, I thought to myself, I'll just step
15700 in and see that kind gentleman, and tell him that if I was a bit gruff
15701 in my manner there was not any harm meant, and that I am much obliged to
15702 him for picking up my books.
15703 \begin_inset Quotes erd
15709 \begin_layout Plain Layout
15712 \begin_inset Quotes eld
15715 You make too much of a trifle,
15716 \begin_inset Quotes erd
15721 \begin_inset Quotes eld
15724 May I ask how you knew who I was?
15725 \begin_inset Quotes erd
15728 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
15732 \begin_layout Plain Layout
15744 \begin_layout Plain Layout
15747 \begin_inset Quotes eld
15750 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
15751 you'll find my little bookshop at the corner of Church Street, and very
15752 happy to see you, I am sure.
15753 Maybe you collect yourself, sir.
15757 \begin_inset space ~
15771 \begin_inset space ~
15774 – a bargain, every one of them.
15775 With five volumes you could just fill that gap on that second shelf.
15776 It looks untidy, does it not, sir?
15777 \begin_inset Quotes erd
15788 \begin_layout Subsubsection
15792 \begin_layout Standard
15793 The width of the columns is automatically calculated, but you can modify
15794 the space between the columns.
15795 This is done by changing the length
15796 \begin_inset Flex Code
15799 \begin_layout Plain Layout
15808 Its predefined value is 10
15809 \begin_inset space \thinspace{}
15813 Here is an example where
15814 \begin_inset Flex Code
15817 \begin_layout Plain Layout
15826 \begin_inset space \thinspace{}
15832 \begin_layout Standard
15836 \begin_layout Plain Layout
15850 \begin_layout Standard
15851 \begin_inset Flex Multiple Columns
15854 \begin_layout Plain Layout
15857 My observations of No.
15858 \begin_inset space \space{}
15861 427 Park Lane did little to clear up the problem in which I was interested.
15862 The house was separated from the street by a low wall and railing, the
15863 whole not more than five feet high.
15864 It was perfectly easy, therefore, for anyone to get into the garden, but
15865 the window was entirely inaccessible, since there was no water pipe or
15866 anything which could help the most active man to climb it.
15867 More puzzled than ever, I retraced my steps to Kensington.
15868 I had not been in my study five minutes when the maid entered to say that
15869 a person desired to see me.
15870 To my astonishment it was none other than my strange old book collector,
15871 his sharp, wizened face peering out from a frame of white hair, and his
15872 precious volumes, a dozen of them at least, wedged under his right arm.
15880 \begin_layout Standard
15884 \begin_layout Plain Layout
15896 \begin_inset Note Note
15899 \begin_layout Plain Layout
15900 go back to the default
15908 \begin_layout Subsubsection
15912 \begin_layout Standard
15913 Between the columns a rule with a width of the length
15914 \begin_inset Flex Code
15917 \begin_layout Plain Layout
15926 If this rule width is set to 0
15927 \begin_inset space \thinspace{}
15930 pt (this is the default), the rule is suppressed.
15931 In the following example the rule is 2
15932 \begin_inset space \thinspace{}
15938 \begin_layout Standard
15942 \begin_layout Plain Layout
15948 columnseprule}{2pt}
15956 \begin_layout Standard
15957 \begin_inset Flex Multiple Columns
15960 \begin_layout Plain Layout
15963 \begin_inset Quotes eld
15966 You're surprised to see me, sir,
15967 \begin_inset Quotes erd
15970 said he, in a strange, croaking voice.
15973 \begin_layout Plain Layout
15976 I acknowledged that I was.
15979 \begin_layout Plain Layout
15982 \begin_inset Quotes eld
15985 Well, I've a conscience, sir, and when I chanced to see you go into this
15986 house, as I came hobbling after you, I thought to myself, I'll just step
15987 in and see that kind gentleman, and tell him that if I was a bit gruff
15988 in my manner there was not any harm meant, and that I am much obliged to
15989 him for picking up my books.
15990 \begin_inset Quotes erd
15996 \begin_layout Plain Layout
15999 \begin_inset Quotes eld
16002 You make too much of a trifle,
16003 \begin_inset Quotes erd
16008 \begin_inset Quotes eld
16011 May I ask how you knew who I was?
16012 \begin_inset Quotes erd
16018 \begin_layout Plain Layout
16021 \begin_inset Quotes eld
16024 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
16025 you'll find my little bookshop at the corner of Church Street, and very
16026 happy to see you, I am sure.
16027 Maybe you collect yourself, sir.
16031 \begin_inset space ~
16045 \begin_inset space ~
16048 – a bargain, every one of them.
16049 With five volumes you could just fill that gap on that second shelf.
16050 It looks untidy, does it not, sir?
16051 \begin_inset Quotes erd
16062 \begin_layout Standard
16063 \begin_inset VSpace defskip
16069 \begin_layout Standard
16070 The rule can be colored by redefining the command
16071 \begin_inset Flex Code
16074 \begin_layout Plain Layout
16083 This is done by inserting the command
16086 \begin_layout LyX-Code
16091 columnseprulecolor}{
16096 \begin_layout Standard
16097 as \SpecialChar TeX
16098 Code before the multicolumn inset.
16100 \begin_inset Flex Code
16103 \begin_layout Plain Layout
16109 in this command by a color of your choice.
16110 You can use all pre- and self-defined colors.
16118 \begin_inset space ~
16123 for more information about pre- and self-defined colors.
16124 To go back to the default color insert the command
16127 \begin_layout LyX-Code
16132 columnseprulecolor}{
16137 \begin_layout Standard
16138 Here is the example with a cyan rule and 1
16139 \begin_inset space \thinspace{}
16142 cm column separation:
16145 \begin_layout Standard
16149 \begin_layout Plain Layout
16158 \begin_layout Plain Layout
16164 columnseprulecolor}{
16174 \begin_layout Standard
16175 \begin_inset Flex Multiple Columns
16178 \begin_layout Plain Layout
16181 \begin_inset Quotes eld
16184 You're surprised to see me, sir,
16185 \begin_inset Quotes erd
16188 said he, in a strange, croaking voice.
16191 \begin_layout Plain Layout
16194 I acknowledged that I was.
16197 \begin_layout Plain Layout
16200 \begin_inset Quotes eld
16203 Well, I've a conscience, sir, and when I chanced to see you go into this
16204 house, as I came hobbling after you, I thought to myself, I'll just step
16205 in and see that kind gentleman, and tell him that if I was a bit gruff
16206 in my manner there was not any harm meant, and that I am much obliged to
16207 him for picking up my books.
16208 \begin_inset Quotes erd
16214 \begin_layout Plain Layout
16217 \begin_inset Quotes eld
16220 You make too much of a trifle,
16221 \begin_inset Quotes erd
16226 \begin_inset Quotes eld
16229 May I ask how you knew who I was?
16230 \begin_inset Quotes erd
16236 \begin_layout Plain Layout
16239 \begin_inset Quotes eld
16242 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
16243 you'll find my little bookshop at the corner of Church Street, and very
16244 happy to see you, I am sure.
16245 Maybe you collect yourself, sir.
16249 \begin_inset space ~
16263 \begin_inset space ~
16266 – a bargain, every one of them.
16267 With five volumes you could just fill that gap on that second shelf.
16268 It looks untidy, does it not, sir?
16269 \begin_inset Quotes erd
16280 \begin_layout Standard
16284 \begin_layout Plain Layout
16290 columnseprule}{0pt}
16293 \begin_layout Plain Layout
16299 columnseprulecolor}{
16307 \begin_inset Note Note
16310 \begin_layout Plain Layout
16311 go back to the default
16319 \begin_layout Section
16321 \change_inserted 564990737 1671270380
16325 \begin_layout Subsection
16327 \change_inserted 564990737 1671270398
16329 \change_deleted 564990737 1671270396
16335 \begin_layout Standard
16338 as well as any other text processor uses by default rectangular paragraphs.
16339 For special cases like for example posters, invitation cards or poems you
16340 can modify the paragraph shape to one of your choice.
16341 This can be done by using the \SpecialChar LaTeX
16343 \begin_inset Flex Code
16346 \begin_layout Plain Layout
16352 which is loaded by using in the document settings the module
16354 Custom paragraph shapes
16359 \begin_layout Subsubsection
16363 \begin_layout Standard
16368 provides the following shapes:
16371 \begin_layout Standard
16372 \begin_inset Tabular
16373 <lyxtabular version="3" rows="13" columns="3">
16374 <features booktabs="true" islongtable="true" longtabularalignment="center">
16375 <column alignment="left" valignment="middle" width="16col%">
16376 <column alignment="left" valignment="middle" width="40col%">
16377 <column alignment="left" valignment="middle" width="35col%">
16378 <row endhead="true">
16379 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
16382 \begin_layout Plain Layout
16391 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
16394 \begin_layout Plain Layout
16403 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
16406 \begin_layout Plain Layout
16416 <row interlinespace="default">
16417 <cell alignment="left" valignment="top" usebox="none">
16420 \begin_layout Plain Layout
16428 <cell alignment="left" valignment="top" usebox="none">
16431 \begin_layout Plain Layout
16434 Circle with circular hole (in the size of a CD/DVD)
16439 <cell alignment="left" valignment="top" usebox="none">
16442 \begin_layout Plain Layout
16445 Cannot be scaled, take care there is not too much text
16451 <row interlinespace="default">
16452 <cell alignment="left" valignment="top" usebox="none">
16455 \begin_layout Plain Layout
16463 <cell alignment="left" valignment="top" usebox="none">
16466 \begin_layout Plain Layout
16474 <cell alignment="left" valignment="top" usebox="none">
16477 \begin_layout Plain Layout
16480 Fragile, calculation might fail
16486 <row interlinespace="default">
16487 <cell alignment="left" valignment="top" usebox="none">
16490 \begin_layout Plain Layout
16498 <cell alignment="left" valignment="top" usebox="none">
16501 \begin_layout Plain Layout
16504 Rhomboid (symbolizing a
16505 \begin_inset Quotes eld
16509 \begin_inset Quotes erd
16517 <cell alignment="left" valignment="top" usebox="none">
16520 \begin_layout Plain Layout
16529 <row interlinespace="default">
16530 <cell alignment="left" valignment="top" usebox="none">
16533 \begin_layout Plain Layout
16541 <cell alignment="left" valignment="top" usebox="none">
16544 \begin_layout Plain Layout
16552 <cell alignment="left" valignment="top" usebox="none">
16555 \begin_layout Plain Layout
16564 <row interlinespace="default">
16565 <cell alignment="left" valignment="top" usebox="none">
16568 \begin_layout Plain Layout
16576 <cell alignment="left" valignment="top" usebox="none">
16579 \begin_layout Plain Layout
16587 <cell alignment="left" valignment="top" usebox="none">
16590 \begin_layout Plain Layout
16599 <row interlinespace="default">
16600 <cell alignment="left" valignment="top" usebox="none">
16603 \begin_layout Plain Layout
16611 <cell alignment="left" valignment="top" usebox="none">
16614 \begin_layout Plain Layout
16617 Nut for bolt (hexagon with circular hole)
16622 <cell alignment="left" valignment="top" usebox="none">
16625 \begin_layout Plain Layout
16634 <row interlinespace="default">
16635 <cell alignment="left" valignment="top" usebox="none">
16638 \begin_layout Plain Layout
16646 <cell alignment="left" valignment="top" usebox="none">
16649 \begin_layout Plain Layout
16657 <cell alignment="left" valignment="top" usebox="none">
16660 \begin_layout Plain Layout
16669 <row interlinespace="default">
16670 <cell alignment="left" valignment="top" usebox="none">
16673 \begin_layout Plain Layout
16681 <cell alignment="left" valignment="top" usebox="none">
16684 \begin_layout Plain Layout
16692 <cell alignment="left" valignment="top" usebox="none">
16695 \begin_layout Plain Layout
16704 <row interlinespace="default">
16705 <cell alignment="left" valignment="top" usebox="none">
16708 \begin_layout Plain Layout
16716 <cell alignment="left" valignment="top" usebox="none">
16719 \begin_layout Plain Layout
16727 <cell alignment="left" valignment="top" usebox="none">
16730 \begin_layout Plain Layout
16739 <row interlinespace="default">
16740 <cell alignment="left" valignment="top" usebox="none">
16743 \begin_layout Plain Layout
16751 <cell alignment="left" valignment="top" usebox="none">
16754 \begin_layout Plain Layout
16757 Normal/reversed rain drop
16762 <cell alignment="left" valignment="top" usebox="none">
16765 \begin_layout Plain Layout
16768 Fragile, calculation might fail
16774 <row interlinespace="default">
16775 <cell alignment="left" valignment="top" usebox="none">
16778 \begin_layout Plain Layout
16787 <cell alignment="left" valignment="top" usebox="none">
16790 \begin_layout Plain Layout
16793 The \SpecialChar TeX
16799 <cell alignment="left" valignment="top" usebox="none">
16802 \begin_layout Plain Layout
16811 <row interlinespace="default">
16812 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
16815 \begin_layout Plain Layout
16819 \begin_inset Newline newline
16827 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
16830 \begin_layout Plain Layout
16833 Triangles in different orientations
16838 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
16841 \begin_layout Plain Layout
16857 \begin_layout Standard
16858 To use a shape for your paragraph, simply select it in \SpecialChar LyX
16860 for environments in the toolbar.
16863 \begin_layout Standard
16864 \begin_inset Newpage newpage
16870 \begin_layout Standard
16871 Here is an example paragraph in the shape of a nut:
16874 \begin_layout Standard
16875 \begin_inset VSpace bigskip
16884 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16885 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16887 At vero eos et accusam et justo duo dolores et ea rebum.
16888 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16890 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16891 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16895 \begin_layout Standard
16896 \begin_inset VSpace bigskip
16902 \begin_layout Standard
16903 \begin_inset Note Greyedout
16906 \begin_layout Plain Layout
16915 paragraphs cannot run over a page break.
16923 \begin_layout Standard
16924 \begin_inset VSpace bigskip
16930 \begin_layout Standard
16932 \begin_inset Flex Code
16935 \begin_layout Plain Layout
16941 takes care that the shape will always be preserved, no matter how much
16942 text is in the paragraph.
16943 Therefore the paragraph size changes with the amount of contained text.
16944 This can lead to paragraph sizes exceeding the page margins.
16945 To demonstrate the size scaling, here is the same example paragraph but
16946 with twice as much text:
16949 \begin_layout Standard
16950 \begin_inset Newpage newpage
16959 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16960 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16962 At vero eos et accusam et justo duo dolores et ea rebum.
16963 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16965 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16966 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16968 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16969 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16971 At vero eos et accusam et justo duo dolores et ea rebum.
16972 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
16974 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
16975 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
16979 \begin_layout Standard
16980 \begin_inset VSpace bigskip
16986 \begin_layout Standard
16987 An exception is the shape
16992 It cannot be scaled because it must fit the size of a CD/DVD.
16993 Therefore the amount of text that fits into the shape is limited.
16994 \begin_inset Newline newline
17005 shape are fragile, meaning that the calculation of their size can fail,
17006 depending on the amount of text.
17007 You will then get the \SpecialChar LaTeX
17009 \begin_inset Quotes eld
17012 Arithmetic overflow
17013 \begin_inset Quotes erd
17017 In this case one can try to remove or add some text; if nothing works one
17018 has to use another shape.
17021 \begin_layout Standard
17022 \begin_inset VSpace bigskip
17028 \begin_layout Standard
17029 For shapes with tips you will maybe see that \SpecialChar LaTeX
17030 's hyphenation routine fails
17031 for text in the tips.
17032 Therefore it is often necessary to add hyphenation points
17037 arg "specialchar-insert hyphenation"
17042 ) to the corresponding text parts.
17045 \begin_layout Standard
17046 \begin_inset VSpace bigskip
17052 \begin_layout Standard
17053 Shapepar paragraphs are either always centered or placed on the page so
17054 that their left border touches the left page margin.
17055 You can therefore not use the paragraph dialog to align such paragraphs.
17056 A solution is to put the paragraph into a minipage or parbox and align
17058 The problem is hereby to find the right width for the box.
17059 Because if it is too wide and you center the box, the paragraph is not
17060 centered too because it sticks at the left side of the box.
17061 So you might have to play a bit with the width until it fits.
17062 Here are two heart-shaped paragraphs, the first one is not aligned, the
17063 second one is right-aligned:
17066 \begin_layout Standard
17067 \begin_inset Newpage newpage
17073 \begin_layout Heart
17077 Lo\SpecialChar softhyphen
17078 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
17079 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
17081 At vero eos et accusam et justo duo dolores et ea rebum.
17082 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
17086 \begin_layout Standard
17087 \begin_inset VSpace bigskip
17093 \begin_layout Standard
17096 \begin_inset Box Frameless
17106 height_special "totalheight"
17111 backgroundcolor "none"
17114 \begin_layout Heart
17118 Lo\SpecialChar softhyphen
17119 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
17120 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
17122 At vero eos et accusam et justo duo dolores et ea rebum.
17123 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
17132 \begin_layout Subsubsection
17136 \begin_layout Standard
17137 You can define any shape you want.
17138 Doing this manually is a lot of work because every coordinate must be specified.
17139 But there is a way to let the computer calculate the coordinates:
17142 \begin_layout Enumerate
17143 Install the program
17144 \begin_inset CommandInset href
17147 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
17155 \begin_layout Enumerate
17162 TeX/LaTeX\SpecialChar menuseparator
17163 Settings\SpecialChar menuseparator
17166 and select the font size you are using in your document.
17167 For example this document uses the size 12
17168 \begin_inset space \thinspace{}
17174 \begin_layout Enumerate
17178 \begin_layout Enumerate
17181 TeX/LaTeX\SpecialChar menuseparator
17184 to export the shape to coordinates.
17185 In the appearing dialog use either the outline of your shape for the coordinate
17186 s or the path itself.
17190 \begin_layout Plain Layout
17191 For more information see
17192 \begin_inset CommandInset href
17194 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
17207 \begin_layout Standard
17208 The coordinates are written into a \SpecialChar TeX
17210 To use it for your \SpecialChar LyX
17214 \begin_layout Enumerate
17215 Place the cursor before the first character of your paragraph (or into a
17219 \begin_layout Enumerate
17220 Open in \SpecialChar LyX
17223 Insert\SpecialChar menuseparator
17224 File\SpecialChar menuseparator
17226 \begin_inset space ~
17231 , select the file and use
17240 \begin_layout Standard
17241 \begin_inset VSpace defskip
17247 \begin_layout Standard
17248 \begin_inset Note Greyedout
17251 \begin_layout Plain Layout
17256 : The changed shape only applies to the current paragraph; everything is
17257 reset to normal for the next paragraph.
17258 Therefore the shape definition file must be input into every paragraph
17259 with the desired shape.
17267 \begin_layout Standard
17268 \begin_inset VSpace bigskip
17274 \begin_layout Standard
17275 Here is an example:
17278 \begin_layout Standard
17279 \begin_inset VSpace bigskip
17285 \begin_layout Standard
17286 \begin_inset CommandInset include
17288 filename "SpecialParagraphShape.tex"
17295 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
17296 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
17298 At vero eos et accusam et justo duo dolores et ea rebum.
17299 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
17301 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
17302 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
17306 \begin_layout Standard
17307 \begin_inset VSpace bigskip
17313 \begin_layout Standard
17318 to draw complexer shapes in
17322 you can draw the shape in a program of your choice and import the resulting
17328 Then you only need to draw a line or spline along the outline of the image.
17331 \begin_layout Standard
17332 \begin_inset VSpace bigskip
17338 \begin_layout Standard
17341 Custom paragraph shapes
17343 also provides the two commands
17351 which can be used to define custom shapes coordinate by coordinate.
17355 \begin_layout Plain Layout
17356 These commands are internally used for all shapes described here.
17361 For information how these styles are used and about further customization
17362 possibilities, have a look at the
17363 \begin_inset CommandInset href
17365 name "documentation"
17366 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
17372 \begin_inset Flex Code
17375 \begin_layout Plain Layout
17384 \begin_layout Chapter
17386 \change_deleted 564990737 1671304317
17390 \change_inserted 564990737 1671304322
17392 \change_deleted 564990737 1671304331
17393 ies with Bib\SpecialChar TeX
17399 \begin_layout Standard
17400 The most basic information about how to use Bib\SpecialChar TeX
17405 with \SpecialChar LyX
17406 is contained in the section
17408 Bibliography databases
17415 The following subsections explain special bibliography features supported
17416 by \SpecialChar LyX
17420 \begin_layout Section
17421 Alternative Citation Styles
17424 \begin_layout Standard
17425 Standard Bib\SpecialChar TeX
17427 \begin_inset space \thinspace{}
17431 \begin_inset space \space{}
17435 \begin_inset Quotes eld
17439 \begin_inset Quotes erd
17442 ) to refer to a cited work.
17443 However, in many scientific disciplines, other citation styles are in use.
17444 The most common one is the author-year style (e.
17445 \begin_inset space \thinspace{}
17449 \begin_inset space \space{}
17453 \begin_inset Quotes eld
17457 \begin_inset Quotes erd
17462 supports three packages that provide this style,
17463 \begin_inset Flex Code
17466 \begin_layout Plain Layout
17473 \begin_inset Flex Code
17476 \begin_layout Plain Layout
17483 \begin_inset Flex Code
17486 \begin_layout Plain Layout
17493 Each of these packages has their pros and cons, which cannot be listed
17495 If you only want to have simple author-year (or author-numerical) style,
17496 or if you want to use one of the countless style files for
17497 \begin_inset Flex Code
17500 \begin_layout Plain Layout
17506 , then the established
17507 \begin_inset Flex Code
17510 \begin_layout Plain Layout
17516 package is probably your choice.
17517 If you look for specific citation styles common in law studies, you might
17519 \begin_inset Flex Code
17522 \begin_layout Plain Layout
17529 If you want to have full control over the formatting or look for advanced
17530 features such as ibidem, footnote citations, full title citations, advanced
17531 date formats (such as 400 BC) or full localization to other languages than
17532 English, you should definitely consider
17533 \begin_inset Flex Code
17536 \begin_layout Plain Layout
17542 , which exceeds all other packages in terms of features, but is also quite
17543 heavy and more resource-hungry.
17546 \begin_layout Standard
17547 The handling of these packages in \SpecialChar LyX
17548 is basically the same.
17550 \begin_inset Flex Noun
17553 \begin_layout Plain Layout
17554 Document\SpecialChar menuseparator
17561 \begin_inset Flex Noun
17564 \begin_layout Plain Layout
17571 \begin_inset Flex Noun
17574 \begin_layout Plain Layout
17581 \begin_inset Flex Noun
17584 \begin_layout Plain Layout
17591 \begin_inset Flex Noun
17594 \begin_layout Plain Layout
17601 \begin_inset Flex Noun
17604 \begin_layout Plain Layout
17605 Biblatex (Natbib mode)
17611 \begin_inset Flex Noun
17614 \begin_layout Plain Layout
17621 \begin_inset Flex Noun
17624 \begin_layout Plain Layout
17631 \begin_inset space ~
17634 6.5.3 in the User's Guide for more information on these choices).
17635 With all these packages, you will get some extra features in the citation
17636 dialog and you can select the style of the reference (
17637 \begin_inset Quotes eld
17641 \begin_inset Quotes erd
17645 \begin_inset Quotes eld
17649 \begin_inset Quotes erd
17653 \begin_inset Quotes eld
17657 \begin_inset Quotes erd
17661 \begin_inset Quotes eld
17665 \begin_inset Quotes erd
17669 Note that either package needs specifically designed style files.
17670 They all ship their own, but there are lots of additional style files,
17671 and there is even an interactive style file builder
17675 \begin_layout Plain Layout
17677 \begin_inset Flex URL
17680 \begin_layout Plain Layout
17682 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
17693 \begin_inset Flex Code
17696 \begin_layout Plain Layout
17705 \begin_layout Section
17706 Subdivided Bibliographies
17709 \begin_layout Standard
17710 Sometimes you might need to divide your bibliography into several sections.
17711 If you are for instance a historian, the possibility to separate sources
17712 and scientific works is most likely a
17713 \begin_inset Quotes eld
17717 \begin_inset Quotes erd
17721 Unfortunately, Bib\SpecialChar TeX
17722 itself does not allow you to do this.
17723 But with the help of some \SpecialChar LaTeX
17724 packages, Bib\SpecialChar TeX
17725 can be extended to fit your needs.
17728 \begin_layout Standard
17730 provides native support for one of these packages,
17738 \begin_layout Plain Layout
17740 \begin_inset Flex URL
17743 \begin_layout Plain Layout
17745 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
17755 The advantage of this package (compared to other packages such as
17759 ) is that you don't need to define new citation commands.
17760 Instead, you need to prepare different bibliographic databases which include
17761 the entries for the different sections of the bibliography.
17762 For example: If you want to divide your bibliography into the sections
17764 \begin_inset Quotes eld
17768 \begin_inset Quotes erd
17772 \begin_inset Quotes eld
17776 \begin_inset Quotes erd
17779 , you first need to create two bibliographic databases, e.
17780 \begin_inset space \thinspace{}
17784 \begin_inset space \space{}
17788 \begin_inset Flex Code
17791 \begin_layout Plain Layout
17798 \begin_inset Flex Code
17801 \begin_layout Plain Layout
17811 \begin_layout Standard
17813 \begin_inset Flex Noun
17816 \begin_layout Plain Layout
17817 Document\SpecialChar menuseparator
17824 \begin_inset Flex Noun
17827 \begin_layout Plain Layout
17834 \begin_inset Flex Noun
17837 \begin_layout Plain Layout
17838 Subdivided bibliography
17844 Now you can insert multiple Bib\SpecialChar TeX
17845 bibliographies, one for each section of
17847 Returning to our example: Insert the Bib\SpecialChar TeX
17849 \begin_inset Flex Code
17852 \begin_layout Plain Layout
17858 and a second one for the database
17859 \begin_inset Flex Code
17862 \begin_layout Plain Layout
17869 You are free to use the same or different styles for each section.
17870 Additionally, you can choose if the bibliography section should contain
17872 \begin_inset Quotes eld
17875 all cited references
17876 \begin_inset Quotes erd
17879 of the specified database(s) (which is the default),
17880 \begin_inset Quotes eld
17883 all uncited references
17884 \begin_inset Quotes erd
17888 \begin_inset Quotes eld
17892 \begin_inset Quotes erd
17896 This might be useful if you would like to separate your bibliography into
17898 \begin_inset Quotes eld
17902 \begin_inset Quotes erd
17906 \begin_inset Quotes eld
17910 \begin_inset Quotes erd
17914 \begin_inset Quotes eld
17918 \begin_inset Quotes erd
17922 The titles for the sections can be added as ordinary sections or subsections.
17924 \begin_inset Flex Code
17927 \begin_layout Plain Layout
17933 removes the bibliography title, you have to manually re-add that, too (as
17934 a chapter* or section*, for instance).
17937 \begin_layout Standard
17942 , the procedure is a bit different.
17951 , the aforementioned
17952 \begin_inset Flex Noun
17955 \begin_layout Plain Layout
17956 Subdivided bibliography
17961 option is disabled if you use
17970 provides its own means to generate subdivided bibliographies.
17971 You can either add keywords to bibliography entries via the
17972 \begin_inset Flex Code
17975 \begin_layout Plain Layout
17981 entry option and then filter bibliography sections by keyword (by adding
17983 \begin_inset Flex Code
17986 \begin_layout Plain Layout
17993 \begin_inset Flex Noun
17996 \begin_layout Plain Layout
18002 field of the dialog that opens if you left-click on the
18003 \begin_inset Flex Noun
18006 \begin_layout Plain Layout
18007 Biblatex Generated Bibliography
18012 button), or you can filter by entry types (such as
18021 \begin_inset space \thinspace{}
18026 \begin_inset Flex Code
18029 \begin_layout Plain Layout
18036 \begin_inset Flex Code
18039 \begin_layout Plain Layout
18046 \begin_inset Flex Noun
18049 \begin_layout Plain Layout
18055 field, or you can create so-called
18056 \begin_inset Quotes eld
18059 Bibliography Categories
18060 \begin_inset Quotes erd
18063 to which you can assign individual entries.
18064 Please refer to the Biblatex manual, section
18066 Subdivided Bibliographies
18071 \begin_layout Section
18072 Multiple Bibliographies
18073 \begin_inset CommandInset label
18075 name "subsec:Multiple-Bibliographies"
18082 \begin_layout Standard
18083 Multiple bibliographies, e.
18084 \begin_inset space \thinspace{}
18088 \begin_inset space \space{}
18091 a bibliography for each part, chapter, section, subsection or child (sub-documen
18092 t) of the document, are also supported by \SpecialChar LyX
18094 In order to enable it, go to
18095 \begin_inset Flex Noun
18098 \begin_layout Plain Layout
18099 Document\SpecialChar menuseparator
18100 Settings\SpecialChar menuseparator
18106 and select the relevant unit (e.
18107 \begin_inset space \thinspace{}
18111 \begin_inset Quotes eld
18115 \begin_inset Quotes erd
18119 \begin_inset Flex Noun
18122 \begin_layout Plain Layout
18123 Multiple Bibliographies
18129 Then add a Bib(la)\SpecialChar TeX
18130 bibliography to each unit (e.
18131 \begin_inset space \thinspace{}
18134 g., section) of your document.
18135 In the output, a separate bibliography, containing only the references
18136 done in the current unit is generated.
18139 \begin_layout Standard
18140 If you use Bib\SpecialChar TeX
18142 \begin_inset Flex Code
18145 \begin_layout Plain Layout
18152 \begin_inset Flex Code
18155 \begin_layout Plain Layout
18161 package is used to create multiple bibliographies.
18162 The former package is used if you select
18163 \begin_inset Quotes eld
18167 \begin_inset Quotes erd
18175 \begin_inset Flex Noun
18178 \begin_layout Plain Layout
18179 Sectioned Bibliography
18185 In all other cases,
18186 \begin_inset Flex Code
18189 \begin_layout Plain Layout
18199 \begin_layout Plain Layout
18200 An alternative approach, if you are willing to use some
18201 \begin_inset Flex Noun
18204 \begin_layout Plain Layout
18212 \begin_inset space ~
18216 \begin_inset CommandInset ref
18218 reference "sec:Inserting-TeX-Code"
18223 \begin_inset Flex Code
18226 \begin_layout Plain Layout
18238 \begin_inset Flex Code
18241 \begin_layout Plain Layout
18247 is used, \SpecialChar LyX
18248 encloses the specified units in
18249 \begin_inset Flex Code
18252 \begin_layout Plain Layout
18259 \begin_inset Flex Code
18262 \begin_layout Plain Layout
18271 \begin_inset Flex Code
18274 \begin_layout Plain Layout
18282 in order to create the units.
18283 Note that this approach has some limitations.
18284 First, every citation reference has to be inside some
18285 \begin_inset Flex Code
18288 \begin_layout Plain Layout
18295 So citations outside a defined unit (e.
18296 \begin_inset space \thinspace{}
18299 g., before the first section if you use
18300 \begin_inset Quotes eld
18304 \begin_inset Quotes erd
18308 \begin_inset Quotes eld
18312 \begin_inset Quotes erd
18316 You can also create your own units by entering
18317 \begin_inset Flex Code
18320 \begin_layout Plain Layout
18329 \begin_inset Flex Code
18332 \begin_layout Plain Layout
18340 as \SpecialChar TeX
18341 code (for instance to work around the mentioned limitation).
18343 \begin_inset Flex Code
18346 \begin_layout Plain Layout
18352 s cannot be nested.
18353 A second limitation is that
18354 \begin_inset Flex Code
18357 \begin_layout Plain Layout
18363 always processes all references of a bibliography database, even if they
18365 This can result in odd labels (e.
18366 \begin_inset space \thinspace{}
18371 \begin_inset Quotes eld
18375 \begin_inset Quotes erd
18378 if two works of this author from 2014 are in the database, even if only
18382 \begin_layout Standard
18388 \begin_inset Flex Code
18391 \begin_layout Plain Layout
18397 option is used instead.
18398 If you need specific units, you can start them with the \SpecialChar TeX
18400 \begin_inset Flex Code
18403 \begin_layout Plain Layout
18412 \begin_inset Flex Code
18415 \begin_layout Plain Layout
18424 If you also want to control the end of the unit, use the environment
18425 \begin_inset Flex Code
18428 \begin_layout Plain Layout
18438 \begin_inset Flex Code
18441 \begin_layout Plain Layout
18451 \begin_inset Flex Code
18454 \begin_layout Plain Layout
18460 s cannot be nested.
18461 In addition to the individual bibliography of the current unit,
18465 also provides an easy way to output all bibliographies, subsequently, at
18467 \begin_inset space \thinspace{}
18470 g., at the end of the document).
18472 \begin_inset Quotes eld
18475 all reference units
18476 \begin_inset Quotes erd
18479 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
18481 Please refer to the
18485 manual for more information on this topic.
18488 \begin_layout Chapter
18490 \change_deleted 564990737 1671355654
18494 \change_inserted 564990737 1671355667
18496 \change_deleted 564990737 1671355661
18498 \change_inserted 564990737 1671355684
18500 \begin_inset CommandInset label
18502 name "chap:bullets"
18507 \change_deleted 564990737 1671355684
18509 \begin_inset CommandInset label
18520 \begin_layout Standard
18526 \begin_layout Section
18530 \begin_layout Standard
18532 provides 216 bullet shapes that can be accessed from a simple dialog.
18533 Using this dialog you can easily specify what bullet shape to use at each
18534 level of an itemized list.
18535 These settings are document-wide so you won't be able to specify different
18536 sets of bullets for different paragraphs.
18540 \begin_layout Plain Layout
18541 Well, actually you can but you'll have to do it by hand.
18549 \begin_layout Section
18553 \begin_layout Standard
18554 Open the dialog by selecting the
18555 \begin_inset Flex Noun
18558 \begin_layout Plain Layout
18559 Document\SpecialChar menuseparator
18565 menu item and then select the
18566 \begin_inset Flex Noun
18569 \begin_layout Plain Layout
18578 \begin_layout Standard
18579 The dialog provides you with a table of bullet shapes.
18580 A column of buttons on the left of the table provides access to the six
18581 different panels of bullet shapes.
18582 The row of buttons across the top is used to select which bullet depth
18585 \change_deleted 244031559 1603875981
18586 A text entry under the table shows the currently selected bullet shape's
18588 equivalent and this can be edited if desired.
18589 If you do modify the text you will also need to specify any needed packages
18590 in the \SpecialChar LaTeX
18596 \begin_layout Standard
18597 The six panels are divided up by the packages they require.
18598 The following table shows the mappings from button name to \SpecialChar LaTeX
18602 \begin_layout Standard
18604 \begin_inset Tabular
18605 <lyxtabular version="3" rows="7" columns="2">
18606 <features tabularvalignment="middle">
18607 <column alignment="center" valignment="top" width="0pt">
18608 <column alignment="center" valignment="top" width="0pt">
18610 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18613 \begin_layout Plain Layout
18628 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
18631 \begin_layout Plain Layout
18648 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18651 \begin_layout Plain Layout
18666 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18669 \begin_layout Plain Layout
18678 base \SpecialChar LaTeX
18686 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18689 \begin_layout Plain Layout
18704 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18707 \begin_layout Plain Layout
18724 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18727 \begin_layout Plain Layout
18742 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18745 \begin_layout Plain Layout
18762 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18765 \begin_layout Plain Layout
18780 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18783 \begin_layout Plain Layout
18800 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
18803 \begin_layout Plain Layout
18818 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
18821 \begin_layout Plain Layout
18838 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
18841 \begin_layout Plain Layout
18856 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
18859 \begin_layout Plain Layout
18882 \begin_layout Standard
18884 doesn't stop you using bullets from packages you don't have.
18885 If you get errors from \SpecialChar LaTeX
18886 when you try to view or print the file, then it
18887 is likely you are missing a package.
18891 \begin_layout Plain Layout
18893 doesn't restrict your use since you may be editing locally and exporting
18902 \begin_layout Section
18906 \begin_layout Standard
18907 Select which bullet depth you want to change then select the bullet shape
18909 Any changes will not be visible in \SpecialChar LyX
18910 , but are visible when viewing the document.
18913 \begin_layout Standard
18914 You can reset a bullet shape to the default simply by clicking your right
18915 mouse button on the appropriate bullet depth button.
18919 \begin_layout Plain Layout
18924 want to have multiple sets of paragraphs with different sets of bullets
18925 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
18927 The bullet selection dialog can help though because it provides you with
18928 the \SpecialChar LaTeX
18929 code for a wide range of bullet shapes.
18930 To make your own custom paragraphs you have the following options:
18933 \begin_layout Plain Layout
18937 \begin_layout Plain Layout
18953 \begin_layout Plain Layout
18957 \begin_layout Plain Layout
18979 \begin_layout Itemize
18980 Use the \SpecialChar LaTeX
18982 \begin_inset Flex Code
18985 \begin_layout Plain Layout
18993 to specify a new bullet shape for a given depth.
18994 You'll also need to save the current bullet shape so you can restore it
18996 In this itemized list the following \SpecialChar LaTeX
18997 code was used to change the bullet
18998 used for the first depth.
19002 \begin_layout LyX-Code
19012 \begin_layout LyX-Code
19029 \begin_layout Itemize
19030 Note that the itemize depth is specified in Roman numerals as part of the
19040 \begin_layout Itemize
19041 \begin_inset Argument item:1
19044 \begin_layout Plain Layout
19048 \begin_layout Plain Layout
19066 Specify each individual entry by starting each item with the bullet shape
19068 \begin_inset Quotes eld
19072 \begin_inset Quotes erd
19075 inset (available at
19077 Insert\SpecialChar menuseparator
19081 \begin_inset Flex Noun
19084 \begin_layout Plain Layout
19092 For example, this item was started with
19093 \begin_inset Flex Code
19096 \begin_layout Plain Layout
19111 \begin_layout Plain Layout
19115 \begin_layout Plain Layout
19131 \begin_layout Plain Layout
19132 You'll also need to revert the labelitem back to its previous setting for
19133 the global bullet shape settings to remain in effect.
19134 The way used here was:
19137 \begin_layout LyX-Code
19152 \begin_layout Chapter
19156 \begin_layout Section
19157 Multipart Documents
19160 \begin_layout Subsection
19164 \begin_layout Standard
19165 When you are working on a large file with many sections, it is often convenient
19166 to break up the document into several files, or perhaps you have something
19167 where a table may change from time to time, but the preceding text does
19169 In these cases, you should seriously consider using multipart documents.
19170 For example, scientific papers often have five major sections: the introduction
19171 , observations, results, discussion, and conclusion.
19172 Each of these could be its own separate \SpecialChar LyX
19174 \begin_inset Quotes eld
19178 \begin_inset Quotes erd
19181 file which contains the title, authors, abstract, references, etc., plus
19182 the five included files.
19183 It is important to note that each of these files is a full \SpecialChar LyX
19185 can be formatted and printed on its own, as well as included in a master
19187 Each of these files must have the same document class, however—don't attempt
19188 to mix book classes with article classes.
19189 You may also include \SpecialChar LaTeX
19190 files; however, these files must not have their own
19192 \begin_inset space \thinspace{}
19196 \begin_inset space \space{}
19199 everything up to and including the
19200 \begin_inset Flex Code
19203 \begin_layout Plain Layout
19211 line as well as the
19212 \begin_inset Flex Code
19215 \begin_layout Plain Layout
19223 line must be deleted) or else errors will be generated when you try to
19227 \begin_layout Standard
19229 allows you to include files quite easily with
19230 \begin_inset Flex Noun
19233 \begin_layout Plain Layout
19234 Insert\SpecialChar menuseparator
19236 \begin_inset space ~
19245 When you click on this selection a small box is inserted into the file
19246 at the current cursor location.
19247 Clicking on the box raises a dialog which allows you to select the file
19248 to be included, and the method of its inclusion.
19252 \begin_layout Standard
19253 The file selection box should by now be obvious.
19254 The three inclusion methods are
19255 \begin_inset Quotes eld
19259 \begin_inset Quotes erd
19263 \begin_inset Quotes eld
19267 \begin_inset Quotes erd
19271 \begin_inset Quotes eld
19275 \begin_inset Quotes erd
19280 \begin_inset Quotes eld
19284 \begin_inset Quotes erd
19288 \begin_inset Quotes eld
19292 \begin_inset Quotes erd
19295 are similar in many ways, but there are also some notable differences:
19298 \begin_layout Enumerate
19300 \begin_inset Quotes eld
19304 \begin_inset Quotes erd
19307 are typeset beginning on a new page, while files that are
19308 \begin_inset Quotes eld
19312 \begin_inset Quotes erd
19315 are typeset starting on the current page.
19318 \begin_layout Enumerate
19319 \begin_inset Quotes eld
19323 \begin_inset Quotes erd
19326 files cannot themselves
19327 \begin_inset Quotes eld
19331 \begin_inset Quotes erd
19335 \begin_inset Quotes eld
19339 \begin_inset Quotes erd
19344 \begin_inset Quotes eld
19348 \begin_inset Quotes erd
19351 , on the other hand, infinite sub-inputting is possible.
19354 \begin_layout Enumerate
19355 \begin_inset Quotes eld
19359 \begin_inset Quotes erd
19362 allow for the output of only selected
19363 \begin_inset Quotes eld
19367 \begin_inset Quotes erd
19370 files, while maintaining the actual counters (pagination etc.) and references
19371 (please refer to the section
19374 \begin_inset space ~
19382 \begin_inset space ~
19387 manual for details).
19390 \begin_layout Standard
19392 \begin_inset Quotes eld
19396 \begin_inset Quotes erd
19399 is the preferred method for chapters that are outsourced to child documents,
19401 \begin_inset Quotes eld
19405 \begin_inset Quotes erd
19408 is more suitable for arbitrary file inheritance.
19411 \begin_layout Standard
19413 \begin_inset Quotes eld
19417 \begin_inset Quotes erd
19420 included file allows you to include a file typeset exactly as it appears
19422 \begin_inset space \thinspace{}
19426 \begin_inset space \space{}
19430 \begin_inset Flex Code
19433 \begin_layout Plain Layout
19439 mode, with the characters set in a fixed-width typewriter font.
19440 Normally, spaces in this file are invisible, though two consecutive spaces
19441 are conserved, unlike \SpecialChar LyX
19442 's normal treatment of spaces.
19443 However, setting the
19444 \begin_inset Flex Noun
19447 \begin_layout Plain Layout
19449 \begin_inset space ~
19453 \begin_inset space ~
19457 \begin_inset space ~
19465 checkbox typesets a mark to unambiguously define the presence of a space.
19469 \begin_layout Standard
19470 Generally, the master file is converted into a full \SpecialChar LaTeX
19471 file before typesetting,
19472 while the included files are converted to \SpecialChar LaTeX
19473 files that do not have all the
19474 preamble information.
19477 \begin_layout Subsection
19478 Cross-References Between Files
19481 \begin_layout Standard
19482 \begin_inset Box Shadowbox
19492 height_special "totalheight"
19497 backgroundcolor "none"
19500 \begin_layout Plain Layout
19501 This section is somewhat out of date.
19502 Need to describe default master documents and how children are opened when
19512 \begin_layout Standard
19513 It is possible to set up cross-references between the different files.
19514 First, open all the files in question: let's call them A and B in a two
19515 file example, where B is included in A.
19516 Let's say you insert a label in A, then want to reference it in B.
19517 Open the cross-reference dialog whilst in document B, and you can select
19519 \begin_inset Quotes eld
19523 \begin_inset Quotes erd
19529 \begin_layout Subsection
19530 Bibliography Lists in all Subdocuments
19533 \begin_layout Standard
19534 If you work with child documents, you might want to have only one main bibliogra
19535 phy at the end, but still be able to have a selected bibliography for the
19536 child if you output it on its own.
19537 Here is how to achieve this.
19540 \begin_layout Standard
19541 For the main document, you just insert a bibliography inset at the place
19542 where the main bibliography has to appear (within the master file or within
19544 If the bibliography inset is in the master file, the references will be
19545 inherited by all children, so they are available in the citation dialog
19549 \begin_layout Standard
19550 For child-specific bibliographies, insert bibliography insets within the
19551 child documents, at the place where the bibliography should appear when
19552 the child is compiled separately.
19553 However, the trick is to insert them into a branch (
19555 Insert\SpecialChar menuseparator
19556 Branch\SpecialChar menuseparator
19557 Insert New Branch...
19560 \begin_inset space \thinspace{}
19565 \begin_inset Quotes eld
19569 \begin_inset Quotes erd
19573 Within the children, activate the branch (
19575 Document\SpecialChar menuseparator
19576 Settings...\SpecialChar menuseparator
19580 Within the master, deactivate the branch (
19582 Document\SpecialChar menuseparator
19583 Settings...\SpecialChar menuseparator
19587 Now the child's bibliography will be ignored by the master, but considered
19591 \begin_layout Standard
19592 If you need multiple bibliographies (e.
19593 \begin_inset space \thinspace{}
19596 g., one per child in the
19600 ), please refer to sec.
19601 \begin_inset space ~
19605 \begin_inset CommandInset ref
19607 reference "subsec:Multiple-Bibliographies"
19614 \begin_layout Section
19619 \begin_layout Standard
19620 Users sometimes need to be able to
19621 \begin_inset Quotes eld
19625 \begin_inset Quotes erd
19629 file together with all the images (and other files) on which it depends,
19630 either for sending to a publisher or for sharing with a co-author.
19632 includes a Python script (
19633 \begin_inset Flex Code
19636 \begin_layout Plain Layout
19642 ) that automates this process.
19643 To use it, you must have either the
19644 \begin_inset Flex Code
19647 \begin_layout Plain Layout
19654 \begin_inset Flex Code
19657 \begin_layout Plain Layout
19663 python modules installed on your system.
19664 By default, the script prefers the
19665 \begin_inset Flex Code
19668 \begin_layout Plain Layout
19675 \begin_inset Flex Code
19678 \begin_layout Plain Layout
19684 format on Unix-like systems and the
19685 \begin_inset Flex Code
19688 \begin_layout Plain Layout
19697 \begin_layout Standard
19699 's configuration process will set the script up to export a `\SpecialChar LyX
19701 and this format will then be available under
19702 \begin_inset Flex Code
19705 \begin_layout Plain Layout
19706 File\SpecialChar menuseparator
19715 \begin_layout Standard
19716 Independently of the platform, the generation of a particular archive format
19717 can be forced by adding either the
19718 \begin_inset Flex Code
19721 \begin_layout Plain Layout
19728 \begin_inset Flex Code
19731 \begin_layout Plain Layout
19738 \begin_inset Flex Code
19741 \begin_layout Plain Layout
19748 \begin_inset Flex Code
19751 \begin_layout Plain Layout
19757 format) switch to the
19758 \begin_inset Flex Code
19761 \begin_layout Plain Layout
19763 \SpecialChar menuseparator
19771 \begin_inset Flex Code
19774 \begin_layout Plain Layout
19775 Tools\SpecialChar menuseparator
19776 Preferences\SpecialChar menuseparator
19777 File Handling\SpecialChar menuseparator
19784 (Make sure you add the switch after the script name, not before it.)
19787 \begin_layout Section
19788 Fancy Headers and Footers
19791 \begin_layout Standard
19792 The default page layout is rather plain; for an
19793 \begin_inset Flex Code
19796 \begin_layout Plain Layout
19802 document class, all you get is a centered page number at the bottom of
19804 This document uses KOMA-script's book class, so it appears to be a bit
19806 But to really put on a show, you need to set the document page style to
19808 \begin_inset Quotes eld
19812 \begin_inset Quotes erd
19815 , as mentioned in the
19820 This section describes the \SpecialChar LaTeX
19821 code you need to insert in your \SpecialChar LaTeX
19823 order to get the desired effects.
19826 \begin_layout Standard
19827 For more information on fancy headers, see the
19828 \begin_inset Flex Code
19831 \begin_layout Plain Layout
19837 package documentation.
19839 \begin_inset Flex URL
19842 \begin_layout Plain Layout
19844 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
19852 \begin_layout Standard
19853 The page header is divided into three fields, not surprisingly labeled
19854 \begin_inset Quotes eld
19858 \begin_inset Quotes erd
19862 \begin_inset Quotes eld
19866 \begin_inset Quotes erd
19870 \begin_inset Quotes eld
19874 \begin_inset Quotes erd
19878 The footer is also divided into these three fields.
19879 The \SpecialChar LaTeX
19880 commands to set these fields in the simplest manner are
19881 \begin_inset Flex Code
19884 \begin_layout Plain Layout
19893 \begin_inset Flex Code
19896 \begin_layout Plain Layout
19905 \begin_inset Flex Code
19908 \begin_layout Plain Layout
19917 \begin_inset Flex Code
19920 \begin_layout Plain Layout
19929 Suppose you wish to put your name in the upper left hand corner of each
19931 Simply insert the following command in the preamble:
19934 \begin_layout Standard
19943 \begin_layout Standard
19944 You will now see your name in the upper left.
19945 If a field has a default entry that you would like to get rid of (often
19946 the page number appears in the central footer) simply include a command
19947 with a blank argument, e.
19948 \begin_inset space \thinspace{}
19954 \begin_layout Standard
19962 \begin_layout Standard
19963 Let's get really fancy: lets put the section number with the word
19964 \begin_inset Quotes eld
19968 \begin_inset Quotes erd
19972 \begin_inset space \thinspace{}
19976 \begin_inset space \space{}
19979 Section 3) in the upper left, the page number (e.
19980 \begin_inset space \thinspace{}
19984 \begin_inset space \space{}
19987 Page 4) in the upper right, your name in the lower left, and the date in
19989 The following commands should now appear in the preamble:
19992 \begin_layout Standard
20002 \begin_layout Standard
20010 \begin_layout Standard
20020 \begin_layout Standard
20029 \begin_layout Standard
20037 \begin_layout Standard
20047 \begin_layout Standard
20049 \begin_inset Flex Code
20052 \begin_layout Plain Layout
20061 \begin_inset Flex Code
20064 \begin_layout Plain Layout
20072 access \SpecialChar LaTeX
20073 's section and page counters, and so print out the current section
20076 \begin_inset Flex Code
20079 \begin_layout Plain Layout
20087 simply prints out today's date.
20090 \begin_layout Standard
20091 The thicknesses of the horizontal rules drawn beneath the header and above
20092 the footer can also be modified.
20093 If you don't want one of the rules, set its thickness to 0.
20094 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
20100 \begin_inset Flex Code
20103 \begin_layout Plain Layout
20108 headrulewidth}{0.4pt}
20114 \begin_inset Flex Code
20117 \begin_layout Plain Layout
20122 footrulewidth}{0.4pt}
20127 to set the thicknesses.
20130 \begin_layout Standard
20131 You can switch the header/footer settings on and off for individual pages
20132 using commands like
20133 \begin_inset Flex Code
20136 \begin_layout Plain Layout
20139 thispagestyle{empty}
20145 \begin_inset Flex Code
20148 \begin_layout Plain Layout
20151 thispagestyle{plain}
20157 \begin_inset Flex Code
20160 \begin_layout Plain Layout
20163 thispagestyle{fancy}
20169 Simply insert them in the text on the page you want changed and mark them
20170 as \SpecialChar TeX
20172 In fact, title pages are marked as plain by default, while following pages
20173 are marked fancy when using the global fancy setting.
20176 \begin_layout Standard
20177 As a final example, it is possible to include an image in the header or
20179 Suppose you want to put a company logo in the upper lefthand corner.
20180 You might try something like
20183 \begin_layout Standard
20192 includegraphics{logo.eps}}}
20195 \begin_layout Standard
20197 (you may need to preface this with
20198 \begin_inset Flex Code
20201 \begin_layout Plain Layout
20204 usepackage{graphics}
20209 if you don't include graphics elsewhere in your document).
20212 \begin_layout Chapter
20214 and the World Wide Web
20217 \begin_layout Standard
20219 has long supported the export of documents to various web-friendly formats,
20221 Before version 2.0, however, HTML export was always accomplished by the
20222 use of external converters.
20226 \begin_layout Plain Layout
20227 For details on the use of external converters with \SpecialChar LyX
20232 section of the Customization manual.
20237 These fall into two large groups: there are converters that use \SpecialChar LaTeX
20239 intermediate format, such as
20240 \begin_inset Flex Code
20243 \begin_layout Plain Layout
20250 \begin_inset Flex Code
20253 \begin_layout Plain Layout
20260 \begin_inset Flex Code
20263 \begin_layout Plain Layout
20269 , relying upon \SpecialChar LyX
20270 to produce the \SpecialChar LaTeX
20271 ; and there is a converter that works directly
20272 on \SpecialChar LyX
20274 \begin_inset Flex Code
20277 \begin_layout Plain Layout
20285 All of these have different advantages and disadvantages.
20289 \begin_layout Standard
20290 The \SpecialChar LaTeX
20291 -based converters have the advantage that, in principle, they know everythin
20292 g about the exported document that \SpecialChar LaTeX
20294 Such converters do not care, for example, if a certain block of code was
20295 produced by \SpecialChar LyX
20296 or was Evil Red Text.
20297 These converters know about
20298 \begin_inset Flex Code
20301 \begin_layout Plain Layout
20307 files, counters, and references, and can often make use of the
20308 \begin_inset Flex Code
20311 \begin_layout Plain Layout
20317 files generated by Bib\SpecialChar TeX
20319 On the other hand, \SpecialChar LaTeX
20320 is a very hard language to parse—it is sometimes said
20321 that only \SpecialChar TeX
20322 itself understands \SpecialChar TeX
20323 —and \SpecialChar LaTeX
20324 -based converters will often choke on
20325 what seem to be quite simple constructs; complex ones can throw them completely
20326 , and as of this writing, for example, the
20330 manual will not export with
20331 \begin_inset Flex Code
20334 \begin_layout Plain Layout
20340 , though the others will.
20341 The other issue concerns how math is handled.
20342 These converters typically convert the formulae into little pictures that
20343 are then linked from the HTML document.
20344 Since these are actually generated by \SpecialChar LaTeX
20345 , they are accurate.
20346 But they do not scale well, and just getting them to look as if they are
20347 actually meant to be in your document—so that the font sizes seem to be
20348 roughly the same—can be a challenge.
20351 \begin_layout Standard
20353 \begin_inset Flex Code
20356 \begin_layout Plain Layout
20364 \begin_inset CommandInset href
20366 name "http://pinchito.es/elyxer/"
20367 target "http://pinchito.es/elyxer/"
20372 ) solves some of these problems.
20373 In particular, the formulae it produces scale perfectly, since it renders
20374 math using a combination of HTML and CSS rather than converting the formulae
20376 But even moderately complex formula are rendered less well than with
20377 \begin_inset Flex Code
20380 \begin_layout Plain Layout
20386 ; this reflects the limitations of HTML.
20390 \begin_layout Plain Layout
20392 \begin_inset Flex Code
20395 \begin_layout Plain Layout
20402 can also use jsMath and MathJax for equations, but this setting is only
20403 available globally and requires one to have access to a server that runs
20409 More importantly (as of version 1.1.1, at least),
20410 \begin_inset Flex Code
20413 \begin_layout Plain Layout
20420 has limited support for math macros and no support for user-defined paragraph
20421 or character styles.
20422 These limitations make
20423 \begin_inset Flex Code
20426 \begin_layout Plain Layout
20433 unsuitable for many of the documents \SpecialChar LyX
20435 In principle, of course, these problems could be solved, but the \SpecialChar LyX
20437 have decided to follow a different path and have made \SpecialChar LyX
20439 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
20440 , DocBook, and plaintext.
20443 \begin_layout Standard
20444 As of this writing, XHTML output remains under development and should probably
20446 \begin_inset Quotes eld
20450 \begin_inset Quotes erd
20457 \begin_layout Plain Layout
20459 \begin_inset Flex Code
20462 \begin_layout Plain Layout
20463 development/HTML/HTML.notes
20468 , which can be found in the \SpecialChar LyX
20470 \begin_inset CommandInset href
20472 name "accessed online"
20473 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
20478 , usually contains up-to-date information about the state of XHTML output.
20479 See also the list of XHTML bugs on
20480 \begin_inset CommandInset href
20482 name "the bug tracker"
20483 target "https://www.lyx.org/trac/query?status=reopened&status=assigned&status=new&max=0&component=xhtml+export&order=id&col=id&col=summary&col=reporter&col=keywords&keywords=%21%7Efixedintrunk&desc=1"
20493 Still, the developers have chosen this approach because it has several
20494 potential advantages over the other two.
20497 \begin_layout Standard
20498 These advantages are primarily due to the fact that the XHTML output routines,
20499 since they are part of \SpecialChar LyX
20500 , know everything \SpecialChar LyX
20501 knows about the document being
20506 \begin_layout Plain Layout
20507 Another advantage is that, since these routines are internal to \SpecialChar LyX
20509 immune to changes in \SpecialChar LyX
20510 's file format, or to changes in the semantics of
20516 So they know about the table of contents (as displayed in the outline),
20517 about the counters associated with different paragraph styles, and about
20518 user-defined styles.
20519 The XHTML output routines know what \SpecialChar LyX
20520 knows about internationalization,
20521 too, so they will output
20522 \begin_inset Quotes eld
20526 \begin_inset Quotes erd
20530 \begin_inset Quotes eld
20538 \begin_inset Quotes erd
20541 , depending upon the language in effect at the time.
20545 \begin_layout Standard
20546 Quite generally, the output routines know what \SpecialChar LyX
20547 knows about document layout,
20548 that is, about how the document is to be rendered on screen.
20549 We use this information when we output the document as XHTML.
20550 In particular, \SpecialChar LyX
20555 generates CSS style information corresponding to the layout information
20556 it uses to render the document on screen: if section headings are supposed
20557 to be sans-serif and bold as seen in \SpecialChar LyX
20558 , then (by default) they will be sans-seri
20559 f and bold when viewed in a web browser, too.
20560 And this is true not just for pre-defined styles, like Section, but for
20561 any style, including user-defined styles.
20562 Indeed, the XHTML output routines make no distinction between user-defined
20564 \change_deleted 244031559 1603876931
20566 \change_inserted 244031559 1603876940
20569 styles and \SpecialChar LyX
20570 's own pre-defined styles: in each case, everything \SpecialChar LyX
20572 the styles is contained in the layout files.
20573 And much the same is true as regards pre-defined textual insets, such as
20574 footnotes, and various custom insets.
20578 \begin_layout Standard
20579 The result is that XHTML output can be customized and extended in exactly
20580 the same way \SpecialChar LaTeX
20581 output can be customized and extended: through layout files
20583 See chapter five of the
20587 manual for the details.
20590 \begin_layout Standard
20591 The remainder of this chapter contains more detailed information on XHTML
20592 output, its limitations, and ways to work around those limitations.
20595 \begin_layout Section
20596 Math Output in XHTML
20599 \begin_layout Standard
20601 offers four choices for how math is rendered.
20602 These have various advantages and disadvantages:
20605 \begin_layout Itemize
20607 \begin_inset Newline newline
20610 MathML is a dialect of XML designed specifically for mathematics on the
20611 web, and it typically renders very well in browsers that support it.
20612 The disadvantage is that not all browsers support MathML, and support is
20613 not complete even in the Gecko-based browsers, such as Firefox.
20614 \begin_inset Newline newline
20617 If \SpecialChar LyX
20618 is unable to render a formula as MathML—for example, if the formula
20620 \begin_inset Flex Code
20623 \begin_layout Plain Layout
20629 package or ERT—then it will instead output the formula as an image.
20633 \begin_layout Itemize
20635 \begin_inset Newline newline
20638 As mentioned above,
20639 \begin_inset Flex Code
20642 \begin_layout Plain Layout
20648 outputs math as HTML, styled by CSS.
20652 \begin_layout Plain Layout
20654 has borrowed some of the CSS for its HTML output from
20655 \begin_inset Flex Code
20658 \begin_layout Plain Layout
20669 For simple formulae, this can work quite well, though with more complicated
20670 formulae it tends to break down.
20671 Still, this method has the advantage that it is very widely supported and
20672 so it may be appropriate for documents that contain only a little, fairly
20674 \begin_inset Newline newline
20677 If Lyx is unable to render a formula as HTML—for example, if the formula
20679 \begin_inset Flex Code
20682 \begin_layout Plain Layout
20688 package or ERT—then it will instead output the formula as an image.
20692 \begin_layout Itemize
20694 \begin_inset Newline newline
20698 \begin_inset Flex Code
20701 \begin_layout Plain Layout
20708 will output formulae as images, the very same images, in fact, that are
20709 used for instant preview.
20713 \begin_layout Plain Layout
20714 Instant preview does
20718 have to be on for images to be output, however.
20723 The advantage to this method is that the images are simply generated by
20725 , so they are very accurate.
20726 The disadvantage, as mentioned earlier, is that these are bitmapped images,
20727 so they do not scale terribly well, and one cannot copy them, etc.
20728 \begin_inset Newline newline
20731 The size of the images can be controlled by setting the
20732 \begin_inset Quotes eld
20735 Math Images Scaling
20736 \begin_inset Quotes erd
20740 \begin_inset Flex Noun
20743 \begin_layout Plain Layout
20744 Document\SpecialChar menuseparator
20745 Settings\SpecialChar menuseparator
20755 \begin_layout Plain Layout
20756 For those who want to know, this controls the resolution of the image in
20757 dots per inch and is based upon a default of 75 dpi.
20763 \begin_inset Newline newline
20766 If \SpecialChar LyX
20767 for some reason fails to create an image for a formula (e.g., if a required
20769 package is not installed), then it will fall back to outputing the raw
20774 \begin_layout Itemize
20777 \begin_inset Newline newline
20780 Finally, \SpecialChar LyX
20781 will happily output math as \SpecialChar LaTeX
20783 As well as being the output of last resort, this method can be used with
20785 \begin_inset CommandInset href
20788 target "http://www.math.union.edu/~dpvc/jsMath/"
20793 , which uses JavaScript to render \SpecialChar LaTeX
20794 embedded in HTML documents.
20796 wraps the \SpecialChar LaTeX
20798 \begin_inset Flex Code
20801 \begin_layout Plain Layout
20807 (for inline formulas) or
20808 \begin_inset Flex Code
20811 \begin_layout Plain Layout
20817 (for displayed formulas) with
20818 \begin_inset Flex Code
20821 \begin_layout Plain Layout
20827 , as is required for jsMath.
20830 \begin_layout Standard
20831 One of these output methods must be selected under
20832 \begin_inset Flex Noun
20835 \begin_layout Plain Layout
20836 Document\SpecialChar menuseparator
20837 Settings\SpecialChar menuseparator
20844 By default, \SpecialChar LyX
20846 This is a document-wide setting, therefore.
20849 \begin_layout Standard
20850 Eventually, \SpecialChar LyX
20851 will offer the user the option to select an alternate output
20852 method for a particular inset, say, one that isn't being rendered very
20857 \begin_layout Plain Layout
20858 That said, since \SpecialChar LyX
20859 falls back to images if the inset contains ERT, then one
20860 can force output as an image by putting some harmless ERT into the math,
20862 \begin_inset Formula $a=b\relax$
20873 \begin_layout Section
20874 Bibliography and Citations
20877 \begin_layout Standard
20878 XHTML output fully supports bibliographies and citations.
20882 \begin_layout Standard
20883 Citation labels are generated by the same machinery that generates \SpecialChar LyX
20885 labels, so the labels will look in the output much as they do in \SpecialChar LyX
20888 If you are using numerical citations, then \SpecialChar LyX
20889 will output numerical labels,
20890 such as [1] or [17], rather than simply showing the citation key in square
20891 brackets, as it does on-screen.
20892 If you are using author-year citations, then \SpecialChar LyX
20893 will add lowercase letters
20894 to the years, just as Bib\SpecialChar TeX
20895 does, if it finds more than one citation for
20896 a given author-year combination.
20897 The labels will be printed with the bibliography entries.
20898 Note that there is, at present, no way to customize the appearance of the
20899 labels, for example, to choose between square brackets and parentheses.
20902 \begin_layout Standard
20903 Bibliography output is handled by the same machinery that handles the presentati
20904 on of reference information in the citation dialog, so you will see in the
20905 XHTML output pretty much what you would see if you were to look at a given
20906 entry in the citation dialog.
20907 The formatting can be customized in your layout file or, preferably, in
20913 manual for the details.
20916 \begin_layout Standard
20917 The main defect at present is that cross-referenced information is printed
20918 with every entry with which it is associated.
20919 So you can see things like this:
20922 \begin_layout Quote
20924 \begin_inset Quotes eld
20927 Context and Logical Form
20928 \begin_inset Quotes erd
20933 Language in Context: Selected Essays
20935 (Oxford: Oxford University Press, 2007), pp.
20939 \begin_layout Quote
20941 \begin_inset Quotes eld
20944 Semantics in Context
20945 \begin_inset Quotes erd
20950 Language in Context: Selected Essays
20952 (Oxford: Oxford University Press, 2007), pp.
20956 \begin_layout Standard
20957 This should be fixed before long.
20960 \begin_layout Standard
20961 There is no support at present for sectioned bibliographies.
20962 If you have multiple bibliographies, then \SpecialChar LyX
20963 will print the same bibliography
20967 \begin_layout Section
20971 \begin_layout Standard
20973 will happily export indexes as XHTML, but with certain limitations at the
20977 \begin_layout Standard
20978 Index export will be most reliable when you do not attempt to use the fancy
20979 constructs that are described in the section on indexes in the
20987 \begin_layout Plain Layout
20988 The main issue here is that \SpecialChar LyX
20989 itself does not really handle these.
20990 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
20996 We'll describe how they are handled using the subsection headings from
21000 \begin_layout Itemize
21001 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
21002 makes an effort to support these,
21003 but the entries must be separated by
21004 \begin_inset Quotes eld
21008 \begin_inset Quotes erd
21011 , that is, there must be spaces around the exclamation point.
21012 This is because it is otherwise too difficult to check for escaped exclamation
21013 points, ones in math, and so forth.
21016 \begin_layout Itemize
21017 Page Ranges: There is no support at all for page ranges, since these make
21018 no sense with XHMTL.
21019 Instead, you will just get two index entries, one at either end.
21022 \begin_layout Itemize
21023 Cross-referencing: There is no support for cross-referencing.
21024 If \SpecialChar LyX
21025 finds an entry containing the
21026 \begin_inset Quotes eld
21029 |see\SpecialChar ldots
21031 \begin_inset Quotes erd
21034 construct, it is just dropped, and the rest is treated as an ordinary index
21038 \begin_layout Itemize
21039 Index Entry Order: \SpecialChar LyX
21040 does support attempts to fix the sorting order.
21041 It will take what is before the first `@' it finds and use that for sorting,
21042 taking what follows the first `@' to be the actual entry.
21043 At present, \SpecialChar LyX
21044 does not check for escaped `@', so do not try to index email
21048 \begin_layout Itemize
21049 Index Entry Layout: You can format entries by using the text style dialog,
21050 or by using any other method available within \SpecialChar LyX
21052 There is no support for constructs like:
21053 \begin_inset Quotes eld
21057 \begin_inset Quotes erd
21061 Indeed, if \SpecialChar LyX
21062 finds a pipe symbol, `|', in an entry, it will delete it and
21063 everything that follows it.
21066 \begin_layout Itemize
21067 Multiple Indexes: There is no support for multiple indexes.
21068 Rather, all index entries will be printed as one large index.
21069 To avoid our printing several versions of the index, we print only the
21070 main index, so make sure you have one.
21073 \begin_layout Section
21074 Nomenclature and Glossary
21077 \begin_layout Standard
21078 There is at present no support for glossaries.
21079 Adding it would be fairly trivial, and welcome.
21082 \begin_layout Chapter
21084 \change_inserted 1075283030 1616534180
21088 \begin_layout Standard
21090 \change_inserted 1075283030 1616534386
21091 Apart from HTML, \SpecialChar LyX
21092 can generate documents in the DocBook XML vocabulary.
21093 With versions 2.3 and before, only select templates could be used to generate
21094 DocBook documents (only version 4).
21095 Starting with \SpecialChar LyX
21096 2.4, most \SpecialChar LyX
21097 layouts can generate valid DocBook documents (only
21099 This feature is built into \SpecialChar LyX
21100 and does not require the use of external tools.
21103 \begin_layout Standard
21105 \change_inserted 1075283030 1616534437
21106 The result is that the DocBook output can be customized and extended in
21107 exactly the same way \SpecialChar LaTeX
21108 output can be customized and extended: through layout
21110 See chapter five of the
21114 manual for the details.
21117 \begin_layout Standard
21119 \change_inserted 1075283030 1616534475
21120 Most \SpecialChar LyX
21121 features are supported with DocBook, like math output.
21124 \begin_layout Itemize
21126 \change_inserted 1075283030 1616534741
21127 Math output is performed mostly in MathML (the major exception being constructio
21128 ns not supported by \SpecialChar LyX
21131 All formulae are also available in raw \SpecialChar TeX
21132 in the DocBook output for further
21136 \begin_layout Itemize
21138 \change_inserted 1075283030 1616534852
21139 Bibliographies and citations are implemented, including with an external
21141 Bibliography entries are not prerendered when the detailed information
21142 are available, but rather output with the standard DocBook constructs.
21143 The external DocBook processor is expected to handle the rendering of entries.
21146 \begin_layout Itemize
21148 \change_inserted 1075283030 1616534863
21149 Indexes are supported, including multiple indices.
21154 ), page ranges, and cross-references (
21158 ) are supported, with the exception of the same symbols escaped.
21167 ) are not supported.
21168 There is no support for escaping of index entries.
21171 \begin_layout Itemize
21173 \change_inserted 1075283030 1616534884
21174 Glossaries are implemented.
21177 \begin_layout Standard
21179 \change_inserted 1075283030 1616534894
21180 Two major parameters can be set at the document level.
21183 \begin_layout Itemize
21185 \change_inserted 1075283030 1616534948
21186 Format for tables: \SpecialChar LyX
21187 can generate tables either as HTML (default value) or
21188 CALS, depending on the user's requirements.
21189 Most DocBook processors accept both formats.
21192 \begin_layout Itemize
21194 \change_inserted 1075283030 1616535006
21195 MathML prefix: in DocBook, MathML is included within its own name space,
21197 The implication is that there must be an indication of the tags belonging
21198 to the MathML standard.
21199 Three choices are offered:
21203 \begin_layout Itemize
21205 \change_inserted 1075283030 1616535044
21206 Inline: the MathML name space is defined for each formula (using the
21210 attribute on each formula)
21213 \begin_layout Itemize
21215 \change_inserted 1075283030 1616535090
21220 prefix (default): the MathML name space is defined at the document level
21225 attribute on the root element).
21226 Each MathML is prefixed with
21235 \begin_layout Itemize
21237 \change_inserted 1075283030 1616620405
21242 prefix: similar to the
21251 \begin_layout Standard
21253 \change_inserted 1075283030 1616620470
21254 This option is especially useful if you want \SpecialChar LyX
21255 to match your personal style
21256 or to work with buggy software that only accepts one prefix for MathML.
21262 \begin_layout Chapter
21263 The \SpecialChar LyX
21267 \begin_layout Section
21271 \begin_layout Standard
21272 The `\SpecialChar LyX
21273 server' allows other programs to talk to \SpecialChar LyX
21274 , invoke \SpecialChar LyX
21275 commands, and retrieve
21276 information about the \SpecialChar LyX
21278 This is only intended for advanced users, but they should find it useful.
21279 It is by writing to the \SpecialChar LyX
21280 server, for example, that bibliography managers,
21281 such as JabRef, are able to
21282 \begin_inset Quotes eld
21286 \begin_inset Quotes erd
21289 citations to \SpecialChar LyX
21293 \begin_layout Section
21294 Starting the \SpecialChar LyX
21296 \begin_inset CommandInset label
21298 name "sec:Starting-the-Server"
21305 \begin_layout Standard
21306 The \SpecialChar LyX
21307 server works through the use of a pair of named pipes.
21308 These are usually located in
21309 \begin_inset Flex Code
21312 \begin_layout Plain Layout
21318 , (except on Windows, where
21322 named pipes are special objects located in
21323 \begin_inset Flex Code
21326 \begin_layout Plain Layout
21338 ) and have the names
21339 \begin_inset Quotes eld
21343 \begin_inset Flex Code
21346 \begin_layout Plain Layout
21353 \begin_inset Quotes erd
21357 \begin_inset Quotes eld
21361 \begin_inset Flex Code
21364 \begin_layout Plain Layout
21371 \begin_inset Quotes erd
21375 External programs write into
21376 \begin_inset Flex Code
21379 \begin_layout Plain Layout
21385 and read back data from
21386 \begin_inset Flex Code
21389 \begin_layout Plain Layout
21396 The stem of the pipe names can be defined in the
21397 \begin_inset Flex Noun
21400 \begin_layout Plain Layout
21401 Tools\SpecialChar menuseparator
21407 dialog, for example
21408 \begin_inset Flex Code
21411 \begin_layout Plain Layout
21412 "/home/myhome/lyxpipe"
21418 \begin_inset Flex Code
21421 \begin_layout Plain Layout
21435 on Windows (where any working path instead of lyxpipe can be used, for
21437 \begin_inset Flex Code
21440 \begin_layout Plain Layout
21463 configure this manually in order for the server to start.
21466 \begin_layout Standard
21469 \begin_inset Flex Code
21472 \begin_layout Plain Layout
21479 \begin_inset Flex Code
21482 \begin_layout Plain Layout
21488 ' to create the pipes.
21489 If one of the pipes already exists, \SpecialChar LyX
21490 will assume that another \SpecialChar LyX
21492 is already running and will not start the server.
21493 On POSIX (Unix like) systems, if for some other reason, an unused
21494 \begin_inset Quotes eld
21498 \begin_inset Quotes erd
21501 pipe is left in existence when \SpecialChar LyX
21502 closes, then \SpecialChar LyX
21503 will try to delete it.
21504 If this fails for some reason, you will need to delete the pipes manually
21505 and then restart \SpecialChar LyX
21507 On Windows, pipes are deleted by the OS on program termination or crash,
21509 \begin_inset Quotes eld
21513 \begin_inset Quotes erd
21516 pipes should not be possible.
21519 \begin_layout Standard
21520 To have several \SpecialChar LyX
21521 processes with servers at the same time, you have to use
21522 different configurations, perhaps by using separate user directories, each
21524 \begin_inset Flex Code
21527 \begin_layout Plain Layout
21533 file, for each process.
21536 \begin_layout Standard
21537 If you are developing a client program, you might find it useful to enable
21538 debugging information from the \SpecialChar LyX
21540 Do this by starting \SpecialChar LyX
21542 \begin_inset Flex Code
21545 \begin_layout Plain Layout
21554 \begin_layout Standard
21555 You can find a complete example client written in C++ in the source distribution
21557 \begin_inset Flex Code
21560 \begin_layout Plain Layout
21561 development/lyxserver/server_monitor.cpp
21569 \begin_layout Standard
21570 Another useful tool is the command-line based client found in
21571 \begin_inset Flex Code
21574 \begin_layout Plain Layout
21575 src/client/lyxclient
21583 \begin_layout Section
21584 Normal communication
21587 \begin_layout Standard
21588 To issue a \SpecialChar LyX
21589 call, the client writes a line of ASCII text into the input
21591 This line has the following format:
21594 \begin_layout Quote
21608 \begin_layout Description
21609 clientname is a name that the client can choose arbitrarily.
21610 Its only use is that \SpecialChar LyX
21611 will echo it if it sends an answer—so a client can
21612 dispatch results from different requesters.
21615 \begin_layout Description
21616 function is the function you want \SpecialChar LyX
21618 It is the same as the commands you'd use in the minibuffer.
21621 \begin_layout Description
21622 argument is an optional argument which is meaningful only to some functions
21624 \begin_inset Quotes eld
21628 \begin_inset Quotes erd
21631 LFUN will insert the argument as text at the cursor position).
21634 \begin_layout Standard
21635 The answer from \SpecialChar LyX
21636 will arrive in the output pipe and be of the form
21639 \begin_layout Quote
21653 \begin_layout Standard
21662 are just echoed from the command request, while
21666 is more or less useful information filled according to how the command
21667 execution worked out.
21668 Some commands, such as
21669 \begin_inset Quotes eld
21673 \begin_inset Quotes erd
21676 , will return information about the internal state of \SpecialChar LyX
21678 return an empty data-response.
21679 This means that the command execution went fine.
21682 \begin_layout Standard
21683 In case of errors, the response from \SpecialChar LyX
21684 will have this form
21687 \begin_layout Quote
21701 \begin_layout Standard
21706 should contain an explanation of why the command failed.
21709 \begin_layout Standard
21713 \begin_layout LyX-Code
21714 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
21715 \begin_inset Newline newline
21718 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
21719 \begin_inset Newline newline
21722 read a <~/.lyxpipe.out
21723 \begin_inset Newline newline
21729 \begin_layout Subsection
21730 AppleScript (Mac OS X)
21733 \begin_layout Standard
21734 Since \SpecialChar LyX
21735 2.1, \SpecialChar LyX
21736 supports basic interactions with AppleScript for normal communicatio
21737 n through the command run.
21738 This command takes a direct argument (the
21742 to perform) and an optional argument.
21743 It either returns the output of the function or triggers an error with
21744 the error message and code.
21747 \begin_layout Standard
21751 \begin_layout LyX-Code
21752 tell application "\SpecialChar LyX
21756 \begin_layout LyX-Code
21760 \begin_layout LyX-Code
21761 -- Stores the current file name into f
21764 \begin_layout LyX-Code
21765 set f to (run "server-get-filename" with argument "")
21768 \begin_layout LyX-Code
21769 on error the error_message number the error_number
21772 \begin_layout LyX-Code
21773 display dialog "Error: " & the error_number & ".
21777 \begin_layout LyX-Code
21778 & the error_message buttons {"OK"} default button 1
21781 \begin_layout LyX-Code
21785 \begin_layout LyX-Code
21789 \begin_layout Section
21793 \begin_layout Standard
21795 can notify clients of events going on asynchronously.
21796 Currently it will only do this if the user binds a key sequence with the
21798 \begin_inset Quotes eld
21802 \begin_inset Quotes erd
21806 The format of the string \SpecialChar LyX
21807 sends is as follows:
21810 \begin_layout Quote
21811 \begin_inset Flex Code
21814 \begin_layout Plain Layout
21825 \begin_layout Standard
21830 is the printed representation of the key sequence that was actually typed
21834 \begin_layout Standard
21835 This mechanism can be used to extend \SpecialChar LyX
21836 's command set and implement macros.
21837 Bind some key sequence to
21838 \begin_inset Quotes eld
21842 \begin_inset Quotes erd
21846 Then start a client that listens on the output pipe, dispatches the command
21847 according to the sequence, and starts a function that may use \SpecialChar LyX
21850 requests to issue a command or a series of commands to \SpecialChar LyX
21854 \begin_layout Section
21855 The simple \SpecialChar LyX
21859 \begin_layout Standard
21861 implements a simple protocol that can be used for session management.
21862 All messages are of the form
21865 \begin_layout Quote
21875 \begin_layout Standard
21881 \begin_inset Quotes eld
21885 \begin_inset Quotes erd
21889 \begin_inset Quotes eld
21893 \begin_inset Quotes erd
21898 \begin_inset Quotes eld
21902 \begin_inset Quotes erd
21905 is received from a client, \SpecialChar LyX
21906 will report back to inform the client that
21907 it's listening to it's messages, while
21908 \begin_inset Quotes eld
21912 \begin_inset Quotes erd
21915 sent from \SpecialChar LyX
21916 will inform clients that \SpecialChar LyX
21920 \begin_layout Section
21921 Reverse DVI/PDF search
21924 \begin_layout Standard
21925 Some DVI/PDF viewers
21929 \begin_layout Plain Layout
21930 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
21931 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
21940 facility (also called
21945 This means that you can tell \SpecialChar LyX
21946 to put the cursor to a specific line in the
21947 document by clicking at the respective position in the DVI/PDF output.
21948 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
21950 This is done via the \SpecialChar LyX
21951 server either by using the named pipe (
21955 ), or the UNIX domain socket (
21959 ) that \SpecialChar LyX
21960 creates in its temporary directory (this is the way the
21961 \begin_inset Flex Code
21964 \begin_layout Plain Layout
21970 program communicates with \SpecialChar LyX
21972 In some cases, you need a helper script that mediates between the viewer
21973 and \SpecialChar LyX
21974 , in others, the viewer can communicate with \SpecialChar LyX
21976 This depends on the selected viewer and on your operating system.
21977 The same applies to the way viewers need to be configured and the way the
21978 reverse search is actually performed.
21979 In what follows, we will thus describe how to setup reverse search for
21981 Before we turn to this, though, we will explain what needs to be done generally
21982 to enable reverse search in the DVI/PDF output.
21985 \begin_layout Subsection
21987 \begin_inset CommandInset label
21989 name "subsec:rev-search"
21996 \begin_layout Standard
21997 In most cases \SpecialChar LyX
21998 will do the work for you by pressing the following button
22002 arg "buffer-toggle-output-sync"
22006 Alternatively, you can also enable the feature by checking
22008 Synchronize with Output
22011 \begin_inset Flex Noun
22014 \begin_layout Plain Layout
22015 Document\SpecialChar menuseparator
22016 Settings\SpecialChar menuseparator
22023 In such a case \SpecialChar LyX
22024 will automatically insert the necessary Sync\SpecialChar TeX
22026 PDF) or load the srcltx package (for DVI) respectively.
22027 This option can be easily reached also on
22028 \begin_inset Flex Code
22031 \begin_layout Plain Layout
22040 \begin_layout Standard
22041 If you need a different setting, you can select or input a custom macro
22042 from the drop down box just below
22043 \begin_inset Flex Noun
22046 \begin_layout Plain Layout
22047 Document\SpecialChar menuseparator
22048 Settings\SpecialChar menuseparator
22049 Output\SpecialChar menuseparator
22050 Synchronize with Output
22058 \begin_layout Standard
22059 Note that the method
22060 \begin_inset Flex Code
22063 \begin_layout Plain Layout
22071 enables gzip compression.
22072 If your viewer does not support it, you should instead use
22073 \begin_inset Flex Code
22076 \begin_layout Plain Layout
22087 \begin_layout Standard
22088 Please also note that including the
22089 \begin_inset Flex Code
22092 \begin_layout Plain Layout
22099 \begin_inset Flex Code
22102 \begin_layout Plain Layout
22108 sometimes has an undesired impact on the typesetting.
22109 Thus, you should switch output synchronization off for the final typesetting
22111 \begin_inset Flex Code
22114 \begin_layout Plain Layout
22121 \begin_inset Flex Code
22124 \begin_layout Plain Layout
22134 \begin_layout Standard
22135 In case you need some more special settings that are not covered by the
22136 automatic settings, read the next section about how to set up output synchroniz
22138 If the automatic setup suits your needs, you can readily jump to section
22139 \begin_inset space ~
22143 \begin_inset CommandInset ref
22145 reference "subsec:configuring-viewers"
22149 , where the necessary configuration steps in your viewer – needed both with
22150 the automatic and the manual setup – are described.
22153 \begin_layout Subsection
22157 \begin_layout Standard
22159 provides several different methods for reverse search.
22160 Some are built-in in the
22161 \begin_inset Flex Code
22164 \begin_layout Plain Layout
22170 program, some are provided by external packages.
22171 Your choice depends on whether your \SpecialChar LaTeX
22172 distribution already provides a given
22173 method (the built-in methods are rather new) and whether your viewer can
22175 The available methods are described in the following.
22178 \begin_layout Subsubsection*
22179 Built-in DVI-search via src-specials (DVI only)
22182 \begin_layout Standard
22183 This method provides the DVI file with the necessary information for reverse
22185 It is available in \SpecialChar LaTeX
22186 since quite some time (any somewhat recent \SpecialChar LaTeX
22188 should include it), and it works reliably.
22189 To enable it, change the
22190 \begin_inset Flex Noun
22193 \begin_layout Plain Layout
22204 \begin_inset Flex Noun
22207 \begin_layout Plain Layout
22218 \begin_inset Flex Noun
22221 \begin_layout Plain Layout
22222 Preferences\SpecialChar menuseparator
22223 File Handling\SpecialChar menuseparator
22230 \begin_inset Flex Code
22233 \begin_layout Plain Layout
22234 latex -src-specials $$i
22240 If this doesn't work, check if your \SpecialChar TeX
22241 engine needs different options (the
22242 syntax might differ in some distributions).
22245 \begin_layout Subsubsection*
22246 External Packages (PDFSync and scrltx)
22249 \begin_layout Standard
22258 provide reverse search facility for PDF output (via pdflatex) and DVI output,
22260 In order to enable it, load the packages in the \SpecialChar LyX
22264 \begin_layout Itemize
22265 \begin_inset Flex Code
22268 \begin_layout Plain Layout
22271 usepackage{pdfsync}
22276 for reverse PDF search,
22279 \begin_layout Itemize
22280 \begin_inset Flex Code
22283 \begin_layout Plain Layout
22286 usepackage[active]{srcltx}
22291 for reverse DVI search.
22294 \begin_layout Standard
22295 If you want to be able to perform both DVI and PDF reverse searches, you
22296 can also insert in the preamble the following lines
22299 \begin_layout LyX-Code
22303 \begin_inset Newline newline
22309 \begin_inset Newline newline
22314 usepackage{pdfsync}
22315 \begin_inset Newline newline
22321 \begin_inset Newline newline
22326 usepackage[active]{srcltx}
22327 \begin_inset Newline newline
22335 \begin_layout Standard
22336 This way, you can preview the file as either DVI or PDF (pdflatex) and the
22337 right package will be used.
22340 \begin_layout Standard
22341 Note that PDFSync might affect the output layout of your document.
22342 It is therefore advised to disable PDFsync for final documents.
22345 \begin_layout Subsubsection*
22346 Built-in reverse search via Sync\SpecialChar TeX
22350 \begin_layout Standard
22352 \begin_inset Flex Code
22355 \begin_layout Plain Layout
22361 have built-in support for both PDF and DVI reverse search.
22364 Sync\SpecialChar TeX
22367 facility is basically the result of the integration of the PDFSync package
22368 to the pdftex program and its merge with the
22373 You need at least \SpecialChar TeX
22374 Live 2008 or a recent Mik\SpecialChar TeX
22375 distribution in order to use
22380 \begin_layout Plain Layout
22381 For some reason, Mik\SpecialChar TeX
22382 does not understand/obey the command \SpecialChar LyX
22384 the preamble when you check the "Enable Forward/Reverse Search" button
22385 in the toolbar and does not generate the necessary info.
22388 \begin_layout Plain Layout
22389 The generation of the required info can be forced by changing the converter
22390 "\SpecialChar LaTeX
22391 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
22392 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
22393 the -synctex=1 switch).
22398 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
22399 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
22400 already provide Sync\SpecialChar TeX
22404 \begin_layout Standard
22405 To enable Sync\SpecialChar TeX
22406 for DVI output, change the
22407 \begin_inset Flex Noun
22410 \begin_layout Plain Layout
22421 \begin_inset Flex Noun
22424 \begin_layout Plain Layout
22429 (plain) -> DraftDVI
22435 \begin_inset Flex Noun
22438 \begin_layout Plain Layout
22439 Preferences\SpecialChar menuseparator
22440 File Handling\SpecialChar menuseparator
22447 \begin_inset Flex Code
22450 \begin_layout Plain Layout
22451 latex -synctex=1 $$i
22456 , and for PDF output, change the
22457 \begin_inset Flex Noun
22460 \begin_layout Plain Layout
22465 (pdflatex) -> PDF (pdflatex)
22471 \begin_inset Flex Code
22474 \begin_layout Plain Layout
22475 pdflatex -synctex=1 $$i
22481 Should your viewer not be considered in the following description, or in
22482 case of missing success, please check the documentation of your viewer
22483 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
22488 \begin_layout Plain Layout
22489 Note that the option
22490 \begin_inset Flex Code
22493 \begin_layout Plain Layout
22499 option enables gzip compression.
22500 If your viewer does not support it, you should instead use
22501 \begin_inset Flex Code
22504 \begin_layout Plain Layout
22518 \begin_layout Subsection
22519 Configuring and using specific viewers
22520 \begin_inset CommandInset label
22522 name "subsec:configuring-viewers"
22529 \begin_layout Subsubsection*
22530 Xdvi (all platforms)
22533 \begin_layout Standard
22535 \begin_inset Flex Code
22538 \begin_layout Plain Layout
22544 , you don't need to do anything else for performing a reverse DVI search,
22545 as \SpecialChar LyX
22546 already provides the necessary hooks for automatically using the
22547 \begin_inset Flex Code
22550 \begin_layout Plain Layout
22557 Just setup your document as described above (reverse search is triggered
22558 by Ctrl-click or Alt-click on Mac OSX, respectively).
22561 \begin_layout Standard
22562 However, if for whatever reason you want to use the named pipe instead of
22563 the socket for communicating with \SpecialChar LyX
22564 , simply change the DVI viewer in
22565 \begin_inset Flex Noun
22568 \begin_layout Plain Layout
22569 Preferences\SpecialChar menuseparator
22570 File Handling\SpecialChar menuseparator
22580 \begin_layout Plain Layout
22581 On Mac OSX you have to use
22582 \begin_inset Flex Code
22585 \begin_layout Plain Layout
22586 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
22597 \begin_inset Flex Code
22600 \begin_layout Plain Layout
22601 xdvi -editor "lyxeditor.sh %f %l"
22607 \begin_inset Flex Code
22610 \begin_layout Plain Layout
22616 is a suitable script.
22617 For example, a minimal shell script is the following one:
22620 \begin_layout LyX-Code
22622 \begin_inset Newline newline
22625 LYXPIPE="/path/to/lyxpipe"
22626 \begin_inset Newline newline
22629 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
22630 \begin_inset Newline newline
22633 echo "$COMMAND" > "${LYXPIPE}".in || exit
22634 \begin_inset Newline newline
22637 read TMP < "${LYXPIPE}".out || exit
22640 \begin_layout Standard
22642 \begin_inset Flex Code
22645 \begin_layout Plain Layout
22651 is the LyXServer pipe path specified in
22652 \begin_inset Flex Noun
22655 \begin_layout Plain Layout
22656 Preferences\SpecialChar menuseparator
22666 \begin_layout Plain Layout
22668 \begin_inset Flex Code
22671 \begin_layout Plain Layout
22677 folder of a source distribution you can find a
22678 \begin_inset Flex Code
22681 \begin_layout Plain Layout
22687 script which is able to locate the
22691 based on your preferences.
22699 \begin_layout Subsubsection*
22703 \begin_layout Standard
22705 \begin_inset Flex Code
22708 \begin_layout Plain Layout
22709 /Applications/MacDviX_Folder/calleditor.script
22714 , add the following lines:
22717 \begin_layout LyX-Code
22718 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
22719 \begin_inset Newline newline
22725 \begin_layout Standard
22726 Modify the lines accordingly if you install \SpecialChar LyX
22727 somewhere else than in the
22728 Applications folder.
22731 \begin_layout Standard
22732 Reverse search is triggered by Alt-click (OPTION-click).
22735 \begin_layout Subsubsection*
22739 \begin_layout Standard
22741 \begin_inset Flex Code
22744 \begin_layout Plain Layout
22745 open -a Skim.app $$i
22750 to the viewer setting in
22751 \begin_inset Flex Noun
22754 \begin_layout Plain Layout
22755 Preferences\SpecialChar menuseparator
22756 File Handling\SpecialChar menuseparator
22757 File formats\SpecialChar menuseparator
22764 \begin_inset Flex Noun
22767 \begin_layout Plain Layout
22768 Skim\SpecialChar menuseparator
22769 Preferences\SpecialChar menuseparator
22776 \begin_inset Flex Noun
22779 \begin_layout Plain Layout
22785 preset and enter command
22786 \begin_inset Flex Noun
22789 \begin_layout Plain Layout
22790 /Applications/\SpecialChar LyX
22791 .app/Contents/MacOS/lyxeditor
22799 \begin_layout Standard
22800 Reverse search is triggered by COMMAND-SHIFT-click
22803 \begin_layout Subsubsection*
22807 \begin_layout Standard
22808 Reverse search with evince does not work out of the box, but it can be achieved
22809 by means of some third party helper scripts.
22811 \begin_inset CommandInset href
22813 target "https://wiki.lyx.org/LyX/SyncTeX"
22821 \begin_layout Subsubsection*
22825 \begin_layout Standard
22827 \begin_inset Flex Noun
22830 \begin_layout Plain Layout
22831 Settings\SpecialChar menuseparator
22832 Configure Okular\SpecialChar menuseparator
22839 \begin_inset Quotes erd
22843 This inserts the appropriate command (
22844 \begin_inset Flex Code
22847 \begin_layout Plain Layout
22856 \begin_layout Standard
22857 Reverse search is triggered by SHIFT-click.
22859 \change_inserted -712698321 1578211026
22860 Note that this only works if Okular is in
22861 \begin_inset Quotes eld
22865 \begin_inset Quotes erd
22869 \begin_inset space \thinspace{}
22872 e., the hand symbol is clicked).
22877 \begin_layout Subsubsection*
22881 \begin_layout Standard
22882 Qpdfview supports Sync\SpecialChar TeX
22883 since version 0.3.5.
22885 \begin_inset Flex Noun
22888 \begin_layout Plain Layout
22889 Edit\SpecialChar menuseparator
22890 Settings\SpecialChar menuseparator
22896 , click on the input field of the
22897 \begin_inset Quotes eld
22901 \begin_inset Quotes erd
22904 item and add the command
22905 \begin_inset Flex Code
22908 \begin_layout Plain Layout
22917 \begin_layout Standard
22918 Reverse search is triggered by double-click or, in more recent versions,
22922 \begin_layout Subsubsection*
22926 \begin_layout Standard
22927 Launch yap, choose its
22928 \begin_inset Flex Noun
22931 \begin_layout Plain Layout
22932 View\SpecialChar menuseparator
22938 menu and select the
22939 \begin_inset Quotes eld
22943 \begin_inset Quotes erd
22948 \begin_inset Quotes eld
22951 New\SpecialChar ldots
22953 \begin_inset Quotes erd
22956 button and, in the window that opens, enter
22957 \begin_inset Quotes eld
22962 \begin_inset Quotes erd
22965 (or any other name you like) in the
22966 \begin_inset Quotes eld
22970 \begin_inset Quotes erd
22974 Now click on the button labeled
22975 \begin_inset Quotes eld
22980 \begin_inset Quotes erd
22983 to open a file dialog and navigate to the directory containing the batch
22985 \begin_inset Flex Code
22988 \begin_layout Plain Layout
22996 \begin_inset Flex Code
22999 \begin_layout Plain Layout
23005 and then specify the program arguments as
23006 \begin_inset Flex Code
23009 \begin_layout Plain Layout
23017 \begin_inset Flex Code
23020 \begin_layout Plain Layout
23026 wrapper is used for communicating with \SpecialChar LyX
23034 \begin_layout LyX-Code
23036 \begin_inset Newline newline
23039 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
23048 \begin_inset Newline newline
23062 \begin_layout Standard
23063 Make sure that the \SpecialChar LyX
23064 Server pipe path you specified in \SpecialChar LyX
23066 \begin_inset Flex Code
23069 \begin_layout Plain Layout
23083 , otherwise change the
23084 \begin_inset Flex Code
23087 \begin_layout Plain Layout
23093 wrapper accordingly.
23096 \begin_layout Standard
23097 In yap, reverse search is triggered by double-click.
23100 \begin_layout Subsubsection*
23101 SumatraPDF (Windows)
23104 \begin_layout Standard
23105 In order to use SumatraPDF for inverse search, enter
23106 \begin_inset Flex Code
23109 \begin_layout Plain Layout
23110 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
23115 in the viewer setting in
23116 \begin_inset Flex Noun
23119 \begin_layout Plain Layout
23120 Preferences\SpecialChar menuseparator
23121 File Handling\SpecialChar menuseparator
23122 File formats\SpecialChar menuseparator
23129 \begin_inset Flex Code
23132 \begin_layout Plain Layout
23138 is the previous wrapper.
23139 If SumatraPDF.exe is not in your command PATH, use its full file name.
23142 \begin_layout Standard
23143 Reverse search is triggered by double-click.
23146 \begin_layout Subsubsection*
23150 \begin_layout Standard
23151 First of all, make sure that yap is your default DVI viewer in the Windows
23152 environment, then launch it, choose its
23153 \begin_inset Flex Noun
23156 \begin_layout Plain Layout
23157 View\SpecialChar menuseparator
23163 menu and select the
23164 \begin_inset Quotes eld
23168 \begin_inset Quotes erd
23173 \begin_inset Quotes eld
23176 New\SpecialChar ldots
23178 \begin_inset Quotes erd
23181 button and, in the window that opens, enter
23182 \begin_inset Quotes eld
23187 \begin_inset Quotes erd
23190 (or any other name you like) in the
23191 \begin_inset Quotes eld
23195 \begin_inset Quotes erd
23199 Now click on the button labeled
23200 \begin_inset Quotes eld
23205 \begin_inset Quotes erd
23208 to open a file dialog and navigate to the directory containing the
23209 \begin_inset Flex Code
23212 \begin_layout Plain Layout
23218 program (which is installed by default on Cygwin along with the \SpecialChar LyX
23221 \begin_inset Flex Code
23224 \begin_layout Plain Layout
23230 and then specify the program arguments as
23231 \begin_inset Flex Code
23234 \begin_layout Plain Layout
23241 In this way, you will be using the
23245 for communicating with \SpecialChar LyX
23247 If, for whatever reason, you want to use the
23252 \begin_inset Flex Code
23255 \begin_layout Plain Layout
23261 option and be sure to specify the \SpecialChar LyX
23262 Server pipe path in the \SpecialChar LyX
23266 \begin_layout Standard
23267 In yap, reverse search is triggered by double-click.
23270 \begin_layout Subsubsection*
23271 SumatraPDF (Cygwin)
23274 \begin_layout Standard
23275 In order to use SumatraPDF for inverse search, enter
23276 \begin_inset Flex Code
23279 \begin_layout Plain Layout
23280 SumatraPDF -inverse-search "lyxeditor -g %f %l"
23285 in the viewer setting in
23286 \begin_inset Flex Noun
23289 \begin_layout Plain Layout
23290 Preferences\SpecialChar menuseparator
23291 File Handling\SpecialChar menuseparator
23292 File formats\SpecialChar menuseparator
23299 If SumatraPDF.exe is not in your command PATH, use its full posix path.
23301 \begin_inset Flex Code
23304 \begin_layout Plain Layout
23310 enables communication via the
23316 \begin_inset Flex Code
23319 \begin_layout Plain Layout
23325 option if you want to use the
23329 , and be sure to specify the \SpecialChar LyX
23330 Server pipe path in the \SpecialChar LyX
23334 \begin_layout Standard
23335 Reverse search is triggered by double-click.
23338 \begin_layout Section
23342 \begin_layout Standard
23343 Forward search is, as the name implies, in a sense the
23344 \begin_inset Quotes eld
23348 \begin_inset Quotes erd
23352 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
23354 If forward search is set up (as described in what follows), you can put
23355 the cursor anywhere in your \SpecialChar LyX
23357 \begin_inset Flex Noun
23360 \begin_layout Plain Layout
23361 Navigate\SpecialChar menuseparator
23368 \begin_inset Flex Noun
23371 \begin_layout Plain Layout
23377 in the context menu via right mouse click), and then the viewer will jump
23378 to that position as well.
23379 This implies, of course, that your viewer supports this function.
23382 \begin_layout Standard
23383 To make forward search possible, you first need to provide the generated
23384 output PDF/DVI file with additional information about the \SpecialChar TeX
23386 This can be done via the methods described in the section
23387 \begin_inset CommandInset ref
23389 reference "subsec:rev-search"
23396 \begin_layout Standard
23397 Additionally, you need to configure \SpecialChar LyX
23398 for using your viewers in
23399 \begin_inset Flex Noun
23402 \begin_layout Plain Layout
23403 Tools\SpecialChar menuseparator
23404 Preferences\SpecialChar menuseparator
23405 Output\SpecialChar menuseparator
23412 We provide a range of tested configurations for some viewers, which you
23413 can select from the drop down list.
23414 If none of these configurations suits you, you have to find out and enter
23415 a suitable configuration yourself.
23416 The definition syntax uses the following placeholders:
23419 \begin_layout Itemize
23421 \begin_inset Flex Code
23424 \begin_layout Plain Layout
23433 \begin_layout Itemize
23435 \begin_inset Flex Code
23438 \begin_layout Plain Layout
23444 : name of the (temporary) exported .tex file (without path)
23447 \begin_layout Itemize
23449 \begin_inset Flex Code
23452 \begin_layout Plain Layout
23458 : name of the (temporary) exported .tex file (including path)
23461 \begin_layout Itemize
23463 \begin_inset Flex Code
23466 \begin_layout Plain Layout
23472 : name of the exported output file (either dvi or pdf, depending on which
23473 one exists in the temporary directory)
23476 \begin_layout Standard
23477 Note that only some of the viewers provide full and usable forward search
23478 functionality out of the box, among them yap, xdvi, okular
23482 \begin_layout Plain Layout
23483 You might want to set
23484 \begin_inset Flex Code
23487 \begin_layout Plain Layout
23494 \begin_inset Flex Noun
23497 \begin_layout Plain Layout
23498 Tools\SpecialChar menuseparator
23499 Preferences\SpecialChar menuseparator
23500 File Handling\SpecialChar menuseparator
23502 \begin_inset space ~
23515 , qpdfview, and SumatraPDF
23519 \begin_layout Plain Layout
23520 SumatraPDF can also use DDE commands through the external program CMCDDE
23521 — downloadable from
23522 \begin_inset CommandInset href
23524 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
23535 Others, such as evince
23539 \begin_layout Plain Layout
23540 Forward search with evince can be achieved by means of third party helper
23543 \begin_inset CommandInset href
23545 target "https://wiki.lyx.org/LyX/SyncTeX"
23555 , require some extra tools in order to use forward search.
23556 While many of the widespread PDF viewers (most notably Adobe Reader) do
23557 not support forward search at all, some other viewers – e.
23558 \begin_inset space \thinspace{}
23562 xpdf – allow at least to reload the document and jump to a specific page
23563 of the file, so you can at least navigate
23564 \begin_inset Quotes eld
23568 \begin_inset Quotes erd
23572 This latter functionality is provided by an external call of synctex (see
23573 the predefined example configurations).
23577 \begin_layout Standard
23578 Forward search works both with DVI and PDF output.
23580 simply checks which preview format you have used before (i.
23581 \begin_inset space \thinspace{}
23584 e., which format is already there in the temporary directory) and chooses
23585 the appropriate configuration for the respective format.
23588 \begin_layout Chapter
23590 \change_deleted 564990737 1671097409
23591 Special Document Classes
23596 \begin_layout Section
23598 \change_deleted 564990737 1669742044
23602 \begin_layout Standard
23604 \change_deleted 564990737 1669742044
23610 \begin_layout Subsection
23612 \change_deleted 564990737 1669742044
23616 \begin_layout Standard
23618 \change_deleted 564990737 1669742044
23619 This section describes how \SpecialChar LyX
23620 can be used to write articles for submission
23621 to the scientific journal
23623 Astronomy and Astrophysics
23626 \begin_inset Flex URL
23629 \begin_layout Plain Layout
23631 https://www.aanda.org/
23636 ) using Version 5.01 of the document class
23641 This package can be downloaded from the ftp site
23644 \begin_layout Standard
23646 \change_deleted 564990737 1669742044
23647 \begin_inset VSpace medskip
23653 \begin_layout Standard
23656 \change_deleted 564990737 1669742044
23657 \begin_inset Flex URL
23660 \begin_layout Plain Layout
23662 ftp://ftp.edpsciences.org/pub/aa/readme.html
23670 \begin_layout Standard
23672 \change_deleted 564990737 1669742044
23673 \begin_inset VSpace medskip
23679 \begin_layout Standard
23681 \change_deleted 564990737 1669742044
23682 A manual comes together with that package, and this text is not meant to
23683 replace the original manual but is merely a short guide in how to realize
23684 the correct form of your paper.
23688 \begin_layout Standard
23690 \change_deleted 564990737 1669742044
23691 Please note that the publisher of the journal was changed from Springer
23692 to EDP Sciences starting January 1, 2001.
23693 That change involved also some slight changes to the style files, namely
23694 the removal of the thesaurus command.
23695 The \SpecialChar LyX
23696 class aa supports the newest version of these style files, V 5.01.
23697 If you have an older version installed, please upgrade.
23698 For compatibility, the old (version 4) layout has been kept as
23703 Please refer to the comments in
23706 Dir/layouts/aapaper.layout
23711 \begin_layout Subsection
23713 \change_deleted 564990737 1669742044
23717 \begin_layout Standard
23719 \change_deleted 564990737 1669742044
23720 It is recommended you start from the example template distributed with \SpecialChar LyX
23722 If you are not using a template, note the following settings:
23725 \begin_layout Itemize
23727 \change_deleted 564990737 1669742044
23734 Document\SpecialChar menuseparator
23737 dialog (OK, that one was obvious).
23740 \begin_layout Itemize
23742 \change_deleted 564990737 1669742044
23743 Don't change the option
23746 \begin_inset space ~
23756 The whole layout is done by the macros, you shouldn't change anything.
23759 \begin_layout Subsection
23761 \change_deleted 564990737 1669742044
23765 \begin_layout Standard
23767 \change_deleted 564990737 1669742044
23768 First thing to enter is the header information.
23769 It consists of seven entries, of which some are optional.
23773 \begin_layout Itemize
23775 \change_deleted 564990737 1669742044
23783 \begin_layout Itemize
23785 \change_deleted 564990737 1669742044
23793 \begin_layout Itemize
23795 \change_deleted 564990737 1669742044
23803 \begin_layout Itemize
23805 \change_deleted 564990737 1669742044
23813 \begin_layout Itemize
23815 \change_deleted 564990737 1669742044
23820 : [optional] if more than one author: whom to contact for offprint requests.
23823 \begin_layout Itemize
23825 \change_deleted 564990737 1669742044
23830 : [optional] mail address for contacts.
23833 \begin_layout Itemize
23835 \change_deleted 564990737 1669742044
23841 Suggested format is
23843 Received: <date>; Accepted <date>
23846 \begin_layout Standard
23848 \change_deleted 564990737 1669742044
23849 There is no need to issue the
23855 command, this is done automatically by \SpecialChar LyX
23856 when the header is finished.
23857 Although the order of the single header entries doesn't matter it is advised
23858 to keep the above sequence, just to get the best optics and meets the layout
23859 of the real document.
23862 \begin_layout Standard
23864 \change_deleted 564990737 1669742044
23865 If you want to place footnotes in the header block, e.
23866 \begin_inset space \thinspace{}
23870 \begin_inset space \space{}
23873 to state your present address, just use the standard footnote via the menu
23876 Insert\SpecialChar menuseparator
23881 will automagically use the term
23890 \begin_layout Standard
23892 \change_deleted 564990737 1669742044
23895 Edit\SpecialChar menuseparator
23898 , you'll find two insets which are relevant for the titling:
23901 \begin_layout Itemize
23903 \change_deleted 564990737 1669742044
23910 to mark corresponding author\SpecialChar breakableslash
23912 The institutes are numbered sequentially as they appear in the
23916 field, so you have to put a marker to each author.
23919 \begin_layout Itemize
23921 \change_deleted 564990737 1669742044
23926 to supply an email address for fast contact.
23929 \begin_layout Standard
23931 \change_deleted 564990737 1669742044
23932 In addition to these topics, the macros use one additional \SpecialChar LaTeX
23934 has no counterpart in \SpecialChar LyX
23938 \begin_layout Itemize
23940 \change_deleted 564990737 1669742044
23947 to separate different names for more than one author and institute, respectivel
23951 \begin_layout Standard
23953 \change_deleted 564990737 1669742044
23954 The appropriate command has to be entered in \SpecialChar LyX
23955 and marked as \SpecialChar LaTeX
23961 \begin_layout Subsection
23963 \change_deleted 564990737 1669742044
23967 \begin_layout Standard
23969 \change_deleted 564990737 1669742044
23970 The abstract should immediately follow the header block.
23971 With version 5 the abstract environment was changed to a command, and there
23972 is now a restriction to only one paragraph.
23973 In addition, it should contain an entry with the keywords.
23974 This is done via the paragraph style
23979 Refer to the example paper.
23982 \begin_layout Subsection
23984 \change_deleted 564990737 1669742044
23985 Supported environments
23988 \begin_layout Standard
23990 \change_deleted 564990737 1669742044
23991 The A&A paper layout supports the following environments for structuring
23995 \begin_layout Itemize
23997 \change_deleted 564990737 1669742044
24003 \begin_layout Itemize
24005 \change_deleted 564990737 1669742044
24011 \begin_layout Itemize
24013 \change_deleted 564990737 1669742044
24019 \begin_layout Itemize
24021 \change_deleted 564990737 1669742044
24027 \begin_layout Itemize
24029 \change_deleted 564990737 1669742044
24035 \begin_layout Itemize
24037 \change_deleted 564990737 1669742044
24043 \begin_layout Itemize
24045 \change_deleted 564990737 1669742044
24051 \begin_layout Itemize
24053 \change_deleted 564990737 1669742044
24059 \begin_layout Itemize
24061 \change_deleted 564990737 1669742044
24067 \begin_layout Itemize
24069 \change_deleted 564990737 1669742044
24075 \begin_layout Itemize
24077 \change_deleted 564990737 1669742044
24083 \begin_layout Itemize
24085 \change_deleted 564990737 1669742044
24092 \begin_layout Subsection
24094 \change_deleted 564990737 1669742044
24095 Commands not supported by \SpecialChar LyX
24099 \begin_layout Standard
24101 \change_deleted 564990737 1669742044
24102 Some commands are not yet supported by the
24106 layout for \SpecialChar LyX
24108 Some have already been mentioned.
24109 For the sake of completeness, they are listed all together here:
24112 \begin_layout Itemize
24114 \change_deleted 564990737 1669742044
24122 \begin_layout Itemize
24124 \change_deleted 564990737 1669742044
24132 \begin_layout Itemize
24134 \change_deleted 564990737 1669742044
24142 \begin_layout Itemize
24144 \change_deleted 564990737 1669742044
24152 \begin_layout Standard
24154 \change_deleted 564990737 1669742044
24155 If you want to use any of these commands, you have to enter them yourself.
24158 Do not forget to mark them as \SpecialChar LaTeX
24162 \begin_layout Subsection
24164 \change_deleted 564990737 1669742044
24165 Figure and Table Floats
24168 \begin_layout Standard
24170 \change_deleted 564990737 1669742044
24172 provides support for the necessary float environments
24174 figure, figure*, table
24180 , therefore we won't tell much about it here.
24184 \begin_inset space ~
24190 Just remember that tables should be left-aligned.
24191 For that, select the table and change the alignment in
24193 Edit\SpecialChar menuseparator
24195 \begin_inset space ~
24201 \begin_layout Standard
24203 \change_deleted 564990737 1669742044
24204 There is only one special thing: the figures with caption besides the figure.
24205 To create such a figure, you have to do the following:
24208 \begin_layout Enumerate
24210 \change_deleted 564990737 1669742044
24211 Create a wide figure float:
24213 Insert\SpecialChar menuseparator
24214 Float\SpecialChar menuseparator
24217 , then right click in the figure and select
24220 \begin_inset space ~
24228 \begin_layout Enumerate
24230 \change_deleted 564990737 1669742044
24231 Enter your caption text.
24234 \begin_layout Enumerate
24236 \change_deleted 564990737 1669742044
24241 to move the cursor above the caption.
24244 \begin_layout Enumerate
24246 \change_deleted 564990737 1669742044
24250 \begin_layout Enumerate
24252 \change_deleted 564990737 1669742044
24253 Position the cursor behind the figure and insert a horizontal fill:
24255 Insert\SpecialChar menuseparator
24257 \begin_inset space ~
24260 Character\SpecialChar menuseparator
24262 \begin_inset space ~
24270 \begin_layout Enumerate
24272 \change_deleted 564990737 1669742044
24273 Switch to \SpecialChar LaTeX
24277 \begin_inset space ~
24285 \begin_layout Enumerate
24287 \change_deleted 564990737 1669742044
24297 Do not close the brace!
24300 \begin_layout Enumerate
24302 \change_deleted 564990737 1669742044
24303 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
24308 \begin_inset space ~
24320 \begin_layout Standard
24322 \change_deleted 564990737 1669742044
24323 Also, refer to the figures in the example paper.
24326 \begin_layout Subsection
24328 \change_deleted 564990737 1669742044
24332 \begin_layout Standard
24334 \change_deleted 564990737 1669742044
24335 For submission, the paper has to be formated in a special double-spacing
24337 For this purpose, you have to give the option
24341 to the document class.
24342 This must be done using the custom class options field in the
24344 Document\SpecialChar menuseparator
24348 Just enter the string
24355 \begin_layout Subsection
24357 \change_deleted 564990737 1669742044
24361 \begin_layout Standard
24363 \change_deleted 564990737 1669742044
24368 directory contains an example paper written with \SpecialChar LyX
24370 It is the example paper from the original macro package, translated to
24373 Use it for inspiration, and compare the original \SpecialChar LaTeX
24374 code with \SpecialChar LyX
24378 \begin_layout Section
24380 \change_deleted 564990737 1671097429
24384 \begin_layout Standard
24386 \change_deleted 564990737 1671097429
24391 can be used to type letters according to German conventions.
24392 A template file is included in
24394 .../lyx/share/templates
24396 for you to use as a starting point.
24399 \begin_layout Section
24401 \change_deleted 564990737 1671097429
24405 \begin_layout Standard
24407 \change_deleted 564990737 1671097429
24408 See the \SpecialChar LyX
24414 It contains all infos you need.
24417 \begin_layout Section
24419 \change_deleted 564990737 1669755802
24423 \begin_layout Standard
24425 \change_deleted 564990737 1669755802
24428 Panayotis Papasotiriou
24431 \begin_layout Subsection
24433 \change_deleted 564990737 1669755802
24437 \begin_layout Standard
24439 \change_deleted 564990737 1669755802
24440 The ijmpc package is a set of macros that facilitates electronic manuscript
24443 International Journal of Modern Physics C
24446 Similarly, the ijmpd package is for creating manuscripts to be submitted
24449 International Journal of Modern Physics D
24452 Both journals are published by World Scientific.
24453 The corresponding document classes are named
24462 These files, together with instructions for the authors, can be downloaded
24464 \begin_inset Flex URL
24467 \begin_layout Plain Layout
24469 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
24475 \begin_inset Flex URL
24478 \begin_layout Plain Layout
24480 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
24486 Both packages are modified versions of the standard
24487 \begin_inset Quotes eld
24491 \begin_inset Quotes erd
24494 package, and they are almost (but not exactly) identical.
24495 Most of their features are supported by \SpecialChar LyX
24497 I have used \SpecialChar LyX
24498 successfully to write articles submitted to both journals
24499 without any problem.
24502 \begin_layout Subsection
24504 \change_deleted 564990737 1669755802
24508 \begin_layout Standard
24510 \change_deleted 564990737 1669755802
24511 As usual, the easiest way to write a paper is to start with a template.
24514 File\SpecialChar menuseparator
24530 This will give an (almost) empty document that includes the most common
24531 fields found in a manuscript.
24532 Simply overwrite the existing text (including the brackets,
24537 You should keep in mind the following remarks.
24540 \begin_layout Enumerate
24542 \change_deleted 564990737 1669755802
24544 won't let you change the font size and the page style of the document,
24545 because such modifications are not allowed by both packages.
24548 \begin_layout Enumerate
24550 \change_deleted 564990737 1669755802
24551 The language of the document should not be changed.
24552 Before previewing your paper, be sure that the babel package is not used.
24553 To do this, click on
24556 arg "dialog-show document"
24561 \SpecialChar menuseparator
24565 \begin_inset Quotes eld
24569 \begin_inset Quotes erd
24579 \begin_layout Enumerate
24581 \change_deleted 564990737 1669755802
24583 \begin_inset Quotes eld
24587 \begin_inset Quotes erd
24590 style must be used to define keywords.
24593 \begin_layout Enumerate
24595 \change_deleted 564990737 1669755802
24596 The ijmpc package provides a style named
24597 \begin_inset Quotes eld
24600 Classification Codes
24601 \begin_inset Quotes erd
24604 , which can be used to define classification codes, such as PACS numbers.
24605 Note that this facility is not supported by the ijmpd package.
24608 \begin_layout Enumerate
24610 \change_deleted 564990737 1669755802
24611 Several new environments are available:
24612 \begin_inset Quotes eld
24616 \begin_inset Quotes erd
24620 \begin_inset Quotes eld
24624 \begin_inset Quotes erd
24628 \begin_inset Quotes eld
24632 \begin_inset Quotes erd
24636 \begin_inset Quotes eld
24640 \begin_inset Quotes erd
24644 \begin_inset Quotes eld
24648 \begin_inset Quotes erd
24652 \begin_inset Quotes eld
24656 \begin_inset Quotes erd
24660 \begin_inset Quotes eld
24664 \begin_inset Quotes erd
24668 \begin_inset Quotes eld
24672 \begin_inset Quotes erd
24676 \begin_inset Quotes eld
24680 \begin_inset Quotes erd
24684 \begin_inset Quotes eld
24688 \begin_inset Quotes erd
24692 \begin_inset Quotes eld
24696 \begin_inset Quotes erd
24700 \begin_inset Quotes eld
24704 \begin_inset Quotes erd
24708 \begin_inset Quotes eld
24712 \begin_inset Quotes erd
24716 \begin_inset Quotes eld
24720 \begin_inset Quotes erd
24724 Their use is more or less obvious.
24726 supports all these environments; it will use the proper label, text style,
24727 and numbering scheme for each of them.
24730 \begin_layout Enumerate
24732 \change_deleted 564990737 1669755802
24733 Both packages use basic citations; the natbib package should not be used.
24734 In \SpecialChar LyX
24735 , citation references are shown as usual; in the output, citations are
24736 shown as superscripts.
24737 If you want to use a citation as normal text, you should use the
24742 \begin_inset space \thinspace{}
24746 \begin_inset space \space{}
24750 \begin_inset Quotes eld
24754 \begin_inset space \space{}
24764 \begin_inset Quotes erd
24770 \begin_layout Enumerate
24772 \change_deleted 564990737 1669755802
24774 \begin_inset Quotes eld
24778 \begin_inset Quotes erd
24781 section in both packages.
24782 To put acknowledgments, just use the
24783 \begin_inset Quotes eld
24787 \begin_inset Quotes erd
24793 \begin_layout Enumerate
24795 \change_deleted 564990737 1669755802
24796 Appendices may be added to the paper,
24800 the Acknowledgments and
24806 provides a special environment, called
24807 \begin_inset Quotes eld
24811 \begin_inset Quotes erd
24814 which marks the beginning of the appendices.
24815 This environment should be left blank; it just sends a \SpecialChar LaTeX
24816 command, but nothing
24818 In \SpecialChar LyX
24820 \begin_inset Quotes eld
24824 \begin_inset Quotes erd
24827 is printed with blue letters, as a signal that all sections after that
24828 point are appendices.
24829 To write an appendix, use the
24830 \begin_inset Quotes eld
24834 \begin_inset Quotes erd
24839 will number each appendix with capital letters, as required by both journals.
24841 \begin_inset Quotes eld
24845 \begin_inset Quotes erd
24852 be present before the first appendix; if not, all appendices will be numbered
24853 as normal sections in the output.
24856 \begin_layout Enumerate
24858 \change_deleted 564990737 1669755802
24859 The ijmpc and the ijmpd packages use the
24863 command to implement table captions.
24864 As a result, a table created by \SpecialChar LyX
24865 is printed correctly, but its caption
24867 However, you can use some \SpecialChar TeX
24868 code to overcome this problem, so that captions
24869 are printed as expected.
24870 To do so, create a float table as usual, remove the caption, and replace
24871 it with the \SpecialChar TeX
24882 (sic); you must also the \SpecialChar TeX
24887 immediately after the tabular material.
24888 Study the example table included in the template files to see how this
24889 trick is implemented.
24890 Alternatively, If you need table captions, you should implement the whole
24895 file, then include this file to the \SpecialChar LyX
24898 Insert\SpecialChar menuseparator
24899 File\SpecialChar menuseparator
24901 \begin_inset space ~
24907 Details on how to create a table float can be found in the files
24915 , included in the corresponding packages.
24918 \begin_layout Subsection
24920 \change_deleted 564990737 1669755802
24921 Preparing a paper for submission
24924 \begin_layout Standard
24926 \change_deleted 564990737 1669755802
24927 Before you submit your paper you must export the \SpecialChar LyX
24928 document as a \SpecialChar LaTeX
24931 File\SpecialChar menuseparator
24932 Export\SpecialChar menuseparator
24940 \begin_layout Plain Layout
24941 Actually you have the choice between \SpecialChar LaTeX
24942 (plain) and pdflatex.
24943 If you intend to use pdflatex to prepare the paper, you should use the
24944 pdflatex option so that included graphics are converted to PDF format,
24945 ready for use by pdflatex.
24950 , then make the following changes to the resulting
24957 \begin_layout Enumerate
24959 \change_deleted 564990737 1669755802
24960 Remove the comment lines before the
24969 \begin_layout Enumerate
24971 \change_deleted 564990737 1669755802
24972 Remove everything between (and including) the
24984 commands, except for any commands you specifically put into the \SpecialChar LaTeX
24988 \begin_layout Standard
24990 \change_deleted 564990737 1669755802
24995 file should be saved and processed through \SpecialChar LaTeX
24996 as many times as necessary.
24997 You may also want to check the resulting
25006 \begin_layout Section
25008 \change_deleted 564990737 1669801478
25012 \begin_layout Standard
25014 \change_deleted 564990737 1669801478
25020 \begin_layout Subsection
25022 \change_deleted 564990737 1669801478
25026 \begin_layout Standard
25028 \change_deleted 564990737 1669801478
25029 The iopart package provides a document class to create electronic manuscript
25030 submission to the journals published by the Institute of Physics.
25031 Instructions for the authors how to create a paper using the iopart class
25032 can be downloaded together with the iopart package from the site
25033 \begin_inset Flex URL
25036 \begin_layout Plain Layout
25038 ftp://ftp.iop.org/pub/journals/latex2e
25046 \begin_layout Subsection
25048 \change_deleted 564990737 1669801478
25052 \begin_layout Standard
25054 \change_deleted 564990737 1669801478
25055 The easiest way to write a paper is to start with the template
25059 that is available via
25061 File\SpecialChar menuseparator
25064 The template explains how to use the special text environments.
25065 Here are the most important advices:
25068 \begin_layout Itemize
25070 \change_deleted 564990737 1669801478
25071 To be able to compile your document to a PDF, PS, or DVI, ensure that the
25072 no AMS packages are loaded in
25074 Document\SpecialChar menuseparator
25075 Settings\SpecialChar menuseparator
25081 \begin_layout Itemize
25083 \change_deleted 564990737 1669801478
25086 The title environment defines the kind of your paper.
25087 So use one of the following environments for the title:
25091 \begin_layout Itemize
25093 \change_deleted 564990737 1669801478
25102 \begin_layout Itemize
25104 \change_deleted 564990737 1669801478
25113 \begin_layout Itemize
25115 \change_deleted 564990737 1669801478
25121 for a Topical review
25124 \begin_layout Itemize
25126 \change_deleted 564990737 1669801478
25135 \begin_layout Itemize
25137 \change_deleted 564990737 1669801478
25146 \begin_layout Itemize
25148 \change_deleted 564990737 1669801478
25154 for a Paper (same as Title)
25157 \begin_layout Itemize
25159 \change_deleted 564990737 1669801478
25165 for a Preliminary communication
25168 \begin_layout Itemize
25170 \change_deleted 564990737 1669801478
25176 for a Rapid communication
25179 \begin_layout Itemize
25181 \change_deleted 564990737 1669801478
25187 for a Letter to the editor
25191 \begin_layout Itemize
25193 \change_deleted 564990737 1669801478
25196 All title environments except of
25200 can have an optional short title.
25203 \begin_layout Itemize
25205 \change_deleted 564990737 1669801478
25206 There is a general title environment
25210 which is not directly supported by \SpecialChar LyX
25212 This can be used as \SpecialChar TeX
25213 code when your document doesn't fit into one of the
25217 \begin_layout Standard
25219 \change_deleted 564990737 1669801478
25220 For more informations like hints for special table and formula formatting,
25221 look at the IOP author guidelines.
25226 \begin_layout Section
25228 \change_deleted 564990737 1670317155
25232 \begin_layout Standard
25234 \change_deleted 564990737 1670317155
25237 Panayotis Papasotiriou
25240 \begin_layout Subsection
25242 \change_deleted 564990737 1670317155
25246 \begin_layout Standard
25248 \change_deleted 564990737 1670317155
25249 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
25250 that facilitates electronic manuscript submission to the journals they
25252 Most known of them (at least in my domain of interest) are
25254 Astrophysics and Space Science
25260 , but there are many others (see a complete list at
25261 \begin_inset Flex URL
25264 \begin_layout Plain Layout
25266 http://www.wkap.nl/jrnllist.htm/JRNLHOME
25272 The Kluwer package may be downloaded from the site
25273 \begin_inset Flex URL
25276 \begin_layout Plain Layout
25278 http://www.wkap.nl/kaphtml.htm/STYLEFILES
25284 A complete user guide is contained in that package (but it can also be
25285 downloaded separately).
25288 \begin_layout Standard
25290 \change_deleted 564990737 1670317155
25292 supports many features of the package but not everything.
25293 However, the \SpecialChar TeX
25294 code needed is reduced to some
25295 \begin_inset Quotes eld
25299 \begin_inset Quotes erd
25302 commands of the package (see
25303 \begin_inset space ~
25307 \begin_inset CommandInset ref
25309 reference "subsec:kluwer_peculiarities"
25314 I have recently used \SpecialChar LyX
25315 to write an article submitted to the
25317 Astrophysics and Space Science
25319 without any problem.
25322 \begin_layout Subsection
25324 \change_deleted 564990737 1670317155
25328 \begin_layout Standard
25330 \change_deleted 564990737 1670317155
25331 The easiest way to write a paper is to start with the Kluwer template file.
25334 File\SpecialChar menuseparator
25346 This will give an (almost) empty document that includes the most common
25347 fields found in a manuscript and a short description of their use.
25348 As in most templates, simply overwrite the existing text (including the
25353 ) with the correct information.
25356 \begin_layout Subsection
25358 \change_deleted 564990737 1670317155
25359 Preparing a paper for submission
25362 \begin_layout Standard
25364 \change_deleted 564990737 1670317155
25365 As in the AAS\SpecialChar TeX
25366 package, before you submit your paper to a journal you must
25368 \begin_inset Quotes eld
25372 \begin_inset Quotes erd
25378 \begin_layout Enumerate
25380 \change_deleted 564990737 1670317155
25381 Export your paper as a \SpecialChar LaTeX
25383 To do this, click on
25385 File\SpecialChar menuseparator
25386 Export\SpecialChar menuseparator
25394 \begin_layout Enumerate
25396 \change_deleted 564990737 1670317155
25401 file with a text editor and make the following changes
25405 \begin_layout Enumerate
25407 \change_deleted 564990737 1670317155
25408 remove the comment lines before the
25417 \begin_layout Enumerate
25419 \change_deleted 564990737 1670317155
25420 remove everything between (and including) the
25432 commands, except for any commands you specifically put into the \SpecialChar LaTeX
25436 \begin_layout Standard
25438 \change_deleted 564990737 1670317155
25447 \begin_layout Enumerate
25449 \change_deleted 564990737 1670317155
25454 file through \SpecialChar LaTeX
25455 as many times as necessary (usually up to three).
25458 \begin_layout Enumerate
25460 \change_deleted 564990737 1670317155
25466 \begin_inset space \thinspace{}
25470 \begin_inset space \space{}
25477 , and check if everything is OK (it should, if you didn't make any mistake).
25480 \begin_layout Subsection
25482 \change_deleted 564990737 1670317155
25483 \begin_inset Quotes eld
25487 \begin_inset Quotes erd
25490 of the Kluwer package
25491 \begin_inset CommandInset label
25493 name "subsec:kluwer_peculiarities"
25500 \begin_layout Standard
25502 \change_deleted 564990737 1670317155
25503 The Kluwer package has the following
25504 \begin_inset Quotes eld
25508 \begin_inset Quotes erd
25514 \begin_layout Enumerate
25516 \change_deleted 564990737 1670317155
25517 It is possible to write multiple articles in the same \SpecialChar LaTeX
25522 \begin_layout Plain Layout
25523 I can't imagine any good reason to do this.
25529 Each article must be included in the environment
25530 \begin_inset Quotes eld
25534 \begin_inset Quotes erd
25538 Unfortunately, this environment cannot be omitted, even if you write just
25540 Therefore, each article starts with the command
25546 and, obviously, ends with the command
25553 Although this can be implemented in \SpecialChar LyX
25554 , I didn't included it, since it looks
25555 ugly and can confuse the novice user.
25556 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
25559 \begin_inset Quotes eld
25564 \begin_inset Quotes erd
25570 \begin_layout Enumerate
25572 \change_deleted 564990737 1670317155
25573 Information given at the beginning of the article (i.
25574 \begin_inset space \thinspace{}
25578 \begin_inset space \space{}
25581 title, subtitle, author, institution, running title, running author, abstract
25582 and keywords) must be included in an environment called
25583 \begin_inset Quotes eld
25587 \begin_inset Quotes erd
25591 This is not implemented in \SpecialChar LyX
25592 , so you must enter title, subtitle etc.
25593 \begin_inset space ~
25596 between two \SpecialChar TeX
25612 \begin_layout Enumerate
25614 \change_deleted 564990737 1670317155
25615 According to the user manual, the label of each bibliography item must be
25639 \begin_layout Standard
25641 \change_deleted 564990737 1670317155
25646 template takes care of all these
25647 \begin_inset Quotes eld
25651 \begin_inset Quotes erd
25655 If you start a new paper using this template you don't need to do anything
25660 \begin_layout Enumerate
25662 \change_deleted 564990737 1670317155
25663 don't delete the \SpecialChar TeX
25664 code included in the template, and
25667 \begin_layout Enumerate
25669 \change_deleted 564990737 1670317155
25670 copy the example bibliography item included in the template and modify it
25671 as necessary to enter new bibliography items.
25674 \begin_layout Section
25676 \change_deleted 564990737 1671097446
25680 \begin_layout Standard
25682 \change_deleted 564990737 1671097446
25687 provides an alternative to the standard
25692 It provides similar functionality, but you might prefer this layout with
25693 sans serif sections, headings, and more.
25696 \begin_layout Section
25698 \change_deleted 564990737 1671097446
25699 Springer Journals (
25706 \begin_layout Standard
25708 \change_deleted 564990737 1671097446
25714 \begin_layout Subsection
25716 \change_deleted 564990737 1671097446
25720 \begin_layout Standard
25722 \change_deleted 564990737 1671097446
25723 These are the layout files for some of the journal formats used by Springer
25724 Verlag and listed on
25725 \begin_inset Flex URL
25728 \begin_layout Plain Layout
25730 http://www.springer.de/author/tex/help-journals.html
25735 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
25737 It is a modular system: the things common to all journals are implemented
25742 , which journal-specific layout files (such as, e.
25743 \begin_inset space \thinspace{}
25747 \begin_inset space \space{}
25754 for Journal of Geodesy) can include.
25757 \begin_layout Standard
25759 \change_deleted 564990737 1671097446
25760 This means that implementing support for any other Springer journal on this
25761 list is as simple as writing your own
25769 file following the outline given in
25777 \begin_layout Standard
25779 \change_deleted 564990737 1671097446
25780 It is reasonably well tested only for the Journal of Geodesy.
25789 come with the standard \SpecialChar LyX
25791 Install the relevant class file (downloaded from Springer) in a proper
25792 directory, reconfigure \SpecialChar LaTeX
25793 (in the te\SpecialChar TeX
25798 , as root if necessary — doesn't \SpecialChar LyX
25799 take care of this?), reconfigure \SpecialChar LyX
25804 \begin_layout Subsection
25806 \change_deleted 564990737 1671097446
25810 \begin_layout Standard
25812 \change_deleted 564990737 1671097446
25813 A large number of theorem-like styles —
25825 \begin_layout Standard
25827 \change_deleted 564990737 1671097446
25830 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
25831 _Title, Author_Running, Institute,
25832 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
25835 See the Springer class file documentation for details.
25838 \begin_layout Subsection
25840 \change_deleted 564990737 1671097446
25844 \begin_layout Itemize
25846 \change_deleted 564990737 1671097446
25858 \begin_layout Itemize
25860 \change_deleted 564990737 1671097446
25863 Probability Theory and Related Fields
25869 — Jean-Marc Lasgouttes
25872 \begin_layout Standard
25874 \change_deleted 564990737 1671097446
25875 Add your own, it isn't so hard!
25878 \begin_layout Subsection
25880 \change_deleted 564990737 1671097446
25884 \begin_layout Standard
25886 \change_deleted 564990737 1671097446
25887 These files are partly based on the older
25891 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
25893 file from Springer.
25898 layout, are now defunct.
25899 Jean-Marc Lasgouttes helped out big in making me find my way around the
25901 layout file mechanism.
25904 \begin_layout Subsection
25906 \change_deleted 564990737 1671097446
25910 \begin_layout Standard
25912 \change_deleted 564990737 1671097446
25914 But probably less than in the old hacked-\SpecialChar LaTeX
25922 \begin_layout Chapter
25924 Features needing Extra Software
25927 \begin_layout Section
25928 Checking \SpecialChar TeX
25932 \begin_layout Standard
25938 \begin_layout Subsection
25942 \begin_layout Standard
25951 \begin_layout Plain Layout
25956 is not yet available when you are using the \SpecialChar LaTeX
25957 distribution MiK\SpecialChar TeX
25963 , you'll find in the
25970 \begin_inset space ~
25981 \begin_inset Newline newline
25985 \begin_inset CommandInset href
25987 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
25995 \begin_layout Standard
25998 Chk\SpecialChar TeX
26001 package is a program that was written by
26002 \begin_inset Flex Noun
26005 \begin_layout Plain Layout
26007 \begin_inset space ~
26015 in frustration because some constructs in \SpecialChar LaTeX
26016 are sometimes non-intuitive,
26017 and easy to forget.
26018 The program runs over your \SpecialChar LaTeX
26019 file, checks the integrity of the file, and
26020 flags some common errors.
26021 In other technical words, it is
26025 for \SpecialChar LaTeX
26029 \begin_layout Standard
26030 Well, what is a syntax checker doing in \SpecialChar LyX
26031 which is supposed to produce correct
26033 anyways? The answer is simple: Just as
26037 not only checks the
26041 of C programs, but also does
26045 checks for type-errors,
26047 Chk\SpecialChar TeX
26050 catches some common
26054 errors, in addition to the syntactical ones.
26057 Chk\SpecialChar TeX
26060 is capable of detecting several common errors, such as
26063 \begin_layout Itemize
26064 Ellipsis detection:
26065 \begin_inset Newline newline
26068 Use \SpecialChar ldots
26072 \begin_layout Itemize
26073 No space in front of/after parenthesis:
26074 \begin_inset Newline newline
26080 \begin_layout Itemize
26081 Enforcement of normal space after common abbreviations:
26082 \begin_inset Newline newline
26086 \begin_inset space \thinspace{}
26090 \begin_inset space \space{}
26093 is too wide spacing.
26096 \begin_layout Itemize
26097 Enforcement of end-of-sentence space when the last sentence ends with a
26099 \begin_inset Newline newline
26103 And this is wrong spacing.
26106 \begin_layout Itemize
26107 Space in front of labels and similar commands:
26108 \begin_inset Newline newline
26111 The label should stick right up to the text to avoid falling to a wrong
26114 \begin_inset CommandInset label
26124 \begin_layout Plain Layout
26125 This footnote is in danger of falling off to a wrong page
26130 The label is separated too much.
26133 \begin_layout Itemize
26134 Space in front of references, instead of hard spaces:
26135 \begin_inset Newline newline
26138 If you have bad luck, the text will break right between the referenced text
26139 and reference number, and that's a pity.
26141 \begin_inset CommandInset ref
26143 reference "sec:chktex"
26150 \begin_layout Itemize
26152 \begin_inset Quotes eld
26156 \begin_inset Quotes erd
26160 \begin_inset Formula $\times$
26164 \begin_inset Newline newline
26167 2x2 looks cheap compared to
26168 \begin_inset Formula $2\times2$
26174 \begin_layout Standard
26175 and more \SpecialChar ldots
26176 It is an invaluable tool when you are
26177 \begin_inset Quotes eld
26181 \begin_inset Quotes erd
26184 your document before printing, and you should run it right after the obligatory
26185 spelling check, and before you go fine tuning the typesetting.
26188 \begin_layout Subsection
26192 \begin_layout Standard
26193 If you have the program installed, usage is as simple as choosing
26195 Tools\SpecialChar menuseparator
26197 \begin_inset space ~
26203 This will make \SpecialChar LyX
26204 generate a \SpecialChar LaTeX
26205 file of your document, start
26207 Chk\SpecialChar TeX
26210 to check it, and then make \SpecialChar LyX
26212 \begin_inset Quotes eld
26216 \begin_inset Quotes erd
26219 with the warnings from
26221 Chk\SpecialChar TeX
26224 , if there were any.
26225 The warnings will be placed close to the point of the mistake, and you
26226 can quickly find them by using the
26228 Navigate\SpecialChar menuseparator
26231 menu item, or the shortcut key
26240 Open the error boxes by clicking on them with the mouse, or use the shortcut
26249 bindings, or the corresponding
26258 Read the warning and correct the mistake, if it is a mistake.
26259 If you have trouble understanding what the warning is about, you can safely
26261 Remember that there is a hidden layer between the document on screen and
26262 the technical details in invoking
26264 Chk\SpecialChar TeX
26267 , and this gap can make some warnings seem arcane or just plain silly.
26270 \begin_layout Standard
26271 This document is an excellent testing bed for the feature, and it should
26272 provide quite a few warnings for you to fiddle with.
26273 Since computers are only so smart, expect most of the warnings to be false
26277 \begin_layout Subsection
26278 How to fine tune it
26281 \begin_layout Standard
26282 Sometimes, you'll find that
26284 Chk\SpecialChar TeX
26287 makes more noise than suits your mood.
26288 Then you can choose not to use it, wait until your mood changes, or try
26291 Chk\SpecialChar TeX
26294 to get better along with you.
26297 \begin_layout Standard
26300 Chk\SpecialChar TeX
26307 very configurable and extensible, you should not expect to solve all problems
26310 Chk\SpecialChar TeX
26313 in \SpecialChar LyX
26315 Since \SpecialChar LyX
26316 has to generate a somewhat special \SpecialChar LaTeX
26317 file to be able to match the
26318 line numbers from the
26320 Chk\SpecialChar TeX
26327 \begin_layout Plain Layout
26328 You can inspect the specific output from
26334 Document\SpecialChar menuseparator
26337 \begin_inset space ~
26351 to the internal document structure, some of the warnings will not appear
26353 There are two things you can do about this:
26356 \begin_layout Itemize
26359 Chk\SpecialChar TeX
26362 invocation command line in
26363 \begin_inset Flex Noun
26366 \begin_layout Plain Layout
26367 Tools\SpecialChar menuseparator
26368 Preferences\SpecialChar menuseparator
26369 Output\SpecialChar menuseparator
26370 LaTeX\SpecialChar menuseparator
26378 Chk\SpecialChar TeX
26381 installation configuration file (usually with the file
26386 See below to learn what warnings can be enabled and disabled on the command
26390 \begin_layout Itemize
26391 Export your document as a raw \SpecialChar LaTeX
26394 File\SpecialChar menuseparator
26395 Export\SpecialChar menuseparator
26404 Invoked in this way, it can be a hassle to find the corresponding place
26405 in the document inside \SpecialChar LyX
26406 , but with a little patience, you should be able
26410 \begin_layout Standard
26411 Here follows the warning messages that can be enabled and disabled in
26420 to disable a warning, and
26424 to enable a warning.
26425 The emphasized entries are disabled by default, because the default is
26428 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
26433 \begin_layout Standard
26434 Notice that you should only use the options that enable and disable warnings,
26435 because \SpecialChar LyX
26436 relies on some of the other command line parameters to be set
26437 in a specific way to have a chance to communicate with
26444 \begin_layout Enumerate
26448 Command terminated with space.
26451 \begin_layout Enumerate
26454 Non-breaking space (
26455 \begin_inset Quotes eld
26463 \begin_inset Quotes erd
26466 ) should have been used.
26469 \begin_layout Enumerate
26473 You should enclose the previous parenthesis with
26474 \begin_inset Quotes eld
26482 \begin_inset Quotes erd
26488 \begin_layout Enumerate
26491 Italic correction (
26492 \begin_inset Quotes eld
26502 \begin_inset Quotes erd
26505 ) found in non-italic buffer.
26508 \begin_layout Enumerate
26511 Italic correction (
26512 \begin_inset Quotes eld
26522 \begin_inset Quotes erd
26525 ) found more than once.
26528 \begin_layout Enumerate
26532 No italic correction (
26533 \begin_inset Quotes eld
26543 \begin_inset Quotes erd
26549 \begin_layout Enumerate
26553 \begin_inset Quotes eld
26561 \begin_inset Quotes erd
26565 \begin_inset Quotes eld
26573 \begin_inset Quotes erd
26579 \begin_layout Enumerate
26582 Wrong length of dash may have been used.
26585 \begin_layout Enumerate
26589 \begin_inset Quotes eld
26597 \begin_inset Quotes erd
26601 \begin_inset Quotes eld
26609 \begin_inset Quotes erd
26615 \begin_layout Enumerate
26619 \begin_inset Quotes eld
26627 \begin_inset Quotes erd
26633 \begin_layout Enumerate
26637 \begin_inset Quotes eld
26645 \begin_inset Quotes erd
26648 to achieve an ellipsis.
26651 \begin_layout Enumerate
26654 Inter-word spacing (
26655 \begin_inset Quotes eld
26665 \begin_inset Quotes eld
26668 ) should perhaps be used.
26671 \begin_layout Enumerate
26674 Inter-sentence spacing (
26675 \begin_inset Quotes eld
26685 \begin_inset Quotes erd
26688 ) should perhaps be used.
26691 \begin_layout Enumerate
26694 Could not find argument for command.
26697 \begin_layout Enumerate
26701 \begin_inset Quotes eld
26709 \begin_inset Quotes erd
26715 \begin_layout Enumerate
26718 Math mode still on at end of \SpecialChar LaTeX
26722 \begin_layout Enumerate
26726 \begin_inset Quotes eld
26734 \begin_inset Quotes erd
26737 doesn't match the number of
26738 \begin_inset Quotes eld
26746 \begin_inset Quotes erd
26752 \begin_layout Enumerate
26755 You should use either
26758 \begin_inset Quotes eld
26766 \begin_inset Quotes erd
26771 as an alternative to
26772 \begin_inset Quotes eld
26780 \begin_inset Quotes erd
26786 \begin_layout Enumerate
26793 " (ASCII 39) instead of "
26800 \begin_layout Enumerate
26803 User-specified pattern found.
26806 \begin_layout Enumerate
26809 This command might not be intended.
26812 \begin_layout Enumerate
26819 \begin_layout Enumerate
26837 \begin_layout Enumerate
26840 Delete this space to maintain correct page references.
26843 \begin_layout Enumerate
26847 You might wish to put this between a pair of
26848 \begin_inset Quotes eld
26856 \begin_inset Quotes erd
26862 \begin_layout Enumerate
26865 You ought to remove spaces in front of punctuation.
26868 \begin_layout Enumerate
26871 Could not execute \SpecialChar LaTeX
26875 \begin_layout Enumerate
26884 in front of small punctuation.
26887 \begin_layout Enumerate
26895 may look prettier here.
26898 \begin_layout Enumerate
26902 Multiple spaces detected in output.
26905 \begin_layout Enumerate
26908 This text may be ignored.
26911 \begin_layout Enumerate
26917 \begin_inset Quotes eld
26922 to begin quotation, not
26929 \begin_layout Enumerate
26936 to end quotation, not
26939 \begin_inset Quotes eld
26947 \begin_layout Enumerate
26953 \begin_layout Enumerate
26956 You should perhaps use
26957 \begin_inset Quotes eld
26965 \begin_inset Quotes erd
26971 \begin_layout Enumerate
26974 You should put a space in front of/after parenthesis.
26977 \begin_layout Enumerate
26980 You should avoid spaces in front of/after parenthesis.
26983 \begin_layout Enumerate
26987 You should not use punctuation in front of/after quotes.
26990 \begin_layout Enumerate
26993 Double space found.
26996 \begin_layout Enumerate
26999 You should put punctuation outside inner/inside display math mode.
27002 \begin_layout Enumerate
27005 You ought to not use primitive \SpecialChar TeX
27006 in \SpecialChar LaTeX
27010 \begin_layout Enumerate
27013 You should remove spaces in front of
27014 \begin_inset Quotes eld
27022 \begin_inset Quotes erd
27028 \begin_layout Enumerate
27031 \begin_inset Quotes eld
27039 \begin_inset Quotes erd
27042 is normally not followed by
27043 \begin_inset Quotes eld
27051 \begin_inset Quotes erd
27057 \begin_layout Standard
27058 In later versions of \SpecialChar LyX
27059 , we hope to provide a more complete interface to this
27060 tool (and it's smaller cousin
27064 ) to exploit the full power of it.
27065 But it's not exactly useless as it is now: go try it on one of your existing
27066 documents of a certain length and be surprised.
27069 \begin_layout Section
27070 Version Control in \SpecialChar LyX
27074 \begin_layout Standard
27077 Lars Gullik Bjønnes
27084 \begin_layout Subsection
27088 \begin_layout Standard
27090 supports some of the most basic RCS/CVS/SVN/GIT commands.
27091 If you need something a bit more sophisticated you will have to do that
27092 manually in a terminal.
27095 \begin_layout Standard
27096 Also note that CVS support is not as good as subversion support, so we advise
27098 A good place to start learning Subversion is the SVN Book
27102 \begin_layout Plain Layout
27103 \begin_inset CommandInset href
27105 target "http://svnbook.red-bean.com/"
27116 In the case of RCS you should read
27117 \begin_inset Quotes eld
27121 \begin_inset Quotes erd
27124 (a man file, read it with
27129 This file describes all the basic features of RCS.
27130 You should especially notice the comment about a RCS directory, and the
27131 notion of a master RCS file (the file ending in
27138 \begin_layout Standard
27139 Before you begin to use the version control features in \SpecialChar LyX
27141 familiar with RCS/CVS/SVN/GIT usage.
27142 The implementation in \SpecialChar LyX
27143 assumes a recent version of the GNU RCS or CVS/SVN
27144 package — no guarantees are made for older versions.
27145 Most of the log messages are not currently displayed after operations —
27146 you can check them in the Messages pane if you are unsure.
27147 Regular users of version control will appreciate the VC toolbar, which
27150 View\SpecialChar menuseparator
27151 Toolbars\SpecialChar menuseparator
27153 \begin_inset space ~
27161 \begin_layout Standard
27162 For introducing your own external commands consult
27163 \begin_inset Flex Code
27166 \begin_layout Plain Layout
27180 \begin_layout Standard
27181 It is strongly recommended to store documents in uncompressed format if
27182 using version control (uncheck
27184 Document\SpecialChar menuseparator
27187 if it is checked): Uncompressed LyX documents are text files and therefore
27188 for merging two different versions by version control systems.
27189 Compressed LyX documents are binary files, which cannot be merged by version
27193 \begin_layout Subsection
27194 RCS commands in \SpecialChar LyX
27198 \begin_layout Standard
27199 The following sections describe the RCS commands supported by \SpecialChar LyX
27201 You can find them in the
27203 File\SpecialChar menuseparator
27205 \begin_inset space ~
27212 was tested against RCS 5.7/5.8.
27215 \begin_layout Subsubsection
27221 \begin_layout Standard
27222 If your document is not under revision control, this is the only item shown
27224 And if it is under revision control, the
27228 item is not visible.
27232 \begin_layout Standard
27233 This command registers your document with RCS (unless you are under the
27234 directory managed by CVS)\SpecialChar endofsentence
27235 You are asked interactively to supply an initial
27236 description of the document.
27237 The document is now set in Read-Only mode and you have to
27240 \begin_inset space ~
27244 \begin_inset space ~
27248 \begin_inset space ~
27253 , before making any changes to it.
27254 A document under revision control has a
27255 \begin_inset Quotes eld
27258 [RCS:<version> <locker>]
27259 \begin_inset Quotes erd
27262 item tagged to the filename in the minibuffer.
27265 \begin_layout Standard
27266 RCS command that is run:
27269 \begin_layout LyX-Code
27272 ci -q -u -i -t-"<initial description>" <file-name>
27275 \begin_layout Standard
27280 to understand the switches.
27284 \begin_layout Subsubsection
27290 \begin_layout Standard
27291 When you are finished editing a file, you check in your changes.
27292 When you do this, you are asked for a description of the changes.
27293 This is stored in the history log.
27294 The version number is bumped, your changes are applied to the master RCS
27295 file, the document is unlocked and set to Read-Only mode.
27298 \begin_layout Itemize
27301 ci -q -u -m"<description>" <file-name>
27304 \begin_layout Subsubsection
27310 \begin_layout Standard
27311 By doing this you lock the document so that only you can edit it.
27312 This will also make the document Read-Write only for you.
27313 You will usually continue editing for a while and when you are finished
27314 you check in your changes.
27315 The status line is changed to reflect that you have locked the file.
27318 \begin_layout Itemize
27321 co -q -l <file-name>
27324 \begin_layout Subsubsection
27327 Revert To Repository Version
27330 \begin_layout Standard
27331 This will discard all changes made to the document since the last check
27333 You get a warning before changes are discarded.
27336 \begin_layout Itemize
27339 co -f -u<version> <file-name>
27342 \begin_layout Subsubsection
27348 \begin_layout Standard
27349 This will create a copy of the current document.
27350 Since RCS does not support copy operations natively, the version history
27351 is not preserved, and the copy is added as a new file.
27352 It requires a clean document without any changes since the last checkin.
27353 You are asked for a file name and a description of the copy operation.
27354 After that the copy is created, both locally and in the repository.
27355 If the parent directories of the copied and original document differ, all
27356 relative paths of included files of the copy are adjusted (like in
27358 File\SpecialChar menuseparator
27363 Finally, the copy is loaded instead of the original document.
27366 \begin_layout Labeling
27367 \labelwidthstring 00.00.0000
27369 \begin_inset space ~
27373 \begin_inset space ~
27377 \begin_inset Newline newline
27381 \begin_inset Flex Code
27384 \begin_layout Plain Layout
27387 \begin_inset Quotes qld
27391 \begin_inset Quotes qld
27400 \begin_inset Flex Code
27403 \begin_layout Plain Layout
27406 \begin_inset Quotes qld
27410 \begin_inset Quotes qld
27419 \begin_inset Newline newline
27423 \begin_inset Flex Code
27426 \begin_layout Plain Layout
27430 \begin_inset Quotes qld
27434 \begin_inset Quotes qld
27445 \begin_layout Subsubsection
27451 \begin_layout Standard
27452 This makes as if the last check in never happened.
27453 No changes are made to the document loaded into \SpecialChar LyX
27454 , but the last version
27455 is removed from the master RCS file.
27458 \begin_layout Itemize
27461 rcs -o<version> <file-name>
27464 \begin_layout Subsubsection
27470 \begin_layout Standard
27471 This shows the complete history of the RCS document.
27476 is shown in a browser.
27484 \begin_layout Subsubsection
27488 \begin_layout Standard
27490 supports RCS version number, author name, date and time of last commit.
27491 All those are extracted from
27493 rlog -r <file-name>
27497 \begin_inset CommandInset ref
27499 reference "subsec:VCS-Revision-Information"
27506 \begin_layout Subsection
27507 CVS commands in \SpecialChar LyX
27511 \begin_layout Standard
27512 A subset of CVS operations is supported by \SpecialChar LyX
27514 You can find the commands in the
27516 File\SpecialChar menuseparator
27518 \begin_inset space ~
27524 The version control system SVN is more powerful, so please use it instead
27525 of CVS if possible.
27528 \begin_layout Subsubsection
27534 \begin_layout Standard
27535 If you start from scratch with CVS you have to create your repository and
27536 checkout the working copy with external tools.
27537 If you're using a client-server setup you may need to login before doing
27538 the first repository checkout.
27541 \begin_layout Standard
27542 If your documents are under revision control and others are using the same
27543 repository problems arise when different changes to the same document at
27544 the same location happen.
27545 Standard CVS repositories don't operate with a file locking mechanism.
27546 This may be surprising, but conflicts only occur if people disagree on
27547 the proper content of the same part of a document.
27548 So, if co-workers are used to communicate regularly, these conflicts occur
27550 If they don't communicate they have a fundamental problem anyway.
27551 Nevertheless some people like to work with so called
27552 \begin_inset Quotes eld
27556 \begin_inset Quotes erd
27560 If they do so the working copy of all files is readonly when checked out
27561 first and the user starts editing after using a special command to make
27562 the working copy writable.
27563 When the changes are checked in the working copy returns to readonly state.
27564 With \SpecialChar LyX
27565 one has to edit the
27566 \begin_inset Flex Code
27569 \begin_layout Plain Layout
27575 file and add the line
27576 \begin_inset Flex Code
27579 \begin_layout Plain Layout
27585 to work with reserved checkouts.
27586 The benefit is the possibility to see who is using a writable copy of some
27588 It's not guaranteed only one user makes a copy writable.
27591 \begin_layout Standard
27593 tries to guess if you're using reserved or non-reserved checkouts.
27594 If your working copy is readonly or it is writable and an additional copy
27595 of your document exists in the CVS/Base sub-directory a reserved otherwise
27596 a non-reserved checkout is assumed.
27597 When a reserved checkout is detected you have to use
27598 \begin_inset Flex Noun
27601 \begin_layout Plain Layout
27607 to make your working copy writable if it's readonly.
27609 \begin_inset Flex Noun
27612 \begin_layout Plain Layout
27618 operation is possible and that makes your working copy readonly again after
27619 transferring your changes to the repository.
27622 \begin_layout Standard
27623 More information about CVS can be found here
27624 \begin_inset Flex URL
27627 \begin_layout Plain Layout
27629 http://www.nongnu.org/cvs
27635 \begin_inset Flex URL
27638 \begin_layout Plain Layout
27640 http://ximbiot.com/cvs
27648 \begin_layout Standard
27653 to understand the sub-commands and the switches mentioned below.
27656 \begin_layout Subsubsection
27662 \begin_layout Standard
27663 If your document is not under revision control, this is the only item shown
27665 And if it is under revision control, the
27669 item is not visible.
27673 \begin_layout Standard
27674 This command registers in CVS your document
27675 \begin_inset Flex Strong
27678 \begin_layout Plain Layout
27686 in the case you have already the documents directory under CVS control
27692 This means you have to create or checkout the archive by yourself using
27694 (In case you forget that step \SpecialChar LyX
27695 registers the document with RCS.)
27698 \begin_layout Standard
27699 Then you are asked interactively to supply an initial description of the
27701 Don't forget that registered file is not yet checked in.
27704 \begin_layout Standard
27705 CVS command that is run:
27707 cvs -q add -m"<entered message>" "<file-name>"
27710 \begin_layout Standard
27715 above and for all other CVS commands is an abbreviation for
27716 \begin_inset Quotes eld
27719 change the current working directory to file location and use the file name
27720 without path component as argument
27721 \begin_inset Quotes erd
27727 \begin_layout Subsubsection
27733 \begin_layout Standard
27734 When you are finished editing a file, you commit your changes.
27735 When you do this and you had changed the document, you are asked for a
27736 description of the changes.
27737 After that changes are written to the repository.
27738 In case you didn't change the document and a reserved checkout is detected
27739 the reservation made on
27740 \begin_inset Flex Noun
27743 \begin_layout Plain Layout
27752 \begin_layout Labeling
27753 \labelwidthstring 00.00.0000
27755 \begin_inset space ~
27759 \begin_inset space ~
27763 \begin_inset Newline newline
27767 \begin_inset Flex Code
27770 \begin_layout Plain Layout
27773 -q commit -m"<description>" "<file-name>"
27779 \begin_inset Newline newline
27783 \begin_inset Flex Code
27786 \begin_layout Plain Layout
27797 \begin_layout Subsubsection
27803 \begin_layout Standard
27804 When you are sharing a repository with others, you may have to incorporate
27805 their changes into your working copy.
27808 \begin_layout Standard
27811 cvs -q update "<file-name>"
27814 \begin_layout Standard
27815 If a readonly checkout is detected the working copy is made writable and
27819 \begin_layout Standard
27822 cvs -q edit "<file-name>"
27825 \begin_layout Subsubsection
27828 Revert To Repository Version
27831 \begin_layout Standard
27832 This will discard all changes made to the document since the last check
27834 You get a warning before changes are discarded.
27835 Firstly the file is deleted, secondly CVS update command is run.
27838 \begin_layout Standard
27841 cvs -q update "<file-name>"
27844 \begin_layout Standard
27845 If a reserved checkout is detected and the working copy has no changes only
27846 the reservation is undone.
27849 \begin_layout Standard
27852 cvs -q unedit "<file-name>"
27855 \begin_layout Subsubsection
27861 \begin_layout Standard
27862 This will create a copy of the current document.
27863 Since CVS does not support copy operations natively, the version history
27864 is not preserved, and the copy is added as a new file.
27865 It requires a clean document without any changes since the last checkin.
27866 You are asked for a file name and a description of the copy operation.
27867 After that the copy is created, both locally and in the repository.
27868 If the parent directories of the copied and original document differ, all
27869 relative paths of included files of the copy are adjusted (like in
27871 File\SpecialChar menuseparator
27876 Finally, the copy is loaded instead of the original document.
27879 \begin_layout Labeling
27880 \labelwidthstring 00.00.0000
27882 \begin_inset space ~
27886 \begin_inset space ~
27890 \begin_inset Newline newline
27894 \begin_inset Flex Code
27897 \begin_layout Plain Layout
27904 \begin_inset Flex Code
27907 \begin_layout Plain Layout
27914 \begin_inset Newline newline
27918 \begin_inset Flex Code
27921 \begin_layout Plain Layout
27922 cvs -q add "<new-file-name>"
27930 \begin_layout Subsubsection
27936 \begin_layout Standard
27937 This will rename the current document.
27938 Since CVS does not support rename operations natively, the version history
27939 is not preserved, the renamed document is added as a new file, and the
27940 original document is deleted.
27941 It requires a clean document without any changes since the last checkin.
27942 You are asked for a file name and a description of the rename operation.
27943 After that the document is renamed, both locally and in the repository.
27944 If the parent directories of the new and old file names differ, all relative
27945 paths of included files are adjusted (like in
27947 File\SpecialChar menuseparator
27952 Finally, the document is reloaded using the new name.
27955 \begin_layout Labeling
27956 \labelwidthstring 00.00.0000
27958 \begin_inset space ~
27962 \begin_inset space ~
27966 \begin_inset Newline newline
27970 \begin_inset Flex Code
27973 \begin_layout Plain Layout
27980 \begin_inset Flex Code
27983 \begin_layout Plain Layout
27990 \begin_inset Newline newline
27994 \begin_inset Flex Code
27997 \begin_layout Plain Layout
27998 cvs -q add "<new-file-name>"
28004 \begin_inset Newline newline
28008 \begin_inset Flex Code
28011 \begin_layout Plain Layout
28012 cvs -q remove "<file-name>"
28020 \begin_layout Subsubsection
28021 Update of the local directory checkout from repository
28024 \begin_layout Standard
28025 Once your documents gets more complex, containing sub-documents and pictures,
28027 \begin_inset Flex Code
28030 \begin_layout Plain Layout
28036 files and so on using version control becomes more complicated.
28038 supports updating the whole tree in which resides the document.
28039 This become especially useful once you cooperate with people which neither
28040 have detailed knowledge about CVS usage nor they have ambition to commit
28041 additional material to the repository.
28042 You have to organize the files structure so that all external files are
28043 in the same directory or subdirectories of the document.
28044 It's good practice anyway to store multipart documents in an extra directory.
28047 \begin_layout Standard
28049 \begin_inset Flex Code
28052 \begin_layout Plain Layout
28053 Update local directory from repository
28058 command updates the whole directory.
28059 If local changes are detected user is warned before update starts.
28060 In case of merge conflicts both versions of the conflicting document parts
28061 are placed in the final document.
28062 You have to review and correct the result of the merge.
28063 You'll find the conflicts enclosed in pairs of
28064 \begin_inset Flex Code
28067 \begin_layout Plain Layout
28074 \begin_inset Flex Code
28077 \begin_layout Plain Layout
28084 \begin_inset Flex Code
28087 \begin_layout Plain Layout
28094 The first part is your version as before the update operation with the
28095 document name prepended.
28096 The second one is the repository version with the version number after
28098 \begin_inset Flex Code
28101 \begin_layout Plain Layout
28110 \begin_layout Labeling
28111 \labelwidthstring 00.00.0000
28113 \begin_inset space ~
28117 \begin_inset space ~
28121 \begin_inset Newline newline
28125 \begin_inset Flex Code
28128 \begin_layout Plain Layout
28136 (Ask if changes are detected.)
28137 \begin_inset Newline newline
28141 \begin_inset Flex Code
28144 \begin_layout Plain Layout
28145 cd $path; cvs -q update
28155 \begin_layout Standard
28157 \begin_inset Flex Code
28160 \begin_layout Plain Layout
28166 stands for the path to the document.
28169 \begin_layout Subsubsection
28175 \begin_layout Standard
28176 This shows the complete history of the CVS document.
28179 cvs log "<file-name>"
28181 is shown in a browser.
28184 \begin_layout Subsubsection
28188 \begin_layout Standard
28190 supports CVS version number, author name, date and time of last commit.
28191 All those are extracted from
28193 cvs log -r <file-name>
28197 \begin_inset CommandInset ref
28199 reference "subsec:VCS-Revision-Information"
28206 \begin_layout Subsection
28207 SVN commands in \SpecialChar LyX
28211 \begin_layout Standard
28212 SVN is now partially supported by \SpecialChar LyX
28214 You can find the commands in the
28216 File\SpecialChar menuseparator
28218 \begin_inset space ~
28224 Please note that if you use password protected access to repository via
28225 ssh, you will be asked in terminal window.
28227 was tested against SVN 1.5, 1.6, 1.7 and 1.8
28231 \begin_layout Plain Layout
28232 Most of the commands will work with 1.4 too, see
28233 \begin_inset CommandInset ref
28235 reference "subsec:SVN-Repo-Update"
28240 There seems to be currently unresolved permissions problem under SVN 1.8
28241 with reverting changes when file is locked.
28249 \begin_layout Subsubsection
28255 \begin_layout Standard
28256 If your document is not under revision control, this is the only item shown
28258 And if it is under revision control, the
28262 item is not visible.
28265 \begin_layout Standard
28266 This command registers in SVN your document ONLY in case you have already
28267 the documents directory under SVN control (in particular
28272 This means you have to checkout the archive by yourself.
28275 \begin_layout Standard
28276 Then you are asked interactively to supply an initial description of the
28278 Don't forget that registered file is not yet commited.
28281 \begin_layout Standard
28282 SVN command that is run:
28285 \begin_inset Quotes qld
28289 \begin_inset Quotes qld
28295 \begin_layout Standard
28300 to understand the switches.
28303 \begin_layout Subsubsection
28309 \begin_layout Standard
28310 When you are finished editing a file, you commit your changes.
28311 When you do this, you are asked for a description of the changes.
28312 After that changes are commited.
28315 \begin_layout Standard
28320 \begin_layout Plain Layout
28321 In case locking is not enabled.
28323 \begin_inset CommandInset ref
28325 reference "subsec:SVN-File-Locking"
28336 svn commit -q -m"<description>" <file-name>
28339 \begin_layout Subsubsection
28345 \begin_layout Standard
28346 Updates the changes of this file from the repository.
28347 Be sure you understand SVN merging and conflicts resolving before using
28348 this function, because all conflicts has to be resolved manually by you!
28351 \begin_layout Standard
28356 \begin_layout Plain Layout
28364 svn update --non-interactive
28365 \begin_inset Quotes qld
28369 \begin_inset Quotes qld
28375 \begin_layout Subsubsection
28378 Revert To Repository Version
28381 \begin_layout Standard
28382 This will discard all changes made to the document since the last check
28384 You get a warning before changes are discarded.
28387 \begin_layout Standard
28391 \begin_inset Quotes qld
28395 \begin_inset Quotes qld
28401 \begin_layout Subsubsection
28407 \begin_layout Standard
28408 This will create a copy of the current document including the version history.
28409 It requires a clean document without any changes since the last checkin.
28410 You are asked for a file name and a description of the copy operation.
28411 After that the copy is created, both locally and in the repository.
28412 If the parent directories of the copied and original document differ, all
28413 relative paths of included files of the copy are adjusted (like in
28415 File\SpecialChar menuseparator
28420 Finally, the copy is loaded instead of the original document.
28423 \begin_layout Labeling
28424 \labelwidthstring 00.00.0000
28426 \begin_inset space ~
28430 \begin_inset space ~
28434 \begin_inset Newline newline
28438 \begin_inset Flex Code
28441 \begin_layout Plain Layout
28445 \begin_inset Quotes qld
28449 \begin_inset Quotes qld
28453 \begin_inset Quotes qld
28457 \begin_inset Quotes qld
28466 \begin_inset Newline newline
28470 \begin_inset Flex Code
28473 \begin_layout Plain Layout
28482 \begin_layout Subsubsection
28488 \begin_layout Standard
28489 This will rename the current document including the version history.
28490 It requires a clean document without any changes since the last checkin.
28491 You are asked for a file name and a description of the rename operation.
28492 After that the document is renamed, both locally and in the repository.
28493 If the parent directories of the new and old file names differ, all relative
28494 paths of included files are adjusted (like in
28496 File\SpecialChar menuseparator
28501 Finally, the document is reloaded using the new name.
28504 \begin_layout Labeling
28505 \labelwidthstring 00.00.0000
28507 \begin_inset space ~
28511 \begin_inset space ~
28515 \begin_inset Newline newline
28519 \begin_inset Flex Code
28522 \begin_layout Plain Layout
28526 \begin_inset Quotes qld
28530 \begin_inset Quotes qld
28534 \begin_inset Quotes qld
28538 \begin_inset Quotes qld
28547 \begin_inset Newline newline
28551 \begin_inset Flex Code
28554 \begin_layout Plain Layout
28563 \begin_layout Subsubsection
28564 \begin_inset CommandInset label
28566 name "subsec:SVN-Repo-Update"
28570 Update of the local directory checkout from repository
28574 \begin_layout Plain Layout
28575 Note that this command will work only with subversion
28576 \begin_inset Formula $\geqq1.5$
28587 \begin_layout Standard
28588 All the commands above have one shortcoming – they deal with the current
28590 Once your document contains pictures, includes external
28591 \begin_inset Flex Code
28594 \begin_layout Plain Layout
28600 files and so on administration becomes more complicated.
28602 now supports updating the whole tree in which resides the document
28606 \begin_layout Plain Layout
28607 One need to organize the files structure so that all external files are
28608 in the same directory or subdirectories of the document.
28615 This become especially useful once you cooperate with people which neither
28616 know about subversion management nor they have ambition to commit additional
28617 material to the repository.
28621 \begin_layout Standard
28622 \begin_inset Flex Code
28625 \begin_layout Plain Layout
28626 Update local directory from repository
28631 command updates the whole directory and in case of merge conflicts local
28632 version of the files are left, so no unintended data loss occurs.
28633 If local changes are detected user is warned before update starts.
28636 \begin_layout Labeling
28637 \labelwidthstring 00.00.0000
28639 \begin_inset space ~
28643 \begin_inset space ~
28647 \begin_inset Newline newline
28651 \begin_inset Flex Code
28654 \begin_layout Plain Layout
28660 (Ask if changes are detected.)
28661 \begin_inset Newline newline
28665 \begin_inset Flex Code
28668 \begin_layout Plain Layout
28669 svn update --accept mine-full $path
28677 \begin_layout Standard
28679 \begin_inset Flex Code
28682 \begin_layout Plain Layout
28688 stands for the path to the document.
28691 \begin_layout Subsubsection
28697 \begin_layout Standard
28698 This shows the complete history of the SVN document.
28702 \begin_inset Quotes qld
28706 \begin_inset Quotes qld
28711 is shown in a browser.
28714 \begin_layout Subsubsection
28716 \begin_inset CommandInset label
28718 name "subsec:SVN-File-Locking"
28725 \begin_layout Standard
28726 The file exchange through various revision control systems brings the problem
28727 of merge conflicts in case two different users try to edit the same (parts
28729 When such a conflict happens it needs manual resolving and one reasonable
28730 alternative is to provide some kind of locking mechanism, which guarantees
28731 that only one user is allowed to edit file at the given time.
28734 \begin_layout Standard
28735 SVN has two such mechanisms to provide mutual exclusivity for file access
28736 – locks and automatic setting of write permissions (see sec.
28738 \begin_inset CommandInset ref
28740 reference "subsec:Automatical-Locking-Property"
28745 \begin_inset Flex Code
28748 \begin_layout Plain Layout
28758 \begin_layout Plain Layout
28759 \begin_inset Flex URL
28762 \begin_layout Plain Layout
28764 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
28775 If this property is detected for a given document \SpecialChar LyX
28776 starts to use SVN locks
28777 for document editing automatically and the whole check-in/out mechanism
28778 switches to the same regimen as for RCS.
28779 This in particular means there are two different modes of file use in \SpecialChar LyX
28783 \begin_layout Itemize
28785 The loaded file is in the read-only mode.
28786 For editing on needs to check-out.
28791 consists of updating from the repository and gaining write lock.
28792 If the lock is not possible to obtain, we remain in unlocked state.
28795 \begin_layout Itemize
28797 The loaded file is in the
28798 \begin_inset Quotes els
28802 \begin_inset Quotes ers
28806 No other user is allowed to edit the file.
28811 consists of commiting changes and releasing write-lock.
28812 If no changes have been made to the document, no commit will be produced
28816 \begin_layout Plain Layout
28817 Don't be puzzled by the fact that you will be asked for commit message anyway.
28822 and only the write-lock will be released.
28825 \begin_layout Standard
28829 \begin_layout Labeling
28830 \labelwidthstring 00.00.0000
28833 svn commit -q -m"<description>" "<file-name>"
28834 \begin_inset Newline newline
28837 svn unlock "<file-name>"
28840 \begin_layout Labeling
28841 \labelwidthstring 00.00.0000
28844 svn update "<file-name>"
28845 \begin_inset Newline newline
28848 svn lock "<file-name>"
28851 \begin_layout Subsubsection
28854 \begin_inset CommandInset label
28856 name "subsec:Automatical-Locking-Property"
28862 Automatic Locking Property
28865 \begin_layout Standard
28866 The above mentioned automatic setting of write permissions of the .lyx file
28869 File\SpecialChar menuseparator
28871 \begin_inset space ~
28874 Control\SpecialChar menuseparator
28875 Use Locking Property
28878 This command is active only when the file is not locked on the svn server
28880 you need to check-out before proceeding).
28883 \begin_layout Labeling
28884 \labelwidthstring 00.00.0000
28886 \begin_inset space ~
28892 \begin_layout Labeling
28893 \labelwidthstring 00.00.0000
28896 svn propset svn:needs-lock ON "<file-name>"
28899 \begin_layout Labeling
28900 \labelwidthstring 00.00.0000
28903 svn propdel svn:needs-lock "<file-name>"
28906 \begin_layout Subsubsection
28907 \begin_inset CommandInset label
28909 name "subsec:VCS-Revision-Information"
28913 Revision Information in Documents
28916 \begin_layout Standard
28917 There are more possibilities how to activate revision information in our
28921 \begin_layout Itemize
28927 \begin_layout Itemize
28928 tree revision information (
28929 \begin_inset Flex Code
28932 \begin_layout Plain Layout
28939 The result is the output of the
28940 \begin_inset Flex Code
28943 \begin_layout Plain Layout
28949 command, the following table gives you an idea, how to read the results.
28952 \begin_layout Standard
28954 \begin_inset Tabular
28955 <lyxtabular version="3" rows="6" columns="2">
28956 <features tabularvalignment="middle">
28957 <column alignment="left" valignment="top">
28958 <column alignment="left" valignment="top">
28960 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
28963 \begin_layout Plain Layout
28971 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
28974 \begin_layout Plain Layout
28984 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
28987 \begin_layout Plain Layout
28993 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
28996 \begin_layout Plain Layout
28997 mixed revision working copy
29004 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29007 \begin_layout Plain Layout
29013 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29016 \begin_layout Plain Layout
29017 modified working copy
29024 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29027 \begin_layout Plain Layout
29033 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29036 \begin_layout Plain Layout
29037 switched working copy
29044 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
29047 \begin_layout Plain Layout
29053 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
29056 \begin_layout Plain Layout
29057 partial working copy, from a sparse checkout
29064 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
29067 \begin_layout Plain Layout
29073 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
29076 \begin_layout Plain Layout
29077 mixed revision, modified, switched working copy
29090 \begin_layout Itemize
29091 file revision information.
29092 The result comes from parsing the output of
29093 \begin_inset Flex Code
29096 \begin_layout Plain Layout
29098 \begin_inset space ~
29102 \begin_inset space ~
29106 \begin_inset space ~
29115 Supported flags are:
29119 \begin_layout Itemize
29120 version number of the last commit (
29121 \begin_inset Flex Code
29124 \begin_layout Plain Layout
29133 \begin_layout Itemize
29134 author of the last commit (
29135 \begin_inset Flex Code
29138 \begin_layout Plain Layout
29147 \begin_layout Itemize
29148 date of the last commit (
29149 \begin_inset Flex Code
29152 \begin_layout Plain Layout
29161 \begin_layout Itemize
29162 time of the last commit (
29163 \begin_inset Flex Code
29166 \begin_layout Plain Layout
29176 \begin_layout Standard
29177 You can obtain this info via InsetInfo (
29178 \change_inserted 5863208 1564400022
29181 Insert\SpecialChar menuseparator
29182 Field\SpecialChar menuseparator
29183 Version Control Revision
29184 \change_deleted 5863208 1564399852
29189 \begin_inset Flex Code
29192 \begin_layout Plain Layout
29193 info-insert buffer vcs-date
29201 The information will be available only when you have the file stored under
29202 svn managment (i.e.
29204 \begin_inset Flex Code
29207 \begin_layout Plain Layout
29213 directory is available with your document).
29217 \begin_layout Itemize
29218 Another—a hacking one—possibility is to use svn keywords
29222 \begin_layout Plain Layout
29223 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
29229 In short – you set file keywords property (e.g.
29232 svn propset svn:keywords 'Rev' file.lyx
29234 ) and then paste keyword \SpecialChar TeX
29239 \begin_layout Plain Layout
29240 This is an easy way how to ensure that \SpecialChar LyX
29241 won't break the line in the middle
29247 tag in your document (e.g.
29249 \begin_inset Flex Code
29252 \begin_layout Plain Layout
29259 This way svn client will automatically substitute revision number (e.g.
29261 \begin_inset Flex Code
29264 \begin_layout Plain Layout
29270 ) after each update and commit.
29271 There are more problems with this approach.
29272 Firstly, the '$' character is used in \SpecialChar TeX
29273 world for math equations, so any
29274 occurence of math formula
29275 \begin_inset Formula $Rev$
29279 \begin_inset Formula $Rev:59$
29282 in your \SpecialChar LyX
29284 Similarly for other keywords like Id, Date, Author, etc.
29285 Secondly svn output is dependent on your locales, so its very easy that
29286 svn would produce some problematic strings once Date is used.
29287 Thirdly you get the whole 'Rev: 59' string in your document instead of
29289 Until subversion implements user's custom keywords it will be hard to use
29290 this approach reliably or let \SpecialChar LyX
29291 to support it directly.
29294 \begin_layout Subsection
29295 SVN and Windows Environment
29298 \begin_layout Quote
29299 My inclination is to say that if the user cannot figure out the command
29300 line operations on their own fairly quickly, they would be well advised
29301 to use TortoiseSVN.
29307 \begin_layout Subsubsection
29311 \begin_layout Standard
29312 In addition to installing \SpecialChar LyX
29313 , and having access to a Subversion repository,
29314 the user will need to install the Subversion client program.
29315 A Windows installer for the client program is available from
29316 \begin_inset CommandInset href
29319 target "http://www.collab.net/nonav/downloads/subversion/"
29325 The user may also want to install
29326 \begin_inset CommandInset href
29329 target "http://tortoisesvn.tigris.org/"
29334 , which integrates Subversion operations into the context (rightclick) menu
29335 of Windows Explorer.
29336 Operations done outside \SpecialChar LyX
29337 will typically be more convenient using the Explorer
29339 Note that TortoiseSVN is not a replacement for the client program, which
29340 is what \SpecialChar LyX
29344 \begin_layout Subsubsection
29345 Bringing a document under Subversion control
29348 \begin_layout Standard
29349 Before a \SpecialChar LyX
29350 document can be brought under version control in Subversion, its
29351 parent directory needs to be under version control.
29352 If the document is being added to a project already in the repository,
29353 this is accomplished by checking the project out to the directory where
29354 the new document will be placed.
29355 If the project itself is not yet under version control (for instance, if
29356 this document starts a new project), the directory must be imported into
29358 This is done outside \SpecialChar LyX
29360 Both import and checkout are easily accomplished from the Explorer context
29361 menu using TortoiseSVN, or alternatively can be done using the command
29362 line client at a DOS prompt.
29363 The procedure for importing the project using TortoiseSVN is described
29364 below, assuming an existing repository and a new project being started
29372 For information on using the Subversion client program, run
29379 \begin_layout Enumerate
29386 in Windows Explorer, right click it, and select
29388 TortoiseSVN\SpecialChar menuseparator
29392 If necessary, adjust the URL for the repository, then click OK.
29395 \begin_layout Enumerate
29396 Right click the level of the repository under which you want to place the
29397 new project folder (typically the top level) and click
29401 Supply a name for the project folder and click OK.
29402 Add a message for the log file if desired, then click OK again.
29403 The new project folder should appear in the repository.
29404 Finally, click OK again to exit the repository browser.
29407 \begin_layout Enumerate
29408 Once again right click
29414 , this time selecting SVN Checkout\SpecialChar ldots
29415 Select the URL of the project folder
29416 you just created in the repository, and set the checkout directory to
29424 You will be warned about a non-empty folder; click OK to proceed.
29425 You should now have a
29436 \begin_layout Enumerate
29437 Create or open your document in \SpecialChar LyX
29440 File\SpecialChar menuseparator
29442 \begin_inset space ~
29445 Control\SpecialChar menuseparator
29449 Add a log message and click OK to commit the document to version control.
29452 \begin_layout Standard
29453 From this point onward, you should have full functionality in the
29455 File\SpecialChar menuseparator
29457 \begin_inset space ~
29463 You also have the option of checking the document in and out, viewing its
29465 using the TortoiseSVN context menu in Windows Explorer or the Subversion
29466 client program from a command prompt.
29469 \begin_layout Subsubsection
29470 SSH tunnel used with SVN under Windows
29473 \begin_layout Standard
29474 Compared with Linux setting up an svn client to communicate over ssh under
29475 Windows is a rather troublesome task.
29476 We will at least offer some hints how to setup the client side but prior
29477 knowledge about ssh and the Windows command line is needed, also be prepared
29478 for a great deal of frustration\SpecialChar ldots
29482 \begin_layout Enumerate
29483 Get an svn client for windows, as described in the previous sections.
29484 When it is a fresh install run some svn command (e.g.
29486 \begin_inset Flex Code
29489 \begin_layout Plain Layout
29495 ) to create config files, which you will need to change later on.
29498 \begin_layout Enumerate
29499 Choose an ssh client for Windows.
29500 There are several possibilities, we will use the one from Putty tools
29504 \begin_layout Plain Layout
29505 \begin_inset Flex URL
29508 \begin_layout Plain Layout
29510 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
29521 You will need to set the connection up so that the client doesn't ask for
29522 any password from you.
29523 To keep things easy we will use only keys without any additional password
29528 \begin_layout Enumerate
29530 \begin_inset Flex Code
29533 \begin_layout Plain Layout
29540 Save your private .ppk key file and put the public one on the server side.
29541 If the SVN server runs on Linux, note that the format of the public key
29542 is not compatible with Linux openssh and you will need to direcly copy-paste
29544 \begin_inset Quotes eld
29549 Public key for pasting into OpenSSH authorized_keys file
29552 \begin_inset Quotes erd
29555 edit field into the server's
29556 \begin_inset Flex Code
29559 \begin_layout Plain Layout
29560 ~/.ssh/authorized_keys
29566 \begin_inset Flex Code
29569 \begin_layout Plain Layout
29578 \begin_layout Enumerate
29580 \begin_inset Flex Code
29583 \begin_layout Plain Layout
29590 In the SVN config file
29594 \begin_layout Plain Layout
29595 Exact path depends on Windows version, usually somewhere around
29596 \begin_inset Flex Code
29599 \begin_layout Plain Layout
29602 Documents and Settings
29616 \begin_inset Flex Code
29619 \begin_layout Plain Layout
29634 , section [tunnels], setup ssh command, e.g.
29636 \begin_inset Flex Code
29639 \begin_layout Plain Layout
29640 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
29649 \begin_layout Plain Layout
29650 It will usually take a lot of time to get exact command right and it depends
29652 For example do not have some remote server saved as a default session in
29654 If things fail, try to connect via plink without SVN first.
29663 \begin_layout Enumerate
29664 Checkout the SVN archive, e.
29665 \begin_inset space \thinspace{}
29669 \begin_inset Newline newline
29673 \begin_inset Flex Code
29676 \begin_layout Plain Layout
29677 svn co svn+ssh://user@server/repository_path
29685 \begin_layout Subsubsection
29686 End-of-Line Conversions
29689 \begin_layout Standard
29690 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
29692 use different line endings inside the .lyx files.
29693 This is not a problem as far as \SpecialChar LyX
29694 functionality is concerned, but the commit
29695 diffs will be huge and merge-conflicts prone.
29696 Fortunately SVN itself knows
29700 \begin_layout Plain Layout
29701 \begin_inset Flex URL
29704 \begin_layout Plain Layout
29706 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
29716 how to deal with CR/LF problems when switching .lyx files to the
29717 \begin_inset Flex Code
29720 \begin_layout Plain Layout
29730 \begin_layout Plain Layout
29732 \begin_inset Flex Code
29735 \begin_layout Plain Layout
29736 svn propset svn:eol-style native FILE_NAME
29749 \begin_layout Subsection
29750 GIT commands in \SpecialChar LyX
29754 \begin_layout Standard
29755 A minimal subset of GIT commands is now supported by \SpecialChar LyX
29757 You can find the commands in the
29759 File\SpecialChar menuseparator
29761 \begin_inset space ~
29767 Please note that if you use password protected access to repository via
29768 ssh, you will be asked in terminal window.
29770 was tested against GIT 1.7.
29774 \begin_layout Plain Layout
29775 Windows users please note that you need to ensure that git is on the path.
29776 This can be set from within \SpecialChar LyX
29779 Tools\SpecialChar menuseparator
29780 Preferences\SpecialChar menuseparator
29781 Paths\SpecialChar menuseparator
29792 \begin_layout Standard
29793 One big difference of GIT and the other supported version control systems
29794 is the distributed nature of GIT: With traditional version control systems
29795 there is one central server which hosts the repository.
29796 Users commit their changes to the server, and get updates made by other
29798 With GIT, users commit to a local repository.
29799 The local repository can be synchronized with one or more remote repositories
29801 \begin_inset Flex Code
29804 \begin_layout Plain Layout
29811 \begin_inset Flex Code
29814 \begin_layout Plain Layout
29822 does not interact in any way with remote GIT repositories.
29823 It works exclusively with the local repository in a very similar way as
29824 with a central CVS or SVN repository.
29825 If you use remote GIT repositories you need to do the
29826 \begin_inset Flex Code
29829 \begin_layout Plain Layout
29836 \begin_inset Flex Code
29839 \begin_layout Plain Layout
29845 operations with your favourite GIT client.
29848 \begin_layout Subsubsection
29854 \begin_layout Standard
29855 If your document is not under revision control, this is the only item shown
29857 And if it is under revision control, the
29861 item is not visible.
29864 \begin_layout Standard
29865 This command registers in GIT your document ONLY in case you have already
29866 the documents directory under GIT control (in particular
29871 This means you have to checkout the archive by yourself.
29874 \begin_layout Standard
29875 Then you are asked interactively to supply an initial description of the
29877 Don't forget that registered file is not yet committed.
29880 \begin_layout Standard
29881 GIT command that is run:
29884 \begin_inset Quotes qld
29888 \begin_inset Quotes qld
29894 \begin_layout Standard
29899 to understand the switches.
29902 \begin_layout Subsubsection
29908 \begin_layout Standard
29909 When you are finished editing a file, you commit your changes.
29910 When you do this, you are asked for a description of the changes.
29911 After that changes are committed.
29914 \begin_layout Standard
29917 git commit -q -m"<description>" <file-name>
29920 \begin_layout Subsubsection
29923 Revert To Repository Version
29926 \begin_layout Standard
29927 This will discard all changes made to the document since the last check
29929 You get a warning before changes are discarded.
29932 \begin_layout Standard
29936 \begin_inset Quotes qld
29940 \begin_inset Quotes qld
29946 \begin_layout Subsubsection
29952 \begin_layout Standard
29953 This will rename the current document including the version history.
29954 It requires a clean document without any changes since the last checkin.
29955 You are asked for a file name and a description of the rename operation.
29956 After that the document is renamed, both locally and in the repository.
29957 If the parent directories of the new and old file names differ, all relative
29958 paths of included files are adjusted (like in
29960 File\SpecialChar menuseparator
29965 Finally, the document is reloaded using the new name.
29968 \begin_layout Labeling
29969 \labelwidthstring 00.00.0000
29971 \begin_inset space ~
29975 \begin_inset space ~
29979 \begin_inset Newline newline
29983 \begin_inset Flex Code
29986 \begin_layout Plain Layout
29990 \begin_inset Quotes qld
29994 \begin_inset Quotes qld
29998 \begin_inset Quotes qld
30002 \begin_inset Quotes qld
30011 \begin_inset Newline newline
30015 \begin_inset Flex Code
30018 \begin_layout Plain Layout
30027 \begin_layout Subsubsection
30033 \begin_layout Standard
30034 This shows the complete history of the GIT document.
30038 \begin_inset Quotes qld
30042 \begin_inset Quotes qld
30047 is shown in a browser.
30050 \begin_layout Subsubsection
30054 \begin_layout Standard
30056 supports GIT hash number of the last commit to the file,
30057 \change_inserted 1119979965 1564297456
30058 its abbreviated form,
30060 author name, date and time of last commit.
30061 All those are extracted from
30063 git log -n 1 --pretty=format:%H%n
30064 \change_inserted 1119979965 1564297427
30070 Tree version information is obtained via
30072 git describe --abbrev --dirty --long
30076 \begin_inset CommandInset ref
30078 reference "subsec:VCS-Revision-Information"
30085 \begin_layout Subsection
30089 \begin_layout Standard
30090 With the recent addition of the
30091 \begin_inset Flex Code
30094 \begin_layout Plain Layout
30100 function \SpecialChar LyX
30101 power users are allowed to create their own commands for revision
30105 \begin_layout Standard
30106 As an example you can see how two TortoiseSVN commands could be integrated
30110 \begin_layout Description
30112 \begin_inset Flex Code
30115 \begin_layout Plain Layout
30116 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
30124 \begin_layout Description
30126 \begin_inset Flex Code
30129 \begin_layout Plain Layout
30130 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
30138 \begin_layout Subsection
30139 Version control and Document comparison
30142 \begin_layout Standard
30143 One of the typical uses of version control is to inspect the changes between
30144 revisions, usually by creating
30145 \begin_inset Flex Code
30148 \begin_layout Plain Layout
30155 While this is useful for plain text files, it is much less useful in the
30156 case of \SpecialChar LyX
30157 files, which have more a complicated structure.
30158 Hence we provide binding to the Document comparison feature.
30159 There are two ways of calling this feature – either by direct call of
30160 \begin_inset Flex Code
30163 \begin_layout Plain Layout
30170 function (for details see \SpecialChar LyX
30171 functions manual) or by the toolbar icon
30184 One can either compare two chosen revisions of the document or he can simply
30185 compare the current version of edited text with older revisions (where
30187 \begin_inset Flex Noun
30190 \begin_layout Plain Layout
30196 ' revisions back means comparison of the edited file with last commited
30201 \begin_layout Standard
30202 This feature is supported for SVN and RCS though due to the more complicated
30203 versioning scheme of RCS there is a constraint – when addressing the revisions
30204 in dialog, numbers always point to the last number in RCS revision number,
30207 We don't currently support GIT addressing of revisions, one can just compare
30208 edited document with its revision X steps backs, where X is addressed as
30210 \begin_inset Flex Code
30213 \begin_layout Plain Layout
30222 \begin_layout Section
30223 Literate Programming
30226 \begin_layout Standard
30231 (kayvan@sylvan.com)
30235 original documentation written by
30237 Edmar Wienskoski Jr.
30240 (edmar-w-jr@technologist.com)
30243 \begin_layout Subsection
30247 \begin_layout Standard
30248 The main purpose of this documentation is to show you how to use \SpecialChar LyX
30250 programming, where it is assumed that you are familiar with this programming
30251 technique, and know what
30252 \begin_inset Quotes eld
30256 \begin_inset Quotes erd
30260 \begin_inset Quotes eld
30264 \begin_inset Quotes erd
30268 If that is not the case, please follow the web links provided in the following
30270 There is a lot of good documentation out there covering old development
30271 history to the latest tools tips.
30274 \begin_layout Standard
30275 It is also assumed that you are familiar with \SpecialChar LyX
30276 itself to a point that you
30277 are comfortable changing your \SpecialChar LyX
30278 preferences, and X resources file.
30279 If that is not the case please refer to other \SpecialChar LyX
30280 documentation to cover your
30284 \begin_layout Subsection
30285 Literate Programming
30288 \begin_layout Standard
30289 From the Literate Programming FAQ:
30292 \begin_layout Quotation
30293 Literate programming is the combination of documentation and source together
30294 in a fashion suited for reading by human beings.
30295 In fact, literate programs should be enjoyable reading, even inviting!
30296 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
30297 and documentation in a single file.
30298 Literate programming tools then parse the file to produce either readable
30299 documentation or compilable source.
30300 The WEB style of literate programming was created by D.
30301 \begin_inset space \thinspace{}
30305 Knuth during the development of his \SpecialChar TeX
30306 typesetting software.
30310 \begin_layout Standard
30311 Another excerpt says:
30314 \begin_layout Quotation
30317 How is literate programming different from verbose commenting?
30320 \begin_layout Quotation
30321 There are three distinguishing characteristics.
30322 In order of importance, they are:
30326 \begin_layout Itemize
30327 flexible order of elaboration
30330 \begin_layout Itemize
30331 automatic support for browsing
30334 \begin_layout Itemize
30335 typeset documentation, especially diagrams and mathematics
30339 \begin_layout Standard
30340 Now that I sparked your curiosity, take a look in the references.
30343 \begin_layout Subsubsection
30347 \begin_layout Standard
30348 The complete Literate Programming FAQ can be found at:
30351 \begin_layout Quote
30352 Literate Programming FAQ
30353 \begin_inset Flex URL
30356 \begin_layout Plain Layout
30358 http://www.literateprogramming.com/lpfaq.pdf
30366 \begin_layout Standard
30367 The FAQ lists 23 (twenty three!) different literate programming tools.
30368 Where some are specialized or
30369 \begin_inset Quotes eld
30373 \begin_inset Quotes erd
30376 for particular programming languages, while other have general scope.
30381 for my own use for several reasons:
30384 \begin_layout Itemize
30385 It can generate the documentation either in \SpecialChar LaTeX
30389 \begin_layout Itemize
30390 It has a open architecture, i.
30391 \begin_inset space \thinspace{}
30395 \begin_inset space \space{}
30398 it is easy to plug in new filters
30402 \begin_layout Plain Layout
30407 are programs that read a given data stream and output a manipulated data
30409 That way, a WEB file (consisting of literate code) can be turned into a
30410 file consisting only of C program code or \SpecialChar LaTeX
30416 and to perform special processing that you may need.
30420 \begin_layout Itemize
30421 There is a good selection of filters available already (the HTML is one
30425 \begin_layout Itemize
30429 \begin_layout Standard
30430 The Noweb web page can be found at:
30433 \begin_layout Quote
30435 \begin_inset Flex URL
30438 \begin_layout Plain Layout
30440 https://www.cs.tufts.edu/~nr/noweb/
30448 \begin_layout Standard
30449 Starting from there you can reach many other interesting links and even
30450 some literate program examples.
30453 \begin_layout Subsection
30455 and Literate Programming with Noweb
30458 \begin_layout Standard
30459 The \SpecialChar LyX
30460 support for Literate Programming is provided by using the generic \SpecialChar LyX
30462 converters mechanism.
30463 This support is provided in a
30464 \begin_inset Quotes eld
30468 \begin_inset Quotes erd
30472 \begin_inset space \thinspace{}
30476 \begin_inset space \space{}
30479 you will be able to use this new \SpecialChar LyX
30480 feature with some other literate programming
30481 tool of your choice by just changing your \SpecialChar LyX
30485 \begin_layout Subsubsection
30486 Generating documents and code (weaving and tangling)
30489 \begin_layout Paragraph
30490 Using the noweb module
30493 \begin_layout Standard
30494 If you have installed Noweb and \SpecialChar LyX
30495 successfully, whenever you open a new document,
30496 after you have chosen its document class, use the
30498 Document\SpecialChar menuseparator
30502 \begin_inset Quotes eld
30506 \begin_inset Quotes erd
30510 If Noweb is correctly installed, when you click on the
30511 \begin_inset Quotes eld
30515 \begin_inset Quotes erd
30518 link, you will see the
30519 \begin_inset Quotes eld
30523 \begin_inset Quotes erd
30526 module in the available list and you can add it to your document.
30529 \begin_layout Paragraph
30533 \begin_layout Standard
30535 enables you to write code with a custom inset named
30536 \begin_inset Flex Noun
30539 \begin_layout Plain Layout
30546 Noweb delimits chunks like this:
30549 \begin_layout LyX-Code
30553 \begin_layout LyX-Code
30557 \begin_layout LyX-Code
30561 \begin_layout LyX-Code
30565 \begin_layout LyX-Code
30569 \begin_layout Standard
30570 The problem is that whatever is written in between the << and the
30574 must be taken literally, i.
30575 \begin_inset space \thinspace{}
30579 \begin_inset space \space{}
30583 should be prevented from making any special interpretation of what has
30585 This is also handled by
30586 \begin_inset Flex Noun
30589 \begin_layout Plain Layout
30595 , that works like a normal text inset but has a free spacing capability.
30598 \begin_layout Standard
30599 As a special note, you can also use the
30600 \begin_inset Quotes eld
30604 \begin_inset Quotes erd
30607 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
30611 \begin_layout LyX-Code
30615 \begin_layout LyX-Code
30616 def some_function(args):
30619 \begin_layout LyX-Code
30620 "This is the doc string for this function."
30623 \begin_layout LyX-Code
30624 print "My args: ", args
30627 \begin_layout LyX-Code
30628 @ %def some_function
30631 \begin_layout Standard
30632 For an example of this usage and the resulting cross-reference output, look
30633 at the Literate python program in
30635 LIBDIR/examples/listerrors.lyx
30637 which should make this all clear.
30640 \begin_layout Paragraph
30641 Generating the documentation
30644 \begin_layout Standard
30645 At this point you already have a new document file with a proper document
30646 class, and with some code and text on it.
30647 How do I print it? The answer is simple, you select
30649 View\SpecialChar menuseparator
30653 Just like you would do for a plain document.
30654 No special procedure is required.
30657 \begin_layout Standard
30658 To help orientate you, I will now explain what happens inside \SpecialChar LyX
30662 \begin_layout Enumerate
30665 Update\SpecialChar menuseparator
30668 menu option is chosen, a \SpecialChar LaTeX
30674 \begin_layout Standard
30675 If the document is of any literate class the generated file will be named
30676 with an extension name defined by the
30677 \begin_inset Quotes eld
30681 \begin_inset Quotes erd
30684 format (defined in the Preferences panel), otherwise the file will have
30693 \begin_layout Enumerate
30694 Note that the only difference so far is in the name of the file, no special
30695 processing is required by \SpecialChar LyX
30697 Given that you formatted the code using the
30698 \begin_inset Flex Noun
30701 \begin_layout Plain Layout
30707 inset that, by itself, takes care of the business.
30710 \begin_layout Enumerate
30711 If the document is of any literate class \SpecialChar LyX
30712 will then use the internal \SpecialChar LyX
30714 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
30719 \begin_layout Plain Layout
30720 The converters are defined in the
30722 Tools\SpecialChar menuseparator
30726 \begin_inset Quotes eld
30730 \begin_inset Quotes erd
30742 manual for general information about converters.
30747 to generate the \SpecialChar LaTeX
30752 \begin_layout Standard
30753 Otherwise it will just skip this step.
30757 \begin_layout Enumerate
30758 Finally, \SpecialChar LaTeX
30759 is invoked and the regular post processing continues as in a plain
30763 \begin_layout Standard
30764 Independence from a particular
30765 \begin_inset Quotes eld
30769 \begin_inset Quotes erd
30772 is easily achieved by changing the commands that are run by the various
30776 \begin_layout Paragraph
30777 Generating the code
30780 \begin_layout Standard
30781 When the build menu option is chosen or the corresponding button in the
30782 toolbar is pressed, a \SpecialChar LaTeX
30783 file is generated just like step 1 above.
30784 Next, \SpecialChar LyX
30790 This converter needs to be defined by the user and is not installed by
30791 default, though the Program format is.
30792 This converter (like any other converter) will have two parts:
30795 \begin_layout Enumerate
30796 The converter program itself.
30797 This program performs the conversion from the one format to the other (in
30798 this case, from the Noweb format to the Program pseudo-format).
30801 \begin_layout Enumerate
30802 The error log parser.
30803 This is a program whose sole purpose is to rewrite error messages in a
30804 format that \SpecialChar LyX
30806 This makes it possible for \SpecialChar LyX
30807 to place error boxes in the right places in
30811 \begin_layout Standard
30812 The first part, the
30813 \begin_inset Quotes eld
30817 \begin_inset Quotes erd
30820 setting, should be set to
30823 \begin_layout LyX-Code
30831 \begin_layout Standard
30832 This basically means that \SpecialChar LyX
30834 \begin_inset Quotes eld
30838 \begin_inset Quotes erd
30841 (a program or script) with the name of the Noweb file (normally a file
30842 in the \SpecialChar LyX
30843 temp directory) and the directory path of the original \SpecialChar LyX
30848 \begin_layout Standard
30849 This is an implementation of
30850 \begin_inset Quotes eld
30854 \begin_inset Quotes erd
30857 that you can place in a directory on your path:
30860 \begin_layout LyX-Code
30866 \begin_layout LyX-Code
30872 \begin_layout LyX-Code
30875 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
30878 \begin_layout Standard
30879 The next part of the converter setting is the
30880 \begin_inset Quotes eld
30884 \begin_inset Quotes erd
30887 which is to be set to
30890 \begin_layout LyX-Code
30893 parselog=$$s/scripts/listerrors
30896 \begin_layout Standard
30897 This will run any errors that are generated by the
30898 \begin_inset Quotes eld
30902 \begin_inset Quotes erd
30905 process through the
30906 \begin_inset Quotes eld
30910 \begin_inset Quotes erd
30916 \begin_layout Standard
30917 The build will normally take place in \SpecialChar LyX
30918 's temporary directory, so the files
30919 produced by the conversion will be in that directory.
30921 will copy out what it regards as the `main' file, but the
30925 conversion may produce several files, and so most of these would then be
30926 deleted when \SpecialChar LyX
30928 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
30929 the build-script chunk can place the generated files in that location.
30932 \begin_layout Paragraph
30933 Build instructions in the document
30936 \begin_layout Standard
30937 The last piece of the integration between \SpecialChar LyX
30939 \begin_inset Quotes eld
30943 \begin_inset Quotes erd
30947 Generally, the instructions for building your program should be embedded
30948 in a chunk of its own.
30950 \begin_inset Quotes eld
30954 \begin_inset Quotes erd
30957 above uses the notangle command to look for this chunk (called
30958 \begin_inset Quotes eld
30962 \begin_inset Quotes erd
30965 ) and runs its contents through
30966 \begin_inset Quotes eld
30970 \begin_inset Quotes erd
30976 \begin_layout Standard
30977 Typically, such a chunk would look something like this:
30980 \begin_layout LyX-Code
30984 \begin_layout LyX-Code
30986 \begin_inset Newline newline
30989 if [ -z "${NOWEB_SOURCE}" ]
30990 \begin_inset Newline newline
30996 \begin_layout LyX-Code
30997 NOWEB_SOURCE=myfile.nw
30998 \begin_inset Newline newline
31002 \begin_inset Newline newline
31006 code to extract files ...
31007 use NOWEB_OUTPUT_DIR here ...]
31008 \begin_inset Newline newline
31012 code to compile files ...]
31013 \begin_inset Newline newline
31019 \begin_layout Standard
31022 LIBDIR/examples/listerrors.lyx
31026 LIBDIR/examples/Literate.lyx
31028 which implement two versions of the
31029 \begin_inset Quotes eld
31033 \begin_inset Quotes erd
31036 program for some illustrations of how all of these pieces go together or
31039 LIBDIR/examples/noweb2lyx.lyx.
31042 Interestingly, these three files show off the language-indepence of the
31044 literate programming support since they are written in Python, C and Perl
31048 \begin_layout Subsubsection
31049 Configuring \SpecialChar LyX
31053 \begin_layout Standard
31054 All the Literate Programming support is configured by the
31056 Tools\SpecialChar menuseparator
31060 \begin_inset Quotes eld
31064 \begin_inset Quotes erd
31068 The important parts are:
31071 \begin_layout Description
31073 \begin_inset space ~
31077 \begin_inset Quotes eld
31081 \begin_inset Quotes erd
31085 \begin_inset space ~
31088 format Set up via the File Formats tab, this is where the Noweb-specific
31098 , the file extension is set to
31103 This tells \SpecialChar LyX
31104 to create a file with a
31108 extension in the first step of the conversion process.
31111 \begin_layout Description
31113 \begin_inset space ~
31121 \begin_inset space ~
31124 format This is an empty format whose sole purpose is to be the endpoint
31125 of a conversion (which then allows us to set up a converter for it).
31128 \begin_layout Description
31138 This converter performs the
31139 \begin_inset Quotes eld
31143 \begin_inset Quotes erd
31146 of the literate document.
31147 For Noweb, it is set to
31148 \begin_inset Quotes eld
31153 noweave -delay -index $$i > $$o
31156 \begin_inset Quotes erd
31162 \begin_layout Description
31172 \begin_inset Quotes eld
31176 \begin_inset Quotes erd
31180 As stated above, the Converter is set to
31181 \begin_inset Quotes eld
31189 \begin_inset Quotes erd
31192 , with Flags set to
31193 \begin_inset Newline newline
31197 \begin_inset Quotes eld
31202 parselog=$$s/scripts/listerrors
31205 \begin_inset Quotes erd
31211 \begin_layout Subsubsection
31215 \begin_layout Standard
31216 There is also a new function implemented in the \SpecialChar LyX
31218 \begin_inset Quotes eld
31221 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
31225 \begin_layout Standard
31226 When debugging code with ddd/gdb, it is possible to invoke a text editor
31227 at the current execution position with a single key stroke.
31228 The default ddd configuration for that is shift-ctrl-V.
31229 It happens that you can define the editor command line invocation in ddd
31232 Edit\SpecialChar menuseparator
31233 Preferences\SpecialChar menuseparator
31236 dialog and changing the "Edit Sources" entry.
31239 \begin_layout Standard
31240 I take advantage of the newly created \SpecialChar LyX
31241 server function and this ddd feature,
31243 \begin_inset Quotes eld
31247 \begin_inset Quotes erd
31253 \begin_layout LyX-Code
31254 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
31257 \begin_layout Standard
31258 With this, whenever you are using ddd and find a point in the program that
31259 you want to edit, you just press shift-ctrl-V (in the ddd window), and
31260 ddd will forward this information to \SpecialChar LyX
31261 through the \SpecialChar LyX
31262 server and then the
31264 window will show the same file with the cursor at the same position ddd
31266 No more guessing or long scrolling to locate a point in the program back
31270 \begin_layout Standard
31271 Note however that you must enable the \SpecialChar LyX
31272 server to get this feature working
31273 (it is disabled by default).
31275 \begin_inset space ~
31279 \begin_inset CommandInset ref
31281 reference "sec:Starting-the-Server"
31285 explains how to do that.
31288 \begin_layout Subsubsection
31292 \begin_layout Standard
31293 There are six new buttons that can be added to your \SpecialChar LyX
31295 Four of these buttons are short cuts to layout styles:
31313 , one for the custom inset
31318 The last one is a short cut to the
31319 \begin_inset Quotes eld
31323 \begin_inset Quotes erd
31330 \begin_layout Standard
31332 has a range of buttons that are available for tool bar customization.
31333 In my toolbar I like to combine the six short cuts above with two more:
31338 \SpecialChar menuseparator
31343 \SpecialChar menuseparator
31350 Document\SpecialChar menuseparator
31351 View\SpecialChar menuseparator
31355 Here is how it looks like:
31358 \begin_layout LyX-Code
31362 \begin_layout LyX-Code
31366 \begin_layout LyX-Code
31367 Icon "layout Standard"
31370 \begin_layout LyX-Code
31371 Icon "layout Section"
31374 \begin_layout LyX-Code
31375 Icon "layout \SpecialChar LaTeX
31379 \begin_layout LyX-Code
31380 Icon "layout \SpecialChar LyX
31384 \begin_layout LyX-Code
31385 Icon "flex.insert Chunk"
31388 \begin_layout LyX-Code
31392 \begin_layout LyX-Code
31396 \begin_layout LyX-Code
31397 Icon "buffer-typeset"
31400 \begin_layout LyX-Code
31401 Icon "build-program"
31404 \begin_layout LyX-Code
31408 \begin_layout LyX-Code
31412 \begin_layout LyX-Code
31416 \begin_layout LyX-Code
31420 \begin_layout LyX-Code
31424 \begin_layout Subsubsection
31425 Colors customization
31428 \begin_layout Standard
31429 There are a number of colors in \SpecialChar LyX
31430 that can be customized in
31435 One of the things that bothers people is the \SpecialChar LaTeX
31437 The default color is red, since the chunks uses \SpecialChar LaTeX
31438 font, and there is a lot
31439 of chunks in literate documents, you may get tired of seeing everything
31441 You can change it by going to the tabs
31450 \begin_layout Standard
31451 The next thing is the visible presence of the newline character in the screen.
31452 You can choose the color of this particular character and make it blend
31454 I recommend you choosing a color that is close to the background but not
31455 equal, that way you still can see it is there, but it is not bothering
31459 \begin_layout Subsection
31464 \begin_layout Standard
31474 \change_deleted 564990737 1671643409
31480 \change_inserted 564990737 1671643443
31484 File\SpecialChar menuseparator
31485 Open Example\SpecialChar menuseparator
31486 Modules\SpecialChar menuseparator
31493 \change_deleted 564990737 1671643461
31494 the Sweave manual (menu
31496 Help\SpecialChar menuseparator
31500 \change_inserted 564990737 1671643461
31504 Help\SpecialChar menuseparator
31505 Specific Manuals\SpecialChar menuseparator
31514 \begin_layout Chapter
31516 \change_deleted 564990737 1671355343
31520 \begin_layout Standard
31522 \change_deleted 564990737 1671355343
31523 You can do everything with \SpecialChar LyX
31524 that you can do with \SpecialChar LaTeX
31526 However, \SpecialChar LyX
31527 cannot support every \SpecialChar LaTeX
31529 But you can always use \SpecialChar TeX
31531 This chapter shows you some more special things you might want to use.
31532 For other special things you can do with figures, tables, floats, boxes
31533 and notes, have a look at the
31536 \begin_inset space ~