1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children no
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
54 \font_typewriter_osf false
55 \font_sf_scale 100 100
56 \font_tt_scale 100 100
58 \use_dash_ligatures true
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX's Additional Features manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX's additional features documentation"
70 \pdf_keywords "LyX, Documentation, Additional"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen false
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 1
84 \use_package amssymb 1
87 \use_package mathdots 1
88 \use_package mathtools 1
90 \use_package stackrel 1
91 \use_package stmaryrd 1
92 \use_package undertilde 1
94 \cite_engine_type default
98 \paperorientation portrait
104 \notefontcolor #0000ff
111 \paragraph_separation indent
112 \paragraph_indentation default
114 \math_indentation default
115 \math_numbering_side default
116 \quotes_style english
120 \paperpagestyle headings
122 \tracking_changes true
123 \output_changes false
125 \postpone_fragile_content false
129 \docbook_table_output 0
130 \docbook_mathml_prefix 1
131 \author -712698321 "Jürgen Spitzmüller"
134 \author 244031559 "Yuriy"
135 \author 564990737 "John Lyx"
136 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
137 \author 1075283030 "Thibaut"
138 \author 1119979965 "Joel A. Kulesza"
144 Additional \SpecialChar LyX
148 \begin_layout Subtitle
150 \change_deleted 630872221 1622909155
152 \change_inserted 630872221 1622909155
159 by the \SpecialChar LyX
164 \begin_layout Plain Layout
166 Principal maintainer of this file is
168 Richard Kimberly Heck
171 If you have comments or error corrections, please send them to the \SpecialChar LyX
174 \begin_inset Flex Code
177 \begin_layout Plain Layout
178 <lyx-docs@lists.lyx.org>
191 \begin_layout Standard
192 \begin_inset CommandInset toc
193 LatexCommand tableofcontents
200 \begin_layout Chapter
204 \begin_layout Standard
205 This manual is essentially Part II of the
207 User's Guide\SpecialChar endofsentence
210 The reason for separating the two documents is simple: the
214 is already quite lengthy, and it contains information on all of the basic
215 features one needs to know in order to prepare most documents.
216 However, the \SpecialChar LyX
217 Team has worked to make \SpecialChar LyX
218 extensible through various configuration
219 files and external packages.
220 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
222 create a layout file (or module) for it without having to alter \SpecialChar LyX
224 We've already had contributions of several new features this way, and some
225 of them are documented here.
226 There are also some more `advanced' features, such as how to control the
227 presentation of bibliographies and how to work with multi-part documents,
228 that are not covered in the
232 and are discussed here.
235 \begin_layout Standard
236 This manual also documents some special features, like fax support
237 \change_deleted 244031559 1603802929
239 \change_inserted 244031559 1603802931
243 \change_deleted 244031559 1603802954
246 , which require additional software to work properly.
247 There is also a chapter on \SpecialChar LyX
249 And lastly, there's a chapter of \SpecialChar LaTeX
250 tools and tips, things you can use to
251 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
253 After all, \SpecialChar LyX
258 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
262 \begin_layout Standard
263 If you haven't read the
267 yet, you are definitely in the wrong manual.
272 is the first place to go, since it describes the notation and format of
274 You should also be thoroughly familiar with the
278 and all of the basic features of \SpecialChar LyX
279 before attempting to read this one.
282 \begin_layout Standard
283 Since many of the topics in this manual depend heavily on \SpecialChar LyX
285 with \SpecialChar LaTeX
286 , this first chapter covers the inner workings of \SpecialChar LyX
289 to generate exactly the \SpecialChar LaTeX
291 It is obviously for more seasoned \SpecialChar LyX
295 \begin_layout Chapter
297 and \SpecialChar LaTeX
301 \begin_layout Section
303 Uses \SpecialChar LaTeX
307 \begin_layout Standard
308 This chapter is for both \SpecialChar TeX
309 -nicians and the \SpecialChar LaTeX
311 In it, we'll explain how \SpecialChar LyX
312 and \SpecialChar LaTeX
313 work together to produce printable output.
314 This is the only place in any of the manuals where we assume you know something
315 about \SpecialChar LaTeX
319 \begin_layout Standard
320 At one time, \SpecialChar LyX
322 \begin_inset Quotes eld
325 WYSIWYM frontend to \SpecialChar LaTeX
327 \begin_inset Quotes erd
330 but that's no longer true.
331 There are frontends to \SpecialChar LaTeX
336 \begin_layout Plain Layout
337 Some familar ones are \SpecialChar TeX
338 maker and kile, on Linux, and \SpecialChar TeX
340 There are also the \SpecialChar LaTeX
341 modes for vi and emacs, of course.
346 These are basically text editors with the ability to run \SpecialChar LaTeX
348 errors in the file you're editing.
349 Although \SpecialChar LyX
358 run \SpecialChar LaTeX
359 , and it also indicates errors in the file, it also does much, much
361 For one thing, you don't need to know \SpecialChar LaTeX
362 to use \SpecialChar LyX
365 has added its own extensions to \SpecialChar LaTeX
367 Try the following sometime: select
368 \begin_inset Flex Noun
371 \begin_layout Plain Layout
372 Export\SpecialChar menuseparator
379 \begin_inset Flex Noun
382 \begin_layout Plain Layout
389 \begin_inset Flex Noun
392 \begin_layout Plain Layout
393 View\SpecialChar menuseparator
403 ), then look at the preamble of the resulting
404 \begin_inset Flex Code
407 \begin_layout Plain Layout
414 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
416 These macros are defined automatically, according to the features you use
420 \begin_layout Standard
421 There are several commands that automatically invoke \SpecialChar LaTeX
426 \begin_layout Itemize
427 \begin_inset Flex Noun
430 \begin_layout Plain Layout
431 Document\SpecialChar menuseparator
440 \begin_layout Itemize
441 \begin_inset Flex Noun
444 \begin_layout Plain Layout
445 Document\SpecialChar menuseparator
454 \begin_layout Standard
455 They will only invoke \SpecialChar LaTeX
456 if the file has changed since the last time \SpecialChar LaTeX
462 \begin_layout Standard
463 When \SpecialChar LyX
464 runs \SpecialChar LaTeX
465 on the file you're editing, it performs these steps:
468 \begin_layout Enumerate
469 Convert the document to \SpecialChar LaTeX
470 and save to a file with the extension
471 \begin_inset Flex Code
474 \begin_layout Plain Layout
481 \begin_inset Flex Code
484 \begin_layout Plain Layout
493 \begin_layout Enumerate
494 Run \SpecialChar LaTeX
496 \begin_inset Flex Code
499 \begin_layout Plain Layout
505 file (maybe several times), and run any other commands (such as
506 \begin_inset Flex Code
509 \begin_layout Plain Layout
516 \begin_inset Flex Code
519 \begin_layout Plain Layout
525 ) needed to compile the \SpecialChar LaTeX
529 \begin_layout Enumerate
530 If there are any errors, show the error log.
533 \begin_layout Standard
534 If you have run \SpecialChar LaTeX
536 \begin_inset Flex Noun
539 \begin_layout Plain Layout
540 View\SpecialChar menuseparator
547 then runs a DVI viewer to display the DVI-file.
549 \begin_inset Flex Noun
552 \begin_layout Plain Layout
553 View\SpecialChar menuseparator
560 performs further steps:
563 \begin_layout Enumerate
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
574 to convert the DVI file to PostScript.
577 \begin_layout Enumerate
578 Run a PostScript viewer, such as
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
588 , to display the PostScript file.
591 \begin_layout Standard
593 does similar things when viewing, or exporting, other formats.
596 \begin_layout Section
597 Translating \SpecialChar LaTeX
598 files into \SpecialChar LyX
602 \begin_layout Standard
603 You can import a \SpecialChar LaTeX
604 file into \SpecialChar LyX
606 \begin_inset Flex Noun
609 \begin_layout Plain Layout
610 File\SpecialChar menuseparator
611 Import\SpecialChar menuseparator
617 command in \SpecialChar LyX
619 This will call a program named
620 \begin_inset Flex Code
623 \begin_layout Plain Layout
629 which will create a file
630 \begin_inset Flex Code
633 \begin_layout Plain Layout
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
651 will then open that file.
655 \begin_layout Plain Layout
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
665 can also be run from the command line, of course.
673 \begin_layout Standard
674 \begin_inset Flex Code
677 \begin_layout Plain Layout
683 will translate most legal \SpecialChar LaTeX
684 , but not everything.
685 It will put things it doesn't understand into \SpecialChar TeX
686 code, so after translating
688 \begin_inset Flex Code
691 \begin_layout Plain Layout
697 , you can look for \SpecialChar TeX
698 code and hand-edit it until it looks right.
701 \begin_layout Standard
702 If you don't know what \SpecialChar TeX
703 code is, read the next section.
706 \begin_layout Section
707 \begin_inset CommandInset label
709 name "sec:Inserting-TeX-Code"
713 Inserting \SpecialChar TeX
714 Code into \SpecialChar LyX
718 \begin_layout Standard
719 Anything you can do in \SpecialChar LaTeX
720 you can do in \SpecialChar LyX
721 , for a very simple reason: You can
722 always insert \SpecialChar TeX
723 code into any \SpecialChar LyX
726 cannot, and will never be able to, display every possible \SpecialChar LaTeX
728 If ever you need to insert \SpecialChar LaTeX
729 commands into your \SpecialChar LyX
730 document, you can use the
732 \begin_inset Flex Code
735 \begin_layout Plain Layout
742 box, which you can insert into your document with
743 \begin_inset Flex Noun
746 \begin_layout Plain Layout
747 Insert\SpecialChar menuseparator
757 or the keyboard shortcut
766 \begin_layout Standard
767 Here's an example of inserting \SpecialChar LaTeX
768 commands in a \SpecialChar LyX
770 The code looks like this:
773 \begin_layout LyX-Code
777 \begin_inset Newline newline
783 \begin_inset Newline newline
786 This is an example of a minipage environment.
788 \begin_inset Newline newline
791 can put nearly everything in it, even (non-floating)
792 \begin_inset Newline newline
797 \begin_inset Newline newline
803 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
830 \begin_inset Newline newline
836 \begin_inset Newline newline
842 \begin_inset Newline newline
848 \begin_inset Newline newline
856 \begin_layout LyX-Code
860 \begin_layout Standard
862 \begin_inset Flex Code
865 \begin_layout Plain Layout
872 box containing this text is directly after this paragraph.
873 Those of you reading the manual in \SpecialChar LyX
874 will only see the \SpecialChar TeX
876 Those reading a printed version of the manuals will see the actual results:
877 \begin_inset VSpace bigskip
883 \begin_layout Standard
887 \begin_layout Plain Layout
894 \begin_layout Plain Layout
901 \begin_layout Plain Layout
903 This is an example of a minipage environment.
904 You can put nearly everything in it, even (non-floating) figures and tables.
908 \begin_layout Plain Layout
915 \begin_layout Plain Layout
920 \begin_layout Plain Layout
927 \begin_layout Plain Layout
934 \begin_layout Plain Layout
941 \begin_layout Plain Layout
947 \begin_layout Plain Layout
954 \begin_layout Plain Layout
961 \begin_layout Plain Layout
968 \begin_layout Plain Layout
978 \begin_inset VSpace bigskip
984 \begin_layout Standard
985 In addition to using \SpecialChar TeX
986 code, you can also create a separate file containing
987 some complex \SpecialChar LaTeX
988 structure and then use
989 \begin_inset Flex Noun
992 \begin_layout Plain Layout
993 Insert\SpecialChar menuseparator
1003 to include your file (you should select the type
1004 \begin_inset Flex Code
1007 \begin_layout Plain Layout
1014 We recommend that you only do this if you have a
1015 \begin_inset Flex Code
1018 \begin_layout Plain Layout
1029 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1033 \begin_layout Standard
1034 There are a few last points to emphasize:
1037 \begin_layout Itemize
1043 check if your \SpecialChar LaTeX
1047 \begin_layout Itemize
1048 Beware of reinventing the wheel.
1051 \begin_layout Standard
1052 On that last point, \SpecialChar LyX
1053 does have quite a few features tucked into it, and
1055 Be sure to check the manuals to make sure that \SpecialChar LyX
1056 doesn't have such-and-such
1057 feature before you decide you have to do it by hand.
1058 Moreover, there are numerous \SpecialChar LaTeX
1059 packages out there to do all sorts of things,
1060 from labels to envelopes to fancy multipage tables.
1062 \change_inserted 244031559 1603815732
1064 \begin_inset CommandInset href
1067 target "https://www.ctan.org/"
1073 \change_deleted 244031559 1603815732
1075 \begin_inset CommandInset href
1078 target "http://www.ctan.org/"
1088 \begin_layout Standard
1089 If you do need to do some wild and fancy things within your document, be
1090 sure to check out a good \SpecialChar LaTeX
1091 book for assistance.
1092 There are a number of them listed in the bibliography of the
1099 \begin_layout Section
1101 and the \SpecialChar LaTeX
1105 \begin_layout Subsection
1106 About the \SpecialChar LaTeX
1110 \begin_layout Standard
1111 If you already know \SpecialChar LaTeX
1112 , there is no need to explain here what the preamble
1114 If you don't, the following will give you some ideas—we recommend again
1115 that you consult a \SpecialChar LaTeX
1116 book for further information.
1117 In any case, you should read the points below, because they explain what
1118 you can do and what you don't need to do in the \SpecialChar LaTeX
1119 preamble of a \SpecialChar LyX
1123 \begin_layout Standard
1124 The \SpecialChar LaTeX
1125 preamble comes at the very beginning of a document,
1133 \begin_layout Itemize
1134 Declare the document class.
1136 \begin_inset Newline newline
1140 already does this for you.
1141 If you're a seasoned \SpecialChar LaTeX
1142 -nician, and you have a custom document class you
1143 want to use, check out the
1145 Customization Manual
1147 for information on how to make \SpecialChar LyX
1151 \begin_layout Itemize
1152 Declare the usage of packages.
1154 \begin_inset Newline newline
1158 packages provide special commands, which are only available within a document
1159 when the package has been declared in the preamble.
1160 In addition to providing special commands, the inclusion of a package can
1161 change the document.
1162 For example, the package
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1172 forces all paragraphs to be indented.
1173 There are other packages for labels, envelopes, margins, etc.
1177 \begin_layout Itemize
1178 Set counters, variables, lengths and widths.
1180 \begin_inset Newline newline
1183 There are several \SpecialChar LaTeX
1184 counters and variables that
1188 be set globally from within the preamble in order to have the desired effect.
1189 (There are variables that you can set and reset inside the document, too.)
1190 Margins are a good example of something that must be set in the preamble.
1191 Another example is the label format for lists.
1192 You can actually set these just about anywhere, but it's best to do it
1193 just once, inside the preamble.
1196 \begin_layout Itemize
1197 Declare user defined commands (with
1198 \begin_inset Flex Code
1201 \begin_layout Plain Layout
1210 \begin_inset Flex Code
1213 \begin_layout Plain Layout
1222 \begin_inset Newline newline
1225 These are abbreviations for \SpecialChar LaTeX
1226 commands which appear very often inside a document.
1227 Although the preamble is a good place to declare such commands, they
1231 be declared anywhere (before they are used for the first time, of course).
1232 This can be useful if there is a lot of raw \SpecialChar LaTeX
1233 code in your document, which
1234 normally should not be the case.
1237 \begin_layout Standard
1239 adds its own set of definitions to the preamble of the
1240 \begin_inset Flex Code
1243 \begin_layout Plain Layout
1250 This makes \SpecialChar LaTeX
1251 files generated by \SpecialChar LyX
1255 \begin_layout Subsection
1256 Changing the Preamble
1259 \begin_layout Standard
1260 The commands which \SpecialChar LyX
1261 adds to the preamble of a \SpecialChar LaTeX
1262 file are fixed; you can't
1263 change them without patching \SpecialChar LyX
1265 You can, however, add your own stuff to the preamble by selecting
1266 \begin_inset Flex Noun
1269 \begin_layout Plain Layout
1272 \begin_inset space ~
1281 \begin_inset Flex Noun
1284 \begin_layout Plain Layout
1285 Document\SpecialChar menuseparator
1293 adds anything in the
1294 \begin_inset Flex Noun
1297 \begin_layout Plain Layout
1303 dialog to its own built-in preamble.
1304 Before adding your own declarations in the preamble, you should make sure
1305 that \SpecialChar LyX
1306 doesn't already support what you want to do.
1307 (Remember what we said about reinventing the wheel?) Also,
1309 make sure your preamble code is correct
1313 doesn't check it for you.
1314 If there is an error, you're likely to get an error like
1315 \begin_inset Quotes eld
1319 \begin_inset Flex Code
1322 \begin_layout Plain Layout
1331 \begin_inset Quotes erd
1335 If you see this error, check your preamble.
1338 \begin_layout Subsection
1342 \begin_layout Standard
1343 Here are some examples of what you can add to a preamble, and what they
1347 \begin_layout Subsubsection
1351 \begin_layout Standard
1352 There are two variables under \SpecialChar LaTeX
1353 that control page position:
1354 \begin_inset Flex Code
1357 \begin_layout Plain Layout
1366 \begin_inset Flex Code
1369 \begin_layout Plain Layout
1378 Their names should be self-explanatory.
1379 These variables are useful if you think for a moment about computer labels.
1380 Sometimes, the size of a print medium and the area of the medium that you
1381 can actually print on aren't the same.
1383 \begin_inset Flex Code
1386 \begin_layout Plain Layout
1395 \begin_inset Flex Code
1398 \begin_layout Plain Layout
1409 \begin_layout Standard
1410 The default values for
1411 \begin_inset Flex Code
1414 \begin_layout Plain Layout
1423 \begin_inset Flex Code
1426 \begin_layout Plain Layout
1435 \begin_inset space \thinspace{}
1439 \begin_inset space \thinspace{}
1443 \begin_inset space \space{}
1446 the page isn't shifted.
1447 Unfortunately, some DVI drivers always seem to shift the page.
1448 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1449 If you're using \SpecialChar LyX
1450 on a system that you don't personally maintain, and your
1451 sysadmin is a doofus,
1452 \begin_inset Flex Code
1455 \begin_layout Plain Layout
1464 \begin_inset Flex Code
1467 \begin_layout Plain Layout
1476 Suppose your left and top margins are always 0.5
1477 \begin_inset space \thinspace{}
1481 You can add this to the preamble:
1484 \begin_layout LyX-Code
1492 \begin_layout LyX-Code
1500 \begin_layout Standard
1501 and your margins should now be correct.
1504 \begin_layout Subsubsection
1508 \begin_layout Standard
1509 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1510 There's a rather nice package, available at your nearest CTAN archive,
1511 for printing sheets of labels:
1512 \begin_inset Flex Code
1515 \begin_layout Plain Layout
1522 Now, your system may not have this package installed by default.
1523 We leave that up to you to check.
1524 You'll also want to read the documentation for it; we're not going to do
1526 Since this is an example, however, we'll give you an example of how you
1530 \begin_layout Standard
1531 First, make sure you're using the
1532 \begin_inset Flex Code
1535 \begin_layout Plain Layout
1542 Next, you need to put the following in your preamble:
1545 \begin_layout LyX-Code
1551 \begin_layout LyX-Code
1557 \begin_layout LyX-Code
1563 \begin_layout LyX-Code
1569 \begin_layout LyX-Code
1575 \begin_layout LyX-Code
1581 \begin_layout LyX-Code
1587 \begin_layout Standard
1588 This sets things up for Avery label sheets, stock #5360.
1589 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1592 \begin_inset Flex Code
1595 \begin_layout Plain Layout
1604 \begin_inset Flex Code
1607 \begin_layout Plain Layout
1615 around each label text.
1616 This and other special features of
1617 \begin_inset Flex Code
1620 \begin_layout Plain Layout
1626 are explained in its documentation.
1629 \begin_layout Standard
1630 Someday, someone may write a \SpecialChar LyX
1631 layout file to support this package directly.
1632 Maybe that someone is you.
1635 \begin_layout Subsubsection
1636 Example #3: Paragraph Indentation
1639 \begin_layout Standard
1640 Americans are trained to indent the first line of
1645 As with all of their other weird quirks, most Americans will whine and
1646 moan until they can have their way and indent the first line of all paragraphs.
1655 \begin_layout Standard
1656 Of course, this behavior isn't standard typography.
1657 In books, you typically only indent the first line of a paragraph
1661 it follows another one.
1662 The idea behind indenting the first line of a paragraph is to distinguish
1663 neighboring paragraphs from one another.
1664 If there is no previous paragraph—for example, if it follows a figure or
1665 is the first paragraph in a section—then there is no need for indentation.
1669 \begin_layout Standard
1670 If you're a typical American (we're still joking!), though, you don't care
1671 about such esoteric things; you want your indentation! Add this to the
1675 \begin_layout LyX-Code
1678 usepackage{indentfirst}
1681 \begin_layout Standard
1682 If your \SpecialChar TeX
1683 distribution isn't braindead, you'll have this package, and all
1684 of your paragraphs will get the indentation the Founding Fathers intended
1688 \begin_layout Subsubsection
1689 Example #4: This Document
1692 \begin_layout Standard
1693 You can also check out the preamble of this document to get an idea of some
1694 of the advanced things you can do.
1697 \begin_layout Section
1699 and \SpecialChar LaTeX
1703 \begin_layout Standard
1704 When \SpecialChar LyX
1705 calls \SpecialChar LaTeX
1706 , it tells \SpecialChar LaTeX
1707 to blithely ignore any errors and keep going.
1708 It then uses the logfile from the \SpecialChar LaTeX
1709 run to do a post-mortem.
1710 After analyzing the logfile, \SpecialChar LyX
1711 displays a dialog listing the errors.
1712 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1714 where the error occurred.
1718 \begin_layout Plain Layout
1720 Analyzing the logfile is a tough job, and \SpecialChar LyX
1721 doesn't always go to the right
1723 There are also cases where \SpecialChar LaTeX
1724 reports the error on one line, but the actual
1726 This is not unlike forgetting a closing brace in a program: You'll get
1727 an error, but only later.
1735 \begin_layout Standard
1736 Some folks also like to look at the log file directly: It is available from
1738 \begin_inset Flex Noun
1741 \begin_layout Plain Layout
1742 Document\SpecialChar menuseparator
1744 \begin_inset space ~
1753 There are some fairly common error messages and warnings.
1754 We'll cover those here.
1755 You should look at a good \SpecialChar LaTeX
1756 book for a complete listing.
1759 \begin_layout Itemize
1760 \begin_inset Flex Code
1763 \begin_layout Plain Layout
1770 \begin_inset Newline newline
1773 Anything beginning with these words is a warning message for the purpose
1775 \begin_inset Quotes eld
1779 \begin_inset Quotes erd
1782 the \SpecialChar LaTeX
1784 You'll get messages like this if you added or changed cross-references
1785 or bibliography entries, in which case, \SpecialChar LaTeX
1786 is trying to tell you that you
1787 need to make another run.
1788 You can by-and-large ignore these.
1791 \begin_layout Itemize
1792 \begin_inset Flex Code
1795 \begin_layout Plain Layout
1802 \begin_inset Newline newline
1805 Another warning message, this time about fonts which \SpecialChar LaTeX
1807 The rest of the message will often say something about a replacement font
1808 that \SpecialChar LaTeX
1810 You can safely ignore these, too.
1813 \begin_layout Itemize
1814 \begin_inset Flex Code
1817 \begin_layout Plain Layout
1826 \begin_inset Newline newline
1835 It seems to generate at least one of these messages for just about any
1837 They are warnings about lines that were too long and run past the right
1839 This happens if \SpecialChar LaTeX
1840 does not find a reasonable way to break the lines (notoriously
1841 often with typewriter font, since this does not allow for automatic break
1843 In many cases, this is unnoticeable in the final output.
1844 (It can be just a point or two.) Sometimes, however, the lines run rather
1845 visibly into the margin; something you will not want to have in your final
1848 \begin_inset Newline newline
1851 There are several global ways to try to minimize the overfull lines.
1854 Enable micro-typographic extensions
1858 Document\SpecialChar menuseparator
1859 Settings\SpecialChar menuseparator
1862 might already improve things a lot.
1863 Furthermore, \SpecialChar LaTeX
1864 code such as the following in
1866 Document\SpecialChar menuseparator
1867 Settings\SpecialChar menuseparator
1870 usually reduces the overfull lines drastically (we use this in the preamble
1875 \begin_layout LyX-Code
1879 \begin_inset Newline newline
1885 \begin_inset Newline newline
1890 emergencystretch 1.5em
1891 \begin_inset Newline newline
1899 \begin_layout Standard
1900 In some cases, however, you eventually have to rewrite the text to get the
1901 line breaking right.
1905 \begin_layout Plain Layout
1906 For more information, see
1907 \begin_inset Flex URL
1910 \begin_layout Plain Layout
1912 http://www.tex.ac.uk/FAQ-overfull.html
1925 \begin_layout Standard
1926 In any case, you should check the respective lines, at least for the final
1927 version of your document.
1928 Your eyes will tell you if there's a problem with something that's too
1933 \begin_layout Plain Layout
1934 You can also enable the `draft' option in
1935 \begin_inset Flex Noun
1938 \begin_layout Plain Layout
1939 Document\SpecialChar menuseparator
1945 , and then \SpecialChar LaTeX
1946 will draw a black box in the margin of lines that are overfull.
1955 \begin_layout Itemize
1956 \begin_inset Flex Code
1959 \begin_layout Plain Layout
1968 \begin_inset Newline newline
1971 Not quite as common as its cousin.
1972 This happens again if \SpecialChar LaTeX
1973 does not find a reasonable break point and consequently
1974 generates too loose lines.
1975 As with the overfull lines, you should check if this is a visible problem.
1978 \begin_layout Itemize
1979 \begin_inset Flex Code
1982 \begin_layout Plain Layout
1991 \begin_inset Flex Code
1994 \begin_layout Plain Layout
2003 \begin_inset Newline newline
2006 Warnings about troubles breaking the page.
2007 Once again, just look at the output.
2008 Your eyes will tell you where something has gone wrong.
2011 \begin_layout Itemize
2012 \begin_inset Flex Code
2015 \begin_layout Plain Layout
2017 \begin_inset Quotes els
2021 \begin_inset Quotes ers
2030 \begin_inset Newline newline
2034 \begin_inset Quotes eld
2038 \begin_inset Quotes erd
2041 isn't installed on this system.
2042 This usually appears because some package your document needs isn't installed.
2043 If you didn't touch the preamble or didn't use the
2044 \begin_inset Flex Code
2047 \begin_layout Plain Layout
2055 command, then one of the packages \SpecialChar LyX
2056 tried to load is missing.
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2062 Help\SpecialChar menuseparator
2069 to get a list of packages that \SpecialChar LyX
2071 This file is updated whenever you reconfigure \SpecialChar LyX
2073 \begin_inset Flex Noun
2076 \begin_layout Plain Layout
2077 Tools\SpecialChar menuseparator
2083 ) and tells you which packages have been detected and what they do.
2084 \begin_inset Newline newline
2088 \begin_inset Flex Code
2091 \begin_layout Plain Layout
2099 command and the package in question isn't installed, then you'll need to
2100 install it yourself.
2103 \begin_layout Itemize
2104 \begin_inset Flex Code
2107 \begin_layout Plain Layout
2108 LaTeX Error: Unknown option
2114 \begin_inset Newline newline
2117 Error messages beginning with this are trying to tell you that you specified
2118 a bad or undefined option to a package.
2119 Check the package's documentation.
2122 \begin_layout Itemize
2123 \begin_inset Flex Code
2126 \begin_layout Plain Layout
2127 Undefined control sequence
2133 \begin_inset Newline newline
2136 If you've inserted \SpecialChar LaTeX
2137 code into your document, but made a typo, you'll get
2139 You may have forgotten to load a package.
2140 In any case, this error message usually means that you used an undefined
2145 \begin_layout Standard
2146 There are other error and warning messages.
2147 Some are self-explanatory.
2148 These are usually \SpecialChar LaTeX
2150 Others are downright cryptic.
2151 These are usually \SpecialChar TeX
2152 error messages, and we really have
2156 what they mean or how to decipher them.
2160 \begin_layout Standard
2161 There's a general sequence you should follow if you get error messages:
2164 \begin_layout Enumerate
2165 Look at the \SpecialChar LaTeX
2166 code you inserted for typos.
2169 \begin_layout Enumerate
2170 If there are no typos, check that you used the command(s) correctly.
2173 \begin_layout Enumerate
2174 If you get a bunch of error boxes piled up at the very top of the document—and
2175 especially if you see a
2176 \begin_inset Quotes eld
2180 \begin_inset Flex Code
2183 \begin_layout Plain Layout
2192 \begin_inset Quotes erd
2195 error—it means that there are errors in the preamble.
2196 Start debugging your preamble.
2199 \begin_layout Enumerate
2200 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2202 document, the first suspect is your \SpecialChar LaTeX
2203 distribution itself.
2204 Check for missing packages and install them.
2207 \begin_layout Enumerate
2208 Okay, so there are no missing packages.
2209 Did you use any of the fine-tuning options in \SpecialChar LyX
2210 ? Specifically, did you
2214 any of them, like trying to manually insert lots of
2215 \begin_inset Flex Code
2218 \begin_layout Plain Layout
2220 \change_deleted 177693 1654669036
2222 \change_inserted 177693 1654669038
2226 \begin_inset space ~
2230 \change_deleted 177693 1654669040
2232 \change_inserted 177693 1654669041
2241 \begin_inset Flex Code
2244 \begin_layout Plain Layout
2251 \begin_inset Flex Code
2254 \begin_layout Plain Layout
2260 ? Did you try to kludge something together with these instead of using the
2261 appropriate paragraph environment?
2264 \begin_layout Enumerate
2265 All right, you didn't use any of the fine-tuning options, you played by
2267 Did you try to pull a fancy maneuver? Did you do something funky inside
2268 a table or an equation, like inserting a graphic into a table cell?
2271 \begin_layout Enumerate
2272 Do you have long sections of text where \SpecialChar LaTeX
2273 cannot find a place to break a
2274 line? By default, \SpecialChar LaTeX
2275 is rather strict about how much extra inter-word spacing
2276 it will add in order to break a line.
2277 Preferably, you should rework the paragraph to avoid the problem.
2280 \begin_layout Enumerate
2281 Did you go overboard with the nesting? \SpecialChar LyX
2282 (currently) doesn't check to make
2283 sure you're in the limits for nesting environments.
2284 If you nested a bunch of environments to the
2285 \begin_inset Formula $17^{\mathrm{th}}$
2288 level, that's the problem.
2289 (The limit in \SpecialChar LaTeX
2293 \begin_layout Enumerate
2294 Okay, you didn't get any error messages, but your output looks awful.
2295 If you have a table or figure that's too wide or long for the page, you
2300 \begin_layout Enumerate
2301 rescale the figure so it fits.
2304 \begin_layout Enumerate
2305 trim down the table so it fits.
2309 \begin_layout Enumerate
2310 If something else is wrong with the output, and you didn't try to pull anything
2311 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2314 \begin_layout Standard
2315 If all this doesn't help—well, then
2319 you might have found a bug in \SpecialChar LyX
2324 \begin_layout Chapter
2326 \change_inserted 564990737 1670439508
2330 \begin_layout Section
2332 \change_inserted 564990737 1670439533
2333 \begin_inset CommandInset label
2335 name "sec:Collections"
2342 \begin_layout Subsection
2343 AMS \SpecialChar LaTeX
2347 \begin_layout Standard
2354 Richard Kimberly Heck
2357 \begin_layout Standard
2358 \begin_inset VSpace bigskip
2364 \begin_layout Standard
2366 The AMS \SpecialChar LaTeX
2367 layouts are set up to conform to suggested styles for mathematical
2368 papers to be submitted to American Mathematical Society publications.
2369 The layouts are not tailored to a specific journal, but easily can be.
2370 You should refer to the AMS documentation for specific instructions for
2371 each journal (usually it will entail only changing a single line in the
2374 That documentation is available on the Web at
2375 \begin_inset Flex URL
2378 \begin_layout Plain Layout
2386 \begin_inset Flex URL
2389 \begin_layout Plain Layout
2391 ftp://ftp.ams.org/pub/tex/amslatex/
2397 These layouts are appropriate, and useful, for any mathematical writing.
2401 \begin_layout Standard
2402 There are two basic AMS \SpecialChar LaTeX
2406 \begin_layout Itemize
2407 amsart: The standard AMS article format.
2410 \begin_layout Itemize
2411 amsbook: the standard AMS book (really, monograph) format.
2415 \begin_layout Standard
2416 The layouts themselves contain only the minimum necessary to use the AMS
2418 They do not, in particular, contain any of the `theorem' environments used
2419 for setting theorems, lemmas, and the like.
2420 These are contained, instead, in the
2421 \begin_inset Flex Code
2424 \begin_layout Plain Layout
2430 module, which is loaded by default when you select one of the AMS classes.
2431 (It can also be used with other classes and can be removed, if you would
2432 rather use something else.) Less commonly used environments are in the
2433 \begin_inset Flex Code
2436 \begin_layout Plain Layout
2437 Theorems (AMS-Extended)
2442 module, which must be loaded manually.
2445 \begin_layout Standard
2446 By default, theorems and the like are numbered consecutively throughout
2447 the document, but this may be modified by loading the module
2448 \begin_inset Flex Code
2451 \begin_layout Plain Layout
2452 Theorems (Order by Section)
2457 or, if you are using
2458 \begin_inset Flex Code
2461 \begin_layout Plain Layout
2468 \begin_inset Flex Code
2471 \begin_layout Plain Layout
2472 Theorems (Order by Chapter)
2478 These will number the results as
2479 \begin_inset Formula $n.m$
2482 , where the first number refers to the section (or chapter) and the second
2483 refers to the total number of results so far in that section (or chapter).
2484 Many environments are also available unnumbered.
2485 These are indicated by an asterisk at the end.
2486 If you happen to want
2490 unnumbered results, the module
2491 \begin_inset Flex Code
2494 \begin_layout Plain Layout
2500 provides that option.
2503 \begin_layout Standard
2504 Note that these modules do not
2508 to be used with the AMS classes.
2509 It is perfectly possible to use the
2510 \begin_inset Flex Code
2513 \begin_layout Plain Layout
2519 module, and the others mentioned, with other classes, such as
2520 \begin_inset Flex Code
2523 \begin_layout Plain Layout
2530 \begin_inset Flex Code
2533 \begin_layout Plain Layout
2540 \begin_inset Flex Code
2543 \begin_layout Plain Layout
2552 \begin_layout Subsubsection
2553 What these layouts provide
2556 \begin_layout Standard
2557 There is a long list of included environments provided by these layouts.
2558 In AMS-\SpecialChar LaTeX
2559 , there is, in fact, an opportunity to define an unlimited variety
2560 of `theorem' environments.
2561 However, the AMS recommends the environments that are available in \SpecialChar LyX
2566 \begin_layout Standard
2567 The following environments—as well as the standard environments, such as
2569 \begin_inset Flex Noun
2572 \begin_layout Plain Layout
2579 \begin_inset Flex Noun
2582 \begin_layout Plain Layout
2589 \begin_inset Flex Noun
2592 \begin_layout Plain Layout
2599 \begin_inset Flex Noun
2602 \begin_layout Plain Layout
2609 \begin_inset Flex Noun
2612 \begin_layout Plain Layout
2619 \begin_inset Flex Code
2622 \begin_layout Plain Layout
2629 \begin_inset Flex Code
2632 \begin_layout Plain Layout
2641 \begin_layout Description
2642 Address This should be the author's permanent address.
2645 \begin_layout Description
2647 \begin_inset space ~
2650 Address This should be the author's temporary address at the time of submission,
2651 if different from the Address.
2654 \begin_layout Description
2655 Email Author's e-mail address
2658 \begin_layout Description
2659 URL Author's Web address, if desired.
2662 \begin_layout Description
2663 Keywords Key words or phrases used to identify specific topics discussed
2667 \begin_layout Description
2668 Subjectclass These refer to the AMS Subject Classifications, published and
2671 Mathematical Reviews
2674 These are also available online at the AMS cites listed above.
2677 \begin_layout Description
2681 \begin_layout Description
2685 \begin_layout Description
2689 \begin_layout Standard
2690 The following environments are provided by both the
2691 \begin_inset Flex Code
2694 \begin_layout Plain Layout
2701 \begin_inset Flex Code
2704 \begin_layout Plain Layout
2710 modules, in the latter case in both starred (unnumbered) and unstarred
2711 (numbered) versions.
2712 These same environments are provided only in the starred versions by the
2714 \begin_inset Flex Code
2717 \begin_layout Plain Layout
2726 \begin_layout Theorem
2727 This is typically used for the statements of major results.
2731 \begin_layout Corollary*
2732 This is used for statements which follow fairly directly from previous statement
2734 Again, these can be major results.
2739 These are smaller results needed to prove other statements.
2742 \begin_layout Proposition
2743 These are less major results which (hopefully) add to the general theory
2747 \begin_layout Conjecture
2748 These are statements provided without justification, which the author does
2749 not know how to prove, but which seem to be true (to the author, at least).
2752 \begin_layout Definition*
2753 Guess what this is for.
2754 The font is different for this environment than for the previous ones.
2758 \begin_layout Example*
2759 Used for examples illustrating proven results.
2762 \begin_layout Problem
2763 It's not really known what this is for.
2764 You should figure it out.
2767 \begin_layout Exercise*
2768 Write a description for this one.
2771 \begin_layout Remark
2772 This environment is also a type of theorem, usually a lesser sort of observation.
2775 \begin_layout Claim*
2776 Often used in the course of giving a proof of a larger result.
2780 Generally, these are used to break up long arguments, using specific instances
2786 The numbering scheme for cases is on its own, not together with other numbered
2792 At the end of this environment, a QED symbol (usually a square, but it can
2793 vary with different styles) is placed.
2794 If you want to have other environments within this one—for example, Case
2795 environments—and have the QED symbol appear only after them, then the other
2796 environments need to be nested within the proof environment.
2799 Nesting Environments
2805 for information on nesting.
2808 \begin_layout Standard
2809 And these environments are provided by
2810 \begin_inset Flex Code
2813 \begin_layout Plain Layout
2814 Theorems (AMS-Extended)
2822 \begin_layout Criterion*
2823 A required condition.
2826 \begin_layout Algorithm*
2827 A general procedure to be used.
2830 \begin_layout Axiom*
2831 This is a property or statement taken as true within the system being discussed.
2834 \begin_layout Condition*
2835 Sometimes used to state a condition assumed within the present context of
2840 Similar to a Remark.
2843 \begin_layout Notation*
2844 Used for the explanation of, yes, notation.
2847 \begin_layout Summary
2848 Do we really need to tell you?
2851 \begin_layout Acknowledgement*
2855 \begin_layout Conclusion*
2856 Sometimes used at the end of a long train of argument.
2860 Used in a way similar to Proposition, though perhaps lower on the scale.
2863 \begin_layout Standard
2864 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2867 They need to be available on your system in order to use these environments.
2870 \begin_layout Subsection
2874 \begin_layout Standard
2880 \begin_layout Subsubsection
2884 \begin_layout Standard
2885 The \SpecialChar LyX
2888 article (koma-script)
2892 report (koma-script)
2910 correspond to the \SpecialChar LaTeX
2928 \begin_inset space ~
2931 of the Koma-Script family.
2932 They are replacements for the standard document classes
2948 , resp., and fit better to European typography conventions in a number of
2952 \begin_layout Itemize
2953 Standard character size is 11pt in
2955 article (koma-script)
2959 report (koma-script)
2967 letter (koma-script)
2972 \begin_layout Itemize
2973 Headings, labels of the description environment, and a number of elements
2976 letter (koma-script)
2978 document class are set in a bold sans serif font.
2982 \begin_layout Plain Layout
2983 There is a big difference between the bold sans serif old cm fonts and new
2984 ec fonts, especially in the appearance of headings.
2985 In comparison, the ec bold sans serif fonts look a bit thin.
2986 Here the \SpecialChar LaTeX
2995 helps to produce the
2996 \begin_inset Quotes eld
3000 \begin_inset Quotes erd
3003 appearance when using the ec fonts.
3008 The numbering of chapter headings is made in the same way as the numbering
3009 of section headings, that is without the extra line
3010 \begin_inset Quotes eld
3013 Chapter\SpecialChar ldots
3015 \begin_inset Quotes erd
3019 In addition, the appearance of the headings can be modified by using a
3020 number of options (in \SpecialChar LyX
3021 to be entered in the field
3024 \begin_inset space ~
3031 Layout\SpecialChar menuseparator
3038 \begin_layout Itemize
3039 The main means in the Koma-Script document classes to design the type area
3048 (in \SpecialChar LyX
3049 to be entered in the extra class options field in the dialog
3051 Document\SpecialChar menuseparator
3055 They make a clearer modification of page margins possible as do the options
3058 Document\SpecialChar menuseparator
3065 \begin_layout Itemize
3066 The \SpecialChar LaTeX
3067 document classes of the Koma-Script family define a number of additional
3069 Those part of it which makes sense in \SpecialChar LyX
3070 is implemented in corresponding
3074 \begin_layout Standard
3075 Detailed descriptions of the \SpecialChar LaTeX
3076 document classes of the Koma-Script family
3077 can be found in the Koma-Script documentation
3088 \begin_layout Subsubsection
3089 article (koma-script), report (koma-script), and book (koma-script)
3092 \begin_layout Standard
3093 The document classes
3095 article (koma-script)
3099 report (koma-script)
3109 are implemented in the layout files
3122 They contain all the paragraph types of the corresponding standard document
3135 , resp., partly modified, with the exception of the \SpecialChar LyX
3140 -type, which is replaced by the new
3144 -type having the same functionality.
3149 -Type there is a number of new paragraph types added.
3156 letter (koma-script)
3161 \begin_layout Itemize
3170 : are equivalents to
3178 , resp., additionally inserting an entry in the table of contents.
3187 are not contained in
3189 article (koma-script)
3194 \begin_layout Itemize
3211 , resp., additionally clearing running heads.
3218 article (koma-script)
3224 \begin_layout Plain Layout
3237 report (koma-script)
3239 , but since this is identical to
3243 , is has not been implemented in \SpecialChar LyX
3252 \begin_layout Itemize
3257 : generates a heading directly above the following paragraph in the standard
3258 character size without affecting the structure of the document.
3261 \begin_layout Itemize
3270 are special captions which respect the different space settings needed
3271 for captions placed above or below an element (if you follow strict typographic
3272 rules, you might want to place table captions always above the table).
3273 You can also use the class option
3290 You need at least Koma-Script version 2.8q to use this.
3293 \begin_layout Itemize
3298 : can be used to set a bonmot, e.
3299 \begin_inset space \thinspace{}
3303 \begin_inset space \space{}
3306 at the beginning of a chapter.
3307 If you use the optional argument (
3309 Insert\SpecialChar menuseparator
3311 \begin_inset space ~
3316 ), you can insert the dictum's author there.
3317 Dictum and author are separated by a line.
3318 You need at least Koma-Script version 2.8q to use this.
3325 article (koma-script)
3330 \begin_layout Standard
3331 The following types, together with the standard types
3343 , form the title area of the document.
3344 They must be entered ahead of the first
3345 \begin_inset Quotes eld
3349 \begin_inset Quotes erd
3356 \begin_layout Plain Layout
3357 The corresponding \SpecialChar LaTeX
3358 commands must appear before the
3369 When such a type is used more than once, the latter usage overwrites the
3370 former one, that means, for every type only the latest usage is valid.
3371 The order of the different types however has, like
3383 , no effect on the appearance of the produced document.
3386 \begin_layout Itemize
3391 : produces a centered paragraph above the ordinary title (
3403 ) for the subject of the document.
3406 \begin_layout Itemize
3411 : produces a centered paragraph below the ordinary title (
3423 ) for the publishers' name.
3426 \begin_layout Itemize
3433 report (koma-script)
3439 produces a centered paragraph on its own page behind the title page, or
3442 article (koma-script)
3444 produces a centered paragraph below the ordinary title (
3463 \begin_layout Itemize
3468 : produces a left aligned paragraph above the ordinary title (
3484 ) for a document`s head.
3487 \begin_layout Itemize
3492 : produces in a double-sided print in
3494 report (koma-script)
3500 a left-aligned paragraph at the top of the title page`s back or has no
3501 effect in a single-sided print or in
3503 article (koma-script)
3508 \begin_layout Itemize
3513 : produces in a double-sided print in
3515 report (koma-script)
3521 a left-aligned paragraph at the bottom of the title page`s back or has
3522 no effect in a single-sided print or in
3524 article (koma-script)
3529 \begin_layout Itemize
3534 : produces a special
3535 \begin_inset Quotes eld
3539 \begin_inset Quotes erd
3542 page ahead of the actual document containing a paragraph without special
3546 \begin_layout Standard
3547 The layout files for the document classes
3549 article (koma-script)
3553 report (koma-script)
3564 This is thought of as a place to define your own types.
3569 in your personal layout directory and edit the file!
3572 \begin_layout Subsubsection
3573 letter (koma-script)
3576 \begin_layout Description
3577 Note: This section discusses the obsolete
3579 KOMA-Script-Letter (v.
3580 \begin_inset space ~
3585 , which is not even included anymore in recent KOMA releases.
3586 Please refer to the next section for the current KOMA-Script-Letter class
3588 \begin_inset space ~
3594 \begin_layout Standard
3598 letter (koma-script)
3600 is implemented in the layout file
3605 It contains all the paragraph types of the corresponding standard document
3610 , partly modified, with the exception of the \SpecialChar LyX
3624 type, which is replaced by the new
3629 In addition, it contains, in contrast to the standard document class, the
3648 Furthermore, there are a number of new letter specific types.
3651 \begin_layout Standard
3652 The appearance of the letter produced by this document class can be controlled
3653 by a number of \SpecialChar LaTeX
3654 commands, which you can put in the \SpecialChar LaTeX
3659 \begin_layout Plain Layout
3660 For example, the standard appearance of the letter`s heading, consisting
3661 of name and address, is quite self-willed.
3663 \begin_inset Quotes eld
3667 \begin_inset Quotes erd
3670 heading is produced by the following \SpecialChar LaTeX
3671 commands in the preamble:
3674 \begin_layout LyX-Code
3684 \begin_layout LyX-Code
3700 \begin_layout LyX-Code
3710 \begin_layout LyX-Code
3730 A detailed German description of such \SpecialChar LaTeX
3731 commands can be found in the Koma-Script
3737 With it, the letter's author can produce his personal letter layout.
3740 \begin_layout Standard
3749 define the beginning of the letter and must be used in every letter.
3750 To emphasize them in the \SpecialChar LyX
3751 document class, they are marked with the letter
3761 \begin_inset space ~
3765 It is possible to write any number of letters in one file.
3770 type produces a new letter using the same addressee and a
3774 type produces a new addressee.
3791 are ordinary paragraph types and can also be used several times in one
3792 and the same letter.
3795 \begin_layout Itemize
3800 : produces a paragraph for the addressee and implicitly defines the beginning
3804 \begin_layout Itemize
3809 : produces a paragraph for the form of address and implicitly produces a
3813 \begin_layout Itemize
3818 : produces a paragraph for a close.
3821 \begin_layout Itemize
3826 : produces a paragraph for a postscript.
3829 \begin_layout Itemize
3834 : produces a paragraph for a distribution list.
3837 \begin_layout Itemize
3842 : produces a paragraph for enclosures.
3845 \begin_layout Standard
3886 are input types provided with a label to enter information, which will
3887 be processed by the document class.
3891 \begin_layout Plain Layout
3892 It could be seen as a matter of inconsequence, that the types
3900 described above are not such input types as well.
3901 Because of the special meaning of those types, however, I have implemented
3902 them as ordinary paragraph types with a one letter mark in the left margin.
3903 Moreover, it would affect my feeling of symmetry, if the
3911 type had such a serious different appearance.
3916 The types must be used ahead of the corresponding
3923 \begin_layout Standard
3924 An implementation of these types in a WYSIWYG fashion does not seem to make
3925 sense, because the real appearance of the produced letter does not only
3926 depend on the usage of the particular type, but also on other factors.
3927 For example, a signature entered in the
3931 type will in the standard behavior appear in the produced letter only,
3932 when in the same letter also a
3937 The entered value of the
3941 type will in the standard behavior not appear in the produced letter at
3943 The possibility to design the letter`s heading freely is already indicated
3944 in a footnote above.
3947 \begin_layout Standard
3948 The input types can also be used as empty paragraphs.
3950 \begin_inset space \thinspace{}
3954 \begin_inset space \space{}
3966 type is not used at all, in the standard behavior the value of the
3970 type is used as signature, whereas if an empty
3974 type is used, no signature value is defined.
3977 \begin_layout Standard
3978 By using the input types it is possible to write a letter template, containing
3979 filled input types with your personal dates (name, address, etc.) and empty
3980 input types for other dates you want to enter.
3983 \begin_layout Itemize
3988 : sender's name, in the standard behavior appears as a centered paragraph
3989 in small caps in the letter`s heading.
3992 \begin_layout Itemize
3997 : sender's signature, in the standard behavior appears below the
4006 type is used, the value of the
4010 type appears instead.
4013 \begin_layout Itemize
4018 : sender's address, in the standard behavior appears in a centered paragraph
4019 in the letter`s heading below the sender's name.
4022 \begin_layout Itemize
4027 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4038 \begin_layout Itemize
4043 : place of the letter`s making.
4046 \begin_layout Itemize
4051 : date of the letter`s making.
4060 , in the standard behavior, produce the place and the date in a right-aligned
4061 line below the addressee's field.
4066 type is used, neither place nor date appear, independent of the value of
4076 type is used, the date of the letter `s production is used.
4079 \begin_layout Itemize
4084 : sender`s back address, in the standard behavior appears above the addressee's
4085 field in a small sans serif font.
4088 \begin_layout Itemize
4093 : special mail information, in the standard behavior appears underlined
4094 above the addressee's field below the back address.
4097 \begin_layout Itemize
4102 : additional information, in the standard behavior appears on right side
4103 below the addressee`s field.
4106 \begin_layout Itemize
4111 : the letter's title, in the standard behavior appears in a big, bold, sans
4112 serif font above the subject.
4115 \begin_layout Itemize
4120 : the letter's subject, in the standard behavior appears in a bold font
4128 \begin_layout Standard
4149 produce a business letter like line above the
4153 line containing the fields
4154 \begin_inset Quotes eld
4158 \begin_inset Quotes erd
4162 \begin_inset Quotes eld
4166 \begin_inset Quotes erd
4170 \begin_inset Quotes eld
4174 \begin_inset Quotes erd
4178 \begin_inset Quotes eld
4182 \begin_inset Quotes erd
4186 \begin_inset Quotes eld
4190 \begin_inset Quotes erd
4194 \begin_inset Quotes eld
4198 \begin_inset Quotes erd
4202 For the date field, the value of the
4208 \begin_inset Quotes eld
4211 business letter types
4212 \begin_inset Quotes erd
4215 is used, the value of the
4219 type however does not appear, but only the \SpecialChar LaTeX
4227 The ordinary output of place and date in a right-aligned line below the
4228 addressee`s field is suppressed.
4229 The types are implemented as input types provided with a label and must
4230 be used ahead of the corresponding
4237 \begin_layout Itemize
4245 \begin_layout Itemize
4253 \begin_layout Itemize
4261 \begin_layout Itemize
4269 \begin_layout Itemize
4277 \begin_layout Subsubsection
4278 The new letter class: letter (koma-script v.2)
4281 \begin_layout Standard
4287 \begin_layout Standard
4288 \begin_inset VSpace medskip
4294 \begin_layout Standard
4296 Koma-Script version 2.8 has introduced a new letter class
4300 which supersedes the now unsupported
4305 It has — on the \SpecialChar LaTeX
4306 side — a completely new interface and is not compatible
4308 Therefore, \SpecialChar LyX
4309 supports both, though it is recommended you use the new class.
4312 \begin_layout Standard
4313 This class covers the same functionality as
4315 letter (koma-script),
4322 (receiver's address, same as
4339 will start a new letter (i.
4340 \begin_inset space \thinspace{}
4344 \begin_inset space \space{}
4347 you can write several letters per document).
4348 New elements are sender's
4364 and the possibility to use a
4370 Insert\SpecialChar menuseparator
4376 \begin_layout Standard
4377 The biggest improvement is, though, that the letter's layout is configurable
4378 to meet almost any needs.
4379 This can be done via the preamble or with a special style file (Letter
4380 Class Option, extension
4384 ), that will be read in as a class option.
4388 \begin_layout Plain Layout
4389 The KOMA package comes with some default
4394 There is, for instance, a
4398 file that follows german typesetting rules, or a
4402 that provides the default layout of the old
4407 The latter can be loaded with the class option
4413 Layout\SpecialChar menuseparator
4414 Document\SpecialChar menuseparator
4426 template that is included in \SpecialChar LyX
4428 A detailed description is to be found in the Koma-Script documentation
4436 \begin_layout Subsubsection
4440 \begin_layout Standard
4441 Visualizing the Koma-Script document classes in \SpecialChar LyX
4442 , the \SpecialChar LyX
4443 internals cause some
4447 \begin_layout Itemize
4448 The chapter number of a
4452 type appears on a line of its own above the chapter heading instead of
4453 appearing in the same line ahead of it.
4454 The cause for that is the \SpecialChar LyX
4455 internal behavior for the labeltype
4462 \begin_layout Itemize
4463 The headings of the types
4472 \begin_inset Quotes eld
4476 \begin_inset Quotes erd
4480 table of contents, but not in the \SpecialChar LyX
4483 Document\SpecialChar menuseparator
4485 \begin_inset space ~
4489 \begin_inset space ~
4497 \begin_layout Itemize
4502 document class appear in a skip separation mode, not indented.
4503 This is the standard behavior, no special \SpecialChar LaTeX
4504 commands are needed for that.
4507 Document\SpecialChar menuseparator
4510 dialog the corresponding radio button indicates
4519 value always has the effect that extra \SpecialChar LaTeX
4520 commands are inserted in the document
4521 to produce the gap, which is not what is wanted in this case.
4524 \begin_layout Section
4526 \change_inserted 564990737 1670439534
4530 \begin_layout Standard
4532 \change_inserted 564990737 1670794710
4533 See also the document classes in the Collections (section
4534 \begin_inset space ~
4538 \begin_inset CommandInset ref
4540 reference "sec:Collections"
4547 \begin_layout Subsection
4549 \change_inserted 564990737 1670794716
4555 \begin_layout Standard
4557 \change_inserted 564990737 1670794716
4564 ; updated by the \SpecialChar LyX
4568 \begin_layout Subsubsection
4570 \change_inserted 564990737 1670794716
4576 \begin_layout Standard
4578 \change_inserted 564990737 1670794716
4581 This section describes how \SpecialChar LyX
4582 can be used to write articles for submission
4583 to the scientific journal
4585 Astronomy and Astrophysics
4588 \begin_inset CommandInset href
4591 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
4596 ) using Version 9.1 of the document class
4600 ; information about it is available at
4601 \begin_inset Flex URL
4604 \begin_layout Plain Layout
4606 \change_inserted 564990737 1670794716
4608 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
4618 \begin_layout Standard
4620 \change_inserted 564990737 1670794716
4623 A manual comes together with the package and should be consulted before
4624 installing this document class as described in the
4626 Installing New Document Classe
4636 \begin_layout Standard
4638 \change_inserted 564990737 1670794716
4641 \begin_inset Note Greyedout
4644 \begin_layout Plain Layout
4646 \change_inserted 564990737 1670794716
4649 Please note that the publisher of the journal was changed from Springer
4650 to EDP Sciences starting January 1, 2001.
4651 That change also involved some slight changes to the style files, namely
4652 the removal of the thesaurus command.
4653 If you have an older version installed, please upgrade.
4654 For information about compatibility with the old (version 4) layout, please
4655 refer to the comments in
4658 Dir/layouts/aapaper.layout
4668 \begin_layout Subsubsection
4670 \change_inserted 564990737 1670794716
4676 \begin_layout Standard
4678 \change_inserted 564990737 1670794716
4681 It is recommended you start from the template
4690 ile\SpecialChar menuseparator
4692 \begin_inset space ~
4700 \begin_inset space ~
4706 If you are not using the template, note the following settings:
4709 \begin_layout Itemize
4711 \change_inserted 564990737 1670794716
4723 ocument\SpecialChar menuseparator
4728 ettings\SpecialChar menuseparator
4730 \begin_inset space ~
4735 dialog (OK, that one was obvious).
4738 \begin_layout Itemize
4740 \change_inserted 564990737 1670794716
4746 \begin_inset space ~
4758 \begin_inset space ~
4763 dialog: leave it set to
4768 The whole layout is done by the macros, you shouldn't change anything.
4771 \begin_layout Subsubsection
4773 \change_inserted 564990737 1670794716
4779 \begin_layout Standard
4781 \change_inserted 564990737 1670794716
4784 First thing to enter is the header information.
4785 It consists of five entries, of which one is optional.
4789 \begin_layout Itemize
4791 \change_inserted 564990737 1670794716
4800 \begin_layout Itemize
4802 \change_inserted 564990737 1670794716
4811 \begin_layout Itemize
4813 \change_inserted 564990737 1670794716
4822 \begin_layout Itemize
4824 \change_inserted 564990737 1670794716
4833 \begin_layout Itemize
4835 \change_inserted 564990737 1670794716
4844 Received: <date>; Accepted <date>
4847 \begin_layout Standard
4849 \change_inserted 564990737 1670794716
4852 Although the order of the single header entries doesn't matter it is advised
4853 to keep the above sequence, just to get the best optics and meets the layout
4854 of the real document.
4857 \begin_layout Standard
4859 \change_inserted 564990737 1670794716
4862 If you want to place footnotes in the header block, e.
4863 \begin_inset space \thinspace{}
4867 \begin_inset space \space{}
4870 to state your present address, just use the standard footnote via the menu
4876 nsert\SpecialChar menuseparator
4885 will automagically use the term
4894 \begin_layout Standard
4896 \change_inserted 564990737 1670794716
4899 In addition to these topics, the macros use three additional \SpecialChar LaTeX
4901 have no counterpart in \SpecialChar LyX
4905 \begin_layout Itemize
4907 \change_inserted 564990737 1670794716
4915 to separate different names for more than one author and institute, respectivel
4919 \begin_layout Itemize
4921 \change_inserted 564990737 1670794716
4929 to mark corresponding author/institute pairs.
4930 The institutes are numbered sequentially as they appear in the
4934 field, so you have to put a marker to each author.
4937 \begin_layout Itemize
4939 \change_inserted 564990737 1670794716
4947 to supply an email address for fast contact.
4950 \begin_layout Standard
4952 \change_inserted 564990737 1670794716
4955 In all cases, the appropriate command has to be entered as \SpecialChar TeX
4956 code in \SpecialChar LyX
4958 See the examples in the template and in the file
4970 \begin_layout Subsubsection
4972 \change_inserted 564990737 1670794716
4978 \begin_layout Standard
4980 \change_inserted 564990737 1670794716
4983 The abstract should immediately follow the header block and must contain
4993 \begin_layout Enumerate
4995 \change_inserted 564990737 1670794716
5001 (optional) {} leave it empty if necessary
5004 \begin_layout Enumerate
5006 \change_inserted 564990737 1670794716
5015 \begin_layout Enumerate
5017 \change_inserted 564990737 1670794716
5026 \begin_layout Enumerate
5028 \change_inserted 564990737 1670794716
5037 \begin_layout Enumerate
5039 \change_inserted 564990737 1670794716
5045 (optional) {} leave it empty if necessary
5048 \begin_layout Standard
5050 \change_inserted 564990737 1670794716
5054 This structure not shown in
5061 \begin_layout Subsubsection
5063 \change_inserted 564990737 1670794716
5066 Supported environments
5069 \begin_layout Standard
5071 \change_inserted 564990737 1670794716
5074 The A&A paper layout supports the following environments for structuring
5078 \begin_layout Itemize
5080 \change_inserted 564990737 1670794716
5087 \begin_layout Itemize
5089 \change_inserted 564990737 1670794716
5096 \begin_layout Itemize
5098 \change_inserted 564990737 1670794716
5105 \begin_layout Itemize
5107 \change_inserted 564990737 1670794716
5114 \begin_layout Itemize
5116 \change_inserted 564990737 1670794716
5123 \begin_layout Itemize
5125 \change_inserted 564990737 1670794716
5132 \begin_layout Itemize
5134 \change_inserted 564990737 1670794716
5141 \begin_layout Itemize
5143 \change_inserted 564990737 1670794716
5150 \begin_layout Itemize
5152 \change_inserted 564990737 1670794716
5159 \begin_layout Itemize
5161 \change_inserted 564990737 1670794716
5168 \begin_layout Itemize
5170 \change_inserted 564990737 1670794716
5177 \begin_layout Itemize
5179 \change_inserted 564990737 1670794716
5187 \begin_layout Subsubsection
5189 \change_inserted 564990737 1670794716
5192 Commands not supported by \SpecialChar LyX
5196 \begin_layout Standard
5198 \change_inserted 564990737 1670794716
5201 Some commands are not yet supported by the
5205 layout for \SpecialChar LyX
5207 Some have already been mentioned.
5208 For the sake of completeness, they are listed all together here:
5211 \begin_layout Itemize
5213 \change_inserted 564990737 1670794716
5222 \begin_layout Itemize
5224 \change_inserted 564990737 1670794716
5233 \begin_layout Itemize
5235 \change_inserted 564990737 1670794716
5244 \begin_layout Itemize
5246 \change_inserted 564990737 1670794716
5255 \begin_layout Itemize
5257 \change_inserted 564990737 1670794716
5266 \begin_layout Standard
5268 \change_inserted 564990737 1670794716
5271 If you want to use any of these commands, you have to enter them yourself.
5274 Do not forget to use
5280 nsert\SpecialChar menuseparator
5283 \begin_inset space ~
5292 \begin_layout Subsubsection
5294 \change_inserted 564990737 1670794716
5297 Figure and Table Floats
5300 \begin_layout Standard
5302 \change_inserted 564990737 1670794716
5306 provides support for the necessary float environments
5308 figure, figure*, table
5314 , therefore we won't tell much about it here.
5318 \begin_inset space ~
5324 Just remember that tables should be left-aligned.
5325 For that, select the table and change the alignment in
5330 dit\SpecialChar menuseparator
5336 \begin_inset space ~
5342 \begin_layout Standard
5344 \change_inserted 564990737 1670794716
5347 There is only one special thing: the figures with a caption beside the figure.
5348 To create such a figure, you have to do the following:
5351 \begin_layout Enumerate
5353 \change_inserted 564990737 1670794716
5356 Create a wide figure float:
5361 nsert\SpecialChar menuseparator
5366 t\SpecialChar menuseparator
5369 , then, from within the float, use the menu
5374 dit\SpecialChar menuseparator
5380 \begin_inset space ~
5391 \begin_inset space ~
5403 \begin_layout Enumerate
5405 \change_inserted 564990737 1670794716
5408 Enter your caption text.
5411 \begin_layout Enumerate
5413 \change_inserted 564990737 1670794716
5420 to move the cursor above the caption.
5423 \begin_layout Enumerate
5425 \change_inserted 564990737 1670794716
5431 \begin_layout Enumerate
5433 \change_inserted 564990737 1670794716
5436 Position the cursor after the figure and insert a horizontal fill by using
5442 nsert\SpecialChar menuseparator
5447 rmatting\SpecialChar menuseparator
5453 \begin_inset space ~
5462 dialog and select the
5476 \begin_layout Enumerate
5478 \change_inserted 564990737 1670794716
5481 Switch to \SpecialChar LaTeX
5485 \begin_inset space ~
5493 \begin_layout Enumerate
5495 \change_inserted 564990737 1670794716
5506 Do not close the brace!
5509 \begin_layout Enumerate
5511 \change_inserted 564990737 1670794716
5514 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5519 \begin_inset space ~
5531 \begin_layout Standard
5533 \change_inserted 564990737 1670794716
5536 Also, refer to the figures in the file
5547 \begin_layout Subsubsection
5549 \change_inserted 564990737 1670794716
5555 \begin_layout Standard
5557 \change_inserted 564990737 1670794716
5560 For submission, the paper has to be formatted in a special double-spacing
5562 For this purpose, you have to add the option
5573 \begin_inset space ~
5583 ocument\SpecialChar menuseparator
5588 ettings\SpecialChar menuseparator
5590 \begin_inset space ~
5599 \begin_layout Subsubsection
5601 \change_inserted 564990737 1670794716
5607 \begin_layout Standard
5609 \change_inserted 564990737 1670794716
5616 was written with \SpecialChar LyX
5618 It is the example paper from the original macro package,
5623 \begin_inset CommandInset href
5626 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
5631 , but translated to \SpecialChar LyX
5632 using the older unstructured abstract type.
5633 Use it for inspiration, and compare the \SpecialChar LaTeX
5638 with the \SpecialChar LyX
5642 \begin_layout Subsection
5647 \begin_layout Standard
5653 \begin_layout Subsubsection
5657 \begin_layout Standard
5659 is a set of macros produced by the American Astronomical Society to
5660 facilitate electronic manuscript submission to the three journals they
5661 publish: the Astrophysical Journal (including the Letters and Supplement),
5662 the Astronomical Journal, and the Publications of the Astronomical Society
5665 has proven to be an excellent tool for generating these documents, especially
5666 given its equation, citation, and figure handling capabilities.
5668 requires version 5.0 (or higher) of these macros; preferably 6.0, which
5669 is the version described here, or higher.
5670 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
5671 2.09 and are fundamentally
5672 incompatible with \SpecialChar LyX
5674 The AAS\SpecialChar TeX
5675 package may be downloaded from the AAS\SpecialChar TeX
5679 \begin_layout Standard
5680 \begin_inset VSpace medskip
5686 \begin_layout Standard
5688 \begin_inset Flex URL
5691 \begin_layout Plain Layout
5693 https://aas.org/aastex/aastex-downloads
5701 \begin_layout Standard
5702 \begin_inset VSpace medskip
5708 \begin_layout Standard
5709 A complete user guide is contained in that package and you should familiarize
5710 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
5713 will not reduce the need to figure out all the AAS\SpecialChar TeX
5714 commands, it will only
5715 reduce the drudgery of typing everything in.
5716 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
5718 completely to the requirements of the journal to which you are submitting
5722 \begin_layout Subsubsection
5723 Starting a New Paper
5726 \begin_layout Standard
5727 I strongly suggest that you start with the AAS\SpecialChar TeX
5731 File\SpecialChar menuseparator
5738 , enter the new file name, then choose the
5743 This will show the most common fields found in a manuscript.
5744 Simply overwrite the existing text (including the brackets,
5748 ) with the correct information.
5749 Many of the AAS\SpecialChar TeX
5750 commands and environments can be implemented directly in
5753 For commands such as these, the \SpecialChar LaTeX
5754 code must be entered directly and marked
5756 Such commands are referred to as \SpecialChar TeX
5757 code, or Evil Red Text.
5758 I tried to minimize the amount of \SpecialChar TeX
5759 code needed in an AAS\SpecialChar TeX
5763 \begin_layout Subsubsection
5764 Finishing Your Paper
5767 \begin_layout Standard
5768 When the paper is finished to your satisfaction and previews/prints correctly,
5770 \begin_inset Quotes eld
5774 \begin_inset Quotes erd
5777 actions which need to be done before you submit it to the journals.
5781 \begin_layout Enumerate
5782 Export your paper as a \SpecialChar LaTeX
5785 File\SpecialChar menuseparator
5786 Export\SpecialChar menuseparator
5794 \begin_layout Enumerate
5799 file with your favorite text editor
5803 \begin_layout Enumerate
5804 remove the comment lines before the
5813 \begin_layout Enumerate
5818 usepackage...{fontenc}
5820 line if it appears (usually just after
5835 \begin_layout Enumerate
5836 remove everything between (and including) the
5848 commands, except for any commands you specifically put into the \SpecialChar LaTeX
5850 (which should appear immediately after the
5851 \begin_inset Quotes eld
5854 User specified \SpecialChar LaTeX
5856 \begin_inset Quotes erd
5867 \begin_layout Enumerate
5868 Run the resulting file through \SpecialChar LaTeX
5869 to make sure it still processes correctly.
5872 \begin_layout Enumerate
5873 Reread the journal requirements to make sure your filenames and formats
5877 \begin_layout Enumerate
5881 \begin_layout Subsubsection
5882 Comments On Specific Commands
5885 \begin_layout Standard
5886 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
5893 ) gives a good description of each.
5894 Thus it's probably easiest for me to go down the list as found in the guide
5895 and offer comments where necessary.
5896 So let's begin \SpecialChar ldots
5900 \begin_layout Paragraph
5901 Things that work as expected
5904 \begin_layout Standard
5905 Because they work as you might expect, I simply list them and the section
6006 begin{thebibliography}
6014 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6015 graphicx figure commands (2.14.1),
6039 (2.15.4, amongst other places),
6066 \begin_layout Standard
6067 The following style options also work correctly:
6088 Simply put them in the
6094 Layout\SpecialChar menuseparator
6100 \begin_layout Paragraph
6101 Things that work, but require more comment
6104 \begin_layout Standard
6105 The following items work, but require a little more discussion:
6108 \begin_layout Itemize
6109 These items are reserved for use by the journal editors, but you can put
6110 them into the \SpecialChar LaTeX
6111 preamble if you feel compelled to do so:
6144 \begin_layout Itemize
6145 These items may be placed in the \SpecialChar LaTeX
6146 preamble, and are included as blanks in
6168 \begin_layout Itemize
6175 (2.3) – can only be used
6176 \begin_inset Quotes eld
6180 \begin_inset Quotes erd
6183 , not in the middle of a paragraph.
6184 Use \SpecialChar TeX
6185 code if you need to embed it.
6188 \begin_layout Itemize
6195 (2.3) – will have extra {} after it.
6196 This should not cause an error.
6199 \begin_layout Itemize
6206 (2.6) – can only be used
6207 \begin_inset Quotes eld
6211 \begin_inset Quotes erd
6214 , not in the middle of a paragraph.
6215 Use \SpecialChar TeX
6216 code if you need to embed it.
6219 \begin_layout Itemize
6226 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6230 \begin_layout Itemize
6244 \begin_layout Itemize
6251 (2.9) – will have extra {} after it.
6252 This should not cause an error.
6255 \begin_layout Itemize
6262 (2.11) – will have extra {} after it.
6263 This should not cause an error.
6266 \begin_layout Itemize
6273 (2.14.2) – you can insert an optional filename argument by placing the cursor
6274 at the beginning of the text and selecting
6276 Insert\SpecialChar menuseparator
6281 \begin_inset Quotes eld
6285 \begin_inset Quotes erd
6288 inserts an optional argument of the type needed by
6295 Hopefully it will be renamed someday.
6298 \begin_layout Itemize
6311 for the catalog ID optional parameter
6314 \begin_layout Itemize
6327 for the catalog ID optional parameter
6330 \begin_layout Paragraph
6331 Things not implemented, use \SpecialChar TeX
6335 \begin_layout Standard
6346 setcounter{equation}
6348 (2.12), Journal name abbreviations (2.13.4),
6384 (2.15.4, insert it as the first element in the lefthand cell after where
6386 Don't use any of \SpecialChar LyX
6387 's rules in the table),
6399 (2.15.5), much of Misc (2.17, except
6450 \begin_layout Paragraph
6451 Things that cannot be implemented
6454 \begin_layout Standard
6456 at least in any meaningful sort of way, so I suggest ignoring them.
6457 They are the references environment (2.13.3), and the deluxetable environment
6459 If you really, really need to use deluxetable, I suggest editing it in
6460 a separate file with a text editor, then using
6462 Insert\SpecialChar menuseparator
6464 \begin_inset space ~
6469 to include it in your \SpecialChar LyX
6475 file to see an example of this.
6478 \begin_layout Subsubsection
6479 FAQs, Tips, Tricks, and Other Ruminations
6482 \begin_layout Paragraph
6483 Getting \SpecialChar LyX
6484 and AAS\SpecialChar TeX
6488 \begin_layout Standard
6489 It can be a bit tricky to get \SpecialChar LyX
6490 to recognize a new layout and document class.
6491 When all else fails, do this:
6494 \begin_layout Enumerate
6495 Make certain that \SpecialChar LaTeX
6496 can find AAS\SpecialChar TeX
6498 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6500 directory completely unrelated to \SpecialChar LaTeX
6501 or AAS\SpecialChar TeX
6502 and run \SpecialChar LaTeX
6510 \begin_layout Enumerate
6515 appears in \SpecialChar LyX
6523 \begin_layout Enumerate
6526 Tools\SpecialChar menuseparator
6530 , then restart \SpecialChar LyX
6534 \begin_layout Enumerate
6535 Open a regular new file, not from a template.
6536 Does AAS\SpecialChar TeX
6537 appear in the class list in
6539 Document\SpecialChar menuseparator
6545 \begin_layout Standard
6546 If you get a warning from an existing AAS\SpecialChar TeX
6547 document about not being able
6548 to find the AAS\SpecialChar TeX
6549 layout or a message about
6550 \begin_inset Quotes eld
6553 You should not mix title layouts with normal ones
6554 \begin_inset Quotes erd
6557 , things haven't been installed correctly.
6560 \begin_layout Paragraph
6562 error processing a table
6565 \begin_layout Standard
6567 , by default, attempts to center the table caption/title.
6568 This seems to produce a bad interaction in AAS\SpecialChar TeX
6569 so you should click somewhere
6570 in the caption/title, then select
6572 Edit\SpecialChar menuseparator
6574 \begin_inset space ~
6588 This took care of it for me.
6591 \begin_layout Paragraph
6595 \begin_layout Standard
6596 A couple of things: 1) I have noticed some funny spacing in the reference
6597 entries in the text.
6598 When you enter the bibliography item data, make sure their is
6602 space between the last author and the parenthesis setting off the year;
6606 \begin_inset space \thinspace{}
6610 \begin_inset space \space{}
6624 2) Entering the references at all is not obvious.
6625 The easiest thing is to start typing your first reference at the end of
6626 the document, then mark it as type
6631 That will put a small gray box in front of what you just typed.
6632 Click on the box to fill in the rest of the information.
6633 For new references, go to the end of an existing reference and press return.
6634 That will create a new line with its own box, etc.
6637 \begin_layout Paragraph
6641 \begin_layout Standard
6642 Even though AAS\SpecialChar TeX
6643 provides its own figure commands (
6649 , for example), I much prefer \SpecialChar LaTeX
6650 's standard figure commands (with the default
6659 \begin_inset space ~
6662 commands as \SpecialChar TeX
6663 code into a Figure Float box if you desire, but I never have
6664 much luck getting the layout right.
6665 With the standard graphics, \SpecialChar LyX
6670 usepackage{graphicx}
6672 command into the \SpecialChar LaTeX
6673 preamble and handle the figures in the standard \SpecialChar LaTeX2e
6675 interspersing the figures in the text.
6676 I believe ApJ accepts figures exactly this way now; AJ might still use
6678 \begin_inset Quotes eld
6681 stack everything at the end
6682 \begin_inset Quotes erd
6688 \begin_layout Paragraph
6689 Things I could have done, but didn't
6692 \begin_layout Standard
6694 \begin_inset Quotes eld
6698 \begin_inset Quotes erd
6701 things I could have implemented, but chose not to.
6702 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
6704 even though it is double-spaced in the paper manuscript.
6705 Also, I chose not to make separate layouts for the preprint and preprint2
6707 Since I assume you will spend most of your time in the plain manuscript
6708 mode anyway, I decided not to chew up more disk space with this.
6712 \begin_layout Subsubsection
6716 \begin_layout Standard
6717 Your mileage may vary.
6718 I've now had papers published by both ApJ and AJ that have had 98% of the
6719 effort done in \SpecialChar LyX
6720 ; the last 2% was the \SpecialChar LaTeX
6721 post-processing and a few cleanups.
6722 I have had no trouble with the submission process, and I'm sure the journals
6723 were never aware that there might be a difference.
6724 So, go forth and publish!
6727 \begin_layout Section
6729 \change_inserted 564990737 1670439560
6733 \begin_layout Standard
6735 \change_inserted 564990737 1670439581
6736 See also the document classes in the Collections (section
6737 \begin_inset space ~
6741 \begin_inset CommandInset ref
6743 reference "sec:Collections"
6750 \begin_layout Subsection
6754 \begin_layout Standard
6760 \begin_layout Subsubsection
6764 \begin_layout Standard
6765 Memoir is a very powerful and constantly evolving class.
6766 It has been designed with regard to fictional and non-fictional literature.
6767 Its aim is to let the user have maximum control over the typesetting of
6769 Memoir is based on the standard book class, but it can also emulate the
6770 article class (see below).
6773 \begin_layout Standard
6774 Peter Wilson, the developer of Memoir, is known as the author of lots of
6775 useful packages in the \SpecialChar LaTeX
6777 Most of them have been merged with Memoir.
6778 Therefore, it is much easier to layout the table of contents, appendices,
6779 chapter designs and such.
6781 , though, does not support all of these goodies natively.
6782 Some of them might be added to forthcoming releases
6786 \begin_layout Plain Layout
6787 You are invited to send suggestions to
6788 \begin_inset Flex URL
6791 \begin_layout Plain Layout
6793 lyx-devel@lists.lyx.org
6803 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
6805 Of course you can still use all features with the help of some native \SpecialChar LaTeX
6807 commands (\SpecialChar TeX
6812 \begin_layout Plain Layout
6817 \begin_layout Plain Layout
6827 \begin_inset space ~
6831 \begin_inset CommandInset ref
6833 reference "sec:Inserting-TeX-Code"
6843 In this section, we can only list those features that are natively supported
6846 For detailed descriptions (and for the rest of features) we recommend you
6847 have a look at the detailed manual of the Memoir class
6851 \begin_layout Plain Layout
6856 \begin_layout Plain Layout
6866 \begin_inset Flex URL
6869 \begin_layout Plain Layout
6871 CTAN:/macros/latex/memoir/memman.pdf
6881 , which is not only a user guide for the class, but also both a comprehensive
6882 description on good typesetting and a superb example for good typesetting
6886 \begin_layout Subsubsection
6887 Basic features and restrictions
6890 \begin_layout Standard
6891 Memoir supports basically all features of the standard book classes.
6892 There are, however, some differences, as follows:
6895 \begin_layout Description
6897 \begin_inset space ~
6900 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
6903 \begin_layout Description
6905 \begin_inset space ~
6908 style: The fancy page style is not supported, due to a command clash between
6909 Memoir and the fancyhdr package (they both define a command with the same
6910 name, which confuses \SpecialChar LaTeX
6912 Instead, Memoir comes with a number of its own page styles (see
6914 Document\SpecialChar menuseparator
6915 Settings\SpecialChar menuseparator
6917 \begin_inset space ~
6923 If you want to use these for the chapter pages, you have to use the command
6930 in the main text or in preamble (e.
6931 \begin_inset space \thinspace{}
6935 \begin_inset space \space{}
6942 chapterstyle{companion}
6947 \begin_layout Description
6948 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
6949 optional argument in the standard classes.
6950 With this, you can specify an alternative version of the title for the
6951 table of contents and the headers (for instance, if the title is too long).
6953 , you can do this via
6955 Insert\SpecialChar menuseparator
6957 \begin_inset space ~
6962 at the beginning of a chapter/section.
6963 Memoir features a second optional argument and thus separates the table
6964 of contents from the header.
6965 You can define three variants of a title with this: one for the main text,
6966 one for the table of contents, and one for the headers.
6968 makes these available in form of specific
6979 \begin_layout Description
6980 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
6981 of contents, the list of figures and the list of table start a new page
6983 Memoir does not follow this route.
6984 You have to insert a page break yourself, if you want to have one.
6987 \begin_layout Description
6988 Titlepage: For some unknown reason, Memoir uses pagination on the title
6989 page (in the standard classes, title pages are
6990 \begin_inset Quotes eld
6994 \begin_inset Quotes erd
6998 If you want an empty title page, type
7002 aliaspagestyle{title}{empty}
7007 \begin_layout Description
7008 Article: With the class option
7014 Document\SpecialChar menuseparator
7015 Settings\SpecialChar menuseparator
7016 Class Settings\SpecialChar menuseparator
7018 \begin_inset space ~
7023 ), you can emulate article style.
7024 That is, counters (footnotes, figures, tables etc.) will not be reset on
7025 new chapters, chapters don't start a new page (but are—in contrary to
7026 \begin_inset Quotes eld
7030 \begin_inset Quotes erd
7033 article classes—still allowed), parts, though, use their own page, as in
7037 \begin_layout Description
7038 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
7039 font commands, which have been used in the old \SpecialChar LaTeX
7041 \begin_inset space \thinspace{}
7045 \begin_inset space \space{}
7061 It produces an error and stops \SpecialChar LaTeX
7062 whenever such a command appears.
7067 reallows the commands and spits out warnings instead (which does at least
7068 not stop \SpecialChar LaTeX
7070 Since a lot of packages and particularly Bib\SpecialChar TeX
7071 style files are still using
7072 those commands, we have decided to use this option by default.
7075 \begin_layout Subsubsection
7079 \begin_layout Standard
7080 We will only describe the features supported by \SpecialChar LyX
7081 (which is not much currently).
7082 Please consult the Memoir manual
7086 \begin_layout Plain Layout
7091 \begin_layout Plain Layout
7101 \begin_inset Flex URL
7104 \begin_layout Plain Layout
7106 CTAN:/macros/latex/memoir/memman.pdf
7119 \begin_layout Description
7120 Abstract: You may wonder why an abstract is an extra feature.
7121 Well, it is in book class.
7122 Usually books don't have abstracts.
7123 Memoir, however, has.
7124 You can use it wherever and how often you like.
7127 \begin_layout Description
7128 Chapterprecis: You may know this older typesetting style: The contents of
7129 a chapter are summarized below the title and also in the table of contents
7131 \begin_inset space \thinspace{}
7135 \begin_inset space \space{}
7140 Our hero arrives in Troia; he loses some friends; he finds others
7143 Chapterprecis does exactly this.
7144 It is therefore only sensible below a chapter.
7147 \begin_layout Description
7148 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
7149 The epigraph environment provides an elegant way of typesetting such a
7151 The motto itself (text) and its (optional) author (source) are divided
7153 The author (source) can be inserted via
7155 Insert\SpecialChar menuseparator
7162 \begin_layout Description
7163 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
7164 complex figurative poems).
7166 can only support a few of them.
7167 One is poemtitle, which is a centered title for poems, which will also
7168 be added to the table of contents (verse is the standard environment for
7170 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
7172 because they have to be nested inside regular verse environments, which
7173 is not possible with \SpecialChar LyX
7177 \begin_layout Description
7178 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
7181 \begin_layout Section
7183 \change_inserted 564990737 1670439605
7187 \begin_layout Section
7189 \change_inserted 564990737 1670439627
7193 \begin_layout Section
7195 \change_inserted 564990737 1670439660
7199 \begin_layout Section
7201 \change_inserted 564990737 1670439661
7205 \begin_layout Subsection
7207 \change_inserted 564990737 1670439661
7211 \begin_layout Standard
7213 \change_inserted 564990737 1670439661
7222 document class for preparing reports.
7227 document class, this provides parts, chapters and sections but does not
7228 provide the paragraph styles needed for a book; like the
7232 document class, it provides the abstract paragraph style.
7233 In two-sided mode, it does not start a new chapter on the right hand page.
7236 \begin_layout Standard
7238 \change_inserted 564990737 1670439674
7243 document classes are described in the Collections (section
7244 \begin_inset space ~
7248 \begin_inset CommandInset ref
7250 reference "sec:Collections"
7257 \begin_layout Section
7259 \change_inserted 564990737 1670439674
7263 \begin_layout Subsection
7267 \begin_layout Standard
7273 \begin_layout Subsubsection
7277 \begin_layout Standard
7278 Broadway is for writing plays.
7279 The format is more decorative than Hollywood, and much less standardized.
7280 This format should be suitable for workshops.
7283 \begin_layout Subsubsection
7287 \begin_layout Standard
7288 The same as in Hollywood.
7291 \begin_layout Subsubsection
7295 \begin_layout Standard
7300 names as labels then cross-reference the label to insert the name.
7301 The cross-reference dialog will show the current cast of characters.
7304 \begin_layout Subsubsection
7305 Paper size and Margins
7308 \begin_layout Standard
7309 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
7312 \begin_layout Subsubsection
7316 \begin_layout Standard
7317 The following environments are available.
7318 You can use broadway.bind to get the bind keys shown at the right.
7321 \begin_layout Itemize
7325 \begin_inset Newline newline
7330 You should not have to use this, but it is here for anything that does not
7334 \begin_layout Itemize
7338 \begin_inset space \hfill{}
7342 \begin_inset Newline newline
7347 Used to describe stage setting and the action.
7348 First use of speaker names in all CAPs.
7351 \begin_layout Itemize
7355 \begin_inset space \hfill{}
7359 \begin_inset Newline newline
7364 Automatically numbered.
7365 On screen it will be arabic, but will print as Roman.
7368 \begin_layout Itemize
7372 \begin_inset space \hfill{}
7376 \begin_inset Newline newline
7386 It is just centered text.
7389 \begin_layout Itemize
7393 \begin_inset space \hfill{}
7397 \begin_inset Newline newline
7402 Not automatically numbered.
7403 You supply the number.
7404 This is because I couldn't figure out how.
7407 \begin_layout Itemize
7411 \begin_inset space \hfill{}
7415 \begin_inset Newline newline
7420 A special case of Narrative to describe the setting and action as the curtain
7424 \begin_layout Itemize
7428 \begin_inset space \hfill{}
7432 \begin_inset Newline newline
7437 The speaker's (actor's) title, centered in all CAPS.
7440 \begin_layout Itemize
7444 \begin_inset space \hfill{}
7448 \begin_inset Newline newline
7453 Instructions to the speaker.
7454 The parentheses are automatically inserted.
7455 The ( will appear on screen, but both will be in the printed play.
7456 This environment is only used within
7463 \begin_layout Itemize
7467 \begin_inset space \hfill{}
7471 \begin_inset Newline newline
7476 What the Speaker says.
7479 \begin_layout Itemize
7483 \begin_inset space \hfill{}
7487 \begin_inset Newline newline
7492 The curtain comes down.
7495 \begin_layout Itemize
7499 \begin_inset space \hfill{}
7505 \begin_layout Itemize
7509 \begin_inset space \hfill{}
7515 \begin_layout Itemize
7519 \begin_inset space \hfill{}
7525 \begin_layout Standard
7529 \begin_layout Subsection
7530 Hollywood (Hollywood spec scripts)
7533 \begin_layout Standard
7539 \begin_layout Subsubsection
7543 \begin_layout Standard
7544 Getting the format of a Hollywood script right is a
7545 \begin_inset Quotes eld
7549 \begin_inset Quotes erd
7552 It is designed to make the readers focus on content and to be easy and
7553 familiar for the actors to read.
7554 Each page of a script should be one minute of film.
7555 Nothing goes in a script that you cannot see or hear on screen.
7556 The courier 12 pt font should be used throughout.
7560 \begin_layout Subsubsection
7564 \begin_layout Standard
7565 Speakers' lines should NEVER break in mid-sentence.
7566 If a speaker's lines continue over a page break, repeat the
7570 title followed by (Cont'd).
7573 \begin_layout Subsubsection
7577 \begin_layout Standard
7582 names as labels then cross-reference the label to insert the name.
7583 The cross-reference dialog will show the current cast of characters.
7584 You can use this to insert the speaker name in narratives also.
7587 \begin_layout Subsubsection
7588 Paper size and Margins
7591 \begin_layout Standard
7592 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
7595 \begin_layout Subsubsection
7599 \begin_layout Standard
7600 The following environments are available.
7601 You can use hollywood.bind to get the bind keys shown at the right.
7604 \begin_layout Itemize
7608 \begin_inset Newline newline
7613 Used where nothing else works.
7617 \begin_layout Itemize
7623 \begin_inset space \hfill{}
7631 \begin_inset Newline newline
7634 Usually followed by something like
7635 \begin_inset Quotes eld
7639 \begin_inset Quotes erd
7645 \begin_layout Itemize
7649 \begin_inset space \hfill{}
7653 \begin_inset Newline newline
7658 Introduces a new INTERIOR camera set-up.
7659 Always followed by DAY or NIGHT, or something similar to define the lighting
7661 Everthing on this line in CAPS.
7664 \begin_layout Itemize
7668 \begin_inset space \hfill{}
7672 \begin_inset Newline newline
7677 Introduces a new EXTERIOR camera set-up.
7678 Everthing on this line in CAPS.
7681 \begin_layout Itemize
7685 \begin_inset space \hfill{}
7689 \begin_inset Newline newline
7694 The character speaking.
7697 \begin_layout Itemize
7701 \begin_inset space \hfill{}
7705 \begin_inset Newline newline
7710 Instructions to the speaker.
7711 The () are automatically inserted.
7714 \begin_layout Itemize
7718 \begin_inset space \hfill{}
7722 \begin_inset Newline newline
7734 \begin_layout Itemize
7738 \begin_inset space \hfill{}
7742 \begin_inset Newline newline
7747 Camera movement instruction.
7749 \begin_inset space \thinspace{}
7753 \begin_inset space \space{}
7759 \begin_layout Itemize
7763 \begin_inset space \hfill{}
7769 \begin_layout Itemize
7773 \begin_inset space \hfill{}
7779 \begin_layout Itemize
7783 \begin_inset space \hfill{}
7789 \begin_layout Itemize
7793 \begin_inset space \hfill{}
7799 \begin_layout Subsubsection
7803 \begin_layout Itemize
7807 \begin_layout Itemize
7811 \begin_layout Itemize
7813 \begin_inset space \thinspace{}
7820 \begin_layout Itemize
7825 \begin_layout Itemize
7826 PAN — camera movement
7829 \begin_layout Itemize
7830 INSERT — cut to close-up of
7833 \begin_layout Chapter
7837 \begin_layout Section
7838 Customizing Bibliographies with Bib\SpecialChar TeX
7842 \begin_layout Standard
7843 The most basic information about how to use Bib\SpecialChar TeX
7848 with \SpecialChar LyX
7849 is contained in the section
7851 Bibliography databases
7858 The following subsections explain special bibliography features supported
7863 \begin_layout Subsection
7864 Alternative Citation Styles
7867 \begin_layout Standard
7868 Standard Bib\SpecialChar TeX
7870 \begin_inset space \thinspace{}
7874 \begin_inset space \space{}
7878 \begin_inset Quotes eld
7882 \begin_inset Quotes erd
7885 ) to refer to a cited work.
7886 However, in many scientific disciplines, other citation styles are in use.
7887 The most common one is the author-year style (e.
7888 \begin_inset space \thinspace{}
7892 \begin_inset space \space{}
7896 \begin_inset Quotes eld
7900 \begin_inset Quotes erd
7905 supports three packages that provide this style,
7906 \begin_inset Flex Code
7909 \begin_layout Plain Layout
7916 \begin_inset Flex Code
7919 \begin_layout Plain Layout
7926 \begin_inset Flex Code
7929 \begin_layout Plain Layout
7936 Each of these packages has their pros and cons, which cannot be listed
7938 If you only want to have simple author-year (or author-numerical) style,
7939 or if you want to use one of the countless style files for
7940 \begin_inset Flex Code
7943 \begin_layout Plain Layout
7949 , then the established
7950 \begin_inset Flex Code
7953 \begin_layout Plain Layout
7959 package is probably your choice.
7960 If you look for specific citation styles common in law studies, you might
7962 \begin_inset Flex Code
7965 \begin_layout Plain Layout
7972 If you want to have full control over the formatting or look for advanced
7973 features such as ibidem, footnote citations, full title citations, advanced
7974 date formats (such as 400 BC) or full localization to other languages than
7975 English, you should definitely consider
7976 \begin_inset Flex Code
7979 \begin_layout Plain Layout
7985 , which exceeds all other packages in terms of features, but is also quite
7986 heavy and more resource-hungry.
7989 \begin_layout Standard
7990 The handling of these packages in \SpecialChar LyX
7991 is basically the same.
7993 \begin_inset Flex Noun
7996 \begin_layout Plain Layout
7997 Document\SpecialChar menuseparator
8004 \begin_inset Flex Noun
8007 \begin_layout Plain Layout
8014 \begin_inset Flex Noun
8017 \begin_layout Plain Layout
8024 \begin_inset Flex Noun
8027 \begin_layout Plain Layout
8034 \begin_inset Flex Noun
8037 \begin_layout Plain Layout
8044 \begin_inset Flex Noun
8047 \begin_layout Plain Layout
8048 Biblatex (Natbib mode)
8054 \begin_inset Flex Noun
8057 \begin_layout Plain Layout
8064 \begin_inset Flex Noun
8067 \begin_layout Plain Layout
8074 \begin_inset space ~
8077 6.5.3 in the User's Guide for more information on these choices).
8078 With all these packages, you will get some extra features in the citation
8079 dialog and you can select the style of the reference (
8080 \begin_inset Quotes eld
8084 \begin_inset Quotes erd
8088 \begin_inset Quotes eld
8092 \begin_inset Quotes erd
8096 \begin_inset Quotes eld
8100 \begin_inset Quotes erd
8104 \begin_inset Quotes eld
8108 \begin_inset Quotes erd
8112 Note that either package needs specifically designed style files.
8113 They all ship their own, but there are lots of additional style files,
8114 and there is even an interactive style file builder
8118 \begin_layout Plain Layout
8120 \begin_inset Flex URL
8123 \begin_layout Plain Layout
8125 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
8136 \begin_inset Flex Code
8139 \begin_layout Plain Layout
8148 \begin_layout Subsection
8149 Subdivided Bibliographies
8152 \begin_layout Standard
8153 Sometimes you might need to divide your bibliography into several sections.
8154 If you are for instance a historian, the possibility to separate sources
8155 and scientific works is most likely a
8156 \begin_inset Quotes eld
8160 \begin_inset Quotes erd
8164 Unfortunately, Bib\SpecialChar TeX
8165 itself does not allow you to do this.
8166 But with the help of some \SpecialChar LaTeX
8167 packages, Bib\SpecialChar TeX
8168 can be extended to fit your needs.
8171 \begin_layout Standard
8173 provides native support for one of these packages,
8181 \begin_layout Plain Layout
8183 \begin_inset Flex URL
8186 \begin_layout Plain Layout
8188 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
8198 The advantage of this package (compared to other packages such as
8202 ) is that you don't need to define new citation commands.
8203 Instead, you need to prepare different bibliographic databases which include
8204 the entries for the different sections of the bibliography.
8205 For example: If you want to divide your bibliography into the sections
8207 \begin_inset Quotes eld
8211 \begin_inset Quotes erd
8215 \begin_inset Quotes eld
8219 \begin_inset Quotes erd
8222 , you first need to create two bibliographic databases, e.
8223 \begin_inset space \thinspace{}
8227 \begin_inset space \space{}
8231 \begin_inset Flex Code
8234 \begin_layout Plain Layout
8241 \begin_inset Flex Code
8244 \begin_layout Plain Layout
8254 \begin_layout Standard
8256 \begin_inset Flex Noun
8259 \begin_layout Plain Layout
8260 Document\SpecialChar menuseparator
8267 \begin_inset Flex Noun
8270 \begin_layout Plain Layout
8277 \begin_inset Flex Noun
8280 \begin_layout Plain Layout
8281 Subdivided bibliography
8287 Now you can insert multiple Bib\SpecialChar TeX
8288 bibliographies, one for each section of
8290 Returning to our example: Insert the Bib\SpecialChar TeX
8292 \begin_inset Flex Code
8295 \begin_layout Plain Layout
8301 and a second one for the database
8302 \begin_inset Flex Code
8305 \begin_layout Plain Layout
8312 You are free to use the same or different styles for each section.
8313 Additionally, you can choose if the bibliography section should contain
8315 \begin_inset Quotes eld
8318 all cited references
8319 \begin_inset Quotes erd
8322 of the specified database(s) (which is the default),
8323 \begin_inset Quotes eld
8326 all uncited references
8327 \begin_inset Quotes erd
8331 \begin_inset Quotes eld
8335 \begin_inset Quotes erd
8339 This might be useful if you would like to separate your bibliography into
8341 \begin_inset Quotes eld
8345 \begin_inset Quotes erd
8349 \begin_inset Quotes eld
8353 \begin_inset Quotes erd
8357 \begin_inset Quotes eld
8361 \begin_inset Quotes erd
8365 The titles for the sections can be added as ordinary sections or subsections.
8367 \begin_inset Flex Code
8370 \begin_layout Plain Layout
8376 removes the bibliography title, you have to manually re-add that, too (as
8377 a chapter* or section*, for instance).
8380 \begin_layout Standard
8385 , the procedure is a bit different.
8394 , the aforementioned
8395 \begin_inset Flex Noun
8398 \begin_layout Plain Layout
8399 Subdivided bibliography
8404 option is disabled if you use
8413 provides its own means to generate subdivided bibliographies.
8414 You can either add keywords to bibliography entries via the
8415 \begin_inset Flex Code
8418 \begin_layout Plain Layout
8424 entry option and then filter bibliography sections by keyword (by adding
8426 \begin_inset Flex Code
8429 \begin_layout Plain Layout
8436 \begin_inset Flex Noun
8439 \begin_layout Plain Layout
8445 field of the dialog that opens if you left-click on the
8446 \begin_inset Flex Noun
8449 \begin_layout Plain Layout
8450 Biblatex Generated Bibliography
8455 button), or you can filter by entry types (such as
8464 \begin_inset space \thinspace{}
8469 \begin_inset Flex Code
8472 \begin_layout Plain Layout
8479 \begin_inset Flex Code
8482 \begin_layout Plain Layout
8489 \begin_inset Flex Noun
8492 \begin_layout Plain Layout
8498 field, or you can create so-called
8499 \begin_inset Quotes eld
8502 Bibliography Categories
8503 \begin_inset Quotes erd
8506 to which you can assign individual entries.
8507 Please refer to the Biblatex manual, section
8509 Subdivided Bibliographies
8514 \begin_layout Subsection
8515 Multiple Bibliographies
8516 \begin_inset CommandInset label
8518 name "subsec:Multiple-Bibliographies"
8525 \begin_layout Standard
8526 Multiple bibliographies, e.
8527 \begin_inset space \thinspace{}
8531 \begin_inset space \space{}
8534 a bibliography for each part, chapter, section, subsection or child (sub-documen
8535 t) of the document, are also supported by \SpecialChar LyX
8537 In order to enable it, go to
8538 \begin_inset Flex Noun
8541 \begin_layout Plain Layout
8542 Document\SpecialChar menuseparator
8543 Settings\SpecialChar menuseparator
8549 and select the relevant unit (e.
8550 \begin_inset space \thinspace{}
8554 \begin_inset Quotes eld
8558 \begin_inset Quotes erd
8562 \begin_inset Flex Noun
8565 \begin_layout Plain Layout
8566 Multiple Bibliographies
8572 Then add a Bib(la)\SpecialChar TeX
8573 bibliography to each unit (e.
8574 \begin_inset space \thinspace{}
8577 g., section) of your document.
8578 In the output, a separate bibliography, containing only the references
8579 done in the current unit is generated.
8582 \begin_layout Standard
8583 If you use Bib\SpecialChar TeX
8585 \begin_inset Flex Code
8588 \begin_layout Plain Layout
8595 \begin_inset Flex Code
8598 \begin_layout Plain Layout
8604 package is used to create multiple bibliographies.
8605 The former package is used if you select
8606 \begin_inset Quotes eld
8610 \begin_inset Quotes erd
8618 \begin_inset Flex Noun
8621 \begin_layout Plain Layout
8622 Sectioned Bibliography
8629 \begin_inset Flex Code
8632 \begin_layout Plain Layout
8642 \begin_layout Plain Layout
8643 An alternative approach, if you are willing to use some
8644 \begin_inset Flex Noun
8647 \begin_layout Plain Layout
8655 \begin_inset space ~
8659 \begin_inset CommandInset ref
8661 reference "sec:Inserting-TeX-Code"
8666 \begin_inset Flex Code
8669 \begin_layout Plain Layout
8681 \begin_inset Flex Code
8684 \begin_layout Plain Layout
8690 is used, \SpecialChar LyX
8691 encloses the specified units in
8692 \begin_inset Flex Code
8695 \begin_layout Plain Layout
8702 \begin_inset Flex Code
8705 \begin_layout Plain Layout
8714 \begin_inset Flex Code
8717 \begin_layout Plain Layout
8725 in order to create the units.
8726 Note that this approach has some limitations.
8727 First, every citation reference has to be inside some
8728 \begin_inset Flex Code
8731 \begin_layout Plain Layout
8738 So citations outside a defined unit (e.
8739 \begin_inset space \thinspace{}
8742 g., before the first section if you use
8743 \begin_inset Quotes eld
8747 \begin_inset Quotes erd
8751 \begin_inset Quotes eld
8755 \begin_inset Quotes erd
8759 You can also create your own units by entering
8760 \begin_inset Flex Code
8763 \begin_layout Plain Layout
8772 \begin_inset Flex Code
8775 \begin_layout Plain Layout
8784 code (for instance to work around the mentioned limitation).
8786 \begin_inset Flex Code
8789 \begin_layout Plain Layout
8796 A second limitation is that
8797 \begin_inset Flex Code
8800 \begin_layout Plain Layout
8806 always processes all references of a bibliography database, even if they
8808 This can result in odd labels (e.
8809 \begin_inset space \thinspace{}
8814 \begin_inset Quotes eld
8818 \begin_inset Quotes erd
8821 if two works of this author from 2014 are in the database, even if only
8825 \begin_layout Standard
8831 \begin_inset Flex Code
8834 \begin_layout Plain Layout
8840 option is used instead.
8841 If you need specific units, you can start them with the \SpecialChar TeX
8843 \begin_inset Flex Code
8846 \begin_layout Plain Layout
8855 \begin_inset Flex Code
8858 \begin_layout Plain Layout
8867 If you also want to control the end of the unit, use the environment
8868 \begin_inset Flex Code
8871 \begin_layout Plain Layout
8881 \begin_inset Flex Code
8884 \begin_layout Plain Layout
8894 \begin_inset Flex Code
8897 \begin_layout Plain Layout
8904 In addition to the individual bibliography of the current unit,
8908 also provides an easy way to output all bibliographies, subsequently, at
8910 \begin_inset space \thinspace{}
8913 g., at the end of the document).
8915 \begin_inset Quotes eld
8919 \begin_inset Quotes erd
8922 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
8928 manual for more information on this topic.
8931 \begin_layout Section
8935 \begin_layout Subsection
8939 \begin_layout Standard
8940 When you are working on a large file with many sections, it is often convenient
8941 to break up the document into several files, or perhaps you have something
8942 where a table may change from time to time, but the preceding text does
8944 In these cases, you should seriously consider using multipart documents.
8945 For example, scientific papers often have five major sections: the introduction
8946 , observations, results, discussion, and conclusion.
8947 Each of these could be its own separate \SpecialChar LyX
8949 \begin_inset Quotes eld
8953 \begin_inset Quotes erd
8956 file which contains the title, authors, abstract, references, etc., plus
8957 the five included files.
8958 It is important to note that each of these files is a full \SpecialChar LyX
8960 can be formatted and printed on its own, as well as included in a master
8962 Each of these files must have the same document class, however—don't attempt
8963 to mix book classes with article classes.
8964 You may also include \SpecialChar LaTeX
8965 files; however, these files must not have their own
8967 \begin_inset space \thinspace{}
8971 \begin_inset space \space{}
8974 everything up to and including the
8975 \begin_inset Flex Code
8978 \begin_layout Plain Layout
8987 \begin_inset Flex Code
8990 \begin_layout Plain Layout
8998 line must be deleted) or else errors will be generated when you try to
9002 \begin_layout Standard
9004 allows you to include files quite easily with
9005 \begin_inset Flex Noun
9008 \begin_layout Plain Layout
9009 Insert\SpecialChar menuseparator
9011 \begin_inset space ~
9020 When you click on this selection a small box is inserted into the file
9021 at the current cursor location.
9022 Clicking on the box raises a dialog which allows you to select the file
9023 to be included, and the method of its inclusion.
9027 \begin_layout Standard
9028 The file selection box should by now be obvious.
9029 The three inclusion methods are
9030 \begin_inset Quotes eld
9034 \begin_inset Quotes erd
9038 \begin_inset Quotes eld
9042 \begin_inset Quotes erd
9046 \begin_inset Quotes eld
9050 \begin_inset Quotes erd
9055 \begin_inset Quotes eld
9059 \begin_inset Quotes erd
9063 \begin_inset Quotes eld
9067 \begin_inset Quotes erd
9070 are similar in many ways, but there are also some notable differences:
9073 \begin_layout Enumerate
9075 \begin_inset Quotes eld
9079 \begin_inset Quotes erd
9082 are typeset beginning on a new page, while files that are
9083 \begin_inset Quotes eld
9087 \begin_inset Quotes erd
9090 are typeset starting on the current page.
9093 \begin_layout Enumerate
9094 \begin_inset Quotes eld
9098 \begin_inset Quotes erd
9101 files cannot themselves
9102 \begin_inset Quotes eld
9106 \begin_inset Quotes erd
9110 \begin_inset Quotes eld
9114 \begin_inset Quotes erd
9119 \begin_inset Quotes eld
9123 \begin_inset Quotes erd
9126 , on the other hand, infinite sub-inputting is possible.
9129 \begin_layout Enumerate
9130 \begin_inset Quotes eld
9134 \begin_inset Quotes erd
9137 allow for the output of only selected
9138 \begin_inset Quotes eld
9142 \begin_inset Quotes erd
9145 files, while maintaining the actual counters (pagination etc.) and references
9146 (please refer to the section
9149 \begin_inset space ~
9157 \begin_inset space ~
9162 manual for details).
9165 \begin_layout Standard
9167 \begin_inset Quotes eld
9171 \begin_inset Quotes erd
9174 is the preferred method for chapters that are outsourced to child documents,
9176 \begin_inset Quotes eld
9180 \begin_inset Quotes erd
9183 is more suitable for arbitrary file inheritance.
9186 \begin_layout Standard
9188 \begin_inset Quotes eld
9192 \begin_inset Quotes erd
9195 included file allows you to include a file typeset exactly as it appears
9197 \begin_inset space \thinspace{}
9201 \begin_inset space \space{}
9205 \begin_inset Flex Code
9208 \begin_layout Plain Layout
9214 mode, with the characters set in a fixed-width typewriter font.
9215 Normally, spaces in this file are invisible, though two consecutive spaces
9216 are conserved, unlike \SpecialChar LyX
9217 's normal treatment of spaces.
9218 However, setting the
9219 \begin_inset Flex Noun
9222 \begin_layout Plain Layout
9224 \begin_inset space ~
9228 \begin_inset space ~
9232 \begin_inset space ~
9240 checkbox typesets a mark to unambiguously define the presence of a space.
9244 \begin_layout Standard
9245 Generally, the master file is converted into a full \SpecialChar LaTeX
9246 file before typesetting,
9247 while the included files are converted to \SpecialChar LaTeX
9248 files that do not have all the
9249 preamble information.
9252 \begin_layout Subsection
9253 Cross-References Between Files
9256 \begin_layout Standard
9257 \begin_inset Box Shadowbox
9267 height_special "totalheight"
9272 backgroundcolor "none"
9275 \begin_layout Plain Layout
9276 This section is somewhat out of date.
9277 Need to describe default master documents and how children are opened when
9287 \begin_layout Standard
9288 It is possible to set up cross-references between the different files.
9289 First, open all the files in question: let's call them A and B in a two
9290 file example, where B is included in A.
9291 Let's say you insert a label in A, then want to reference it in B.
9292 Open the cross-reference dialog whilst in document B, and you can select
9294 \begin_inset Quotes eld
9298 \begin_inset Quotes erd
9304 \begin_layout Subsection
9305 Bibliography Lists in all Subdocuments
9308 \begin_layout Standard
9309 If you work with child documents, you might want to have only one main bibliogra
9310 phy at the end, but still be able to have a selected bibliography for the
9311 child if you output it on its own.
9312 Here is how to achieve this.
9315 \begin_layout Standard
9316 For the main document, you just insert a bibliography inset at the place
9317 where the main bibliography has to appear (within the master file or within
9319 If the bibliography inset is in the master file, the references will be
9320 inherited by all children, so they are available in the citation dialog
9324 \begin_layout Standard
9325 For child-specific bibliographies, insert bibliography insets within the
9326 child documents, at the place where the bibliography should appear when
9327 the child is compiled separately.
9328 However, the trick is to insert them into a branch (
9330 Insert\SpecialChar menuseparator
9331 Branch\SpecialChar menuseparator
9332 Insert New Branch...
9335 \begin_inset space \thinspace{}
9340 \begin_inset Quotes eld
9344 \begin_inset Quotes erd
9348 Within the children, activate the branch (
9350 Document\SpecialChar menuseparator
9351 Settings...\SpecialChar menuseparator
9355 Within the master, deactivate the branch (
9357 Document\SpecialChar menuseparator
9358 Settings...\SpecialChar menuseparator
9362 Now the child's bibliography will be ignored by the master, but considered
9366 \begin_layout Standard
9367 If you need multiple bibliographies (e.
9368 \begin_inset space \thinspace{}
9371 g., one per child in the
9375 ), please refer to sec.
9376 \begin_inset space ~
9380 \begin_inset CommandInset ref
9382 reference "subsec:Multiple-Bibliographies"
9389 \begin_layout Section
9394 \begin_layout Standard
9395 Users sometimes need to be able to
9396 \begin_inset Quotes eld
9400 \begin_inset Quotes erd
9404 file together with all the images (and other files) on which it depends,
9405 either for sending to a publisher or for sharing with a co-author.
9407 includes a Python script (
9408 \begin_inset Flex Code
9411 \begin_layout Plain Layout
9417 ) that automates this process.
9418 To use it, you must have either the
9419 \begin_inset Flex Code
9422 \begin_layout Plain Layout
9429 \begin_inset Flex Code
9432 \begin_layout Plain Layout
9438 python modules installed on your system.
9439 By default, the script prefers the
9440 \begin_inset Flex Code
9443 \begin_layout Plain Layout
9450 \begin_inset Flex Code
9453 \begin_layout Plain Layout
9459 format on Unix-like systems and the
9460 \begin_inset Flex Code
9463 \begin_layout Plain Layout
9472 \begin_layout Standard
9474 's configuration process will set the script up to export a `\SpecialChar LyX
9476 and this format will then be available under
9477 \begin_inset Flex Code
9480 \begin_layout Plain Layout
9481 File\SpecialChar menuseparator
9490 \begin_layout Standard
9491 Independently of the platform, the generation of a particular archive format
9492 can be forced by adding either the
9493 \begin_inset Flex Code
9496 \begin_layout Plain Layout
9503 \begin_inset Flex Code
9506 \begin_layout Plain Layout
9513 \begin_inset Flex Code
9516 \begin_layout Plain Layout
9523 \begin_inset Flex Code
9526 \begin_layout Plain Layout
9532 format) switch to the
9533 \begin_inset Flex Code
9536 \begin_layout Plain Layout
9538 \SpecialChar menuseparator
9546 \begin_inset Flex Code
9549 \begin_layout Plain Layout
9550 Tools\SpecialChar menuseparator
9551 Preferences\SpecialChar menuseparator
9552 File Handling\SpecialChar menuseparator
9559 (Make sure you add the switch after the script name, not before it.)
9562 \begin_layout Section
9563 Fancy Headers and Footers
9566 \begin_layout Standard
9567 The default page layout is rather plain; for an
9568 \begin_inset Flex Code
9571 \begin_layout Plain Layout
9577 document class, all you get is a centered page number at the bottom of
9579 This document uses KOMA-script's book class, so it appears to be a bit
9581 But to really put on a show, you need to set the document page style to
9583 \begin_inset Quotes eld
9587 \begin_inset Quotes erd
9590 , as mentioned in the
9595 This section describes the \SpecialChar LaTeX
9596 code you need to insert in your \SpecialChar LaTeX
9598 order to get the desired effects.
9601 \begin_layout Standard
9602 For more information on fancy headers, see the
9603 \begin_inset Flex Code
9606 \begin_layout Plain Layout
9612 package documentation.
9614 \begin_inset Flex URL
9617 \begin_layout Plain Layout
9619 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
9627 \begin_layout Standard
9628 The page header is divided into three fields, not surprisingly labeled
9629 \begin_inset Quotes eld
9633 \begin_inset Quotes erd
9637 \begin_inset Quotes eld
9641 \begin_inset Quotes erd
9645 \begin_inset Quotes eld
9649 \begin_inset Quotes erd
9653 The footer is also divided into these three fields.
9654 The \SpecialChar LaTeX
9655 commands to set these fields in the simplest manner are
9656 \begin_inset Flex Code
9659 \begin_layout Plain Layout
9668 \begin_inset Flex Code
9671 \begin_layout Plain Layout
9680 \begin_inset Flex Code
9683 \begin_layout Plain Layout
9692 \begin_inset Flex Code
9695 \begin_layout Plain Layout
9704 Suppose you wish to put your name in the upper left hand corner of each
9706 Simply insert the following command in the preamble:
9709 \begin_layout Standard
9718 \begin_layout Standard
9719 You will now see your name in the upper left.
9720 If a field has a default entry that you would like to get rid of (often
9721 the page number appears in the central footer) simply include a command
9722 with a blank argument, e.
9723 \begin_inset space \thinspace{}
9729 \begin_layout Standard
9737 \begin_layout Standard
9738 Let's get really fancy: lets put the section number with the word
9739 \begin_inset Quotes eld
9743 \begin_inset Quotes erd
9747 \begin_inset space \thinspace{}
9751 \begin_inset space \space{}
9754 Section 3) in the upper left, the page number (e.
9755 \begin_inset space \thinspace{}
9759 \begin_inset space \space{}
9762 Page 4) in the upper right, your name in the lower left, and the date in
9764 The following commands should now appear in the preamble:
9767 \begin_layout Standard
9777 \begin_layout Standard
9785 \begin_layout Standard
9795 \begin_layout Standard
9804 \begin_layout Standard
9812 \begin_layout Standard
9822 \begin_layout Standard
9824 \begin_inset Flex Code
9827 \begin_layout Plain Layout
9836 \begin_inset Flex Code
9839 \begin_layout Plain Layout
9847 access \SpecialChar LaTeX
9848 's section and page counters, and so print out the current section
9851 \begin_inset Flex Code
9854 \begin_layout Plain Layout
9862 simply prints out today's date.
9865 \begin_layout Standard
9866 The thicknesses of the horizontal rules drawn beneath the header and above
9867 the footer can also be modified.
9868 If you don't want one of the rules, set its thickness to 0.
9869 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
9875 \begin_inset Flex Code
9878 \begin_layout Plain Layout
9883 headrulewidth}{0.4pt}
9889 \begin_inset Flex Code
9892 \begin_layout Plain Layout
9897 footrulewidth}{0.4pt}
9902 to set the thicknesses.
9905 \begin_layout Standard
9906 You can switch the header/footer settings on and off for individual pages
9908 \begin_inset Flex Code
9911 \begin_layout Plain Layout
9914 thispagestyle{empty}
9920 \begin_inset Flex Code
9923 \begin_layout Plain Layout
9926 thispagestyle{plain}
9932 \begin_inset Flex Code
9935 \begin_layout Plain Layout
9938 thispagestyle{fancy}
9944 Simply insert them in the text on the page you want changed and mark them
9947 In fact, title pages are marked as plain by default, while following pages
9948 are marked fancy when using the global fancy setting.
9951 \begin_layout Standard
9952 As a final example, it is possible to include an image in the header or
9954 Suppose you want to put a company logo in the upper lefthand corner.
9955 You might try something like
9958 \begin_layout Standard
9967 includegraphics{logo.eps}}}
9970 \begin_layout Standard
9972 (you may need to preface this with
9973 \begin_inset Flex Code
9976 \begin_layout Plain Layout
9979 usepackage{graphics}
9984 if you don't include graphics elsewhere in your document).
9987 \begin_layout Section
9988 Itemize Bullet Selection
9989 \begin_inset CommandInset label
9998 \begin_layout Standard
10004 \begin_layout Subsection
10008 \begin_layout Standard
10010 provides 216 bullet shapes that can be accessed from a simple dialog.
10011 Using this dialog you can easily specify what bullet shape to use at each
10012 level of an itemized list.
10013 These settings are document-wide so you won't be able to specify different
10014 sets of bullets for different paragraphs.
10018 \begin_layout Plain Layout
10019 Well, actually you can but you'll have to do it by hand.
10027 \begin_layout Subsection
10031 \begin_layout Standard
10032 Open the dialog by selecting the
10033 \begin_inset Flex Noun
10036 \begin_layout Plain Layout
10037 Document\SpecialChar menuseparator
10043 menu item and then select the
10044 \begin_inset Flex Noun
10047 \begin_layout Plain Layout
10056 \begin_layout Standard
10057 The dialog provides you with a table of bullet shapes.
10058 A column of buttons on the left of the table provides access to the six
10059 different panels of bullet shapes.
10060 The row of buttons across the top is used to select which bullet depth
10063 \change_deleted 244031559 1603875981
10064 A text entry under the table shows the currently selected bullet shape's
10066 equivalent and this can be edited if desired.
10067 If you do modify the text you will also need to specify any needed packages
10068 in the \SpecialChar LaTeX
10074 \begin_layout Standard
10075 The six panels are divided up by the packages they require.
10076 The following table shows the mappings from button name to \SpecialChar LaTeX
10080 \begin_layout Standard
10082 \begin_inset Tabular
10083 <lyxtabular version="3" rows="7" columns="2">
10084 <features tabularvalignment="middle">
10085 <column alignment="center" valignment="top" width="0pt">
10086 <column alignment="center" valignment="top" width="0pt">
10088 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
10091 \begin_layout Plain Layout
10106 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
10109 \begin_layout Plain Layout
10126 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
10129 \begin_layout Plain Layout
10144 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
10147 \begin_layout Plain Layout
10156 base \SpecialChar LaTeX
10164 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
10167 \begin_layout Plain Layout
10182 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
10185 \begin_layout Plain Layout
10202 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
10205 \begin_layout Plain Layout
10220 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
10223 \begin_layout Plain Layout
10240 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
10243 \begin_layout Plain Layout
10258 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
10261 \begin_layout Plain Layout
10278 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
10281 \begin_layout Plain Layout
10296 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
10299 \begin_layout Plain Layout
10316 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
10319 \begin_layout Plain Layout
10334 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
10337 \begin_layout Plain Layout
10360 \begin_layout Standard
10362 doesn't stop you using bullets from packages you don't have.
10363 If you get errors from \SpecialChar LaTeX
10364 when you try to view or print the file, then it
10365 is likely you are missing a package.
10369 \begin_layout Plain Layout
10371 doesn't restrict your use since you may be editing locally and exporting
10380 \begin_layout Subsection
10384 \begin_layout Standard
10385 Select which bullet depth you want to change then select the bullet shape
10387 Any changes will not be visible in \SpecialChar LyX
10388 , but are visible when viewing the document.
10391 \begin_layout Standard
10392 You can reset a bullet shape to the default simply by clicking your right
10393 mouse button on the appropriate bullet depth button.
10397 \begin_layout Plain Layout
10402 want to have multiple sets of paragraphs with different sets of bullets
10403 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
10405 The bullet selection dialog can help though because it provides you with
10406 the \SpecialChar LaTeX
10407 code for a wide range of bullet shapes.
10408 To make your own custom paragraphs you have the following options:
10411 \begin_layout Plain Layout
10415 \begin_layout Plain Layout
10431 \begin_layout Plain Layout
10435 \begin_layout Plain Layout
10457 \begin_layout Itemize
10458 Use the \SpecialChar LaTeX
10460 \begin_inset Flex Code
10463 \begin_layout Plain Layout
10471 to specify a new bullet shape for a given depth.
10472 You'll also need to save the current bullet shape so you can restore it
10474 In this itemized list the following \SpecialChar LaTeX
10475 code was used to change the bullet
10476 used for the first depth.
10480 \begin_layout LyX-Code
10490 \begin_layout LyX-Code
10507 \begin_layout Itemize
10508 Note that the itemize depth is specified in Roman numerals as part of the
10518 \begin_layout Itemize
10519 \begin_inset Argument item:1
10522 \begin_layout Plain Layout
10526 \begin_layout Plain Layout
10544 Specify each individual entry by starting each item with the bullet shape
10546 \begin_inset Quotes eld
10550 \begin_inset Quotes erd
10553 inset (available at
10555 Insert\SpecialChar menuseparator
10559 \begin_inset Flex Noun
10562 \begin_layout Plain Layout
10570 For example, this item was started with
10571 \begin_inset Flex Code
10574 \begin_layout Plain Layout
10589 \begin_layout Plain Layout
10593 \begin_layout Plain Layout
10609 \begin_layout Plain Layout
10610 You'll also need to revert the labelitem back to its previous setting for
10611 the global bullet shape settings to remain in effect.
10612 The way used here was:
10615 \begin_layout LyX-Code
10630 \begin_layout Chapter
10632 and the World Wide Web
10635 \begin_layout Standard
10637 has long supported the export of documents to various web-friendly formats,
10639 Before version 2.0, however, HTML export was always accomplished by the
10640 use of external converters.
10644 \begin_layout Plain Layout
10645 For details on the use of external converters with \SpecialChar LyX
10650 section of the Customization manual.
10655 These fall into two large groups: there are converters that use \SpecialChar LaTeX
10657 intermediate format, such as
10658 \begin_inset Flex Code
10661 \begin_layout Plain Layout
10668 \begin_inset Flex Code
10671 \begin_layout Plain Layout
10678 \begin_inset Flex Code
10681 \begin_layout Plain Layout
10687 , relying upon \SpecialChar LyX
10688 to produce the \SpecialChar LaTeX
10689 ; and there is a converter that works directly
10690 on \SpecialChar LyX
10692 \begin_inset Flex Code
10695 \begin_layout Plain Layout
10703 All of these have different advantages and disadvantages.
10707 \begin_layout Standard
10708 The \SpecialChar LaTeX
10709 -based converters have the advantage that, in principle, they know everythin
10710 g about the exported document that \SpecialChar LaTeX
10712 Such converters do not care, for example, if a certain block of code was
10713 produced by \SpecialChar LyX
10714 or was Evil Red Text.
10715 These converters know about
10716 \begin_inset Flex Code
10719 \begin_layout Plain Layout
10725 files, counters, and references, and can often make use of the
10726 \begin_inset Flex Code
10729 \begin_layout Plain Layout
10735 files generated by Bib\SpecialChar TeX
10737 On the other hand, \SpecialChar LaTeX
10738 is a very hard language to parse—it is sometimes said
10739 that only \SpecialChar TeX
10740 itself understands \SpecialChar TeX
10741 —and \SpecialChar LaTeX
10742 -based converters will often choke on
10743 what seem to be quite simple constructs; complex ones can throw them completely
10744 , and as of this writing, for example, the
10748 manual will not export with
10749 \begin_inset Flex Code
10752 \begin_layout Plain Layout
10758 , though the others will.
10759 The other issue concerns how math is handled.
10760 These converters typically convert the formulae into little pictures that
10761 are then linked from the HTML document.
10762 Since these are actually generated by \SpecialChar LaTeX
10763 , they are accurate.
10764 But they do not scale well, and just getting them to look as if they are
10765 actually meant to be in your document—so that the font sizes seem to be
10766 roughly the same—can be a challenge.
10769 \begin_layout Standard
10771 \begin_inset Flex Code
10774 \begin_layout Plain Layout
10782 \begin_inset CommandInset href
10784 name "http://pinchito.es/elyxer/"
10785 target "http://pinchito.es/elyxer/"
10790 ) solves some of these problems.
10791 In particular, the formulae it produces scale perfectly, since it renders
10792 math using a combination of HTML and CSS rather than converting the formulae
10794 But even moderately complex formula are rendered less well than with
10795 \begin_inset Flex Code
10798 \begin_layout Plain Layout
10804 ; this reflects the limitations of HTML.
10808 \begin_layout Plain Layout
10810 \begin_inset Flex Code
10813 \begin_layout Plain Layout
10820 can also use jsMath and MathJax for equations, but this setting is only
10821 available globally and requires one to have access to a server that runs
10827 More importantly (as of version 1.1.1, at least),
10828 \begin_inset Flex Code
10831 \begin_layout Plain Layout
10838 has limited support for math macros and no support for user-defined paragraph
10839 or character styles.
10840 These limitations make
10841 \begin_inset Flex Code
10844 \begin_layout Plain Layout
10851 unsuitable for many of the documents \SpecialChar LyX
10853 In principle, of course, these problems could be solved, but the \SpecialChar LyX
10855 have decided to follow a different path and have made \SpecialChar LyX
10857 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
10858 , DocBook, and plaintext.
10861 \begin_layout Standard
10862 As of this writing, XHTML output remains under development and should probably
10864 \begin_inset Quotes eld
10868 \begin_inset Quotes erd
10875 \begin_layout Plain Layout
10877 \begin_inset Flex Code
10880 \begin_layout Plain Layout
10881 development/HTML/HTML.notes
10886 , which can be found in the \SpecialChar LyX
10888 \begin_inset CommandInset href
10890 name "accessed online"
10891 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
10896 , usually contains up-to-date information about the state of XHTML output.
10897 See also the list of XHTML bugs on
10898 \begin_inset CommandInset href
10900 name "the bug tracker"
10901 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"
10911 Still, the developers have chosen this approach because it has several
10912 potential advantages over the other two.
10915 \begin_layout Standard
10916 These advantages are primarily due to the fact that the XHTML output routines,
10917 since they are part of \SpecialChar LyX
10918 , know everything \SpecialChar LyX
10919 knows about the document being
10924 \begin_layout Plain Layout
10925 Another advantage is that, since these routines are internal to \SpecialChar LyX
10927 immune to changes in \SpecialChar LyX
10928 's file format, or to changes in the semantics of
10934 So they know about the table of contents (as displayed in the outline),
10935 about the counters associated with different paragraph styles, and about
10936 user-defined styles.
10937 The XHTML output routines know what \SpecialChar LyX
10938 knows about internationalization,
10939 too, so they will output
10940 \begin_inset Quotes eld
10944 \begin_inset Quotes erd
10948 \begin_inset Quotes eld
10956 \begin_inset Quotes erd
10959 , depending upon the language in effect at the time.
10963 \begin_layout Standard
10964 Quite generally, the output routines know what \SpecialChar LyX
10965 knows about document layout,
10966 that is, about how the document is to be rendered on screen.
10967 We use this information when we output the document as XHTML.
10968 In particular, \SpecialChar LyX
10973 generates CSS style information corresponding to the layout information
10974 it uses to render the document on screen: if section headings are supposed
10975 to be sans-serif and bold as seen in \SpecialChar LyX
10976 , then (by default) they will be sans-seri
10977 f and bold when viewed in a web browser, too.
10978 And this is true not just for pre-defined styles, like Section, but for
10979 any style, including user-defined styles.
10980 Indeed, the XHTML output routines make no distinction between user-defined
10982 \change_deleted 244031559 1603876931
10984 \change_inserted 244031559 1603876940
10987 styles and \SpecialChar LyX
10988 's own pre-defined styles: in each case, everything \SpecialChar LyX
10990 the styles is contained in the layout files.
10991 And much the same is true as regards pre-defined textual insets, such as
10992 footnotes, and various custom insets.
10996 \begin_layout Standard
10997 The result is that XHTML output can be customized and extended in exactly
10998 the same way \SpecialChar LaTeX
10999 output can be customized and extended: through layout files
11001 See chapter five of the
11005 manual for the details.
11008 \begin_layout Standard
11009 The remainder of this chapter contains more detailed information on XHTML
11010 output, its limitations, and ways to work around those limitations.
11013 \begin_layout Section
11014 Math Output in XHTML
11017 \begin_layout Standard
11019 offers four choices for how math is rendered.
11020 These have various advantages and disadvantages:
11023 \begin_layout Itemize
11025 \begin_inset Newline newline
11028 MathML is a dialect of XML designed specifically for mathematics on the
11029 web, and it typically renders very well in browsers that support it.
11030 The disadvantage is that not all browsers support MathML, and support is
11031 not complete even in the Gecko-based browsers, such as Firefox.
11032 \begin_inset Newline newline
11035 If \SpecialChar LyX
11036 is unable to render a formula as MathML—for example, if the formula
11038 \begin_inset Flex Code
11041 \begin_layout Plain Layout
11047 package or ERT—then it will instead output the formula as an image.
11051 \begin_layout Itemize
11053 \begin_inset Newline newline
11056 As mentioned above,
11057 \begin_inset Flex Code
11060 \begin_layout Plain Layout
11066 outputs math as HTML, styled by CSS.
11070 \begin_layout Plain Layout
11072 has borrowed some of the CSS for its HTML output from
11073 \begin_inset Flex Code
11076 \begin_layout Plain Layout
11087 For simple formulae, this can work quite well, though with more complicated
11088 formulae it tends to break down.
11089 Still, this method has the advantage that it is very widely supported and
11090 so it may be appropriate for documents that contain only a little, fairly
11092 \begin_inset Newline newline
11095 If Lyx is unable to render a formula as HTML—for example, if the formula
11097 \begin_inset Flex Code
11100 \begin_layout Plain Layout
11106 package or ERT—then it will instead output the formula as an image.
11110 \begin_layout Itemize
11112 \begin_inset Newline newline
11116 \begin_inset Flex Code
11119 \begin_layout Plain Layout
11126 will output formulae as images, the very same images, in fact, that are
11127 used for instant preview.
11131 \begin_layout Plain Layout
11132 Instant preview does
11136 have to be on for images to be output, however.
11141 The advantage to this method is that the images are simply generated by
11143 , so they are very accurate.
11144 The disadvantage, as mentioned earlier, is that these are bitmapped images,
11145 so they do not scale terribly well, and one cannot copy them, etc.
11146 \begin_inset Newline newline
11149 The size of the images can be controlled by setting the
11150 \begin_inset Quotes eld
11153 Math Images Scaling
11154 \begin_inset Quotes erd
11158 \begin_inset Flex Noun
11161 \begin_layout Plain Layout
11162 Document\SpecialChar menuseparator
11163 Settings\SpecialChar menuseparator
11173 \begin_layout Plain Layout
11174 For those who want to know, this controls the resolution of the image in
11175 dots per inch and is based upon a default of 75 dpi.
11181 \begin_inset Newline newline
11184 If \SpecialChar LyX
11185 for some reason fails to create an image for a formula (e.g., if a required
11187 package is not installed), then it will fall back to outputing the raw
11192 \begin_layout Itemize
11195 \begin_inset Newline newline
11198 Finally, \SpecialChar LyX
11199 will happily output math as \SpecialChar LaTeX
11201 As well as being the output of last resort, this method can be used with
11203 \begin_inset CommandInset href
11206 target "http://www.math.union.edu/~dpvc/jsMath/"
11211 , which uses JavaScript to render \SpecialChar LaTeX
11212 embedded in HTML documents.
11214 wraps the \SpecialChar LaTeX
11216 \begin_inset Flex Code
11219 \begin_layout Plain Layout
11225 (for inline formulas) or
11226 \begin_inset Flex Code
11229 \begin_layout Plain Layout
11235 (for displayed formulas) with
11236 \begin_inset Flex Code
11239 \begin_layout Plain Layout
11245 , as is required for jsMath.
11248 \begin_layout Standard
11249 One of these output methods must be selected under
11250 \begin_inset Flex Noun
11253 \begin_layout Plain Layout
11254 Document\SpecialChar menuseparator
11255 Settings\SpecialChar menuseparator
11262 By default, \SpecialChar LyX
11264 This is a document-wide setting, therefore.
11267 \begin_layout Standard
11268 Eventually, \SpecialChar LyX
11269 will offer the user the option to select an alternate output
11270 method for a particular inset, say, one that isn't being rendered very
11275 \begin_layout Plain Layout
11276 That said, since \SpecialChar LyX
11277 falls back to images if the inset contains ERT, then one
11278 can force output as an image by putting some harmless ERT into the math,
11280 \begin_inset Formula $a=b\relax$
11291 \begin_layout Section
11292 Bibliography and Citations
11295 \begin_layout Standard
11296 XHTML output fully supports bibliographies and citations.
11300 \begin_layout Standard
11301 Citation labels are generated by the same machinery that generates \SpecialChar LyX
11303 labels, so the labels will look in the output much as they do in \SpecialChar LyX
11306 If you are using numerical citations, then \SpecialChar LyX
11307 will output numerical labels,
11308 such as [1] or [17], rather than simply showing the citation key in square
11309 brackets, as it does on-screen.
11310 If you are using author-year citations, then \SpecialChar LyX
11311 will add lowercase letters
11312 to the years, just as Bib\SpecialChar TeX
11313 does, if it finds more than one citation for
11314 a given author-year combination.
11315 The labels will be printed with the bibliography entries.
11316 Note that there is, at present, no way to customize the appearance of the
11317 labels, for example, to choose between square brackets and parentheses.
11320 \begin_layout Standard
11321 Bibliography output is handled by the same machinery that handles the presentati
11322 on of reference information in the citation dialog, so you will see in the
11323 XHTML output pretty much what you would see if you were to look at a given
11324 entry in the citation dialog.
11325 The formatting can be customized in your layout file or, preferably, in
11331 manual for the details.
11334 \begin_layout Standard
11335 The main defect at present is that cross-referenced information is printed
11336 with every entry with which it is associated.
11337 So you can see things like this:
11340 \begin_layout Quote
11342 \begin_inset Quotes eld
11345 Context and Logical Form
11346 \begin_inset Quotes erd
11351 Language in Context: Selected Essays
11353 (Oxford: Oxford University Press, 2007), pp.
11357 \begin_layout Quote
11359 \begin_inset Quotes eld
11362 Semantics in Context
11363 \begin_inset Quotes erd
11368 Language in Context: Selected Essays
11370 (Oxford: Oxford University Press, 2007), pp.
11374 \begin_layout Standard
11375 This should be fixed before long.
11378 \begin_layout Standard
11379 There is no support at present for sectioned bibliographies.
11380 If you have multiple bibliographies, then \SpecialChar LyX
11381 will print the same bibliography
11385 \begin_layout Section
11389 \begin_layout Standard
11391 will happily export indexes as XHTML, but with certain limitations at the
11395 \begin_layout Standard
11396 Index export will be most reliable when you do not attempt to use the fancy
11397 constructs that are described in the section on indexes in the
11405 \begin_layout Plain Layout
11406 The main issue here is that \SpecialChar LyX
11407 itself does not really handle these.
11408 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
11414 We'll describe how they are handled using the subsection headings from
11418 \begin_layout Itemize
11419 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
11420 makes an effort to support these,
11421 but the entries must be separated by
11422 \begin_inset Quotes eld
11426 \begin_inset Quotes erd
11429 , that is, there must be spaces around the exclamation point.
11430 This is because it is otherwise too difficult to check for escaped exclamation
11431 points, ones in math, and so forth.
11434 \begin_layout Itemize
11435 Page Ranges: There is no support at all for page ranges, since these make
11436 no sense with XHMTL.
11437 Instead, you will just get two index entries, one at either end.
11440 \begin_layout Itemize
11441 Cross-referencing: There is no support for cross-referencing.
11442 If \SpecialChar LyX
11443 finds an entry containing the
11444 \begin_inset Quotes eld
11447 |see\SpecialChar ldots
11449 \begin_inset Quotes erd
11452 construct, it is just dropped, and the rest is treated as an ordinary index
11456 \begin_layout Itemize
11457 Index Entry Order: \SpecialChar LyX
11458 does support attempts to fix the sorting order.
11459 It will take what is before the first `@' it finds and use that for sorting,
11460 taking what follows the first `@' to be the actual entry.
11461 At present, \SpecialChar LyX
11462 does not check for escaped `@', so do not try to index email
11466 \begin_layout Itemize
11467 Index Entry Layout: You can format entries by using the text style dialog,
11468 or by using any other method available within \SpecialChar LyX
11470 There is no support for constructs like:
11471 \begin_inset Quotes eld
11475 \begin_inset Quotes erd
11479 Indeed, if \SpecialChar LyX
11480 finds a pipe symbol, `|', in an entry, it will delete it and
11481 everything that follows it.
11484 \begin_layout Itemize
11485 Multiple Indexes: There is no support for multiple indexes.
11486 Rather, all index entries will be printed as one large index.
11487 To avoid our printing several versions of the index, we print only the
11488 main index, so make sure you have one.
11491 \begin_layout Section
11492 Nomenclature and Glossary
11495 \begin_layout Standard
11496 There is at present no support for glossaries.
11497 Adding it would be fairly trivial, and welcome.
11500 \begin_layout Chapter
11502 \change_inserted 1075283030 1616534180
11506 \begin_layout Standard
11508 \change_inserted 1075283030 1616534386
11509 Apart from HTML, \SpecialChar LyX
11510 can generate documents in the DocBook XML vocabulary.
11511 With versions 2.3 and before, only select templates could be used to generate
11512 DocBook documents (only version 4).
11513 Starting with \SpecialChar LyX
11514 2.4, most \SpecialChar LyX
11515 layouts can generate valid DocBook documents (only
11517 This feature is built into \SpecialChar LyX
11518 and does not require the use of external tools.
11521 \begin_layout Standard
11523 \change_inserted 1075283030 1616534437
11524 The result is that the DocBook output can be customized and extended in
11525 exactly the same way \SpecialChar LaTeX
11526 output can be customized and extended: through layout
11528 See chapter five of the
11532 manual for the details.
11535 \begin_layout Standard
11537 \change_inserted 1075283030 1616534475
11538 Most \SpecialChar LyX
11539 features are supported with DocBook, like math output.
11542 \begin_layout Itemize
11544 \change_inserted 1075283030 1616534741
11545 Math output is performed mostly in MathML (the major exception being constructio
11546 ns not supported by \SpecialChar LyX
11549 All formulae are also available in raw \SpecialChar TeX
11550 in the DocBook output for further
11554 \begin_layout Itemize
11556 \change_inserted 1075283030 1616534852
11557 Bibliographies and citations are implemented, including with an external
11559 Bibliography entries are not prerendered when the detailed information
11560 are available, but rather output with the standard DocBook constructs.
11561 The external DocBook processor is expected to handle the rendering of entries.
11564 \begin_layout Itemize
11566 \change_inserted 1075283030 1616534863
11567 Indexes are supported, including multiple indices.
11572 ), page ranges, and cross-references (
11576 ) are supported, with the exception of the same symbols escaped.
11585 ) are not supported.
11586 There is no support for escaping of index entries.
11589 \begin_layout Itemize
11591 \change_inserted 1075283030 1616534884
11592 Glossaries are implemented.
11595 \begin_layout Standard
11597 \change_inserted 1075283030 1616534894
11598 Two major parameters can be set at the document level.
11601 \begin_layout Itemize
11603 \change_inserted 1075283030 1616534948
11604 Format for tables: \SpecialChar LyX
11605 can generate tables either as HTML (default value) or
11606 CALS, depending on the user's requirements.
11607 Most DocBook processors accept both formats.
11610 \begin_layout Itemize
11612 \change_inserted 1075283030 1616535006
11613 MathML prefix: in DocBook, MathML is included within its own name space,
11615 The implication is that there must be an indication of the tags belonging
11616 to the MathML standard.
11617 Three choices are offered:
11621 \begin_layout Itemize
11623 \change_inserted 1075283030 1616535044
11624 Inline: the MathML name space is defined for each formula (using the
11628 attribute on each formula)
11631 \begin_layout Itemize
11633 \change_inserted 1075283030 1616535090
11638 prefix (default): the MathML name space is defined at the document level
11643 attribute on the root element).
11644 Each MathML is prefixed with
11653 \begin_layout Itemize
11655 \change_inserted 1075283030 1616620405
11660 prefix: similar to the
11669 \begin_layout Standard
11671 \change_inserted 1075283030 1616620470
11672 This option is especially useful if you want \SpecialChar LyX
11673 to match your personal style
11674 or to work with buggy software that only accepts one prefix for MathML.
11680 \begin_layout Chapter
11681 The \SpecialChar LyX
11685 \begin_layout Section
11689 \begin_layout Standard
11690 The `\SpecialChar LyX
11691 server' allows other programs to talk to \SpecialChar LyX
11692 , invoke \SpecialChar LyX
11693 commands, and retrieve
11694 information about the \SpecialChar LyX
11696 This is only intended for advanced users, but they should find it useful.
11697 It is by writing to the \SpecialChar LyX
11698 server, for example, that bibliography managers,
11699 such as JabRef, are able to
11700 \begin_inset Quotes eld
11704 \begin_inset Quotes erd
11707 citations to \SpecialChar LyX
11711 \begin_layout Section
11712 Starting the \SpecialChar LyX
11714 \begin_inset CommandInset label
11716 name "sec:Starting-the-Server"
11723 \begin_layout Standard
11724 The \SpecialChar LyX
11725 server works through the use of a pair of named pipes.
11726 These are usually located in
11727 \begin_inset Flex Code
11730 \begin_layout Plain Layout
11736 , (except on Windows, where
11740 named pipes are special objects located in
11741 \begin_inset Flex Code
11744 \begin_layout Plain Layout
11756 ) and have the names
11757 \begin_inset Quotes eld
11761 \begin_inset Flex Code
11764 \begin_layout Plain Layout
11771 \begin_inset Quotes erd
11775 \begin_inset Quotes eld
11779 \begin_inset Flex Code
11782 \begin_layout Plain Layout
11789 \begin_inset Quotes erd
11793 External programs write into
11794 \begin_inset Flex Code
11797 \begin_layout Plain Layout
11803 and read back data from
11804 \begin_inset Flex Code
11807 \begin_layout Plain Layout
11814 The stem of the pipe names can be defined in the
11815 \begin_inset Flex Noun
11818 \begin_layout Plain Layout
11819 Tools\SpecialChar menuseparator
11825 dialog, for example
11826 \begin_inset Flex Code
11829 \begin_layout Plain Layout
11830 "/home/myhome/lyxpipe"
11836 \begin_inset Flex Code
11839 \begin_layout Plain Layout
11853 on Windows (where any working path instead of lyxpipe can be used, for
11855 \begin_inset Flex Code
11858 \begin_layout Plain Layout
11881 configure this manually in order for the server to start.
11884 \begin_layout Standard
11887 \begin_inset Flex Code
11890 \begin_layout Plain Layout
11897 \begin_inset Flex Code
11900 \begin_layout Plain Layout
11906 ' to create the pipes.
11907 If one of the pipes already exists, \SpecialChar LyX
11908 will assume that another \SpecialChar LyX
11910 is already running and will not start the server.
11911 On POSIX (Unix like) systems, if for some other reason, an unused
11912 \begin_inset Quotes eld
11916 \begin_inset Quotes erd
11919 pipe is left in existence when \SpecialChar LyX
11920 closes, then \SpecialChar LyX
11921 will try to delete it.
11922 If this fails for some reason, you will need to delete the pipes manually
11923 and then restart \SpecialChar LyX
11925 On Windows, pipes are deleted by the OS on program termination or crash,
11927 \begin_inset Quotes eld
11931 \begin_inset Quotes erd
11934 pipes should not be possible.
11937 \begin_layout Standard
11938 To have several \SpecialChar LyX
11939 processes with servers at the same time, you have to use
11940 different configurations, perhaps by using separate user directories, each
11942 \begin_inset Flex Code
11945 \begin_layout Plain Layout
11951 file, for each process.
11954 \begin_layout Standard
11955 If you are developing a client program, you might find it useful to enable
11956 debugging information from the \SpecialChar LyX
11958 Do this by starting \SpecialChar LyX
11960 \begin_inset Flex Code
11963 \begin_layout Plain Layout
11972 \begin_layout Standard
11973 You can find a complete example client written in C++ in the source distribution
11975 \begin_inset Flex Code
11978 \begin_layout Plain Layout
11979 development/lyxserver/server_monitor.cpp
11987 \begin_layout Standard
11988 Another useful tool is the command-line based client found in
11989 \begin_inset Flex Code
11992 \begin_layout Plain Layout
11993 src/client/lyxclient
12001 \begin_layout Section
12002 Normal communication
12005 \begin_layout Standard
12006 To issue a \SpecialChar LyX
12007 call, the client writes a line of ASCII text into the input
12009 This line has the following format:
12012 \begin_layout Quote
12026 \begin_layout Description
12027 clientname is a name that the client can choose arbitrarily.
12028 Its only use is that \SpecialChar LyX
12029 will echo it if it sends an answer—so a client can
12030 dispatch results from different requesters.
12033 \begin_layout Description
12034 function is the function you want \SpecialChar LyX
12036 It is the same as the commands you'd use in the minibuffer.
12039 \begin_layout Description
12040 argument is an optional argument which is meaningful only to some functions
12042 \begin_inset Quotes eld
12046 \begin_inset Quotes erd
12049 LFUN will insert the argument as text at the cursor position).
12052 \begin_layout Standard
12053 The answer from \SpecialChar LyX
12054 will arrive in the output pipe and be of the form
12057 \begin_layout Quote
12071 \begin_layout Standard
12080 are just echoed from the command request, while
12084 is more or less useful information filled according to how the command
12085 execution worked out.
12086 Some commands, such as
12087 \begin_inset Quotes eld
12091 \begin_inset Quotes erd
12094 , will return information about the internal state of \SpecialChar LyX
12096 return an empty data-response.
12097 This means that the command execution went fine.
12100 \begin_layout Standard
12101 In case of errors, the response from \SpecialChar LyX
12102 will have this form
12105 \begin_layout Quote
12119 \begin_layout Standard
12124 should contain an explanation of why the command failed.
12127 \begin_layout Standard
12131 \begin_layout LyX-Code
12132 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
12133 \begin_inset Newline newline
12136 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
12137 \begin_inset Newline newline
12140 read a <~/.lyxpipe.out
12141 \begin_inset Newline newline
12147 \begin_layout Subsection
12148 AppleScript (Mac OS X)
12151 \begin_layout Standard
12152 Since \SpecialChar LyX
12153 2.1, \SpecialChar LyX
12154 supports basic interactions with AppleScript for normal communicatio
12155 n through the command run.
12156 This command takes a direct argument (the
12160 to perform) and an optional argument.
12161 It either returns the output of the function or triggers an error with
12162 the error message and code.
12165 \begin_layout Standard
12169 \begin_layout LyX-Code
12170 tell application "\SpecialChar LyX
12174 \begin_layout LyX-Code
12178 \begin_layout LyX-Code
12179 -- Stores the current file name into f
12182 \begin_layout LyX-Code
12183 set f to (run "server-get-filename" with argument "")
12186 \begin_layout LyX-Code
12187 on error the error_message number the error_number
12190 \begin_layout LyX-Code
12191 display dialog "Error: " & the error_number & ".
12195 \begin_layout LyX-Code
12196 & the error_message buttons {"OK"} default button 1
12199 \begin_layout LyX-Code
12203 \begin_layout LyX-Code
12207 \begin_layout Section
12211 \begin_layout Standard
12213 can notify clients of events going on asynchronously.
12214 Currently it will only do this if the user binds a key sequence with the
12216 \begin_inset Quotes eld
12220 \begin_inset Quotes erd
12224 The format of the string \SpecialChar LyX
12225 sends is as follows:
12228 \begin_layout Quote
12229 \begin_inset Flex Code
12232 \begin_layout Plain Layout
12243 \begin_layout Standard
12248 is the printed representation of the key sequence that was actually typed
12252 \begin_layout Standard
12253 This mechanism can be used to extend \SpecialChar LyX
12254 's command set and implement macros.
12255 Bind some key sequence to
12256 \begin_inset Quotes eld
12260 \begin_inset Quotes erd
12264 Then start a client that listens on the output pipe, dispatches the command
12265 according to the sequence, and starts a function that may use \SpecialChar LyX
12268 requests to issue a command or a series of commands to \SpecialChar LyX
12272 \begin_layout Section
12273 The simple \SpecialChar LyX
12277 \begin_layout Standard
12279 implements a simple protocol that can be used for session management.
12280 All messages are of the form
12283 \begin_layout Quote
12293 \begin_layout Standard
12299 \begin_inset Quotes eld
12303 \begin_inset Quotes erd
12307 \begin_inset Quotes eld
12311 \begin_inset Quotes erd
12316 \begin_inset Quotes eld
12320 \begin_inset Quotes erd
12323 is received from a client, \SpecialChar LyX
12324 will report back to inform the client that
12325 it's listening to it's messages, while
12326 \begin_inset Quotes eld
12330 \begin_inset Quotes erd
12333 sent from \SpecialChar LyX
12334 will inform clients that \SpecialChar LyX
12338 \begin_layout Section
12339 Reverse DVI/PDF search
12342 \begin_layout Standard
12343 Some DVI/PDF viewers
12347 \begin_layout Plain Layout
12348 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
12349 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
12358 facility (also called
12363 This means that you can tell \SpecialChar LyX
12364 to put the cursor to a specific line in the
12365 document by clicking at the respective position in the DVI/PDF output.
12366 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
12368 This is done via the \SpecialChar LyX
12369 server either by using the named pipe (
12373 ), or the UNIX domain socket (
12377 ) that \SpecialChar LyX
12378 creates in its temporary directory (this is the way the
12379 \begin_inset Flex Code
12382 \begin_layout Plain Layout
12388 program communicates with \SpecialChar LyX
12390 In some cases, you need a helper script that mediates between the viewer
12391 and \SpecialChar LyX
12392 , in others, the viewer can communicate with \SpecialChar LyX
12394 This depends on the selected viewer and on your operating system.
12395 The same applies to the way viewers need to be configured and the way the
12396 reverse search is actually performed.
12397 In what follows, we will thus describe how to setup reverse search for
12399 Before we turn to this, though, we will explain what needs to be done generally
12400 to enable reverse search in the DVI/PDF output.
12403 \begin_layout Subsection
12405 \begin_inset CommandInset label
12407 name "subsec:rev-search"
12414 \begin_layout Standard
12415 In most cases \SpecialChar LyX
12416 will do the work for you by pressing the following button
12420 arg "buffer-toggle-output-sync"
12424 Alternatively, you can also enable the feature by checking
12426 Synchronize with Output
12429 \begin_inset Flex Noun
12432 \begin_layout Plain Layout
12433 Document\SpecialChar menuseparator
12434 Settings\SpecialChar menuseparator
12441 In such a case \SpecialChar LyX
12442 will automatically insert the necessary Sync\SpecialChar TeX
12444 PDF) or load the srcltx package (for DVI) respectively.
12445 This option can be easily reached also on
12446 \begin_inset Flex Code
12449 \begin_layout Plain Layout
12458 \begin_layout Standard
12459 If you need a different setting, you can select or input a custom macro
12460 from the drop down box just below
12461 \begin_inset Flex Noun
12464 \begin_layout Plain Layout
12465 Document\SpecialChar menuseparator
12466 Settings\SpecialChar menuseparator
12467 Output\SpecialChar menuseparator
12468 Synchronize with Output
12476 \begin_layout Standard
12477 Note that the method
12478 \begin_inset Flex Code
12481 \begin_layout Plain Layout
12489 enables gzip compression.
12490 If your viewer does not support it, you should instead use
12491 \begin_inset Flex Code
12494 \begin_layout Plain Layout
12505 \begin_layout Standard
12506 Please also note that including the
12507 \begin_inset Flex Code
12510 \begin_layout Plain Layout
12517 \begin_inset Flex Code
12520 \begin_layout Plain Layout
12526 sometimes has an undesired impact on the typesetting.
12527 Thus, you should switch output synchronization off for the final typesetting
12529 \begin_inset Flex Code
12532 \begin_layout Plain Layout
12539 \begin_inset Flex Code
12542 \begin_layout Plain Layout
12552 \begin_layout Standard
12553 In case you need some more special settings that are not covered by the
12554 automatic settings, read the next section about how to set up output synchroniz
12556 If the automatic setup suits your needs, you can readily jump to section
12557 \begin_inset space ~
12561 \begin_inset CommandInset ref
12563 reference "subsec:configuring-viewers"
12567 , where the necessary configuration steps in your viewer – needed both with
12568 the automatic and the manual setup – are described.
12571 \begin_layout Subsection
12575 \begin_layout Standard
12577 provides several different methods for reverse search.
12578 Some are built-in in the
12579 \begin_inset Flex Code
12582 \begin_layout Plain Layout
12588 program, some are provided by external packages.
12589 Your choice depends on whether your \SpecialChar LaTeX
12590 distribution already provides a given
12591 method (the built-in methods are rather new) and whether your viewer can
12593 The available methods are described in the following.
12596 \begin_layout Subsubsection*
12597 Built-in DVI-search via src-specials (DVI only)
12600 \begin_layout Standard
12601 This method provides the DVI file with the necessary information for reverse
12603 It is available in \SpecialChar LaTeX
12604 since quite some time (any somewhat recent \SpecialChar LaTeX
12606 should include it), and it works reliably.
12607 To enable it, change the
12608 \begin_inset Flex Noun
12611 \begin_layout Plain Layout
12622 \begin_inset Flex Noun
12625 \begin_layout Plain Layout
12636 \begin_inset Flex Noun
12639 \begin_layout Plain Layout
12640 Preferences\SpecialChar menuseparator
12641 File Handling\SpecialChar menuseparator
12648 \begin_inset Flex Code
12651 \begin_layout Plain Layout
12652 latex -src-specials $$i
12658 If this doesn't work, check if your \SpecialChar TeX
12659 engine needs different options (the
12660 syntax might differ in some distributions).
12663 \begin_layout Subsubsection*
12664 External Packages (PDFSync and scrltx)
12667 \begin_layout Standard
12676 provide reverse search facility for PDF output (via pdflatex) and DVI output,
12678 In order to enable it, load the packages in the \SpecialChar LyX
12682 \begin_layout Itemize
12683 \begin_inset Flex Code
12686 \begin_layout Plain Layout
12689 usepackage{pdfsync}
12694 for reverse PDF search,
12697 \begin_layout Itemize
12698 \begin_inset Flex Code
12701 \begin_layout Plain Layout
12704 usepackage[active]{srcltx}
12709 for reverse DVI search.
12712 \begin_layout Standard
12713 If you want to be able to perform both DVI and PDF reverse searches, you
12714 can also insert in the preamble the following lines
12717 \begin_layout LyX-Code
12721 \begin_inset Newline newline
12727 \begin_inset Newline newline
12732 usepackage{pdfsync}
12733 \begin_inset Newline newline
12739 \begin_inset Newline newline
12744 usepackage[active]{srcltx}
12745 \begin_inset Newline newline
12753 \begin_layout Standard
12754 This way, you can preview the file as either DVI or PDF (pdflatex) and the
12755 right package will be used.
12758 \begin_layout Standard
12759 Note that PDFSync might affect the output layout of your document.
12760 It is therefore advised to disable PDFsync for final documents.
12763 \begin_layout Subsubsection*
12764 Built-in reverse search via Sync\SpecialChar TeX
12768 \begin_layout Standard
12770 \begin_inset Flex Code
12773 \begin_layout Plain Layout
12779 have built-in support for both PDF and DVI reverse search.
12782 Sync\SpecialChar TeX
12785 facility is basically the result of the integration of the PDFSync package
12786 to the pdftex program and its merge with the
12791 You need at least \SpecialChar TeX
12792 Live 2008 or a recent Mik\SpecialChar TeX
12793 distribution in order to use
12798 \begin_layout Plain Layout
12799 For some reason, Mik\SpecialChar TeX
12800 does not understand/obey the command \SpecialChar LyX
12802 the preamble when you check the "Enable Forward/Reverse Search" button
12803 in the toolbar and does not generate the necessary info.
12806 \begin_layout Plain Layout
12807 The generation of the required info can be forced by changing the converter
12808 "\SpecialChar LaTeX
12809 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
12810 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
12811 the -synctex=1 switch).
12816 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
12817 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
12818 already provide Sync\SpecialChar TeX
12822 \begin_layout Standard
12823 To enable Sync\SpecialChar TeX
12824 for DVI output, change the
12825 \begin_inset Flex Noun
12828 \begin_layout Plain Layout
12839 \begin_inset Flex Noun
12842 \begin_layout Plain Layout
12847 (plain) -> DraftDVI
12853 \begin_inset Flex Noun
12856 \begin_layout Plain Layout
12857 Preferences\SpecialChar menuseparator
12858 File Handling\SpecialChar menuseparator
12865 \begin_inset Flex Code
12868 \begin_layout Plain Layout
12869 latex -synctex=1 $$i
12874 , and for PDF output, change the
12875 \begin_inset Flex Noun
12878 \begin_layout Plain Layout
12883 (pdflatex) -> PDF (pdflatex)
12889 \begin_inset Flex Code
12892 \begin_layout Plain Layout
12893 pdflatex -synctex=1 $$i
12899 Should your viewer not be considered in the following description, or in
12900 case of missing success, please check the documentation of your viewer
12901 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
12906 \begin_layout Plain Layout
12907 Note that the option
12908 \begin_inset Flex Code
12911 \begin_layout Plain Layout
12917 option enables gzip compression.
12918 If your viewer does not support it, you should instead use
12919 \begin_inset Flex Code
12922 \begin_layout Plain Layout
12936 \begin_layout Subsection
12937 Configuring and using specific viewers
12938 \begin_inset CommandInset label
12940 name "subsec:configuring-viewers"
12947 \begin_layout Subsubsection*
12948 Xdvi (all platforms)
12951 \begin_layout Standard
12953 \begin_inset Flex Code
12956 \begin_layout Plain Layout
12962 , you don't need to do anything else for performing a reverse DVI search,
12963 as \SpecialChar LyX
12964 already provides the necessary hooks for automatically using the
12965 \begin_inset Flex Code
12968 \begin_layout Plain Layout
12975 Just setup your document as described above (reverse search is triggered
12976 by Ctrl-click or Alt-click on Mac OSX, respectively).
12979 \begin_layout Standard
12980 However, if for whatever reason you want to use the named pipe instead of
12981 the socket for communicating with \SpecialChar LyX
12982 , simply change the DVI viewer in
12983 \begin_inset Flex Noun
12986 \begin_layout Plain Layout
12987 Preferences\SpecialChar menuseparator
12988 File Handling\SpecialChar menuseparator
12998 \begin_layout Plain Layout
12999 On Mac OSX you have to use
13000 \begin_inset Flex Code
13003 \begin_layout Plain Layout
13004 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
13015 \begin_inset Flex Code
13018 \begin_layout Plain Layout
13019 xdvi -editor "lyxeditor.sh %f %l"
13025 \begin_inset Flex Code
13028 \begin_layout Plain Layout
13034 is a suitable script.
13035 For example, a minimal shell script is the following one:
13038 \begin_layout LyX-Code
13040 \begin_inset Newline newline
13043 LYXPIPE="/path/to/lyxpipe"
13044 \begin_inset Newline newline
13047 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
13048 \begin_inset Newline newline
13051 echo "$COMMAND" > "${LYXPIPE}".in || exit
13052 \begin_inset Newline newline
13055 read TMP < "${LYXPIPE}".out || exit
13058 \begin_layout Standard
13060 \begin_inset Flex Code
13063 \begin_layout Plain Layout
13069 is the LyXServer pipe path specified in
13070 \begin_inset Flex Noun
13073 \begin_layout Plain Layout
13074 Preferences\SpecialChar menuseparator
13084 \begin_layout Plain Layout
13086 \begin_inset Flex Code
13089 \begin_layout Plain Layout
13095 folder of a source distribution you can find a
13096 \begin_inset Flex Code
13099 \begin_layout Plain Layout
13105 script which is able to locate the
13109 based on your preferences.
13117 \begin_layout Subsubsection*
13121 \begin_layout Standard
13123 \begin_inset Flex Code
13126 \begin_layout Plain Layout
13127 /Applications/MacDviX_Folder/calleditor.script
13132 , add the following lines:
13135 \begin_layout LyX-Code
13136 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
13137 \begin_inset Newline newline
13143 \begin_layout Standard
13144 Modify the lines accordingly if you install \SpecialChar LyX
13145 somewhere else than in the
13146 Applications folder.
13149 \begin_layout Standard
13150 Reverse search is triggered by Alt-click (OPTION-click).
13153 \begin_layout Subsubsection*
13157 \begin_layout Standard
13159 \begin_inset Flex Code
13162 \begin_layout Plain Layout
13163 open -a Skim.app $$i
13168 to the viewer setting in
13169 \begin_inset Flex Noun
13172 \begin_layout Plain Layout
13173 Preferences\SpecialChar menuseparator
13174 File Handling\SpecialChar menuseparator
13175 File formats\SpecialChar menuseparator
13182 \begin_inset Flex Noun
13185 \begin_layout Plain Layout
13186 Skim\SpecialChar menuseparator
13187 Preferences\SpecialChar menuseparator
13194 \begin_inset Flex Noun
13197 \begin_layout Plain Layout
13203 preset and enter command
13204 \begin_inset Flex Noun
13207 \begin_layout Plain Layout
13208 /Applications/\SpecialChar LyX
13209 .app/Contents/MacOS/lyxeditor
13217 \begin_layout Standard
13218 Reverse search is triggered by COMMAND-SHIFT-click
13221 \begin_layout Subsubsection*
13225 \begin_layout Standard
13226 Reverse search with evince does not work out of the box, but it can be achieved
13227 by means of some third party helper scripts.
13229 \begin_inset CommandInset href
13231 target "https://wiki.lyx.org/LyX/SyncTeX"
13239 \begin_layout Subsubsection*
13243 \begin_layout Standard
13245 \begin_inset Flex Noun
13248 \begin_layout Plain Layout
13249 Settings\SpecialChar menuseparator
13250 Configure Okular\SpecialChar menuseparator
13257 \begin_inset Quotes erd
13261 This inserts the appropriate command (
13262 \begin_inset Flex Code
13265 \begin_layout Plain Layout
13274 \begin_layout Standard
13275 Reverse search is triggered by SHIFT-click.
13277 \change_inserted -712698321 1578211026
13278 Note that this only works if Okular is in
13279 \begin_inset Quotes eld
13283 \begin_inset Quotes erd
13287 \begin_inset space \thinspace{}
13290 e., the hand symbol is clicked).
13295 \begin_layout Subsubsection*
13299 \begin_layout Standard
13300 Qpdfview supports Sync\SpecialChar TeX
13301 since version 0.3.5.
13303 \begin_inset Flex Noun
13306 \begin_layout Plain Layout
13307 Edit\SpecialChar menuseparator
13308 Settings\SpecialChar menuseparator
13314 , click on the input field of the
13315 \begin_inset Quotes eld
13319 \begin_inset Quotes erd
13322 item and add the command
13323 \begin_inset Flex Code
13326 \begin_layout Plain Layout
13335 \begin_layout Standard
13336 Reverse search is triggered by double-click or, in more recent versions,
13340 \begin_layout Subsubsection*
13344 \begin_layout Standard
13345 Launch yap, choose its
13346 \begin_inset Flex Noun
13349 \begin_layout Plain Layout
13350 View\SpecialChar menuseparator
13356 menu and select the
13357 \begin_inset Quotes eld
13361 \begin_inset Quotes erd
13366 \begin_inset Quotes eld
13369 New\SpecialChar ldots
13371 \begin_inset Quotes erd
13374 button and, in the window that opens, enter
13375 \begin_inset Quotes eld
13380 \begin_inset Quotes erd
13383 (or any other name you like) in the
13384 \begin_inset Quotes eld
13388 \begin_inset Quotes erd
13392 Now click on the button labeled
13393 \begin_inset Quotes eld
13398 \begin_inset Quotes erd
13401 to open a file dialog and navigate to the directory containing the batch
13403 \begin_inset Flex Code
13406 \begin_layout Plain Layout
13414 \begin_inset Flex Code
13417 \begin_layout Plain Layout
13423 and then specify the program arguments as
13424 \begin_inset Flex Code
13427 \begin_layout Plain Layout
13435 \begin_inset Flex Code
13438 \begin_layout Plain Layout
13444 wrapper is used for communicating with \SpecialChar LyX
13452 \begin_layout LyX-Code
13454 \begin_inset Newline newline
13457 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
13466 \begin_inset Newline newline
13480 \begin_layout Standard
13481 Make sure that the \SpecialChar LyX
13482 Server pipe path you specified in \SpecialChar LyX
13484 \begin_inset Flex Code
13487 \begin_layout Plain Layout
13501 , otherwise change the
13502 \begin_inset Flex Code
13505 \begin_layout Plain Layout
13511 wrapper accordingly.
13514 \begin_layout Standard
13515 In yap, reverse search is triggered by double-click.
13518 \begin_layout Subsubsection*
13519 SumatraPDF (Windows)
13522 \begin_layout Standard
13523 In order to use SumatraPDF for inverse search, enter
13524 \begin_inset Flex Code
13527 \begin_layout Plain Layout
13528 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
13533 in the viewer setting in
13534 \begin_inset Flex Noun
13537 \begin_layout Plain Layout
13538 Preferences\SpecialChar menuseparator
13539 File Handling\SpecialChar menuseparator
13540 File formats\SpecialChar menuseparator
13547 \begin_inset Flex Code
13550 \begin_layout Plain Layout
13556 is the previous wrapper.
13557 If SumatraPDF.exe is not in your command PATH, use its full file name.
13560 \begin_layout Standard
13561 Reverse search is triggered by double-click.
13564 \begin_layout Subsubsection*
13568 \begin_layout Standard
13569 First of all, make sure that yap is your default DVI viewer in the Windows
13570 environment, then launch it, choose its
13571 \begin_inset Flex Noun
13574 \begin_layout Plain Layout
13575 View\SpecialChar menuseparator
13581 menu and select the
13582 \begin_inset Quotes eld
13586 \begin_inset Quotes erd
13591 \begin_inset Quotes eld
13594 New\SpecialChar ldots
13596 \begin_inset Quotes erd
13599 button and, in the window that opens, enter
13600 \begin_inset Quotes eld
13605 \begin_inset Quotes erd
13608 (or any other name you like) in the
13609 \begin_inset Quotes eld
13613 \begin_inset Quotes erd
13617 Now click on the button labeled
13618 \begin_inset Quotes eld
13623 \begin_inset Quotes erd
13626 to open a file dialog and navigate to the directory containing the
13627 \begin_inset Flex Code
13630 \begin_layout Plain Layout
13636 program (which is installed by default on Cygwin along with the \SpecialChar LyX
13639 \begin_inset Flex Code
13642 \begin_layout Plain Layout
13648 and then specify the program arguments as
13649 \begin_inset Flex Code
13652 \begin_layout Plain Layout
13659 In this way, you will be using the
13663 for communicating with \SpecialChar LyX
13665 If, for whatever reason, you want to use the
13670 \begin_inset Flex Code
13673 \begin_layout Plain Layout
13679 option and be sure to specify the \SpecialChar LyX
13680 Server pipe path in the \SpecialChar LyX
13684 \begin_layout Standard
13685 In yap, reverse search is triggered by double-click.
13688 \begin_layout Subsubsection*
13689 SumatraPDF (Cygwin)
13692 \begin_layout Standard
13693 In order to use SumatraPDF for inverse search, enter
13694 \begin_inset Flex Code
13697 \begin_layout Plain Layout
13698 SumatraPDF -inverse-search "lyxeditor -g %f %l"
13703 in the viewer setting in
13704 \begin_inset Flex Noun
13707 \begin_layout Plain Layout
13708 Preferences\SpecialChar menuseparator
13709 File Handling\SpecialChar menuseparator
13710 File formats\SpecialChar menuseparator
13717 If SumatraPDF.exe is not in your command PATH, use its full posix path.
13719 \begin_inset Flex Code
13722 \begin_layout Plain Layout
13728 enables communication via the
13734 \begin_inset Flex Code
13737 \begin_layout Plain Layout
13743 option if you want to use the
13747 , and be sure to specify the \SpecialChar LyX
13748 Server pipe path in the \SpecialChar LyX
13752 \begin_layout Standard
13753 Reverse search is triggered by double-click.
13756 \begin_layout Section
13760 \begin_layout Standard
13761 Forward search is, as the name implies, in a sense the
13762 \begin_inset Quotes eld
13766 \begin_inset Quotes erd
13770 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
13772 If forward search is set up (as described in what follows), you can put
13773 the cursor anywhere in your \SpecialChar LyX
13775 \begin_inset Flex Noun
13778 \begin_layout Plain Layout
13779 Navigate\SpecialChar menuseparator
13786 \begin_inset Flex Noun
13789 \begin_layout Plain Layout
13795 in the context menu via right mouse click), and then the viewer will jump
13796 to that position as well.
13797 This implies, of course, that your viewer supports this function.
13800 \begin_layout Standard
13801 To make forward search possible, you first need to provide the generated
13802 output PDF/DVI file with additional information about the \SpecialChar TeX
13804 This can be done via the methods described in the section
13805 \begin_inset CommandInset ref
13807 reference "subsec:rev-search"
13814 \begin_layout Standard
13815 Additionally, you need to configure \SpecialChar LyX
13816 for using your viewers in
13817 \begin_inset Flex Noun
13820 \begin_layout Plain Layout
13821 Tools\SpecialChar menuseparator
13822 Preferences\SpecialChar menuseparator
13823 Output\SpecialChar menuseparator
13830 We provide a range of tested configurations for some viewers, which you
13831 can select from the drop down list.
13832 If none of these configurations suits you, you have to find out and enter
13833 a suitable configuration yourself.
13834 The definition syntax uses the following placeholders:
13837 \begin_layout Itemize
13839 \begin_inset Flex Code
13842 \begin_layout Plain Layout
13851 \begin_layout Itemize
13853 \begin_inset Flex Code
13856 \begin_layout Plain Layout
13862 : name of the (temporary) exported .tex file (without path)
13865 \begin_layout Itemize
13867 \begin_inset Flex Code
13870 \begin_layout Plain Layout
13876 : name of the (temporary) exported .tex file (including path)
13879 \begin_layout Itemize
13881 \begin_inset Flex Code
13884 \begin_layout Plain Layout
13890 : name of the exported output file (either dvi or pdf, depending on which
13891 one exists in the temporary directory)
13894 \begin_layout Standard
13895 Note that only some of the viewers provide full and usable forward search
13896 functionality out of the box, among them yap, xdvi, okular
13900 \begin_layout Plain Layout
13901 You might want to set
13902 \begin_inset Flex Code
13905 \begin_layout Plain Layout
13912 \begin_inset Flex Noun
13915 \begin_layout Plain Layout
13916 Tools\SpecialChar menuseparator
13917 Preferences\SpecialChar menuseparator
13918 File Handling\SpecialChar menuseparator
13920 \begin_inset space ~
13933 , qpdfview, and SumatraPDF
13937 \begin_layout Plain Layout
13938 SumatraPDF can also use DDE commands through the external program CMCDDE
13939 — downloadable from
13940 \begin_inset CommandInset href
13942 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
13953 Others, such as evince
13957 \begin_layout Plain Layout
13958 Forward search with evince can be achieved by means of third party helper
13961 \begin_inset CommandInset href
13963 target "https://wiki.lyx.org/LyX/SyncTeX"
13973 , require some extra tools in order to use forward search.
13974 While many of the widespread PDF viewers (most notably Adobe Reader) do
13975 not support forward search at all, some other viewers – e.
13976 \begin_inset space \thinspace{}
13980 xpdf – allow at least to reload the document and jump to a specific page
13981 of the file, so you can at least navigate
13982 \begin_inset Quotes eld
13986 \begin_inset Quotes erd
13990 This latter functionality is provided by an external call of synctex (see
13991 the predefined example configurations).
13995 \begin_layout Standard
13996 Forward search works both with DVI and PDF output.
13998 simply checks which preview format you have used before (i.
13999 \begin_inset space \thinspace{}
14002 e., which format is already there in the temporary directory) and chooses
14003 the appropriate configuration for the respective format.
14006 \begin_layout Chapter
14007 Special Document Classes
14010 \begin_layout Section
14012 \change_deleted 564990737 1669742044
14016 \begin_layout Standard
14018 \change_deleted 564990737 1669742044
14024 \begin_layout Subsection
14026 \change_deleted 564990737 1669742044
14030 \begin_layout Standard
14032 \change_deleted 564990737 1669742044
14033 This section describes how \SpecialChar LyX
14034 can be used to write articles for submission
14035 to the scientific journal
14037 Astronomy and Astrophysics
14040 \begin_inset Flex URL
14043 \begin_layout Plain Layout
14045 https://www.aanda.org/
14050 ) using Version 5.01 of the document class
14055 This package can be downloaded from the ftp site
14058 \begin_layout Standard
14060 \change_deleted 564990737 1669742044
14061 \begin_inset VSpace medskip
14067 \begin_layout Standard
14070 \change_deleted 564990737 1669742044
14071 \begin_inset Flex URL
14074 \begin_layout Plain Layout
14076 ftp://ftp.edpsciences.org/pub/aa/readme.html
14084 \begin_layout Standard
14086 \change_deleted 564990737 1669742044
14087 \begin_inset VSpace medskip
14093 \begin_layout Standard
14095 \change_deleted 564990737 1669742044
14096 A manual comes together with that package, and this text is not meant to
14097 replace the original manual but is merely a short guide in how to realize
14098 the correct form of your paper.
14102 \begin_layout Standard
14104 \change_deleted 564990737 1669742044
14105 Please note that the publisher of the journal was changed from Springer
14106 to EDP Sciences starting January 1, 2001.
14107 That change involved also some slight changes to the style files, namely
14108 the removal of the thesaurus command.
14109 The \SpecialChar LyX
14110 class aa supports the newest version of these style files, V 5.01.
14111 If you have an older version installed, please upgrade.
14112 For compatibility, the old (version 4) layout has been kept as
14117 Please refer to the comments in
14120 Dir/layouts/aapaper.layout
14125 \begin_layout Subsection
14127 \change_deleted 564990737 1669742044
14131 \begin_layout Standard
14133 \change_deleted 564990737 1669742044
14134 It is recommended you start from the example template distributed with \SpecialChar LyX
14136 If you are not using a template, note the following settings:
14139 \begin_layout Itemize
14141 \change_deleted 564990737 1669742044
14148 Document\SpecialChar menuseparator
14151 dialog (OK, that one was obvious).
14154 \begin_layout Itemize
14156 \change_deleted 564990737 1669742044
14157 Don't change the option
14160 \begin_inset space ~
14170 The whole layout is done by the macros, you shouldn't change anything.
14173 \begin_layout Subsection
14175 \change_deleted 564990737 1669742044
14179 \begin_layout Standard
14181 \change_deleted 564990737 1669742044
14182 First thing to enter is the header information.
14183 It consists of seven entries, of which some are optional.
14187 \begin_layout Itemize
14189 \change_deleted 564990737 1669742044
14197 \begin_layout Itemize
14199 \change_deleted 564990737 1669742044
14207 \begin_layout Itemize
14209 \change_deleted 564990737 1669742044
14217 \begin_layout Itemize
14219 \change_deleted 564990737 1669742044
14227 \begin_layout Itemize
14229 \change_deleted 564990737 1669742044
14234 : [optional] if more than one author: whom to contact for offprint requests.
14237 \begin_layout Itemize
14239 \change_deleted 564990737 1669742044
14244 : [optional] mail address for contacts.
14247 \begin_layout Itemize
14249 \change_deleted 564990737 1669742044
14255 Suggested format is
14257 Received: <date>; Accepted <date>
14260 \begin_layout Standard
14262 \change_deleted 564990737 1669742044
14263 There is no need to issue the
14269 command, this is done automatically by \SpecialChar LyX
14270 when the header is finished.
14271 Although the order of the single header entries doesn't matter it is advised
14272 to keep the above sequence, just to get the best optics and meets the layout
14273 of the real document.
14276 \begin_layout Standard
14278 \change_deleted 564990737 1669742044
14279 If you want to place footnotes in the header block, e.
14280 \begin_inset space \thinspace{}
14284 \begin_inset space \space{}
14287 to state your present address, just use the standard footnote via the menu
14290 Insert\SpecialChar menuseparator
14295 will automagically use the term
14304 \begin_layout Standard
14306 \change_deleted 564990737 1669742044
14309 Edit\SpecialChar menuseparator
14312 , you'll find two insets which are relevant for the titling:
14315 \begin_layout Itemize
14317 \change_deleted 564990737 1669742044
14324 to mark corresponding author\SpecialChar breakableslash
14326 The institutes are numbered sequentially as they appear in the
14330 field, so you have to put a marker to each author.
14333 \begin_layout Itemize
14335 \change_deleted 564990737 1669742044
14340 to supply an email address for fast contact.
14343 \begin_layout Standard
14345 \change_deleted 564990737 1669742044
14346 In addition to these topics, the macros use one additional \SpecialChar LaTeX
14348 has no counterpart in \SpecialChar LyX
14352 \begin_layout Itemize
14354 \change_deleted 564990737 1669742044
14361 to separate different names for more than one author and institute, respectivel
14365 \begin_layout Standard
14367 \change_deleted 564990737 1669742044
14368 The appropriate command has to be entered in \SpecialChar LyX
14369 and marked as \SpecialChar LaTeX
14375 \begin_layout Subsection
14377 \change_deleted 564990737 1669742044
14381 \begin_layout Standard
14383 \change_deleted 564990737 1669742044
14384 The abstract should immediately follow the header block.
14385 With version 5 the abstract environment was changed to a command, and there
14386 is now a restriction to only one paragraph.
14387 In addition, it should contain an entry with the keywords.
14388 This is done via the paragraph style
14393 Refer to the example paper.
14396 \begin_layout Subsection
14398 \change_deleted 564990737 1669742044
14399 Supported environments
14402 \begin_layout Standard
14404 \change_deleted 564990737 1669742044
14405 The A&A paper layout supports the following environments for structuring
14409 \begin_layout Itemize
14411 \change_deleted 564990737 1669742044
14417 \begin_layout Itemize
14419 \change_deleted 564990737 1669742044
14425 \begin_layout Itemize
14427 \change_deleted 564990737 1669742044
14433 \begin_layout Itemize
14435 \change_deleted 564990737 1669742044
14441 \begin_layout Itemize
14443 \change_deleted 564990737 1669742044
14449 \begin_layout Itemize
14451 \change_deleted 564990737 1669742044
14457 \begin_layout Itemize
14459 \change_deleted 564990737 1669742044
14465 \begin_layout Itemize
14467 \change_deleted 564990737 1669742044
14473 \begin_layout Itemize
14475 \change_deleted 564990737 1669742044
14481 \begin_layout Itemize
14483 \change_deleted 564990737 1669742044
14489 \begin_layout Itemize
14491 \change_deleted 564990737 1669742044
14497 \begin_layout Itemize
14499 \change_deleted 564990737 1669742044
14506 \begin_layout Subsection
14508 \change_deleted 564990737 1669742044
14509 Commands not supported by \SpecialChar LyX
14513 \begin_layout Standard
14515 \change_deleted 564990737 1669742044
14516 Some commands are not yet supported by the
14520 layout for \SpecialChar LyX
14522 Some have already been mentioned.
14523 For the sake of completeness, they are listed all together here:
14526 \begin_layout Itemize
14528 \change_deleted 564990737 1669742044
14536 \begin_layout Itemize
14538 \change_deleted 564990737 1669742044
14546 \begin_layout Itemize
14548 \change_deleted 564990737 1669742044
14556 \begin_layout Itemize
14558 \change_deleted 564990737 1669742044
14566 \begin_layout Standard
14568 \change_deleted 564990737 1669742044
14569 If you want to use any of these commands, you have to enter them yourself.
14572 Do not forget to mark them as \SpecialChar LaTeX
14576 \begin_layout Subsection
14578 \change_deleted 564990737 1669742044
14579 Figure and Table Floats
14582 \begin_layout Standard
14584 \change_deleted 564990737 1669742044
14586 provides support for the necessary float environments
14588 figure, figure*, table
14594 , therefore we won't tell much about it here.
14598 \begin_inset space ~
14604 Just remember that tables should be left-aligned.
14605 For that, select the table and change the alignment in
14607 Edit\SpecialChar menuseparator
14609 \begin_inset space ~
14615 \begin_layout Standard
14617 \change_deleted 564990737 1669742044
14618 There is only one special thing: the figures with caption besides the figure.
14619 To create such a figure, you have to do the following:
14622 \begin_layout Enumerate
14624 \change_deleted 564990737 1669742044
14625 Create a wide figure float:
14627 Insert\SpecialChar menuseparator
14628 Float\SpecialChar menuseparator
14631 , then right click in the figure and select
14634 \begin_inset space ~
14642 \begin_layout Enumerate
14644 \change_deleted 564990737 1669742044
14645 Enter your caption text.
14648 \begin_layout Enumerate
14650 \change_deleted 564990737 1669742044
14655 to move the cursor above the caption.
14658 \begin_layout Enumerate
14660 \change_deleted 564990737 1669742044
14664 \begin_layout Enumerate
14666 \change_deleted 564990737 1669742044
14667 Position the cursor behind the figure and insert a horizontal fill:
14669 Insert\SpecialChar menuseparator
14671 \begin_inset space ~
14674 Character\SpecialChar menuseparator
14676 \begin_inset space ~
14684 \begin_layout Enumerate
14686 \change_deleted 564990737 1669742044
14687 Switch to \SpecialChar LaTeX
14691 \begin_inset space ~
14699 \begin_layout Enumerate
14701 \change_deleted 564990737 1669742044
14711 Do not close the brace!
14714 \begin_layout Enumerate
14716 \change_deleted 564990737 1669742044
14717 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
14722 \begin_inset space ~
14734 \begin_layout Standard
14736 \change_deleted 564990737 1669742044
14737 Also, refer to the figures in the example paper.
14740 \begin_layout Subsection
14742 \change_deleted 564990737 1669742044
14746 \begin_layout Standard
14748 \change_deleted 564990737 1669742044
14749 For submission, the paper has to be formated in a special double-spacing
14751 For this purpose, you have to give the option
14755 to the document class.
14756 This must be done using the custom class options field in the
14758 Document\SpecialChar menuseparator
14762 Just enter the string
14769 \begin_layout Subsection
14771 \change_deleted 564990737 1669742044
14775 \begin_layout Standard
14777 \change_deleted 564990737 1669742044
14782 directory contains an example paper written with \SpecialChar LyX
14784 It is the example paper from the original macro package, translated to
14787 Use it for inspiration, and compare the original \SpecialChar LaTeX
14788 code with \SpecialChar LyX
14792 \begin_layout Section
14796 \begin_layout Standard
14801 can be used to type letters according to German conventions.
14802 A template file is included in
14804 .../lyx/share/templates
14806 for you to use as a starting point.
14809 \begin_layout Section
14813 \begin_layout Standard
14814 See the \SpecialChar LyX
14820 It contains all infos you need.
14823 \begin_layout Section
14826 Foil\SpecialChar TeX
14830 \begin_inset CommandInset label
14839 \begin_layout Standard
14845 \begin_layout Subsection
14849 \begin_layout Standard
14850 This section describes how to use \SpecialChar LyX
14851 to make slides for overhead projectors.
14852 There are two document classes that can do this: the default slides class
14855 Foil\SpecialChar TeX
14859 This section documents the latter.
14862 \begin_layout Standard
14863 I'm going to say this again, nice and clear, so that there's no misunderstanding
14867 \begin_layout Standard
14868 \begin_inset VSpace bigskip
14874 \begin_layout Standard
14878 This section documents the class
14879 \begin_inset Quotes eld
14887 \begin_inset Quotes erd
14895 \begin_layout Standard
14896 \begin_inset VSpace bigskip
14902 \begin_layout Standard
14903 If you're looking for the documentation for
14904 \begin_inset Quotes eld
14912 \begin_inset Quotes erd
14915 , check out section
14916 \begin_inset space ~
14920 \begin_inset CommandInset ref
14922 reference "sec:slitex"
14927 If your machine doesn't have the
14935 installed, you'll probably have to use the default
14939 class, which isn't quite as good as
14944 \begin_layout Standard
14949 class is designed for use with version
14950 \begin_inset space ~
14958 class file which is now an integral part of \SpecialChar LaTeX2e
14962 \begin_layout Subsection
14966 \begin_layout Standard
14967 Obviously, to use this document class, you need to select
14978 \begin_inset space ~
14984 There are some settings in the
14987 \begin_inset space ~
14992 dialog that you should know about that are specific to this class:
14995 \begin_layout Itemize
14996 Don't change the options
15007 \begin_inset space ~
15013 They're ignored by the
15020 \begin_layout Itemize
15021 The default font size is 20
15022 \begin_inset space \thinspace{}
15025 pt with the other options being 17
15026 \begin_inset space \thinspace{}
15030 \begin_inset space \thinspace{}
15034 \begin_inset space \thinspace{}
15040 \begin_layout Itemize
15041 The default font is
15049 but all math equations are still typeset in the usual roman font.
15052 \begin_layout Itemize
15055 Foil\SpecialChar TeX
15058 supports A4 and Letter paper sizes as well as a special size for working
15060 \begin_inset space \thinspace{}
15064 It doesn't support A5, B5, legal or executive paper sizes.
15067 \begin_layout Itemize
15068 Don't bother changing the
15072 settings because they are ignored anyway.
15073 All floats appear where they are defined in the text.
15076 \begin_layout Itemize
15081 setting behaves a bit differently for this class.
15084 Foil\SpecialChar TeX
15087 provides extensive footer and header capabilities including a user-defined
15090 \begin_inset space ~
15094 \begin_inset CommandInset ref
15096 reference "sec:foilfoot"
15101 The title page is treated differently to all other pages in the document
15110 has the logo centered at the bottom of the page (if one is defined).
15111 The possible page style choices and what they do are as follows:
15115 \begin_layout Labeling
15116 \labelwidthstring MMMMMMM
15123 The final output contains no page numbers, or other headers or footers
15124 (except footnotes of course).
15128 \begin_layout Labeling
15129 \labelwidthstring MMMMMMM
15136 The final output contains page numbers centered at the bottom of the page.
15137 No other headings or footers (other than footnotes).
15140 \begin_layout Labeling
15141 \labelwidthstring MMMMMMM
15146 Page numbers in lower right corner.
15147 Additional headers and footers are also shown.
15148 This is also the default.
15151 \begin_layout Labeling
15152 \labelwidthstring MMMMMMM
15157 Gives you access to the
15161 package although its use with
15163 Foil\SpecialChar TeX
15166 is discouraged by the writer of the
15168 Foil\SpecialChar TeX
15171 package because of some potential page layout clashes.
15175 \begin_layout Subsubsection
15179 \begin_layout Standard
15180 The following options may be used in the extra class options in the
15182 Document\SpecialChar menuseparator
15188 \begin_layout Labeling
15189 \labelwidthstring MMMMMMx
15194 This sets up the page layout for 7.33
15195 \begin_inset space \thinspace{}
15199 \begin_inset space \thinspace{}
15202 in paper, which is about the same aspect ratio as a 35
15203 \begin_inset space \thinspace{}
15206 mm slide, making it a bit easier to work with this medium.
15209 \begin_layout Labeling
15210 \labelwidthstring MMMMMMx
15215 Places a rule across the page below the header on every page except the
15219 \begin_layout Labeling
15220 \labelwidthstring MMMMMMx
15225 Places a rule across the page above the footer on every page except the
15229 \begin_layout Labeling
15230 \labelwidthstring MMMMMMx
15235 This is automatically set each time you create a new
15242 Foil\SpecialChar TeX
15245 to use the dvips driver to rotate those pages that are set as landscape
15249 \begin_layout Labeling
15250 \labelwidthstring MMMMMMx
15255 Simply changes the page dimensions to those of a landscape page but doesn't
15257 Thus if you use this option you need to use an external program to rotate
15258 each page or feed your paper through your printer as landscape.
15259 Note that this option effectively reverses the roles of the
15267 environments (don't worry these are described in the next section).
15270 \begin_layout Labeling
15271 \labelwidthstring MMMMMMx
15276 Equation numbers on the left.
15279 \begin_layout Labeling
15280 \labelwidthstring MMMMMMx
15285 Flush-left equations.
15288 \begin_layout Subsection
15289 Supported Environments
15292 \begin_layout Standard
15293 Most of the environments commonly supported in other classes are also supported
15299 There are several additional environments provided by
15301 Foil\SpecialChar TeX
15304 as well as a couple added by \SpecialChar LyX
15306 The following environments are shared with other classes:
15309 \begin_layout Standard
15310 \begin_inset Flex Multiple Columns
15313 \begin_layout Itemize
15319 \begin_layout Itemize
15325 \begin_layout Itemize
15331 \begin_layout Itemize
15337 \begin_layout Itemize
15343 \begin_layout Itemize
15350 \begin_layout Itemize
15356 \begin_layout Itemize
15362 \begin_layout Itemize
15368 \begin_layout Itemize
15374 \begin_layout Itemize
15380 \begin_layout Itemize
15386 \begin_layout Itemize
15392 \begin_layout Itemize
15398 \begin_layout Itemize
15409 \begin_layout Standard
15410 That is, all the major environments apart from the sectioning environments.
15411 Since foils are essentially self-contained sections, with a title and body,
15414 Foil\SpecialChar TeX
15417 provides specific commands for starting new foils and these are:
15420 \begin_layout Itemize
15426 \begin_layout Itemize
15432 \begin_layout Standard
15434 also provides slightly modified versions of these two environments called:
15437 \begin_layout Itemize
15443 \begin_layout Itemize
15446 ShortRotatefoilhead
15449 \begin_layout Standard
15450 and the differences will be explained in the next section.
15453 \begin_layout Standard
15454 Since foils are often used in presenting ideas or new theorems and such
15457 Foil\SpecialChar TeX
15460 also provides a comprehensive box of goodies for presenting them:
15463 \begin_layout Standard
15464 \begin_inset Flex Multiple Columns
15467 \begin_layout Itemize
15473 \begin_layout Itemize
15479 \begin_layout Itemize
15485 \begin_layout Itemize
15491 \begin_layout Itemize
15497 \begin_layout Itemize
15503 \begin_layout Itemize
15509 \begin_layout Itemize
15515 \begin_layout Itemize
15521 \begin_layout Itemize
15527 \begin_layout Itemize
15538 \begin_layout Standard
15539 The starred versions are unnumbered while the unstarred versions are numbered.
15540 There are also two list environments added by \SpecialChar LyX
15544 \begin_layout Itemize
15550 \begin_layout Itemize
15556 \begin_layout Standard
15559 Foil\SpecialChar TeX
15562 provides some powerful header and footer capabilities that are best set
15563 in the preamble although they may be set at any point in a document.
15564 If you want to change these settings in your document the best place to
15565 do so is at the very top of a foil, i.
15566 \begin_inset space \thinspace{}
15572 \begin_inset space \space{}
15577 straight after the foilhead.
15580 \begin_layout Standard
15581 For this purpose, the following command styles are provided [
15588 \begin_layout Standard
15589 \begin_inset Flex Multiple Columns
15592 \begin_layout Itemize
15596 \begin_inset space ~
15602 \begin_layout Itemize
15608 \begin_layout Itemize
15612 \begin_inset space ~
15618 \begin_layout Itemize
15622 \begin_inset space ~
15628 \begin_layout Itemize
15632 \begin_inset space ~
15639 \begin_layout Plain Layout
15640 \begin_inset space ~
15652 \begin_layout Standard
15653 There are also a few commands provided by
15655 Foil\SpecialChar TeX
15658 that aren't directly supported by \SpecialChar LyX
15659 but I'll tell you what they do and how
15660 to use them in section
15661 \begin_inset space ~
15665 \begin_inset CommandInset ref
15667 reference "sec:unsuppfoils"
15674 \begin_layout Subsection
15675 Building a Set of Foils
15678 \begin_layout Standard
15679 This section will give a simple introduction to using the different environments
15680 to build a set of foils.
15681 If you want to see an example set of foils, take a look at the
15685 file you find in \SpecialChar LyX
15693 \begin_layout Subsubsection
15694 Give It a Title Page
15697 \begin_layout Standard
15698 Unlike other classes that provide
15718 creates the title on a page of its own.
15719 If you leave out the
15723 environment \SpecialChar LaTeX
15724 will substitute the current date (every time you regenerate
15728 \begin_layout Subsubsection
15732 \begin_layout Standard
15733 As I mentioned earlier, there are four ways of starting a new foil.
15734 For portrait foils you should use
15743 The difference between these two environments is the amount of space between
15744 the title of the foil (the foilhead) and the body of the foil.
15747 \begin_layout Standard
15748 Landscape foils are generated using the
15754 ShortRotatefoilhead
15757 Again the only difference is the spacing between foilhead and body.
15758 Both of the short versions have 0.5
15759 \begin_inset space ~
15762 inches less separation between the foilhead and the body.
15766 \begin_layout Standard
15767 One problem with the support for landscape foils is the requirement that
15768 you have to use the
15772 driver to generate the PostScript output otherwise the foils won't be rotated.
15773 It is possible to get landscape foils even if you haven't got the
15777 driver provided you can feed your foils sideways through your printer ;-)
15780 \begin_layout Subsubsection
15781 Theorems, Lemmas, Proofs and more
15784 \begin_layout Standard
15785 You can't have two of the same type of these environments directly following
15787 If you use a normal paragraph break, , you will just be extending the previous
15788 environment as if you had merged the two environments together.
15789 Rather than that, you need to insert a so-called separator.
15790 Please refer to the section entitled
15801 \begin_layout Subsubsection
15805 \begin_layout Standard
15806 You get all the commonly supported list styles found in other classes as
15807 well as two new ones.
15808 I'll only describe the new ones here.
15809 If you want to find out more about the other list environments check out
15815 If you intend to use itemized lists you might also want to read about the
15819 \begin_inset space ~
15823 \begin_inset space ~
15828 dialog described above in section
15829 \begin_inset space ~
15833 \begin_inset CommandInset ref
15835 reference "sec:bullet"
15842 \begin_layout Standard
15843 The two new list styles,
15851 , are designed to make it easier for you to create lists of do's and don'ts
15852 or right and wrong by providing dedicated environments that use a tick
15853 or a cross as the label of the list.
15854 These lists are in fact dedicated variants of the
15859 They do however require that you have the
15863 packages installed.
15866 \begin_layout Subsubsection
15870 \begin_layout Standard
15873 Foil\SpecialChar TeX
15876 redefines the floating tables and figures so that they appear exactly where
15877 they are in the text rather than pushing them to the top of the page or
15878 to some user specified location.
15879 In fact if you change the float placement settings they are simply ignored.
15882 \begin_layout Subsubsection
15883 Page Headers and Footers
15884 \begin_inset CommandInset label
15886 name "sec:foilfoot"
15893 \begin_layout Standard
15897 \begin_inset space ~
15906 are two commands used to control the left-footer text string.
15907 The first is meant to allow you to include a graphic logo on your foils
15909 \begin_inset Quotes eld
15914 Foil\SpecialChar TeX
15918 \begin_inset Quotes erd
15922 While the second is meant to provide a classification for the audience,
15926 \begin_inset space \thinspace{}
15932 \begin_inset space \space{}
15936 It is empty by default.
15939 \begin_layout Standard
15940 The remaining page corners can be filled by
15943 \begin_inset space ~
15948 (which defaults to page numbers),
15951 \begin_inset space ~
15959 \begin_inset space ~
15967 \begin_layout Subsection
15970 Foil\SpecialChar TeX
15974 \begin_inset CommandInset label
15976 name "sec:unsuppfoils"
15983 \begin_layout Standard
15984 All the commands mentioned below need to be set in a
15994 within another environment.
15997 \begin_layout Subsubsection
16001 \begin_layout Standard
16002 All lengths are adjusted using the
16025 should be replaced by the name given to the length you want to change and
16030 is the length value.
16031 All lengths should be specified in units of length such as inches (
16043 ) or relative to some document or font-based length such as
16053 \begin_layout Standard
16054 It's possible to change the spacing between a foilhead and the body of the
16055 foil by adjusting the length specified by
16062 For example, to make
16067 \begin_inset space \space{}
16070 in closer to their bodies put the following in the preamble:
16076 foilheadskip}{-0.5in}
16079 \begin_layout Standard
16080 The spacings around floats can be adjusted by setting these lengths:
16083 \begin_layout Labeling
16084 \labelwidthstring MMMMMMMMMMM
16091 Separation between the text and the top of the float
16094 \begin_layout Labeling
16095 \labelwidthstring MMMMMMMMMMM
16102 Separation between the float and the caption
16105 \begin_layout Labeling
16106 \labelwidthstring MMMMMMMMMMM
16113 Separation between the caption and the following text
16116 \begin_layout Labeling
16117 \labelwidthstring MMMMMMMMMMM
16124 You can make the captions narrower than the surrounding text by adjusting
16126 Best done relative to
16135 \begin_layout Standard
16136 There are also several title page related lengths that you may find useful
16137 if you have a long title or several authors:
16140 \begin_layout Labeling
16141 \labelwidthstring MMMMMMMMMMM
16148 Separation from headers to
16153 \begin_layout Labeling
16154 \labelwidthstring MMMMMMMMMMM
16172 \begin_layout Labeling
16173 \labelwidthstring MMMMMMMMMMM
16187 \begin_layout Labeling
16188 \labelwidthstring MMMMMMMMMMM
16204 \begin_layout Labeling
16205 \labelwidthstring MMMMMMMMMMM
16221 \begin_layout Standard
16222 The last length related command affects all the list environments.
16233 a list environment then all the vertical spacing between the list items
16235 Note that this is a command not a length so it doesn't require
16241 like the stuff mentioned above.
16244 \begin_layout Subsubsection
16245 Headers and Footers
16248 \begin_layout Standard
16261 commands control whether the logo in the
16265 definition appear on a given page.
16272 in the preamble then none of the foils will have the logo on them.
16273 If you don't want the logo on a particular page place the
16279 directly after the foilhead of that page and the
16285 directly after the next foilhead.
16288 \begin_layout Standard
16289 If you decide to use the
16293 page style setting in the
16296 \begin_inset space ~
16301 dialog you should probably add
16311 to your preamble so headers and footers on landscape pages are correctly
16312 placed when rotated.
16313 This is due to some clashes between the page layouts provided by the
16324 \begin_layout Section
16326 \change_deleted 564990737 1669755802
16330 \begin_layout Standard
16332 \change_deleted 564990737 1669755802
16335 Panayotis Papasotiriou
16338 \begin_layout Subsection
16340 \change_deleted 564990737 1669755802
16344 \begin_layout Standard
16346 \change_deleted 564990737 1669755802
16347 The ijmpc package is a set of macros that facilitates electronic manuscript
16350 International Journal of Modern Physics C
16353 Similarly, the ijmpd package is for creating manuscripts to be submitted
16356 International Journal of Modern Physics D
16359 Both journals are published by World Scientific.
16360 The corresponding document classes are named
16369 These files, together with instructions for the authors, can be downloaded
16371 \begin_inset Flex URL
16374 \begin_layout Plain Layout
16376 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
16382 \begin_inset Flex URL
16385 \begin_layout Plain Layout
16387 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
16393 Both packages are modified versions of the standard
16394 \begin_inset Quotes eld
16398 \begin_inset Quotes erd
16401 package, and they are almost (but not exactly) identical.
16402 Most of their features are supported by \SpecialChar LyX
16404 I have used \SpecialChar LyX
16405 successfully to write articles submitted to both journals
16406 without any problem.
16409 \begin_layout Subsection
16411 \change_deleted 564990737 1669755802
16415 \begin_layout Standard
16417 \change_deleted 564990737 1669755802
16418 As usual, the easiest way to write a paper is to start with a template.
16421 File\SpecialChar menuseparator
16437 This will give an (almost) empty document that includes the most common
16438 fields found in a manuscript.
16439 Simply overwrite the existing text (including the brackets,
16444 You should keep in mind the following remarks.
16447 \begin_layout Enumerate
16449 \change_deleted 564990737 1669755802
16451 won't let you change the font size and the page style of the document,
16452 because such modifications are not allowed by both packages.
16455 \begin_layout Enumerate
16457 \change_deleted 564990737 1669755802
16458 The language of the document should not be changed.
16459 Before previewing your paper, be sure that the babel package is not used.
16460 To do this, click on
16463 arg "dialog-show document"
16468 \SpecialChar menuseparator
16472 \begin_inset Quotes eld
16476 \begin_inset Quotes erd
16486 \begin_layout Enumerate
16488 \change_deleted 564990737 1669755802
16490 \begin_inset Quotes eld
16494 \begin_inset Quotes erd
16497 style must be used to define keywords.
16500 \begin_layout Enumerate
16502 \change_deleted 564990737 1669755802
16503 The ijmpc package provides a style named
16504 \begin_inset Quotes eld
16507 Classification Codes
16508 \begin_inset Quotes erd
16511 , which can be used to define classification codes, such as PACS numbers.
16512 Note that this facility is not supported by the ijmpd package.
16515 \begin_layout Enumerate
16517 \change_deleted 564990737 1669755802
16518 Several new environments are available:
16519 \begin_inset Quotes eld
16523 \begin_inset Quotes erd
16527 \begin_inset Quotes eld
16531 \begin_inset Quotes erd
16535 \begin_inset Quotes eld
16539 \begin_inset Quotes erd
16543 \begin_inset Quotes eld
16547 \begin_inset Quotes erd
16551 \begin_inset Quotes eld
16555 \begin_inset Quotes erd
16559 \begin_inset Quotes eld
16563 \begin_inset Quotes erd
16567 \begin_inset Quotes eld
16571 \begin_inset Quotes erd
16575 \begin_inset Quotes eld
16579 \begin_inset Quotes erd
16583 \begin_inset Quotes eld
16587 \begin_inset Quotes erd
16591 \begin_inset Quotes eld
16595 \begin_inset Quotes erd
16599 \begin_inset Quotes eld
16603 \begin_inset Quotes erd
16607 \begin_inset Quotes eld
16611 \begin_inset Quotes erd
16615 \begin_inset Quotes eld
16619 \begin_inset Quotes erd
16623 \begin_inset Quotes eld
16627 \begin_inset Quotes erd
16631 Their use is more or less obvious.
16633 supports all these environments; it will use the proper label, text style,
16634 and numbering scheme for each of them.
16637 \begin_layout Enumerate
16639 \change_deleted 564990737 1669755802
16640 Both packages use basic citations; the natbib package should not be used.
16641 In \SpecialChar LyX
16642 , citation references are shown as usual; in the output, citations are
16643 shown as superscripts.
16644 If you want to use a citation as normal text, you should use the
16649 \begin_inset space \thinspace{}
16653 \begin_inset space \space{}
16657 \begin_inset Quotes eld
16661 \begin_inset space \space{}
16671 \begin_inset Quotes erd
16677 \begin_layout Enumerate
16679 \change_deleted 564990737 1669755802
16681 \begin_inset Quotes eld
16685 \begin_inset Quotes erd
16688 section in both packages.
16689 To put acknowledgments, just use the
16690 \begin_inset Quotes eld
16694 \begin_inset Quotes erd
16700 \begin_layout Enumerate
16702 \change_deleted 564990737 1669755802
16703 Appendices may be added to the paper,
16707 the Acknowledgments and
16713 provides a special environment, called
16714 \begin_inset Quotes eld
16718 \begin_inset Quotes erd
16721 which marks the beginning of the appendices.
16722 This environment should be left blank; it just sends a \SpecialChar LaTeX
16723 command, but nothing
16725 In \SpecialChar LyX
16727 \begin_inset Quotes eld
16731 \begin_inset Quotes erd
16734 is printed with blue letters, as a signal that all sections after that
16735 point are appendices.
16736 To write an appendix, use the
16737 \begin_inset Quotes eld
16741 \begin_inset Quotes erd
16746 will number each appendix with capital letters, as required by both journals.
16748 \begin_inset Quotes eld
16752 \begin_inset Quotes erd
16759 be present before the first appendix; if not, all appendices will be numbered
16760 as normal sections in the output.
16763 \begin_layout Enumerate
16765 \change_deleted 564990737 1669755802
16766 The ijmpc and the ijmpd packages use the
16770 command to implement table captions.
16771 As a result, a table created by \SpecialChar LyX
16772 is printed correctly, but its caption
16774 However, you can use some \SpecialChar TeX
16775 code to overcome this problem, so that captions
16776 are printed as expected.
16777 To do so, create a float table as usual, remove the caption, and replace
16778 it with the \SpecialChar TeX
16789 (sic); you must also the \SpecialChar TeX
16794 immediately after the tabular material.
16795 Study the example table included in the template files to see how this
16796 trick is implemented.
16797 Alternatively, If you need table captions, you should implement the whole
16802 file, then include this file to the \SpecialChar LyX
16805 Insert\SpecialChar menuseparator
16806 File\SpecialChar menuseparator
16808 \begin_inset space ~
16814 Details on how to create a table float can be found in the files
16822 , included in the corresponding packages.
16825 \begin_layout Subsection
16827 \change_deleted 564990737 1669755802
16828 Preparing a paper for submission
16831 \begin_layout Standard
16833 \change_deleted 564990737 1669755802
16834 Before you submit your paper you must export the \SpecialChar LyX
16835 document as a \SpecialChar LaTeX
16838 File\SpecialChar menuseparator
16839 Export\SpecialChar menuseparator
16847 \begin_layout Plain Layout
16848 Actually you have the choice between \SpecialChar LaTeX
16849 (plain) and pdflatex.
16850 If you intend to use pdflatex to prepare the paper, you should use the
16851 pdflatex option so that included graphics are converted to PDF format,
16852 ready for use by pdflatex.
16857 , then make the following changes to the resulting
16864 \begin_layout Enumerate
16866 \change_deleted 564990737 1669755802
16867 Remove the comment lines before the
16876 \begin_layout Enumerate
16878 \change_deleted 564990737 1669755802
16879 Remove everything between (and including) the
16891 commands, except for any commands you specifically put into the \SpecialChar LaTeX
16895 \begin_layout Standard
16897 \change_deleted 564990737 1669755802
16902 file should be saved and processed through \SpecialChar LaTeX
16903 as many times as necessary.
16904 You may also want to check the resulting
16913 \begin_layout Section
16915 \change_deleted 564990737 1669801478
16919 \begin_layout Standard
16921 \change_deleted 564990737 1669801478
16927 \begin_layout Subsection
16929 \change_deleted 564990737 1669801478
16933 \begin_layout Standard
16935 \change_deleted 564990737 1669801478
16936 The iopart package provides a document class to create electronic manuscript
16937 submission to the journals published by the Institute of Physics.
16938 Instructions for the authors how to create a paper using the iopart class
16939 can be downloaded together with the iopart package from the site
16940 \begin_inset Flex URL
16943 \begin_layout Plain Layout
16945 ftp://ftp.iop.org/pub/journals/latex2e
16953 \begin_layout Subsection
16955 \change_deleted 564990737 1669801478
16959 \begin_layout Standard
16961 \change_deleted 564990737 1669801478
16962 The easiest way to write a paper is to start with the template
16966 that is available via
16968 File\SpecialChar menuseparator
16971 The template explains how to use the special text environments.
16972 Here are the most important advices:
16975 \begin_layout Itemize
16977 \change_deleted 564990737 1669801478
16978 To be able to compile your document to a PDF, PS, or DVI, ensure that the
16979 no AMS packages are loaded in
16981 Document\SpecialChar menuseparator
16982 Settings\SpecialChar menuseparator
16988 \begin_layout Itemize
16990 \change_deleted 564990737 1669801478
16993 The title environment defines the kind of your paper.
16994 So use one of the following environments for the title:
16998 \begin_layout Itemize
17000 \change_deleted 564990737 1669801478
17009 \begin_layout Itemize
17011 \change_deleted 564990737 1669801478
17020 \begin_layout Itemize
17022 \change_deleted 564990737 1669801478
17028 for a Topical review
17031 \begin_layout Itemize
17033 \change_deleted 564990737 1669801478
17042 \begin_layout Itemize
17044 \change_deleted 564990737 1669801478
17053 \begin_layout Itemize
17055 \change_deleted 564990737 1669801478
17061 for a Paper (same as Title)
17064 \begin_layout Itemize
17066 \change_deleted 564990737 1669801478
17072 for a Preliminary communication
17075 \begin_layout Itemize
17077 \change_deleted 564990737 1669801478
17083 for a Rapid communication
17086 \begin_layout Itemize
17088 \change_deleted 564990737 1669801478
17094 for a Letter to the editor
17098 \begin_layout Itemize
17100 \change_deleted 564990737 1669801478
17103 All title environments except of
17107 can have an optional short title.
17110 \begin_layout Itemize
17112 \change_deleted 564990737 1669801478
17113 There is a general title environment
17117 which is not directly supported by \SpecialChar LyX
17119 This can be used as \SpecialChar TeX
17120 code when your document doesn't fit into one of the
17124 \begin_layout Standard
17126 \change_deleted 564990737 1669801478
17127 For more informations like hints for special table and formula formatting,
17128 look at the IOP author guidelines.
17133 \begin_layout Section
17135 \change_deleted 564990737 1670317155
17139 \begin_layout Standard
17141 \change_deleted 564990737 1670317155
17144 Panayotis Papasotiriou
17147 \begin_layout Subsection
17149 \change_deleted 564990737 1670317155
17153 \begin_layout Standard
17155 \change_deleted 564990737 1670317155
17156 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
17157 that facilitates electronic manuscript submission to the journals they
17159 Most known of them (at least in my domain of interest) are
17161 Astrophysics and Space Science
17167 , but there are many others (see a complete list at
17168 \begin_inset Flex URL
17171 \begin_layout Plain Layout
17173 http://www.wkap.nl/jrnllist.htm/JRNLHOME
17179 The Kluwer package may be downloaded from the site
17180 \begin_inset Flex URL
17183 \begin_layout Plain Layout
17185 http://www.wkap.nl/kaphtml.htm/STYLEFILES
17191 A complete user guide is contained in that package (but it can also be
17192 downloaded separately).
17195 \begin_layout Standard
17197 \change_deleted 564990737 1670317155
17199 supports many features of the package but not everything.
17200 However, the \SpecialChar TeX
17201 code needed is reduced to some
17202 \begin_inset Quotes eld
17206 \begin_inset Quotes erd
17209 commands of the package (see
17210 \begin_inset space ~
17214 \begin_inset CommandInset ref
17216 reference "subsec:kluwer_peculiarities"
17221 I have recently used \SpecialChar LyX
17222 to write an article submitted to the
17224 Astrophysics and Space Science
17226 without any problem.
17229 \begin_layout Subsection
17231 \change_deleted 564990737 1670317155
17235 \begin_layout Standard
17237 \change_deleted 564990737 1670317155
17238 The easiest way to write a paper is to start with the Kluwer template file.
17241 File\SpecialChar menuseparator
17253 This will give an (almost) empty document that includes the most common
17254 fields found in a manuscript and a short description of their use.
17255 As in most templates, simply overwrite the existing text (including the
17260 ) with the correct information.
17263 \begin_layout Subsection
17265 \change_deleted 564990737 1670317155
17266 Preparing a paper for submission
17269 \begin_layout Standard
17271 \change_deleted 564990737 1670317155
17272 As in the AAS\SpecialChar TeX
17273 package, before you submit your paper to a journal you must
17275 \begin_inset Quotes eld
17279 \begin_inset Quotes erd
17285 \begin_layout Enumerate
17287 \change_deleted 564990737 1670317155
17288 Export your paper as a \SpecialChar LaTeX
17290 To do this, click on
17292 File\SpecialChar menuseparator
17293 Export\SpecialChar menuseparator
17301 \begin_layout Enumerate
17303 \change_deleted 564990737 1670317155
17308 file with a text editor and make the following changes
17312 \begin_layout Enumerate
17314 \change_deleted 564990737 1670317155
17315 remove the comment lines before the
17324 \begin_layout Enumerate
17326 \change_deleted 564990737 1670317155
17327 remove everything between (and including) the
17339 commands, except for any commands you specifically put into the \SpecialChar LaTeX
17343 \begin_layout Standard
17345 \change_deleted 564990737 1670317155
17354 \begin_layout Enumerate
17356 \change_deleted 564990737 1670317155
17361 file through \SpecialChar LaTeX
17362 as many times as necessary (usually up to three).
17365 \begin_layout Enumerate
17367 \change_deleted 564990737 1670317155
17373 \begin_inset space \thinspace{}
17377 \begin_inset space \space{}
17384 , and check if everything is OK (it should, if you didn't make any mistake).
17387 \begin_layout Subsection
17389 \change_deleted 564990737 1670317155
17390 \begin_inset Quotes eld
17394 \begin_inset Quotes erd
17397 of the Kluwer package
17398 \begin_inset CommandInset label
17400 name "subsec:kluwer_peculiarities"
17407 \begin_layout Standard
17409 \change_deleted 564990737 1670317155
17410 The Kluwer package has the following
17411 \begin_inset Quotes eld
17415 \begin_inset Quotes erd
17421 \begin_layout Enumerate
17423 \change_deleted 564990737 1670317155
17424 It is possible to write multiple articles in the same \SpecialChar LaTeX
17429 \begin_layout Plain Layout
17430 I can't imagine any good reason to do this.
17436 Each article must be included in the environment
17437 \begin_inset Quotes eld
17441 \begin_inset Quotes erd
17445 Unfortunately, this environment cannot be omitted, even if you write just
17447 Therefore, each article starts with the command
17453 and, obviously, ends with the command
17460 Although this can be implemented in \SpecialChar LyX
17461 , I didn't included it, since it looks
17462 ugly and can confuse the novice user.
17463 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
17466 \begin_inset Quotes eld
17471 \begin_inset Quotes erd
17477 \begin_layout Enumerate
17479 \change_deleted 564990737 1670317155
17480 Information given at the beginning of the article (i.
17481 \begin_inset space \thinspace{}
17485 \begin_inset space \space{}
17488 title, subtitle, author, institution, running title, running author, abstract
17489 and keywords) must be included in an environment called
17490 \begin_inset Quotes eld
17494 \begin_inset Quotes erd
17498 This is not implemented in \SpecialChar LyX
17499 , so you must enter title, subtitle etc.
17500 \begin_inset space ~
17503 between two \SpecialChar TeX
17519 \begin_layout Enumerate
17521 \change_deleted 564990737 1670317155
17522 According to the user manual, the label of each bibliography item must be
17546 \begin_layout Standard
17548 \change_deleted 564990737 1670317155
17553 template takes care of all these
17554 \begin_inset Quotes eld
17558 \begin_inset Quotes erd
17562 If you start a new paper using this template you don't need to do anything
17567 \begin_layout Enumerate
17569 \change_deleted 564990737 1670317155
17570 don't delete the \SpecialChar TeX
17571 code included in the template, and
17574 \begin_layout Enumerate
17576 \change_deleted 564990737 1670317155
17577 copy the example bibliography item included in the template and modify it
17578 as necessary to enter new bibliography items.
17581 \begin_layout Section
17582 Article (mwart), book (mwbk) and report (mwrep)
17583 \begin_inset Argument status
17586 \begin_layout Plain Layout
17599 \begin_layout Standard
17605 \begin_layout Standard
17606 The \SpecialChar LyX
17623 correspond to the \SpecialChar LaTeX
17637 They are replacements for the standard document classes
17649 , resp., and fit better to Polish typography conventions in a number of points.
17653 \begin_layout Standard
17657 \begin_layout Itemize
17658 Unnumbered titles (with star, e.
17659 \begin_inset space \thinspace{}
17663 \begin_inset space \space{}
17670 ) are added into table of contents,
17673 \begin_layout Itemize
17674 Additional page styles:
17678 \begin_layout Description
17679 uheadings header with separated lines,
17682 \begin_layout Description
17683 myheadings custom header, contents headers via commands:
17698 \begin_layout Description
17699 myuheadings custom header with separated lines,
17702 \begin_layout Description
17703 outer page number is placed on outer side of page
17707 \begin_layout Itemize
17712 \begin_layout Description
17713 rmheadings serif titles — default,
17716 \begin_layout Description
17717 sfheadings sansserif titles,
17720 \begin_layout Description
17721 authortitle on title page first placed is author next title — default,
17724 \begin_layout Description
17725 titleauthor on title page first placed is title next author,
17728 \begin_layout Description
17729 withmarginpar reserve place on page for margins.
17733 \begin_layout Section
17737 \begin_layout Standard
17742 provides an alternative to the standard
17747 It provides similar functionality, but you might prefer this layout with
17748 sans serif sections, headings, and more.
17751 \begin_layout Section
17752 Rev\SpecialChar TeX
17756 \begin_layout Standard
17762 \begin_layout Standard
17763 \begin_inset VSpace bigskip
17769 \begin_layout Standard
17774 \begin_inset space ~
17779 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
17781 \begin_inset Formula $\beta$
17784 release of May, 1999) class.
17787 \begin_layout Standard
17793 textclass, which works with Rev\SpecialChar TeX
17795 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
17797 That means that it doesn't interact very well with \SpecialChar LyX
17798 , which requires \SpecialChar LaTeX2e
17800 it has been kludged to work.
17801 Since Rev\SpecialChar TeX
17802 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
17807 Rev\SpecialChar TeX
17809 \begin_inset space ~
17814 textclass should also be pretty easy to use.
17817 \begin_layout Standard
17818 These documents are supposed to be used in
17822 to the Rev\SpecialChar TeX
17823 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
17825 and assume you'll know what to put in the preamble if necessary.
17828 \begin_layout Subsection
17832 \begin_layout Standard
17833 All you need to do is install Rev\SpecialChar TeX
17834 4, as described in the package's README
17836 The package can be found at The Rev\SpecialChar TeX
17838 \begin_inset Flex URL
17841 \begin_layout Plain Layout
17843 http://publish.aps.org/revtex4/
17849 Install it somewhere that \SpecialChar LaTeX
17851 Test it by trying to \SpecialChar LaTeX
17852 a short Rev\SpecialChar TeX
17853 4 document in some random directory (i.
17854 \begin_inset space \thinspace{}
17858 \begin_inset space \space{}
17861 not the directory where you installed the class file.) Then, if you reconfigure
17863 , it will find the class file and let you use the Rev\SpecialChar TeX
17867 \begin_layout Standard
17868 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
17877 \begin_inset space ~
17882 template, found in the templates directory.
17885 \begin_layout Subsection
17889 \begin_layout Standard
17890 Optional arguments to
17897 \begin_inset Quotes eld
17901 \begin_inset Quotes erd
17905 \begin_inset Quotes eld
17909 \begin_inset Quotes erd
17915 \begin_inset space ~
17923 \begin_inset space ~
17929 Remember that in Rev\SpecialChar TeX
17930 , at least one optional argument is required!
17933 \begin_layout Standard
17934 Other preamble matter, like
17941 \begin_inset space ~
17948 \begin_inset space ~
17953 dialog, also as usual.
17956 \begin_layout Subsection
17960 \begin_layout Standard
17961 The layouts basically correspond to the commands in Rev\SpecialChar TeX
17963 For example, the Email layout corresponds to
17970 Note that (at least as of Rev\SpecialChar TeX
17979 layouts are exactly equivalent, so you shouldn't need to use both.
17983 \begin_layout Plain Layout
17984 In case you're curious, both were included so that
17988 would be able to translate both
18008 \begin_layout Subsection
18012 \begin_layout Standard
18013 There are a couple of important unique aspects of Rev\SpecialChar TeX
18014 4 which might cause
18015 bugs that will be even more confusing in \SpecialChar LyX
18019 \begin_layout Standard
18020 In Rev\SpecialChar TeX
18038 The \SpecialChar LyX
18039 equivalent is that there is a separate Thanks layout.
18044 write footnotes in the
18048 layout, or weird things may happen.
18049 See the Rev\SpecialChar TeX
18050 4 documentation for more details.
18053 \begin_layout Standard
18057 \begin_inset space ~
18065 \begin_inset space ~
18074 layouts must be placed
18082 layout and the corresponding
18099 , the \SpecialChar LaTeX
18103 \begin_layout Section
18104 Springer Journals (
18111 \begin_layout Standard
18117 \begin_layout Subsection
18121 \begin_layout Standard
18122 These are the layout files for some of the journal formats used by Springer
18123 Verlag and listed on
18124 \begin_inset Flex URL
18127 \begin_layout Plain Layout
18129 http://www.springer.de/author/tex/help-journals.html
18134 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
18136 It is a modular system: the things common to all journals are implemented
18141 , which journal-specific layout files (such as, e.
18142 \begin_inset space \thinspace{}
18146 \begin_inset space \space{}
18153 for Journal of Geodesy) can include.
18156 \begin_layout Standard
18157 This means that implementing support for any other Springer journal on this
18158 list is as simple as writing your own
18166 file following the outline given in
18174 \begin_layout Standard
18175 It is reasonably well tested only for the Journal of Geodesy.
18184 come with the standard \SpecialChar LyX
18186 Install the relevant class file (downloaded from Springer) in a proper
18187 directory, reconfigure \SpecialChar LaTeX
18188 (in the te\SpecialChar TeX
18193 , as root if necessary — doesn't \SpecialChar LyX
18194 take care of this?), reconfigure \SpecialChar LyX
18199 \begin_layout Subsection
18203 \begin_layout Standard
18204 A large number of theorem-like styles —
18216 \begin_layout Standard
18219 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
18220 _Title, Author_Running, Institute,
18221 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
18224 See the Springer class file documentation for details.
18227 \begin_layout Subsection
18231 \begin_layout Itemize
18243 \begin_layout Itemize
18246 Probability Theory and Related Fields
18252 — Jean-Marc Lasgouttes
18255 \begin_layout Standard
18256 Add your own, it isn't so hard!
18259 \begin_layout Subsection
18263 \begin_layout Standard
18264 These files are partly based on the older
18268 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
18270 file from Springer.
18275 layout, are now defunct.
18276 Jean-Marc Lasgouttes helped out big in making me find my way around the
18278 layout file mechanism.
18281 \begin_layout Subsection
18285 \begin_layout Standard
18287 But probably less than in the old hacked-\SpecialChar LaTeX
18295 \begin_layout Section
18298 Sli\SpecialChar TeX
18302 \begin_inset CommandInset label
18311 \begin_layout Standard
18319 \begin_layout Subsection
18323 \begin_layout Standard
18324 This section describes how to use \SpecialChar LyX
18325 to make slides for overhead projectors.
18326 There are two document classes that can do this: the default slides class
18329 Foil\SpecialChar TeX
18333 This section documents the former.
18336 \begin_layout Standard
18337 I'm going to say this again, nice and clear, so that there's no misunderstanding
18341 \begin_layout Standard
18342 \begin_inset VSpace bigskip
18348 \begin_layout Standard
18352 This section documents the class
18353 \begin_inset Quotes eld
18361 \begin_inset Quotes erd
18369 \begin_layout Standard
18370 \begin_inset VSpace bigskip
18376 \begin_layout Standard
18377 If you're looking for the documentation for
18378 \begin_inset Quotes eld
18383 slides (Foil\SpecialChar TeX
18387 \begin_inset Quotes erd
18390 , check out section
18391 \begin_inset space ~
18395 \begin_inset CommandInset ref
18397 reference "sec:foiltex"
18407 \begin_inset Quotes eld
18412 slides (Foil\SpecialChar TeX
18416 \begin_inset Quotes erd
18419 ] is actually somewhat better than the default
18427 \begin_layout Plain Layout
18429 or so I've been told repeatedly by its advocates.
18430 Having never used it, I have no idea if this claim is true or not.
18435 which this section documents.
18438 \begin_layout Standard
18439 This class is the \SpecialChar LaTeX2e
18440 improvement of the old
18442 Sli\SpecialChar TeX
18446 Every \SpecialChar LaTeX2e
18447 distribution includes this class [which I'll just refer to as
18448 \begin_inset Quotes eld
18456 \begin_inset Quotes erd
18459 from now on], so you're bound to have it.
18460 As I noted earlier, there are other classes, such as
18464 , which also produce slides for overhead projectors and do a better job
18466 However, there are some things which
18470 can do which the others can't, such as generate overlays.
18471 Read on to learn more!
18474 \begin_layout Subsection
18476 \begin_inset CommandInset label
18478 name "sec:slidesetup"
18485 \begin_layout Standard
18486 Obviously, to use this document class, you need to select
18487 \begin_inset Quotes eld
18495 \begin_inset Quotes erd
18498 from the class list in the
18500 Document\SpecialChar menuseparator
18504 There are some other special things you should know about this class:
18507 \begin_layout Itemize
18508 Don't bother changing the options
18513 They're not supported by the
18520 \begin_layout Itemize
18524 \begin_inset space ~
18529 behaves a bit differently for this class.
18530 The possible choices and what they do are as follows:
18534 \begin_layout Description
18539 The final output contains page numbers in the lower right corner.
18542 \begin_layout Description
18551 , but also prints out any time markers you've put in.
18552 This is the default.
18555 \begin_layout Description
18560 The final output contains no page numbers, time markers, or alignment markers.
18564 \begin_layout Itemize
18569 class has an extra option:
18575 \begin_inset Quotes eld
18583 \begin_inset Quotes erd
18586 in the extra class options.
18590 \begin_layout Standard
18591 Using this options allows you to add time markers to
18597 \begin_inset space ~
18601 \begin_inset CommandInset ref
18603 reference "sec:slideNote"
18611 \begin_layout Standard
18612 You can also use the template file
18613 \begin_inset Quotes eld
18621 \begin_inset Quotes erd
18624 to automatically set up a document to use the
18630 File\SpecialChar menuseparator
18632 \begin_inset space ~
18636 \begin_inset space ~
18641 to open your new document].
18642 The template file also contains some examples of the special paragraph
18643 environments used by this class.
18644 I'll describe those next.
18647 \begin_layout Subsection
18648 Paragraph Environments
18651 \begin_layout Subsubsection
18652 Supported Environments
18655 \begin_layout Standard
18656 The first thing you'll notice when you start up a new
18660 document is the font size and type: it's the equivalent of the size
18661 \begin_inset Quotes eld
18669 \begin_inset Quotes erd
18675 \begin_inset space ~
18681 This is also what's used in the output.
18683 \begin_inset Quotes eld
18687 \begin_inset Quotes erd
18690 to remind you that this is a slide.
18691 Your final slides will use a larger font; ergo, you'll have less space.
18692 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
18695 \begin_layout Standard
18696 The next thing that becomes obvious is the changes to the paragraph environment
18697 pull-down box [at the far-left end of the toolbar].
18698 Most of the paragraph environments you're used to seeing are missing.
18699 There are also five new ones.
18704 class itself only supports certain paragraph environments:
18707 \begin_layout Itemize
18713 \begin_layout Itemize
18719 \begin_layout Itemize
18725 \begin_layout Itemize
18731 \begin_layout Itemize
18737 \begin_layout Itemize
18743 \begin_layout Itemize
18749 \begin_layout Itemize
18755 \begin_layout Itemize
18761 \begin_layout Itemize
18768 \begin_layout Standard
18769 All of the other standard environments, including the section-heading environmen
18770 ts, aren't used in the
18777 \begin_layout Standard
18778 On the other hand, you'll notice the following new environments:
18781 \begin_layout Itemize
18787 \begin_layout Itemize
18793 \begin_layout Itemize
18799 \begin_layout Itemize
18805 \begin_layout Itemize
18811 \begin_layout Standard
18812 These five are kind of quirky, due to a
18813 \begin_inset Quotes eld
18817 \begin_inset Quotes erd
18820 in \SpecialChar LyX
18822 You see, \SpecialChar LyX
18823 doesn't permit you to nest any other paragraph environment into
18824 an empty environment.
18825 Now, that's fine and dandy, but it means that you wouldn't be able to start
18826 a slide with anything except plain text.
18827 To deal with this, I've performed a little
18828 \begin_inset Quotes eld
18833 \begin_inset Quotes erd
18839 \begin_layout Subsubsection
18840 Quirks of the New Environments
18841 \begin_inset CommandInset label
18843 name "sec:slideQuirk"
18850 \begin_layout Standard
18851 All five of the new paragraph environments are somewhat quirky due to inherent
18852 limitiations in the current version of \SpecialChar LyX
18854 As I just mentioned, \SpecialChar LyX
18855 forbids environments that begin with another environment.
18856 To get around this, the
18860 environment isn't a paragraph environment as described in the
18868 \begin_layout Standard
18869 You should consider
18882 \begin_inset Quotes eld
18885 pseudo-environments.
18886 \begin_inset Quotes erd
18889 They look like a section heading or a
18890 \begin_inset Quotes eld
18898 \begin_inset Quotes erd
18901 but really begin a [and, if necessary, end the previous] paragraph environment.
18911 \begin_inset Quotes eld
18915 \begin_inset Quotes erd
18918 These two perform some action.
18921 \begin_layout Standard
18922 A common feature of all five environments,
18942 , is a rather long-ish label.
18943 The text following this label — ordinarily the contents of the paragraph
18944 environment — is utterly irrelevant for
18966 completely ignores it.
18967 In fact, you can leave these five environments completely empty.
18971 \begin_layout Standard
18976 to put any text after the rather long-ish label, you might want to.
18977 This could be a short description of the contents of the
18982 In that case, enter your descriptive comment and hit
18986 as you normally would.
18989 \begin_layout Standard
18990 If, on the other hand, you don't want to enter any descriptive text, you'll
18991 hit another \SpecialChar LyX
18994 , like nature, abhors a vacuum, and will not let you start a new paragraph
18995 environment until you put something in the old one.
18999 \begin_layout Itemize
19000 Start entering the text that will
19028 \begin_layout Itemize
19029 Now move to the beginning of that paragraph.
19033 \begin_layout Itemize
19042 \begin_layout Itemize
19043 Finally, change this new, empty paragraph to a
19067 \begin_layout Standard
19068 Some future version of \SpecialChar LyX
19069 will, hopefully, resolve this quirkiness\SpecialChar ldots
19073 \begin_layout Subsection
19074 Making a Presentation with
19087 \begin_layout Subsubsection
19095 \begin_layout Standard
19096 If you're expecting this section to teach you how to actually make a presentatio
19097 n, you'll be sorely disappointed.
19098 Naturally, I'll describe all of the ways the
19102 class can assist you in preparing the materials for a presentation.
19103 Filling in the contents, however, is up to you.
19108 the \SpecialChar LyX
19112 \begin_layout Standard
19117 environment [in the manner described in section
19118 \begin_inset space ~
19122 \begin_inset CommandInset ref
19124 reference "sec:slideQuirk"
19128 ] tells \SpecialChar LyX
19129 to begin a new slide [duh].
19130 The label for this environment/
19131 \begin_inset Quotes erd
19135 \begin_inset Quotes erd
19139 \begin_inset Quotes eld
19143 \begin_inset Quotes erd
19146 in cool blue, followed by the label,
19147 \begin_inset Quotes eld
19151 \begin_inset Quotes erd
19155 Any text or paragraph environments that follow this one go on the new slide.
19159 \begin_layout Standard
19160 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
19162 (this can be specified in the
19167 In fact, you'll want to, once you finish entering the contents of one slide.
19168 If you've entered more text than can physically fit on a slide, the extra
19169 overflows onto a new slide.
19170 I don't recommend doing this, however, since the overflow slide won't have
19171 any page number on it.
19172 Furthermore, it may interfere with any
19176 you've made to accompany the oversized
19183 \begin_layout Standard
19192 environments work the same way as the
19197 They both create an
19198 \begin_inset Quotes eld
19202 \begin_inset Quotes erd
19205 followed by a label [
19206 \begin_inset Quotes eld
19210 \begin_inset Quotes erd
19214 \begin_inset Quotes eld
19218 \begin_inset Quotes erd
19222 The color is a stunning magenta instead of blue, and the
19223 \begin_inset Quotes eld
19227 \begin_inset Quotes erd
19230 will look different, in style and in length.
19231 The label fonts of all three also differ from one another.
19234 \begin_layout Standard
19239 , if the contents of a
19247 exceed the physical size of a slide or sheet of paper, the extra will overflow
19249 Again, you should avoid this.
19250 It defeats the whole purpose of
19261 \begin_layout Subsubsection
19271 \begin_layout Standard
19276 is a slide that sits atop another slide.
19277 Perhaps you wish to discuss a figure on the main
19281 before displaying the text associated with it.
19282 One way to accomplish this is tape a flap of dark paper over the part of
19287 you want to display later.
19288 This method fails, however, if you wish to overlap one graph with another,
19290 You would then have to fumble while speaking to align the two separate,
19295 s to align the two graphs.
19300 environment in both cases makes life much easier.
19303 \begin_layout Standard
19308 receives the page number of its
19309 \begin_inset Quotes eld
19313 \begin_inset Quotes erd
19321 \begin_inset Quotes eld
19329 \begin_inset Quotes erd
19336 \begin_layout Plain Layout
19337 Presumably, mutliple
19342 \begin_inset Quotes eld
19350 \begin_inset Quotes erd
19354 \begin_inset Quotes eld
19362 \begin_inset Quotes erd
19366 \begin_inset Quotes eld
19374 \begin_inset Quotes erd
19378 \begin_inset space ~
19381 appended to the page number of the parent
19391 Clearly, you want the contents of both the
19399 to each fit on a single physical slide! You should probably consider an
19405 \begin_inset Quotes eld
19409 \begin_inset Quotes erd
19417 Indeed, the \SpecialChar LyX
19422 class provides a visual cue for this: the label at the start of an
19426 is shorter than that at the start of a
19431 Lastly, when you generate printable output, you'll find alignment markers
19432 in all four corners of both the
19436 page and its parent
19441 These will assist you in lining up the two physical slides.
19444 \begin_layout Standard
19445 The major problem in overlaying two slides is aligning the contents of the
19446 two transparencies.
19447 How much space should you leave for that graph on the second slide? Worse
19448 still, what if you want a graph and a sentence on second slide, but there
19449 is text on the main transparency that goes in between them? You could try
19450 and insert vertical space of the right size.
19451 The better way is to use
19462 \begin_layout Standard
19463 As their names imply,
19471 are two command-like paragraph environments that make all subsequent text
19472 invisible and visible, respectively.
19474 \begin_inset space ~
19478 \begin_inset CommandInset ref
19480 reference "sec:slideQuirk"
19484 that you don't place anything
19488 these two environments, however.
19493 , it inserts a centered, sky-blue label into the page reading
19494 \begin_inset Quotes eld
19497 <Invisible Text Follows>
19498 \begin_inset Quotes erd
19502 For paragraphs following this label, the parts of the
19510 ; it doesn't matter which] where they would be contain instead blank space.
19514 \begin_layout Standard
19519 , the corresponding centered label is
19520 \begin_inset Quotes eld
19523 <Visible Text Follows>
19524 \begin_inset Quotes erd
19528 Paragraphs following this label behave normally.
19529 Note that the beginning of a new
19541 automatically shuts off an
19546 It's therefore not necessary to use
19557 \begin_layout Standard
19558 By now, it should be obvious how to create overlay transparencies using
19559 the proper combination of
19578 \begin_layout Enumerate
19583 , including everything that will appear on it, whether on the main slide
19591 \begin_layout Enumerate
19592 Before each figure or paragraph that will appear only on the
19601 If necessary, insert a
19605 environment after the
19612 \begin_layout Enumerate
19617 immediately following the
19624 \begin_layout Enumerate
19625 Copy the contents of this
19636 \begin_layout Enumerate
19641 , change all of the
19652 \begin_layout Standard
19654 You've just made an
19661 \begin_layout Standard
19662 There's one problem with the way I've designed the \SpecialChar LyX
19667 class: you can't make text in the middle of a paragraph invisible, nor
19668 make text in the middle of an invisible paragraph visible again.
19669 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
19674 \begin_layout Plain Layout
19675 The commands of interest are:
19678 \begin_layout Itemize
19683 invisible \SpecialChar ldots
19687 \begin_layout Itemize
19692 visible \SpecialChar ldots
19696 \begin_layout Plain Layout
19698 and need to be marked as \SpecialChar TeX
19701 \begin_inset Quotes eld
19705 \begin_inset Quotes erd
19708 you wish to change goes in between the brackets [and after the
19721 If you don't know how to mark text as \SpecialChar TeX
19722 , see the appropriate section of
19735 \begin_layout Subsubsection
19745 \begin_inset CommandInset label
19747 name "sec:slideNote"
19754 \begin_layout Standard
19763 is associated with a
19764 \begin_inset Quotes eld
19768 \begin_inset Quotes erd
19776 Here, too, the \SpecialChar LyX
19781 class provides visual cues.
19786 is shorter than that of a
19790 [yet longer than that of an
19794 ] and, like the label of an
19798 is shockingly magenta.
19799 Additionally, the printed
19803 has the page number of its
19804 \begin_inset Quotes eld
19808 \begin_inset Quotes erd
19816 \begin_inset Quotes eld
19824 \begin_inset Quotes erd
19828 \begin_inset Quotes eld
19836 \begin_inset Quotes erd
19840 \begin_inset Quotes eld
19848 \begin_inset Quotes erd
19852 You can have multiple
19856 s associated with a single
19868 , you'll probably want to break up long
19872 s so that they fit on a single sheet of paper.
19875 \begin_layout Standard
19880 is obvious: it contains anything additional you might want to say about
19886 It could also be used as a sheet of reminders for a particular
19891 In the case of the latter, you might want to make use of time markers.
19892 Currently, the \SpecialChar LyX
19898 \begin_inset Quotes eld
19902 \begin_inset Quotes erd
19905 support for time markers, a
19907 Sli\SpecialChar TeX
19911 So, you'll have to resort to using the \SpecialChar LaTeX
19915 \begin_layout Standard
19916 To use time markers, you'll need to specify the extra class option
19917 \begin_inset Quotes eld
19925 \begin_inset Quotes erd
19929 \begin_inset space ~
19933 \begin_inset CommandInset ref
19935 reference "sec:slidesetup"
19940 This option turns on timing marks, which will appear in the lower-left-hand
19946 To set what appears in the time marker, you use the \SpecialChar LaTeX
19948 \begin_inset Quotes eld
19958 \begin_inset Quotes erd
19962 \begin_inset Quotes eld
19972 \begin_inset Quotes erd
19976 The arguments of both commands are time measured in seconds.
19978 \begin_inset Quotes eld
19988 \begin_inset Quotes erd
19991 sets the time marker to a given time.
19993 \begin_inset Quotes eld
20003 \begin_inset Quotes erd
20006 increments the time marker by the specified amount.
20007 Using time markers and
20011 s in this fashion, you can remind yourself how much time to spend on a particula
20019 \begin_layout Standard
20020 There's one last feature to describe.
20021 Clearly, you'd like to print out all of your
20029 s on transparencies while printing all of your
20046 with which it is associated.
20047 What's a person to do?
20050 \begin_layout Standard
20051 Luckily, there are two \SpecialChar LaTeX
20052 commands that allow you to select what to print
20054 Both must be placed into the preamble of your document.
20056 \begin_inset Quotes eld
20068 \begin_inset Quotes erd
20071 will cause the output to contain only the
20080 Correspondingly, the command
20081 \begin_inset Quotes eld
20093 \begin_inset Quotes erd
20096 prevents the output of anything but
20101 I'd advise placing both commands in the preamble and initially comment
20103 You can then preview your entire presentation as you write.
20104 When you're done writing, you can then uncomment one of the two to select
20105 what you want to print.
20106 I like to uncomment
20107 \begin_inset Quotes eld
20119 \begin_inset Quotes erd
20122 , print to a file with
20123 \begin_inset Quotes eld
20131 \begin_inset Quotes erd
20134 in its name, comment it back out, then uncomment
20135 \begin_inset Quotes eld
20147 \begin_inset Quotes erd
20151 \begin_inset Quotes eld
20159 \begin_inset Quotes erd
20163 I can then send either file to a printer, loading transparencies or plain
20164 paper as appropriate.
20167 \begin_layout Standard
20168 You can also provide other arguments to the
20169 \begin_inset Quotes eld
20179 \begin_inset Quotes erd
20183 \begin_inset Quotes eld
20193 \begin_inset Quotes erd
20197 See a good \SpecialChar LaTeX
20201 \begin_layout Subsection
20206 Class Template File
20209 \begin_layout Standard
20210 I have also provided a template file,
20211 \begin_inset Quotes eld
20219 \begin_inset Quotes erd
20227 To use it, begin your new presentation with
20229 File\SpecialChar menuseparator
20231 \begin_inset space ~
20235 \begin_inset space ~
20241 Your new \SpecialChar LyX
20242 presentation file will contain an example
20263 additionally contain an example of the use of
20272 Lastly, the preamble will contain:
20275 \begin_layout LyX-Code
20276 % Uncomment to print out only slides and overlays
20279 \begin_layout LyX-Code
20283 \begin_layout LyX-Code
20289 \begin_inset Newline newline
20295 \begin_layout LyX-Code
20296 % Uncomment to print out only notes
20299 \begin_layout LyX-Code
20303 \begin_layout LyX-Code
20311 \begin_layout Standard
20312 One final thing: I created this class to support the \SpecialChar LaTeX2e
20314 \begin_inset Quotes eld
20319 Sli\SpecialChar TeX
20323 \begin_inset Quotes erd
20326 class, one of the built-in \SpecialChar LaTeX2e
20328 Neither I nor the rest of the \SpecialChar LyX
20329 Team endorse or oppose the use of this built-in
20331 It's here if you want it or need it.
20332 There exist other \SpecialChar LaTeX2e
20333 classes for creating presentations, such as the
20338 \begin_inset space ~
20342 \begin_inset CommandInset ref
20344 reference "sec:foiltex"
20349 \begin_inset Quotes eld
20357 \begin_inset Quotes erd
20360 package [present on some \SpecialChar TeX
20362 The latter is not yet supported under \SpecialChar LyX
20367 \begin_layout Plain Layout
20368 Perhaps you can take on the task\SpecialChar ldots
20374 I know nothing about these other classes.
20375 Try them out to see what sort of alternative they provide.
20378 \begin_layout Chapter
20380 Features needing Extra Software
20383 \begin_layout Section
20384 Checking \SpecialChar TeX
20388 \begin_layout Standard
20394 \begin_layout Subsection
20398 \begin_layout Standard
20407 \begin_layout Plain Layout
20412 is not yet available when you are using the \SpecialChar LaTeX
20413 distribution MiK\SpecialChar TeX
20419 , you'll find in the
20426 \begin_inset space ~
20437 \begin_inset Newline newline
20441 \begin_inset CommandInset href
20443 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
20451 \begin_layout Standard
20454 Chk\SpecialChar TeX
20457 package is a program that was written by
20458 \begin_inset Flex Noun
20461 \begin_layout Plain Layout
20463 \begin_inset space ~
20471 in frustration because some constructs in \SpecialChar LaTeX
20472 are sometimes non-intuitive,
20473 and easy to forget.
20474 The program runs over your \SpecialChar LaTeX
20475 file, checks the integrity of the file, and
20476 flags some common errors.
20477 In other technical words, it is
20481 for \SpecialChar LaTeX
20485 \begin_layout Standard
20486 Well, what is a syntax checker doing in \SpecialChar LyX
20487 which is supposed to produce correct
20489 anyways? The answer is simple: Just as
20493 not only checks the
20497 of C programs, but also does
20501 checks for type-errors,
20503 Chk\SpecialChar TeX
20506 catches some common
20510 errors, in addition to the syntactical ones.
20513 Chk\SpecialChar TeX
20516 is capable of detecting several common errors, such as
20519 \begin_layout Itemize
20520 Ellipsis detection:
20521 \begin_inset Newline newline
20524 Use \SpecialChar ldots
20528 \begin_layout Itemize
20529 No space in front of/after parenthesis:
20530 \begin_inset Newline newline
20536 \begin_layout Itemize
20537 Enforcement of normal space after common abbreviations:
20538 \begin_inset Newline newline
20542 \begin_inset space \thinspace{}
20546 \begin_inset space \space{}
20549 is too wide spacing.
20552 \begin_layout Itemize
20553 Enforcement of end-of-sentence space when the last sentence ends with a
20555 \begin_inset Newline newline
20559 And this is wrong spacing.
20562 \begin_layout Itemize
20563 Space in front of labels and similar commands:
20564 \begin_inset Newline newline
20567 The label should stick right up to the text to avoid falling to a wrong
20570 \begin_inset CommandInset label
20580 \begin_layout Plain Layout
20581 This footnote is in danger of falling off to a wrong page
20586 The label is separated too much.
20589 \begin_layout Itemize
20590 Space in front of references, instead of hard spaces:
20591 \begin_inset Newline newline
20594 If you have bad luck, the text will break right between the referenced text
20595 and reference number, and that's a pity.
20597 \begin_inset CommandInset ref
20599 reference "sec:chktex"
20606 \begin_layout Itemize
20608 \begin_inset Quotes eld
20612 \begin_inset Quotes erd
20616 \begin_inset Formula $\times$
20620 \begin_inset Newline newline
20623 2x2 looks cheap compared to
20624 \begin_inset Formula $2\times2$
20630 \begin_layout Standard
20631 and more \SpecialChar ldots
20632 It is an invaluable tool when you are
20633 \begin_inset Quotes eld
20637 \begin_inset Quotes erd
20640 your document before printing, and you should run it right after the obligatory
20641 spelling check, and before you go fine tuning the typesetting.
20644 \begin_layout Subsection
20648 \begin_layout Standard
20649 If you have the program installed, usage is as simple as choosing
20651 Tools\SpecialChar menuseparator
20653 \begin_inset space ~
20659 This will make \SpecialChar LyX
20660 generate a \SpecialChar LaTeX
20661 file of your document, start
20663 Chk\SpecialChar TeX
20666 to check it, and then make \SpecialChar LyX
20668 \begin_inset Quotes eld
20672 \begin_inset Quotes erd
20675 with the warnings from
20677 Chk\SpecialChar TeX
20680 , if there were any.
20681 The warnings will be placed close to the point of the mistake, and you
20682 can quickly find them by using the
20684 Navigate\SpecialChar menuseparator
20687 menu item, or the shortcut key
20696 Open the error boxes by clicking on them with the mouse, or use the shortcut
20705 bindings, or the corresponding
20714 Read the warning and correct the mistake, if it is a mistake.
20715 If you have trouble understanding what the warning is about, you can safely
20717 Remember that there is a hidden layer between the document on screen and
20718 the technical details in invoking
20720 Chk\SpecialChar TeX
20723 , and this gap can make some warnings seem arcane or just plain silly.
20726 \begin_layout Standard
20727 This document is an excellent testing bed for the feature, and it should
20728 provide quite a few warnings for you to fiddle with.
20729 Since computers are only so smart, expect most of the warnings to be false
20733 \begin_layout Subsection
20734 How to fine tune it
20737 \begin_layout Standard
20738 Sometimes, you'll find that
20740 Chk\SpecialChar TeX
20743 makes more noise than suits your mood.
20744 Then you can choose not to use it, wait until your mood changes, or try
20747 Chk\SpecialChar TeX
20750 to get better along with you.
20753 \begin_layout Standard
20756 Chk\SpecialChar TeX
20763 very configurable and extensible, you should not expect to solve all problems
20766 Chk\SpecialChar TeX
20769 in \SpecialChar LyX
20771 Since \SpecialChar LyX
20772 has to generate a somewhat special \SpecialChar LaTeX
20773 file to be able to match the
20774 line numbers from the
20776 Chk\SpecialChar TeX
20783 \begin_layout Plain Layout
20784 You can inspect the specific output from
20790 Document\SpecialChar menuseparator
20793 \begin_inset space ~
20807 to the internal document structure, some of the warnings will not appear
20809 There are two things you can do about this:
20812 \begin_layout Itemize
20815 Chk\SpecialChar TeX
20818 invocation command line in
20819 \begin_inset Flex Noun
20822 \begin_layout Plain Layout
20823 Tools\SpecialChar menuseparator
20824 Preferences\SpecialChar menuseparator
20825 Output\SpecialChar menuseparator
20826 LaTeX\SpecialChar menuseparator
20834 Chk\SpecialChar TeX
20837 installation configuration file (usually with the file
20842 See below to learn what warnings can be enabled and disabled on the command
20846 \begin_layout Itemize
20847 Export your document as a raw \SpecialChar LaTeX
20850 File\SpecialChar menuseparator
20851 Export\SpecialChar menuseparator
20860 Invoked in this way, it can be a hassle to find the corresponding place
20861 in the document inside \SpecialChar LyX
20862 , but with a little patience, you should be able
20866 \begin_layout Standard
20867 Here follows the warning messages that can be enabled and disabled in
20876 to disable a warning, and
20880 to enable a warning.
20881 The emphasized entries are disabled by default, because the default is
20884 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
20889 \begin_layout Standard
20890 Notice that you should only use the options that enable and disable warnings,
20891 because \SpecialChar LyX
20892 relies on some of the other command line parameters to be set
20893 in a specific way to have a chance to communicate with
20900 \begin_layout Enumerate
20904 Command terminated with space.
20907 \begin_layout Enumerate
20910 Non-breaking space (
20911 \begin_inset Quotes eld
20919 \begin_inset Quotes erd
20922 ) should have been used.
20925 \begin_layout Enumerate
20929 You should enclose the previous parenthesis with
20930 \begin_inset Quotes eld
20938 \begin_inset Quotes erd
20944 \begin_layout Enumerate
20947 Italic correction (
20948 \begin_inset Quotes eld
20958 \begin_inset Quotes erd
20961 ) found in non-italic buffer.
20964 \begin_layout Enumerate
20967 Italic correction (
20968 \begin_inset Quotes eld
20978 \begin_inset Quotes erd
20981 ) found more than once.
20984 \begin_layout Enumerate
20988 No italic correction (
20989 \begin_inset Quotes eld
20999 \begin_inset Quotes erd
21005 \begin_layout Enumerate
21009 \begin_inset Quotes eld
21017 \begin_inset Quotes erd
21021 \begin_inset Quotes eld
21029 \begin_inset Quotes erd
21035 \begin_layout Enumerate
21038 Wrong length of dash may have been used.
21041 \begin_layout Enumerate
21045 \begin_inset Quotes eld
21053 \begin_inset Quotes erd
21057 \begin_inset Quotes eld
21065 \begin_inset Quotes erd
21071 \begin_layout Enumerate
21075 \begin_inset Quotes eld
21083 \begin_inset Quotes erd
21089 \begin_layout Enumerate
21093 \begin_inset Quotes eld
21101 \begin_inset Quotes erd
21104 to achieve an ellipsis.
21107 \begin_layout Enumerate
21110 Inter-word spacing (
21111 \begin_inset Quotes eld
21121 \begin_inset Quotes eld
21124 ) should perhaps be used.
21127 \begin_layout Enumerate
21130 Inter-sentence spacing (
21131 \begin_inset Quotes eld
21141 \begin_inset Quotes erd
21144 ) should perhaps be used.
21147 \begin_layout Enumerate
21150 Could not find argument for command.
21153 \begin_layout Enumerate
21157 \begin_inset Quotes eld
21165 \begin_inset Quotes erd
21171 \begin_layout Enumerate
21174 Math mode still on at end of \SpecialChar LaTeX
21178 \begin_layout Enumerate
21182 \begin_inset Quotes eld
21190 \begin_inset Quotes erd
21193 doesn't match the number of
21194 \begin_inset Quotes eld
21202 \begin_inset Quotes erd
21208 \begin_layout Enumerate
21211 You should use either
21214 \begin_inset Quotes eld
21222 \begin_inset Quotes erd
21227 as an alternative to
21228 \begin_inset Quotes eld
21236 \begin_inset Quotes erd
21242 \begin_layout Enumerate
21249 " (ASCII 39) instead of "
21256 \begin_layout Enumerate
21259 User-specified pattern found.
21262 \begin_layout Enumerate
21265 This command might not be intended.
21268 \begin_layout Enumerate
21275 \begin_layout Enumerate
21293 \begin_layout Enumerate
21296 Delete this space to maintain correct page references.
21299 \begin_layout Enumerate
21303 You might wish to put this between a pair of
21304 \begin_inset Quotes eld
21312 \begin_inset Quotes erd
21318 \begin_layout Enumerate
21321 You ought to remove spaces in front of punctuation.
21324 \begin_layout Enumerate
21327 Could not execute \SpecialChar LaTeX
21331 \begin_layout Enumerate
21340 in front of small punctuation.
21343 \begin_layout Enumerate
21351 may look prettier here.
21354 \begin_layout Enumerate
21358 Multiple spaces detected in output.
21361 \begin_layout Enumerate
21364 This text may be ignored.
21367 \begin_layout Enumerate
21373 \begin_inset Quotes eld
21378 to begin quotation, not
21385 \begin_layout Enumerate
21392 to end quotation, not
21395 \begin_inset Quotes eld
21403 \begin_layout Enumerate
21409 \begin_layout Enumerate
21412 You should perhaps use
21413 \begin_inset Quotes eld
21421 \begin_inset Quotes erd
21427 \begin_layout Enumerate
21430 You should put a space in front of/after parenthesis.
21433 \begin_layout Enumerate
21436 You should avoid spaces in front of/after parenthesis.
21439 \begin_layout Enumerate
21443 You should not use punctuation in front of/after quotes.
21446 \begin_layout Enumerate
21449 Double space found.
21452 \begin_layout Enumerate
21455 You should put punctuation outside inner/inside display math mode.
21458 \begin_layout Enumerate
21461 You ought to not use primitive \SpecialChar TeX
21462 in \SpecialChar LaTeX
21466 \begin_layout Enumerate
21469 You should remove spaces in front of
21470 \begin_inset Quotes eld
21478 \begin_inset Quotes erd
21484 \begin_layout Enumerate
21487 \begin_inset Quotes eld
21495 \begin_inset Quotes erd
21498 is normally not followed by
21499 \begin_inset Quotes eld
21507 \begin_inset Quotes erd
21513 \begin_layout Standard
21514 In later versions of \SpecialChar LyX
21515 , we hope to provide a more complete interface to this
21516 tool (and it's smaller cousin
21520 ) to exploit the full power of it.
21521 But it's not exactly useless as it is now: go try it on one of your existing
21522 documents of a certain length and be surprised.
21525 \begin_layout Section
21526 Version Control in \SpecialChar LyX
21530 \begin_layout Standard
21533 Lars Gullik Bjønnes
21540 \begin_layout Subsection
21544 \begin_layout Standard
21546 supports some of the most basic RCS/CVS/SVN/GIT commands.
21547 If you need something a bit more sophisticated you will have to do that
21548 manually in a terminal.
21551 \begin_layout Standard
21552 Also note that CVS support is not as good as subversion support, so we advise
21554 A good place to start learning Subversion is the SVN Book
21558 \begin_layout Plain Layout
21559 \begin_inset CommandInset href
21561 target "http://svnbook.red-bean.com/"
21572 In the case of RCS you should read
21573 \begin_inset Quotes eld
21577 \begin_inset Quotes erd
21580 (a man file, read it with
21585 This file describes all the basic features of RCS.
21586 You should especially notice the comment about a RCS directory, and the
21587 notion of a master RCS file (the file ending in
21594 \begin_layout Standard
21595 Before you begin to use the version control features in \SpecialChar LyX
21597 familiar with RCS/CVS/SVN/GIT usage.
21598 The implementation in \SpecialChar LyX
21599 assumes a recent version of the GNU RCS or CVS/SVN
21600 package — no guarantees are made for older versions.
21601 Most of the log messages are not currently displayed after operations —
21602 you can check them in the Messages pane if you are unsure.
21603 Regular users of version control will appreciate the VC toolbar, which
21606 View\SpecialChar menuseparator
21607 Toolbars\SpecialChar menuseparator
21609 \begin_inset space ~
21617 \begin_layout Standard
21618 For introducing your own external commands consult
21619 \begin_inset Flex Code
21622 \begin_layout Plain Layout
21636 \begin_layout Standard
21637 It is strongly recommended to store documents in uncompressed format if
21638 using version control (uncheck
21640 Document\SpecialChar menuseparator
21643 if it is checked): Uncompressed LyX documents are text files and therefore
21644 for merging two different versions by version control systems.
21645 Compressed LyX documents are binary files, which cannot be merged by version
21649 \begin_layout Subsection
21650 RCS commands in \SpecialChar LyX
21654 \begin_layout Standard
21655 The following sections describe the RCS commands supported by \SpecialChar LyX
21657 You can find them in the
21659 File\SpecialChar menuseparator
21661 \begin_inset space ~
21668 was tested against RCS 5.7/5.8.
21671 \begin_layout Subsubsection
21677 \begin_layout Standard
21678 If your document is not under revision control, this is the only item shown
21680 And if it is under revision control, the
21684 item is not visible.
21688 \begin_layout Standard
21689 This command registers your document with RCS (unless you are under the
21690 directory managed by CVS)\SpecialChar endofsentence
21691 You are asked interactively to supply an initial
21692 description of the document.
21693 The document is now set in Read-Only mode and you have to
21696 \begin_inset space ~
21700 \begin_inset space ~
21704 \begin_inset space ~
21709 , before making any changes to it.
21710 A document under revision control has a
21711 \begin_inset Quotes eld
21714 [RCS:<version> <locker>]
21715 \begin_inset Quotes erd
21718 item tagged to the filename in the minibuffer.
21721 \begin_layout Standard
21722 RCS command that is run:
21725 \begin_layout LyX-Code
21728 ci -q -u -i -t-"<initial description>" <file-name>
21731 \begin_layout Standard
21736 to understand the switches.
21740 \begin_layout Subsubsection
21746 \begin_layout Standard
21747 When you are finished editing a file, you check in your changes.
21748 When you do this, you are asked for a description of the changes.
21749 This is stored in the history log.
21750 The version number is bumped, your changes are applied to the master RCS
21751 file, the document is unlocked and set to Read-Only mode.
21754 \begin_layout Itemize
21757 ci -q -u -m"<description>" <file-name>
21760 \begin_layout Subsubsection
21766 \begin_layout Standard
21767 By doing this you lock the document so that only you can edit it.
21768 This will also make the document Read-Write only for you.
21769 You will usually continue editing for a while and when you are finished
21770 you check in your changes.
21771 The status line is changed to reflect that you have locked the file.
21774 \begin_layout Itemize
21777 co -q -l <file-name>
21780 \begin_layout Subsubsection
21783 Revert To Repository Version
21786 \begin_layout Standard
21787 This will discard all changes made to the document since the last check
21789 You get a warning before changes are discarded.
21792 \begin_layout Itemize
21795 co -f -u<version> <file-name>
21798 \begin_layout Subsubsection
21804 \begin_layout Standard
21805 This will create a copy of the current document.
21806 Since RCS does not support copy operations natively, the version history
21807 is not preserved, and the copy is added as a new file.
21808 It requires a clean document without any changes since the last checkin.
21809 You are asked for a file name and a description of the copy operation.
21810 After that the copy is created, both locally and in the repository.
21811 If the parent directories of the copied and original document differ, all
21812 relative paths of included files of the copy are adjusted (like in
21814 File\SpecialChar menuseparator
21819 Finally, the copy is loaded instead of the original document.
21822 \begin_layout Labeling
21823 \labelwidthstring 00.00.0000
21825 \begin_inset space ~
21829 \begin_inset space ~
21833 \begin_inset Newline newline
21837 \begin_inset Flex Code
21840 \begin_layout Plain Layout
21843 \begin_inset Quotes qld
21847 \begin_inset Quotes qld
21856 \begin_inset Flex Code
21859 \begin_layout Plain Layout
21862 \begin_inset Quotes qld
21866 \begin_inset Quotes qld
21875 \begin_inset Newline newline
21879 \begin_inset Flex Code
21882 \begin_layout Plain Layout
21886 \begin_inset Quotes qld
21890 \begin_inset Quotes qld
21901 \begin_layout Subsubsection
21907 \begin_layout Standard
21908 This makes as if the last check in never happened.
21909 No changes are made to the document loaded into \SpecialChar LyX
21910 , but the last version
21911 is removed from the master RCS file.
21914 \begin_layout Itemize
21917 rcs -o<version> <file-name>
21920 \begin_layout Subsubsection
21926 \begin_layout Standard
21927 This shows the complete history of the RCS document.
21932 is shown in a browser.
21940 \begin_layout Subsubsection
21944 \begin_layout Standard
21946 supports RCS version number, author name, date and time of last commit.
21947 All those are extracted from
21949 rlog -r <file-name>
21953 \begin_inset CommandInset ref
21955 reference "subsec:VCS-Revision-Information"
21962 \begin_layout Subsection
21963 CVS commands in \SpecialChar LyX
21967 \begin_layout Standard
21968 A subset of CVS operations is supported by \SpecialChar LyX
21970 You can find the commands in the
21972 File\SpecialChar menuseparator
21974 \begin_inset space ~
21980 The version control system SVN is more powerful, so please use it instead
21981 of CVS if possible.
21984 \begin_layout Subsubsection
21990 \begin_layout Standard
21991 If you start from scratch with CVS you have to create your repository and
21992 checkout the working copy with external tools.
21993 If you're using a client-server setup you may need to login before doing
21994 the first repository checkout.
21997 \begin_layout Standard
21998 If your documents are under revision control and others are using the same
21999 repository problems arise when different changes to the same document at
22000 the same location happen.
22001 Standard CVS repositories don't operate with a file locking mechanism.
22002 This may be surprising, but conflicts only occur if people disagree on
22003 the proper content of the same part of a document.
22004 So, if co-workers are used to communicate regularly, these conflicts occur
22006 If they don't communicate they have a fundamental problem anyway.
22007 Nevertheless some people like to work with so called
22008 \begin_inset Quotes eld
22012 \begin_inset Quotes erd
22016 If they do so the working copy of all files is readonly when checked out
22017 first and the user starts editing after using a special command to make
22018 the working copy writable.
22019 When the changes are checked in the working copy returns to readonly state.
22020 With \SpecialChar LyX
22021 one has to edit the
22022 \begin_inset Flex Code
22025 \begin_layout Plain Layout
22031 file and add the line
22032 \begin_inset Flex Code
22035 \begin_layout Plain Layout
22041 to work with reserved checkouts.
22042 The benefit is the possibility to see who is using a writable copy of some
22044 It's not guaranteed only one user makes a copy writable.
22047 \begin_layout Standard
22049 tries to guess if you're using reserved or non-reserved checkouts.
22050 If your working copy is readonly or it is writable and an additional copy
22051 of your document exists in the CVS/Base sub-directory a reserved otherwise
22052 a non-reserved checkout is assumed.
22053 When a reserved checkout is detected you have to use
22054 \begin_inset Flex Noun
22057 \begin_layout Plain Layout
22063 to make your working copy writable if it's readonly.
22065 \begin_inset Flex Noun
22068 \begin_layout Plain Layout
22074 operation is possible and that makes your working copy readonly again after
22075 transferring your changes to the repository.
22078 \begin_layout Standard
22079 More information about CVS can be found here
22080 \begin_inset Flex URL
22083 \begin_layout Plain Layout
22085 http://www.nongnu.org/cvs
22091 \begin_inset Flex URL
22094 \begin_layout Plain Layout
22096 http://ximbiot.com/cvs
22104 \begin_layout Standard
22109 to understand the sub-commands and the switches mentioned below.
22112 \begin_layout Subsubsection
22118 \begin_layout Standard
22119 If your document is not under revision control, this is the only item shown
22121 And if it is under revision control, the
22125 item is not visible.
22129 \begin_layout Standard
22130 This command registers in CVS your document
22131 \begin_inset Flex Strong
22134 \begin_layout Plain Layout
22142 in the case you have already the documents directory under CVS control
22148 This means you have to create or checkout the archive by yourself using
22150 (In case you forget that step \SpecialChar LyX
22151 registers the document with RCS.)
22154 \begin_layout Standard
22155 Then you are asked interactively to supply an initial description of the
22157 Don't forget that registered file is not yet checked in.
22160 \begin_layout Standard
22161 CVS command that is run:
22163 cvs -q add -m"<entered message>" "<file-name>"
22166 \begin_layout Standard
22171 above and for all other CVS commands is an abbreviation for
22172 \begin_inset Quotes eld
22175 change the current working directory to file location and use the file name
22176 without path component as argument
22177 \begin_inset Quotes erd
22183 \begin_layout Subsubsection
22189 \begin_layout Standard
22190 When you are finished editing a file, you commit your changes.
22191 When you do this and you had changed the document, you are asked for a
22192 description of the changes.
22193 After that changes are written to the repository.
22194 In case you didn't change the document and a reserved checkout is detected
22195 the reservation made on
22196 \begin_inset Flex Noun
22199 \begin_layout Plain Layout
22208 \begin_layout Labeling
22209 \labelwidthstring 00.00.0000
22211 \begin_inset space ~
22215 \begin_inset space ~
22219 \begin_inset Newline newline
22223 \begin_inset Flex Code
22226 \begin_layout Plain Layout
22229 -q commit -m"<description>" "<file-name>"
22235 \begin_inset Newline newline
22239 \begin_inset Flex Code
22242 \begin_layout Plain Layout
22253 \begin_layout Subsubsection
22259 \begin_layout Standard
22260 When you are sharing a repository with others, you may have to incorporate
22261 their changes into your working copy.
22264 \begin_layout Standard
22267 cvs -q update "<file-name>"
22270 \begin_layout Standard
22271 If a readonly checkout is detected the working copy is made writable and
22275 \begin_layout Standard
22278 cvs -q edit "<file-name>"
22281 \begin_layout Subsubsection
22284 Revert To Repository Version
22287 \begin_layout Standard
22288 This will discard all changes made to the document since the last check
22290 You get a warning before changes are discarded.
22291 Firstly the file is deleted, secondly CVS update command is run.
22294 \begin_layout Standard
22297 cvs -q update "<file-name>"
22300 \begin_layout Standard
22301 If a reserved checkout is detected and the working copy has no changes only
22302 the reservation is undone.
22305 \begin_layout Standard
22308 cvs -q unedit "<file-name>"
22311 \begin_layout Subsubsection
22317 \begin_layout Standard
22318 This will create a copy of the current document.
22319 Since CVS does not support copy operations natively, the version history
22320 is not preserved, and the copy is added as a new file.
22321 It requires a clean document without any changes since the last checkin.
22322 You are asked for a file name and a description of the copy operation.
22323 After that the copy is created, both locally and in the repository.
22324 If the parent directories of the copied and original document differ, all
22325 relative paths of included files of the copy are adjusted (like in
22327 File\SpecialChar menuseparator
22332 Finally, the copy is loaded instead of the original document.
22335 \begin_layout Labeling
22336 \labelwidthstring 00.00.0000
22338 \begin_inset space ~
22342 \begin_inset space ~
22346 \begin_inset Newline newline
22350 \begin_inset Flex Code
22353 \begin_layout Plain Layout
22360 \begin_inset Flex Code
22363 \begin_layout Plain Layout
22370 \begin_inset Newline newline
22374 \begin_inset Flex Code
22377 \begin_layout Plain Layout
22378 cvs -q add "<new-file-name>"
22386 \begin_layout Subsubsection
22392 \begin_layout Standard
22393 This will rename the current document.
22394 Since CVS does not support rename operations natively, the version history
22395 is not preserved, the renamed document is added as a new file, and the
22396 original document is deleted.
22397 It requires a clean document without any changes since the last checkin.
22398 You are asked for a file name and a description of the rename operation.
22399 After that the document is renamed, both locally and in the repository.
22400 If the parent directories of the new and old file names differ, all relative
22401 paths of included files are adjusted (like in
22403 File\SpecialChar menuseparator
22408 Finally, the document is reloaded using the new name.
22411 \begin_layout Labeling
22412 \labelwidthstring 00.00.0000
22414 \begin_inset space ~
22418 \begin_inset space ~
22422 \begin_inset Newline newline
22426 \begin_inset Flex Code
22429 \begin_layout Plain Layout
22436 \begin_inset Flex Code
22439 \begin_layout Plain Layout
22446 \begin_inset Newline newline
22450 \begin_inset Flex Code
22453 \begin_layout Plain Layout
22454 cvs -q add "<new-file-name>"
22460 \begin_inset Newline newline
22464 \begin_inset Flex Code
22467 \begin_layout Plain Layout
22468 cvs -q remove "<file-name>"
22476 \begin_layout Subsubsection
22477 Update of the local directory checkout from repository
22480 \begin_layout Standard
22481 Once your documents gets more complex, containing sub-documents and pictures,
22483 \begin_inset Flex Code
22486 \begin_layout Plain Layout
22492 files and so on using version control becomes more complicated.
22494 supports updating the whole tree in which resides the document.
22495 This become especially useful once you cooperate with people which neither
22496 have detailed knowledge about CVS usage nor they have ambition to commit
22497 additional material to the repository.
22498 You have to organize the files structure so that all external files are
22499 in the same directory or subdirectories of the document.
22500 It's good practice anyway to store multipart documents in an extra directory.
22503 \begin_layout Standard
22505 \begin_inset Flex Code
22508 \begin_layout Plain Layout
22509 Update local directory from repository
22514 command updates the whole directory.
22515 If local changes are detected user is warned before update starts.
22516 In case of merge conflicts both versions of the conflicting document parts
22517 are placed in the final document.
22518 You have to review and correct the result of the merge.
22519 You'll find the conflicts enclosed in pairs of
22520 \begin_inset Flex Code
22523 \begin_layout Plain Layout
22530 \begin_inset Flex Code
22533 \begin_layout Plain Layout
22540 \begin_inset Flex Code
22543 \begin_layout Plain Layout
22550 The first part is your version as before the update operation with the
22551 document name prepended.
22552 The second one is the repository version with the version number after
22554 \begin_inset Flex Code
22557 \begin_layout Plain Layout
22566 \begin_layout Labeling
22567 \labelwidthstring 00.00.0000
22569 \begin_inset space ~
22573 \begin_inset space ~
22577 \begin_inset Newline newline
22581 \begin_inset Flex Code
22584 \begin_layout Plain Layout
22592 (Ask if changes are detected.)
22593 \begin_inset Newline newline
22597 \begin_inset Flex Code
22600 \begin_layout Plain Layout
22601 cd $path; cvs -q update
22611 \begin_layout Standard
22613 \begin_inset Flex Code
22616 \begin_layout Plain Layout
22622 stands for the path to the document.
22625 \begin_layout Subsubsection
22631 \begin_layout Standard
22632 This shows the complete history of the CVS document.
22635 cvs log "<file-name>"
22637 is shown in a browser.
22640 \begin_layout Subsubsection
22644 \begin_layout Standard
22646 supports CVS version number, author name, date and time of last commit.
22647 All those are extracted from
22649 cvs log -r <file-name>
22653 \begin_inset CommandInset ref
22655 reference "subsec:VCS-Revision-Information"
22662 \begin_layout Subsection
22663 SVN commands in \SpecialChar LyX
22667 \begin_layout Standard
22668 SVN is now partially supported by \SpecialChar LyX
22670 You can find the commands in the
22672 File\SpecialChar menuseparator
22674 \begin_inset space ~
22680 Please note that if you use password protected access to repository via
22681 ssh, you will be asked in terminal window.
22683 was tested against SVN 1.5, 1.6, 1.7 and 1.8
22687 \begin_layout Plain Layout
22688 Most of the commands will work with 1.4 too, see
22689 \begin_inset CommandInset ref
22691 reference "subsec:SVN-Repo-Update"
22696 There seems to be currently unresolved permissions problem under SVN 1.8
22697 with reverting changes when file is locked.
22705 \begin_layout Subsubsection
22711 \begin_layout Standard
22712 If your document is not under revision control, this is the only item shown
22714 And if it is under revision control, the
22718 item is not visible.
22721 \begin_layout Standard
22722 This command registers in SVN your document ONLY in case you have already
22723 the documents directory under SVN control (in particular
22728 This means you have to checkout the archive by yourself.
22731 \begin_layout Standard
22732 Then you are asked interactively to supply an initial description of the
22734 Don't forget that registered file is not yet commited.
22737 \begin_layout Standard
22738 SVN command that is run:
22741 \begin_inset Quotes qld
22745 \begin_inset Quotes qld
22751 \begin_layout Standard
22756 to understand the switches.
22759 \begin_layout Subsubsection
22765 \begin_layout Standard
22766 When you are finished editing a file, you commit your changes.
22767 When you do this, you are asked for a description of the changes.
22768 After that changes are commited.
22771 \begin_layout Standard
22776 \begin_layout Plain Layout
22777 In case locking is not enabled.
22779 \begin_inset CommandInset ref
22781 reference "subsec:SVN-File-Locking"
22792 svn commit -q -m"<description>" <file-name>
22795 \begin_layout Subsubsection
22801 \begin_layout Standard
22802 Updates the changes of this file from the repository.
22803 Be sure you understand SVN merging and conflicts resolving before using
22804 this function, because all conflicts has to be resolved manually by you!
22807 \begin_layout Standard
22812 \begin_layout Plain Layout
22820 svn update --non-interactive
22821 \begin_inset Quotes qld
22825 \begin_inset Quotes qld
22831 \begin_layout Subsubsection
22834 Revert To Repository Version
22837 \begin_layout Standard
22838 This will discard all changes made to the document since the last check
22840 You get a warning before changes are discarded.
22843 \begin_layout Standard
22847 \begin_inset Quotes qld
22851 \begin_inset Quotes qld
22857 \begin_layout Subsubsection
22863 \begin_layout Standard
22864 This will create a copy of the current document including the version history.
22865 It requires a clean document without any changes since the last checkin.
22866 You are asked for a file name and a description of the copy operation.
22867 After that the copy is created, both locally and in the repository.
22868 If the parent directories of the copied and original document differ, all
22869 relative paths of included files of the copy are adjusted (like in
22871 File\SpecialChar menuseparator
22876 Finally, the copy is loaded instead of the original document.
22879 \begin_layout Labeling
22880 \labelwidthstring 00.00.0000
22882 \begin_inset space ~
22886 \begin_inset space ~
22890 \begin_inset Newline newline
22894 \begin_inset Flex Code
22897 \begin_layout Plain Layout
22901 \begin_inset Quotes qld
22905 \begin_inset Quotes qld
22909 \begin_inset Quotes qld
22913 \begin_inset Quotes qld
22922 \begin_inset Newline newline
22926 \begin_inset Flex Code
22929 \begin_layout Plain Layout
22938 \begin_layout Subsubsection
22944 \begin_layout Standard
22945 This will rename the current document including the version history.
22946 It requires a clean document without any changes since the last checkin.
22947 You are asked for a file name and a description of the rename operation.
22948 After that the document is renamed, both locally and in the repository.
22949 If the parent directories of the new and old file names differ, all relative
22950 paths of included files are adjusted (like in
22952 File\SpecialChar menuseparator
22957 Finally, the document is reloaded using the new name.
22960 \begin_layout Labeling
22961 \labelwidthstring 00.00.0000
22963 \begin_inset space ~
22967 \begin_inset space ~
22971 \begin_inset Newline newline
22975 \begin_inset Flex Code
22978 \begin_layout Plain Layout
22982 \begin_inset Quotes qld
22986 \begin_inset Quotes qld
22990 \begin_inset Quotes qld
22994 \begin_inset Quotes qld
23003 \begin_inset Newline newline
23007 \begin_inset Flex Code
23010 \begin_layout Plain Layout
23019 \begin_layout Subsubsection
23020 \begin_inset CommandInset label
23022 name "subsec:SVN-Repo-Update"
23026 Update of the local directory checkout from repository
23030 \begin_layout Plain Layout
23031 Note that this command will work only with subversion
23032 \begin_inset Formula $\geqq1.5$
23043 \begin_layout Standard
23044 All the commands above have one shortcoming – they deal with the current
23046 Once your document contains pictures, includes external
23047 \begin_inset Flex Code
23050 \begin_layout Plain Layout
23056 files and so on administration becomes more complicated.
23058 now supports updating the whole tree in which resides the document
23062 \begin_layout Plain Layout
23063 One need to organize the files structure so that all external files are
23064 in the same directory or subdirectories of the document.
23071 This become especially useful once you cooperate with people which neither
23072 know about subversion management nor they have ambition to commit additional
23073 material to the repository.
23077 \begin_layout Standard
23078 \begin_inset Flex Code
23081 \begin_layout Plain Layout
23082 Update local directory from repository
23087 command updates the whole directory and in case of merge conflicts local
23088 version of the files are left, so no unintended data loss occurs.
23089 If local changes are detected user is warned before update starts.
23092 \begin_layout Labeling
23093 \labelwidthstring 00.00.0000
23095 \begin_inset space ~
23099 \begin_inset space ~
23103 \begin_inset Newline newline
23107 \begin_inset Flex Code
23110 \begin_layout Plain Layout
23116 (Ask if changes are detected.)
23117 \begin_inset Newline newline
23121 \begin_inset Flex Code
23124 \begin_layout Plain Layout
23125 svn update --accept mine-full $path
23133 \begin_layout Standard
23135 \begin_inset Flex Code
23138 \begin_layout Plain Layout
23144 stands for the path to the document.
23147 \begin_layout Subsubsection
23153 \begin_layout Standard
23154 This shows the complete history of the SVN document.
23158 \begin_inset Quotes qld
23162 \begin_inset Quotes qld
23167 is shown in a browser.
23170 \begin_layout Subsubsection
23172 \begin_inset CommandInset label
23174 name "subsec:SVN-File-Locking"
23181 \begin_layout Standard
23182 The file exchange through various revision control systems brings the problem
23183 of merge conflicts in case two different users try to edit the same (parts
23185 When such a conflict happens it needs manual resolving and one reasonable
23186 alternative is to provide some kind of locking mechanism, which guarantees
23187 that only one user is allowed to edit file at the given time.
23190 \begin_layout Standard
23191 SVN has two such mechanisms to provide mutual exclusivity for file access
23192 – locks and automatic setting of write permissions (see sec.
23194 \begin_inset CommandInset ref
23196 reference "subsec:Automatical-Locking-Property"
23201 \begin_inset Flex Code
23204 \begin_layout Plain Layout
23214 \begin_layout Plain Layout
23215 \begin_inset Flex URL
23218 \begin_layout Plain Layout
23220 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
23231 If this property is detected for a given document \SpecialChar LyX
23232 starts to use SVN locks
23233 for document editing automatically and the whole check-in/out mechanism
23234 switches to the same regimen as for RCS.
23235 This in particular means there are two different modes of file use in \SpecialChar LyX
23239 \begin_layout Itemize
23241 The loaded file is in the read-only mode.
23242 For editing on needs to check-out.
23247 consists of updating from the repository and gaining write lock.
23248 If the lock is not possible to obtain, we remain in unlocked state.
23251 \begin_layout Itemize
23253 The loaded file is in the
23254 \begin_inset Quotes els
23258 \begin_inset Quotes ers
23262 No other user is allowed to edit the file.
23267 consists of commiting changes and releasing write-lock.
23268 If no changes have been made to the document, no commit will be produced
23272 \begin_layout Plain Layout
23273 Don't be puzzled by the fact that you will be asked for commit message anyway.
23278 and only the write-lock will be released.
23281 \begin_layout Standard
23285 \begin_layout Labeling
23286 \labelwidthstring 00.00.0000
23289 svn commit -q -m"<description>" "<file-name>"
23290 \begin_inset Newline newline
23293 svn unlock "<file-name>"
23296 \begin_layout Labeling
23297 \labelwidthstring 00.00.0000
23300 svn update "<file-name>"
23301 \begin_inset Newline newline
23304 svn lock "<file-name>"
23307 \begin_layout Subsubsection
23310 \begin_inset CommandInset label
23312 name "subsec:Automatical-Locking-Property"
23318 Automatic Locking Property
23321 \begin_layout Standard
23322 The above mentioned automatic setting of write permissions of the .lyx file
23325 File\SpecialChar menuseparator
23327 \begin_inset space ~
23330 Control\SpecialChar menuseparator
23331 Use Locking Property
23334 This command is active only when the file is not locked on the svn server
23336 you need to check-out before proceeding).
23339 \begin_layout Labeling
23340 \labelwidthstring 00.00.0000
23342 \begin_inset space ~
23348 \begin_layout Labeling
23349 \labelwidthstring 00.00.0000
23352 svn propset svn:needs-lock ON "<file-name>"
23355 \begin_layout Labeling
23356 \labelwidthstring 00.00.0000
23359 svn propdel svn:needs-lock "<file-name>"
23362 \begin_layout Subsubsection
23363 \begin_inset CommandInset label
23365 name "subsec:VCS-Revision-Information"
23369 Revision Information in Documents
23372 \begin_layout Standard
23373 There are more possibilities how to activate revision information in our
23377 \begin_layout Itemize
23383 \begin_layout Itemize
23384 tree revision information (
23385 \begin_inset Flex Code
23388 \begin_layout Plain Layout
23395 The result is the output of the
23396 \begin_inset Flex Code
23399 \begin_layout Plain Layout
23405 command, the following table gives you an idea, how to read the results.
23408 \begin_layout Standard
23410 \begin_inset Tabular
23411 <lyxtabular version="3" rows="6" columns="2">
23412 <features tabularvalignment="middle">
23413 <column alignment="left" valignment="top">
23414 <column alignment="left" valignment="top">
23416 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
23419 \begin_layout Plain Layout
23427 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
23430 \begin_layout Plain Layout
23440 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23443 \begin_layout Plain Layout
23449 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23452 \begin_layout Plain Layout
23453 mixed revision working copy
23460 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23463 \begin_layout Plain Layout
23469 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23472 \begin_layout Plain Layout
23473 modified working copy
23480 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23483 \begin_layout Plain Layout
23489 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23492 \begin_layout Plain Layout
23493 switched working copy
23500 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
23503 \begin_layout Plain Layout
23509 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23512 \begin_layout Plain Layout
23513 partial working copy, from a sparse checkout
23520 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
23523 \begin_layout Plain Layout
23529 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
23532 \begin_layout Plain Layout
23533 mixed revision, modified, switched working copy
23546 \begin_layout Itemize
23547 file revision information.
23548 The result comes from parsing the output of
23549 \begin_inset Flex Code
23552 \begin_layout Plain Layout
23554 \begin_inset space ~
23558 \begin_inset space ~
23562 \begin_inset space ~
23571 Supported flags are:
23575 \begin_layout Itemize
23576 version number of the last commit (
23577 \begin_inset Flex Code
23580 \begin_layout Plain Layout
23589 \begin_layout Itemize
23590 author of the last commit (
23591 \begin_inset Flex Code
23594 \begin_layout Plain Layout
23603 \begin_layout Itemize
23604 date of the last commit (
23605 \begin_inset Flex Code
23608 \begin_layout Plain Layout
23617 \begin_layout Itemize
23618 time of the last commit (
23619 \begin_inset Flex Code
23622 \begin_layout Plain Layout
23632 \begin_layout Standard
23633 You can obtain this info via InsetInfo (
23634 \change_inserted 5863208 1564400022
23637 Insert\SpecialChar menuseparator
23638 Field\SpecialChar menuseparator
23639 Version Control Revision
23640 \change_deleted 5863208 1564399852
23645 \begin_inset Flex Code
23648 \begin_layout Plain Layout
23649 info-insert buffer vcs-date
23657 The information will be available only when you have the file stored under
23658 svn managment (i.e.
23660 \begin_inset Flex Code
23663 \begin_layout Plain Layout
23669 directory is available with your document).
23673 \begin_layout Itemize
23674 Another—a hacking one—possibility is to use svn keywords
23678 \begin_layout Plain Layout
23679 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
23685 In short – you set file keywords property (e.g.
23688 svn propset svn:keywords 'Rev' file.lyx
23690 ) and then paste keyword \SpecialChar TeX
23695 \begin_layout Plain Layout
23696 This is an easy way how to ensure that \SpecialChar LyX
23697 won't break the line in the middle
23703 tag in your document (e.g.
23705 \begin_inset Flex Code
23708 \begin_layout Plain Layout
23715 This way svn client will automatically substitute revision number (e.g.
23717 \begin_inset Flex Code
23720 \begin_layout Plain Layout
23726 ) after each update and commit.
23727 There are more problems with this approach.
23728 Firstly, the '$' character is used in \SpecialChar TeX
23729 world for math equations, so any
23730 occurence of math formula
23731 \begin_inset Formula $Rev$
23735 \begin_inset Formula $Rev:59$
23738 in your \SpecialChar LyX
23740 Similarly for other keywords like Id, Date, Author, etc.
23741 Secondly svn output is dependent on your locales, so its very easy that
23742 svn would produce some problematic strings once Date is used.
23743 Thirdly you get the whole 'Rev: 59' string in your document instead of
23745 Until subversion implements user's custom keywords it will be hard to use
23746 this approach reliably or let \SpecialChar LyX
23747 to support it directly.
23750 \begin_layout Subsection
23751 SVN and Windows Environment
23754 \begin_layout Quote
23755 My inclination is to say that if the user cannot figure out the command
23756 line operations on their own fairly quickly, they would be well advised
23757 to use TortoiseSVN.
23763 \begin_layout Subsubsection
23767 \begin_layout Standard
23768 In addition to installing \SpecialChar LyX
23769 , and having access to a Subversion repository,
23770 the user will need to install the Subversion client program.
23771 A Windows installer for the client program is available from
23772 \begin_inset CommandInset href
23775 target "http://www.collab.net/nonav/downloads/subversion/"
23781 The user may also want to install
23782 \begin_inset CommandInset href
23785 target "http://tortoisesvn.tigris.org/"
23790 , which integrates Subversion operations into the context (rightclick) menu
23791 of Windows Explorer.
23792 Operations done outside \SpecialChar LyX
23793 will typically be more convenient using the Explorer
23795 Note that TortoiseSVN is not a replacement for the client program, which
23796 is what \SpecialChar LyX
23800 \begin_layout Subsubsection
23801 Bringing a document under Subversion control
23804 \begin_layout Standard
23805 Before a \SpecialChar LyX
23806 document can be brought under version control in Subversion, its
23807 parent directory needs to be under version control.
23808 If the document is being added to a project already in the repository,
23809 this is accomplished by checking the project out to the directory where
23810 the new document will be placed.
23811 If the project itself is not yet under version control (for instance, if
23812 this document starts a new project), the directory must be imported into
23814 This is done outside \SpecialChar LyX
23816 Both import and checkout are easily accomplished from the Explorer context
23817 menu using TortoiseSVN, or alternatively can be done using the command
23818 line client at a DOS prompt.
23819 The procedure for importing the project using TortoiseSVN is described
23820 below, assuming an existing repository and a new project being started
23828 For information on using the Subversion client program, run
23835 \begin_layout Enumerate
23842 in Windows Explorer, right click it, and select
23844 TortoiseSVN\SpecialChar menuseparator
23848 If necessary, adjust the URL for the repository, then click OK.
23851 \begin_layout Enumerate
23852 Right click the level of the repository under which you want to place the
23853 new project folder (typically the top level) and click
23857 Supply a name for the project folder and click OK.
23858 Add a message for the log file if desired, then click OK again.
23859 The new project folder should appear in the repository.
23860 Finally, click OK again to exit the repository browser.
23863 \begin_layout Enumerate
23864 Once again right click
23870 , this time selecting SVN Checkout\SpecialChar ldots
23871 Select the URL of the project folder
23872 you just created in the repository, and set the checkout directory to
23880 You will be warned about a non-empty folder; click OK to proceed.
23881 You should now have a
23892 \begin_layout Enumerate
23893 Create or open your document in \SpecialChar LyX
23896 File\SpecialChar menuseparator
23898 \begin_inset space ~
23901 Control\SpecialChar menuseparator
23905 Add a log message and click OK to commit the document to version control.
23908 \begin_layout Standard
23909 From this point onward, you should have full functionality in the
23911 File\SpecialChar menuseparator
23913 \begin_inset space ~
23919 You also have the option of checking the document in and out, viewing its
23921 using the TortoiseSVN context menu in Windows Explorer or the Subversion
23922 client program from a command prompt.
23925 \begin_layout Subsubsection
23926 SSH tunnel used with SVN under Windows
23929 \begin_layout Standard
23930 Compared with Linux setting up an svn client to communicate over ssh under
23931 Windows is a rather troublesome task.
23932 We will at least offer some hints how to setup the client side but prior
23933 knowledge about ssh and the Windows command line is needed, also be prepared
23934 for a great deal of frustration\SpecialChar ldots
23938 \begin_layout Enumerate
23939 Get an svn client for windows, as described in the previous sections.
23940 When it is a fresh install run some svn command (e.g.
23942 \begin_inset Flex Code
23945 \begin_layout Plain Layout
23951 ) to create config files, which you will need to change later on.
23954 \begin_layout Enumerate
23955 Choose an ssh client for Windows.
23956 There are several possibilities, we will use the one from Putty tools
23960 \begin_layout Plain Layout
23961 \begin_inset Flex URL
23964 \begin_layout Plain Layout
23966 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
23977 You will need to set the connection up so that the client doesn't ask for
23978 any password from you.
23979 To keep things easy we will use only keys without any additional password
23984 \begin_layout Enumerate
23986 \begin_inset Flex Code
23989 \begin_layout Plain Layout
23996 Save your private .ppk key file and put the public one on the server side.
23997 If the SVN server runs on Linux, note that the format of the public key
23998 is not compatible with Linux openssh and you will need to direcly copy-paste
24000 \begin_inset Quotes eld
24005 Public key for pasting into OpenSSH authorized_keys file
24008 \begin_inset Quotes erd
24011 edit field into the server's
24012 \begin_inset Flex Code
24015 \begin_layout Plain Layout
24016 ~/.ssh/authorized_keys
24022 \begin_inset Flex Code
24025 \begin_layout Plain Layout
24034 \begin_layout Enumerate
24036 \begin_inset Flex Code
24039 \begin_layout Plain Layout
24046 In the SVN config file
24050 \begin_layout Plain Layout
24051 Exact path depends on Windows version, usually somewhere around
24052 \begin_inset Flex Code
24055 \begin_layout Plain Layout
24058 Documents and Settings
24072 \begin_inset Flex Code
24075 \begin_layout Plain Layout
24090 , section [tunnels], setup ssh command, e.g.
24092 \begin_inset Flex Code
24095 \begin_layout Plain Layout
24096 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
24105 \begin_layout Plain Layout
24106 It will usually take a lot of time to get exact command right and it depends
24108 For example do not have some remote server saved as a default session in
24110 If things fail, try to connect via plink without SVN first.
24119 \begin_layout Enumerate
24120 Checkout the SVN archive, e.
24121 \begin_inset space \thinspace{}
24125 \begin_inset Newline newline
24129 \begin_inset Flex Code
24132 \begin_layout Plain Layout
24133 svn co svn+ssh://user@server/repository_path
24141 \begin_layout Subsubsection
24142 End-of-Line Conversions
24145 \begin_layout Standard
24146 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
24148 use different line endings inside the .lyx files.
24149 This is not a problem as far as \SpecialChar LyX
24150 functionality is concerned, but the commit
24151 diffs will be huge and merge-conflicts prone.
24152 Fortunately SVN itself knows
24156 \begin_layout Plain Layout
24157 \begin_inset Flex URL
24160 \begin_layout Plain Layout
24162 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
24172 how to deal with CR/LF problems when switching .lyx files to the
24173 \begin_inset Flex Code
24176 \begin_layout Plain Layout
24186 \begin_layout Plain Layout
24188 \begin_inset Flex Code
24191 \begin_layout Plain Layout
24192 svn propset svn:eol-style native FILE_NAME
24205 \begin_layout Subsection
24206 GIT commands in \SpecialChar LyX
24210 \begin_layout Standard
24211 A minimal subset of GIT commands is now supported by \SpecialChar LyX
24213 You can find the commands in the
24215 File\SpecialChar menuseparator
24217 \begin_inset space ~
24223 Please note that if you use password protected access to repository via
24224 ssh, you will be asked in terminal window.
24226 was tested against GIT 1.7.
24230 \begin_layout Plain Layout
24231 Windows users please note that you need to ensure that git is on the path.
24232 This can be set from within \SpecialChar LyX
24235 Tools\SpecialChar menuseparator
24236 Preferences\SpecialChar menuseparator
24237 Paths\SpecialChar menuseparator
24248 \begin_layout Standard
24249 One big difference of GIT and the other supported version control systems
24250 is the distributed nature of GIT: With traditional version control systems
24251 there is one central server which hosts the repository.
24252 Users commit their changes to the server, and get updates made by other
24254 With GIT, users commit to a local repository.
24255 The local repository can be synchronized with one or more remote repositories
24257 \begin_inset Flex Code
24260 \begin_layout Plain Layout
24267 \begin_inset Flex Code
24270 \begin_layout Plain Layout
24278 does not interact in any way with remote GIT repositories.
24279 It works exclusively with the local repository in a very similar way as
24280 with a central CVS or SVN repository.
24281 If you use remote GIT repositories you need to do the
24282 \begin_inset Flex Code
24285 \begin_layout Plain Layout
24292 \begin_inset Flex Code
24295 \begin_layout Plain Layout
24301 operations with your favourite GIT client.
24304 \begin_layout Subsubsection
24310 \begin_layout Standard
24311 If your document is not under revision control, this is the only item shown
24313 And if it is under revision control, the
24317 item is not visible.
24320 \begin_layout Standard
24321 This command registers in GIT your document ONLY in case you have already
24322 the documents directory under GIT control (in particular
24327 This means you have to checkout the archive by yourself.
24330 \begin_layout Standard
24331 Then you are asked interactively to supply an initial description of the
24333 Don't forget that registered file is not yet committed.
24336 \begin_layout Standard
24337 GIT command that is run:
24340 \begin_inset Quotes qld
24344 \begin_inset Quotes qld
24350 \begin_layout Standard
24355 to understand the switches.
24358 \begin_layout Subsubsection
24364 \begin_layout Standard
24365 When you are finished editing a file, you commit your changes.
24366 When you do this, you are asked for a description of the changes.
24367 After that changes are committed.
24370 \begin_layout Standard
24373 git commit -q -m"<description>" <file-name>
24376 \begin_layout Subsubsection
24379 Revert To Repository Version
24382 \begin_layout Standard
24383 This will discard all changes made to the document since the last check
24385 You get a warning before changes are discarded.
24388 \begin_layout Standard
24392 \begin_inset Quotes qld
24396 \begin_inset Quotes qld
24402 \begin_layout Subsubsection
24408 \begin_layout Standard
24409 This will rename the current document including the version history.
24410 It requires a clean document without any changes since the last checkin.
24411 You are asked for a file name and a description of the rename operation.
24412 After that the document is renamed, both locally and in the repository.
24413 If the parent directories of the new and old file names differ, all relative
24414 paths of included files are adjusted (like in
24416 File\SpecialChar menuseparator
24421 Finally, the document is reloaded using the new name.
24424 \begin_layout Labeling
24425 \labelwidthstring 00.00.0000
24427 \begin_inset space ~
24431 \begin_inset space ~
24435 \begin_inset Newline newline
24439 \begin_inset Flex Code
24442 \begin_layout Plain Layout
24446 \begin_inset Quotes qld
24450 \begin_inset Quotes qld
24454 \begin_inset Quotes qld
24458 \begin_inset Quotes qld
24467 \begin_inset Newline newline
24471 \begin_inset Flex Code
24474 \begin_layout Plain Layout
24483 \begin_layout Subsubsection
24489 \begin_layout Standard
24490 This shows the complete history of the GIT document.
24494 \begin_inset Quotes qld
24498 \begin_inset Quotes qld
24503 is shown in a browser.
24506 \begin_layout Subsubsection
24510 \begin_layout Standard
24512 supports GIT hash number of the last commit to the file,
24513 \change_inserted 1119979965 1564297456
24514 its abbreviated form,
24516 author name, date and time of last commit.
24517 All those are extracted from
24519 git log -n 1 --pretty=format:%H%n
24520 \change_inserted 1119979965 1564297427
24526 Tree version information is obtained via
24528 git describe --abbrev --dirty --long
24532 \begin_inset CommandInset ref
24534 reference "subsec:VCS-Revision-Information"
24541 \begin_layout Subsection
24545 \begin_layout Standard
24546 With the recent addition of the
24547 \begin_inset Flex Code
24550 \begin_layout Plain Layout
24556 function \SpecialChar LyX
24557 power users are allowed to create their own commands for revision
24561 \begin_layout Standard
24562 As an example you can see how two TortoiseSVN commands could be integrated
24566 \begin_layout Description
24568 \begin_inset Flex Code
24571 \begin_layout Plain Layout
24572 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
24580 \begin_layout Description
24582 \begin_inset Flex Code
24585 \begin_layout Plain Layout
24586 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
24594 \begin_layout Subsection
24595 Version control and Document comparison
24598 \begin_layout Standard
24599 One of the typical uses of version control is to inspect the changes between
24600 revisions, usually by creating
24601 \begin_inset Flex Code
24604 \begin_layout Plain Layout
24611 While this is useful for plain text files, it is much less useful in the
24612 case of \SpecialChar LyX
24613 files, which have more a complicated structure.
24614 Hence we provide binding to the Document comparison feature.
24615 There are two ways of calling this feature – either by direct call of
24616 \begin_inset Flex Code
24619 \begin_layout Plain Layout
24626 function (for details see \SpecialChar LyX
24627 functions manual) or by the toolbar icon
24640 One can either compare two chosen revisions of the document or he can simply
24641 compare the current version of edited text with older revisions (where
24643 \begin_inset Flex Noun
24646 \begin_layout Plain Layout
24652 ' revisions back means comparison of the edited file with last commited
24657 \begin_layout Standard
24658 This feature is supported for SVN and RCS though due to the more complicated
24659 versioning scheme of RCS there is a constraint – when addressing the revisions
24660 in dialog, numbers always point to the last number in RCS revision number,
24663 We don't currently support GIT addressing of revisions, one can just compare
24664 edited document with its revision X steps backs, where X is addressed as
24666 \begin_inset Flex Code
24669 \begin_layout Plain Layout
24678 \begin_layout Section
24679 Literate Programming
24682 \begin_layout Standard
24687 (kayvan@sylvan.com)
24691 original documentation written by
24693 Edmar Wienskoski Jr.
24696 (edmar-w-jr@technologist.com)
24699 \begin_layout Subsection
24703 \begin_layout Standard
24704 The main purpose of this documentation is to show you how to use \SpecialChar LyX
24706 programming, where it is assumed that you are familiar with this programming
24707 technique, and know what
24708 \begin_inset Quotes eld
24712 \begin_inset Quotes erd
24716 \begin_inset Quotes eld
24720 \begin_inset Quotes erd
24724 If that is not the case, please follow the web links provided in the following
24726 There is a lot of good documentation out there covering old development
24727 history to the latest tools tips.
24730 \begin_layout Standard
24731 It is also assumed that you are familiar with \SpecialChar LyX
24732 itself to a point that you
24733 are comfortable changing your \SpecialChar LyX
24734 preferences, and X resources file.
24735 If that is not the case please refer to other \SpecialChar LyX
24736 documentation to cover your
24740 \begin_layout Subsection
24741 Literate Programming
24744 \begin_layout Standard
24745 From the Literate Programming FAQ:
24748 \begin_layout Quotation
24749 Literate programming is the combination of documentation and source together
24750 in a fashion suited for reading by human beings.
24751 In fact, literate programs should be enjoyable reading, even inviting!
24752 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
24753 and documentation in a single file.
24754 Literate programming tools then parse the file to produce either readable
24755 documentation or compilable source.
24756 The WEB style of literate programming was created by D.
24757 \begin_inset space \thinspace{}
24761 Knuth during the development of his \SpecialChar TeX
24762 typesetting software.
24766 \begin_layout Standard
24767 Another excerpt says:
24770 \begin_layout Quotation
24773 How is literate programming different from verbose commenting?
24776 \begin_layout Quotation
24777 There are three distinguishing characteristics.
24778 In order of importance, they are:
24782 \begin_layout Itemize
24783 flexible order of elaboration
24786 \begin_layout Itemize
24787 automatic support for browsing
24790 \begin_layout Itemize
24791 typeset documentation, especially diagrams and mathematics
24795 \begin_layout Standard
24796 Now that I sparked your curiosity, take a look in the references.
24799 \begin_layout Subsubsection
24803 \begin_layout Standard
24804 The complete Literate Programming FAQ can be found at:
24807 \begin_layout Quote
24808 Literate Programming FAQ
24809 \begin_inset Flex URL
24812 \begin_layout Plain Layout
24814 http://www.literateprogramming.com/lpfaq.pdf
24822 \begin_layout Standard
24823 The FAQ lists 23 (twenty three!) different literate programming tools.
24824 Where some are specialized or
24825 \begin_inset Quotes eld
24829 \begin_inset Quotes erd
24832 for particular programming languages, while other have general scope.
24837 for my own use for several reasons:
24840 \begin_layout Itemize
24841 It can generate the documentation either in \SpecialChar LaTeX
24845 \begin_layout Itemize
24846 It has a open architecture, i.
24847 \begin_inset space \thinspace{}
24851 \begin_inset space \space{}
24854 it is easy to plug in new filters
24858 \begin_layout Plain Layout
24863 are programs that read a given data stream and output a manipulated data
24865 That way, a WEB file (consisting of literate code) can be turned into a
24866 file consisting only of C program code or \SpecialChar LaTeX
24872 and to perform special processing that you may need.
24876 \begin_layout Itemize
24877 There is a good selection of filters available already (the HTML is one
24881 \begin_layout Itemize
24885 \begin_layout Standard
24886 The Noweb web page can be found at:
24889 \begin_layout Quote
24891 \begin_inset Flex URL
24894 \begin_layout Plain Layout
24896 https://www.cs.tufts.edu/~nr/noweb/
24904 \begin_layout Standard
24905 Starting from there you can reach many other interesting links and even
24906 some literate program examples.
24909 \begin_layout Subsection
24911 and Literate Programming with Noweb
24914 \begin_layout Standard
24915 The \SpecialChar LyX
24916 support for Literate Programming is provided by using the generic \SpecialChar LyX
24918 converters mechanism.
24919 This support is provided in a
24920 \begin_inset Quotes eld
24924 \begin_inset Quotes erd
24928 \begin_inset space \thinspace{}
24932 \begin_inset space \space{}
24935 you will be able to use this new \SpecialChar LyX
24936 feature with some other literate programming
24937 tool of your choice by just changing your \SpecialChar LyX
24941 \begin_layout Subsubsection
24942 Generating documents and code (weaving and tangling)
24945 \begin_layout Paragraph
24946 Using the noweb module
24949 \begin_layout Standard
24950 If you have installed Noweb and \SpecialChar LyX
24951 successfully, whenever you open a new document,
24952 after you have chosen its document class, use the
24954 Document\SpecialChar menuseparator
24958 \begin_inset Quotes eld
24962 \begin_inset Quotes erd
24966 If Noweb is correctly installed, when you click on the
24967 \begin_inset Quotes eld
24971 \begin_inset Quotes erd
24974 link, you will see the
24975 \begin_inset Quotes eld
24979 \begin_inset Quotes erd
24982 module in the available list and you can add it to your document.
24985 \begin_layout Paragraph
24989 \begin_layout Standard
24991 enables you to write code with a custom inset named
24992 \begin_inset Flex Noun
24995 \begin_layout Plain Layout
25002 Noweb delimits chunks like this:
25005 \begin_layout LyX-Code
25009 \begin_layout LyX-Code
25013 \begin_layout LyX-Code
25017 \begin_layout LyX-Code
25021 \begin_layout LyX-Code
25025 \begin_layout Standard
25026 The problem is that whatever is written in between the << and the
25030 must be taken literally, i.
25031 \begin_inset space \thinspace{}
25035 \begin_inset space \space{}
25039 should be prevented from making any special interpretation of what has
25041 This is also handled by
25042 \begin_inset Flex Noun
25045 \begin_layout Plain Layout
25051 , that works like a normal text inset but has a free spacing capability.
25054 \begin_layout Standard
25055 As a special note, you can also use the
25056 \begin_inset Quotes eld
25060 \begin_inset Quotes erd
25063 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
25067 \begin_layout LyX-Code
25071 \begin_layout LyX-Code
25072 def some_function(args):
25075 \begin_layout LyX-Code
25076 "This is the doc string for this function."
25079 \begin_layout LyX-Code
25080 print "My args: ", args
25083 \begin_layout LyX-Code
25084 @ %def some_function
25087 \begin_layout Standard
25088 For an example of this usage and the resulting cross-reference output, look
25089 at the Literate python program in
25091 LIBDIR/examples/listerrors.lyx
25093 which should make this all clear.
25096 \begin_layout Paragraph
25097 Generating the documentation
25100 \begin_layout Standard
25101 At this point you already have a new document file with a proper document
25102 class, and with some code and text on it.
25103 How do I print it? The answer is simple, you select
25105 View\SpecialChar menuseparator
25109 Just like you would do for a plain document.
25110 No special procedure is required.
25113 \begin_layout Standard
25114 To help orientate you, I will now explain what happens inside \SpecialChar LyX
25118 \begin_layout Enumerate
25121 Update\SpecialChar menuseparator
25124 menu option is chosen, a \SpecialChar LaTeX
25130 \begin_layout Standard
25131 If the document is of any literate class the generated file will be named
25132 with an extension name defined by the
25133 \begin_inset Quotes eld
25137 \begin_inset Quotes erd
25140 format (defined in the Preferences panel), otherwise the file will have
25149 \begin_layout Enumerate
25150 Note that the only difference so far is in the name of the file, no special
25151 processing is required by \SpecialChar LyX
25153 Given that you formatted the code using the
25154 \begin_inset Flex Noun
25157 \begin_layout Plain Layout
25163 inset that, by itself, takes care of the business.
25166 \begin_layout Enumerate
25167 If the document is of any literate class \SpecialChar LyX
25168 will then use the internal \SpecialChar LyX
25170 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
25175 \begin_layout Plain Layout
25176 The converters are defined in the
25178 Tools\SpecialChar menuseparator
25182 \begin_inset Quotes eld
25186 \begin_inset Quotes erd
25198 manual for general information about converters.
25203 to generate the \SpecialChar LaTeX
25208 \begin_layout Standard
25209 Otherwise it will just skip this step.
25213 \begin_layout Enumerate
25214 Finally, \SpecialChar LaTeX
25215 is invoked and the regular post processing continues as in a plain
25219 \begin_layout Standard
25220 Independence from a particular
25221 \begin_inset Quotes eld
25225 \begin_inset Quotes erd
25228 is easily achieved by changing the commands that are run by the various
25232 \begin_layout Paragraph
25233 Generating the code
25236 \begin_layout Standard
25237 When the build menu option is chosen or the corresponding button in the
25238 toolbar is pressed, a \SpecialChar LaTeX
25239 file is generated just like step 1 above.
25240 Next, \SpecialChar LyX
25246 This converter needs to be defined by the user and is not installed by
25247 default, though the Program format is.
25248 This converter (like any other converter) will have two parts:
25251 \begin_layout Enumerate
25252 The converter program itself.
25253 This program performs the conversion from the one format to the other (in
25254 this case, from the Noweb format to the Program pseudo-format).
25257 \begin_layout Enumerate
25258 The error log parser.
25259 This is a program whose sole purpose is to rewrite error messages in a
25260 format that \SpecialChar LyX
25262 This makes it possible for \SpecialChar LyX
25263 to place error boxes in the right places in
25267 \begin_layout Standard
25268 The first part, the
25269 \begin_inset Quotes eld
25273 \begin_inset Quotes erd
25276 setting, should be set to
25279 \begin_layout LyX-Code
25287 \begin_layout Standard
25288 This basically means that \SpecialChar LyX
25290 \begin_inset Quotes eld
25294 \begin_inset Quotes erd
25297 (a program or script) with the name of the Noweb file (normally a file
25298 in the \SpecialChar LyX
25299 temp directory) and the directory path of the original \SpecialChar LyX
25304 \begin_layout Standard
25305 This is an implementation of
25306 \begin_inset Quotes eld
25310 \begin_inset Quotes erd
25313 that you can place in a directory on your path:
25316 \begin_layout LyX-Code
25322 \begin_layout LyX-Code
25328 \begin_layout LyX-Code
25331 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
25334 \begin_layout Standard
25335 The next part of the converter setting is the
25336 \begin_inset Quotes eld
25340 \begin_inset Quotes erd
25343 which is to be set to
25346 \begin_layout LyX-Code
25349 parselog=$$s/scripts/listerrors
25352 \begin_layout Standard
25353 This will run any errors that are generated by the
25354 \begin_inset Quotes eld
25358 \begin_inset Quotes erd
25361 process through the
25362 \begin_inset Quotes eld
25366 \begin_inset Quotes erd
25372 \begin_layout Standard
25373 The build will normally take place in \SpecialChar LyX
25374 's temporary directory, so the files
25375 produced by the conversion will be in that directory.
25377 will copy out what it regards as the `main' file, but the
25381 conversion may produce several files, and so most of these would then be
25382 deleted when \SpecialChar LyX
25384 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
25385 the build-script chunk can place the generated files in that location.
25388 \begin_layout Paragraph
25389 Build instructions in the document
25392 \begin_layout Standard
25393 The last piece of the integration between \SpecialChar LyX
25395 \begin_inset Quotes eld
25399 \begin_inset Quotes erd
25403 Generally, the instructions for building your program should be embedded
25404 in a chunk of its own.
25406 \begin_inset Quotes eld
25410 \begin_inset Quotes erd
25413 above uses the notangle command to look for this chunk (called
25414 \begin_inset Quotes eld
25418 \begin_inset Quotes erd
25421 ) and runs its contents through
25422 \begin_inset Quotes eld
25426 \begin_inset Quotes erd
25432 \begin_layout Standard
25433 Typically, such a chunk would look something like this:
25436 \begin_layout LyX-Code
25440 \begin_layout LyX-Code
25442 \begin_inset Newline newline
25445 if [ -z "${NOWEB_SOURCE}" ]
25446 \begin_inset Newline newline
25452 \begin_layout LyX-Code
25453 NOWEB_SOURCE=myfile.nw
25454 \begin_inset Newline newline
25458 \begin_inset Newline newline
25462 code to extract files ...
25463 use NOWEB_OUTPUT_DIR here ...]
25464 \begin_inset Newline newline
25468 code to compile files ...]
25469 \begin_inset Newline newline
25475 \begin_layout Standard
25478 LIBDIR/examples/listerrors.lyx
25482 LIBDIR/examples/Literate.lyx
25484 which implement two versions of the
25485 \begin_inset Quotes eld
25489 \begin_inset Quotes erd
25492 program for some illustrations of how all of these pieces go together or
25495 LIBDIR/examples/noweb2lyx.lyx.
25498 Interestingly, these three files show off the language-indepence of the
25500 literate programming support since they are written in Python, C and Perl
25504 \begin_layout Subsubsection
25505 Configuring \SpecialChar LyX
25509 \begin_layout Standard
25510 All the Literate Programming support is configured by the
25512 Tools\SpecialChar menuseparator
25516 \begin_inset Quotes eld
25520 \begin_inset Quotes erd
25524 The important parts are:
25527 \begin_layout Description
25529 \begin_inset space ~
25533 \begin_inset Quotes eld
25537 \begin_inset Quotes erd
25541 \begin_inset space ~
25544 format Set up via the File Formats tab, this is where the Noweb-specific
25554 , the file extension is set to
25559 This tells \SpecialChar LyX
25560 to create a file with a
25564 extension in the first step of the conversion process.
25567 \begin_layout Description
25569 \begin_inset space ~
25577 \begin_inset space ~
25580 format This is an empty format whose sole purpose is to be the endpoint
25581 of a conversion (which then allows us to set up a converter for it).
25584 \begin_layout Description
25594 This converter performs the
25595 \begin_inset Quotes eld
25599 \begin_inset Quotes erd
25602 of the literate document.
25603 For Noweb, it is set to
25604 \begin_inset Quotes eld
25609 noweave -delay -index $$i > $$o
25612 \begin_inset Quotes erd
25618 \begin_layout Description
25628 \begin_inset Quotes eld
25632 \begin_inset Quotes erd
25636 As stated above, the Converter is set to
25637 \begin_inset Quotes eld
25645 \begin_inset Quotes erd
25648 , with Flags set to
25649 \begin_inset Newline newline
25653 \begin_inset Quotes eld
25658 parselog=$$s/scripts/listerrors
25661 \begin_inset Quotes erd
25667 \begin_layout Subsubsection
25671 \begin_layout Standard
25672 There is also a new function implemented in the \SpecialChar LyX
25674 \begin_inset Quotes eld
25677 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
25681 \begin_layout Standard
25682 When debugging code with ddd/gdb, it is possible to invoke a text editor
25683 at the current execution position with a single key stroke.
25684 The default ddd configuration for that is shift-ctrl-V.
25685 It happens that you can define the editor command line invocation in ddd
25688 Edit\SpecialChar menuseparator
25689 Preferences\SpecialChar menuseparator
25692 dialog and changing the "Edit Sources" entry.
25695 \begin_layout Standard
25696 I take advantage of the newly created \SpecialChar LyX
25697 server function and this ddd feature,
25699 \begin_inset Quotes eld
25703 \begin_inset Quotes erd
25709 \begin_layout LyX-Code
25710 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
25713 \begin_layout Standard
25714 With this, whenever you are using ddd and find a point in the program that
25715 you want to edit, you just press shift-ctrl-V (in the ddd window), and
25716 ddd will forward this information to \SpecialChar LyX
25717 through the \SpecialChar LyX
25718 server and then the
25720 window will show the same file with the cursor at the same position ddd
25722 No more guessing or long scrolling to locate a point in the program back
25726 \begin_layout Standard
25727 Note however that you must enable the \SpecialChar LyX
25728 server to get this feature working
25729 (it is disabled by default).
25731 \begin_inset space ~
25735 \begin_inset CommandInset ref
25737 reference "sec:Starting-the-Server"
25741 explains how to do that.
25744 \begin_layout Subsubsection
25748 \begin_layout Standard
25749 There are six new buttons that can be added to your \SpecialChar LyX
25751 Four of these buttons are short cuts to layout styles:
25769 , one for the custom inset
25774 The last one is a short cut to the
25775 \begin_inset Quotes eld
25779 \begin_inset Quotes erd
25786 \begin_layout Standard
25788 has a range of buttons that are available for tool bar customization.
25789 In my toolbar I like to combine the six short cuts above with two more:
25794 \SpecialChar menuseparator
25799 \SpecialChar menuseparator
25806 Document\SpecialChar menuseparator
25807 View\SpecialChar menuseparator
25811 Here is how it looks like:
25814 \begin_layout LyX-Code
25818 \begin_layout LyX-Code
25822 \begin_layout LyX-Code
25823 Icon "layout Standard"
25826 \begin_layout LyX-Code
25827 Icon "layout Section"
25830 \begin_layout LyX-Code
25831 Icon "layout \SpecialChar LaTeX
25835 \begin_layout LyX-Code
25836 Icon "layout \SpecialChar LyX
25840 \begin_layout LyX-Code
25841 Icon "flex.insert Chunk"
25844 \begin_layout LyX-Code
25848 \begin_layout LyX-Code
25852 \begin_layout LyX-Code
25853 Icon "buffer-typeset"
25856 \begin_layout LyX-Code
25857 Icon "build-program"
25860 \begin_layout LyX-Code
25864 \begin_layout LyX-Code
25868 \begin_layout LyX-Code
25872 \begin_layout LyX-Code
25876 \begin_layout LyX-Code
25880 \begin_layout Subsubsection
25881 Colors customization
25884 \begin_layout Standard
25885 There are a number of colors in \SpecialChar LyX
25886 that can be customized in
25891 One of the things that bothers people is the \SpecialChar LaTeX
25893 The default color is red, since the chunks uses \SpecialChar LaTeX
25894 font, and there is a lot
25895 of chunks in literate documents, you may get tired of seeing everything
25897 You can change it by going to the tabs
25906 \begin_layout Standard
25907 The next thing is the visible presence of the newline character in the screen.
25908 You can choose the color of this particular character and make it blend
25910 I recommend you choosing a color that is close to the background but not
25911 equal, that way you still can see it is there, but it is not bothering
25915 \begin_layout Subsection
25920 \begin_layout Standard
25929 is documented in the
25933 example file and in the Sweave manual (menu
25935 Help\SpecialChar menuseparator
25941 \begin_layout Chapter
25945 \begin_layout Standard
25946 You can do everything with \SpecialChar LyX
25947 that you can do with \SpecialChar LaTeX
25949 However, \SpecialChar LyX
25950 cannot support every \SpecialChar LaTeX
25952 But you can always use \SpecialChar TeX
25954 This chapter shows you some more special things you might want to use.
25955 For other special things you can do with figures, tables, floats, boxes
25956 and notes, have a look at the
25959 \begin_inset space ~
25967 \begin_layout Section
25968 Multiple Text Columns
25971 \begin_layout Standard
25972 This feature is independent of the option
25974 Two-column document
25976 in the document settings under
25981 If you want to have 2
25982 \begin_inset space ~
25985 columns for the whole document, it is recommended to use the
25987 Two-column document
25990 For all other cases use this feature.
25993 \begin_layout Standard
25994 To use multiple text columns in your document, you have to load the module
26001 Document\SpecialChar menuseparator
26002 Settings\SpecialChar menuseparator
26005 ) and must have the \SpecialChar LaTeX
26007 \begin_inset Flex Code
26010 \begin_layout Plain Layout
26019 \begin_layout Standard
26020 Footnotes within multiple columns will be placed at the bottom of the page
26021 and not under each column.
26022 Within the different columns you can use everything, with the limitation
26023 that for floats you need to use the float option
26030 \begin_layout Subsection
26034 \begin_layout Standard
26035 If you want to have 2
26036 \begin_inset space ~
26039 columns in your text, insert a multicolumn inset via the menu
26041 Insert\SpecialChar menuseparator
26043 \begin_inset space ~
26046 Insets\SpecialChar menuseparator
26048 \begin_inset space ~
26053 where the columns should start.
26054 Write all text that should be printed in 2
26055 \begin_inset space ~
26058 columns into this inset.
26061 \begin_layout Standard
26062 Here is an example:
26065 \begin_layout Standard
26067 \begin_inset Flex Multiple Columns
26070 \begin_layout Plain Layout
26075 The Adventure of the Empty House
26078 \begin_inset Newline newline
26081 by Sir Arthur Conan Doyle
26084 \begin_layout Plain Layout
26087 It was in the spring of the year 1894 that all London was interested, and
26088 the fashionable world dismayed, by the murder of the Honourable Ronald
26089 Adair under most unusual and inexplicable circumstances.
26090 The public has already learned those particulars of the crime which came
26091 out in the police investigation, but a good deal was suppressed upon that
26092 occasion, since the case for the prosecution was so overwhelmingly strong
26093 that it was not necessary to bring forward all the facts.
26094 Only now, at the end of nearly ten years, am I allowed to supply those
26095 missing links which make up the whole of that remarkable chain.
26096 The crime was of interest in itself, but that interest was as nothing to
26097 me compared to the inconceivable sequel, which afforded me the greatest
26098 shock and surprise of any event in my adventurous life.
26099 Even now, after this long interval, I find myself thrilling as I think
26100 of it, and feeling once more that sudden flood of joy, amazement, and increduli
26101 ty which utterly submerged my mind.
26102 Let me say to that public, which has shown some interest in those glimpses
26103 which I have occasionally given them of the thoughts and actions of a very
26104 remarkable man, that they are not to blame me if I have not shared my knowledge
26105 with them, for I should have considered it my first duty to do so, had
26106 I not been barred by a positive prohibition from his own lips, which was
26107 only withdrawn upon the third of last month.
26115 \begin_layout Standard
26116 To get 3 or more columns, set the cursor into the multicolumn inset and
26119 Insert\SpecialChar menuseparator
26121 \begin_inset space ~
26125 \begin_inset space ~
26131 The number of the desired columns is written into that inset (for 3
26132 \begin_inset space ~
26136 \begin_inset Quotes eld
26140 \begin_inset Quotes erd
26144 \begin_inset Newline newline
26147 Here is an example with 3
26148 \begin_inset space ~
26154 \begin_layout Standard
26155 \begin_inset Flex Multiple Columns
26158 \begin_layout Plain Layout
26161 \begin_inset Argument 1
26164 \begin_layout Plain Layout
26171 It can be imagined that my close intimacy with Sherlock Holmes had interested
26172 me deeply in crime, and that after his disappearance I never failed to
26173 read with care the various problems which came before the public.
26174 And I even attempted, more than once, for my own private satisfaction,
26175 to employ his methods in their solution, though with indifferent success.
26176 There was none, however, which appealed to me like this tragedy of Ronald
26178 As I read the evidence at the inquest, which led up to a verdict of willful
26179 murder against some person or persons unknown, I realized more clearly
26180 than I had ever done the loss which the community had sustained by the
26181 death of Sherlock Holmes.
26182 There were points about this strange business which would, I was sure,
26183 have specially appealed to him, and the efforts of the police would have
26184 been supplemented, or more probably anticipated, by the trained observation
26185 and the alert mind of the first criminal agent in Europe.
26186 All day, as I drove upon my round, I turned over the case in my mind and
26187 found no explanation which appeared to me to be adequate.
26188 At the risk of telling a twice-told tale, I will recapitulate the facts
26189 as they were known to the public at the conclusion of the inquest.
26197 \begin_layout Standard
26198 You can have up to 10
26199 \begin_inset space ~
26202 columns if you want to, but that might not be very pleasant for the readers
26206 \begin_layout Standard
26207 \begin_inset Newpage newpage
26213 \begin_layout Subsection
26214 Columns inside Columns
26217 \begin_layout Standard
26218 You can also have columns inside columns:
26221 \begin_layout Standard
26222 \begin_inset Flex Multiple Columns
26225 \begin_layout Plain Layout
26228 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
26229 at that time governor of one of the Australian colonies.
26230 Adair's mother had returned from Australia to undergo the operation for
26231 cataract, and she, her son Ronald, and her daughter Hilda were living together
26235 \begin_layout Plain Layout
26236 \begin_inset Flex Multiple Columns
26239 \begin_layout Plain Layout
26242 The youth moved in the best society
26243 \begin_inset space ~
26246 – had, so far as was known, no enemies and no particular vices.
26247 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
26248 had been broken off by mutual consent some months before, and there was
26249 no sign that it had left any very profound feeling behind it.
26250 For the rest {sic} the man's life moved in a narrow and conventional circle,
26251 for his habits were quiet and his nature unemotional.
26252 Yet it was upon this easy-going young aristocrat that death came, in most
26253 strange and unexpected form, between the hours of ten and eleven-twenty
26254 on the night of March 30, 1894.
26262 \begin_layout Plain Layout
26265 Ronald Adair was fond of cards
26266 \begin_inset space ~
26269 – playing continually, but never for such stakes as would hurt him.
26270 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
26271 It was shown that, after dinner on the day of his death, he had played
26272 a rubber of whist at the latter club.
26273 He had also played there in the afternoon.
26278 The evidence of those who had played with him
26279 \begin_inset space ~
26283 Murray, Sir John Hardy, and Colonel Moran
26284 \begin_inset space ~
26287 – showed that the game was whist, and that there was a fairly equal fall
26289 Adair might have lost five pounds, but not more.
26290 His fortune was a considerable one, and such a loss could not in any way
26292 He had played nearly every day at one club or other, but he was a cautious
26293 player, and usually rose a winner.
26294 It came out in evidence that, in partnership with Colonel Moran, he had
26295 actually won as much as four hundred and twenty pounds in a sitting, some
26296 weeks before, from Godfrey Milner and Lord Balmoral.
26297 So much for his recent history as it came out at the inquest.
26305 \begin_layout Subsection
26309 \begin_layout Standard
26310 The examples in this section show some more special features of multiple
26314 \begin_layout Standard
26315 For more features of multiple columns, have a look at the
26316 \begin_inset CommandInset href
26318 name "documentation"
26319 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
26324 of the \SpecialChar LaTeX
26326 \begin_inset Flex Code
26329 \begin_layout Plain Layout
26338 \begin_layout Subsubsection
26342 \begin_layout Standard
26343 To add a preface text for multiple columns, set the cursor into the multicolumn
26344 inset and use the menu
26346 Insert\SpecialChar menuseparator
26350 Write your preface text into that inset.
26351 \begin_inset Newline newline
26354 This is an example with some preface text:
26357 \begin_layout Standard
26358 \begin_inset VSpace bigskip
26364 \begin_layout Standard
26365 \begin_inset Flex Multiple Columns
26368 \begin_layout Plain Layout
26369 \begin_inset Argument 2
26372 \begin_layout Plain Layout
26373 And the story continues and continues and continues and continues\SpecialChar ldots
26381 On the evening of the crime, he returned from the club exactly at ten.
26382 His mother and sister were out spending the evening with a relation.
26383 The servant deposed that she heard him enter the front room on the second
26384 floor, generally used as his sitting-room.
26385 She had lit a fire there, and as it smoked she had opened the window.
26386 No sound was heard from the room until eleven-twenty, the hour of the return
26387 of Lady Maynooth and her daughter.
26388 Desiring to say good-night, she attempted to enter her son's room.
26389 The door was locked on the inside, and no answer could be got to their
26390 cries and knocking.
26391 Help was obtained, and the door forced.
26392 The unfortunate young man was found lying near the table.
26393 His head had been horribly mutilated by an expanding revolver bullet, but
26394 no weapon of any sort was to be found in the room.
26402 \begin_layout Standard
26403 You can also use a section heading as the preface if you use a section command
26404 as \SpecialChar TeX
26406 For example the command
26409 \begin_layout LyX-Code
26412 subsection{subsection title}
26415 \begin_layout Standard
26416 creates a subsection.
26417 In this example the preface is a subsubsection:
26420 \begin_layout Standard
26421 \begin_inset Flex Multiple Columns
26424 \begin_layout Plain Layout
26425 \begin_inset Argument 2
26428 \begin_layout Plain Layout
26432 \begin_layout Plain Layout
26441 This is a subsubsection heading as a preface
26445 \begin_layout Plain Layout
26459 A minute examination of the circumstances served only to make the case more
26461 In the first place, no reason could be given why the young man should have
26462 fastened the door upon the inside.
26463 There was the possibility that the murderer had done this, and had afterwards
26464 escaped by the window.
26465 The drop was at least twenty feet, however, and a bed of crocuses in full
26467 Neither the flowers nor the earth showed any sign of having been disturbed,
26468 nor were there any marks upon the narrow strip of grass which separated
26469 the house from the road.
26470 Apparently, therefore, it was the young man himself who had fastened the
26472 But how did he come by his death? No one could have climbed up to the window
26473 without leaving traces.
26474 Suppose a man had fired through the window, he would indeed be a remarkable
26475 shot who could with a revolver inflict so deadly a wound.
26476 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
26477 a hundred yards of the house.
26478 No one had heard a shot.
26486 \begin_layout Standard
26487 If there is less vertical space than 6
26488 \begin_inset space ~
26491 text lines is left on the page at the beginning of the multiple columns,
26492 a page break will be inserted before the multiple columns.
26493 Depending on the number of lines of the preface text, you might want to
26495 This is done by setting the cursor into the mulitcolumn inset behind the
26496 preface (if there is any) and using the menu
26498 Insert\SpecialChar menuseparator
26500 \begin_inset space ~
26504 \begin_inset space ~
26508 \begin_inset space ~
26514 Insert into that inset the amount of space like e.
26515 \begin_inset space \thinspace{}
26519 \begin_inset space \space{}
26523 \begin_inset Quotes eld
26527 \begin_inset Quotes erd
26531 \begin_inset Newline newline
26534 In this example the space is set to 7
26535 \begin_inset space ~
26538 text lines by using
26539 \begin_inset Flex Code
26542 \begin_layout Plain Layout
26551 \begin_inset Flex Code
26554 \begin_layout Plain Layout
26562 needs to be inserted as \SpecialChar TeX
26566 \begin_layout Standard
26567 \begin_inset Flex Multiple Columns
26570 \begin_layout Plain Layout
26571 \begin_inset Argument 3
26574 \begin_layout Plain Layout
26579 \begin_layout Plain Layout
26595 On the evening of the crime, he returned from the club exactly at ten.
26596 His mother and sister were out spending the evening with a relation.
26597 The servant deposed that she heard him enter the front room on the second
26598 floor, generally used as his sitting-room.
26599 She had lit a fire there, and as it smoked she had opened the window.
26600 No sound was heard from the room until eleven-twenty, the hour of the return
26601 of Lady Maynooth and her daughter.
26602 Desiring to say good-night, she attempted to enter her son's room.
26603 The door was locked on the inside, and no answer could be got to their
26604 cries and knocking.
26605 Help was obtained, and the door forced.
26606 The unfortunate young man was found lying near the table.
26607 His head had been horribly mutilated by an expanding revolver bullet, but
26608 no weapon of any sort was to be found in the room.
26616 \begin_layout Subsubsection
26620 \begin_layout Standard
26621 The amount of space before and after multiple columns can be changed by
26622 changing the length
26623 \begin_inset Flex Code
26626 \begin_layout Plain Layout
26635 For example the command
26638 \begin_layout LyX-Code
26646 \begin_layout Standard
26647 in \SpecialChar TeX
26648 Code changes its value to 3
26649 \begin_inset space \thinspace{}
26653 The change must be made before the multiple columns' start.
26654 The predefined value is 13
26655 \begin_inset space \thinspace{}
26661 \begin_layout Standard
26663 \begin_inset Flex Code
26666 \begin_layout Plain Layout
26675 \begin_inset space \thinspace{}
26681 \begin_layout Standard
26685 \begin_layout Plain Layout
26691 multicolsep}{2.5cm}
26699 \begin_layout Standard
26700 \begin_inset Flex Multiple Columns
26703 \begin_layout Plain Layout
26706 All day I turned these facts over in my mind, endeavouring to hit upon some
26707 theory which could reconcile them all, and to find that line of least resistanc
26708 e which my poor friend had declared to be the starting-point of every investigat
26710 I confess that I made little progress.
26711 In the evening I strolled across the Park, and found myself about six o'clock
26712 at the Oxford Street end of Park Lane.
26713 A group of loafers upon the pavements, all staring up at a particular window,
26714 directed me to the house which I had come to see.
26715 A tall, thin man with coloured glasses, whom I strongly suspected of being
26716 a plain-clothes detective, was pointing out some theory of his own, while
26717 the others crowded round to listen to what he said.
26718 I got as near him as I could, but his observations seemed to me to be absurd,
26719 so I withdrew again in some disgust.
26720 As I did so I struck against an elderly, deformed man, who had been behind
26721 me, and I knocked down several books which he was carrying.
26729 \begin_layout Standard
26730 \begin_inset Note Greyedout
26733 \begin_layout Plain Layout
26738 The values you set with
26739 \begin_inset Flex Code
26742 \begin_layout Plain Layout
26750 will be used for all following multiple columns until you change them again.
26758 \begin_layout Standard
26762 \begin_layout Plain Layout
26774 \begin_inset Note Note
26777 \begin_layout Plain Layout
26778 go back to the default
26786 \begin_layout Standard
26787 \begin_inset Newpage newpage
26793 \begin_layout Subsubsection
26797 \begin_layout Standard
26798 A column break can be forced by inserting the command
26799 \begin_inset Flex Code
26802 \begin_layout Plain Layout
26810 as \SpecialChar TeX
26811 Code to that position in the text where the column should be broken.
26812 Note that this leads in most cases to whitespace in the text.
26813 \begin_inset Newline newline
26816 Here is an example:
26819 \begin_layout Standard
26820 \begin_inset Flex Multiple Columns
26823 \begin_layout Plain Layout
26826 \begin_inset Quotes eld
26829 You're surprised to see me, sir,
26830 \begin_inset Quotes erd
26833 said he, in a strange, croaking voice.
26836 \begin_layout Plain Layout
26839 I acknowledged that I was.
26842 \begin_layout Plain Layout
26845 \begin_inset Quotes eld
26848 Well, I've a conscience, sir, and when I chanced to see you go into this
26849 house, as I came hobbling after you, I thought to myself, I'll just step
26850 in and see that kind gentleman, and tell him that if I was a bit gruff
26851 in my manner there was not any harm meant, and that I am much obliged to
26852 him for picking up my books.
26853 \begin_inset Quotes erd
26859 \begin_layout Plain Layout
26862 \begin_inset Quotes eld
26865 You make too much of a trifle,
26866 \begin_inset Quotes erd
26871 \begin_inset Quotes eld
26874 May I ask how you knew who I was?
26875 \begin_inset Quotes erd
26878 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
26882 \begin_layout Plain Layout
26894 \begin_layout Plain Layout
26897 \begin_inset Quotes eld
26900 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26901 you'll find my little bookshop at the corner of Church Street, and very
26902 happy to see you, I am sure.
26903 Maybe you collect yourself, sir.
26907 \begin_inset space ~
26921 \begin_inset space ~
26924 – a bargain, every one of them.
26925 With five volumes you could just fill that gap on that second shelf.
26926 It looks untidy, does it not, sir?
26927 \begin_inset Quotes erd
26938 \begin_layout Subsubsection
26942 \begin_layout Standard
26943 The width of the columns is automatically calculated, but you can modify
26944 the space between the columns.
26945 This is done by changing the length
26946 \begin_inset Flex Code
26949 \begin_layout Plain Layout
26958 Its predefined value is 10
26959 \begin_inset space \thinspace{}
26963 Here is an example where
26964 \begin_inset Flex Code
26967 \begin_layout Plain Layout
26976 \begin_inset space \thinspace{}
26982 \begin_layout Standard
26986 \begin_layout Plain Layout
27000 \begin_layout Standard
27001 \begin_inset Flex Multiple Columns
27004 \begin_layout Plain Layout
27007 My observations of No.
27008 \begin_inset space \space{}
27011 427 Park Lane did little to clear up the problem in which I was interested.
27012 The house was separated from the street by a low wall and railing, the
27013 whole not more than five feet high.
27014 It was perfectly easy, therefore, for anyone to get into the garden, but
27015 the window was entirely inaccessible, since there was no water pipe or
27016 anything which could help the most active man to climb it.
27017 More puzzled than ever, I retraced my steps to Kensington.
27018 I had not been in my study five minutes when the maid entered to say that
27019 a person desired to see me.
27020 To my astonishment it was none other than my strange old book collector,
27021 his sharp, wizened face peering out from a frame of white hair, and his
27022 precious volumes, a dozen of them at least, wedged under his right arm.
27030 \begin_layout Standard
27034 \begin_layout Plain Layout
27046 \begin_inset Note Note
27049 \begin_layout Plain Layout
27050 go back to the default
27058 \begin_layout Subsubsection
27062 \begin_layout Standard
27063 Between the columns a rule with a width of the length
27064 \begin_inset Flex Code
27067 \begin_layout Plain Layout
27076 If this rule width is set to 0
27077 \begin_inset space \thinspace{}
27080 pt (this is the default), the rule is suppressed.
27081 In the following example the rule is 2
27082 \begin_inset space \thinspace{}
27088 \begin_layout Standard
27092 \begin_layout Plain Layout
27098 columnseprule}{2pt}
27106 \begin_layout Standard
27107 \begin_inset Flex Multiple Columns
27110 \begin_layout Plain Layout
27113 \begin_inset Quotes eld
27116 You're surprised to see me, sir,
27117 \begin_inset Quotes erd
27120 said he, in a strange, croaking voice.
27123 \begin_layout Plain Layout
27126 I acknowledged that I was.
27129 \begin_layout Plain Layout
27132 \begin_inset Quotes eld
27135 Well, I've a conscience, sir, and when I chanced to see you go into this
27136 house, as I came hobbling after you, I thought to myself, I'll just step
27137 in and see that kind gentleman, and tell him that if I was a bit gruff
27138 in my manner there was not any harm meant, and that I am much obliged to
27139 him for picking up my books.
27140 \begin_inset Quotes erd
27146 \begin_layout Plain Layout
27149 \begin_inset Quotes eld
27152 You make too much of a trifle,
27153 \begin_inset Quotes erd
27158 \begin_inset Quotes eld
27161 May I ask how you knew who I was?
27162 \begin_inset Quotes erd
27168 \begin_layout Plain Layout
27171 \begin_inset Quotes eld
27174 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
27175 you'll find my little bookshop at the corner of Church Street, and very
27176 happy to see you, I am sure.
27177 Maybe you collect yourself, sir.
27181 \begin_inset space ~
27195 \begin_inset space ~
27198 – a bargain, every one of them.
27199 With five volumes you could just fill that gap on that second shelf.
27200 It looks untidy, does it not, sir?
27201 \begin_inset Quotes erd
27212 \begin_layout Standard
27213 \begin_inset VSpace defskip
27219 \begin_layout Standard
27220 The rule can be colored by redefining the command
27221 \begin_inset Flex Code
27224 \begin_layout Plain Layout
27233 This is done by inserting the command
27236 \begin_layout LyX-Code
27241 columnseprulecolor}{
27246 \begin_layout Standard
27247 as \SpecialChar TeX
27248 Code before the multicolumn inset.
27250 \begin_inset Flex Code
27253 \begin_layout Plain Layout
27259 in this command by a color of your choice.
27260 You can use all pre- and self-defined colors.
27268 \begin_inset space ~
27273 for more information about pre- and self-defined colors.
27274 To go back to the default color insert the command
27277 \begin_layout LyX-Code
27282 columnseprulecolor}{
27287 \begin_layout Standard
27288 Here is the example with a cyan rule and 1
27289 \begin_inset space \thinspace{}
27292 cm column separation:
27295 \begin_layout Standard
27299 \begin_layout Plain Layout
27308 \begin_layout Plain Layout
27314 columnseprulecolor}{
27324 \begin_layout Standard
27325 \begin_inset Flex Multiple Columns
27328 \begin_layout Plain Layout
27331 \begin_inset Quotes eld
27334 You're surprised to see me, sir,
27335 \begin_inset Quotes erd
27338 said he, in a strange, croaking voice.
27341 \begin_layout Plain Layout
27344 I acknowledged that I was.
27347 \begin_layout Plain Layout
27350 \begin_inset Quotes eld
27353 Well, I've a conscience, sir, and when I chanced to see you go into this
27354 house, as I came hobbling after you, I thought to myself, I'll just step
27355 in and see that kind gentleman, and tell him that if I was a bit gruff
27356 in my manner there was not any harm meant, and that I am much obliged to
27357 him for picking up my books.
27358 \begin_inset Quotes erd
27364 \begin_layout Plain Layout
27367 \begin_inset Quotes eld
27370 You make too much of a trifle,
27371 \begin_inset Quotes erd
27376 \begin_inset Quotes eld
27379 May I ask how you knew who I was?
27380 \begin_inset Quotes erd
27386 \begin_layout Plain Layout
27389 \begin_inset Quotes eld
27392 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
27393 you'll find my little bookshop at the corner of Church Street, and very
27394 happy to see you, I am sure.
27395 Maybe you collect yourself, sir.
27399 \begin_inset space ~
27413 \begin_inset space ~
27416 – a bargain, every one of them.
27417 With five volumes you could just fill that gap on that second shelf.
27418 It looks untidy, does it not, sir?
27419 \begin_inset Quotes erd
27430 \begin_layout Standard
27434 \begin_layout Plain Layout
27440 columnseprule}{0pt}
27443 \begin_layout Plain Layout
27449 columnseprulecolor}{
27457 \begin_inset Note Note
27460 \begin_layout Plain Layout
27461 go back to the default
27469 \begin_layout Section
27470 Non-standard Paragraph Shapes
27473 \begin_layout Standard
27476 as well as any other text processor uses by default rectangular paragraphs.
27477 For special cases like for example posters, invitation cards or poems you
27478 can modify the paragraph shape to one of your choice.
27479 This can be done by using the \SpecialChar LaTeX
27481 \begin_inset Flex Code
27484 \begin_layout Plain Layout
27490 which is loaded by using in the document settings the module
27492 Custom paragraph shapes
27497 \begin_layout Subsection
27501 \begin_layout Standard
27506 provides the following shapes:
27509 \begin_layout Standard
27510 \begin_inset Tabular
27511 <lyxtabular version="3" rows="13" columns="3">
27512 <features booktabs="true" islongtable="true" longtabularalignment="center">
27513 <column alignment="left" valignment="middle" width="16col%">
27514 <column alignment="left" valignment="middle" width="40col%">
27515 <column alignment="left" valignment="middle" width="35col%">
27516 <row endhead="true">
27517 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27520 \begin_layout Plain Layout
27529 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27532 \begin_layout Plain Layout
27541 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27544 \begin_layout Plain Layout
27554 <row interlinespace="default">
27555 <cell alignment="left" valignment="top" usebox="none">
27558 \begin_layout Plain Layout
27566 <cell alignment="left" valignment="top" usebox="none">
27569 \begin_layout Plain Layout
27572 Circle with circular hole (in the size of a CD/DVD)
27577 <cell alignment="left" valignment="top" usebox="none">
27580 \begin_layout Plain Layout
27583 Cannot be scaled, take care there is not too much text
27589 <row interlinespace="default">
27590 <cell alignment="left" valignment="top" usebox="none">
27593 \begin_layout Plain Layout
27601 <cell alignment="left" valignment="top" usebox="none">
27604 \begin_layout Plain Layout
27612 <cell alignment="left" valignment="top" usebox="none">
27615 \begin_layout Plain Layout
27618 Fragile, calculation might fail
27624 <row interlinespace="default">
27625 <cell alignment="left" valignment="top" usebox="none">
27628 \begin_layout Plain Layout
27636 <cell alignment="left" valignment="top" usebox="none">
27639 \begin_layout Plain Layout
27642 Rhomboid (symbolizing a
27643 \begin_inset Quotes eld
27647 \begin_inset Quotes erd
27655 <cell alignment="left" valignment="top" usebox="none">
27658 \begin_layout Plain Layout
27667 <row interlinespace="default">
27668 <cell alignment="left" valignment="top" usebox="none">
27671 \begin_layout Plain Layout
27679 <cell alignment="left" valignment="top" usebox="none">
27682 \begin_layout Plain Layout
27690 <cell alignment="left" valignment="top" usebox="none">
27693 \begin_layout Plain Layout
27702 <row interlinespace="default">
27703 <cell alignment="left" valignment="top" usebox="none">
27706 \begin_layout Plain Layout
27714 <cell alignment="left" valignment="top" usebox="none">
27717 \begin_layout Plain Layout
27725 <cell alignment="left" valignment="top" usebox="none">
27728 \begin_layout Plain Layout
27737 <row interlinespace="default">
27738 <cell alignment="left" valignment="top" usebox="none">
27741 \begin_layout Plain Layout
27749 <cell alignment="left" valignment="top" usebox="none">
27752 \begin_layout Plain Layout
27755 Nut for bolt (hexagon with circular hole)
27760 <cell alignment="left" valignment="top" usebox="none">
27763 \begin_layout Plain Layout
27772 <row interlinespace="default">
27773 <cell alignment="left" valignment="top" usebox="none">
27776 \begin_layout Plain Layout
27784 <cell alignment="left" valignment="top" usebox="none">
27787 \begin_layout Plain Layout
27795 <cell alignment="left" valignment="top" usebox="none">
27798 \begin_layout Plain Layout
27807 <row interlinespace="default">
27808 <cell alignment="left" valignment="top" usebox="none">
27811 \begin_layout Plain Layout
27819 <cell alignment="left" valignment="top" usebox="none">
27822 \begin_layout Plain Layout
27830 <cell alignment="left" valignment="top" usebox="none">
27833 \begin_layout Plain Layout
27842 <row interlinespace="default">
27843 <cell alignment="left" valignment="top" usebox="none">
27846 \begin_layout Plain Layout
27854 <cell alignment="left" valignment="top" usebox="none">
27857 \begin_layout Plain Layout
27865 <cell alignment="left" valignment="top" usebox="none">
27868 \begin_layout Plain Layout
27877 <row interlinespace="default">
27878 <cell alignment="left" valignment="top" usebox="none">
27881 \begin_layout Plain Layout
27889 <cell alignment="left" valignment="top" usebox="none">
27892 \begin_layout Plain Layout
27895 Normal/reversed rain drop
27900 <cell alignment="left" valignment="top" usebox="none">
27903 \begin_layout Plain Layout
27906 Fragile, calculation might fail
27912 <row interlinespace="default">
27913 <cell alignment="left" valignment="top" usebox="none">
27916 \begin_layout Plain Layout
27925 <cell alignment="left" valignment="top" usebox="none">
27928 \begin_layout Plain Layout
27931 The \SpecialChar TeX
27937 <cell alignment="left" valignment="top" usebox="none">
27940 \begin_layout Plain Layout
27949 <row interlinespace="default">
27950 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
27953 \begin_layout Plain Layout
27957 \begin_inset Newline newline
27965 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
27968 \begin_layout Plain Layout
27971 Triangles in different orientations
27976 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
27979 \begin_layout Plain Layout
27995 \begin_layout Standard
27996 To use a shape for your paragraph, simply select it in \SpecialChar LyX
27998 for environments in the toolbar.
28001 \begin_layout Standard
28002 \begin_inset Newpage newpage
28008 \begin_layout Standard
28009 Here is an example paragraph in the shape of a nut:
28012 \begin_layout Standard
28013 \begin_inset VSpace bigskip
28022 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28023 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28025 At vero eos et accusam et justo duo dolores et ea rebum.
28026 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28028 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28029 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28033 \begin_layout Standard
28034 \begin_inset VSpace bigskip
28040 \begin_layout Standard
28041 \begin_inset Note Greyedout
28044 \begin_layout Plain Layout
28053 paragraphs cannot run over a page break.
28061 \begin_layout Standard
28062 \begin_inset VSpace bigskip
28068 \begin_layout Standard
28070 \begin_inset Flex Code
28073 \begin_layout Plain Layout
28079 takes care that the shape will always be preserved, no matter how much
28080 text is in the paragraph.
28081 Therefore the paragraph size changes with the amount of contained text.
28082 This can lead to paragraph sizes exceeding the page margins.
28083 To demonstrate the size scaling, here is the same example paragraph but
28084 with twice as much text:
28087 \begin_layout Standard
28088 \begin_inset Newpage newpage
28097 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28098 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28100 At vero eos et accusam et justo duo dolores et ea rebum.
28101 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28103 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28104 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28106 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28107 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28109 At vero eos et accusam et justo duo dolores et ea rebum.
28110 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28112 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28113 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28117 \begin_layout Standard
28118 \begin_inset VSpace bigskip
28124 \begin_layout Standard
28125 An exception is the shape
28130 It cannot be scaled because it must fit the size of a CD/DVD.
28131 Therefore the amount of text that fits into the shape is limited.
28132 \begin_inset Newline newline
28143 shape are fragile, meaning that the calculation of their size can fail,
28144 depending on the amount of text.
28145 You will then get the \SpecialChar LaTeX
28147 \begin_inset Quotes eld
28150 Arithmetic overflow
28151 \begin_inset Quotes erd
28155 In this case one can try to remove or add some text; if nothing works one
28156 has to use another shape.
28159 \begin_layout Standard
28160 \begin_inset VSpace bigskip
28166 \begin_layout Standard
28167 For shapes with tips you will maybe see that \SpecialChar LaTeX
28168 's hyphenation routine fails
28169 for text in the tips.
28170 Therefore it is often necessary to add hyphenation points
28175 arg "specialchar-insert hyphenation"
28180 ) to the corresponding text parts.
28183 \begin_layout Standard
28184 \begin_inset VSpace bigskip
28190 \begin_layout Standard
28191 Shapepar paragraphs are either always centered or placed on the page so
28192 that their left border touches the left page margin.
28193 You can therefore not use the paragraph dialog to align such paragraphs.
28194 A solution is to put the paragraph into a minipage or parbox and align
28196 The problem is hereby to find the right width for the box.
28197 Because if it is too wide and you center the box, the paragraph is not
28198 centered too because it sticks at the left side of the box.
28199 So you might have to play a bit with the width until it fits.
28200 Here are two heart-shaped paragraphs, the first one is not aligned, the
28201 second one is right-aligned:
28204 \begin_layout Standard
28205 \begin_inset Newpage newpage
28211 \begin_layout Heart
28215 Lo\SpecialChar softhyphen
28216 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28217 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28219 At vero eos et accusam et justo duo dolores et ea rebum.
28220 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28224 \begin_layout Standard
28225 \begin_inset VSpace bigskip
28231 \begin_layout Standard
28234 \begin_inset Box Frameless
28244 height_special "totalheight"
28249 backgroundcolor "none"
28252 \begin_layout Heart
28256 Lo\SpecialChar softhyphen
28257 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28258 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28260 At vero eos et accusam et justo duo dolores et ea rebum.
28261 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28270 \begin_layout Subsection
28274 \begin_layout Standard
28275 You can define any shape you want.
28276 Doing this manually is a lot of work because every coordinate must be specified.
28277 But there is a way to let the computer calculate the coordinates:
28280 \begin_layout Enumerate
28281 Install the program
28282 \begin_inset CommandInset href
28285 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
28293 \begin_layout Enumerate
28300 TeX/LaTeX\SpecialChar menuseparator
28301 Settings\SpecialChar menuseparator
28304 and select the font size you are using in your document.
28305 For example this document uses the size 12
28306 \begin_inset space \thinspace{}
28312 \begin_layout Enumerate
28316 \begin_layout Enumerate
28319 TeX/LaTeX\SpecialChar menuseparator
28322 to export the shape to coordinates.
28323 In the appearing dialog use either the outline of your shape for the coordinate
28324 s or the path itself.
28328 \begin_layout Plain Layout
28329 For more information see
28330 \begin_inset CommandInset href
28332 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
28345 \begin_layout Standard
28346 The coordinates are written into a \SpecialChar TeX
28348 To use it for your \SpecialChar LyX
28352 \begin_layout Enumerate
28353 Place the cursor before the first character of your paragraph (or into a
28357 \begin_layout Enumerate
28358 Open in \SpecialChar LyX
28361 Insert\SpecialChar menuseparator
28362 File\SpecialChar menuseparator
28364 \begin_inset space ~
28369 , select the file and use
28378 \begin_layout Standard
28379 \begin_inset VSpace defskip
28385 \begin_layout Standard
28386 \begin_inset Note Greyedout
28389 \begin_layout Plain Layout
28394 : The changed shape only applies to the current paragraph; everything is
28395 reset to normal for the next paragraph.
28396 Therefore the shape definition file must be input into every paragraph
28397 with the desired shape.
28405 \begin_layout Standard
28406 \begin_inset VSpace bigskip
28412 \begin_layout Standard
28413 Here is an example:
28416 \begin_layout Standard
28417 \begin_inset VSpace bigskip
28423 \begin_layout Standard
28424 \begin_inset CommandInset include
28426 filename "SpecialParagraphShape.tex"
28433 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28434 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28436 At vero eos et accusam et justo duo dolores et ea rebum.
28437 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
28439 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
28440 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
28444 \begin_layout Standard
28445 \begin_inset VSpace bigskip
28451 \begin_layout Standard
28456 to draw complexer shapes in
28460 you can draw the shape in a program of your choice and import the resulting
28466 Then you only need to draw a line or spline along the outline of the image.
28469 \begin_layout Standard
28470 \begin_inset VSpace bigskip
28476 \begin_layout Standard
28479 Custom paragraph shapes
28481 also provides the two commands
28489 which can be used to define custom shapes coordinate by coordinate.
28493 \begin_layout Plain Layout
28494 These commands are internally used for all shapes described here.
28499 For information how these styles are used and about further customization
28500 possibilities, have a look at the
28501 \begin_inset CommandInset href
28503 name "documentation"
28504 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
28510 \begin_inset Flex Code
28513 \begin_layout Plain Layout
projects / lyx.git / blob