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
2872 \change_inserted 564990737 1671383236
2875 \begin_inset CommandInset label
2877 name "subsec:Extra-font-sizes"
2884 \begin_layout Standard
2886 \change_inserted 564990737 1671383236
2889 The “Extra font sizes” collection provides the document classes
2892 \begin_inset space \thinspace{}
2895 (with extra font sizes)
2900 \begin_inset space \thinspace{}
2903 (with extra font sizes)
2908 \begin_inset space \thinspace{}
2911 (with extra font sizes)
2916 \begin_inset space \thinspace{}
2919 (with extra font sizes)
2937 document classes respectively but offer the additional
2943 \begin_inset space ~
2948 options 8, 9, 14, 17 and 20 in the
2953 ocument\SpecialChar menuseparator
2958 ettings\SpecialChar menuseparator
2964 \begin_layout Subsection
2966 \change_inserted 564990737 1671383236
2972 \begin_layout Standard
2974 \change_inserted 564990737 1671383236
2977 The document classes
2980 \begin_inset space \thinspace{}
2988 \begin_inset space \thinspace{}
3003 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3007 \begin_layout Subsection
3009 \change_inserted 564990737 1671383236
3012 \begin_inset CommandInset label
3014 name "subsec:Japanese"
3021 \begin_layout Standard
3023 \change_inserted 564990737 1671383236
3026 The document classes
3029 \begin_inset space \thinspace{}
3037 \begin_inset space \thinspace{}
3040 (Japanese Standard Class Vertical Writing)
3045 \begin_inset space \thinspace{}
3048 (Japanese Standard Class)
3053 \begin_inset space \thinspace{}
3061 \begin_inset space \thinspace{}
3064 (Japanese Standard Class Vertical Writing)
3069 \begin_inset space \thinspace{}
3072 (Japanese Standard Class)
3077 \begin_inset space \thinspace{}
3080 (Japanese Vertical Writing)
3085 \begin_inset space \thinspace{}
3088 (Japanese Standard Class)
3090 provide document classes for the Japanese language.
3093 \begin_layout Subsection
3097 \begin_layout Standard
3103 \begin_layout Subsubsection
3107 \begin_layout Standard
3108 The \SpecialChar LyX
3111 article (koma-script)
3115 report (koma-script)
3133 correspond to the \SpecialChar LaTeX
3151 \begin_inset space ~
3154 of the Koma-Script family.
3155 They are replacements for the standard document classes
3171 , resp., and fit better to European typography conventions in a number of
3175 \begin_layout Itemize
3176 Standard character size is 11pt in
3178 article (koma-script)
3182 report (koma-script)
3190 letter (koma-script)
3195 \begin_layout Itemize
3196 Headings, labels of the description environment, and a number of elements
3199 letter (koma-script)
3201 document class are set in a bold sans serif font.
3205 \begin_layout Plain Layout
3206 There is a big difference between the bold sans serif old cm fonts and new
3207 ec fonts, especially in the appearance of headings.
3208 In comparison, the ec bold sans serif fonts look a bit thin.
3209 Here the \SpecialChar LaTeX
3218 helps to produce the
3219 \begin_inset Quotes eld
3223 \begin_inset Quotes erd
3226 appearance when using the ec fonts.
3231 The numbering of chapter headings is made in the same way as the numbering
3232 of section headings, that is without the extra line
3233 \begin_inset Quotes eld
3236 Chapter\SpecialChar ldots
3238 \begin_inset Quotes erd
3242 In addition, the appearance of the headings can be modified by using a
3243 number of options (in \SpecialChar LyX
3244 to be entered in the field
3247 \begin_inset space ~
3254 Layout\SpecialChar menuseparator
3261 \begin_layout Itemize
3262 The main means in the Koma-Script document classes to design the type area
3271 (in \SpecialChar LyX
3272 to be entered in the extra class options field in the dialog
3274 Document\SpecialChar menuseparator
3278 They make a clearer modification of page margins possible as do the options
3281 Document\SpecialChar menuseparator
3288 \begin_layout Itemize
3289 The \SpecialChar LaTeX
3290 document classes of the Koma-Script family define a number of additional
3292 Those part of it which makes sense in \SpecialChar LyX
3293 is implemented in corresponding
3297 \begin_layout Standard
3298 Detailed descriptions of the \SpecialChar LaTeX
3299 document classes of the Koma-Script family
3300 can be found in the Koma-Script documentation
3311 \begin_layout Subsubsection
3312 article (koma-script), report (koma-script), and book (koma-script)
3315 \begin_layout Standard
3316 The document classes
3318 article (koma-script)
3322 report (koma-script)
3332 are implemented in the layout files
3345 They contain all the paragraph types of the corresponding standard document
3358 , resp., partly modified, with the exception of the \SpecialChar LyX
3363 -type, which is replaced by the new
3367 -type having the same functionality.
3372 -Type there is a number of new paragraph types added.
3379 letter (koma-script)
3384 \begin_layout Itemize
3393 : are equivalents to
3401 , resp., additionally inserting an entry in the table of contents.
3410 are not contained in
3412 article (koma-script)
3417 \begin_layout Itemize
3434 , resp., additionally clearing running heads.
3441 article (koma-script)
3447 \begin_layout Plain Layout
3460 report (koma-script)
3462 , but since this is identical to
3466 , is has not been implemented in \SpecialChar LyX
3475 \begin_layout Itemize
3480 : generates a heading directly above the following paragraph in the standard
3481 character size without affecting the structure of the document.
3484 \begin_layout Itemize
3493 are special captions which respect the different space settings needed
3494 for captions placed above or below an element (if you follow strict typographic
3495 rules, you might want to place table captions always above the table).
3496 You can also use the class option
3513 You need at least Koma-Script version 2.8q to use this.
3516 \begin_layout Itemize
3521 : can be used to set a bonmot, e.
3522 \begin_inset space \thinspace{}
3526 \begin_inset space \space{}
3529 at the beginning of a chapter.
3530 If you use the optional argument (
3532 Insert\SpecialChar menuseparator
3534 \begin_inset space ~
3539 ), you can insert the dictum's author there.
3540 Dictum and author are separated by a line.
3541 You need at least Koma-Script version 2.8q to use this.
3548 article (koma-script)
3553 \begin_layout Standard
3554 The following types, together with the standard types
3566 , form the title area of the document.
3567 They must be entered ahead of the first
3568 \begin_inset Quotes eld
3572 \begin_inset Quotes erd
3579 \begin_layout Plain Layout
3580 The corresponding \SpecialChar LaTeX
3581 commands must appear before the
3592 When such a type is used more than once, the latter usage overwrites the
3593 former one, that means, for every type only the latest usage is valid.
3594 The order of the different types however has, like
3606 , no effect on the appearance of the produced document.
3609 \begin_layout Itemize
3614 : produces a centered paragraph above the ordinary title (
3626 ) for the subject of the document.
3629 \begin_layout Itemize
3634 : produces a centered paragraph below the ordinary title (
3646 ) for the publishers' name.
3649 \begin_layout Itemize
3656 report (koma-script)
3662 produces a centered paragraph on its own page behind the title page, or
3665 article (koma-script)
3667 produces a centered paragraph below the ordinary title (
3686 \begin_layout Itemize
3691 : produces a left aligned paragraph above the ordinary title (
3707 ) for a document`s head.
3710 \begin_layout Itemize
3715 : produces in a double-sided print in
3717 report (koma-script)
3723 a left-aligned paragraph at the top of the title page`s back or has no
3724 effect in a single-sided print or in
3726 article (koma-script)
3731 \begin_layout Itemize
3736 : produces in a double-sided print in
3738 report (koma-script)
3744 a left-aligned paragraph at the bottom of the title page`s back or has
3745 no effect in a single-sided print or in
3747 article (koma-script)
3752 \begin_layout Itemize
3757 : produces a special
3758 \begin_inset Quotes eld
3762 \begin_inset Quotes erd
3765 page ahead of the actual document containing a paragraph without special
3769 \begin_layout Standard
3770 The layout files for the document classes
3772 article (koma-script)
3776 report (koma-script)
3787 This is thought of as a place to define your own types.
3792 in your personal layout directory and edit the file!
3795 \begin_layout Subsubsection
3796 letter (koma-script)
3799 \begin_layout Description
3800 Note: This section discusses the obsolete
3802 KOMA-Script-Letter (v.
3803 \begin_inset space ~
3808 , which is not even included anymore in recent KOMA releases.
3809 Please refer to the next section for the current KOMA-Script-Letter class
3811 \begin_inset space ~
3817 \begin_layout Standard
3821 letter (koma-script)
3823 is implemented in the layout file
3828 It contains all the paragraph types of the corresponding standard document
3833 , partly modified, with the exception of the \SpecialChar LyX
3847 type, which is replaced by the new
3852 In addition, it contains, in contrast to the standard document class, the
3871 Furthermore, there are a number of new letter specific types.
3874 \begin_layout Standard
3875 The appearance of the letter produced by this document class can be controlled
3876 by a number of \SpecialChar LaTeX
3877 commands, which you can put in the \SpecialChar LaTeX
3882 \begin_layout Plain Layout
3883 For example, the standard appearance of the letter`s heading, consisting
3884 of name and address, is quite self-willed.
3886 \begin_inset Quotes eld
3890 \begin_inset Quotes erd
3893 heading is produced by the following \SpecialChar LaTeX
3894 commands in the preamble:
3897 \begin_layout LyX-Code
3907 \begin_layout LyX-Code
3923 \begin_layout LyX-Code
3933 \begin_layout LyX-Code
3953 A detailed German description of such \SpecialChar LaTeX
3954 commands can be found in the Koma-Script
3960 With it, the letter's author can produce his personal letter layout.
3963 \begin_layout Standard
3972 define the beginning of the letter and must be used in every letter.
3973 To emphasize them in the \SpecialChar LyX
3974 document class, they are marked with the letter
3984 \begin_inset space ~
3988 It is possible to write any number of letters in one file.
3993 type produces a new letter using the same addressee and a
3997 type produces a new addressee.
4014 are ordinary paragraph types and can also be used several times in one
4015 and the same letter.
4018 \begin_layout Itemize
4023 : produces a paragraph for the addressee and implicitly defines the beginning
4027 \begin_layout Itemize
4032 : produces a paragraph for the form of address and implicitly produces a
4036 \begin_layout Itemize
4041 : produces a paragraph for a close.
4044 \begin_layout Itemize
4049 : produces a paragraph for a postscript.
4052 \begin_layout Itemize
4057 : produces a paragraph for a distribution list.
4060 \begin_layout Itemize
4065 : produces a paragraph for enclosures.
4068 \begin_layout Standard
4109 are input types provided with a label to enter information, which will
4110 be processed by the document class.
4114 \begin_layout Plain Layout
4115 It could be seen as a matter of inconsequence, that the types
4123 described above are not such input types as well.
4124 Because of the special meaning of those types, however, I have implemented
4125 them as ordinary paragraph types with a one letter mark in the left margin.
4126 Moreover, it would affect my feeling of symmetry, if the
4134 type had such a serious different appearance.
4139 The types must be used ahead of the corresponding
4146 \begin_layout Standard
4147 An implementation of these types in a WYSIWYG fashion does not seem to make
4148 sense, because the real appearance of the produced letter does not only
4149 depend on the usage of the particular type, but also on other factors.
4150 For example, a signature entered in the
4154 type will in the standard behavior appear in the produced letter only,
4155 when in the same letter also a
4160 The entered value of the
4164 type will in the standard behavior not appear in the produced letter at
4166 The possibility to design the letter`s heading freely is already indicated
4167 in a footnote above.
4170 \begin_layout Standard
4171 The input types can also be used as empty paragraphs.
4173 \begin_inset space \thinspace{}
4177 \begin_inset space \space{}
4189 type is not used at all, in the standard behavior the value of the
4193 type is used as signature, whereas if an empty
4197 type is used, no signature value is defined.
4200 \begin_layout Standard
4201 By using the input types it is possible to write a letter template, containing
4202 filled input types with your personal dates (name, address, etc.) and empty
4203 input types for other dates you want to enter.
4206 \begin_layout Itemize
4211 : sender's name, in the standard behavior appears as a centered paragraph
4212 in small caps in the letter`s heading.
4215 \begin_layout Itemize
4220 : sender's signature, in the standard behavior appears below the
4229 type is used, the value of the
4233 type appears instead.
4236 \begin_layout Itemize
4241 : sender's address, in the standard behavior appears in a centered paragraph
4242 in the letter`s heading below the sender's name.
4245 \begin_layout Itemize
4250 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4261 \begin_layout Itemize
4266 : place of the letter`s making.
4269 \begin_layout Itemize
4274 : date of the letter`s making.
4283 , in the standard behavior, produce the place and the date in a right-aligned
4284 line below the addressee's field.
4289 type is used, neither place nor date appear, independent of the value of
4299 type is used, the date of the letter `s production is used.
4302 \begin_layout Itemize
4307 : sender`s back address, in the standard behavior appears above the addressee's
4308 field in a small sans serif font.
4311 \begin_layout Itemize
4316 : special mail information, in the standard behavior appears underlined
4317 above the addressee's field below the back address.
4320 \begin_layout Itemize
4325 : additional information, in the standard behavior appears on right side
4326 below the addressee`s field.
4329 \begin_layout Itemize
4334 : the letter's title, in the standard behavior appears in a big, bold, sans
4335 serif font above the subject.
4338 \begin_layout Itemize
4343 : the letter's subject, in the standard behavior appears in a bold font
4351 \begin_layout Standard
4372 produce a business letter like line above the
4376 line containing the fields
4377 \begin_inset Quotes eld
4381 \begin_inset Quotes erd
4385 \begin_inset Quotes eld
4389 \begin_inset Quotes erd
4393 \begin_inset Quotes eld
4397 \begin_inset Quotes erd
4401 \begin_inset Quotes eld
4405 \begin_inset Quotes erd
4409 \begin_inset Quotes eld
4413 \begin_inset Quotes erd
4417 \begin_inset Quotes eld
4421 \begin_inset Quotes erd
4425 For the date field, the value of the
4431 \begin_inset Quotes eld
4434 business letter types
4435 \begin_inset Quotes erd
4438 is used, the value of the
4442 type however does not appear, but only the \SpecialChar LaTeX
4450 The ordinary output of place and date in a right-aligned line below the
4451 addressee`s field is suppressed.
4452 The types are implemented as input types provided with a label and must
4453 be used ahead of the corresponding
4460 \begin_layout Itemize
4468 \begin_layout Itemize
4476 \begin_layout Itemize
4484 \begin_layout Itemize
4492 \begin_layout Itemize
4500 \begin_layout Subsubsection
4501 The new letter class: letter (koma-script v.2)
4504 \begin_layout Standard
4510 \begin_layout Standard
4511 \begin_inset VSpace medskip
4517 \begin_layout Standard
4519 Koma-Script version 2.8 has introduced a new letter class
4523 which supersedes the now unsupported
4528 It has — on the \SpecialChar LaTeX
4529 side — a completely new interface and is not compatible
4531 Therefore, \SpecialChar LyX
4532 supports both, though it is recommended you use the new class.
4535 \begin_layout Standard
4536 This class covers the same functionality as
4538 letter (koma-script),
4545 (receiver's address, same as
4562 will start a new letter (i.
4563 \begin_inset space \thinspace{}
4567 \begin_inset space \space{}
4570 you can write several letters per document).
4571 New elements are sender's
4587 and the possibility to use a
4593 Insert\SpecialChar menuseparator
4599 \begin_layout Standard
4600 The biggest improvement is, though, that the letter's layout is configurable
4601 to meet almost any needs.
4602 This can be done via the preamble or with a special style file (Letter
4603 Class Option, extension
4607 ), that will be read in as a class option.
4611 \begin_layout Plain Layout
4612 The KOMA package comes with some default
4617 There is, for instance, a
4621 file that follows german typesetting rules, or a
4625 that provides the default layout of the old
4630 The latter can be loaded with the class option
4636 Layout\SpecialChar menuseparator
4637 Document\SpecialChar menuseparator
4649 template that is included in \SpecialChar LyX
4651 A detailed description is to be found in the Koma-Script documentation
4659 \begin_layout Subsubsection
4663 \begin_layout Standard
4664 Visualizing the Koma-Script document classes in \SpecialChar LyX
4665 , the \SpecialChar LyX
4666 internals cause some
4670 \begin_layout Itemize
4671 The chapter number of a
4675 type appears on a line of its own above the chapter heading instead of
4676 appearing in the same line ahead of it.
4677 The cause for that is the \SpecialChar LyX
4678 internal behavior for the labeltype
4685 \begin_layout Itemize
4686 The headings of the types
4695 \begin_inset Quotes eld
4699 \begin_inset Quotes erd
4703 table of contents, but not in the \SpecialChar LyX
4706 Document\SpecialChar menuseparator
4708 \begin_inset space ~
4712 \begin_inset space ~
4720 \begin_layout Itemize
4725 document class appear in a skip separation mode, not indented.
4726 This is the standard behavior, no special \SpecialChar LaTeX
4727 commands are needed for that.
4730 Document\SpecialChar menuseparator
4733 dialog the corresponding radio button indicates
4742 value always has the effect that extra \SpecialChar LaTeX
4743 commands are inserted in the document
4744 to produce the gap, which is not what is wanted in this case.
4747 \begin_layout Subsection
4749 \change_inserted 564990737 1670924924
4751 \begin_inset space \thinspace{}
4755 \begin_inset space \space{}
4759 \change_deleted 564990737 1670924933
4760 Article (mwart), book (mwbk) and report (mwrep)
4761 \begin_inset Argument status
4764 \begin_layout Plain Layout
4779 \begin_layout Standard
4785 \begin_layout Standard
4786 The \SpecialChar LyX
4803 correspond to the \SpecialChar LaTeX
4817 They are replacements for the standard document classes
4829 , resp., and fit better to Polish typography conventions in a number of points.
4833 \begin_layout Standard
4837 \begin_layout Itemize
4838 Unnumbered titles (with star, e.
4839 \begin_inset space \thinspace{}
4843 \begin_inset space \space{}
4850 ) are added into table of contents,
4853 \begin_layout Itemize
4854 Additional page styles:
4858 \begin_layout Description
4859 uheadings header with separated lines,
4862 \begin_layout Description
4863 myheadings custom header, contents headers via commands:
4878 \begin_layout Description
4879 myuheadings custom header with separated lines,
4882 \begin_layout Description
4883 outer page number is placed on outer side of page
4887 \begin_layout Itemize
4892 \begin_layout Description
4893 rmheadings serif titles — default,
4896 \begin_layout Description
4897 sfheadings sansserif titles,
4900 \begin_layout Description
4901 authortitle on title page first placed is author next title — default,
4904 \begin_layout Description
4905 titleauthor on title page first placed is title next author,
4908 \begin_layout Description
4909 withmarginpar reserve place on page for margins.
4913 \begin_layout Section
4915 \change_inserted 564990737 1670439534
4919 \begin_layout Standard
4921 \change_inserted 564990737 1670794710
4922 See also the document classes in the Collections (section
4923 \begin_inset space ~
4927 \begin_inset CommandInset ref
4929 reference "sec:Collections"
4936 \begin_layout Subsection
4938 \change_inserted 564990737 1670794716
4944 \begin_layout Standard
4946 \change_inserted 564990737 1670794716
4953 ; updated by the \SpecialChar LyX
4957 \begin_layout Subsubsection
4959 \change_inserted 564990737 1670794716
4965 \begin_layout Standard
4967 \change_inserted 564990737 1670794716
4970 This section describes how \SpecialChar LyX
4971 can be used to write articles for submission
4972 to the scientific journal
4974 Astronomy and Astrophysics
4977 \begin_inset CommandInset href
4980 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
4985 ) using Version 9.1 of the document class
4989 ; information about it is available at
4990 \begin_inset Flex URL
4993 \begin_layout Plain Layout
4995 \change_inserted 564990737 1670794716
4997 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
5007 \begin_layout Standard
5009 \change_inserted 564990737 1670794716
5012 A manual comes together with the package and should be consulted before
5013 installing this document class as described in the
5015 Installing New Document Classe
5025 \begin_layout Standard
5027 \change_inserted 564990737 1670794716
5030 \begin_inset Note Greyedout
5033 \begin_layout Plain Layout
5035 \change_inserted 564990737 1670794716
5038 Please note that the publisher of the journal was changed from Springer
5039 to EDP Sciences starting January 1, 2001.
5040 That change also involved some slight changes to the style files, namely
5041 the removal of the thesaurus command.
5042 If you have an older version installed, please upgrade.
5043 For information about compatibility with the old (version 4) layout, please
5044 refer to the comments in
5047 Dir/layouts/aapaper.layout
5057 \begin_layout Subsubsection
5059 \change_inserted 564990737 1670794716
5065 \begin_layout Standard
5067 \change_inserted 564990737 1670794716
5070 It is recommended you start from the template
5079 ile\SpecialChar menuseparator
5081 \begin_inset space ~
5089 \begin_inset space ~
5095 If you are not using the template, note the following settings:
5098 \begin_layout Itemize
5100 \change_inserted 564990737 1670794716
5112 ocument\SpecialChar menuseparator
5117 ettings\SpecialChar menuseparator
5119 \begin_inset space ~
5124 dialog (OK, that one was obvious).
5127 \begin_layout Itemize
5129 \change_inserted 564990737 1670794716
5135 \begin_inset space ~
5147 \begin_inset space ~
5152 dialog: leave it set to
5157 The whole layout is done by the macros, you shouldn't change anything.
5160 \begin_layout Subsubsection
5162 \change_inserted 564990737 1670794716
5168 \begin_layout Standard
5170 \change_inserted 564990737 1670794716
5173 First thing to enter is the header information.
5174 It consists of five entries, of which one is optional.
5178 \begin_layout Itemize
5180 \change_inserted 564990737 1670794716
5189 \begin_layout Itemize
5191 \change_inserted 564990737 1670794716
5200 \begin_layout Itemize
5202 \change_inserted 564990737 1670794716
5211 \begin_layout Itemize
5213 \change_inserted 564990737 1670794716
5222 \begin_layout Itemize
5224 \change_inserted 564990737 1670794716
5233 Received: <date>; Accepted <date>
5236 \begin_layout Standard
5238 \change_inserted 564990737 1670794716
5241 Although the order of the single header entries doesn't matter it is advised
5242 to keep the above sequence, just to get the best optics and meets the layout
5243 of the real document.
5246 \begin_layout Standard
5248 \change_inserted 564990737 1670794716
5251 If you want to place footnotes in the header block, e.
5252 \begin_inset space \thinspace{}
5256 \begin_inset space \space{}
5259 to state your present address, just use the standard footnote via the menu
5265 nsert\SpecialChar menuseparator
5274 will automagically use the term
5283 \begin_layout Standard
5285 \change_inserted 564990737 1670794716
5288 In addition to these topics, the macros use three additional \SpecialChar LaTeX
5290 have no counterpart in \SpecialChar LyX
5294 \begin_layout Itemize
5296 \change_inserted 564990737 1670794716
5304 to separate different names for more than one author and institute, respectivel
5308 \begin_layout Itemize
5310 \change_inserted 564990737 1670794716
5318 to mark corresponding author/institute pairs.
5319 The institutes are numbered sequentially as they appear in the
5323 field, so you have to put a marker to each author.
5326 \begin_layout Itemize
5328 \change_inserted 564990737 1670794716
5336 to supply an email address for fast contact.
5339 \begin_layout Standard
5341 \change_inserted 564990737 1670794716
5344 In all cases, the appropriate command has to be entered as \SpecialChar TeX
5345 code in \SpecialChar LyX
5347 See the examples in the template and in the file
5359 \begin_layout Subsubsection
5361 \change_inserted 564990737 1670794716
5367 \begin_layout Standard
5369 \change_inserted 564990737 1670794716
5372 The abstract should immediately follow the header block and must contain
5382 \begin_layout Enumerate
5384 \change_inserted 564990737 1670794716
5390 (optional) {} leave it empty if necessary
5393 \begin_layout Enumerate
5395 \change_inserted 564990737 1670794716
5404 \begin_layout Enumerate
5406 \change_inserted 564990737 1670794716
5415 \begin_layout Enumerate
5417 \change_inserted 564990737 1670794716
5426 \begin_layout Enumerate
5428 \change_inserted 564990737 1670794716
5434 (optional) {} leave it empty if necessary
5437 \begin_layout Standard
5439 \change_inserted 564990737 1670794716
5443 This structure not shown in
5450 \begin_layout Subsubsection
5452 \change_inserted 564990737 1670794716
5455 Supported environments
5458 \begin_layout Standard
5460 \change_inserted 564990737 1670794716
5463 The A&A paper layout supports the following environments for structuring
5467 \begin_layout Itemize
5469 \change_inserted 564990737 1670794716
5476 \begin_layout Itemize
5478 \change_inserted 564990737 1670794716
5485 \begin_layout Itemize
5487 \change_inserted 564990737 1670794716
5494 \begin_layout Itemize
5496 \change_inserted 564990737 1670794716
5503 \begin_layout Itemize
5505 \change_inserted 564990737 1670794716
5512 \begin_layout Itemize
5514 \change_inserted 564990737 1670794716
5521 \begin_layout Itemize
5523 \change_inserted 564990737 1670794716
5530 \begin_layout Itemize
5532 \change_inserted 564990737 1670794716
5539 \begin_layout Itemize
5541 \change_inserted 564990737 1670794716
5548 \begin_layout Itemize
5550 \change_inserted 564990737 1670794716
5557 \begin_layout Itemize
5559 \change_inserted 564990737 1670794716
5566 \begin_layout Itemize
5568 \change_inserted 564990737 1670794716
5576 \begin_layout Subsubsection
5578 \change_inserted 564990737 1670794716
5581 Commands not supported by \SpecialChar LyX
5585 \begin_layout Standard
5587 \change_inserted 564990737 1670794716
5590 Some commands are not yet supported by the
5594 layout for \SpecialChar LyX
5596 Some have already been mentioned.
5597 For the sake of completeness, they are listed all together here:
5600 \begin_layout Itemize
5602 \change_inserted 564990737 1670794716
5611 \begin_layout Itemize
5613 \change_inserted 564990737 1670794716
5622 \begin_layout Itemize
5624 \change_inserted 564990737 1670794716
5633 \begin_layout Itemize
5635 \change_inserted 564990737 1670794716
5644 \begin_layout Itemize
5646 \change_inserted 564990737 1670794716
5655 \begin_layout Standard
5657 \change_inserted 564990737 1670794716
5660 If you want to use any of these commands, you have to enter them yourself.
5663 Do not forget to use
5669 nsert\SpecialChar menuseparator
5672 \begin_inset space ~
5681 \begin_layout Subsubsection
5683 \change_inserted 564990737 1670794716
5686 Figure and Table Floats
5689 \begin_layout Standard
5691 \change_inserted 564990737 1670794716
5695 provides support for the necessary float environments
5697 figure, figure*, table
5703 , therefore we won't tell much about it here.
5707 \begin_inset space ~
5713 Just remember that tables should be left-aligned.
5714 For that, select the table and change the alignment in
5719 dit\SpecialChar menuseparator
5725 \begin_inset space ~
5731 \begin_layout Standard
5733 \change_inserted 564990737 1670794716
5736 There is only one special thing: the figures with a caption beside the figure.
5737 To create such a figure, you have to do the following:
5740 \begin_layout Enumerate
5742 \change_inserted 564990737 1670794716
5745 Create a wide figure float:
5750 nsert\SpecialChar menuseparator
5755 t\SpecialChar menuseparator
5758 , then, from within the float, use the menu
5763 dit\SpecialChar menuseparator
5769 \begin_inset space ~
5780 \begin_inset space ~
5792 \begin_layout Enumerate
5794 \change_inserted 564990737 1670794716
5797 Enter your caption text.
5800 \begin_layout Enumerate
5802 \change_inserted 564990737 1670794716
5809 to move the cursor above the caption.
5812 \begin_layout Enumerate
5814 \change_inserted 564990737 1670794716
5820 \begin_layout Enumerate
5822 \change_inserted 564990737 1670794716
5825 Position the cursor after the figure and insert a horizontal fill by using
5831 nsert\SpecialChar menuseparator
5836 rmatting\SpecialChar menuseparator
5842 \begin_inset space ~
5851 dialog and select the
5865 \begin_layout Enumerate
5867 \change_inserted 564990737 1670794716
5870 Switch to \SpecialChar LaTeX
5874 \begin_inset space ~
5882 \begin_layout Enumerate
5884 \change_inserted 564990737 1670794716
5895 Do not close the brace!
5898 \begin_layout Enumerate
5900 \change_inserted 564990737 1670794716
5903 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
5908 \begin_inset space ~
5920 \begin_layout Standard
5922 \change_inserted 564990737 1670794716
5925 Also, refer to the figures in the file
5936 \begin_layout Subsubsection
5938 \change_inserted 564990737 1670794716
5944 \begin_layout Standard
5946 \change_inserted 564990737 1670794716
5949 For submission, the paper has to be formatted in a special double-spacing
5951 For this purpose, you have to add the option
5962 \begin_inset space ~
5972 ocument\SpecialChar menuseparator
5977 ettings\SpecialChar menuseparator
5979 \begin_inset space ~
5988 \begin_layout Subsubsection
5990 \change_inserted 564990737 1670794716
5996 \begin_layout Standard
5998 \change_inserted 564990737 1670794716
6005 was written with \SpecialChar LyX
6007 It is the example paper from the original macro package,
6012 \begin_inset CommandInset href
6015 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6020 , but translated to \SpecialChar LyX
6021 using the older unstructured abstract type.
6022 Use it for inspiration, and compare the \SpecialChar LaTeX
6027 with the \SpecialChar LyX
6031 \begin_layout Subsection
6036 \begin_layout Standard
6042 \begin_layout Subsubsection
6046 \begin_layout Standard
6048 is a set of macros produced by the American Astronomical Society to
6049 facilitate electronic manuscript submission to the three journals they
6050 publish: the Astrophysical Journal (including the Letters and Supplement),
6051 the Astronomical Journal, and the Publications of the Astronomical Society
6054 has proven to be an excellent tool for generating these documents, especially
6055 given its equation, citation, and figure handling capabilities.
6057 requires version 5.0 (or higher) of these macros; preferably 6.0, which
6058 is the version described here, or higher.
6059 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
6060 2.09 and are fundamentally
6061 incompatible with \SpecialChar LyX
6063 The AAS\SpecialChar TeX
6064 package may be downloaded from the AAS\SpecialChar TeX
6068 \begin_layout Standard
6069 \begin_inset VSpace medskip
6075 \begin_layout Standard
6077 \begin_inset Flex URL
6080 \begin_layout Plain Layout
6082 https://aas.org/aastex/aastex-downloads
6090 \begin_layout Standard
6091 \begin_inset VSpace medskip
6097 \begin_layout Standard
6098 A complete user guide is contained in that package and you should familiarize
6099 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
6102 will not reduce the need to figure out all the AAS\SpecialChar TeX
6103 commands, it will only
6104 reduce the drudgery of typing everything in.
6105 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
6107 completely to the requirements of the journal to which you are submitting
6111 \begin_layout Subsubsection
6112 Starting a New Paper
6115 \begin_layout Standard
6116 I strongly suggest that you start with the AAS\SpecialChar TeX
6120 File\SpecialChar menuseparator
6127 , enter the new file name, then choose the
6132 This will show the most common fields found in a manuscript.
6133 Simply overwrite the existing text (including the brackets,
6137 ) with the correct information.
6138 Many of the AAS\SpecialChar TeX
6139 commands and environments can be implemented directly in
6142 For commands such as these, the \SpecialChar LaTeX
6143 code must be entered directly and marked
6145 Such commands are referred to as \SpecialChar TeX
6146 code, or Evil Red Text.
6147 I tried to minimize the amount of \SpecialChar TeX
6148 code needed in an AAS\SpecialChar TeX
6152 \begin_layout Subsubsection
6153 Finishing Your Paper
6156 \begin_layout Standard
6157 When the paper is finished to your satisfaction and previews/prints correctly,
6159 \begin_inset Quotes eld
6163 \begin_inset Quotes erd
6166 actions which need to be done before you submit it to the journals.
6170 \begin_layout Enumerate
6171 Export your paper as a \SpecialChar LaTeX
6174 File\SpecialChar menuseparator
6175 Export\SpecialChar menuseparator
6183 \begin_layout Enumerate
6188 file with your favorite text editor
6192 \begin_layout Enumerate
6193 remove the comment lines before the
6202 \begin_layout Enumerate
6207 usepackage...{fontenc}
6209 line if it appears (usually just after
6224 \begin_layout Enumerate
6225 remove everything between (and including) the
6237 commands, except for any commands you specifically put into the \SpecialChar LaTeX
6239 (which should appear immediately after the
6240 \begin_inset Quotes eld
6243 User specified \SpecialChar LaTeX
6245 \begin_inset Quotes erd
6256 \begin_layout Enumerate
6257 Run the resulting file through \SpecialChar LaTeX
6258 to make sure it still processes correctly.
6261 \begin_layout Enumerate
6262 Reread the journal requirements to make sure your filenames and formats
6266 \begin_layout Enumerate
6270 \begin_layout Subsubsection
6271 Comments On Specific Commands
6274 \begin_layout Standard
6275 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
6282 ) gives a good description of each.
6283 Thus it's probably easiest for me to go down the list as found in the guide
6284 and offer comments where necessary.
6285 So let's begin \SpecialChar ldots
6289 \begin_layout Paragraph
6290 Things that work as expected
6293 \begin_layout Standard
6294 Because they work as you might expect, I simply list them and the section
6395 begin{thebibliography}
6403 (2.13.2), all the cite commands and their variations (2.13.2), the generic
6404 graphicx figure commands (2.14.1),
6428 (2.15.4, amongst other places),
6455 \begin_layout Standard
6456 The following style options also work correctly:
6477 Simply put them in the
6483 Layout\SpecialChar menuseparator
6489 \begin_layout Paragraph
6490 Things that work, but require more comment
6493 \begin_layout Standard
6494 The following items work, but require a little more discussion:
6497 \begin_layout Itemize
6498 These items are reserved for use by the journal editors, but you can put
6499 them into the \SpecialChar LaTeX
6500 preamble if you feel compelled to do so:
6533 \begin_layout Itemize
6534 These items may be placed in the \SpecialChar LaTeX
6535 preamble, and are included as blanks in
6557 \begin_layout Itemize
6564 (2.3) – can only be used
6565 \begin_inset Quotes eld
6569 \begin_inset Quotes erd
6572 , not in the middle of a paragraph.
6573 Use \SpecialChar TeX
6574 code if you need to embed it.
6577 \begin_layout Itemize
6584 (2.3) – will have extra {} after it.
6585 This should not cause an error.
6588 \begin_layout Itemize
6595 (2.6) – can only be used
6596 \begin_inset Quotes eld
6600 \begin_inset Quotes erd
6603 , not in the middle of a paragraph.
6604 Use \SpecialChar TeX
6605 code if you need to embed it.
6608 \begin_layout Itemize
6615 (2.8) – can't insert a cross-reference tag, you must type the tag name by
6619 \begin_layout Itemize
6633 \begin_layout Itemize
6640 (2.9) – will have extra {} after it.
6641 This should not cause an error.
6644 \begin_layout Itemize
6651 (2.11) – will have extra {} after it.
6652 This should not cause an error.
6655 \begin_layout Itemize
6662 (2.14.2) – you can insert an optional filename argument by placing the cursor
6663 at the beginning of the text and selecting
6665 Insert\SpecialChar menuseparator
6670 \begin_inset Quotes eld
6674 \begin_inset Quotes erd
6677 inserts an optional argument of the type needed by
6684 Hopefully it will be renamed someday.
6687 \begin_layout Itemize
6700 for the catalog ID optional parameter
6703 \begin_layout Itemize
6716 for the catalog ID optional parameter
6719 \begin_layout Paragraph
6720 Things not implemented, use \SpecialChar TeX
6724 \begin_layout Standard
6735 setcounter{equation}
6737 (2.12), Journal name abbreviations (2.13.4),
6773 (2.15.4, insert it as the first element in the lefthand cell after where
6775 Don't use any of \SpecialChar LyX
6776 's rules in the table),
6788 (2.15.5), much of Misc (2.17, except
6839 \begin_layout Paragraph
6840 Things that cannot be implemented
6843 \begin_layout Standard
6845 at least in any meaningful sort of way, so I suggest ignoring them.
6846 They are the references environment (2.13.3), and the deluxetable environment
6848 If you really, really need to use deluxetable, I suggest editing it in
6849 a separate file with a text editor, then using
6851 Insert\SpecialChar menuseparator
6853 \begin_inset space ~
6858 to include it in your \SpecialChar LyX
6864 file to see an example of this.
6867 \begin_layout Subsubsection
6868 FAQs, Tips, Tricks, and Other Ruminations
6871 \begin_layout Paragraph
6872 Getting \SpecialChar LyX
6873 and AAS\SpecialChar TeX
6877 \begin_layout Standard
6878 It can be a bit tricky to get \SpecialChar LyX
6879 to recognize a new layout and document class.
6880 When all else fails, do this:
6883 \begin_layout Enumerate
6884 Make certain that \SpecialChar LaTeX
6885 can find AAS\SpecialChar TeX
6887 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
6889 directory completely unrelated to \SpecialChar LaTeX
6890 or AAS\SpecialChar TeX
6891 and run \SpecialChar LaTeX
6899 \begin_layout Enumerate
6904 appears in \SpecialChar LyX
6912 \begin_layout Enumerate
6915 Tools\SpecialChar menuseparator
6919 , then restart \SpecialChar LyX
6923 \begin_layout Enumerate
6924 Open a regular new file, not from a template.
6925 Does AAS\SpecialChar TeX
6926 appear in the class list in
6928 Document\SpecialChar menuseparator
6934 \begin_layout Standard
6935 If you get a warning from an existing AAS\SpecialChar TeX
6936 document about not being able
6937 to find the AAS\SpecialChar TeX
6938 layout or a message about
6939 \begin_inset Quotes eld
6942 You should not mix title layouts with normal ones
6943 \begin_inset Quotes erd
6946 , things haven't been installed correctly.
6949 \begin_layout Paragraph
6951 error processing a table
6954 \begin_layout Standard
6956 , by default, attempts to center the table caption/title.
6957 This seems to produce a bad interaction in AAS\SpecialChar TeX
6958 so you should click somewhere
6959 in the caption/title, then select
6961 Edit\SpecialChar menuseparator
6963 \begin_inset space ~
6977 This took care of it for me.
6980 \begin_layout Paragraph
6984 \begin_layout Standard
6985 A couple of things: 1) I have noticed some funny spacing in the reference
6986 entries in the text.
6987 When you enter the bibliography item data, make sure their is
6991 space between the last author and the parenthesis setting off the year;
6995 \begin_inset space \thinspace{}
6999 \begin_inset space \space{}
7013 2) Entering the references at all is not obvious.
7014 The easiest thing is to start typing your first reference at the end of
7015 the document, then mark it as type
7020 That will put a small gray box in front of what you just typed.
7021 Click on the box to fill in the rest of the information.
7022 For new references, go to the end of an existing reference and press return.
7023 That will create a new line with its own box, etc.
7026 \begin_layout Paragraph
7030 \begin_layout Standard
7031 Even though AAS\SpecialChar TeX
7032 provides its own figure commands (
7038 , for example), I much prefer \SpecialChar LaTeX
7039 's standard figure commands (with the default
7048 \begin_inset space ~
7051 commands as \SpecialChar TeX
7052 code into a Figure Float box if you desire, but I never have
7053 much luck getting the layout right.
7054 With the standard graphics, \SpecialChar LyX
7059 usepackage{graphicx}
7061 command into the \SpecialChar LaTeX
7062 preamble and handle the figures in the standard \SpecialChar LaTeX2e
7064 interspersing the figures in the text.
7065 I believe ApJ accepts figures exactly this way now; AJ might still use
7067 \begin_inset Quotes eld
7070 stack everything at the end
7071 \begin_inset Quotes erd
7077 \begin_layout Paragraph
7078 Things I could have done, but didn't
7081 \begin_layout Standard
7083 \begin_inset Quotes eld
7087 \begin_inset Quotes erd
7090 things I could have implemented, but chose not to.
7091 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
7093 even though it is double-spaced in the paper manuscript.
7094 Also, I chose not to make separate layouts for the preprint and preprint2
7096 Since I assume you will spend most of your time in the plain manuscript
7097 mode anyway, I decided not to chew up more disk space with this.
7101 \begin_layout Subsubsection
7105 \begin_layout Standard
7106 Your mileage may vary.
7107 I've now had papers published by both ApJ and AJ that have had 98% of the
7108 effort done in \SpecialChar LyX
7109 ; the last 2% was the \SpecialChar LaTeX
7110 post-processing and a few cleanups.
7111 I have had no trouble with the submission process, and I'm sure the journals
7112 were never aware that there might be a difference.
7113 So, go forth and publish!
7116 \begin_layout Subsection
7118 \change_inserted 564990737 1671442131
7124 \begin_layout Standard
7126 \change_inserted 564990737 1671442131
7132 \begin_inset space \thinspace{}
7141 document class together with the style
7145 to facilitate the description of chess games.
7161 \begin_layout Subsection
7163 \change_inserted 564990737 1671042028
7169 \begin_layout Standard
7171 \change_inserted 564990737 1671042028
7177 \begin_inset space \thinspace{}
7187 This provides the following additional environments:
7190 \begin_inset space ~
7198 \begin_inset space ~
7206 \begin_inset space ~
7229 is available in the menu
7234 ile\SpecialChar menuseparator
7236 \begin_inset space ~
7244 \begin_inset space ~
7250 It has been customized with further environments and contains all the informati
7252 However, the documentation is also available from
7253 \begin_inset CommandInset href
7256 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
7264 \begin_layout Subsection
7266 \change_inserted 564990737 1671042046
7272 \begin_layout Standard
7274 \change_inserted 564990737 1671042046
7280 \begin_inset space \thinspace{}
7285 provides an alternative to the
7290 It provides similar functionality, but you might prefer this layout with
7291 sans serif sections, headings, and more.
7294 \begin_layout Subsection
7299 \begin_layout Standard
7305 \begin_layout Standard
7306 \begin_inset VSpace bigskip
7312 \begin_layout Standard
7317 \begin_inset space ~
7322 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7324 \begin_inset Formula $\beta$
7327 release of May, 1999) class.
7330 \begin_layout Standard
7336 textclass, which works with Rev\SpecialChar TeX
7338 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7340 That means that it doesn't interact very well with \SpecialChar LyX
7341 , which requires \SpecialChar LaTeX2e
7343 it has been kludged to work.
7344 Since Rev\SpecialChar TeX
7345 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7352 \begin_inset space ~
7357 textclass should also be pretty easy to use.
7360 \begin_layout Standard
7361 These documents are supposed to be used in
7365 to the Rev\SpecialChar TeX
7366 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7368 and assume you'll know what to put in the preamble if necessary.
7371 \begin_layout Subsubsection
7375 \begin_layout Standard
7376 All you need to do is install Rev\SpecialChar TeX
7377 4, as described in the package's README
7379 The package can be found at The Rev\SpecialChar TeX
7381 \begin_inset Flex URL
7384 \begin_layout Plain Layout
7386 http://publish.aps.org/revtex4/
7392 Install it somewhere that \SpecialChar LaTeX
7394 Test it by trying to \SpecialChar LaTeX
7395 a short Rev\SpecialChar TeX
7396 4 document in some random directory (i.
7397 \begin_inset space \thinspace{}
7401 \begin_inset space \space{}
7404 not the directory where you installed the class file.) Then, if you reconfigure
7406 , it will find the class file and let you use the Rev\SpecialChar TeX
7410 \begin_layout Standard
7411 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7420 \begin_inset space ~
7425 template, found in the templates directory.
7428 \begin_layout Subsubsection
7432 \begin_layout Standard
7433 Optional arguments to
7440 \begin_inset Quotes eld
7444 \begin_inset Quotes erd
7448 \begin_inset Quotes eld
7452 \begin_inset Quotes erd
7458 \begin_inset space ~
7466 \begin_inset space ~
7472 Remember that in Rev\SpecialChar TeX
7473 , at least one optional argument is required!
7476 \begin_layout Standard
7477 Other preamble matter, like
7484 \begin_inset space ~
7491 \begin_inset space ~
7496 dialog, also as usual.
7499 \begin_layout Subsubsection
7503 \begin_layout Standard
7504 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7506 For example, the Email layout corresponds to
7513 Note that (at least as of Rev\SpecialChar TeX
7522 layouts are exactly equivalent, so you shouldn't need to use both.
7526 \begin_layout Plain Layout
7527 In case you're curious, both were included so that
7531 would be able to translate both
7551 \begin_layout Subsubsection
7555 \begin_layout Standard
7556 There are a couple of important unique aspects of Rev\SpecialChar TeX
7558 bugs that will be even more confusing in \SpecialChar LyX
7562 \begin_layout Standard
7563 In Rev\SpecialChar TeX
7581 The \SpecialChar LyX
7582 equivalent is that there is a separate Thanks layout.
7587 write footnotes in the
7591 layout, or weird things may happen.
7592 See the Rev\SpecialChar TeX
7593 4 documentation for more details.
7596 \begin_layout Standard
7600 \begin_inset space ~
7608 \begin_inset space ~
7617 layouts must be placed
7625 layout and the corresponding
7642 , the \SpecialChar LaTeX
7646 \begin_layout Subsection
7648 \change_inserted 564990737 1671042072
7654 \begin_layout Standard
7656 \change_inserted 564990737 1671042072
7663 classes were replaced in 2013 with a completely new
7668 This package provides a \SpecialChar LaTeX
7669 class and templates for books to be published
7670 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7671 Research, Springer VS Research, or Springer VS Forschung.
7672 The documentation is available in German from
7673 \begin_inset CommandInset href
7676 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7684 \begin_layout Section
7686 \change_inserted 564990737 1670439560
7690 \begin_layout Standard
7692 \change_inserted 564990737 1670439581
7693 See also the document classes in the Collections (section
7694 \begin_inset space ~
7698 \begin_inset CommandInset ref
7700 reference "sec:Collections"
7707 \begin_layout Subsection
7711 \begin_layout Standard
7717 \begin_layout Subsubsection
7721 \begin_layout Standard
7722 Memoir is a very powerful and constantly evolving class.
7723 It has been designed with regard to fictional and non-fictional literature.
7724 Its aim is to let the user have maximum control over the typesetting of
7726 Memoir is based on the standard book class, but it can also emulate the
7727 article class (see below).
7730 \begin_layout Standard
7731 Peter Wilson, the developer of Memoir, is known as the author of lots of
7732 useful packages in the \SpecialChar LaTeX
7734 Most of them have been merged with Memoir.
7735 Therefore, it is much easier to layout the table of contents, appendices,
7736 chapter designs and such.
7738 , though, does not support all of these goodies natively.
7739 Some of them might be added to forthcoming releases
7743 \begin_layout Plain Layout
7744 You are invited to send suggestions to
7745 \begin_inset Flex URL
7748 \begin_layout Plain Layout
7750 lyx-devel@lists.lyx.org
7760 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7762 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7764 commands (\SpecialChar TeX
7769 \begin_layout Plain Layout
7774 \begin_layout Plain Layout
7784 \begin_inset space ~
7788 \begin_inset CommandInset ref
7790 reference "sec:Inserting-TeX-Code"
7800 In this section, we can only list those features that are natively supported
7803 For detailed descriptions (and for the rest of features) we recommend you
7804 have a look at the detailed manual of the Memoir class
7808 \begin_layout Plain Layout
7813 \begin_layout Plain Layout
7823 \begin_inset Flex URL
7826 \begin_layout Plain Layout
7828 CTAN:/macros/latex/memoir/memman.pdf
7838 , which is not only a user guide for the class, but also both a comprehensive
7839 description on good typesetting and a superb example for good typesetting
7843 \begin_layout Subsubsection
7844 Basic features and restrictions
7847 \begin_layout Standard
7848 Memoir supports basically all features of the standard book classes.
7849 There are, however, some differences, as follows:
7852 \begin_layout Description
7854 \begin_inset space ~
7857 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7860 \begin_layout Description
7862 \begin_inset space ~
7865 style: The fancy page style is not supported, due to a command clash between
7866 Memoir and the fancyhdr package (they both define a command with the same
7867 name, which confuses \SpecialChar LaTeX
7869 Instead, Memoir comes with a number of its own page styles (see
7871 Document\SpecialChar menuseparator
7872 Settings\SpecialChar menuseparator
7874 \begin_inset space ~
7880 If you want to use these for the chapter pages, you have to use the command
7887 in the main text or in preamble (e.
7888 \begin_inset space \thinspace{}
7892 \begin_inset space \space{}
7899 chapterstyle{companion}
7904 \begin_layout Description
7905 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7906 optional argument in the standard classes.
7907 With this, you can specify an alternative version of the title for the
7908 table of contents and the headers (for instance, if the title is too long).
7910 , you can do this via
7912 Insert\SpecialChar menuseparator
7914 \begin_inset space ~
7919 at the beginning of a chapter/section.
7920 Memoir features a second optional argument and thus separates the table
7921 of contents from the header.
7922 You can define three variants of a title with this: one for the main text,
7923 one for the table of contents, and one for the headers.
7925 makes these available in form of specific
7936 \begin_layout Description
7937 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
7938 of contents, the list of figures and the list of table start a new page
7940 Memoir does not follow this route.
7941 You have to insert a page break yourself, if you want to have one.
7944 \begin_layout Description
7945 Titlepage: For some unknown reason, Memoir uses pagination on the title
7946 page (in the standard classes, title pages are
7947 \begin_inset Quotes eld
7951 \begin_inset Quotes erd
7955 If you want an empty title page, type
7959 aliaspagestyle{title}{empty}
7964 \begin_layout Description
7965 Article: With the class option
7971 Document\SpecialChar menuseparator
7972 Settings\SpecialChar menuseparator
7973 Class Settings\SpecialChar menuseparator
7975 \begin_inset space ~
7980 ), you can emulate article style.
7981 That is, counters (footnotes, figures, tables etc.) will not be reset on
7982 new chapters, chapters don't start a new page (but are—in contrary to
7983 \begin_inset Quotes eld
7987 \begin_inset Quotes erd
7990 article classes—still allowed), parts, though, use their own page, as in
7994 \begin_layout Description
7995 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
7996 font commands, which have been used in the old \SpecialChar LaTeX
7998 \begin_inset space \thinspace{}
8002 \begin_inset space \space{}
8018 It produces an error and stops \SpecialChar LaTeX
8019 whenever such a command appears.
8024 reallows the commands and spits out warnings instead (which does at least
8025 not stop \SpecialChar LaTeX
8027 Since a lot of packages and particularly Bib\SpecialChar TeX
8028 style files are still using
8029 those commands, we have decided to use this option by default.
8032 \begin_layout Subsubsection
8036 \begin_layout Standard
8037 We will only describe the features supported by \SpecialChar LyX
8038 (which is not much currently).
8039 Please consult the Memoir manual
8043 \begin_layout Plain Layout
8048 \begin_layout Plain Layout
8058 \begin_inset Flex URL
8061 \begin_layout Plain Layout
8063 CTAN:/macros/latex/memoir/memman.pdf
8076 \begin_layout Description
8077 Abstract: You may wonder why an abstract is an extra feature.
8078 Well, it is in book class.
8079 Usually books don't have abstracts.
8080 Memoir, however, has.
8081 You can use it wherever and how often you like.
8084 \begin_layout Description
8085 Chapterprecis: You may know this older typesetting style: The contents of
8086 a chapter are summarized below the title and also in the table of contents
8088 \begin_inset space \thinspace{}
8092 \begin_inset space \space{}
8097 Our hero arrives in Troia; he loses some friends; he finds others
8100 Chapterprecis does exactly this.
8101 It is therefore only sensible below a chapter.
8104 \begin_layout Description
8105 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
8106 The epigraph environment provides an elegant way of typesetting such a
8108 The motto itself (text) and its (optional) author (source) are divided
8110 The author (source) can be inserted via
8112 Insert\SpecialChar menuseparator
8119 \begin_layout Description
8120 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
8121 complex figurative poems).
8123 can only support a few of them.
8124 One is poemtitle, which is a centered title for poems, which will also
8125 be added to the table of contents (verse is the standard environment for
8127 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
8129 because they have to be nested inside regular verse environments, which
8130 is not possible with \SpecialChar LyX
8134 \begin_layout Description
8135 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
8138 \begin_layout Subsection
8140 \change_inserted 564990737 1671442175
8146 \begin_layout Standard
8148 \change_inserted 564990737 1671442175
8158 \begin_inset space \thinspace{}
8163 document class but adds two environments:
8166 \begin_layout Description
8168 \change_inserted 564990737 1671442175
8171 Recipe a numbered section environment at the
8175 level which generates a bold centered heading above a double horizontal
8179 \begin_layout Description
8181 \change_inserted 564990737 1671442175
8194 are what are being described and the environment ends with a horizontal
8198 \begin_layout Standard
8200 \change_inserted 564990737 1671442175
8211 directory illustrates its use.
8214 \begin_layout Standard
8216 \change_inserted 564990737 1671442175
8219 It is designed for typesetting one or two recipes per page, with dimensions
8221 \begin_inset Quotes qrd
8225 \begin_inset Quotes qrd
8229 The hyperlinked table of contents (ToC) and page numbers make browsing
8230 recipes convenient, and the pages can be joined together or printed 2 per
8231 page to normal letterpaper easily.
8232 The size was chosen to work in half-page 3-ring binder cover sheets, because
8233 un-laminated paper just doesn't last in the kitchen.
8236 \begin_layout Standard
8238 \change_inserted 564990737 1671442175
8241 The half-letter pages can be printed two per page using your printer driver,
8242 or bound together using
8244 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
8254 is the compiled version of your recipes.
8257 \begin_layout Section
8259 \change_inserted 564990737 1671442207
8263 \begin_layout Subsection
8265 \change_inserted 564990737 1671442208
8271 \begin_layout Standard
8273 \change_inserted 564990737 1671442208
8279 \begin_inset space \space{}
8283 \begin_inset space \thinspace{}
8292 document class, an unofficial implementation of the ‘Europass CV’ recommended
8293 by the European Commission in 2013.
8302 directory offers guidance on its use.
8303 Its documentation is available from
8304 \begin_inset CommandInset href
8307 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
8315 \begin_layout Subsection
8317 \change_inserted 564990737 1671442208
8323 \begin_layout Standard
8325 \change_inserted 564990737 1671442208
8331 \begin_inset space \space{}
8335 \begin_inset space \thinspace{}
8344 document class, an unofficial implementation of the “Europass CV” recommended
8345 by the European Commission in 2002.
8354 directory offers guidance on its use.
8355 Its documentation is available from
8356 \begin_inset CommandInset href
8359 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
8367 \begin_layout Subsection
8369 \change_inserted 564990737 1671442208
8375 \begin_layout Standard
8377 \change_inserted 564990737 1671442208
8383 \begin_inset space \space{}
8387 \begin_inset space \thinspace{}
8397 This allows the creation of customizable CVs.
8406 directory offers guidance on its use.
8407 Its documentation is available from
8408 \begin_inset CommandInset href
8411 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
8419 \begin_layout Subsection
8421 \change_inserted 564990737 1671442208
8427 \begin_layout Standard
8429 \change_inserted 564990737 1671442208
8435 \begin_inset space \space{}
8439 \begin_inset space \thinspace{}
8448 document class, originally developed for use with \SpecialChar LyX
8458 directory offers guidance on its use.
8459 Its documentation is available from
8460 \begin_inset CommandInset href
8463 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
8471 \begin_layout Section
8473 \change_inserted 564990737 1671041968
8477 \begin_layout Subsection
8479 \change_inserted 564990737 1671041970
8485 \begin_layout Standard
8487 \change_inserted 564990737 1671041970
8498 document class for writing letters according to the
8500 Deutsches Institut für Normung
8512 ile\SpecialChar menuseparator
8514 \begin_inset space ~
8522 \begin_inset space ~
8527 offers guidance on its use.
8528 The documentation is available from
8529 \begin_inset CommandInset href
8532 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8540 \begin_layout Section
8542 \change_inserted 564990737 1670439660
8546 \begin_layout Subsection
8549 Foil\SpecialChar TeX
8553 \begin_inset CommandInset label
8562 \begin_layout Standard
8568 \begin_layout Subsubsection
8572 \begin_layout Standard
8573 This section describes how to use \SpecialChar LyX
8574 to make slides for overhead projectors.
8575 There are two document classes that can do this: the default slides class
8578 Foil\SpecialChar TeX
8582 This section documents the latter.
8585 \begin_layout Standard
8586 I'm going to say this again, nice and clear, so that there's no misunderstanding
8590 \begin_layout Standard
8591 \begin_inset VSpace bigskip
8597 \begin_layout Standard
8601 This section documents the class
8602 \begin_inset Quotes eld
8610 \begin_inset Quotes erd
8618 \begin_layout Standard
8619 \begin_inset VSpace bigskip
8625 \begin_layout Standard
8626 If you're looking for the documentation for
8627 \begin_inset Quotes eld
8635 \begin_inset Quotes erd
8639 \begin_inset space ~
8643 \begin_inset CommandInset ref
8645 reference "sec:slitex"
8650 If your machine doesn't have the
8658 installed, you'll probably have to use the default
8662 class, which isn't quite as good as
8667 \begin_layout Standard
8672 class is designed for use with version
8673 \begin_inset space ~
8681 class file which is now an integral part of \SpecialChar LaTeX2e
8685 \begin_layout Subsubsection
8689 \begin_layout Standard
8690 Obviously, to use this document class, you need to select
8701 \begin_inset space ~
8707 There are some settings in the
8710 \begin_inset space ~
8715 dialog that you should know about that are specific to this class:
8718 \begin_layout Itemize
8719 Don't change the options
8730 \begin_inset space ~
8736 They're ignored by the
8743 \begin_layout Itemize
8744 The default font size is 20
8745 \begin_inset space \thinspace{}
8748 pt with the other options being 17
8749 \begin_inset space \thinspace{}
8753 \begin_inset space \thinspace{}
8757 \begin_inset space \thinspace{}
8763 \begin_layout Itemize
8772 but all math equations are still typeset in the usual roman font.
8775 \begin_layout Itemize
8778 Foil\SpecialChar TeX
8781 supports A4 and Letter paper sizes as well as a special size for working
8783 \begin_inset space \thinspace{}
8787 It doesn't support A5, B5, legal or executive paper sizes.
8790 \begin_layout Itemize
8791 Don't bother changing the
8795 settings because they are ignored anyway.
8796 All floats appear where they are defined in the text.
8799 \begin_layout Itemize
8804 setting behaves a bit differently for this class.
8807 Foil\SpecialChar TeX
8810 provides extensive footer and header capabilities including a user-defined
8813 \begin_inset space ~
8817 \begin_inset CommandInset ref
8819 reference "sec:foilfoot"
8824 The title page is treated differently to all other pages in the document
8833 has the logo centered at the bottom of the page (if one is defined).
8834 The possible page style choices and what they do are as follows:
8838 \begin_layout Labeling
8839 \labelwidthstring MMMMMMM
8846 The final output contains no page numbers, or other headers or footers
8847 (except footnotes of course).
8851 \begin_layout Labeling
8852 \labelwidthstring MMMMMMM
8859 The final output contains page numbers centered at the bottom of the page.
8860 No other headings or footers (other than footnotes).
8863 \begin_layout Labeling
8864 \labelwidthstring MMMMMMM
8869 Page numbers in lower right corner.
8870 Additional headers and footers are also shown.
8871 This is also the default.
8874 \begin_layout Labeling
8875 \labelwidthstring MMMMMMM
8880 Gives you access to the
8884 package although its use with
8886 Foil\SpecialChar TeX
8889 is discouraged by the writer of the
8891 Foil\SpecialChar TeX
8894 package because of some potential page layout clashes.
8898 \begin_layout Paragraph
8902 \begin_layout Standard
8903 The following options may be used in the extra class options in the
8905 Document\SpecialChar menuseparator
8911 \begin_layout Labeling
8912 \labelwidthstring MMMMMMx
8917 This sets up the page layout for 7.33
8918 \begin_inset space \thinspace{}
8922 \begin_inset space \thinspace{}
8925 in paper, which is about the same aspect ratio as a 35
8926 \begin_inset space \thinspace{}
8929 mm slide, making it a bit easier to work with this medium.
8932 \begin_layout Labeling
8933 \labelwidthstring MMMMMMx
8938 Places a rule across the page below the header on every page except the
8942 \begin_layout Labeling
8943 \labelwidthstring MMMMMMx
8948 Places a rule across the page above the footer on every page except the
8952 \begin_layout Labeling
8953 \labelwidthstring MMMMMMx
8958 This is automatically set each time you create a new
8965 Foil\SpecialChar TeX
8968 to use the dvips driver to rotate those pages that are set as landscape
8972 \begin_layout Labeling
8973 \labelwidthstring MMMMMMx
8978 Simply changes the page dimensions to those of a landscape page but doesn't
8980 Thus if you use this option you need to use an external program to rotate
8981 each page or feed your paper through your printer as landscape.
8982 Note that this option effectively reverses the roles of the
8990 environments (don't worry these are described in the next section).
8993 \begin_layout Labeling
8994 \labelwidthstring MMMMMMx
8999 Equation numbers on the left.
9002 \begin_layout Labeling
9003 \labelwidthstring MMMMMMx
9008 Flush-left equations.
9011 \begin_layout Subsubsection
9012 Supported Environments
9015 \begin_layout Standard
9016 Most of the environments commonly supported in other classes are also supported
9022 There are several additional environments provided by
9024 Foil\SpecialChar TeX
9027 as well as a couple added by \SpecialChar LyX
9029 The following environments are shared with other classes:
9032 \begin_layout Standard
9033 \begin_inset Flex Multiple Columns
9036 \begin_layout Itemize
9042 \begin_layout Itemize
9048 \begin_layout Itemize
9054 \begin_layout Itemize
9060 \begin_layout Itemize
9066 \begin_layout Itemize
9073 \begin_layout Itemize
9079 \begin_layout Itemize
9085 \begin_layout Itemize
9091 \begin_layout Itemize
9097 \begin_layout Itemize
9103 \begin_layout Itemize
9109 \begin_layout Itemize
9115 \begin_layout Itemize
9121 \begin_layout Itemize
9132 \begin_layout Standard
9133 That is, all the major environments apart from the sectioning environments.
9134 Since foils are essentially self-contained sections, with a title and body,
9137 Foil\SpecialChar TeX
9140 provides specific commands for starting new foils and these are:
9143 \begin_layout Itemize
9149 \begin_layout Itemize
9155 \begin_layout Standard
9157 also provides slightly modified versions of these two environments called:
9160 \begin_layout Itemize
9166 \begin_layout Itemize
9172 \begin_layout Standard
9173 and the differences will be explained in the next section.
9176 \begin_layout Standard
9177 Since foils are often used in presenting ideas or new theorems and such
9180 Foil\SpecialChar TeX
9183 also provides a comprehensive box of goodies for presenting them:
9186 \begin_layout Standard
9187 \begin_inset Flex Multiple Columns
9190 \begin_layout Itemize
9196 \begin_layout Itemize
9202 \begin_layout Itemize
9208 \begin_layout Itemize
9214 \begin_layout Itemize
9220 \begin_layout Itemize
9226 \begin_layout Itemize
9232 \begin_layout Itemize
9238 \begin_layout Itemize
9244 \begin_layout Itemize
9250 \begin_layout Itemize
9261 \begin_layout Standard
9262 The starred versions are unnumbered while the unstarred versions are numbered.
9263 There are also two list environments added by \SpecialChar LyX
9267 \begin_layout Itemize
9273 \begin_layout Itemize
9279 \begin_layout Standard
9282 Foil\SpecialChar TeX
9285 provides some powerful header and footer capabilities that are best set
9286 in the preamble although they may be set at any point in a document.
9287 If you want to change these settings in your document the best place to
9288 do so is at the very top of a foil, i.
9289 \begin_inset space \thinspace{}
9295 \begin_inset space \space{}
9300 straight after the foilhead.
9303 \begin_layout Standard
9304 For this purpose, the following command styles are provided [
9311 \begin_layout Standard
9312 \begin_inset Flex Multiple Columns
9315 \begin_layout Itemize
9319 \begin_inset space ~
9325 \begin_layout Itemize
9331 \begin_layout Itemize
9335 \begin_inset space ~
9341 \begin_layout Itemize
9345 \begin_inset space ~
9351 \begin_layout Itemize
9355 \begin_inset space ~
9362 \begin_layout Plain Layout
9363 \begin_inset space ~
9375 \begin_layout Standard
9376 There are also a few commands provided by
9378 Foil\SpecialChar TeX
9381 that aren't directly supported by \SpecialChar LyX
9382 but I'll tell you what they do and how
9383 to use them in section
9384 \begin_inset space ~
9388 \begin_inset CommandInset ref
9390 reference "sec:unsuppfoils"
9397 \begin_layout Subsubsection
9398 Building a Set of Foils
9401 \begin_layout Standard
9402 This section will give a simple introduction to using the different environments
9403 to build a set of foils.
9404 If you want to see an example set of foils, take a look at the
9408 file you find in \SpecialChar LyX
9416 \begin_layout Paragraph
9417 Give It a Title Page
9420 \begin_layout Standard
9421 Unlike other classes that provide
9441 creates the title on a page of its own.
9442 If you leave out the
9446 environment \SpecialChar LaTeX
9447 will substitute the current date (every time you regenerate
9451 \begin_layout Paragraph
9455 \begin_layout Standard
9456 As I mentioned earlier, there are four ways of starting a new foil.
9457 For portrait foils you should use
9466 The difference between these two environments is the amount of space between
9467 the title of the foil (the foilhead) and the body of the foil.
9470 \begin_layout Standard
9471 Landscape foils are generated using the
9480 Again the only difference is the spacing between foilhead and body.
9481 Both of the short versions have 0.5
9482 \begin_inset space ~
9485 inches less separation between the foilhead and the body.
9489 \begin_layout Standard
9490 One problem with the support for landscape foils is the requirement that
9495 driver to generate the PostScript output otherwise the foils won't be rotated.
9496 It is possible to get landscape foils even if you haven't got the
9500 driver provided you can feed your foils sideways through your printer ;-)
9503 \begin_layout Paragraph
9504 Theorems, Lemmas, Proofs and more
9507 \begin_layout Standard
9508 You can't have two of the same type of these environments directly following
9510 If you use a normal paragraph break, , you will just be extending the previous
9511 environment as if you had merged the two environments together.
9512 Rather than that, you need to insert a so-called separator.
9513 Please refer to the section entitled
9524 \begin_layout Paragraph
9528 \begin_layout Standard
9529 You get all the commonly supported list styles found in other classes as
9530 well as two new ones.
9531 I'll only describe the new ones here.
9532 If you want to find out more about the other list environments check out
9538 If you intend to use itemized lists you might also want to read about the
9542 \begin_inset space ~
9546 \begin_inset space ~
9551 dialog described above in section
9552 \begin_inset space ~
9556 \change_inserted 564990737 1671355684
9558 \begin_inset CommandInset ref
9560 reference "chap:bullets"
9565 \change_deleted 564990737 1671355684
9567 \begin_inset CommandInset ref
9569 reference "sec:bullet"
9578 \begin_layout Standard
9579 The two new list styles,
9587 , are designed to make it easier for you to create lists of do's and don'ts
9588 or right and wrong by providing dedicated environments that use a tick
9589 or a cross as the label of the list.
9590 These lists are in fact dedicated variants of the
9595 They do however require that you have the
9602 \begin_layout Paragraph
9606 \begin_layout Standard
9609 Foil\SpecialChar TeX
9612 redefines the floating tables and figures so that they appear exactly where
9613 they are in the text rather than pushing them to the top of the page or
9614 to some user specified location.
9615 In fact if you change the float placement settings they are simply ignored.
9618 \begin_layout Paragraph
9619 Page Headers and Footers
9620 \begin_inset CommandInset label
9629 \begin_layout Standard
9633 \begin_inset space ~
9642 are two commands used to control the left-footer text string.
9643 The first is meant to allow you to include a graphic logo on your foils
9645 \begin_inset Quotes eld
9650 Foil\SpecialChar TeX
9654 \begin_inset Quotes erd
9658 While the second is meant to provide a classification for the audience,
9662 \begin_inset space \thinspace{}
9668 \begin_inset space \space{}
9672 It is empty by default.
9675 \begin_layout Standard
9676 The remaining page corners can be filled by
9679 \begin_inset space ~
9684 (which defaults to page numbers),
9687 \begin_inset space ~
9695 \begin_inset space ~
9703 \begin_layout Subsubsection
9706 Foil\SpecialChar TeX
9710 \begin_inset CommandInset label
9712 name "sec:unsuppfoils"
9719 \begin_layout Standard
9720 All the commands mentioned below need to be set in a
9730 within another environment.
9733 \begin_layout Paragraph
9737 \begin_layout Standard
9738 All lengths are adjusted using the
9761 should be replaced by the name given to the length you want to change and
9766 is the length value.
9767 All lengths should be specified in units of length such as inches (
9779 ) or relative to some document or font-based length such as
9789 \begin_layout Standard
9790 It's possible to change the spacing between a foilhead and the body of the
9791 foil by adjusting the length specified by
9798 For example, to make
9803 \begin_inset space \space{}
9806 in closer to their bodies put the following in the preamble:
9812 foilheadskip}{-0.5in}
9815 \begin_layout Standard
9816 The spacings around floats can be adjusted by setting these lengths:
9819 \begin_layout Labeling
9820 \labelwidthstring MMMMMMMMMMM
9827 Separation between the text and the top of the float
9830 \begin_layout Labeling
9831 \labelwidthstring MMMMMMMMMMM
9838 Separation between the float and the caption
9841 \begin_layout Labeling
9842 \labelwidthstring MMMMMMMMMMM
9849 Separation between the caption and the following text
9852 \begin_layout Labeling
9853 \labelwidthstring MMMMMMMMMMM
9860 You can make the captions narrower than the surrounding text by adjusting
9862 Best done relative to
9871 \begin_layout Standard
9872 There are also several title page related lengths that you may find useful
9873 if you have a long title or several authors:
9876 \begin_layout Labeling
9877 \labelwidthstring MMMMMMMMMMM
9884 Separation from headers to
9889 \begin_layout Labeling
9890 \labelwidthstring MMMMMMMMMMM
9908 \begin_layout Labeling
9909 \labelwidthstring MMMMMMMMMMM
9923 \begin_layout Labeling
9924 \labelwidthstring MMMMMMMMMMM
9940 \begin_layout Labeling
9941 \labelwidthstring MMMMMMMMMMM
9957 \begin_layout Standard
9958 The last length related command affects all the list environments.
9969 a list environment then all the vertical spacing between the list items
9971 Note that this is a command not a length so it doesn't require
9977 like the stuff mentioned above.
9980 \begin_layout Paragraph
9984 \begin_layout Standard
9997 commands control whether the logo in the
10001 definition appear on a given page.
10008 in the preamble then none of the foils will have the logo on them.
10009 If you don't want the logo on a particular page place the
10015 directly after the foilhead of that page and the
10021 directly after the next foilhead.
10024 \begin_layout Standard
10025 If you decide to use the
10029 page style setting in the
10032 \begin_inset space ~
10037 dialog you should probably add
10047 to your preamble so headers and footers on landscape pages are correctly
10048 placed when rotated.
10049 This is due to some clashes between the page layouts provided by the
10060 \begin_layout Subsection
10063 Sli\SpecialChar TeX
10067 \begin_inset CommandInset label
10076 \begin_layout Standard
10084 \begin_layout Subsubsection
10088 \begin_layout Standard
10089 This section describes how to use \SpecialChar LyX
10090 to make slides for overhead projectors.
10091 There are two document classes that can do this: the default slides class
10094 Foil\SpecialChar TeX
10098 This section documents the former.
10101 \begin_layout Standard
10102 I'm going to say this again, nice and clear, so that there's no misunderstanding
10106 \begin_layout Standard
10107 \begin_inset VSpace bigskip
10113 \begin_layout Standard
10117 This section documents the class
10118 \begin_inset Quotes eld
10126 \begin_inset Quotes erd
10134 \begin_layout Standard
10135 \begin_inset VSpace bigskip
10141 \begin_layout Standard
10142 If you're looking for the documentation for
10143 \begin_inset Quotes eld
10148 slides (Foil\SpecialChar TeX
10152 \begin_inset Quotes erd
10155 , check out section
10156 \begin_inset space ~
10160 \begin_inset CommandInset ref
10162 reference "sec:foiltex"
10172 \begin_inset Quotes eld
10177 slides (Foil\SpecialChar TeX
10181 \begin_inset Quotes erd
10184 ] is actually somewhat better than the default
10192 \begin_layout Plain Layout
10194 or so I've been told repeatedly by its advocates.
10195 Having never used it, I have no idea if this claim is true or not.
10200 which this section documents.
10203 \begin_layout Standard
10204 This class is the \SpecialChar LaTeX2e
10205 improvement of the old
10207 Sli\SpecialChar TeX
10211 Every \SpecialChar LaTeX2e
10212 distribution includes this class [which I'll just refer to as
10213 \begin_inset Quotes eld
10221 \begin_inset Quotes erd
10224 from now on], so you're bound to have it.
10225 As I noted earlier, there are other classes, such as
10229 , which also produce slides for overhead projectors and do a better job
10231 However, there are some things which
10235 can do which the others can't, such as generate overlays.
10236 Read on to learn more!
10239 \begin_layout Subsubsection
10241 \begin_inset CommandInset label
10243 name "sec:slidesetup"
10250 \begin_layout Standard
10251 Obviously, to use this document class, you need to select
10252 \begin_inset Quotes eld
10260 \begin_inset Quotes erd
10263 from the class list in the
10265 Document\SpecialChar menuseparator
10269 There are some other special things you should know about this class:
10272 \begin_layout Itemize
10273 Don't bother changing the options
10278 They're not supported by the
10285 \begin_layout Itemize
10289 \begin_inset space ~
10294 behaves a bit differently for this class.
10295 The possible choices and what they do are as follows:
10299 \begin_layout Description
10304 The final output contains page numbers in the lower right corner.
10307 \begin_layout Description
10316 , but also prints out any time markers you've put in.
10317 This is the default.
10320 \begin_layout Description
10325 The final output contains no page numbers, time markers, or alignment markers.
10329 \begin_layout Itemize
10334 class has an extra option:
10340 \begin_inset Quotes eld
10348 \begin_inset Quotes erd
10351 in the extra class options.
10355 \begin_layout Standard
10356 Using this options allows you to add time markers to
10362 \begin_inset space ~
10366 \begin_inset CommandInset ref
10368 reference "sec:slideNote"
10376 \begin_layout Standard
10377 You can also use the template file
10378 \begin_inset Quotes eld
10386 \begin_inset Quotes erd
10389 to automatically set up a document to use the
10395 File\SpecialChar menuseparator
10397 \begin_inset space ~
10401 \begin_inset space ~
10406 to open your new document].
10407 The template file also contains some examples of the special paragraph
10408 environments used by this class.
10409 I'll describe those next.
10412 \begin_layout Subsubsection
10413 Paragraph Environments
10416 \begin_layout Paragraph
10417 Supported Environments
10420 \begin_layout Standard
10421 The first thing you'll notice when you start up a new
10425 document is the font size and type: it's the equivalent of the size
10426 \begin_inset Quotes eld
10434 \begin_inset Quotes erd
10440 \begin_inset space ~
10446 This is also what's used in the output.
10448 \begin_inset Quotes eld
10452 \begin_inset Quotes erd
10455 to remind you that this is a slide.
10456 Your final slides will use a larger font; ergo, you'll have less space.
10457 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10460 \begin_layout Standard
10461 The next thing that becomes obvious is the changes to the paragraph environment
10462 pull-down box [at the far-left end of the toolbar].
10463 Most of the paragraph environments you're used to seeing are missing.
10464 There are also five new ones.
10469 class itself only supports certain paragraph environments:
10472 \begin_layout Itemize
10478 \begin_layout Itemize
10484 \begin_layout Itemize
10490 \begin_layout Itemize
10496 \begin_layout Itemize
10502 \begin_layout Itemize
10508 \begin_layout Itemize
10514 \begin_layout Itemize
10520 \begin_layout Itemize
10526 \begin_layout Itemize
10533 \begin_layout Standard
10534 All of the other standard environments, including the section-heading environmen
10535 ts, aren't used in the
10542 \begin_layout Standard
10543 On the other hand, you'll notice the following new environments:
10546 \begin_layout Itemize
10552 \begin_layout Itemize
10558 \begin_layout Itemize
10564 \begin_layout Itemize
10570 \begin_layout Itemize
10576 \begin_layout Standard
10577 These five are kind of quirky, due to a
10578 \begin_inset Quotes eld
10582 \begin_inset Quotes erd
10585 in \SpecialChar LyX
10587 You see, \SpecialChar LyX
10588 doesn't permit you to nest any other paragraph environment into
10589 an empty environment.
10590 Now, that's fine and dandy, but it means that you wouldn't be able to start
10591 a slide with anything except plain text.
10592 To deal with this, I've performed a little
10593 \begin_inset Quotes eld
10598 \begin_inset Quotes erd
10604 \begin_layout Paragraph
10605 Quirks of the New Environments
10606 \begin_inset CommandInset label
10608 name "sec:slideQuirk"
10615 \begin_layout Standard
10616 All five of the new paragraph environments are somewhat quirky due to inherent
10617 limitiations in the current version of \SpecialChar LyX
10619 As I just mentioned, \SpecialChar LyX
10620 forbids environments that begin with another environment.
10621 To get around this, the
10625 environment isn't a paragraph environment as described in the
10633 \begin_layout Standard
10634 You should consider
10647 \begin_inset Quotes eld
10650 pseudo-environments.
10651 \begin_inset Quotes erd
10654 They look like a section heading or a
10655 \begin_inset Quotes eld
10663 \begin_inset Quotes erd
10666 but really begin a [and, if necessary, end the previous] paragraph environment.
10676 \begin_inset Quotes eld
10680 \begin_inset Quotes erd
10683 These two perform some action.
10686 \begin_layout Standard
10687 A common feature of all five environments,
10707 , is a rather long-ish label.
10708 The text following this label — ordinarily the contents of the paragraph
10709 environment — is utterly irrelevant for
10731 completely ignores it.
10732 In fact, you can leave these five environments completely empty.
10736 \begin_layout Standard
10741 to put any text after the rather long-ish label, you might want to.
10742 This could be a short description of the contents of the
10747 In that case, enter your descriptive comment and hit
10751 as you normally would.
10754 \begin_layout Standard
10755 If, on the other hand, you don't want to enter any descriptive text, you'll
10756 hit another \SpecialChar LyX
10759 , like nature, abhors a vacuum, and will not let you start a new paragraph
10760 environment until you put something in the old one.
10764 \begin_layout Itemize
10765 Start entering the text that will
10793 \begin_layout Itemize
10794 Now move to the beginning of that paragraph.
10798 \begin_layout Itemize
10807 \begin_layout Itemize
10808 Finally, change this new, empty paragraph to a
10832 \begin_layout Standard
10833 Some future version of \SpecialChar LyX
10834 will, hopefully, resolve this quirkiness\SpecialChar ldots
10838 \begin_layout Subsubsection
10839 Making a Presentation with
10852 \begin_layout Paragraph
10860 \begin_layout Standard
10861 If you're expecting this section to teach you how to actually make a presentatio
10862 n, you'll be sorely disappointed.
10863 Naturally, I'll describe all of the ways the
10867 class can assist you in preparing the materials for a presentation.
10868 Filling in the contents, however, is up to you.
10873 the \SpecialChar LyX
10877 \begin_layout Standard
10882 environment [in the manner described in section
10883 \begin_inset space ~
10887 \begin_inset CommandInset ref
10889 reference "sec:slideQuirk"
10893 ] tells \SpecialChar LyX
10894 to begin a new slide [duh].
10895 The label for this environment/
10896 \begin_inset Quotes erd
10900 \begin_inset Quotes erd
10904 \begin_inset Quotes eld
10908 \begin_inset Quotes erd
10911 in cool blue, followed by the label,
10912 \begin_inset Quotes eld
10916 \begin_inset Quotes erd
10920 Any text or paragraph environments that follow this one go on the new slide.
10924 \begin_layout Standard
10925 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
10927 (this can be specified in the
10932 In fact, you'll want to, once you finish entering the contents of one slide.
10933 If you've entered more text than can physically fit on a slide, the extra
10934 overflows onto a new slide.
10935 I don't recommend doing this, however, since the overflow slide won't have
10936 any page number on it.
10937 Furthermore, it may interfere with any
10941 you've made to accompany the oversized
10948 \begin_layout Standard
10957 environments work the same way as the
10962 They both create an
10963 \begin_inset Quotes eld
10967 \begin_inset Quotes erd
10970 followed by a label [
10971 \begin_inset Quotes eld
10975 \begin_inset Quotes erd
10979 \begin_inset Quotes eld
10983 \begin_inset Quotes erd
10987 The color is a stunning magenta instead of blue, and the
10988 \begin_inset Quotes eld
10992 \begin_inset Quotes erd
10995 will look different, in style and in length.
10996 The label fonts of all three also differ from one another.
10999 \begin_layout Standard
11004 , if the contents of a
11012 exceed the physical size of a slide or sheet of paper, the extra will overflow
11014 Again, you should avoid this.
11015 It defeats the whole purpose of
11026 \begin_layout Paragraph
11036 \begin_layout Standard
11041 is a slide that sits atop another slide.
11042 Perhaps you wish to discuss a figure on the main
11046 before displaying the text associated with it.
11047 One way to accomplish this is tape a flap of dark paper over the part of
11052 you want to display later.
11053 This method fails, however, if you wish to overlap one graph with another,
11055 You would then have to fumble while speaking to align the two separate,
11060 s to align the two graphs.
11065 environment in both cases makes life much easier.
11068 \begin_layout Standard
11073 receives the page number of its
11074 \begin_inset Quotes eld
11078 \begin_inset Quotes erd
11086 \begin_inset Quotes eld
11094 \begin_inset Quotes erd
11101 \begin_layout Plain Layout
11102 Presumably, mutliple
11107 \begin_inset Quotes eld
11115 \begin_inset Quotes erd
11119 \begin_inset Quotes eld
11127 \begin_inset Quotes erd
11131 \begin_inset Quotes eld
11139 \begin_inset Quotes erd
11143 \begin_inset space ~
11146 appended to the page number of the parent
11156 Clearly, you want the contents of both the
11164 to each fit on a single physical slide! You should probably consider an
11170 \begin_inset Quotes eld
11174 \begin_inset Quotes erd
11182 Indeed, the \SpecialChar LyX
11187 class provides a visual cue for this: the label at the start of an
11191 is shorter than that at the start of a
11196 Lastly, when you generate printable output, you'll find alignment markers
11197 in all four corners of both the
11201 page and its parent
11206 These will assist you in lining up the two physical slides.
11209 \begin_layout Standard
11210 The major problem in overlaying two slides is aligning the contents of the
11211 two transparencies.
11212 How much space should you leave for that graph on the second slide? Worse
11213 still, what if you want a graph and a sentence on second slide, but there
11214 is text on the main transparency that goes in between them? You could try
11215 and insert vertical space of the right size.
11216 The better way is to use
11227 \begin_layout Standard
11228 As their names imply,
11236 are two command-like paragraph environments that make all subsequent text
11237 invisible and visible, respectively.
11239 \begin_inset space ~
11243 \begin_inset CommandInset ref
11245 reference "sec:slideQuirk"
11249 that you don't place anything
11253 these two environments, however.
11258 , it inserts a centered, sky-blue label into the page reading
11259 \begin_inset Quotes eld
11262 <Invisible Text Follows>
11263 \begin_inset Quotes erd
11267 For paragraphs following this label, the parts of the
11275 ; it doesn't matter which] where they would be contain instead blank space.
11279 \begin_layout Standard
11284 , the corresponding centered label is
11285 \begin_inset Quotes eld
11288 <Visible Text Follows>
11289 \begin_inset Quotes erd
11293 Paragraphs following this label behave normally.
11294 Note that the beginning of a new
11306 automatically shuts off an
11311 It's therefore not necessary to use
11322 \begin_layout Standard
11323 By now, it should be obvious how to create overlay transparencies using
11324 the proper combination of
11343 \begin_layout Enumerate
11348 , including everything that will appear on it, whether on the main slide
11356 \begin_layout Enumerate
11357 Before each figure or paragraph that will appear only on the
11366 If necessary, insert a
11370 environment after the
11377 \begin_layout Enumerate
11382 immediately following the
11389 \begin_layout Enumerate
11390 Copy the contents of this
11401 \begin_layout Enumerate
11406 , change all of the
11417 \begin_layout Standard
11419 You've just made an
11426 \begin_layout Standard
11427 There's one problem with the way I've designed the \SpecialChar LyX
11432 class: you can't make text in the middle of a paragraph invisible, nor
11433 make text in the middle of an invisible paragraph visible again.
11434 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
11439 \begin_layout Plain Layout
11440 The commands of interest are:
11443 \begin_layout Itemize
11448 invisible \SpecialChar ldots
11452 \begin_layout Itemize
11457 visible \SpecialChar ldots
11461 \begin_layout Plain Layout
11463 and need to be marked as \SpecialChar TeX
11466 \begin_inset Quotes eld
11470 \begin_inset Quotes erd
11473 you wish to change goes in between the brackets [and after the
11486 If you don't know how to mark text as \SpecialChar TeX
11487 , see the appropriate section of
11500 \begin_layout Paragraph
11510 \begin_inset CommandInset label
11512 name "sec:slideNote"
11519 \begin_layout Standard
11528 is associated with a
11529 \begin_inset Quotes eld
11533 \begin_inset Quotes erd
11541 Here, too, the \SpecialChar LyX
11546 class provides visual cues.
11551 is shorter than that of a
11555 [yet longer than that of an
11559 ] and, like the label of an
11563 is shockingly magenta.
11564 Additionally, the printed
11568 has the page number of its
11569 \begin_inset Quotes eld
11573 \begin_inset Quotes erd
11581 \begin_inset Quotes eld
11589 \begin_inset Quotes erd
11593 \begin_inset Quotes eld
11601 \begin_inset Quotes erd
11605 \begin_inset Quotes eld
11613 \begin_inset Quotes erd
11617 You can have multiple
11621 s associated with a single
11633 , you'll probably want to break up long
11637 s so that they fit on a single sheet of paper.
11640 \begin_layout Standard
11645 is obvious: it contains anything additional you might want to say about
11651 It could also be used as a sheet of reminders for a particular
11656 In the case of the latter, you might want to make use of time markers.
11657 Currently, the \SpecialChar LyX
11663 \begin_inset Quotes eld
11667 \begin_inset Quotes erd
11670 support for time markers, a
11672 Sli\SpecialChar TeX
11676 So, you'll have to resort to using the \SpecialChar LaTeX
11680 \begin_layout Standard
11681 To use time markers, you'll need to specify the extra class option
11682 \begin_inset Quotes eld
11690 \begin_inset Quotes erd
11694 \begin_inset space ~
11698 \begin_inset CommandInset ref
11700 reference "sec:slidesetup"
11705 This option turns on timing marks, which will appear in the lower-left-hand
11711 To set what appears in the time marker, you use the \SpecialChar LaTeX
11713 \begin_inset Quotes eld
11723 \begin_inset Quotes erd
11727 \begin_inset Quotes eld
11737 \begin_inset Quotes erd
11741 The arguments of both commands are time measured in seconds.
11743 \begin_inset Quotes eld
11753 \begin_inset Quotes erd
11756 sets the time marker to a given time.
11758 \begin_inset Quotes eld
11768 \begin_inset Quotes erd
11771 increments the time marker by the specified amount.
11772 Using time markers and
11776 s in this fashion, you can remind yourself how much time to spend on a particula
11784 \begin_layout Standard
11785 There's one last feature to describe.
11786 Clearly, you'd like to print out all of your
11794 s on transparencies while printing all of your
11811 with which it is associated.
11812 What's a person to do?
11815 \begin_layout Standard
11816 Luckily, there are two \SpecialChar LaTeX
11817 commands that allow you to select what to print
11819 Both must be placed into the preamble of your document.
11821 \begin_inset Quotes eld
11833 \begin_inset Quotes erd
11836 will cause the output to contain only the
11845 Correspondingly, the command
11846 \begin_inset Quotes eld
11858 \begin_inset Quotes erd
11861 prevents the output of anything but
11866 I'd advise placing both commands in the preamble and initially comment
11868 You can then preview your entire presentation as you write.
11869 When you're done writing, you can then uncomment one of the two to select
11870 what you want to print.
11871 I like to uncomment
11872 \begin_inset Quotes eld
11884 \begin_inset Quotes erd
11887 , print to a file with
11888 \begin_inset Quotes eld
11896 \begin_inset Quotes erd
11899 in its name, comment it back out, then uncomment
11900 \begin_inset Quotes eld
11912 \begin_inset Quotes erd
11916 \begin_inset Quotes eld
11924 \begin_inset Quotes erd
11928 I can then send either file to a printer, loading transparencies or plain
11929 paper as appropriate.
11932 \begin_layout Standard
11933 You can also provide other arguments to the
11934 \begin_inset Quotes eld
11944 \begin_inset Quotes erd
11948 \begin_inset Quotes eld
11958 \begin_inset Quotes erd
11962 See a good \SpecialChar LaTeX
11966 \begin_layout Subsubsection
11971 Class Template File
11974 \begin_layout Standard
11975 I have also provided a template file,
11976 \begin_inset Quotes eld
11984 \begin_inset Quotes erd
11992 To use it, begin your new presentation with
11994 File\SpecialChar menuseparator
11996 \begin_inset space ~
12000 \begin_inset space ~
12006 Your new \SpecialChar LyX
12007 presentation file will contain an example
12028 additionally contain an example of the use of
12037 Lastly, the preamble will contain:
12040 \begin_layout LyX-Code
12041 % Uncomment to print out only slides and overlays
12044 \begin_layout LyX-Code
12048 \begin_layout LyX-Code
12054 \begin_inset Newline newline
12060 \begin_layout LyX-Code
12061 % Uncomment to print out only notes
12064 \begin_layout LyX-Code
12068 \begin_layout LyX-Code
12076 \begin_layout Standard
12077 One final thing: I created this class to support the \SpecialChar LaTeX2e
12079 \begin_inset Quotes eld
12084 Sli\SpecialChar TeX
12088 \begin_inset Quotes erd
12091 class, one of the built-in \SpecialChar LaTeX2e
12093 Neither I nor the rest of the \SpecialChar LyX
12094 Team endorse or oppose the use of this built-in
12096 It's here if you want it or need it.
12097 There exist other \SpecialChar LaTeX2e
12098 classes for creating presentations, such as the
12103 \begin_inset space ~
12107 \begin_inset CommandInset ref
12109 reference "sec:foiltex"
12114 \begin_inset Quotes eld
12122 \begin_inset Quotes erd
12125 package [present on some \SpecialChar TeX
12127 The latter is not yet supported under \SpecialChar LyX
12132 \begin_layout Plain Layout
12133 Perhaps you can take on the task\SpecialChar ldots
12139 I know nothing about these other classes.
12140 Try them out to see what sort of alternative they provide.
12143 \begin_layout Section
12145 \change_inserted 564990737 1670439661
12149 \begin_layout Subsection
12151 \change_inserted 564990737 1670439661
12155 \begin_layout Standard
12157 \change_inserted 564990737 1670439661
12166 document class for preparing reports.
12171 document class, this provides parts, chapters and sections but does not
12172 provide the paragraph styles needed for a book; like the
12176 document class, it provides the abstract paragraph style.
12177 In two-sided mode, it does not start a new chapter on the right hand page.
12180 \begin_layout Standard
12182 \change_inserted 564990737 1670439674
12187 document classes are described in the Collections (section
12188 \begin_inset space ~
12192 \begin_inset CommandInset ref
12194 reference "sec:Collections"
12201 \begin_layout Section
12203 \change_inserted 564990737 1670439674
12207 \begin_layout Subsection
12211 \begin_layout Standard
12217 \begin_layout Subsubsection
12221 \begin_layout Standard
12222 Broadway is for writing plays.
12223 The format is more decorative than Hollywood, and much less standardized.
12224 This format should be suitable for workshops.
12227 \begin_layout Subsubsection
12231 \begin_layout Standard
12232 The same as in Hollywood.
12235 \begin_layout Subsubsection
12239 \begin_layout Standard
12244 names as labels then cross-reference the label to insert the name.
12245 The cross-reference dialog will show the current cast of characters.
12248 \begin_layout Subsubsection
12249 Paper size and Margins
12252 \begin_layout Standard
12253 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12256 \begin_layout Subsubsection
12260 \begin_layout Standard
12261 The following environments are available.
12262 You can use broadway.bind to get the bind keys shown at the right.
12265 \begin_layout Itemize
12269 \begin_inset Newline newline
12274 You should not have to use this, but it is here for anything that does not
12278 \begin_layout Itemize
12282 \begin_inset space \hfill{}
12286 \begin_inset Newline newline
12291 Used to describe stage setting and the action.
12292 First use of speaker names in all CAPs.
12295 \begin_layout Itemize
12299 \begin_inset space \hfill{}
12303 \begin_inset Newline newline
12308 Automatically numbered.
12309 On screen it will be arabic, but will print as Roman.
12312 \begin_layout Itemize
12316 \begin_inset space \hfill{}
12320 \begin_inset Newline newline
12330 It is just centered text.
12333 \begin_layout Itemize
12337 \begin_inset space \hfill{}
12341 \begin_inset Newline newline
12346 Not automatically numbered.
12347 You supply the number.
12348 This is because I couldn't figure out how.
12351 \begin_layout Itemize
12355 \begin_inset space \hfill{}
12359 \begin_inset Newline newline
12364 A special case of Narrative to describe the setting and action as the curtain
12368 \begin_layout Itemize
12372 \begin_inset space \hfill{}
12376 \begin_inset Newline newline
12381 The speaker's (actor's) title, centered in all CAPS.
12384 \begin_layout Itemize
12388 \begin_inset space \hfill{}
12392 \begin_inset Newline newline
12397 Instructions to the speaker.
12398 The parentheses are automatically inserted.
12399 The ( will appear on screen, but both will be in the printed play.
12400 This environment is only used within
12407 \begin_layout Itemize
12411 \begin_inset space \hfill{}
12415 \begin_inset Newline newline
12420 What the Speaker says.
12423 \begin_layout Itemize
12427 \begin_inset space \hfill{}
12431 \begin_inset Newline newline
12436 The curtain comes down.
12439 \begin_layout Itemize
12443 \begin_inset space \hfill{}
12449 \begin_layout Itemize
12453 \begin_inset space \hfill{}
12459 \begin_layout Itemize
12463 \begin_inset space \hfill{}
12469 \begin_layout Standard
12473 \begin_layout Subsection
12474 Hollywood (Hollywood spec scripts)
12477 \begin_layout Standard
12483 \begin_layout Subsubsection
12487 \begin_layout Standard
12488 Getting the format of a Hollywood script right is a
12489 \begin_inset Quotes eld
12493 \begin_inset Quotes erd
12496 It is designed to make the readers focus on content and to be easy and
12497 familiar for the actors to read.
12498 Each page of a script should be one minute of film.
12499 Nothing goes in a script that you cannot see or hear on screen.
12500 The courier 12 pt font should be used throughout.
12504 \begin_layout Subsubsection
12508 \begin_layout Standard
12509 Speakers' lines should NEVER break in mid-sentence.
12510 If a speaker's lines continue over a page break, repeat the
12514 title followed by (Cont'd).
12517 \begin_layout Subsubsection
12521 \begin_layout Standard
12526 names as labels then cross-reference the label to insert the name.
12527 The cross-reference dialog will show the current cast of characters.
12528 You can use this to insert the speaker name in narratives also.
12531 \begin_layout Subsubsection
12532 Paper size and Margins
12535 \begin_layout Standard
12536 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12539 \begin_layout Subsubsection
12543 \begin_layout Standard
12544 The following environments are available.
12545 You can use hollywood.bind to get the bind keys shown at the right.
12548 \begin_layout Itemize
12552 \begin_inset Newline newline
12557 Used where nothing else works.
12561 \begin_layout Itemize
12567 \begin_inset space \hfill{}
12575 \begin_inset Newline newline
12578 Usually followed by something like
12579 \begin_inset Quotes eld
12582 on Sally waking up.
12583 \begin_inset Quotes erd
12589 \begin_layout Itemize
12593 \begin_inset space \hfill{}
12597 \begin_inset Newline newline
12602 Introduces a new INTERIOR camera set-up.
12603 Always followed by DAY or NIGHT, or something similar to define the lighting
12605 Everthing on this line in CAPS.
12608 \begin_layout Itemize
12612 \begin_inset space \hfill{}
12616 \begin_inset Newline newline
12621 Introduces a new EXTERIOR camera set-up.
12622 Everthing on this line in CAPS.
12625 \begin_layout Itemize
12629 \begin_inset space \hfill{}
12633 \begin_inset Newline newline
12638 The character speaking.
12641 \begin_layout Itemize
12645 \begin_inset space \hfill{}
12649 \begin_inset Newline newline
12654 Instructions to the speaker.
12655 The () are automatically inserted.
12658 \begin_layout Itemize
12662 \begin_inset space \hfill{}
12666 \begin_inset Newline newline
12678 \begin_layout Itemize
12682 \begin_inset space \hfill{}
12686 \begin_inset Newline newline
12691 Camera movement instruction.
12693 \begin_inset space \thinspace{}
12697 \begin_inset space \space{}
12703 \begin_layout Itemize
12707 \begin_inset space \hfill{}
12713 \begin_layout Itemize
12717 \begin_inset space \hfill{}
12723 \begin_layout Itemize
12727 \begin_inset space \hfill{}
12733 \begin_layout Itemize
12737 \begin_inset space \hfill{}
12743 \begin_layout Subsubsection
12747 \begin_layout Itemize
12751 \begin_layout Itemize
12755 \begin_layout Itemize
12757 \begin_inset space \thinspace{}
12764 \begin_layout Itemize
12769 \begin_layout Itemize
12770 PAN — camera movement
12773 \begin_layout Itemize
12774 INSERT — cut to close-up of
12777 \begin_layout Chapter
12779 \change_inserted 564990737 1671185876
12783 \begin_layout Section
12784 Multiple Text Columns
12787 \begin_layout Standard
12788 This feature is independent of the option
12790 Two-column document
12792 in the document settings under
12797 If you want to have 2
12798 \begin_inset space ~
12801 columns for the whole document, it is recommended to use the
12803 Two-column document
12806 For all other cases use this feature.
12809 \begin_layout Standard
12810 To use multiple text columns in your document, you have to load the module
12817 Document\SpecialChar menuseparator
12818 Settings\SpecialChar menuseparator
12821 ) and must have the \SpecialChar LaTeX
12823 \begin_inset Flex Code
12826 \begin_layout Plain Layout
12835 \begin_layout Standard
12836 Footnotes within multiple columns will be placed at the bottom of the page
12837 and not under each column.
12838 Within the different columns you can use everything, with the limitation
12839 that for floats you need to use the float option
12846 \begin_layout Subsection
12850 \begin_layout Standard
12851 If you want to have 2
12852 \begin_inset space ~
12855 columns in your text, insert a multicolumn inset via the menu
12857 Insert\SpecialChar menuseparator
12859 \begin_inset space ~
12862 Insets\SpecialChar menuseparator
12864 \begin_inset space ~
12869 where the columns should start.
12870 Write all text that should be printed in 2
12871 \begin_inset space ~
12874 columns into this inset.
12877 \begin_layout Standard
12878 Here is an example:
12881 \begin_layout Standard
12883 \begin_inset Flex Multiple Columns
12886 \begin_layout Plain Layout
12891 The Adventure of the Empty House
12894 \begin_inset Newline newline
12897 by Sir Arthur Conan Doyle
12900 \begin_layout Plain Layout
12903 It was in the spring of the year 1894 that all London was interested, and
12904 the fashionable world dismayed, by the murder of the Honourable Ronald
12905 Adair under most unusual and inexplicable circumstances.
12906 The public has already learned those particulars of the crime which came
12907 out in the police investigation, but a good deal was suppressed upon that
12908 occasion, since the case for the prosecution was so overwhelmingly strong
12909 that it was not necessary to bring forward all the facts.
12910 Only now, at the end of nearly ten years, am I allowed to supply those
12911 missing links which make up the whole of that remarkable chain.
12912 The crime was of interest in itself, but that interest was as nothing to
12913 me compared to the inconceivable sequel, which afforded me the greatest
12914 shock and surprise of any event in my adventurous life.
12915 Even now, after this long interval, I find myself thrilling as I think
12916 of it, and feeling once more that sudden flood of joy, amazement, and increduli
12917 ty which utterly submerged my mind.
12918 Let me say to that public, which has shown some interest in those glimpses
12919 which I have occasionally given them of the thoughts and actions of a very
12920 remarkable man, that they are not to blame me if I have not shared my knowledge
12921 with them, for I should have considered it my first duty to do so, had
12922 I not been barred by a positive prohibition from his own lips, which was
12923 only withdrawn upon the third of last month.
12931 \begin_layout Standard
12932 To get 3 or more columns, set the cursor into the multicolumn inset and
12935 Insert\SpecialChar menuseparator
12937 \begin_inset space ~
12941 \begin_inset space ~
12947 The number of the desired columns is written into that inset (for 3
12948 \begin_inset space ~
12952 \begin_inset Quotes eld
12956 \begin_inset Quotes erd
12960 \begin_inset Newline newline
12963 Here is an example with 3
12964 \begin_inset space ~
12970 \begin_layout Standard
12971 \begin_inset Flex Multiple Columns
12974 \begin_layout Plain Layout
12977 \begin_inset Argument 1
12980 \begin_layout Plain Layout
12987 It can be imagined that my close intimacy with Sherlock Holmes had interested
12988 me deeply in crime, and that after his disappearance I never failed to
12989 read with care the various problems which came before the public.
12990 And I even attempted, more than once, for my own private satisfaction,
12991 to employ his methods in their solution, though with indifferent success.
12992 There was none, however, which appealed to me like this tragedy of Ronald
12994 As I read the evidence at the inquest, which led up to a verdict of willful
12995 murder against some person or persons unknown, I realized more clearly
12996 than I had ever done the loss which the community had sustained by the
12997 death of Sherlock Holmes.
12998 There were points about this strange business which would, I was sure,
12999 have specially appealed to him, and the efforts of the police would have
13000 been supplemented, or more probably anticipated, by the trained observation
13001 and the alert mind of the first criminal agent in Europe.
13002 All day, as I drove upon my round, I turned over the case in my mind and
13003 found no explanation which appeared to me to be adequate.
13004 At the risk of telling a twice-told tale, I will recapitulate the facts
13005 as they were known to the public at the conclusion of the inquest.
13013 \begin_layout Standard
13014 You can have up to 10
13015 \begin_inset space ~
13018 columns if you want to, but that might not be very pleasant for the readers
13022 \begin_layout Standard
13023 \begin_inset Newpage newpage
13029 \begin_layout Subsection
13030 Columns inside Columns
13033 \begin_layout Standard
13034 You can also have columns inside columns:
13037 \begin_layout Standard
13038 \begin_inset Flex Multiple Columns
13041 \begin_layout Plain Layout
13044 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
13045 at that time governor of one of the Australian colonies.
13046 Adair's mother had returned from Australia to undergo the operation for
13047 cataract, and she, her son Ronald, and her daughter Hilda were living together
13051 \begin_layout Plain Layout
13052 \begin_inset Flex Multiple Columns
13055 \begin_layout Plain Layout
13058 The youth moved in the best society
13059 \begin_inset space ~
13062 – had, so far as was known, no enemies and no particular vices.
13063 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
13064 had been broken off by mutual consent some months before, and there was
13065 no sign that it had left any very profound feeling behind it.
13066 For the rest {sic} the man's life moved in a narrow and conventional circle,
13067 for his habits were quiet and his nature unemotional.
13068 Yet it was upon this easy-going young aristocrat that death came, in most
13069 strange and unexpected form, between the hours of ten and eleven-twenty
13070 on the night of March 30, 1894.
13078 \begin_layout Plain Layout
13081 Ronald Adair was fond of cards
13082 \begin_inset space ~
13085 – playing continually, but never for such stakes as would hurt him.
13086 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
13087 It was shown that, after dinner on the day of his death, he had played
13088 a rubber of whist at the latter club.
13089 He had also played there in the afternoon.
13094 The evidence of those who had played with him
13095 \begin_inset space ~
13099 Murray, Sir John Hardy, and Colonel Moran
13100 \begin_inset space ~
13103 – showed that the game was whist, and that there was a fairly equal fall
13105 Adair might have lost five pounds, but not more.
13106 His fortune was a considerable one, and such a loss could not in any way
13108 He had played nearly every day at one club or other, but he was a cautious
13109 player, and usually rose a winner.
13110 It came out in evidence that, in partnership with Colonel Moran, he had
13111 actually won as much as four hundred and twenty pounds in a sitting, some
13112 weeks before, from Godfrey Milner and Lord Balmoral.
13113 So much for his recent history as it came out at the inquest.
13121 \begin_layout Subsection
13125 \begin_layout Standard
13126 The examples in this section show some more special features of multiple
13130 \begin_layout Standard
13131 For more features of multiple columns, have a look at the
13132 \begin_inset CommandInset href
13134 name "documentation"
13135 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
13140 of the \SpecialChar LaTeX
13142 \begin_inset Flex Code
13145 \begin_layout Plain Layout
13154 \begin_layout Subsubsection
13158 \begin_layout Standard
13159 To add a preface text for multiple columns, set the cursor into the multicolumn
13160 inset and use the menu
13162 Insert\SpecialChar menuseparator
13166 Write your preface text into that inset.
13167 \begin_inset Newline newline
13170 This is an example with some preface text:
13173 \begin_layout Standard
13174 \begin_inset VSpace bigskip
13180 \begin_layout Standard
13181 \begin_inset Flex Multiple Columns
13184 \begin_layout Plain Layout
13185 \begin_inset Argument 2
13188 \begin_layout Plain Layout
13189 And the story continues and continues and continues and continues\SpecialChar ldots
13197 On the evening of the crime, he returned from the club exactly at ten.
13198 His mother and sister were out spending the evening with a relation.
13199 The servant deposed that she heard him enter the front room on the second
13200 floor, generally used as his sitting-room.
13201 She had lit a fire there, and as it smoked she had opened the window.
13202 No sound was heard from the room until eleven-twenty, the hour of the return
13203 of Lady Maynooth and her daughter.
13204 Desiring to say good-night, she attempted to enter her son's room.
13205 The door was locked on the inside, and no answer could be got to their
13206 cries and knocking.
13207 Help was obtained, and the door forced.
13208 The unfortunate young man was found lying near the table.
13209 His head had been horribly mutilated by an expanding revolver bullet, but
13210 no weapon of any sort was to be found in the room.
13218 \begin_layout Standard
13219 You can also use a section heading as the preface if you use a section command
13220 as \SpecialChar TeX
13222 For example the command
13225 \begin_layout LyX-Code
13228 subsection{subsection title}
13231 \begin_layout Standard
13232 creates a subsection.
13233 In this example the preface is a subsubsection:
13236 \begin_layout Standard
13237 \begin_inset Flex Multiple Columns
13240 \begin_layout Plain Layout
13241 \begin_inset Argument 2
13244 \begin_layout Plain Layout
13248 \begin_layout Plain Layout
13257 This is a subsubsection heading as a preface
13261 \begin_layout Plain Layout
13275 A minute examination of the circumstances served only to make the case more
13277 In the first place, no reason could be given why the young man should have
13278 fastened the door upon the inside.
13279 There was the possibility that the murderer had done this, and had afterwards
13280 escaped by the window.
13281 The drop was at least twenty feet, however, and a bed of crocuses in full
13283 Neither the flowers nor the earth showed any sign of having been disturbed,
13284 nor were there any marks upon the narrow strip of grass which separated
13285 the house from the road.
13286 Apparently, therefore, it was the young man himself who had fastened the
13288 But how did he come by his death? No one could have climbed up to the window
13289 without leaving traces.
13290 Suppose a man had fired through the window, he would indeed be a remarkable
13291 shot who could with a revolver inflict so deadly a wound.
13292 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
13293 a hundred yards of the house.
13294 No one had heard a shot.
13302 \begin_layout Standard
13303 If there is less vertical space than 6
13304 \begin_inset space ~
13307 text lines is left on the page at the beginning of the multiple columns,
13308 a page break will be inserted before the multiple columns.
13309 Depending on the number of lines of the preface text, you might want to
13311 This is done by setting the cursor into the mulitcolumn inset behind the
13312 preface (if there is any) and using the menu
13314 Insert\SpecialChar menuseparator
13316 \begin_inset space ~
13320 \begin_inset space ~
13324 \begin_inset space ~
13330 Insert into that inset the amount of space like e.
13331 \begin_inset space \thinspace{}
13335 \begin_inset space \space{}
13339 \begin_inset Quotes eld
13343 \begin_inset Quotes erd
13347 \begin_inset Newline newline
13350 In this example the space is set to 7
13351 \begin_inset space ~
13354 text lines by using
13355 \begin_inset Flex Code
13358 \begin_layout Plain Layout
13367 \begin_inset Flex Code
13370 \begin_layout Plain Layout
13378 needs to be inserted as \SpecialChar TeX
13382 \begin_layout Standard
13383 \begin_inset Flex Multiple Columns
13386 \begin_layout Plain Layout
13387 \begin_inset Argument 3
13390 \begin_layout Plain Layout
13395 \begin_layout Plain Layout
13411 On the evening of the crime, he returned from the club exactly at ten.
13412 His mother and sister were out spending the evening with a relation.
13413 The servant deposed that she heard him enter the front room on the second
13414 floor, generally used as his sitting-room.
13415 She had lit a fire there, and as it smoked she had opened the window.
13416 No sound was heard from the room until eleven-twenty, the hour of the return
13417 of Lady Maynooth and her daughter.
13418 Desiring to say good-night, she attempted to enter her son's room.
13419 The door was locked on the inside, and no answer could be got to their
13420 cries and knocking.
13421 Help was obtained, and the door forced.
13422 The unfortunate young man was found lying near the table.
13423 His head had been horribly mutilated by an expanding revolver bullet, but
13424 no weapon of any sort was to be found in the room.
13432 \begin_layout Subsubsection
13436 \begin_layout Standard
13437 The amount of space before and after multiple columns can be changed by
13438 changing the length
13439 \begin_inset Flex Code
13442 \begin_layout Plain Layout
13451 For example the command
13454 \begin_layout LyX-Code
13462 \begin_layout Standard
13463 in \SpecialChar TeX
13464 Code changes its value to 3
13465 \begin_inset space \thinspace{}
13469 The change must be made before the multiple columns' start.
13470 The predefined value is 13
13471 \begin_inset space \thinspace{}
13477 \begin_layout Standard
13479 \begin_inset Flex Code
13482 \begin_layout Plain Layout
13491 \begin_inset space \thinspace{}
13497 \begin_layout Standard
13501 \begin_layout Plain Layout
13507 multicolsep}{2.5cm}
13515 \begin_layout Standard
13516 \begin_inset Flex Multiple Columns
13519 \begin_layout Plain Layout
13522 All day I turned these facts over in my mind, endeavouring to hit upon some
13523 theory which could reconcile them all, and to find that line of least resistanc
13524 e which my poor friend had declared to be the starting-point of every investigat
13526 I confess that I made little progress.
13527 In the evening I strolled across the Park, and found myself about six o'clock
13528 at the Oxford Street end of Park Lane.
13529 A group of loafers upon the pavements, all staring up at a particular window,
13530 directed me to the house which I had come to see.
13531 A tall, thin man with coloured glasses, whom I strongly suspected of being
13532 a plain-clothes detective, was pointing out some theory of his own, while
13533 the others crowded round to listen to what he said.
13534 I got as near him as I could, but his observations seemed to me to be absurd,
13535 so I withdrew again in some disgust.
13536 As I did so I struck against an elderly, deformed man, who had been behind
13537 me, and I knocked down several books which he was carrying.
13545 \begin_layout Standard
13546 \begin_inset Note Greyedout
13549 \begin_layout Plain Layout
13554 The values you set with
13555 \begin_inset Flex Code
13558 \begin_layout Plain Layout
13566 will be used for all following multiple columns until you change them again.
13574 \begin_layout Standard
13578 \begin_layout Plain Layout
13590 \begin_inset Note Note
13593 \begin_layout Plain Layout
13594 go back to the default
13602 \begin_layout Standard
13603 \begin_inset Newpage newpage
13609 \begin_layout Subsubsection
13613 \begin_layout Standard
13614 A column break can be forced by inserting the command
13615 \begin_inset Flex Code
13618 \begin_layout Plain Layout
13626 as \SpecialChar TeX
13627 Code to that position in the text where the column should be broken.
13628 Note that this leads in most cases to whitespace in the text.
13629 \begin_inset Newline newline
13632 Here is an example:
13635 \begin_layout Standard
13636 \begin_inset Flex Multiple Columns
13639 \begin_layout Plain Layout
13642 \begin_inset Quotes eld
13645 You're surprised to see me, sir,
13646 \begin_inset Quotes erd
13649 said he, in a strange, croaking voice.
13652 \begin_layout Plain Layout
13655 I acknowledged that I was.
13658 \begin_layout Plain Layout
13661 \begin_inset Quotes eld
13664 Well, I've a conscience, sir, and when I chanced to see you go into this
13665 house, as I came hobbling after you, I thought to myself, I'll just step
13666 in and see that kind gentleman, and tell him that if I was a bit gruff
13667 in my manner there was not any harm meant, and that I am much obliged to
13668 him for picking up my books.
13669 \begin_inset Quotes erd
13675 \begin_layout Plain Layout
13678 \begin_inset Quotes eld
13681 You make too much of a trifle,
13682 \begin_inset Quotes erd
13687 \begin_inset Quotes eld
13690 May I ask how you knew who I was?
13691 \begin_inset Quotes erd
13694 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
13698 \begin_layout Plain Layout
13710 \begin_layout Plain Layout
13713 \begin_inset Quotes eld
13716 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13717 you'll find my little bookshop at the corner of Church Street, and very
13718 happy to see you, I am sure.
13719 Maybe you collect yourself, sir.
13723 \begin_inset space ~
13737 \begin_inset space ~
13740 – a bargain, every one of them.
13741 With five volumes you could just fill that gap on that second shelf.
13742 It looks untidy, does it not, sir?
13743 \begin_inset Quotes erd
13754 \begin_layout Subsubsection
13758 \begin_layout Standard
13759 The width of the columns is automatically calculated, but you can modify
13760 the space between the columns.
13761 This is done by changing the length
13762 \begin_inset Flex Code
13765 \begin_layout Plain Layout
13774 Its predefined value is 10
13775 \begin_inset space \thinspace{}
13779 Here is an example where
13780 \begin_inset Flex Code
13783 \begin_layout Plain Layout
13792 \begin_inset space \thinspace{}
13798 \begin_layout Standard
13802 \begin_layout Plain Layout
13816 \begin_layout Standard
13817 \begin_inset Flex Multiple Columns
13820 \begin_layout Plain Layout
13823 My observations of No.
13824 \begin_inset space \space{}
13827 427 Park Lane did little to clear up the problem in which I was interested.
13828 The house was separated from the street by a low wall and railing, the
13829 whole not more than five feet high.
13830 It was perfectly easy, therefore, for anyone to get into the garden, but
13831 the window was entirely inaccessible, since there was no water pipe or
13832 anything which could help the most active man to climb it.
13833 More puzzled than ever, I retraced my steps to Kensington.
13834 I had not been in my study five minutes when the maid entered to say that
13835 a person desired to see me.
13836 To my astonishment it was none other than my strange old book collector,
13837 his sharp, wizened face peering out from a frame of white hair, and his
13838 precious volumes, a dozen of them at least, wedged under his right arm.
13846 \begin_layout Standard
13850 \begin_layout Plain Layout
13862 \begin_inset Note Note
13865 \begin_layout Plain Layout
13866 go back to the default
13874 \begin_layout Subsubsection
13878 \begin_layout Standard
13879 Between the columns a rule with a width of the length
13880 \begin_inset Flex Code
13883 \begin_layout Plain Layout
13892 If this rule width is set to 0
13893 \begin_inset space \thinspace{}
13896 pt (this is the default), the rule is suppressed.
13897 In the following example the rule is 2
13898 \begin_inset space \thinspace{}
13904 \begin_layout Standard
13908 \begin_layout Plain Layout
13914 columnseprule}{2pt}
13922 \begin_layout Standard
13923 \begin_inset Flex Multiple Columns
13926 \begin_layout Plain Layout
13929 \begin_inset Quotes eld
13932 You're surprised to see me, sir,
13933 \begin_inset Quotes erd
13936 said he, in a strange, croaking voice.
13939 \begin_layout Plain Layout
13942 I acknowledged that I was.
13945 \begin_layout Plain Layout
13948 \begin_inset Quotes eld
13951 Well, I've a conscience, sir, and when I chanced to see you go into this
13952 house, as I came hobbling after you, I thought to myself, I'll just step
13953 in and see that kind gentleman, and tell him that if I was a bit gruff
13954 in my manner there was not any harm meant, and that I am much obliged to
13955 him for picking up my books.
13956 \begin_inset Quotes erd
13962 \begin_layout Plain Layout
13965 \begin_inset Quotes eld
13968 You make too much of a trifle,
13969 \begin_inset Quotes erd
13974 \begin_inset Quotes eld
13977 May I ask how you knew who I was?
13978 \begin_inset Quotes erd
13984 \begin_layout Plain Layout
13987 \begin_inset Quotes eld
13990 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13991 you'll find my little bookshop at the corner of Church Street, and very
13992 happy to see you, I am sure.
13993 Maybe you collect yourself, sir.
13997 \begin_inset space ~
14011 \begin_inset space ~
14014 – a bargain, every one of them.
14015 With five volumes you could just fill that gap on that second shelf.
14016 It looks untidy, does it not, sir?
14017 \begin_inset Quotes erd
14028 \begin_layout Standard
14029 \begin_inset VSpace defskip
14035 \begin_layout Standard
14036 The rule can be colored by redefining the command
14037 \begin_inset Flex Code
14040 \begin_layout Plain Layout
14049 This is done by inserting the command
14052 \begin_layout LyX-Code
14057 columnseprulecolor}{
14062 \begin_layout Standard
14063 as \SpecialChar TeX
14064 Code before the multicolumn inset.
14066 \begin_inset Flex Code
14069 \begin_layout Plain Layout
14075 in this command by a color of your choice.
14076 You can use all pre- and self-defined colors.
14084 \begin_inset space ~
14089 for more information about pre- and self-defined colors.
14090 To go back to the default color insert the command
14093 \begin_layout LyX-Code
14098 columnseprulecolor}{
14103 \begin_layout Standard
14104 Here is the example with a cyan rule and 1
14105 \begin_inset space \thinspace{}
14108 cm column separation:
14111 \begin_layout Standard
14115 \begin_layout Plain Layout
14124 \begin_layout Plain Layout
14130 columnseprulecolor}{
14140 \begin_layout Standard
14141 \begin_inset Flex Multiple Columns
14144 \begin_layout Plain Layout
14147 \begin_inset Quotes eld
14150 You're surprised to see me, sir,
14151 \begin_inset Quotes erd
14154 said he, in a strange, croaking voice.
14157 \begin_layout Plain Layout
14160 I acknowledged that I was.
14163 \begin_layout Plain Layout
14166 \begin_inset Quotes eld
14169 Well, I've a conscience, sir, and when I chanced to see you go into this
14170 house, as I came hobbling after you, I thought to myself, I'll just step
14171 in and see that kind gentleman, and tell him that if I was a bit gruff
14172 in my manner there was not any harm meant, and that I am much obliged to
14173 him for picking up my books.
14174 \begin_inset Quotes erd
14180 \begin_layout Plain Layout
14183 \begin_inset Quotes eld
14186 You make too much of a trifle,
14187 \begin_inset Quotes erd
14192 \begin_inset Quotes eld
14195 May I ask how you knew who I was?
14196 \begin_inset Quotes erd
14202 \begin_layout Plain Layout
14205 \begin_inset Quotes eld
14208 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
14209 you'll find my little bookshop at the corner of Church Street, and very
14210 happy to see you, I am sure.
14211 Maybe you collect yourself, sir.
14215 \begin_inset space ~
14229 \begin_inset space ~
14232 – a bargain, every one of them.
14233 With five volumes you could just fill that gap on that second shelf.
14234 It looks untidy, does it not, sir?
14235 \begin_inset Quotes erd
14246 \begin_layout Standard
14250 \begin_layout Plain Layout
14256 columnseprule}{0pt}
14259 \begin_layout Plain Layout
14265 columnseprulecolor}{
14273 \begin_inset Note Note
14276 \begin_layout Plain Layout
14277 go back to the default
14285 \begin_layout Section
14287 \change_inserted 564990737 1671270380
14291 \begin_layout Subsection
14293 \change_inserted 564990737 1671270398
14295 \change_deleted 564990737 1671270396
14301 \begin_layout Standard
14304 as well as any other text processor uses by default rectangular paragraphs.
14305 For special cases like for example posters, invitation cards or poems you
14306 can modify the paragraph shape to one of your choice.
14307 This can be done by using the \SpecialChar LaTeX
14309 \begin_inset Flex Code
14312 \begin_layout Plain Layout
14318 which is loaded by using in the document settings the module
14320 Custom paragraph shapes
14325 \begin_layout Subsubsection
14329 \begin_layout Standard
14334 provides the following shapes:
14337 \begin_layout Standard
14338 \begin_inset Tabular
14339 <lyxtabular version="3" rows="13" columns="3">
14340 <features booktabs="true" islongtable="true" longtabularalignment="center">
14341 <column alignment="left" valignment="middle" width="16col%">
14342 <column alignment="left" valignment="middle" width="40col%">
14343 <column alignment="left" valignment="middle" width="35col%">
14344 <row endhead="true">
14345 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
14348 \begin_layout Plain Layout
14357 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
14360 \begin_layout Plain Layout
14369 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
14372 \begin_layout Plain Layout
14382 <row interlinespace="default">
14383 <cell alignment="left" valignment="top" usebox="none">
14386 \begin_layout Plain Layout
14394 <cell alignment="left" valignment="top" usebox="none">
14397 \begin_layout Plain Layout
14400 Circle with circular hole (in the size of a CD/DVD)
14405 <cell alignment="left" valignment="top" usebox="none">
14408 \begin_layout Plain Layout
14411 Cannot be scaled, take care there is not too much text
14417 <row interlinespace="default">
14418 <cell alignment="left" valignment="top" usebox="none">
14421 \begin_layout Plain Layout
14429 <cell alignment="left" valignment="top" usebox="none">
14432 \begin_layout Plain Layout
14440 <cell alignment="left" valignment="top" usebox="none">
14443 \begin_layout Plain Layout
14446 Fragile, calculation might fail
14452 <row interlinespace="default">
14453 <cell alignment="left" valignment="top" usebox="none">
14456 \begin_layout Plain Layout
14464 <cell alignment="left" valignment="top" usebox="none">
14467 \begin_layout Plain Layout
14470 Rhomboid (symbolizing a
14471 \begin_inset Quotes eld
14475 \begin_inset Quotes erd
14483 <cell alignment="left" valignment="top" usebox="none">
14486 \begin_layout Plain Layout
14495 <row interlinespace="default">
14496 <cell alignment="left" valignment="top" usebox="none">
14499 \begin_layout Plain Layout
14507 <cell alignment="left" valignment="top" usebox="none">
14510 \begin_layout Plain Layout
14518 <cell alignment="left" valignment="top" usebox="none">
14521 \begin_layout Plain Layout
14530 <row interlinespace="default">
14531 <cell alignment="left" valignment="top" usebox="none">
14534 \begin_layout Plain Layout
14542 <cell alignment="left" valignment="top" usebox="none">
14545 \begin_layout Plain Layout
14553 <cell alignment="left" valignment="top" usebox="none">
14556 \begin_layout Plain Layout
14565 <row interlinespace="default">
14566 <cell alignment="left" valignment="top" usebox="none">
14569 \begin_layout Plain Layout
14577 <cell alignment="left" valignment="top" usebox="none">
14580 \begin_layout Plain Layout
14583 Nut for bolt (hexagon with circular hole)
14588 <cell alignment="left" valignment="top" usebox="none">
14591 \begin_layout Plain Layout
14600 <row interlinespace="default">
14601 <cell alignment="left" valignment="top" usebox="none">
14604 \begin_layout Plain Layout
14612 <cell alignment="left" valignment="top" usebox="none">
14615 \begin_layout Plain Layout
14623 <cell alignment="left" valignment="top" usebox="none">
14626 \begin_layout Plain Layout
14635 <row interlinespace="default">
14636 <cell alignment="left" valignment="top" usebox="none">
14639 \begin_layout Plain Layout
14647 <cell alignment="left" valignment="top" usebox="none">
14650 \begin_layout Plain Layout
14658 <cell alignment="left" valignment="top" usebox="none">
14661 \begin_layout Plain Layout
14670 <row interlinespace="default">
14671 <cell alignment="left" valignment="top" usebox="none">
14674 \begin_layout Plain Layout
14682 <cell alignment="left" valignment="top" usebox="none">
14685 \begin_layout Plain Layout
14693 <cell alignment="left" valignment="top" usebox="none">
14696 \begin_layout Plain Layout
14705 <row interlinespace="default">
14706 <cell alignment="left" valignment="top" usebox="none">
14709 \begin_layout Plain Layout
14717 <cell alignment="left" valignment="top" usebox="none">
14720 \begin_layout Plain Layout
14723 Normal/reversed rain drop
14728 <cell alignment="left" valignment="top" usebox="none">
14731 \begin_layout Plain Layout
14734 Fragile, calculation might fail
14740 <row interlinespace="default">
14741 <cell alignment="left" valignment="top" usebox="none">
14744 \begin_layout Plain Layout
14753 <cell alignment="left" valignment="top" usebox="none">
14756 \begin_layout Plain Layout
14759 The \SpecialChar TeX
14765 <cell alignment="left" valignment="top" usebox="none">
14768 \begin_layout Plain Layout
14777 <row interlinespace="default">
14778 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
14781 \begin_layout Plain Layout
14785 \begin_inset Newline newline
14793 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
14796 \begin_layout Plain Layout
14799 Triangles in different orientations
14804 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
14807 \begin_layout Plain Layout
14823 \begin_layout Standard
14824 To use a shape for your paragraph, simply select it in \SpecialChar LyX
14826 for environments in the toolbar.
14829 \begin_layout Standard
14830 \begin_inset Newpage newpage
14836 \begin_layout Standard
14837 Here is an example paragraph in the shape of a nut:
14840 \begin_layout Standard
14841 \begin_inset VSpace bigskip
14850 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14851 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14853 At vero eos et accusam et justo duo dolores et ea rebum.
14854 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14856 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14857 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14861 \begin_layout Standard
14862 \begin_inset VSpace bigskip
14868 \begin_layout Standard
14869 \begin_inset Note Greyedout
14872 \begin_layout Plain Layout
14881 paragraphs cannot run over a page break.
14889 \begin_layout Standard
14890 \begin_inset VSpace bigskip
14896 \begin_layout Standard
14898 \begin_inset Flex Code
14901 \begin_layout Plain Layout
14907 takes care that the shape will always be preserved, no matter how much
14908 text is in the paragraph.
14909 Therefore the paragraph size changes with the amount of contained text.
14910 This can lead to paragraph sizes exceeding the page margins.
14911 To demonstrate the size scaling, here is the same example paragraph but
14912 with twice as much text:
14915 \begin_layout Standard
14916 \begin_inset Newpage newpage
14925 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14926 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14928 At vero eos et accusam et justo duo dolores et ea rebum.
14929 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14931 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14932 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14934 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14935 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14937 At vero eos et accusam et justo duo dolores et ea rebum.
14938 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14940 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14941 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14945 \begin_layout Standard
14946 \begin_inset VSpace bigskip
14952 \begin_layout Standard
14953 An exception is the shape
14958 It cannot be scaled because it must fit the size of a CD/DVD.
14959 Therefore the amount of text that fits into the shape is limited.
14960 \begin_inset Newline newline
14971 shape are fragile, meaning that the calculation of their size can fail,
14972 depending on the amount of text.
14973 You will then get the \SpecialChar LaTeX
14975 \begin_inset Quotes eld
14978 Arithmetic overflow
14979 \begin_inset Quotes erd
14983 In this case one can try to remove or add some text; if nothing works one
14984 has to use another shape.
14987 \begin_layout Standard
14988 \begin_inset VSpace bigskip
14994 \begin_layout Standard
14995 For shapes with tips you will maybe see that \SpecialChar LaTeX
14996 's hyphenation routine fails
14997 for text in the tips.
14998 Therefore it is often necessary to add hyphenation points
15003 arg "specialchar-insert hyphenation"
15008 ) to the corresponding text parts.
15011 \begin_layout Standard
15012 \begin_inset VSpace bigskip
15018 \begin_layout Standard
15019 Shapepar paragraphs are either always centered or placed on the page so
15020 that their left border touches the left page margin.
15021 You can therefore not use the paragraph dialog to align such paragraphs.
15022 A solution is to put the paragraph into a minipage or parbox and align
15024 The problem is hereby to find the right width for the box.
15025 Because if it is too wide and you center the box, the paragraph is not
15026 centered too because it sticks at the left side of the box.
15027 So you might have to play a bit with the width until it fits.
15028 Here are two heart-shaped paragraphs, the first one is not aligned, the
15029 second one is right-aligned:
15032 \begin_layout Standard
15033 \begin_inset Newpage newpage
15039 \begin_layout Heart
15043 Lo\SpecialChar softhyphen
15044 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15045 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15047 At vero eos et accusam et justo duo dolores et ea rebum.
15048 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15052 \begin_layout Standard
15053 \begin_inset VSpace bigskip
15059 \begin_layout Standard
15062 \begin_inset Box Frameless
15072 height_special "totalheight"
15077 backgroundcolor "none"
15080 \begin_layout Heart
15084 Lo\SpecialChar softhyphen
15085 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15086 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15088 At vero eos et accusam et justo duo dolores et ea rebum.
15089 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15098 \begin_layout Subsubsection
15102 \begin_layout Standard
15103 You can define any shape you want.
15104 Doing this manually is a lot of work because every coordinate must be specified.
15105 But there is a way to let the computer calculate the coordinates:
15108 \begin_layout Enumerate
15109 Install the program
15110 \begin_inset CommandInset href
15113 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
15121 \begin_layout Enumerate
15128 TeX/LaTeX\SpecialChar menuseparator
15129 Settings\SpecialChar menuseparator
15132 and select the font size you are using in your document.
15133 For example this document uses the size 12
15134 \begin_inset space \thinspace{}
15140 \begin_layout Enumerate
15144 \begin_layout Enumerate
15147 TeX/LaTeX\SpecialChar menuseparator
15150 to export the shape to coordinates.
15151 In the appearing dialog use either the outline of your shape for the coordinate
15152 s or the path itself.
15156 \begin_layout Plain Layout
15157 For more information see
15158 \begin_inset CommandInset href
15160 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
15173 \begin_layout Standard
15174 The coordinates are written into a \SpecialChar TeX
15176 To use it for your \SpecialChar LyX
15180 \begin_layout Enumerate
15181 Place the cursor before the first character of your paragraph (or into a
15185 \begin_layout Enumerate
15186 Open in \SpecialChar LyX
15189 Insert\SpecialChar menuseparator
15190 File\SpecialChar menuseparator
15192 \begin_inset space ~
15197 , select the file and use
15206 \begin_layout Standard
15207 \begin_inset VSpace defskip
15213 \begin_layout Standard
15214 \begin_inset Note Greyedout
15217 \begin_layout Plain Layout
15222 : The changed shape only applies to the current paragraph; everything is
15223 reset to normal for the next paragraph.
15224 Therefore the shape definition file must be input into every paragraph
15225 with the desired shape.
15233 \begin_layout Standard
15234 \begin_inset VSpace bigskip
15240 \begin_layout Standard
15241 Here is an example:
15244 \begin_layout Standard
15245 \begin_inset VSpace bigskip
15251 \begin_layout Standard
15252 \begin_inset CommandInset include
15254 filename "SpecialParagraphShape.tex"
15261 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15262 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15264 At vero eos et accusam et justo duo dolores et ea rebum.
15265 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
15267 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
15268 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
15272 \begin_layout Standard
15273 \begin_inset VSpace bigskip
15279 \begin_layout Standard
15284 to draw complexer shapes in
15288 you can draw the shape in a program of your choice and import the resulting
15294 Then you only need to draw a line or spline along the outline of the image.
15297 \begin_layout Standard
15298 \begin_inset VSpace bigskip
15304 \begin_layout Standard
15307 Custom paragraph shapes
15309 also provides the two commands
15317 which can be used to define custom shapes coordinate by coordinate.
15321 \begin_layout Plain Layout
15322 These commands are internally used for all shapes described here.
15327 For information how these styles are used and about further customization
15328 possibilities, have a look at the
15329 \begin_inset CommandInset href
15331 name "documentation"
15332 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
15338 \begin_inset Flex Code
15341 \begin_layout Plain Layout
15350 \begin_layout Chapter
15352 \change_deleted 564990737 1671304317
15356 \change_inserted 564990737 1671304322
15358 \change_deleted 564990737 1671304331
15359 ies with Bib\SpecialChar TeX
15365 \begin_layout Standard
15366 The most basic information about how to use Bib\SpecialChar TeX
15371 with \SpecialChar LyX
15372 is contained in the section
15374 Bibliography databases
15381 The following subsections explain special bibliography features supported
15382 by \SpecialChar LyX
15386 \begin_layout Section
15387 Alternative Citation Styles
15390 \begin_layout Standard
15391 Standard Bib\SpecialChar TeX
15393 \begin_inset space \thinspace{}
15397 \begin_inset space \space{}
15401 \begin_inset Quotes eld
15405 \begin_inset Quotes erd
15408 ) to refer to a cited work.
15409 However, in many scientific disciplines, other citation styles are in use.
15410 The most common one is the author-year style (e.
15411 \begin_inset space \thinspace{}
15415 \begin_inset space \space{}
15419 \begin_inset Quotes eld
15423 \begin_inset Quotes erd
15428 supports three packages that provide this style,
15429 \begin_inset Flex Code
15432 \begin_layout Plain Layout
15439 \begin_inset Flex Code
15442 \begin_layout Plain Layout
15449 \begin_inset Flex Code
15452 \begin_layout Plain Layout
15459 Each of these packages has their pros and cons, which cannot be listed
15461 If you only want to have simple author-year (or author-numerical) style,
15462 or if you want to use one of the countless style files for
15463 \begin_inset Flex Code
15466 \begin_layout Plain Layout
15472 , then the established
15473 \begin_inset Flex Code
15476 \begin_layout Plain Layout
15482 package is probably your choice.
15483 If you look for specific citation styles common in law studies, you might
15485 \begin_inset Flex Code
15488 \begin_layout Plain Layout
15495 If you want to have full control over the formatting or look for advanced
15496 features such as ibidem, footnote citations, full title citations, advanced
15497 date formats (such as 400 BC) or full localization to other languages than
15498 English, you should definitely consider
15499 \begin_inset Flex Code
15502 \begin_layout Plain Layout
15508 , which exceeds all other packages in terms of features, but is also quite
15509 heavy and more resource-hungry.
15512 \begin_layout Standard
15513 The handling of these packages in \SpecialChar LyX
15514 is basically the same.
15516 \begin_inset Flex Noun
15519 \begin_layout Plain Layout
15520 Document\SpecialChar menuseparator
15527 \begin_inset Flex Noun
15530 \begin_layout Plain Layout
15537 \begin_inset Flex Noun
15540 \begin_layout Plain Layout
15547 \begin_inset Flex Noun
15550 \begin_layout Plain Layout
15557 \begin_inset Flex Noun
15560 \begin_layout Plain Layout
15567 \begin_inset Flex Noun
15570 \begin_layout Plain Layout
15571 Biblatex (Natbib mode)
15577 \begin_inset Flex Noun
15580 \begin_layout Plain Layout
15587 \begin_inset Flex Noun
15590 \begin_layout Plain Layout
15597 \begin_inset space ~
15600 6.5.3 in the User's Guide for more information on these choices).
15601 With all these packages, you will get some extra features in the citation
15602 dialog and you can select the style of the reference (
15603 \begin_inset Quotes eld
15607 \begin_inset Quotes erd
15611 \begin_inset Quotes eld
15615 \begin_inset Quotes erd
15619 \begin_inset Quotes eld
15623 \begin_inset Quotes erd
15627 \begin_inset Quotes eld
15631 \begin_inset Quotes erd
15635 Note that either package needs specifically designed style files.
15636 They all ship their own, but there are lots of additional style files,
15637 and there is even an interactive style file builder
15641 \begin_layout Plain Layout
15643 \begin_inset Flex URL
15646 \begin_layout Plain Layout
15648 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
15659 \begin_inset Flex Code
15662 \begin_layout Plain Layout
15671 \begin_layout Section
15672 Subdivided Bibliographies
15675 \begin_layout Standard
15676 Sometimes you might need to divide your bibliography into several sections.
15677 If you are for instance a historian, the possibility to separate sources
15678 and scientific works is most likely a
15679 \begin_inset Quotes eld
15683 \begin_inset Quotes erd
15687 Unfortunately, Bib\SpecialChar TeX
15688 itself does not allow you to do this.
15689 But with the help of some \SpecialChar LaTeX
15690 packages, Bib\SpecialChar TeX
15691 can be extended to fit your needs.
15694 \begin_layout Standard
15696 provides native support for one of these packages,
15704 \begin_layout Plain Layout
15706 \begin_inset Flex URL
15709 \begin_layout Plain Layout
15711 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
15721 The advantage of this package (compared to other packages such as
15725 ) is that you don't need to define new citation commands.
15726 Instead, you need to prepare different bibliographic databases which include
15727 the entries for the different sections of the bibliography.
15728 For example: If you want to divide your bibliography into the sections
15730 \begin_inset Quotes eld
15734 \begin_inset Quotes erd
15738 \begin_inset Quotes eld
15742 \begin_inset Quotes erd
15745 , you first need to create two bibliographic databases, e.
15746 \begin_inset space \thinspace{}
15750 \begin_inset space \space{}
15754 \begin_inset Flex Code
15757 \begin_layout Plain Layout
15764 \begin_inset Flex Code
15767 \begin_layout Plain Layout
15777 \begin_layout Standard
15779 \begin_inset Flex Noun
15782 \begin_layout Plain Layout
15783 Document\SpecialChar menuseparator
15790 \begin_inset Flex Noun
15793 \begin_layout Plain Layout
15800 \begin_inset Flex Noun
15803 \begin_layout Plain Layout
15804 Subdivided bibliography
15810 Now you can insert multiple Bib\SpecialChar TeX
15811 bibliographies, one for each section of
15813 Returning to our example: Insert the Bib\SpecialChar TeX
15815 \begin_inset Flex Code
15818 \begin_layout Plain Layout
15824 and a second one for the database
15825 \begin_inset Flex Code
15828 \begin_layout Plain Layout
15835 You are free to use the same or different styles for each section.
15836 Additionally, you can choose if the bibliography section should contain
15838 \begin_inset Quotes eld
15841 all cited references
15842 \begin_inset Quotes erd
15845 of the specified database(s) (which is the default),
15846 \begin_inset Quotes eld
15849 all uncited references
15850 \begin_inset Quotes erd
15854 \begin_inset Quotes eld
15858 \begin_inset Quotes erd
15862 This might be useful if you would like to separate your bibliography into
15864 \begin_inset Quotes eld
15868 \begin_inset Quotes erd
15872 \begin_inset Quotes eld
15876 \begin_inset Quotes erd
15880 \begin_inset Quotes eld
15884 \begin_inset Quotes erd
15888 The titles for the sections can be added as ordinary sections or subsections.
15890 \begin_inset Flex Code
15893 \begin_layout Plain Layout
15899 removes the bibliography title, you have to manually re-add that, too (as
15900 a chapter* or section*, for instance).
15903 \begin_layout Standard
15908 , the procedure is a bit different.
15917 , the aforementioned
15918 \begin_inset Flex Noun
15921 \begin_layout Plain Layout
15922 Subdivided bibliography
15927 option is disabled if you use
15936 provides its own means to generate subdivided bibliographies.
15937 You can either add keywords to bibliography entries via the
15938 \begin_inset Flex Code
15941 \begin_layout Plain Layout
15947 entry option and then filter bibliography sections by keyword (by adding
15949 \begin_inset Flex Code
15952 \begin_layout Plain Layout
15959 \begin_inset Flex Noun
15962 \begin_layout Plain Layout
15968 field of the dialog that opens if you left-click on the
15969 \begin_inset Flex Noun
15972 \begin_layout Plain Layout
15973 Biblatex Generated Bibliography
15978 button), or you can filter by entry types (such as
15987 \begin_inset space \thinspace{}
15992 \begin_inset Flex Code
15995 \begin_layout Plain Layout
16002 \begin_inset Flex Code
16005 \begin_layout Plain Layout
16012 \begin_inset Flex Noun
16015 \begin_layout Plain Layout
16021 field, or you can create so-called
16022 \begin_inset Quotes eld
16025 Bibliography Categories
16026 \begin_inset Quotes erd
16029 to which you can assign individual entries.
16030 Please refer to the Biblatex manual, section
16032 Subdivided Bibliographies
16037 \begin_layout Section
16038 Multiple Bibliographies
16039 \begin_inset CommandInset label
16041 name "subsec:Multiple-Bibliographies"
16048 \begin_layout Standard
16049 Multiple bibliographies, e.
16050 \begin_inset space \thinspace{}
16054 \begin_inset space \space{}
16057 a bibliography for each part, chapter, section, subsection or child (sub-documen
16058 t) of the document, are also supported by \SpecialChar LyX
16060 In order to enable it, go to
16061 \begin_inset Flex Noun
16064 \begin_layout Plain Layout
16065 Document\SpecialChar menuseparator
16066 Settings\SpecialChar menuseparator
16072 and select the relevant unit (e.
16073 \begin_inset space \thinspace{}
16077 \begin_inset Quotes eld
16081 \begin_inset Quotes erd
16085 \begin_inset Flex Noun
16088 \begin_layout Plain Layout
16089 Multiple Bibliographies
16095 Then add a Bib(la)\SpecialChar TeX
16096 bibliography to each unit (e.
16097 \begin_inset space \thinspace{}
16100 g., section) of your document.
16101 In the output, a separate bibliography, containing only the references
16102 done in the current unit is generated.
16105 \begin_layout Standard
16106 If you use Bib\SpecialChar TeX
16108 \begin_inset Flex Code
16111 \begin_layout Plain Layout
16118 \begin_inset Flex Code
16121 \begin_layout Plain Layout
16127 package is used to create multiple bibliographies.
16128 The former package is used if you select
16129 \begin_inset Quotes eld
16133 \begin_inset Quotes erd
16141 \begin_inset Flex Noun
16144 \begin_layout Plain Layout
16145 Sectioned Bibliography
16151 In all other cases,
16152 \begin_inset Flex Code
16155 \begin_layout Plain Layout
16165 \begin_layout Plain Layout
16166 An alternative approach, if you are willing to use some
16167 \begin_inset Flex Noun
16170 \begin_layout Plain Layout
16178 \begin_inset space ~
16182 \begin_inset CommandInset ref
16184 reference "sec:Inserting-TeX-Code"
16189 \begin_inset Flex Code
16192 \begin_layout Plain Layout
16204 \begin_inset Flex Code
16207 \begin_layout Plain Layout
16213 is used, \SpecialChar LyX
16214 encloses the specified units in
16215 \begin_inset Flex Code
16218 \begin_layout Plain Layout
16225 \begin_inset Flex Code
16228 \begin_layout Plain Layout
16237 \begin_inset Flex Code
16240 \begin_layout Plain Layout
16248 in order to create the units.
16249 Note that this approach has some limitations.
16250 First, every citation reference has to be inside some
16251 \begin_inset Flex Code
16254 \begin_layout Plain Layout
16261 So citations outside a defined unit (e.
16262 \begin_inset space \thinspace{}
16265 g., before the first section if you use
16266 \begin_inset Quotes eld
16270 \begin_inset Quotes erd
16274 \begin_inset Quotes eld
16278 \begin_inset Quotes erd
16282 You can also create your own units by entering
16283 \begin_inset Flex Code
16286 \begin_layout Plain Layout
16295 \begin_inset Flex Code
16298 \begin_layout Plain Layout
16306 as \SpecialChar TeX
16307 code (for instance to work around the mentioned limitation).
16309 \begin_inset Flex Code
16312 \begin_layout Plain Layout
16318 s cannot be nested.
16319 A second limitation is that
16320 \begin_inset Flex Code
16323 \begin_layout Plain Layout
16329 always processes all references of a bibliography database, even if they
16331 This can result in odd labels (e.
16332 \begin_inset space \thinspace{}
16337 \begin_inset Quotes eld
16341 \begin_inset Quotes erd
16344 if two works of this author from 2014 are in the database, even if only
16348 \begin_layout Standard
16354 \begin_inset Flex Code
16357 \begin_layout Plain Layout
16363 option is used instead.
16364 If you need specific units, you can start them with the \SpecialChar TeX
16366 \begin_inset Flex Code
16369 \begin_layout Plain Layout
16378 \begin_inset Flex Code
16381 \begin_layout Plain Layout
16390 If you also want to control the end of the unit, use the environment
16391 \begin_inset Flex Code
16394 \begin_layout Plain Layout
16404 \begin_inset Flex Code
16407 \begin_layout Plain Layout
16417 \begin_inset Flex Code
16420 \begin_layout Plain Layout
16426 s cannot be nested.
16427 In addition to the individual bibliography of the current unit,
16431 also provides an easy way to output all bibliographies, subsequently, at
16433 \begin_inset space \thinspace{}
16436 g., at the end of the document).
16438 \begin_inset Quotes eld
16441 all reference units
16442 \begin_inset Quotes erd
16445 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
16447 Please refer to the
16451 manual for more information on this topic.
16454 \begin_layout Chapter
16456 \change_deleted 564990737 1671355654
16460 \change_inserted 564990737 1671355667
16462 \change_deleted 564990737 1671355661
16464 \change_inserted 564990737 1671355684
16466 \begin_inset CommandInset label
16468 name "chap:bullets"
16473 \change_deleted 564990737 1671355684
16475 \begin_inset CommandInset label
16486 \begin_layout Standard
16492 \begin_layout Section
16496 \begin_layout Standard
16498 provides 216 bullet shapes that can be accessed from a simple dialog.
16499 Using this dialog you can easily specify what bullet shape to use at each
16500 level of an itemized list.
16501 These settings are document-wide so you won't be able to specify different
16502 sets of bullets for different paragraphs.
16506 \begin_layout Plain Layout
16507 Well, actually you can but you'll have to do it by hand.
16515 \begin_layout Section
16519 \begin_layout Standard
16520 Open the dialog by selecting the
16521 \begin_inset Flex Noun
16524 \begin_layout Plain Layout
16525 Document\SpecialChar menuseparator
16531 menu item and then select the
16532 \begin_inset Flex Noun
16535 \begin_layout Plain Layout
16544 \begin_layout Standard
16545 The dialog provides you with a table of bullet shapes.
16546 A column of buttons on the left of the table provides access to the six
16547 different panels of bullet shapes.
16548 The row of buttons across the top is used to select which bullet depth
16551 \change_deleted 244031559 1603875981
16552 A text entry under the table shows the currently selected bullet shape's
16554 equivalent and this can be edited if desired.
16555 If you do modify the text you will also need to specify any needed packages
16556 in the \SpecialChar LaTeX
16562 \begin_layout Standard
16563 The six panels are divided up by the packages they require.
16564 The following table shows the mappings from button name to \SpecialChar LaTeX
16568 \begin_layout Standard
16570 \begin_inset Tabular
16571 <lyxtabular version="3" rows="7" columns="2">
16572 <features tabularvalignment="middle">
16573 <column alignment="center" valignment="top" width="0pt">
16574 <column alignment="center" valignment="top" width="0pt">
16576 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
16579 \begin_layout Plain Layout
16594 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
16597 \begin_layout Plain Layout
16614 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16617 \begin_layout Plain Layout
16632 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16635 \begin_layout Plain Layout
16644 base \SpecialChar LaTeX
16652 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16655 \begin_layout Plain Layout
16670 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16673 \begin_layout Plain Layout
16690 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16693 \begin_layout Plain Layout
16708 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16711 \begin_layout Plain Layout
16728 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16731 \begin_layout Plain Layout
16746 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16749 \begin_layout Plain Layout
16766 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16769 \begin_layout Plain Layout
16784 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16787 \begin_layout Plain Layout
16804 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
16807 \begin_layout Plain Layout
16822 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
16825 \begin_layout Plain Layout
16848 \begin_layout Standard
16850 doesn't stop you using bullets from packages you don't have.
16851 If you get errors from \SpecialChar LaTeX
16852 when you try to view or print the file, then it
16853 is likely you are missing a package.
16857 \begin_layout Plain Layout
16859 doesn't restrict your use since you may be editing locally and exporting
16868 \begin_layout Section
16872 \begin_layout Standard
16873 Select which bullet depth you want to change then select the bullet shape
16875 Any changes will not be visible in \SpecialChar LyX
16876 , but are visible when viewing the document.
16879 \begin_layout Standard
16880 You can reset a bullet shape to the default simply by clicking your right
16881 mouse button on the appropriate bullet depth button.
16885 \begin_layout Plain Layout
16890 want to have multiple sets of paragraphs with different sets of bullets
16891 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
16893 The bullet selection dialog can help though because it provides you with
16894 the \SpecialChar LaTeX
16895 code for a wide range of bullet shapes.
16896 To make your own custom paragraphs you have the following options:
16899 \begin_layout Plain Layout
16903 \begin_layout Plain Layout
16919 \begin_layout Plain Layout
16923 \begin_layout Plain Layout
16945 \begin_layout Itemize
16946 Use the \SpecialChar LaTeX
16948 \begin_inset Flex Code
16951 \begin_layout Plain Layout
16959 to specify a new bullet shape for a given depth.
16960 You'll also need to save the current bullet shape so you can restore it
16962 In this itemized list the following \SpecialChar LaTeX
16963 code was used to change the bullet
16964 used for the first depth.
16968 \begin_layout LyX-Code
16978 \begin_layout LyX-Code
16995 \begin_layout Itemize
16996 Note that the itemize depth is specified in Roman numerals as part of the
17006 \begin_layout Itemize
17007 \begin_inset Argument item:1
17010 \begin_layout Plain Layout
17014 \begin_layout Plain Layout
17032 Specify each individual entry by starting each item with the bullet shape
17034 \begin_inset Quotes eld
17038 \begin_inset Quotes erd
17041 inset (available at
17043 Insert\SpecialChar menuseparator
17047 \begin_inset Flex Noun
17050 \begin_layout Plain Layout
17058 For example, this item was started with
17059 \begin_inset Flex Code
17062 \begin_layout Plain Layout
17077 \begin_layout Plain Layout
17081 \begin_layout Plain Layout
17097 \begin_layout Plain Layout
17098 You'll also need to revert the labelitem back to its previous setting for
17099 the global bullet shape settings to remain in effect.
17100 The way used here was:
17103 \begin_layout LyX-Code
17118 \begin_layout Chapter
17122 \begin_layout Section
17123 Multipart Documents
17126 \begin_layout Subsection
17130 \begin_layout Standard
17131 When you are working on a large file with many sections, it is often convenient
17132 to break up the document into several files, or perhaps you have something
17133 where a table may change from time to time, but the preceding text does
17135 In these cases, you should seriously consider using multipart documents.
17136 For example, scientific papers often have five major sections: the introduction
17137 , observations, results, discussion, and conclusion.
17138 Each of these could be its own separate \SpecialChar LyX
17140 \begin_inset Quotes eld
17144 \begin_inset Quotes erd
17147 file which contains the title, authors, abstract, references, etc., plus
17148 the five included files.
17149 It is important to note that each of these files is a full \SpecialChar LyX
17151 can be formatted and printed on its own, as well as included in a master
17153 Each of these files must have the same document class, however—don't attempt
17154 to mix book classes with article classes.
17155 You may also include \SpecialChar LaTeX
17156 files; however, these files must not have their own
17158 \begin_inset space \thinspace{}
17162 \begin_inset space \space{}
17165 everything up to and including the
17166 \begin_inset Flex Code
17169 \begin_layout Plain Layout
17177 line as well as the
17178 \begin_inset Flex Code
17181 \begin_layout Plain Layout
17189 line must be deleted) or else errors will be generated when you try to
17193 \begin_layout Standard
17195 allows you to include files quite easily with
17196 \begin_inset Flex Noun
17199 \begin_layout Plain Layout
17200 Insert\SpecialChar menuseparator
17202 \begin_inset space ~
17211 When you click on this selection a small box is inserted into the file
17212 at the current cursor location.
17213 Clicking on the box raises a dialog which allows you to select the file
17214 to be included, and the method of its inclusion.
17218 \begin_layout Standard
17219 The file selection box should by now be obvious.
17220 The three inclusion methods are
17221 \begin_inset Quotes eld
17225 \begin_inset Quotes erd
17229 \begin_inset Quotes eld
17233 \begin_inset Quotes erd
17237 \begin_inset Quotes eld
17241 \begin_inset Quotes erd
17246 \begin_inset Quotes eld
17250 \begin_inset Quotes erd
17254 \begin_inset Quotes eld
17258 \begin_inset Quotes erd
17261 are similar in many ways, but there are also some notable differences:
17264 \begin_layout Enumerate
17266 \begin_inset Quotes eld
17270 \begin_inset Quotes erd
17273 are typeset beginning on a new page, while files that are
17274 \begin_inset Quotes eld
17278 \begin_inset Quotes erd
17281 are typeset starting on the current page.
17284 \begin_layout Enumerate
17285 \begin_inset Quotes eld
17289 \begin_inset Quotes erd
17292 files cannot themselves
17293 \begin_inset Quotes eld
17297 \begin_inset Quotes erd
17301 \begin_inset Quotes eld
17305 \begin_inset Quotes erd
17310 \begin_inset Quotes eld
17314 \begin_inset Quotes erd
17317 , on the other hand, infinite sub-inputting is possible.
17320 \begin_layout Enumerate
17321 \begin_inset Quotes eld
17325 \begin_inset Quotes erd
17328 allow for the output of only selected
17329 \begin_inset Quotes eld
17333 \begin_inset Quotes erd
17336 files, while maintaining the actual counters (pagination etc.) and references
17337 (please refer to the section
17340 \begin_inset space ~
17348 \begin_inset space ~
17353 manual for details).
17356 \begin_layout Standard
17358 \begin_inset Quotes eld
17362 \begin_inset Quotes erd
17365 is the preferred method for chapters that are outsourced to child documents,
17367 \begin_inset Quotes eld
17371 \begin_inset Quotes erd
17374 is more suitable for arbitrary file inheritance.
17377 \begin_layout Standard
17379 \begin_inset Quotes eld
17383 \begin_inset Quotes erd
17386 included file allows you to include a file typeset exactly as it appears
17388 \begin_inset space \thinspace{}
17392 \begin_inset space \space{}
17396 \begin_inset Flex Code
17399 \begin_layout Plain Layout
17405 mode, with the characters set in a fixed-width typewriter font.
17406 Normally, spaces in this file are invisible, though two consecutive spaces
17407 are conserved, unlike \SpecialChar LyX
17408 's normal treatment of spaces.
17409 However, setting the
17410 \begin_inset Flex Noun
17413 \begin_layout Plain Layout
17415 \begin_inset space ~
17419 \begin_inset space ~
17423 \begin_inset space ~
17431 checkbox typesets a mark to unambiguously define the presence of a space.
17435 \begin_layout Standard
17436 Generally, the master file is converted into a full \SpecialChar LaTeX
17437 file before typesetting,
17438 while the included files are converted to \SpecialChar LaTeX
17439 files that do not have all the
17440 preamble information.
17443 \begin_layout Subsection
17444 Cross-References Between Files
17447 \begin_layout Standard
17448 \begin_inset Box Shadowbox
17458 height_special "totalheight"
17463 backgroundcolor "none"
17466 \begin_layout Plain Layout
17467 This section is somewhat out of date.
17468 Need to describe default master documents and how children are opened when
17478 \begin_layout Standard
17479 It is possible to set up cross-references between the different files.
17480 First, open all the files in question: let's call them A and B in a two
17481 file example, where B is included in A.
17482 Let's say you insert a label in A, then want to reference it in B.
17483 Open the cross-reference dialog whilst in document B, and you can select
17485 \begin_inset Quotes eld
17489 \begin_inset Quotes erd
17495 \begin_layout Subsection
17496 Bibliography Lists in all Subdocuments
17499 \begin_layout Standard
17500 If you work with child documents, you might want to have only one main bibliogra
17501 phy at the end, but still be able to have a selected bibliography for the
17502 child if you output it on its own.
17503 Here is how to achieve this.
17506 \begin_layout Standard
17507 For the main document, you just insert a bibliography inset at the place
17508 where the main bibliography has to appear (within the master file or within
17510 If the bibliography inset is in the master file, the references will be
17511 inherited by all children, so they are available in the citation dialog
17515 \begin_layout Standard
17516 For child-specific bibliographies, insert bibliography insets within the
17517 child documents, at the place where the bibliography should appear when
17518 the child is compiled separately.
17519 However, the trick is to insert them into a branch (
17521 Insert\SpecialChar menuseparator
17522 Branch\SpecialChar menuseparator
17523 Insert New Branch...
17526 \begin_inset space \thinspace{}
17531 \begin_inset Quotes eld
17535 \begin_inset Quotes erd
17539 Within the children, activate the branch (
17541 Document\SpecialChar menuseparator
17542 Settings...\SpecialChar menuseparator
17546 Within the master, deactivate the branch (
17548 Document\SpecialChar menuseparator
17549 Settings...\SpecialChar menuseparator
17553 Now the child's bibliography will be ignored by the master, but considered
17557 \begin_layout Standard
17558 If you need multiple bibliographies (e.
17559 \begin_inset space \thinspace{}
17562 g., one per child in the
17566 ), please refer to sec.
17567 \begin_inset space ~
17571 \begin_inset CommandInset ref
17573 reference "subsec:Multiple-Bibliographies"
17580 \begin_layout Section
17585 \begin_layout Standard
17586 Users sometimes need to be able to
17587 \begin_inset Quotes eld
17591 \begin_inset Quotes erd
17595 file together with all the images (and other files) on which it depends,
17596 either for sending to a publisher or for sharing with a co-author.
17598 includes a Python script (
17599 \begin_inset Flex Code
17602 \begin_layout Plain Layout
17608 ) that automates this process.
17609 To use it, you must have either the
17610 \begin_inset Flex Code
17613 \begin_layout Plain Layout
17620 \begin_inset Flex Code
17623 \begin_layout Plain Layout
17629 python modules installed on your system.
17630 By default, the script prefers the
17631 \begin_inset Flex Code
17634 \begin_layout Plain Layout
17641 \begin_inset Flex Code
17644 \begin_layout Plain Layout
17650 format on Unix-like systems and the
17651 \begin_inset Flex Code
17654 \begin_layout Plain Layout
17663 \begin_layout Standard
17665 's configuration process will set the script up to export a `\SpecialChar LyX
17667 and this format will then be available under
17668 \begin_inset Flex Code
17671 \begin_layout Plain Layout
17672 File\SpecialChar menuseparator
17681 \begin_layout Standard
17682 Independently of the platform, the generation of a particular archive format
17683 can be forced by adding either the
17684 \begin_inset Flex Code
17687 \begin_layout Plain Layout
17694 \begin_inset Flex Code
17697 \begin_layout Plain Layout
17704 \begin_inset Flex Code
17707 \begin_layout Plain Layout
17714 \begin_inset Flex Code
17717 \begin_layout Plain Layout
17723 format) switch to the
17724 \begin_inset Flex Code
17727 \begin_layout Plain Layout
17729 \SpecialChar menuseparator
17737 \begin_inset Flex Code
17740 \begin_layout Plain Layout
17741 Tools\SpecialChar menuseparator
17742 Preferences\SpecialChar menuseparator
17743 File Handling\SpecialChar menuseparator
17750 (Make sure you add the switch after the script name, not before it.)
17753 \begin_layout Section
17754 Fancy Headers and Footers
17757 \begin_layout Standard
17758 The default page layout is rather plain; for an
17759 \begin_inset Flex Code
17762 \begin_layout Plain Layout
17768 document class, all you get is a centered page number at the bottom of
17770 This document uses KOMA-script's book class, so it appears to be a bit
17772 But to really put on a show, you need to set the document page style to
17774 \begin_inset Quotes eld
17778 \begin_inset Quotes erd
17781 , as mentioned in the
17786 This section describes the \SpecialChar LaTeX
17787 code you need to insert in your \SpecialChar LaTeX
17789 order to get the desired effects.
17792 \begin_layout Standard
17793 For more information on fancy headers, see the
17794 \begin_inset Flex Code
17797 \begin_layout Plain Layout
17803 package documentation.
17805 \begin_inset Flex URL
17808 \begin_layout Plain Layout
17810 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
17818 \begin_layout Standard
17819 The page header is divided into three fields, not surprisingly labeled
17820 \begin_inset Quotes eld
17824 \begin_inset Quotes erd
17828 \begin_inset Quotes eld
17832 \begin_inset Quotes erd
17836 \begin_inset Quotes eld
17840 \begin_inset Quotes erd
17844 The footer is also divided into these three fields.
17845 The \SpecialChar LaTeX
17846 commands to set these fields in the simplest manner are
17847 \begin_inset Flex Code
17850 \begin_layout Plain Layout
17859 \begin_inset Flex Code
17862 \begin_layout Plain Layout
17871 \begin_inset Flex Code
17874 \begin_layout Plain Layout
17883 \begin_inset Flex Code
17886 \begin_layout Plain Layout
17895 Suppose you wish to put your name in the upper left hand corner of each
17897 Simply insert the following command in the preamble:
17900 \begin_layout Standard
17909 \begin_layout Standard
17910 You will now see your name in the upper left.
17911 If a field has a default entry that you would like to get rid of (often
17912 the page number appears in the central footer) simply include a command
17913 with a blank argument, e.
17914 \begin_inset space \thinspace{}
17920 \begin_layout Standard
17928 \begin_layout Standard
17929 Let's get really fancy: lets put the section number with the word
17930 \begin_inset Quotes eld
17934 \begin_inset Quotes erd
17938 \begin_inset space \thinspace{}
17942 \begin_inset space \space{}
17945 Section 3) in the upper left, the page number (e.
17946 \begin_inset space \thinspace{}
17950 \begin_inset space \space{}
17953 Page 4) in the upper right, your name in the lower left, and the date in
17955 The following commands should now appear in the preamble:
17958 \begin_layout Standard
17968 \begin_layout Standard
17976 \begin_layout Standard
17986 \begin_layout Standard
17995 \begin_layout Standard
18003 \begin_layout Standard
18013 \begin_layout Standard
18015 \begin_inset Flex Code
18018 \begin_layout Plain Layout
18027 \begin_inset Flex Code
18030 \begin_layout Plain Layout
18038 access \SpecialChar LaTeX
18039 's section and page counters, and so print out the current section
18042 \begin_inset Flex Code
18045 \begin_layout Plain Layout
18053 simply prints out today's date.
18056 \begin_layout Standard
18057 The thicknesses of the horizontal rules drawn beneath the header and above
18058 the footer can also be modified.
18059 If you don't want one of the rules, set its thickness to 0.
18060 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
18066 \begin_inset Flex Code
18069 \begin_layout Plain Layout
18074 headrulewidth}{0.4pt}
18080 \begin_inset Flex Code
18083 \begin_layout Plain Layout
18088 footrulewidth}{0.4pt}
18093 to set the thicknesses.
18096 \begin_layout Standard
18097 You can switch the header/footer settings on and off for individual pages
18098 using commands like
18099 \begin_inset Flex Code
18102 \begin_layout Plain Layout
18105 thispagestyle{empty}
18111 \begin_inset Flex Code
18114 \begin_layout Plain Layout
18117 thispagestyle{plain}
18123 \begin_inset Flex Code
18126 \begin_layout Plain Layout
18129 thispagestyle{fancy}
18135 Simply insert them in the text on the page you want changed and mark them
18136 as \SpecialChar TeX
18138 In fact, title pages are marked as plain by default, while following pages
18139 are marked fancy when using the global fancy setting.
18142 \begin_layout Standard
18143 As a final example, it is possible to include an image in the header or
18145 Suppose you want to put a company logo in the upper lefthand corner.
18146 You might try something like
18149 \begin_layout Standard
18158 includegraphics{logo.eps}}}
18161 \begin_layout Standard
18163 (you may need to preface this with
18164 \begin_inset Flex Code
18167 \begin_layout Plain Layout
18170 usepackage{graphics}
18175 if you don't include graphics elsewhere in your document).
18178 \begin_layout Chapter
18180 and the World Wide Web
18183 \begin_layout Standard
18185 has long supported the export of documents to various web-friendly formats,
18187 Before version 2.0, however, HTML export was always accomplished by the
18188 use of external converters.
18192 \begin_layout Plain Layout
18193 For details on the use of external converters with \SpecialChar LyX
18198 section of the Customization manual.
18203 These fall into two large groups: there are converters that use \SpecialChar LaTeX
18205 intermediate format, such as
18206 \begin_inset Flex Code
18209 \begin_layout Plain Layout
18216 \begin_inset Flex Code
18219 \begin_layout Plain Layout
18226 \begin_inset Flex Code
18229 \begin_layout Plain Layout
18235 , relying upon \SpecialChar LyX
18236 to produce the \SpecialChar LaTeX
18237 ; and there is a converter that works directly
18238 on \SpecialChar LyX
18240 \begin_inset Flex Code
18243 \begin_layout Plain Layout
18251 All of these have different advantages and disadvantages.
18255 \begin_layout Standard
18256 The \SpecialChar LaTeX
18257 -based converters have the advantage that, in principle, they know everythin
18258 g about the exported document that \SpecialChar LaTeX
18260 Such converters do not care, for example, if a certain block of code was
18261 produced by \SpecialChar LyX
18262 or was Evil Red Text.
18263 These converters know about
18264 \begin_inset Flex Code
18267 \begin_layout Plain Layout
18273 files, counters, and references, and can often make use of the
18274 \begin_inset Flex Code
18277 \begin_layout Plain Layout
18283 files generated by Bib\SpecialChar TeX
18285 On the other hand, \SpecialChar LaTeX
18286 is a very hard language to parse—it is sometimes said
18287 that only \SpecialChar TeX
18288 itself understands \SpecialChar TeX
18289 —and \SpecialChar LaTeX
18290 -based converters will often choke on
18291 what seem to be quite simple constructs; complex ones can throw them completely
18292 , and as of this writing, for example, the
18296 manual will not export with
18297 \begin_inset Flex Code
18300 \begin_layout Plain Layout
18306 , though the others will.
18307 The other issue concerns how math is handled.
18308 These converters typically convert the formulae into little pictures that
18309 are then linked from the HTML document.
18310 Since these are actually generated by \SpecialChar LaTeX
18311 , they are accurate.
18312 But they do not scale well, and just getting them to look as if they are
18313 actually meant to be in your document—so that the font sizes seem to be
18314 roughly the same—can be a challenge.
18317 \begin_layout Standard
18319 \begin_inset Flex Code
18322 \begin_layout Plain Layout
18330 \begin_inset CommandInset href
18332 name "http://pinchito.es/elyxer/"
18333 target "http://pinchito.es/elyxer/"
18338 ) solves some of these problems.
18339 In particular, the formulae it produces scale perfectly, since it renders
18340 math using a combination of HTML and CSS rather than converting the formulae
18342 But even moderately complex formula are rendered less well than with
18343 \begin_inset Flex Code
18346 \begin_layout Plain Layout
18352 ; this reflects the limitations of HTML.
18356 \begin_layout Plain Layout
18358 \begin_inset Flex Code
18361 \begin_layout Plain Layout
18368 can also use jsMath and MathJax for equations, but this setting is only
18369 available globally and requires one to have access to a server that runs
18375 More importantly (as of version 1.1.1, at least),
18376 \begin_inset Flex Code
18379 \begin_layout Plain Layout
18386 has limited support for math macros and no support for user-defined paragraph
18387 or character styles.
18388 These limitations make
18389 \begin_inset Flex Code
18392 \begin_layout Plain Layout
18399 unsuitable for many of the documents \SpecialChar LyX
18401 In principle, of course, these problems could be solved, but the \SpecialChar LyX
18403 have decided to follow a different path and have made \SpecialChar LyX
18405 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
18406 , DocBook, and plaintext.
18409 \begin_layout Standard
18410 As of this writing, XHTML output remains under development and should probably
18412 \begin_inset Quotes eld
18416 \begin_inset Quotes erd
18423 \begin_layout Plain Layout
18425 \begin_inset Flex Code
18428 \begin_layout Plain Layout
18429 development/HTML/HTML.notes
18434 , which can be found in the \SpecialChar LyX
18436 \begin_inset CommandInset href
18438 name "accessed online"
18439 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
18444 , usually contains up-to-date information about the state of XHTML output.
18445 See also the list of XHTML bugs on
18446 \begin_inset CommandInset href
18448 name "the bug tracker"
18449 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"
18459 Still, the developers have chosen this approach because it has several
18460 potential advantages over the other two.
18463 \begin_layout Standard
18464 These advantages are primarily due to the fact that the XHTML output routines,
18465 since they are part of \SpecialChar LyX
18466 , know everything \SpecialChar LyX
18467 knows about the document being
18472 \begin_layout Plain Layout
18473 Another advantage is that, since these routines are internal to \SpecialChar LyX
18475 immune to changes in \SpecialChar LyX
18476 's file format, or to changes in the semantics of
18482 So they know about the table of contents (as displayed in the outline),
18483 about the counters associated with different paragraph styles, and about
18484 user-defined styles.
18485 The XHTML output routines know what \SpecialChar LyX
18486 knows about internationalization,
18487 too, so they will output
18488 \begin_inset Quotes eld
18492 \begin_inset Quotes erd
18496 \begin_inset Quotes eld
18504 \begin_inset Quotes erd
18507 , depending upon the language in effect at the time.
18511 \begin_layout Standard
18512 Quite generally, the output routines know what \SpecialChar LyX
18513 knows about document layout,
18514 that is, about how the document is to be rendered on screen.
18515 We use this information when we output the document as XHTML.
18516 In particular, \SpecialChar LyX
18521 generates CSS style information corresponding to the layout information
18522 it uses to render the document on screen: if section headings are supposed
18523 to be sans-serif and bold as seen in \SpecialChar LyX
18524 , then (by default) they will be sans-seri
18525 f and bold when viewed in a web browser, too.
18526 And this is true not just for pre-defined styles, like Section, but for
18527 any style, including user-defined styles.
18528 Indeed, the XHTML output routines make no distinction between user-defined
18530 \change_deleted 244031559 1603876931
18532 \change_inserted 244031559 1603876940
18535 styles and \SpecialChar LyX
18536 's own pre-defined styles: in each case, everything \SpecialChar LyX
18538 the styles is contained in the layout files.
18539 And much the same is true as regards pre-defined textual insets, such as
18540 footnotes, and various custom insets.
18544 \begin_layout Standard
18545 The result is that XHTML output can be customized and extended in exactly
18546 the same way \SpecialChar LaTeX
18547 output can be customized and extended: through layout files
18549 See chapter five of the
18553 manual for the details.
18556 \begin_layout Standard
18557 The remainder of this chapter contains more detailed information on XHTML
18558 output, its limitations, and ways to work around those limitations.
18561 \begin_layout Section
18562 Math Output in XHTML
18565 \begin_layout Standard
18567 offers four choices for how math is rendered.
18568 These have various advantages and disadvantages:
18571 \begin_layout Itemize
18573 \begin_inset Newline newline
18576 MathML is a dialect of XML designed specifically for mathematics on the
18577 web, and it typically renders very well in browsers that support it.
18578 The disadvantage is that not all browsers support MathML, and support is
18579 not complete even in the Gecko-based browsers, such as Firefox.
18580 \begin_inset Newline newline
18583 If \SpecialChar LyX
18584 is unable to render a formula as MathML—for example, if the formula
18586 \begin_inset Flex Code
18589 \begin_layout Plain Layout
18595 package or ERT—then it will instead output the formula as an image.
18599 \begin_layout Itemize
18601 \begin_inset Newline newline
18604 As mentioned above,
18605 \begin_inset Flex Code
18608 \begin_layout Plain Layout
18614 outputs math as HTML, styled by CSS.
18618 \begin_layout Plain Layout
18620 has borrowed some of the CSS for its HTML output from
18621 \begin_inset Flex Code
18624 \begin_layout Plain Layout
18635 For simple formulae, this can work quite well, though with more complicated
18636 formulae it tends to break down.
18637 Still, this method has the advantage that it is very widely supported and
18638 so it may be appropriate for documents that contain only a little, fairly
18640 \begin_inset Newline newline
18643 If Lyx is unable to render a formula as HTML—for example, if the formula
18645 \begin_inset Flex Code
18648 \begin_layout Plain Layout
18654 package or ERT—then it will instead output the formula as an image.
18658 \begin_layout Itemize
18660 \begin_inset Newline newline
18664 \begin_inset Flex Code
18667 \begin_layout Plain Layout
18674 will output formulae as images, the very same images, in fact, that are
18675 used for instant preview.
18679 \begin_layout Plain Layout
18680 Instant preview does
18684 have to be on for images to be output, however.
18689 The advantage to this method is that the images are simply generated by
18691 , so they are very accurate.
18692 The disadvantage, as mentioned earlier, is that these are bitmapped images,
18693 so they do not scale terribly well, and one cannot copy them, etc.
18694 \begin_inset Newline newline
18697 The size of the images can be controlled by setting the
18698 \begin_inset Quotes eld
18701 Math Images Scaling
18702 \begin_inset Quotes erd
18706 \begin_inset Flex Noun
18709 \begin_layout Plain Layout
18710 Document\SpecialChar menuseparator
18711 Settings\SpecialChar menuseparator
18721 \begin_layout Plain Layout
18722 For those who want to know, this controls the resolution of the image in
18723 dots per inch and is based upon a default of 75 dpi.
18729 \begin_inset Newline newline
18732 If \SpecialChar LyX
18733 for some reason fails to create an image for a formula (e.g., if a required
18735 package is not installed), then it will fall back to outputing the raw
18740 \begin_layout Itemize
18743 \begin_inset Newline newline
18746 Finally, \SpecialChar LyX
18747 will happily output math as \SpecialChar LaTeX
18749 As well as being the output of last resort, this method can be used with
18751 \begin_inset CommandInset href
18754 target "http://www.math.union.edu/~dpvc/jsMath/"
18759 , which uses JavaScript to render \SpecialChar LaTeX
18760 embedded in HTML documents.
18762 wraps the \SpecialChar LaTeX
18764 \begin_inset Flex Code
18767 \begin_layout Plain Layout
18773 (for inline formulas) or
18774 \begin_inset Flex Code
18777 \begin_layout Plain Layout
18783 (for displayed formulas) with
18784 \begin_inset Flex Code
18787 \begin_layout Plain Layout
18793 , as is required for jsMath.
18796 \begin_layout Standard
18797 One of these output methods must be selected under
18798 \begin_inset Flex Noun
18801 \begin_layout Plain Layout
18802 Document\SpecialChar menuseparator
18803 Settings\SpecialChar menuseparator
18810 By default, \SpecialChar LyX
18812 This is a document-wide setting, therefore.
18815 \begin_layout Standard
18816 Eventually, \SpecialChar LyX
18817 will offer the user the option to select an alternate output
18818 method for a particular inset, say, one that isn't being rendered very
18823 \begin_layout Plain Layout
18824 That said, since \SpecialChar LyX
18825 falls back to images if the inset contains ERT, then one
18826 can force output as an image by putting some harmless ERT into the math,
18828 \begin_inset Formula $a=b\relax$
18839 \begin_layout Section
18840 Bibliography and Citations
18843 \begin_layout Standard
18844 XHTML output fully supports bibliographies and citations.
18848 \begin_layout Standard
18849 Citation labels are generated by the same machinery that generates \SpecialChar LyX
18851 labels, so the labels will look in the output much as they do in \SpecialChar LyX
18854 If you are using numerical citations, then \SpecialChar LyX
18855 will output numerical labels,
18856 such as [1] or [17], rather than simply showing the citation key in square
18857 brackets, as it does on-screen.
18858 If you are using author-year citations, then \SpecialChar LyX
18859 will add lowercase letters
18860 to the years, just as Bib\SpecialChar TeX
18861 does, if it finds more than one citation for
18862 a given author-year combination.
18863 The labels will be printed with the bibliography entries.
18864 Note that there is, at present, no way to customize the appearance of the
18865 labels, for example, to choose between square brackets and parentheses.
18868 \begin_layout Standard
18869 Bibliography output is handled by the same machinery that handles the presentati
18870 on of reference information in the citation dialog, so you will see in the
18871 XHTML output pretty much what you would see if you were to look at a given
18872 entry in the citation dialog.
18873 The formatting can be customized in your layout file or, preferably, in
18879 manual for the details.
18882 \begin_layout Standard
18883 The main defect at present is that cross-referenced information is printed
18884 with every entry with which it is associated.
18885 So you can see things like this:
18888 \begin_layout Quote
18890 \begin_inset Quotes eld
18893 Context and Logical Form
18894 \begin_inset Quotes erd
18899 Language in Context: Selected Essays
18901 (Oxford: Oxford University Press, 2007), pp.
18905 \begin_layout Quote
18907 \begin_inset Quotes eld
18910 Semantics in Context
18911 \begin_inset Quotes erd
18916 Language in Context: Selected Essays
18918 (Oxford: Oxford University Press, 2007), pp.
18922 \begin_layout Standard
18923 This should be fixed before long.
18926 \begin_layout Standard
18927 There is no support at present for sectioned bibliographies.
18928 If you have multiple bibliographies, then \SpecialChar LyX
18929 will print the same bibliography
18933 \begin_layout Section
18937 \begin_layout Standard
18939 will happily export indexes as XHTML, but with certain limitations at the
18943 \begin_layout Standard
18944 Index export will be most reliable when you do not attempt to use the fancy
18945 constructs that are described in the section on indexes in the
18953 \begin_layout Plain Layout
18954 The main issue here is that \SpecialChar LyX
18955 itself does not really handle these.
18956 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
18962 We'll describe how they are handled using the subsection headings from
18966 \begin_layout Itemize
18967 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
18968 makes an effort to support these,
18969 but the entries must be separated by
18970 \begin_inset Quotes eld
18974 \begin_inset Quotes erd
18977 , that is, there must be spaces around the exclamation point.
18978 This is because it is otherwise too difficult to check for escaped exclamation
18979 points, ones in math, and so forth.
18982 \begin_layout Itemize
18983 Page Ranges: There is no support at all for page ranges, since these make
18984 no sense with XHMTL.
18985 Instead, you will just get two index entries, one at either end.
18988 \begin_layout Itemize
18989 Cross-referencing: There is no support for cross-referencing.
18990 If \SpecialChar LyX
18991 finds an entry containing the
18992 \begin_inset Quotes eld
18995 |see\SpecialChar ldots
18997 \begin_inset Quotes erd
19000 construct, it is just dropped, and the rest is treated as an ordinary index
19004 \begin_layout Itemize
19005 Index Entry Order: \SpecialChar LyX
19006 does support attempts to fix the sorting order.
19007 It will take what is before the first `@' it finds and use that for sorting,
19008 taking what follows the first `@' to be the actual entry.
19009 At present, \SpecialChar LyX
19010 does not check for escaped `@', so do not try to index email
19014 \begin_layout Itemize
19015 Index Entry Layout: You can format entries by using the text style dialog,
19016 or by using any other method available within \SpecialChar LyX
19018 There is no support for constructs like:
19019 \begin_inset Quotes eld
19023 \begin_inset Quotes erd
19027 Indeed, if \SpecialChar LyX
19028 finds a pipe symbol, `|', in an entry, it will delete it and
19029 everything that follows it.
19032 \begin_layout Itemize
19033 Multiple Indexes: There is no support for multiple indexes.
19034 Rather, all index entries will be printed as one large index.
19035 To avoid our printing several versions of the index, we print only the
19036 main index, so make sure you have one.
19039 \begin_layout Section
19040 Nomenclature and Glossary
19043 \begin_layout Standard
19044 There is at present no support for glossaries.
19045 Adding it would be fairly trivial, and welcome.
19048 \begin_layout Chapter
19050 \change_inserted 1075283030 1616534180
19054 \begin_layout Standard
19056 \change_inserted 1075283030 1616534386
19057 Apart from HTML, \SpecialChar LyX
19058 can generate documents in the DocBook XML vocabulary.
19059 With versions 2.3 and before, only select templates could be used to generate
19060 DocBook documents (only version 4).
19061 Starting with \SpecialChar LyX
19062 2.4, most \SpecialChar LyX
19063 layouts can generate valid DocBook documents (only
19065 This feature is built into \SpecialChar LyX
19066 and does not require the use of external tools.
19069 \begin_layout Standard
19071 \change_inserted 1075283030 1616534437
19072 The result is that the DocBook output can be customized and extended in
19073 exactly the same way \SpecialChar LaTeX
19074 output can be customized and extended: through layout
19076 See chapter five of the
19080 manual for the details.
19083 \begin_layout Standard
19085 \change_inserted 1075283030 1616534475
19086 Most \SpecialChar LyX
19087 features are supported with DocBook, like math output.
19090 \begin_layout Itemize
19092 \change_inserted 1075283030 1616534741
19093 Math output is performed mostly in MathML (the major exception being constructio
19094 ns not supported by \SpecialChar LyX
19097 All formulae are also available in raw \SpecialChar TeX
19098 in the DocBook output for further
19102 \begin_layout Itemize
19104 \change_inserted 1075283030 1616534852
19105 Bibliographies and citations are implemented, including with an external
19107 Bibliography entries are not prerendered when the detailed information
19108 are available, but rather output with the standard DocBook constructs.
19109 The external DocBook processor is expected to handle the rendering of entries.
19112 \begin_layout Itemize
19114 \change_inserted 1075283030 1616534863
19115 Indexes are supported, including multiple indices.
19120 ), page ranges, and cross-references (
19124 ) are supported, with the exception of the same symbols escaped.
19133 ) are not supported.
19134 There is no support for escaping of index entries.
19137 \begin_layout Itemize
19139 \change_inserted 1075283030 1616534884
19140 Glossaries are implemented.
19143 \begin_layout Standard
19145 \change_inserted 1075283030 1616534894
19146 Two major parameters can be set at the document level.
19149 \begin_layout Itemize
19151 \change_inserted 1075283030 1616534948
19152 Format for tables: \SpecialChar LyX
19153 can generate tables either as HTML (default value) or
19154 CALS, depending on the user's requirements.
19155 Most DocBook processors accept both formats.
19158 \begin_layout Itemize
19160 \change_inserted 1075283030 1616535006
19161 MathML prefix: in DocBook, MathML is included within its own name space,
19163 The implication is that there must be an indication of the tags belonging
19164 to the MathML standard.
19165 Three choices are offered:
19169 \begin_layout Itemize
19171 \change_inserted 1075283030 1616535044
19172 Inline: the MathML name space is defined for each formula (using the
19176 attribute on each formula)
19179 \begin_layout Itemize
19181 \change_inserted 1075283030 1616535090
19186 prefix (default): the MathML name space is defined at the document level
19191 attribute on the root element).
19192 Each MathML is prefixed with
19201 \begin_layout Itemize
19203 \change_inserted 1075283030 1616620405
19208 prefix: similar to the
19217 \begin_layout Standard
19219 \change_inserted 1075283030 1616620470
19220 This option is especially useful if you want \SpecialChar LyX
19221 to match your personal style
19222 or to work with buggy software that only accepts one prefix for MathML.
19228 \begin_layout Chapter
19229 The \SpecialChar LyX
19233 \begin_layout Section
19237 \begin_layout Standard
19238 The `\SpecialChar LyX
19239 server' allows other programs to talk to \SpecialChar LyX
19240 , invoke \SpecialChar LyX
19241 commands, and retrieve
19242 information about the \SpecialChar LyX
19244 This is only intended for advanced users, but they should find it useful.
19245 It is by writing to the \SpecialChar LyX
19246 server, for example, that bibliography managers,
19247 such as JabRef, are able to
19248 \begin_inset Quotes eld
19252 \begin_inset Quotes erd
19255 citations to \SpecialChar LyX
19259 \begin_layout Section
19260 Starting the \SpecialChar LyX
19262 \begin_inset CommandInset label
19264 name "sec:Starting-the-Server"
19271 \begin_layout Standard
19272 The \SpecialChar LyX
19273 server works through the use of a pair of named pipes.
19274 These are usually located in
19275 \begin_inset Flex Code
19278 \begin_layout Plain Layout
19284 , (except on Windows, where
19288 named pipes are special objects located in
19289 \begin_inset Flex Code
19292 \begin_layout Plain Layout
19304 ) and have the names
19305 \begin_inset Quotes eld
19309 \begin_inset Flex Code
19312 \begin_layout Plain Layout
19319 \begin_inset Quotes erd
19323 \begin_inset Quotes eld
19327 \begin_inset Flex Code
19330 \begin_layout Plain Layout
19337 \begin_inset Quotes erd
19341 External programs write into
19342 \begin_inset Flex Code
19345 \begin_layout Plain Layout
19351 and read back data from
19352 \begin_inset Flex Code
19355 \begin_layout Plain Layout
19362 The stem of the pipe names can be defined in the
19363 \begin_inset Flex Noun
19366 \begin_layout Plain Layout
19367 Tools\SpecialChar menuseparator
19373 dialog, for example
19374 \begin_inset Flex Code
19377 \begin_layout Plain Layout
19378 "/home/myhome/lyxpipe"
19384 \begin_inset Flex Code
19387 \begin_layout Plain Layout
19401 on Windows (where any working path instead of lyxpipe can be used, for
19403 \begin_inset Flex Code
19406 \begin_layout Plain Layout
19429 configure this manually in order for the server to start.
19432 \begin_layout Standard
19435 \begin_inset Flex Code
19438 \begin_layout Plain Layout
19445 \begin_inset Flex Code
19448 \begin_layout Plain Layout
19454 ' to create the pipes.
19455 If one of the pipes already exists, \SpecialChar LyX
19456 will assume that another \SpecialChar LyX
19458 is already running and will not start the server.
19459 On POSIX (Unix like) systems, if for some other reason, an unused
19460 \begin_inset Quotes eld
19464 \begin_inset Quotes erd
19467 pipe is left in existence when \SpecialChar LyX
19468 closes, then \SpecialChar LyX
19469 will try to delete it.
19470 If this fails for some reason, you will need to delete the pipes manually
19471 and then restart \SpecialChar LyX
19473 On Windows, pipes are deleted by the OS on program termination or crash,
19475 \begin_inset Quotes eld
19479 \begin_inset Quotes erd
19482 pipes should not be possible.
19485 \begin_layout Standard
19486 To have several \SpecialChar LyX
19487 processes with servers at the same time, you have to use
19488 different configurations, perhaps by using separate user directories, each
19490 \begin_inset Flex Code
19493 \begin_layout Plain Layout
19499 file, for each process.
19502 \begin_layout Standard
19503 If you are developing a client program, you might find it useful to enable
19504 debugging information from the \SpecialChar LyX
19506 Do this by starting \SpecialChar LyX
19508 \begin_inset Flex Code
19511 \begin_layout Plain Layout
19520 \begin_layout Standard
19521 You can find a complete example client written in C++ in the source distribution
19523 \begin_inset Flex Code
19526 \begin_layout Plain Layout
19527 development/lyxserver/server_monitor.cpp
19535 \begin_layout Standard
19536 Another useful tool is the command-line based client found in
19537 \begin_inset Flex Code
19540 \begin_layout Plain Layout
19541 src/client/lyxclient
19549 \begin_layout Section
19550 Normal communication
19553 \begin_layout Standard
19554 To issue a \SpecialChar LyX
19555 call, the client writes a line of ASCII text into the input
19557 This line has the following format:
19560 \begin_layout Quote
19574 \begin_layout Description
19575 clientname is a name that the client can choose arbitrarily.
19576 Its only use is that \SpecialChar LyX
19577 will echo it if it sends an answer—so a client can
19578 dispatch results from different requesters.
19581 \begin_layout Description
19582 function is the function you want \SpecialChar LyX
19584 It is the same as the commands you'd use in the minibuffer.
19587 \begin_layout Description
19588 argument is an optional argument which is meaningful only to some functions
19590 \begin_inset Quotes eld
19594 \begin_inset Quotes erd
19597 LFUN will insert the argument as text at the cursor position).
19600 \begin_layout Standard
19601 The answer from \SpecialChar LyX
19602 will arrive in the output pipe and be of the form
19605 \begin_layout Quote
19619 \begin_layout Standard
19628 are just echoed from the command request, while
19632 is more or less useful information filled according to how the command
19633 execution worked out.
19634 Some commands, such as
19635 \begin_inset Quotes eld
19639 \begin_inset Quotes erd
19642 , will return information about the internal state of \SpecialChar LyX
19644 return an empty data-response.
19645 This means that the command execution went fine.
19648 \begin_layout Standard
19649 In case of errors, the response from \SpecialChar LyX
19650 will have this form
19653 \begin_layout Quote
19667 \begin_layout Standard
19672 should contain an explanation of why the command failed.
19675 \begin_layout Standard
19679 \begin_layout LyX-Code
19680 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
19681 \begin_inset Newline newline
19684 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
19685 \begin_inset Newline newline
19688 read a <~/.lyxpipe.out
19689 \begin_inset Newline newline
19695 \begin_layout Subsection
19696 AppleScript (Mac OS X)
19699 \begin_layout Standard
19700 Since \SpecialChar LyX
19701 2.1, \SpecialChar LyX
19702 supports basic interactions with AppleScript for normal communicatio
19703 n through the command run.
19704 This command takes a direct argument (the
19708 to perform) and an optional argument.
19709 It either returns the output of the function or triggers an error with
19710 the error message and code.
19713 \begin_layout Standard
19717 \begin_layout LyX-Code
19718 tell application "\SpecialChar LyX
19722 \begin_layout LyX-Code
19726 \begin_layout LyX-Code
19727 -- Stores the current file name into f
19730 \begin_layout LyX-Code
19731 set f to (run "server-get-filename" with argument "")
19734 \begin_layout LyX-Code
19735 on error the error_message number the error_number
19738 \begin_layout LyX-Code
19739 display dialog "Error: " & the error_number & ".
19743 \begin_layout LyX-Code
19744 & the error_message buttons {"OK"} default button 1
19747 \begin_layout LyX-Code
19751 \begin_layout LyX-Code
19755 \begin_layout Section
19759 \begin_layout Standard
19761 can notify clients of events going on asynchronously.
19762 Currently it will only do this if the user binds a key sequence with the
19764 \begin_inset Quotes eld
19768 \begin_inset Quotes erd
19772 The format of the string \SpecialChar LyX
19773 sends is as follows:
19776 \begin_layout Quote
19777 \begin_inset Flex Code
19780 \begin_layout Plain Layout
19791 \begin_layout Standard
19796 is the printed representation of the key sequence that was actually typed
19800 \begin_layout Standard
19801 This mechanism can be used to extend \SpecialChar LyX
19802 's command set and implement macros.
19803 Bind some key sequence to
19804 \begin_inset Quotes eld
19808 \begin_inset Quotes erd
19812 Then start a client that listens on the output pipe, dispatches the command
19813 according to the sequence, and starts a function that may use \SpecialChar LyX
19816 requests to issue a command or a series of commands to \SpecialChar LyX
19820 \begin_layout Section
19821 The simple \SpecialChar LyX
19825 \begin_layout Standard
19827 implements a simple protocol that can be used for session management.
19828 All messages are of the form
19831 \begin_layout Quote
19841 \begin_layout Standard
19847 \begin_inset Quotes eld
19851 \begin_inset Quotes erd
19855 \begin_inset Quotes eld
19859 \begin_inset Quotes erd
19864 \begin_inset Quotes eld
19868 \begin_inset Quotes erd
19871 is received from a client, \SpecialChar LyX
19872 will report back to inform the client that
19873 it's listening to it's messages, while
19874 \begin_inset Quotes eld
19878 \begin_inset Quotes erd
19881 sent from \SpecialChar LyX
19882 will inform clients that \SpecialChar LyX
19886 \begin_layout Section
19887 Reverse DVI/PDF search
19890 \begin_layout Standard
19891 Some DVI/PDF viewers
19895 \begin_layout Plain Layout
19896 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
19897 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
19906 facility (also called
19911 This means that you can tell \SpecialChar LyX
19912 to put the cursor to a specific line in the
19913 document by clicking at the respective position in the DVI/PDF output.
19914 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
19916 This is done via the \SpecialChar LyX
19917 server either by using the named pipe (
19921 ), or the UNIX domain socket (
19925 ) that \SpecialChar LyX
19926 creates in its temporary directory (this is the way the
19927 \begin_inset Flex Code
19930 \begin_layout Plain Layout
19936 program communicates with \SpecialChar LyX
19938 In some cases, you need a helper script that mediates between the viewer
19939 and \SpecialChar LyX
19940 , in others, the viewer can communicate with \SpecialChar LyX
19942 This depends on the selected viewer and on your operating system.
19943 The same applies to the way viewers need to be configured and the way the
19944 reverse search is actually performed.
19945 In what follows, we will thus describe how to setup reverse search for
19947 Before we turn to this, though, we will explain what needs to be done generally
19948 to enable reverse search in the DVI/PDF output.
19951 \begin_layout Subsection
19953 \begin_inset CommandInset label
19955 name "subsec:rev-search"
19962 \begin_layout Standard
19963 In most cases \SpecialChar LyX
19964 will do the work for you by pressing the following button
19968 arg "buffer-toggle-output-sync"
19972 Alternatively, you can also enable the feature by checking
19974 Synchronize with Output
19977 \begin_inset Flex Noun
19980 \begin_layout Plain Layout
19981 Document\SpecialChar menuseparator
19982 Settings\SpecialChar menuseparator
19989 In such a case \SpecialChar LyX
19990 will automatically insert the necessary Sync\SpecialChar TeX
19992 PDF) or load the srcltx package (for DVI) respectively.
19993 This option can be easily reached also on
19994 \begin_inset Flex Code
19997 \begin_layout Plain Layout
20006 \begin_layout Standard
20007 If you need a different setting, you can select or input a custom macro
20008 from the drop down box just below
20009 \begin_inset Flex Noun
20012 \begin_layout Plain Layout
20013 Document\SpecialChar menuseparator
20014 Settings\SpecialChar menuseparator
20015 Output\SpecialChar menuseparator
20016 Synchronize with Output
20024 \begin_layout Standard
20025 Note that the method
20026 \begin_inset Flex Code
20029 \begin_layout Plain Layout
20037 enables gzip compression.
20038 If your viewer does not support it, you should instead use
20039 \begin_inset Flex Code
20042 \begin_layout Plain Layout
20053 \begin_layout Standard
20054 Please also note that including the
20055 \begin_inset Flex Code
20058 \begin_layout Plain Layout
20065 \begin_inset Flex Code
20068 \begin_layout Plain Layout
20074 sometimes has an undesired impact on the typesetting.
20075 Thus, you should switch output synchronization off for the final typesetting
20077 \begin_inset Flex Code
20080 \begin_layout Plain Layout
20087 \begin_inset Flex Code
20090 \begin_layout Plain Layout
20100 \begin_layout Standard
20101 In case you need some more special settings that are not covered by the
20102 automatic settings, read the next section about how to set up output synchroniz
20104 If the automatic setup suits your needs, you can readily jump to section
20105 \begin_inset space ~
20109 \begin_inset CommandInset ref
20111 reference "subsec:configuring-viewers"
20115 , where the necessary configuration steps in your viewer – needed both with
20116 the automatic and the manual setup – are described.
20119 \begin_layout Subsection
20123 \begin_layout Standard
20125 provides several different methods for reverse search.
20126 Some are built-in in the
20127 \begin_inset Flex Code
20130 \begin_layout Plain Layout
20136 program, some are provided by external packages.
20137 Your choice depends on whether your \SpecialChar LaTeX
20138 distribution already provides a given
20139 method (the built-in methods are rather new) and whether your viewer can
20141 The available methods are described in the following.
20144 \begin_layout Subsubsection*
20145 Built-in DVI-search via src-specials (DVI only)
20148 \begin_layout Standard
20149 This method provides the DVI file with the necessary information for reverse
20151 It is available in \SpecialChar LaTeX
20152 since quite some time (any somewhat recent \SpecialChar LaTeX
20154 should include it), and it works reliably.
20155 To enable it, change the
20156 \begin_inset Flex Noun
20159 \begin_layout Plain Layout
20170 \begin_inset Flex Noun
20173 \begin_layout Plain Layout
20184 \begin_inset Flex Noun
20187 \begin_layout Plain Layout
20188 Preferences\SpecialChar menuseparator
20189 File Handling\SpecialChar menuseparator
20196 \begin_inset Flex Code
20199 \begin_layout Plain Layout
20200 latex -src-specials $$i
20206 If this doesn't work, check if your \SpecialChar TeX
20207 engine needs different options (the
20208 syntax might differ in some distributions).
20211 \begin_layout Subsubsection*
20212 External Packages (PDFSync and scrltx)
20215 \begin_layout Standard
20224 provide reverse search facility for PDF output (via pdflatex) and DVI output,
20226 In order to enable it, load the packages in the \SpecialChar LyX
20230 \begin_layout Itemize
20231 \begin_inset Flex Code
20234 \begin_layout Plain Layout
20237 usepackage{pdfsync}
20242 for reverse PDF search,
20245 \begin_layout Itemize
20246 \begin_inset Flex Code
20249 \begin_layout Plain Layout
20252 usepackage[active]{srcltx}
20257 for reverse DVI search.
20260 \begin_layout Standard
20261 If you want to be able to perform both DVI and PDF reverse searches, you
20262 can also insert in the preamble the following lines
20265 \begin_layout LyX-Code
20269 \begin_inset Newline newline
20275 \begin_inset Newline newline
20280 usepackage{pdfsync}
20281 \begin_inset Newline newline
20287 \begin_inset Newline newline
20292 usepackage[active]{srcltx}
20293 \begin_inset Newline newline
20301 \begin_layout Standard
20302 This way, you can preview the file as either DVI or PDF (pdflatex) and the
20303 right package will be used.
20306 \begin_layout Standard
20307 Note that PDFSync might affect the output layout of your document.
20308 It is therefore advised to disable PDFsync for final documents.
20311 \begin_layout Subsubsection*
20312 Built-in reverse search via Sync\SpecialChar TeX
20316 \begin_layout Standard
20318 \begin_inset Flex Code
20321 \begin_layout Plain Layout
20327 have built-in support for both PDF and DVI reverse search.
20330 Sync\SpecialChar TeX
20333 facility is basically the result of the integration of the PDFSync package
20334 to the pdftex program and its merge with the
20339 You need at least \SpecialChar TeX
20340 Live 2008 or a recent Mik\SpecialChar TeX
20341 distribution in order to use
20346 \begin_layout Plain Layout
20347 For some reason, Mik\SpecialChar TeX
20348 does not understand/obey the command \SpecialChar LyX
20350 the preamble when you check the "Enable Forward/Reverse Search" button
20351 in the toolbar and does not generate the necessary info.
20354 \begin_layout Plain Layout
20355 The generation of the required info can be forced by changing the converter
20356 "\SpecialChar LaTeX
20357 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
20358 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
20359 the -synctex=1 switch).
20364 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
20365 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
20366 already provide Sync\SpecialChar TeX
20370 \begin_layout Standard
20371 To enable Sync\SpecialChar TeX
20372 for DVI output, change the
20373 \begin_inset Flex Noun
20376 \begin_layout Plain Layout
20387 \begin_inset Flex Noun
20390 \begin_layout Plain Layout
20395 (plain) -> DraftDVI
20401 \begin_inset Flex Noun
20404 \begin_layout Plain Layout
20405 Preferences\SpecialChar menuseparator
20406 File Handling\SpecialChar menuseparator
20413 \begin_inset Flex Code
20416 \begin_layout Plain Layout
20417 latex -synctex=1 $$i
20422 , and for PDF output, change the
20423 \begin_inset Flex Noun
20426 \begin_layout Plain Layout
20431 (pdflatex) -> PDF (pdflatex)
20437 \begin_inset Flex Code
20440 \begin_layout Plain Layout
20441 pdflatex -synctex=1 $$i
20447 Should your viewer not be considered in the following description, or in
20448 case of missing success, please check the documentation of your viewer
20449 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
20454 \begin_layout Plain Layout
20455 Note that the option
20456 \begin_inset Flex Code
20459 \begin_layout Plain Layout
20465 option enables gzip compression.
20466 If your viewer does not support it, you should instead use
20467 \begin_inset Flex Code
20470 \begin_layout Plain Layout
20484 \begin_layout Subsection
20485 Configuring and using specific viewers
20486 \begin_inset CommandInset label
20488 name "subsec:configuring-viewers"
20495 \begin_layout Subsubsection*
20496 Xdvi (all platforms)
20499 \begin_layout Standard
20501 \begin_inset Flex Code
20504 \begin_layout Plain Layout
20510 , you don't need to do anything else for performing a reverse DVI search,
20511 as \SpecialChar LyX
20512 already provides the necessary hooks for automatically using the
20513 \begin_inset Flex Code
20516 \begin_layout Plain Layout
20523 Just setup your document as described above (reverse search is triggered
20524 by Ctrl-click or Alt-click on Mac OSX, respectively).
20527 \begin_layout Standard
20528 However, if for whatever reason you want to use the named pipe instead of
20529 the socket for communicating with \SpecialChar LyX
20530 , simply change the DVI viewer in
20531 \begin_inset Flex Noun
20534 \begin_layout Plain Layout
20535 Preferences\SpecialChar menuseparator
20536 File Handling\SpecialChar menuseparator
20546 \begin_layout Plain Layout
20547 On Mac OSX you have to use
20548 \begin_inset Flex Code
20551 \begin_layout Plain Layout
20552 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
20563 \begin_inset Flex Code
20566 \begin_layout Plain Layout
20567 xdvi -editor "lyxeditor.sh %f %l"
20573 \begin_inset Flex Code
20576 \begin_layout Plain Layout
20582 is a suitable script.
20583 For example, a minimal shell script is the following one:
20586 \begin_layout LyX-Code
20588 \begin_inset Newline newline
20591 LYXPIPE="/path/to/lyxpipe"
20592 \begin_inset Newline newline
20595 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
20596 \begin_inset Newline newline
20599 echo "$COMMAND" > "${LYXPIPE}".in || exit
20600 \begin_inset Newline newline
20603 read TMP < "${LYXPIPE}".out || exit
20606 \begin_layout Standard
20608 \begin_inset Flex Code
20611 \begin_layout Plain Layout
20617 is the LyXServer pipe path specified in
20618 \begin_inset Flex Noun
20621 \begin_layout Plain Layout
20622 Preferences\SpecialChar menuseparator
20632 \begin_layout Plain Layout
20634 \begin_inset Flex Code
20637 \begin_layout Plain Layout
20643 folder of a source distribution you can find a
20644 \begin_inset Flex Code
20647 \begin_layout Plain Layout
20653 script which is able to locate the
20657 based on your preferences.
20665 \begin_layout Subsubsection*
20669 \begin_layout Standard
20671 \begin_inset Flex Code
20674 \begin_layout Plain Layout
20675 /Applications/MacDviX_Folder/calleditor.script
20680 , add the following lines:
20683 \begin_layout LyX-Code
20684 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
20685 \begin_inset Newline newline
20691 \begin_layout Standard
20692 Modify the lines accordingly if you install \SpecialChar LyX
20693 somewhere else than in the
20694 Applications folder.
20697 \begin_layout Standard
20698 Reverse search is triggered by Alt-click (OPTION-click).
20701 \begin_layout Subsubsection*
20705 \begin_layout Standard
20707 \begin_inset Flex Code
20710 \begin_layout Plain Layout
20711 open -a Skim.app $$i
20716 to the viewer setting in
20717 \begin_inset Flex Noun
20720 \begin_layout Plain Layout
20721 Preferences\SpecialChar menuseparator
20722 File Handling\SpecialChar menuseparator
20723 File formats\SpecialChar menuseparator
20730 \begin_inset Flex Noun
20733 \begin_layout Plain Layout
20734 Skim\SpecialChar menuseparator
20735 Preferences\SpecialChar menuseparator
20742 \begin_inset Flex Noun
20745 \begin_layout Plain Layout
20751 preset and enter command
20752 \begin_inset Flex Noun
20755 \begin_layout Plain Layout
20756 /Applications/\SpecialChar LyX
20757 .app/Contents/MacOS/lyxeditor
20765 \begin_layout Standard
20766 Reverse search is triggered by COMMAND-SHIFT-click
20769 \begin_layout Subsubsection*
20773 \begin_layout Standard
20774 Reverse search with evince does not work out of the box, but it can be achieved
20775 by means of some third party helper scripts.
20777 \begin_inset CommandInset href
20779 target "https://wiki.lyx.org/LyX/SyncTeX"
20787 \begin_layout Subsubsection*
20791 \begin_layout Standard
20793 \begin_inset Flex Noun
20796 \begin_layout Plain Layout
20797 Settings\SpecialChar menuseparator
20798 Configure Okular\SpecialChar menuseparator
20805 \begin_inset Quotes erd
20809 This inserts the appropriate command (
20810 \begin_inset Flex Code
20813 \begin_layout Plain Layout
20822 \begin_layout Standard
20823 Reverse search is triggered by SHIFT-click.
20825 \change_inserted -712698321 1578211026
20826 Note that this only works if Okular is in
20827 \begin_inset Quotes eld
20831 \begin_inset Quotes erd
20835 \begin_inset space \thinspace{}
20838 e., the hand symbol is clicked).
20843 \begin_layout Subsubsection*
20847 \begin_layout Standard
20848 Qpdfview supports Sync\SpecialChar TeX
20849 since version 0.3.5.
20851 \begin_inset Flex Noun
20854 \begin_layout Plain Layout
20855 Edit\SpecialChar menuseparator
20856 Settings\SpecialChar menuseparator
20862 , click on the input field of the
20863 \begin_inset Quotes eld
20867 \begin_inset Quotes erd
20870 item and add the command
20871 \begin_inset Flex Code
20874 \begin_layout Plain Layout
20883 \begin_layout Standard
20884 Reverse search is triggered by double-click or, in more recent versions,
20888 \begin_layout Subsubsection*
20892 \begin_layout Standard
20893 Launch yap, choose its
20894 \begin_inset Flex Noun
20897 \begin_layout Plain Layout
20898 View\SpecialChar menuseparator
20904 menu and select the
20905 \begin_inset Quotes eld
20909 \begin_inset Quotes erd
20914 \begin_inset Quotes eld
20917 New\SpecialChar ldots
20919 \begin_inset Quotes erd
20922 button and, in the window that opens, enter
20923 \begin_inset Quotes eld
20928 \begin_inset Quotes erd
20931 (or any other name you like) in the
20932 \begin_inset Quotes eld
20936 \begin_inset Quotes erd
20940 Now click on the button labeled
20941 \begin_inset Quotes eld
20946 \begin_inset Quotes erd
20949 to open a file dialog and navigate to the directory containing the batch
20951 \begin_inset Flex Code
20954 \begin_layout Plain Layout
20962 \begin_inset Flex Code
20965 \begin_layout Plain Layout
20971 and then specify the program arguments as
20972 \begin_inset Flex Code
20975 \begin_layout Plain Layout
20983 \begin_inset Flex Code
20986 \begin_layout Plain Layout
20992 wrapper is used for communicating with \SpecialChar LyX
21000 \begin_layout LyX-Code
21002 \begin_inset Newline newline
21005 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
21014 \begin_inset Newline newline
21028 \begin_layout Standard
21029 Make sure that the \SpecialChar LyX
21030 Server pipe path you specified in \SpecialChar LyX
21032 \begin_inset Flex Code
21035 \begin_layout Plain Layout
21049 , otherwise change the
21050 \begin_inset Flex Code
21053 \begin_layout Plain Layout
21059 wrapper accordingly.
21062 \begin_layout Standard
21063 In yap, reverse search is triggered by double-click.
21066 \begin_layout Subsubsection*
21067 SumatraPDF (Windows)
21070 \begin_layout Standard
21071 In order to use SumatraPDF for inverse search, enter
21072 \begin_inset Flex Code
21075 \begin_layout Plain Layout
21076 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
21081 in the viewer setting in
21082 \begin_inset Flex Noun
21085 \begin_layout Plain Layout
21086 Preferences\SpecialChar menuseparator
21087 File Handling\SpecialChar menuseparator
21088 File formats\SpecialChar menuseparator
21095 \begin_inset Flex Code
21098 \begin_layout Plain Layout
21104 is the previous wrapper.
21105 If SumatraPDF.exe is not in your command PATH, use its full file name.
21108 \begin_layout Standard
21109 Reverse search is triggered by double-click.
21112 \begin_layout Subsubsection*
21116 \begin_layout Standard
21117 First of all, make sure that yap is your default DVI viewer in the Windows
21118 environment, then launch it, choose its
21119 \begin_inset Flex Noun
21122 \begin_layout Plain Layout
21123 View\SpecialChar menuseparator
21129 menu and select the
21130 \begin_inset Quotes eld
21134 \begin_inset Quotes erd
21139 \begin_inset Quotes eld
21142 New\SpecialChar ldots
21144 \begin_inset Quotes erd
21147 button and, in the window that opens, enter
21148 \begin_inset Quotes eld
21153 \begin_inset Quotes erd
21156 (or any other name you like) in the
21157 \begin_inset Quotes eld
21161 \begin_inset Quotes erd
21165 Now click on the button labeled
21166 \begin_inset Quotes eld
21171 \begin_inset Quotes erd
21174 to open a file dialog and navigate to the directory containing the
21175 \begin_inset Flex Code
21178 \begin_layout Plain Layout
21184 program (which is installed by default on Cygwin along with the \SpecialChar LyX
21187 \begin_inset Flex Code
21190 \begin_layout Plain Layout
21196 and then specify the program arguments as
21197 \begin_inset Flex Code
21200 \begin_layout Plain Layout
21207 In this way, you will be using the
21211 for communicating with \SpecialChar LyX
21213 If, for whatever reason, you want to use the
21218 \begin_inset Flex Code
21221 \begin_layout Plain Layout
21227 option and be sure to specify the \SpecialChar LyX
21228 Server pipe path in the \SpecialChar LyX
21232 \begin_layout Standard
21233 In yap, reverse search is triggered by double-click.
21236 \begin_layout Subsubsection*
21237 SumatraPDF (Cygwin)
21240 \begin_layout Standard
21241 In order to use SumatraPDF for inverse search, enter
21242 \begin_inset Flex Code
21245 \begin_layout Plain Layout
21246 SumatraPDF -inverse-search "lyxeditor -g %f %l"
21251 in the viewer setting in
21252 \begin_inset Flex Noun
21255 \begin_layout Plain Layout
21256 Preferences\SpecialChar menuseparator
21257 File Handling\SpecialChar menuseparator
21258 File formats\SpecialChar menuseparator
21265 If SumatraPDF.exe is not in your command PATH, use its full posix path.
21267 \begin_inset Flex Code
21270 \begin_layout Plain Layout
21276 enables communication via the
21282 \begin_inset Flex Code
21285 \begin_layout Plain Layout
21291 option if you want to use the
21295 , and be sure to specify the \SpecialChar LyX
21296 Server pipe path in the \SpecialChar LyX
21300 \begin_layout Standard
21301 Reverse search is triggered by double-click.
21304 \begin_layout Section
21308 \begin_layout Standard
21309 Forward search is, as the name implies, in a sense the
21310 \begin_inset Quotes eld
21314 \begin_inset Quotes erd
21318 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
21320 If forward search is set up (as described in what follows), you can put
21321 the cursor anywhere in your \SpecialChar LyX
21323 \begin_inset Flex Noun
21326 \begin_layout Plain Layout
21327 Navigate\SpecialChar menuseparator
21334 \begin_inset Flex Noun
21337 \begin_layout Plain Layout
21343 in the context menu via right mouse click), and then the viewer will jump
21344 to that position as well.
21345 This implies, of course, that your viewer supports this function.
21348 \begin_layout Standard
21349 To make forward search possible, you first need to provide the generated
21350 output PDF/DVI file with additional information about the \SpecialChar TeX
21352 This can be done via the methods described in the section
21353 \begin_inset CommandInset ref
21355 reference "subsec:rev-search"
21362 \begin_layout Standard
21363 Additionally, you need to configure \SpecialChar LyX
21364 for using your viewers in
21365 \begin_inset Flex Noun
21368 \begin_layout Plain Layout
21369 Tools\SpecialChar menuseparator
21370 Preferences\SpecialChar menuseparator
21371 Output\SpecialChar menuseparator
21378 We provide a range of tested configurations for some viewers, which you
21379 can select from the drop down list.
21380 If none of these configurations suits you, you have to find out and enter
21381 a suitable configuration yourself.
21382 The definition syntax uses the following placeholders:
21385 \begin_layout Itemize
21387 \begin_inset Flex Code
21390 \begin_layout Plain Layout
21399 \begin_layout Itemize
21401 \begin_inset Flex Code
21404 \begin_layout Plain Layout
21410 : name of the (temporary) exported .tex file (without path)
21413 \begin_layout Itemize
21415 \begin_inset Flex Code
21418 \begin_layout Plain Layout
21424 : name of the (temporary) exported .tex file (including path)
21427 \begin_layout Itemize
21429 \begin_inset Flex Code
21432 \begin_layout Plain Layout
21438 : name of the exported output file (either dvi or pdf, depending on which
21439 one exists in the temporary directory)
21442 \begin_layout Standard
21443 Note that only some of the viewers provide full and usable forward search
21444 functionality out of the box, among them yap, xdvi, okular
21448 \begin_layout Plain Layout
21449 You might want to set
21450 \begin_inset Flex Code
21453 \begin_layout Plain Layout
21460 \begin_inset Flex Noun
21463 \begin_layout Plain Layout
21464 Tools\SpecialChar menuseparator
21465 Preferences\SpecialChar menuseparator
21466 File Handling\SpecialChar menuseparator
21468 \begin_inset space ~
21481 , qpdfview, and SumatraPDF
21485 \begin_layout Plain Layout
21486 SumatraPDF can also use DDE commands through the external program CMCDDE
21487 — downloadable from
21488 \begin_inset CommandInset href
21490 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
21501 Others, such as evince
21505 \begin_layout Plain Layout
21506 Forward search with evince can be achieved by means of third party helper
21509 \begin_inset CommandInset href
21511 target "https://wiki.lyx.org/LyX/SyncTeX"
21521 , require some extra tools in order to use forward search.
21522 While many of the widespread PDF viewers (most notably Adobe Reader) do
21523 not support forward search at all, some other viewers – e.
21524 \begin_inset space \thinspace{}
21528 xpdf – allow at least to reload the document and jump to a specific page
21529 of the file, so you can at least navigate
21530 \begin_inset Quotes eld
21534 \begin_inset Quotes erd
21538 This latter functionality is provided by an external call of synctex (see
21539 the predefined example configurations).
21543 \begin_layout Standard
21544 Forward search works both with DVI and PDF output.
21546 simply checks which preview format you have used before (i.
21547 \begin_inset space \thinspace{}
21550 e., which format is already there in the temporary directory) and chooses
21551 the appropriate configuration for the respective format.
21554 \begin_layout Chapter
21556 \change_deleted 564990737 1671097409
21557 Special Document Classes
21562 \begin_layout Section
21564 \change_deleted 564990737 1669742044
21568 \begin_layout Standard
21570 \change_deleted 564990737 1669742044
21576 \begin_layout Subsection
21578 \change_deleted 564990737 1669742044
21582 \begin_layout Standard
21584 \change_deleted 564990737 1669742044
21585 This section describes how \SpecialChar LyX
21586 can be used to write articles for submission
21587 to the scientific journal
21589 Astronomy and Astrophysics
21592 \begin_inset Flex URL
21595 \begin_layout Plain Layout
21597 https://www.aanda.org/
21602 ) using Version 5.01 of the document class
21607 This package can be downloaded from the ftp site
21610 \begin_layout Standard
21612 \change_deleted 564990737 1669742044
21613 \begin_inset VSpace medskip
21619 \begin_layout Standard
21622 \change_deleted 564990737 1669742044
21623 \begin_inset Flex URL
21626 \begin_layout Plain Layout
21628 ftp://ftp.edpsciences.org/pub/aa/readme.html
21636 \begin_layout Standard
21638 \change_deleted 564990737 1669742044
21639 \begin_inset VSpace medskip
21645 \begin_layout Standard
21647 \change_deleted 564990737 1669742044
21648 A manual comes together with that package, and this text is not meant to
21649 replace the original manual but is merely a short guide in how to realize
21650 the correct form of your paper.
21654 \begin_layout Standard
21656 \change_deleted 564990737 1669742044
21657 Please note that the publisher of the journal was changed from Springer
21658 to EDP Sciences starting January 1, 2001.
21659 That change involved also some slight changes to the style files, namely
21660 the removal of the thesaurus command.
21661 The \SpecialChar LyX
21662 class aa supports the newest version of these style files, V 5.01.
21663 If you have an older version installed, please upgrade.
21664 For compatibility, the old (version 4) layout has been kept as
21669 Please refer to the comments in
21672 Dir/layouts/aapaper.layout
21677 \begin_layout Subsection
21679 \change_deleted 564990737 1669742044
21683 \begin_layout Standard
21685 \change_deleted 564990737 1669742044
21686 It is recommended you start from the example template distributed with \SpecialChar LyX
21688 If you are not using a template, note the following settings:
21691 \begin_layout Itemize
21693 \change_deleted 564990737 1669742044
21700 Document\SpecialChar menuseparator
21703 dialog (OK, that one was obvious).
21706 \begin_layout Itemize
21708 \change_deleted 564990737 1669742044
21709 Don't change the option
21712 \begin_inset space ~
21722 The whole layout is done by the macros, you shouldn't change anything.
21725 \begin_layout Subsection
21727 \change_deleted 564990737 1669742044
21731 \begin_layout Standard
21733 \change_deleted 564990737 1669742044
21734 First thing to enter is the header information.
21735 It consists of seven entries, of which some are optional.
21739 \begin_layout Itemize
21741 \change_deleted 564990737 1669742044
21749 \begin_layout Itemize
21751 \change_deleted 564990737 1669742044
21759 \begin_layout Itemize
21761 \change_deleted 564990737 1669742044
21769 \begin_layout Itemize
21771 \change_deleted 564990737 1669742044
21779 \begin_layout Itemize
21781 \change_deleted 564990737 1669742044
21786 : [optional] if more than one author: whom to contact for offprint requests.
21789 \begin_layout Itemize
21791 \change_deleted 564990737 1669742044
21796 : [optional] mail address for contacts.
21799 \begin_layout Itemize
21801 \change_deleted 564990737 1669742044
21807 Suggested format is
21809 Received: <date>; Accepted <date>
21812 \begin_layout Standard
21814 \change_deleted 564990737 1669742044
21815 There is no need to issue the
21821 command, this is done automatically by \SpecialChar LyX
21822 when the header is finished.
21823 Although the order of the single header entries doesn't matter it is advised
21824 to keep the above sequence, just to get the best optics and meets the layout
21825 of the real document.
21828 \begin_layout Standard
21830 \change_deleted 564990737 1669742044
21831 If you want to place footnotes in the header block, e.
21832 \begin_inset space \thinspace{}
21836 \begin_inset space \space{}
21839 to state your present address, just use the standard footnote via the menu
21842 Insert\SpecialChar menuseparator
21847 will automagically use the term
21856 \begin_layout Standard
21858 \change_deleted 564990737 1669742044
21861 Edit\SpecialChar menuseparator
21864 , you'll find two insets which are relevant for the titling:
21867 \begin_layout Itemize
21869 \change_deleted 564990737 1669742044
21876 to mark corresponding author\SpecialChar breakableslash
21878 The institutes are numbered sequentially as they appear in the
21882 field, so you have to put a marker to each author.
21885 \begin_layout Itemize
21887 \change_deleted 564990737 1669742044
21892 to supply an email address for fast contact.
21895 \begin_layout Standard
21897 \change_deleted 564990737 1669742044
21898 In addition to these topics, the macros use one additional \SpecialChar LaTeX
21900 has no counterpart in \SpecialChar LyX
21904 \begin_layout Itemize
21906 \change_deleted 564990737 1669742044
21913 to separate different names for more than one author and institute, respectivel
21917 \begin_layout Standard
21919 \change_deleted 564990737 1669742044
21920 The appropriate command has to be entered in \SpecialChar LyX
21921 and marked as \SpecialChar LaTeX
21927 \begin_layout Subsection
21929 \change_deleted 564990737 1669742044
21933 \begin_layout Standard
21935 \change_deleted 564990737 1669742044
21936 The abstract should immediately follow the header block.
21937 With version 5 the abstract environment was changed to a command, and there
21938 is now a restriction to only one paragraph.
21939 In addition, it should contain an entry with the keywords.
21940 This is done via the paragraph style
21945 Refer to the example paper.
21948 \begin_layout Subsection
21950 \change_deleted 564990737 1669742044
21951 Supported environments
21954 \begin_layout Standard
21956 \change_deleted 564990737 1669742044
21957 The A&A paper layout supports the following environments for structuring
21961 \begin_layout Itemize
21963 \change_deleted 564990737 1669742044
21969 \begin_layout Itemize
21971 \change_deleted 564990737 1669742044
21977 \begin_layout Itemize
21979 \change_deleted 564990737 1669742044
21985 \begin_layout Itemize
21987 \change_deleted 564990737 1669742044
21993 \begin_layout Itemize
21995 \change_deleted 564990737 1669742044
22001 \begin_layout Itemize
22003 \change_deleted 564990737 1669742044
22009 \begin_layout Itemize
22011 \change_deleted 564990737 1669742044
22017 \begin_layout Itemize
22019 \change_deleted 564990737 1669742044
22025 \begin_layout Itemize
22027 \change_deleted 564990737 1669742044
22033 \begin_layout Itemize
22035 \change_deleted 564990737 1669742044
22041 \begin_layout Itemize
22043 \change_deleted 564990737 1669742044
22049 \begin_layout Itemize
22051 \change_deleted 564990737 1669742044
22058 \begin_layout Subsection
22060 \change_deleted 564990737 1669742044
22061 Commands not supported by \SpecialChar LyX
22065 \begin_layout Standard
22067 \change_deleted 564990737 1669742044
22068 Some commands are not yet supported by the
22072 layout for \SpecialChar LyX
22074 Some have already been mentioned.
22075 For the sake of completeness, they are listed all together here:
22078 \begin_layout Itemize
22080 \change_deleted 564990737 1669742044
22088 \begin_layout Itemize
22090 \change_deleted 564990737 1669742044
22098 \begin_layout Itemize
22100 \change_deleted 564990737 1669742044
22108 \begin_layout Itemize
22110 \change_deleted 564990737 1669742044
22118 \begin_layout Standard
22120 \change_deleted 564990737 1669742044
22121 If you want to use any of these commands, you have to enter them yourself.
22124 Do not forget to mark them as \SpecialChar LaTeX
22128 \begin_layout Subsection
22130 \change_deleted 564990737 1669742044
22131 Figure and Table Floats
22134 \begin_layout Standard
22136 \change_deleted 564990737 1669742044
22138 provides support for the necessary float environments
22140 figure, figure*, table
22146 , therefore we won't tell much about it here.
22150 \begin_inset space ~
22156 Just remember that tables should be left-aligned.
22157 For that, select the table and change the alignment in
22159 Edit\SpecialChar menuseparator
22161 \begin_inset space ~
22167 \begin_layout Standard
22169 \change_deleted 564990737 1669742044
22170 There is only one special thing: the figures with caption besides the figure.
22171 To create such a figure, you have to do the following:
22174 \begin_layout Enumerate
22176 \change_deleted 564990737 1669742044
22177 Create a wide figure float:
22179 Insert\SpecialChar menuseparator
22180 Float\SpecialChar menuseparator
22183 , then right click in the figure and select
22186 \begin_inset space ~
22194 \begin_layout Enumerate
22196 \change_deleted 564990737 1669742044
22197 Enter your caption text.
22200 \begin_layout Enumerate
22202 \change_deleted 564990737 1669742044
22207 to move the cursor above the caption.
22210 \begin_layout Enumerate
22212 \change_deleted 564990737 1669742044
22216 \begin_layout Enumerate
22218 \change_deleted 564990737 1669742044
22219 Position the cursor behind the figure and insert a horizontal fill:
22221 Insert\SpecialChar menuseparator
22223 \begin_inset space ~
22226 Character\SpecialChar menuseparator
22228 \begin_inset space ~
22236 \begin_layout Enumerate
22238 \change_deleted 564990737 1669742044
22239 Switch to \SpecialChar LaTeX
22243 \begin_inset space ~
22251 \begin_layout Enumerate
22253 \change_deleted 564990737 1669742044
22263 Do not close the brace!
22266 \begin_layout Enumerate
22268 \change_deleted 564990737 1669742044
22269 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
22274 \begin_inset space ~
22286 \begin_layout Standard
22288 \change_deleted 564990737 1669742044
22289 Also, refer to the figures in the example paper.
22292 \begin_layout Subsection
22294 \change_deleted 564990737 1669742044
22298 \begin_layout Standard
22300 \change_deleted 564990737 1669742044
22301 For submission, the paper has to be formated in a special double-spacing
22303 For this purpose, you have to give the option
22307 to the document class.
22308 This must be done using the custom class options field in the
22310 Document\SpecialChar menuseparator
22314 Just enter the string
22321 \begin_layout Subsection
22323 \change_deleted 564990737 1669742044
22327 \begin_layout Standard
22329 \change_deleted 564990737 1669742044
22334 directory contains an example paper written with \SpecialChar LyX
22336 It is the example paper from the original macro package, translated to
22339 Use it for inspiration, and compare the original \SpecialChar LaTeX
22340 code with \SpecialChar LyX
22344 \begin_layout Section
22346 \change_deleted 564990737 1671097429
22350 \begin_layout Standard
22352 \change_deleted 564990737 1671097429
22357 can be used to type letters according to German conventions.
22358 A template file is included in
22360 .../lyx/share/templates
22362 for you to use as a starting point.
22365 \begin_layout Section
22367 \change_deleted 564990737 1671097429
22371 \begin_layout Standard
22373 \change_deleted 564990737 1671097429
22374 See the \SpecialChar LyX
22380 It contains all infos you need.
22383 \begin_layout Section
22385 \change_deleted 564990737 1669755802
22389 \begin_layout Standard
22391 \change_deleted 564990737 1669755802
22394 Panayotis Papasotiriou
22397 \begin_layout Subsection
22399 \change_deleted 564990737 1669755802
22403 \begin_layout Standard
22405 \change_deleted 564990737 1669755802
22406 The ijmpc package is a set of macros that facilitates electronic manuscript
22409 International Journal of Modern Physics C
22412 Similarly, the ijmpd package is for creating manuscripts to be submitted
22415 International Journal of Modern Physics D
22418 Both journals are published by World Scientific.
22419 The corresponding document classes are named
22428 These files, together with instructions for the authors, can be downloaded
22430 \begin_inset Flex URL
22433 \begin_layout Plain Layout
22435 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
22441 \begin_inset Flex URL
22444 \begin_layout Plain Layout
22446 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
22452 Both packages are modified versions of the standard
22453 \begin_inset Quotes eld
22457 \begin_inset Quotes erd
22460 package, and they are almost (but not exactly) identical.
22461 Most of their features are supported by \SpecialChar LyX
22463 I have used \SpecialChar LyX
22464 successfully to write articles submitted to both journals
22465 without any problem.
22468 \begin_layout Subsection
22470 \change_deleted 564990737 1669755802
22474 \begin_layout Standard
22476 \change_deleted 564990737 1669755802
22477 As usual, the easiest way to write a paper is to start with a template.
22480 File\SpecialChar menuseparator
22496 This will give an (almost) empty document that includes the most common
22497 fields found in a manuscript.
22498 Simply overwrite the existing text (including the brackets,
22503 You should keep in mind the following remarks.
22506 \begin_layout Enumerate
22508 \change_deleted 564990737 1669755802
22510 won't let you change the font size and the page style of the document,
22511 because such modifications are not allowed by both packages.
22514 \begin_layout Enumerate
22516 \change_deleted 564990737 1669755802
22517 The language of the document should not be changed.
22518 Before previewing your paper, be sure that the babel package is not used.
22519 To do this, click on
22522 arg "dialog-show document"
22527 \SpecialChar menuseparator
22531 \begin_inset Quotes eld
22535 \begin_inset Quotes erd
22545 \begin_layout Enumerate
22547 \change_deleted 564990737 1669755802
22549 \begin_inset Quotes eld
22553 \begin_inset Quotes erd
22556 style must be used to define keywords.
22559 \begin_layout Enumerate
22561 \change_deleted 564990737 1669755802
22562 The ijmpc package provides a style named
22563 \begin_inset Quotes eld
22566 Classification Codes
22567 \begin_inset Quotes erd
22570 , which can be used to define classification codes, such as PACS numbers.
22571 Note that this facility is not supported by the ijmpd package.
22574 \begin_layout Enumerate
22576 \change_deleted 564990737 1669755802
22577 Several new environments are available:
22578 \begin_inset Quotes eld
22582 \begin_inset Quotes erd
22586 \begin_inset Quotes eld
22590 \begin_inset Quotes erd
22594 \begin_inset Quotes eld
22598 \begin_inset Quotes erd
22602 \begin_inset Quotes eld
22606 \begin_inset Quotes erd
22610 \begin_inset Quotes eld
22614 \begin_inset Quotes erd
22618 \begin_inset Quotes eld
22622 \begin_inset Quotes erd
22626 \begin_inset Quotes eld
22630 \begin_inset Quotes erd
22634 \begin_inset Quotes eld
22638 \begin_inset Quotes erd
22642 \begin_inset Quotes eld
22646 \begin_inset Quotes erd
22650 \begin_inset Quotes eld
22654 \begin_inset Quotes erd
22658 \begin_inset Quotes eld
22662 \begin_inset Quotes erd
22666 \begin_inset Quotes eld
22670 \begin_inset Quotes erd
22674 \begin_inset Quotes eld
22678 \begin_inset Quotes erd
22682 \begin_inset Quotes eld
22686 \begin_inset Quotes erd
22690 Their use is more or less obvious.
22692 supports all these environments; it will use the proper label, text style,
22693 and numbering scheme for each of them.
22696 \begin_layout Enumerate
22698 \change_deleted 564990737 1669755802
22699 Both packages use basic citations; the natbib package should not be used.
22700 In \SpecialChar LyX
22701 , citation references are shown as usual; in the output, citations are
22702 shown as superscripts.
22703 If you want to use a citation as normal text, you should use the
22708 \begin_inset space \thinspace{}
22712 \begin_inset space \space{}
22716 \begin_inset Quotes eld
22720 \begin_inset space \space{}
22730 \begin_inset Quotes erd
22736 \begin_layout Enumerate
22738 \change_deleted 564990737 1669755802
22740 \begin_inset Quotes eld
22744 \begin_inset Quotes erd
22747 section in both packages.
22748 To put acknowledgments, just use the
22749 \begin_inset Quotes eld
22753 \begin_inset Quotes erd
22759 \begin_layout Enumerate
22761 \change_deleted 564990737 1669755802
22762 Appendices may be added to the paper,
22766 the Acknowledgments and
22772 provides a special environment, called
22773 \begin_inset Quotes eld
22777 \begin_inset Quotes erd
22780 which marks the beginning of the appendices.
22781 This environment should be left blank; it just sends a \SpecialChar LaTeX
22782 command, but nothing
22784 In \SpecialChar LyX
22786 \begin_inset Quotes eld
22790 \begin_inset Quotes erd
22793 is printed with blue letters, as a signal that all sections after that
22794 point are appendices.
22795 To write an appendix, use the
22796 \begin_inset Quotes eld
22800 \begin_inset Quotes erd
22805 will number each appendix with capital letters, as required by both journals.
22807 \begin_inset Quotes eld
22811 \begin_inset Quotes erd
22818 be present before the first appendix; if not, all appendices will be numbered
22819 as normal sections in the output.
22822 \begin_layout Enumerate
22824 \change_deleted 564990737 1669755802
22825 The ijmpc and the ijmpd packages use the
22829 command to implement table captions.
22830 As a result, a table created by \SpecialChar LyX
22831 is printed correctly, but its caption
22833 However, you can use some \SpecialChar TeX
22834 code to overcome this problem, so that captions
22835 are printed as expected.
22836 To do so, create a float table as usual, remove the caption, and replace
22837 it with the \SpecialChar TeX
22848 (sic); you must also the \SpecialChar TeX
22853 immediately after the tabular material.
22854 Study the example table included in the template files to see how this
22855 trick is implemented.
22856 Alternatively, If you need table captions, you should implement the whole
22861 file, then include this file to the \SpecialChar LyX
22864 Insert\SpecialChar menuseparator
22865 File\SpecialChar menuseparator
22867 \begin_inset space ~
22873 Details on how to create a table float can be found in the files
22881 , included in the corresponding packages.
22884 \begin_layout Subsection
22886 \change_deleted 564990737 1669755802
22887 Preparing a paper for submission
22890 \begin_layout Standard
22892 \change_deleted 564990737 1669755802
22893 Before you submit your paper you must export the \SpecialChar LyX
22894 document as a \SpecialChar LaTeX
22897 File\SpecialChar menuseparator
22898 Export\SpecialChar menuseparator
22906 \begin_layout Plain Layout
22907 Actually you have the choice between \SpecialChar LaTeX
22908 (plain) and pdflatex.
22909 If you intend to use pdflatex to prepare the paper, you should use the
22910 pdflatex option so that included graphics are converted to PDF format,
22911 ready for use by pdflatex.
22916 , then make the following changes to the resulting
22923 \begin_layout Enumerate
22925 \change_deleted 564990737 1669755802
22926 Remove the comment lines before the
22935 \begin_layout Enumerate
22937 \change_deleted 564990737 1669755802
22938 Remove everything between (and including) the
22950 commands, except for any commands you specifically put into the \SpecialChar LaTeX
22954 \begin_layout Standard
22956 \change_deleted 564990737 1669755802
22961 file should be saved and processed through \SpecialChar LaTeX
22962 as many times as necessary.
22963 You may also want to check the resulting
22972 \begin_layout Section
22974 \change_deleted 564990737 1669801478
22978 \begin_layout Standard
22980 \change_deleted 564990737 1669801478
22986 \begin_layout Subsection
22988 \change_deleted 564990737 1669801478
22992 \begin_layout Standard
22994 \change_deleted 564990737 1669801478
22995 The iopart package provides a document class to create electronic manuscript
22996 submission to the journals published by the Institute of Physics.
22997 Instructions for the authors how to create a paper using the iopart class
22998 can be downloaded together with the iopart package from the site
22999 \begin_inset Flex URL
23002 \begin_layout Plain Layout
23004 ftp://ftp.iop.org/pub/journals/latex2e
23012 \begin_layout Subsection
23014 \change_deleted 564990737 1669801478
23018 \begin_layout Standard
23020 \change_deleted 564990737 1669801478
23021 The easiest way to write a paper is to start with the template
23025 that is available via
23027 File\SpecialChar menuseparator
23030 The template explains how to use the special text environments.
23031 Here are the most important advices:
23034 \begin_layout Itemize
23036 \change_deleted 564990737 1669801478
23037 To be able to compile your document to a PDF, PS, or DVI, ensure that the
23038 no AMS packages are loaded in
23040 Document\SpecialChar menuseparator
23041 Settings\SpecialChar menuseparator
23047 \begin_layout Itemize
23049 \change_deleted 564990737 1669801478
23052 The title environment defines the kind of your paper.
23053 So use one of the following environments for the title:
23057 \begin_layout Itemize
23059 \change_deleted 564990737 1669801478
23068 \begin_layout Itemize
23070 \change_deleted 564990737 1669801478
23079 \begin_layout Itemize
23081 \change_deleted 564990737 1669801478
23087 for a Topical review
23090 \begin_layout Itemize
23092 \change_deleted 564990737 1669801478
23101 \begin_layout Itemize
23103 \change_deleted 564990737 1669801478
23112 \begin_layout Itemize
23114 \change_deleted 564990737 1669801478
23120 for a Paper (same as Title)
23123 \begin_layout Itemize
23125 \change_deleted 564990737 1669801478
23131 for a Preliminary communication
23134 \begin_layout Itemize
23136 \change_deleted 564990737 1669801478
23142 for a Rapid communication
23145 \begin_layout Itemize
23147 \change_deleted 564990737 1669801478
23153 for a Letter to the editor
23157 \begin_layout Itemize
23159 \change_deleted 564990737 1669801478
23162 All title environments except of
23166 can have an optional short title.
23169 \begin_layout Itemize
23171 \change_deleted 564990737 1669801478
23172 There is a general title environment
23176 which is not directly supported by \SpecialChar LyX
23178 This can be used as \SpecialChar TeX
23179 code when your document doesn't fit into one of the
23183 \begin_layout Standard
23185 \change_deleted 564990737 1669801478
23186 For more informations like hints for special table and formula formatting,
23187 look at the IOP author guidelines.
23192 \begin_layout Section
23194 \change_deleted 564990737 1670317155
23198 \begin_layout Standard
23200 \change_deleted 564990737 1670317155
23203 Panayotis Papasotiriou
23206 \begin_layout Subsection
23208 \change_deleted 564990737 1670317155
23212 \begin_layout Standard
23214 \change_deleted 564990737 1670317155
23215 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
23216 that facilitates electronic manuscript submission to the journals they
23218 Most known of them (at least in my domain of interest) are
23220 Astrophysics and Space Science
23226 , but there are many others (see a complete list at
23227 \begin_inset Flex URL
23230 \begin_layout Plain Layout
23232 http://www.wkap.nl/jrnllist.htm/JRNLHOME
23238 The Kluwer package may be downloaded from the site
23239 \begin_inset Flex URL
23242 \begin_layout Plain Layout
23244 http://www.wkap.nl/kaphtml.htm/STYLEFILES
23250 A complete user guide is contained in that package (but it can also be
23251 downloaded separately).
23254 \begin_layout Standard
23256 \change_deleted 564990737 1670317155
23258 supports many features of the package but not everything.
23259 However, the \SpecialChar TeX
23260 code needed is reduced to some
23261 \begin_inset Quotes eld
23265 \begin_inset Quotes erd
23268 commands of the package (see
23269 \begin_inset space ~
23273 \begin_inset CommandInset ref
23275 reference "subsec:kluwer_peculiarities"
23280 I have recently used \SpecialChar LyX
23281 to write an article submitted to the
23283 Astrophysics and Space Science
23285 without any problem.
23288 \begin_layout Subsection
23290 \change_deleted 564990737 1670317155
23294 \begin_layout Standard
23296 \change_deleted 564990737 1670317155
23297 The easiest way to write a paper is to start with the Kluwer template file.
23300 File\SpecialChar menuseparator
23312 This will give an (almost) empty document that includes the most common
23313 fields found in a manuscript and a short description of their use.
23314 As in most templates, simply overwrite the existing text (including the
23319 ) with the correct information.
23322 \begin_layout Subsection
23324 \change_deleted 564990737 1670317155
23325 Preparing a paper for submission
23328 \begin_layout Standard
23330 \change_deleted 564990737 1670317155
23331 As in the AAS\SpecialChar TeX
23332 package, before you submit your paper to a journal you must
23334 \begin_inset Quotes eld
23338 \begin_inset Quotes erd
23344 \begin_layout Enumerate
23346 \change_deleted 564990737 1670317155
23347 Export your paper as a \SpecialChar LaTeX
23349 To do this, click on
23351 File\SpecialChar menuseparator
23352 Export\SpecialChar menuseparator
23360 \begin_layout Enumerate
23362 \change_deleted 564990737 1670317155
23367 file with a text editor and make the following changes
23371 \begin_layout Enumerate
23373 \change_deleted 564990737 1670317155
23374 remove the comment lines before the
23383 \begin_layout Enumerate
23385 \change_deleted 564990737 1670317155
23386 remove everything between (and including) the
23398 commands, except for any commands you specifically put into the \SpecialChar LaTeX
23402 \begin_layout Standard
23404 \change_deleted 564990737 1670317155
23413 \begin_layout Enumerate
23415 \change_deleted 564990737 1670317155
23420 file through \SpecialChar LaTeX
23421 as many times as necessary (usually up to three).
23424 \begin_layout Enumerate
23426 \change_deleted 564990737 1670317155
23432 \begin_inset space \thinspace{}
23436 \begin_inset space \space{}
23443 , and check if everything is OK (it should, if you didn't make any mistake).
23446 \begin_layout Subsection
23448 \change_deleted 564990737 1670317155
23449 \begin_inset Quotes eld
23453 \begin_inset Quotes erd
23456 of the Kluwer package
23457 \begin_inset CommandInset label
23459 name "subsec:kluwer_peculiarities"
23466 \begin_layout Standard
23468 \change_deleted 564990737 1670317155
23469 The Kluwer package has the following
23470 \begin_inset Quotes eld
23474 \begin_inset Quotes erd
23480 \begin_layout Enumerate
23482 \change_deleted 564990737 1670317155
23483 It is possible to write multiple articles in the same \SpecialChar LaTeX
23488 \begin_layout Plain Layout
23489 I can't imagine any good reason to do this.
23495 Each article must be included in the environment
23496 \begin_inset Quotes eld
23500 \begin_inset Quotes erd
23504 Unfortunately, this environment cannot be omitted, even if you write just
23506 Therefore, each article starts with the command
23512 and, obviously, ends with the command
23519 Although this can be implemented in \SpecialChar LyX
23520 , I didn't included it, since it looks
23521 ugly and can confuse the novice user.
23522 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
23525 \begin_inset Quotes eld
23530 \begin_inset Quotes erd
23536 \begin_layout Enumerate
23538 \change_deleted 564990737 1670317155
23539 Information given at the beginning of the article (i.
23540 \begin_inset space \thinspace{}
23544 \begin_inset space \space{}
23547 title, subtitle, author, institution, running title, running author, abstract
23548 and keywords) must be included in an environment called
23549 \begin_inset Quotes eld
23553 \begin_inset Quotes erd
23557 This is not implemented in \SpecialChar LyX
23558 , so you must enter title, subtitle etc.
23559 \begin_inset space ~
23562 between two \SpecialChar TeX
23578 \begin_layout Enumerate
23580 \change_deleted 564990737 1670317155
23581 According to the user manual, the label of each bibliography item must be
23605 \begin_layout Standard
23607 \change_deleted 564990737 1670317155
23612 template takes care of all these
23613 \begin_inset Quotes eld
23617 \begin_inset Quotes erd
23621 If you start a new paper using this template you don't need to do anything
23626 \begin_layout Enumerate
23628 \change_deleted 564990737 1670317155
23629 don't delete the \SpecialChar TeX
23630 code included in the template, and
23633 \begin_layout Enumerate
23635 \change_deleted 564990737 1670317155
23636 copy the example bibliography item included in the template and modify it
23637 as necessary to enter new bibliography items.
23640 \begin_layout Section
23642 \change_deleted 564990737 1671097446
23646 \begin_layout Standard
23648 \change_deleted 564990737 1671097446
23653 provides an alternative to the standard
23658 It provides similar functionality, but you might prefer this layout with
23659 sans serif sections, headings, and more.
23662 \begin_layout Section
23664 \change_deleted 564990737 1671097446
23665 Springer Journals (
23672 \begin_layout Standard
23674 \change_deleted 564990737 1671097446
23680 \begin_layout Subsection
23682 \change_deleted 564990737 1671097446
23686 \begin_layout Standard
23688 \change_deleted 564990737 1671097446
23689 These are the layout files for some of the journal formats used by Springer
23690 Verlag and listed on
23691 \begin_inset Flex URL
23694 \begin_layout Plain Layout
23696 http://www.springer.de/author/tex/help-journals.html
23701 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
23703 It is a modular system: the things common to all journals are implemented
23708 , which journal-specific layout files (such as, e.
23709 \begin_inset space \thinspace{}
23713 \begin_inset space \space{}
23720 for Journal of Geodesy) can include.
23723 \begin_layout Standard
23725 \change_deleted 564990737 1671097446
23726 This means that implementing support for any other Springer journal on this
23727 list is as simple as writing your own
23735 file following the outline given in
23743 \begin_layout Standard
23745 \change_deleted 564990737 1671097446
23746 It is reasonably well tested only for the Journal of Geodesy.
23755 come with the standard \SpecialChar LyX
23757 Install the relevant class file (downloaded from Springer) in a proper
23758 directory, reconfigure \SpecialChar LaTeX
23759 (in the te\SpecialChar TeX
23764 , as root if necessary — doesn't \SpecialChar LyX
23765 take care of this?), reconfigure \SpecialChar LyX
23770 \begin_layout Subsection
23772 \change_deleted 564990737 1671097446
23776 \begin_layout Standard
23778 \change_deleted 564990737 1671097446
23779 A large number of theorem-like styles —
23791 \begin_layout Standard
23793 \change_deleted 564990737 1671097446
23796 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
23797 _Title, Author_Running, Institute,
23798 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
23801 See the Springer class file documentation for details.
23804 \begin_layout Subsection
23806 \change_deleted 564990737 1671097446
23810 \begin_layout Itemize
23812 \change_deleted 564990737 1671097446
23824 \begin_layout Itemize
23826 \change_deleted 564990737 1671097446
23829 Probability Theory and Related Fields
23835 — Jean-Marc Lasgouttes
23838 \begin_layout Standard
23840 \change_deleted 564990737 1671097446
23841 Add your own, it isn't so hard!
23844 \begin_layout Subsection
23846 \change_deleted 564990737 1671097446
23850 \begin_layout Standard
23852 \change_deleted 564990737 1671097446
23853 These files are partly based on the older
23857 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
23859 file from Springer.
23864 layout, are now defunct.
23865 Jean-Marc Lasgouttes helped out big in making me find my way around the
23867 layout file mechanism.
23870 \begin_layout Subsection
23872 \change_deleted 564990737 1671097446
23876 \begin_layout Standard
23878 \change_deleted 564990737 1671097446
23880 But probably less than in the old hacked-\SpecialChar LaTeX
23888 \begin_layout Chapter
23890 Features needing Extra Software
23893 \begin_layout Section
23894 Checking \SpecialChar TeX
23898 \begin_layout Standard
23904 \begin_layout Subsection
23908 \begin_layout Standard
23917 \begin_layout Plain Layout
23922 is not yet available when you are using the \SpecialChar LaTeX
23923 distribution MiK\SpecialChar TeX
23929 , you'll find in the
23936 \begin_inset space ~
23947 \begin_inset Newline newline
23951 \begin_inset CommandInset href
23953 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
23961 \begin_layout Standard
23964 Chk\SpecialChar TeX
23967 package is a program that was written by
23968 \begin_inset Flex Noun
23971 \begin_layout Plain Layout
23973 \begin_inset space ~
23981 in frustration because some constructs in \SpecialChar LaTeX
23982 are sometimes non-intuitive,
23983 and easy to forget.
23984 The program runs over your \SpecialChar LaTeX
23985 file, checks the integrity of the file, and
23986 flags some common errors.
23987 In other technical words, it is
23991 for \SpecialChar LaTeX
23995 \begin_layout Standard
23996 Well, what is a syntax checker doing in \SpecialChar LyX
23997 which is supposed to produce correct
23999 anyways? The answer is simple: Just as
24003 not only checks the
24007 of C programs, but also does
24011 checks for type-errors,
24013 Chk\SpecialChar TeX
24016 catches some common
24020 errors, in addition to the syntactical ones.
24023 Chk\SpecialChar TeX
24026 is capable of detecting several common errors, such as
24029 \begin_layout Itemize
24030 Ellipsis detection:
24031 \begin_inset Newline newline
24034 Use \SpecialChar ldots
24038 \begin_layout Itemize
24039 No space in front of/after parenthesis:
24040 \begin_inset Newline newline
24046 \begin_layout Itemize
24047 Enforcement of normal space after common abbreviations:
24048 \begin_inset Newline newline
24052 \begin_inset space \thinspace{}
24056 \begin_inset space \space{}
24059 is too wide spacing.
24062 \begin_layout Itemize
24063 Enforcement of end-of-sentence space when the last sentence ends with a
24065 \begin_inset Newline newline
24069 And this is wrong spacing.
24072 \begin_layout Itemize
24073 Space in front of labels and similar commands:
24074 \begin_inset Newline newline
24077 The label should stick right up to the text to avoid falling to a wrong
24080 \begin_inset CommandInset label
24090 \begin_layout Plain Layout
24091 This footnote is in danger of falling off to a wrong page
24096 The label is separated too much.
24099 \begin_layout Itemize
24100 Space in front of references, instead of hard spaces:
24101 \begin_inset Newline newline
24104 If you have bad luck, the text will break right between the referenced text
24105 and reference number, and that's a pity.
24107 \begin_inset CommandInset ref
24109 reference "sec:chktex"
24116 \begin_layout Itemize
24118 \begin_inset Quotes eld
24122 \begin_inset Quotes erd
24126 \begin_inset Formula $\times$
24130 \begin_inset Newline newline
24133 2x2 looks cheap compared to
24134 \begin_inset Formula $2\times2$
24140 \begin_layout Standard
24141 and more \SpecialChar ldots
24142 It is an invaluable tool when you are
24143 \begin_inset Quotes eld
24147 \begin_inset Quotes erd
24150 your document before printing, and you should run it right after the obligatory
24151 spelling check, and before you go fine tuning the typesetting.
24154 \begin_layout Subsection
24158 \begin_layout Standard
24159 If you have the program installed, usage is as simple as choosing
24161 Tools\SpecialChar menuseparator
24163 \begin_inset space ~
24169 This will make \SpecialChar LyX
24170 generate a \SpecialChar LaTeX
24171 file of your document, start
24173 Chk\SpecialChar TeX
24176 to check it, and then make \SpecialChar LyX
24178 \begin_inset Quotes eld
24182 \begin_inset Quotes erd
24185 with the warnings from
24187 Chk\SpecialChar TeX
24190 , if there were any.
24191 The warnings will be placed close to the point of the mistake, and you
24192 can quickly find them by using the
24194 Navigate\SpecialChar menuseparator
24197 menu item, or the shortcut key
24206 Open the error boxes by clicking on them with the mouse, or use the shortcut
24215 bindings, or the corresponding
24224 Read the warning and correct the mistake, if it is a mistake.
24225 If you have trouble understanding what the warning is about, you can safely
24227 Remember that there is a hidden layer between the document on screen and
24228 the technical details in invoking
24230 Chk\SpecialChar TeX
24233 , and this gap can make some warnings seem arcane or just plain silly.
24236 \begin_layout Standard
24237 This document is an excellent testing bed for the feature, and it should
24238 provide quite a few warnings for you to fiddle with.
24239 Since computers are only so smart, expect most of the warnings to be false
24243 \begin_layout Subsection
24244 How to fine tune it
24247 \begin_layout Standard
24248 Sometimes, you'll find that
24250 Chk\SpecialChar TeX
24253 makes more noise than suits your mood.
24254 Then you can choose not to use it, wait until your mood changes, or try
24257 Chk\SpecialChar TeX
24260 to get better along with you.
24263 \begin_layout Standard
24266 Chk\SpecialChar TeX
24273 very configurable and extensible, you should not expect to solve all problems
24276 Chk\SpecialChar TeX
24279 in \SpecialChar LyX
24281 Since \SpecialChar LyX
24282 has to generate a somewhat special \SpecialChar LaTeX
24283 file to be able to match the
24284 line numbers from the
24286 Chk\SpecialChar TeX
24293 \begin_layout Plain Layout
24294 You can inspect the specific output from
24300 Document\SpecialChar menuseparator
24303 \begin_inset space ~
24317 to the internal document structure, some of the warnings will not appear
24319 There are two things you can do about this:
24322 \begin_layout Itemize
24325 Chk\SpecialChar TeX
24328 invocation command line in
24329 \begin_inset Flex Noun
24332 \begin_layout Plain Layout
24333 Tools\SpecialChar menuseparator
24334 Preferences\SpecialChar menuseparator
24335 Output\SpecialChar menuseparator
24336 LaTeX\SpecialChar menuseparator
24344 Chk\SpecialChar TeX
24347 installation configuration file (usually with the file
24352 See below to learn what warnings can be enabled and disabled on the command
24356 \begin_layout Itemize
24357 Export your document as a raw \SpecialChar LaTeX
24360 File\SpecialChar menuseparator
24361 Export\SpecialChar menuseparator
24370 Invoked in this way, it can be a hassle to find the corresponding place
24371 in the document inside \SpecialChar LyX
24372 , but with a little patience, you should be able
24376 \begin_layout Standard
24377 Here follows the warning messages that can be enabled and disabled in
24386 to disable a warning, and
24390 to enable a warning.
24391 The emphasized entries are disabled by default, because the default is
24394 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
24399 \begin_layout Standard
24400 Notice that you should only use the options that enable and disable warnings,
24401 because \SpecialChar LyX
24402 relies on some of the other command line parameters to be set
24403 in a specific way to have a chance to communicate with
24410 \begin_layout Enumerate
24414 Command terminated with space.
24417 \begin_layout Enumerate
24420 Non-breaking space (
24421 \begin_inset Quotes eld
24429 \begin_inset Quotes erd
24432 ) should have been used.
24435 \begin_layout Enumerate
24439 You should enclose the previous parenthesis with
24440 \begin_inset Quotes eld
24448 \begin_inset Quotes erd
24454 \begin_layout Enumerate
24457 Italic correction (
24458 \begin_inset Quotes eld
24468 \begin_inset Quotes erd
24471 ) found in non-italic buffer.
24474 \begin_layout Enumerate
24477 Italic correction (
24478 \begin_inset Quotes eld
24488 \begin_inset Quotes erd
24491 ) found more than once.
24494 \begin_layout Enumerate
24498 No italic correction (
24499 \begin_inset Quotes eld
24509 \begin_inset Quotes erd
24515 \begin_layout Enumerate
24519 \begin_inset Quotes eld
24527 \begin_inset Quotes erd
24531 \begin_inset Quotes eld
24539 \begin_inset Quotes erd
24545 \begin_layout Enumerate
24548 Wrong length of dash may have been used.
24551 \begin_layout Enumerate
24555 \begin_inset Quotes eld
24563 \begin_inset Quotes erd
24567 \begin_inset Quotes eld
24575 \begin_inset Quotes erd
24581 \begin_layout Enumerate
24585 \begin_inset Quotes eld
24593 \begin_inset Quotes erd
24599 \begin_layout Enumerate
24603 \begin_inset Quotes eld
24611 \begin_inset Quotes erd
24614 to achieve an ellipsis.
24617 \begin_layout Enumerate
24620 Inter-word spacing (
24621 \begin_inset Quotes eld
24631 \begin_inset Quotes eld
24634 ) should perhaps be used.
24637 \begin_layout Enumerate
24640 Inter-sentence spacing (
24641 \begin_inset Quotes eld
24651 \begin_inset Quotes erd
24654 ) should perhaps be used.
24657 \begin_layout Enumerate
24660 Could not find argument for command.
24663 \begin_layout Enumerate
24667 \begin_inset Quotes eld
24675 \begin_inset Quotes erd
24681 \begin_layout Enumerate
24684 Math mode still on at end of \SpecialChar LaTeX
24688 \begin_layout Enumerate
24692 \begin_inset Quotes eld
24700 \begin_inset Quotes erd
24703 doesn't match the number of
24704 \begin_inset Quotes eld
24712 \begin_inset Quotes erd
24718 \begin_layout Enumerate
24721 You should use either
24724 \begin_inset Quotes eld
24732 \begin_inset Quotes erd
24737 as an alternative to
24738 \begin_inset Quotes eld
24746 \begin_inset Quotes erd
24752 \begin_layout Enumerate
24759 " (ASCII 39) instead of "
24766 \begin_layout Enumerate
24769 User-specified pattern found.
24772 \begin_layout Enumerate
24775 This command might not be intended.
24778 \begin_layout Enumerate
24785 \begin_layout Enumerate
24803 \begin_layout Enumerate
24806 Delete this space to maintain correct page references.
24809 \begin_layout Enumerate
24813 You might wish to put this between a pair of
24814 \begin_inset Quotes eld
24822 \begin_inset Quotes erd
24828 \begin_layout Enumerate
24831 You ought to remove spaces in front of punctuation.
24834 \begin_layout Enumerate
24837 Could not execute \SpecialChar LaTeX
24841 \begin_layout Enumerate
24850 in front of small punctuation.
24853 \begin_layout Enumerate
24861 may look prettier here.
24864 \begin_layout Enumerate
24868 Multiple spaces detected in output.
24871 \begin_layout Enumerate
24874 This text may be ignored.
24877 \begin_layout Enumerate
24883 \begin_inset Quotes eld
24888 to begin quotation, not
24895 \begin_layout Enumerate
24902 to end quotation, not
24905 \begin_inset Quotes eld
24913 \begin_layout Enumerate
24919 \begin_layout Enumerate
24922 You should perhaps use
24923 \begin_inset Quotes eld
24931 \begin_inset Quotes erd
24937 \begin_layout Enumerate
24940 You should put a space in front of/after parenthesis.
24943 \begin_layout Enumerate
24946 You should avoid spaces in front of/after parenthesis.
24949 \begin_layout Enumerate
24953 You should not use punctuation in front of/after quotes.
24956 \begin_layout Enumerate
24959 Double space found.
24962 \begin_layout Enumerate
24965 You should put punctuation outside inner/inside display math mode.
24968 \begin_layout Enumerate
24971 You ought to not use primitive \SpecialChar TeX
24972 in \SpecialChar LaTeX
24976 \begin_layout Enumerate
24979 You should remove spaces in front of
24980 \begin_inset Quotes eld
24988 \begin_inset Quotes erd
24994 \begin_layout Enumerate
24997 \begin_inset Quotes eld
25005 \begin_inset Quotes erd
25008 is normally not followed by
25009 \begin_inset Quotes eld
25017 \begin_inset Quotes erd
25023 \begin_layout Standard
25024 In later versions of \SpecialChar LyX
25025 , we hope to provide a more complete interface to this
25026 tool (and it's smaller cousin
25030 ) to exploit the full power of it.
25031 But it's not exactly useless as it is now: go try it on one of your existing
25032 documents of a certain length and be surprised.
25035 \begin_layout Section
25036 Version Control in \SpecialChar LyX
25040 \begin_layout Standard
25043 Lars Gullik Bjønnes
25050 \begin_layout Subsection
25054 \begin_layout Standard
25056 supports some of the most basic RCS/CVS/SVN/GIT commands.
25057 If you need something a bit more sophisticated you will have to do that
25058 manually in a terminal.
25061 \begin_layout Standard
25062 Also note that CVS support is not as good as subversion support, so we advise
25064 A good place to start learning Subversion is the SVN Book
25068 \begin_layout Plain Layout
25069 \begin_inset CommandInset href
25071 target "http://svnbook.red-bean.com/"
25082 In the case of RCS you should read
25083 \begin_inset Quotes eld
25087 \begin_inset Quotes erd
25090 (a man file, read it with
25095 This file describes all the basic features of RCS.
25096 You should especially notice the comment about a RCS directory, and the
25097 notion of a master RCS file (the file ending in
25104 \begin_layout Standard
25105 Before you begin to use the version control features in \SpecialChar LyX
25107 familiar with RCS/CVS/SVN/GIT usage.
25108 The implementation in \SpecialChar LyX
25109 assumes a recent version of the GNU RCS or CVS/SVN
25110 package — no guarantees are made for older versions.
25111 Most of the log messages are not currently displayed after operations —
25112 you can check them in the Messages pane if you are unsure.
25113 Regular users of version control will appreciate the VC toolbar, which
25116 View\SpecialChar menuseparator
25117 Toolbars\SpecialChar menuseparator
25119 \begin_inset space ~
25127 \begin_layout Standard
25128 For introducing your own external commands consult
25129 \begin_inset Flex Code
25132 \begin_layout Plain Layout
25146 \begin_layout Standard
25147 It is strongly recommended to store documents in uncompressed format if
25148 using version control (uncheck
25150 Document\SpecialChar menuseparator
25153 if it is checked): Uncompressed LyX documents are text files and therefore
25154 for merging two different versions by version control systems.
25155 Compressed LyX documents are binary files, which cannot be merged by version
25159 \begin_layout Subsection
25160 RCS commands in \SpecialChar LyX
25164 \begin_layout Standard
25165 The following sections describe the RCS commands supported by \SpecialChar LyX
25167 You can find them in the
25169 File\SpecialChar menuseparator
25171 \begin_inset space ~
25178 was tested against RCS 5.7/5.8.
25181 \begin_layout Subsubsection
25187 \begin_layout Standard
25188 If your document is not under revision control, this is the only item shown
25190 And if it is under revision control, the
25194 item is not visible.
25198 \begin_layout Standard
25199 This command registers your document with RCS (unless you are under the
25200 directory managed by CVS)\SpecialChar endofsentence
25201 You are asked interactively to supply an initial
25202 description of the document.
25203 The document is now set in Read-Only mode and you have to
25206 \begin_inset space ~
25210 \begin_inset space ~
25214 \begin_inset space ~
25219 , before making any changes to it.
25220 A document under revision control has a
25221 \begin_inset Quotes eld
25224 [RCS:<version> <locker>]
25225 \begin_inset Quotes erd
25228 item tagged to the filename in the minibuffer.
25231 \begin_layout Standard
25232 RCS command that is run:
25235 \begin_layout LyX-Code
25238 ci -q -u -i -t-"<initial description>" <file-name>
25241 \begin_layout Standard
25246 to understand the switches.
25250 \begin_layout Subsubsection
25256 \begin_layout Standard
25257 When you are finished editing a file, you check in your changes.
25258 When you do this, you are asked for a description of the changes.
25259 This is stored in the history log.
25260 The version number is bumped, your changes are applied to the master RCS
25261 file, the document is unlocked and set to Read-Only mode.
25264 \begin_layout Itemize
25267 ci -q -u -m"<description>" <file-name>
25270 \begin_layout Subsubsection
25276 \begin_layout Standard
25277 By doing this you lock the document so that only you can edit it.
25278 This will also make the document Read-Write only for you.
25279 You will usually continue editing for a while and when you are finished
25280 you check in your changes.
25281 The status line is changed to reflect that you have locked the file.
25284 \begin_layout Itemize
25287 co -q -l <file-name>
25290 \begin_layout Subsubsection
25293 Revert To Repository Version
25296 \begin_layout Standard
25297 This will discard all changes made to the document since the last check
25299 You get a warning before changes are discarded.
25302 \begin_layout Itemize
25305 co -f -u<version> <file-name>
25308 \begin_layout Subsubsection
25314 \begin_layout Standard
25315 This will create a copy of the current document.
25316 Since RCS does not support copy operations natively, the version history
25317 is not preserved, and the copy is added as a new file.
25318 It requires a clean document without any changes since the last checkin.
25319 You are asked for a file name and a description of the copy operation.
25320 After that the copy is created, both locally and in the repository.
25321 If the parent directories of the copied and original document differ, all
25322 relative paths of included files of the copy are adjusted (like in
25324 File\SpecialChar menuseparator
25329 Finally, the copy is loaded instead of the original document.
25332 \begin_layout Labeling
25333 \labelwidthstring 00.00.0000
25335 \begin_inset space ~
25339 \begin_inset space ~
25343 \begin_inset Newline newline
25347 \begin_inset Flex Code
25350 \begin_layout Plain Layout
25353 \begin_inset Quotes qld
25357 \begin_inset Quotes qld
25366 \begin_inset Flex Code
25369 \begin_layout Plain Layout
25372 \begin_inset Quotes qld
25376 \begin_inset Quotes qld
25385 \begin_inset Newline newline
25389 \begin_inset Flex Code
25392 \begin_layout Plain Layout
25396 \begin_inset Quotes qld
25400 \begin_inset Quotes qld
25411 \begin_layout Subsubsection
25417 \begin_layout Standard
25418 This makes as if the last check in never happened.
25419 No changes are made to the document loaded into \SpecialChar LyX
25420 , but the last version
25421 is removed from the master RCS file.
25424 \begin_layout Itemize
25427 rcs -o<version> <file-name>
25430 \begin_layout Subsubsection
25436 \begin_layout Standard
25437 This shows the complete history of the RCS document.
25442 is shown in a browser.
25450 \begin_layout Subsubsection
25454 \begin_layout Standard
25456 supports RCS version number, author name, date and time of last commit.
25457 All those are extracted from
25459 rlog -r <file-name>
25463 \begin_inset CommandInset ref
25465 reference "subsec:VCS-Revision-Information"
25472 \begin_layout Subsection
25473 CVS commands in \SpecialChar LyX
25477 \begin_layout Standard
25478 A subset of CVS operations is supported by \SpecialChar LyX
25480 You can find the commands in the
25482 File\SpecialChar menuseparator
25484 \begin_inset space ~
25490 The version control system SVN is more powerful, so please use it instead
25491 of CVS if possible.
25494 \begin_layout Subsubsection
25500 \begin_layout Standard
25501 If you start from scratch with CVS you have to create your repository and
25502 checkout the working copy with external tools.
25503 If you're using a client-server setup you may need to login before doing
25504 the first repository checkout.
25507 \begin_layout Standard
25508 If your documents are under revision control and others are using the same
25509 repository problems arise when different changes to the same document at
25510 the same location happen.
25511 Standard CVS repositories don't operate with a file locking mechanism.
25512 This may be surprising, but conflicts only occur if people disagree on
25513 the proper content of the same part of a document.
25514 So, if co-workers are used to communicate regularly, these conflicts occur
25516 If they don't communicate they have a fundamental problem anyway.
25517 Nevertheless some people like to work with so called
25518 \begin_inset Quotes eld
25522 \begin_inset Quotes erd
25526 If they do so the working copy of all files is readonly when checked out
25527 first and the user starts editing after using a special command to make
25528 the working copy writable.
25529 When the changes are checked in the working copy returns to readonly state.
25530 With \SpecialChar LyX
25531 one has to edit the
25532 \begin_inset Flex Code
25535 \begin_layout Plain Layout
25541 file and add the line
25542 \begin_inset Flex Code
25545 \begin_layout Plain Layout
25551 to work with reserved checkouts.
25552 The benefit is the possibility to see who is using a writable copy of some
25554 It's not guaranteed only one user makes a copy writable.
25557 \begin_layout Standard
25559 tries to guess if you're using reserved or non-reserved checkouts.
25560 If your working copy is readonly or it is writable and an additional copy
25561 of your document exists in the CVS/Base sub-directory a reserved otherwise
25562 a non-reserved checkout is assumed.
25563 When a reserved checkout is detected you have to use
25564 \begin_inset Flex Noun
25567 \begin_layout Plain Layout
25573 to make your working copy writable if it's readonly.
25575 \begin_inset Flex Noun
25578 \begin_layout Plain Layout
25584 operation is possible and that makes your working copy readonly again after
25585 transferring your changes to the repository.
25588 \begin_layout Standard
25589 More information about CVS can be found here
25590 \begin_inset Flex URL
25593 \begin_layout Plain Layout
25595 http://www.nongnu.org/cvs
25601 \begin_inset Flex URL
25604 \begin_layout Plain Layout
25606 http://ximbiot.com/cvs
25614 \begin_layout Standard
25619 to understand the sub-commands and the switches mentioned below.
25622 \begin_layout Subsubsection
25628 \begin_layout Standard
25629 If your document is not under revision control, this is the only item shown
25631 And if it is under revision control, the
25635 item is not visible.
25639 \begin_layout Standard
25640 This command registers in CVS your document
25641 \begin_inset Flex Strong
25644 \begin_layout Plain Layout
25652 in the case you have already the documents directory under CVS control
25658 This means you have to create or checkout the archive by yourself using
25660 (In case you forget that step \SpecialChar LyX
25661 registers the document with RCS.)
25664 \begin_layout Standard
25665 Then you are asked interactively to supply an initial description of the
25667 Don't forget that registered file is not yet checked in.
25670 \begin_layout Standard
25671 CVS command that is run:
25673 cvs -q add -m"<entered message>" "<file-name>"
25676 \begin_layout Standard
25681 above and for all other CVS commands is an abbreviation for
25682 \begin_inset Quotes eld
25685 change the current working directory to file location and use the file name
25686 without path component as argument
25687 \begin_inset Quotes erd
25693 \begin_layout Subsubsection
25699 \begin_layout Standard
25700 When you are finished editing a file, you commit your changes.
25701 When you do this and you had changed the document, you are asked for a
25702 description of the changes.
25703 After that changes are written to the repository.
25704 In case you didn't change the document and a reserved checkout is detected
25705 the reservation made on
25706 \begin_inset Flex Noun
25709 \begin_layout Plain Layout
25718 \begin_layout Labeling
25719 \labelwidthstring 00.00.0000
25721 \begin_inset space ~
25725 \begin_inset space ~
25729 \begin_inset Newline newline
25733 \begin_inset Flex Code
25736 \begin_layout Plain Layout
25739 -q commit -m"<description>" "<file-name>"
25745 \begin_inset Newline newline
25749 \begin_inset Flex Code
25752 \begin_layout Plain Layout
25763 \begin_layout Subsubsection
25769 \begin_layout Standard
25770 When you are sharing a repository with others, you may have to incorporate
25771 their changes into your working copy.
25774 \begin_layout Standard
25777 cvs -q update "<file-name>"
25780 \begin_layout Standard
25781 If a readonly checkout is detected the working copy is made writable and
25785 \begin_layout Standard
25788 cvs -q edit "<file-name>"
25791 \begin_layout Subsubsection
25794 Revert To Repository Version
25797 \begin_layout Standard
25798 This will discard all changes made to the document since the last check
25800 You get a warning before changes are discarded.
25801 Firstly the file is deleted, secondly CVS update command is run.
25804 \begin_layout Standard
25807 cvs -q update "<file-name>"
25810 \begin_layout Standard
25811 If a reserved checkout is detected and the working copy has no changes only
25812 the reservation is undone.
25815 \begin_layout Standard
25818 cvs -q unedit "<file-name>"
25821 \begin_layout Subsubsection
25827 \begin_layout Standard
25828 This will create a copy of the current document.
25829 Since CVS does not support copy operations natively, the version history
25830 is not preserved, and the copy is added as a new file.
25831 It requires a clean document without any changes since the last checkin.
25832 You are asked for a file name and a description of the copy operation.
25833 After that the copy is created, both locally and in the repository.
25834 If the parent directories of the copied and original document differ, all
25835 relative paths of included files of the copy are adjusted (like in
25837 File\SpecialChar menuseparator
25842 Finally, the copy is loaded instead of the original document.
25845 \begin_layout Labeling
25846 \labelwidthstring 00.00.0000
25848 \begin_inset space ~
25852 \begin_inset space ~
25856 \begin_inset Newline newline
25860 \begin_inset Flex Code
25863 \begin_layout Plain Layout
25870 \begin_inset Flex Code
25873 \begin_layout Plain Layout
25880 \begin_inset Newline newline
25884 \begin_inset Flex Code
25887 \begin_layout Plain Layout
25888 cvs -q add "<new-file-name>"
25896 \begin_layout Subsubsection
25902 \begin_layout Standard
25903 This will rename the current document.
25904 Since CVS does not support rename operations natively, the version history
25905 is not preserved, the renamed document is added as a new file, and the
25906 original document is deleted.
25907 It requires a clean document without any changes since the last checkin.
25908 You are asked for a file name and a description of the rename operation.
25909 After that the document is renamed, both locally and in the repository.
25910 If the parent directories of the new and old file names differ, all relative
25911 paths of included files are adjusted (like in
25913 File\SpecialChar menuseparator
25918 Finally, the document is reloaded using the new name.
25921 \begin_layout Labeling
25922 \labelwidthstring 00.00.0000
25924 \begin_inset space ~
25928 \begin_inset space ~
25932 \begin_inset Newline newline
25936 \begin_inset Flex Code
25939 \begin_layout Plain Layout
25946 \begin_inset Flex Code
25949 \begin_layout Plain Layout
25956 \begin_inset Newline newline
25960 \begin_inset Flex Code
25963 \begin_layout Plain Layout
25964 cvs -q add "<new-file-name>"
25970 \begin_inset Newline newline
25974 \begin_inset Flex Code
25977 \begin_layout Plain Layout
25978 cvs -q remove "<file-name>"
25986 \begin_layout Subsubsection
25987 Update of the local directory checkout from repository
25990 \begin_layout Standard
25991 Once your documents gets more complex, containing sub-documents and pictures,
25993 \begin_inset Flex Code
25996 \begin_layout Plain Layout
26002 files and so on using version control becomes more complicated.
26004 supports updating the whole tree in which resides the document.
26005 This become especially useful once you cooperate with people which neither
26006 have detailed knowledge about CVS usage nor they have ambition to commit
26007 additional material to the repository.
26008 You have to organize the files structure so that all external files are
26009 in the same directory or subdirectories of the document.
26010 It's good practice anyway to store multipart documents in an extra directory.
26013 \begin_layout Standard
26015 \begin_inset Flex Code
26018 \begin_layout Plain Layout
26019 Update local directory from repository
26024 command updates the whole directory.
26025 If local changes are detected user is warned before update starts.
26026 In case of merge conflicts both versions of the conflicting document parts
26027 are placed in the final document.
26028 You have to review and correct the result of the merge.
26029 You'll find the conflicts enclosed in pairs of
26030 \begin_inset Flex Code
26033 \begin_layout Plain Layout
26040 \begin_inset Flex Code
26043 \begin_layout Plain Layout
26050 \begin_inset Flex Code
26053 \begin_layout Plain Layout
26060 The first part is your version as before the update operation with the
26061 document name prepended.
26062 The second one is the repository version with the version number after
26064 \begin_inset Flex Code
26067 \begin_layout Plain Layout
26076 \begin_layout Labeling
26077 \labelwidthstring 00.00.0000
26079 \begin_inset space ~
26083 \begin_inset space ~
26087 \begin_inset Newline newline
26091 \begin_inset Flex Code
26094 \begin_layout Plain Layout
26102 (Ask if changes are detected.)
26103 \begin_inset Newline newline
26107 \begin_inset Flex Code
26110 \begin_layout Plain Layout
26111 cd $path; cvs -q update
26121 \begin_layout Standard
26123 \begin_inset Flex Code
26126 \begin_layout Plain Layout
26132 stands for the path to the document.
26135 \begin_layout Subsubsection
26141 \begin_layout Standard
26142 This shows the complete history of the CVS document.
26145 cvs log "<file-name>"
26147 is shown in a browser.
26150 \begin_layout Subsubsection
26154 \begin_layout Standard
26156 supports CVS version number, author name, date and time of last commit.
26157 All those are extracted from
26159 cvs log -r <file-name>
26163 \begin_inset CommandInset ref
26165 reference "subsec:VCS-Revision-Information"
26172 \begin_layout Subsection
26173 SVN commands in \SpecialChar LyX
26177 \begin_layout Standard
26178 SVN is now partially supported by \SpecialChar LyX
26180 You can find the commands in the
26182 File\SpecialChar menuseparator
26184 \begin_inset space ~
26190 Please note that if you use password protected access to repository via
26191 ssh, you will be asked in terminal window.
26193 was tested against SVN 1.5, 1.6, 1.7 and 1.8
26197 \begin_layout Plain Layout
26198 Most of the commands will work with 1.4 too, see
26199 \begin_inset CommandInset ref
26201 reference "subsec:SVN-Repo-Update"
26206 There seems to be currently unresolved permissions problem under SVN 1.8
26207 with reverting changes when file is locked.
26215 \begin_layout Subsubsection
26221 \begin_layout Standard
26222 If your document is not under revision control, this is the only item shown
26224 And if it is under revision control, the
26228 item is not visible.
26231 \begin_layout Standard
26232 This command registers in SVN your document ONLY in case you have already
26233 the documents directory under SVN control (in particular
26238 This means you have to checkout the archive by yourself.
26241 \begin_layout Standard
26242 Then you are asked interactively to supply an initial description of the
26244 Don't forget that registered file is not yet commited.
26247 \begin_layout Standard
26248 SVN command that is run:
26251 \begin_inset Quotes qld
26255 \begin_inset Quotes qld
26261 \begin_layout Standard
26266 to understand the switches.
26269 \begin_layout Subsubsection
26275 \begin_layout Standard
26276 When you are finished editing a file, you commit your changes.
26277 When you do this, you are asked for a description of the changes.
26278 After that changes are commited.
26281 \begin_layout Standard
26286 \begin_layout Plain Layout
26287 In case locking is not enabled.
26289 \begin_inset CommandInset ref
26291 reference "subsec:SVN-File-Locking"
26302 svn commit -q -m"<description>" <file-name>
26305 \begin_layout Subsubsection
26311 \begin_layout Standard
26312 Updates the changes of this file from the repository.
26313 Be sure you understand SVN merging and conflicts resolving before using
26314 this function, because all conflicts has to be resolved manually by you!
26317 \begin_layout Standard
26322 \begin_layout Plain Layout
26330 svn update --non-interactive
26331 \begin_inset Quotes qld
26335 \begin_inset Quotes qld
26341 \begin_layout Subsubsection
26344 Revert To Repository Version
26347 \begin_layout Standard
26348 This will discard all changes made to the document since the last check
26350 You get a warning before changes are discarded.
26353 \begin_layout Standard
26357 \begin_inset Quotes qld
26361 \begin_inset Quotes qld
26367 \begin_layout Subsubsection
26373 \begin_layout Standard
26374 This will create a copy of the current document including the version history.
26375 It requires a clean document without any changes since the last checkin.
26376 You are asked for a file name and a description of the copy operation.
26377 After that the copy is created, both locally and in the repository.
26378 If the parent directories of the copied and original document differ, all
26379 relative paths of included files of the copy are adjusted (like in
26381 File\SpecialChar menuseparator
26386 Finally, the copy is loaded instead of the original document.
26389 \begin_layout Labeling
26390 \labelwidthstring 00.00.0000
26392 \begin_inset space ~
26396 \begin_inset space ~
26400 \begin_inset Newline newline
26404 \begin_inset Flex Code
26407 \begin_layout Plain Layout
26411 \begin_inset Quotes qld
26415 \begin_inset Quotes qld
26419 \begin_inset Quotes qld
26423 \begin_inset Quotes qld
26432 \begin_inset Newline newline
26436 \begin_inset Flex Code
26439 \begin_layout Plain Layout
26448 \begin_layout Subsubsection
26454 \begin_layout Standard
26455 This will rename the current document including the version history.
26456 It requires a clean document without any changes since the last checkin.
26457 You are asked for a file name and a description of the rename operation.
26458 After that the document is renamed, both locally and in the repository.
26459 If the parent directories of the new and old file names differ, all relative
26460 paths of included files are adjusted (like in
26462 File\SpecialChar menuseparator
26467 Finally, the document is reloaded using the new name.
26470 \begin_layout Labeling
26471 \labelwidthstring 00.00.0000
26473 \begin_inset space ~
26477 \begin_inset space ~
26481 \begin_inset Newline newline
26485 \begin_inset Flex Code
26488 \begin_layout Plain Layout
26492 \begin_inset Quotes qld
26496 \begin_inset Quotes qld
26500 \begin_inset Quotes qld
26504 \begin_inset Quotes qld
26513 \begin_inset Newline newline
26517 \begin_inset Flex Code
26520 \begin_layout Plain Layout
26529 \begin_layout Subsubsection
26530 \begin_inset CommandInset label
26532 name "subsec:SVN-Repo-Update"
26536 Update of the local directory checkout from repository
26540 \begin_layout Plain Layout
26541 Note that this command will work only with subversion
26542 \begin_inset Formula $\geqq1.5$
26553 \begin_layout Standard
26554 All the commands above have one shortcoming – they deal with the current
26556 Once your document contains pictures, includes external
26557 \begin_inset Flex Code
26560 \begin_layout Plain Layout
26566 files and so on administration becomes more complicated.
26568 now supports updating the whole tree in which resides the document
26572 \begin_layout Plain Layout
26573 One need to organize the files structure so that all external files are
26574 in the same directory or subdirectories of the document.
26581 This become especially useful once you cooperate with people which neither
26582 know about subversion management nor they have ambition to commit additional
26583 material to the repository.
26587 \begin_layout Standard
26588 \begin_inset Flex Code
26591 \begin_layout Plain Layout
26592 Update local directory from repository
26597 command updates the whole directory and in case of merge conflicts local
26598 version of the files are left, so no unintended data loss occurs.
26599 If local changes are detected user is warned before update starts.
26602 \begin_layout Labeling
26603 \labelwidthstring 00.00.0000
26605 \begin_inset space ~
26609 \begin_inset space ~
26613 \begin_inset Newline newline
26617 \begin_inset Flex Code
26620 \begin_layout Plain Layout
26626 (Ask if changes are detected.)
26627 \begin_inset Newline newline
26631 \begin_inset Flex Code
26634 \begin_layout Plain Layout
26635 svn update --accept mine-full $path
26643 \begin_layout Standard
26645 \begin_inset Flex Code
26648 \begin_layout Plain Layout
26654 stands for the path to the document.
26657 \begin_layout Subsubsection
26663 \begin_layout Standard
26664 This shows the complete history of the SVN document.
26668 \begin_inset Quotes qld
26672 \begin_inset Quotes qld
26677 is shown in a browser.
26680 \begin_layout Subsubsection
26682 \begin_inset CommandInset label
26684 name "subsec:SVN-File-Locking"
26691 \begin_layout Standard
26692 The file exchange through various revision control systems brings the problem
26693 of merge conflicts in case two different users try to edit the same (parts
26695 When such a conflict happens it needs manual resolving and one reasonable
26696 alternative is to provide some kind of locking mechanism, which guarantees
26697 that only one user is allowed to edit file at the given time.
26700 \begin_layout Standard
26701 SVN has two such mechanisms to provide mutual exclusivity for file access
26702 – locks and automatic setting of write permissions (see sec.
26704 \begin_inset CommandInset ref
26706 reference "subsec:Automatical-Locking-Property"
26711 \begin_inset Flex Code
26714 \begin_layout Plain Layout
26724 \begin_layout Plain Layout
26725 \begin_inset Flex URL
26728 \begin_layout Plain Layout
26730 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
26741 If this property is detected for a given document \SpecialChar LyX
26742 starts to use SVN locks
26743 for document editing automatically and the whole check-in/out mechanism
26744 switches to the same regimen as for RCS.
26745 This in particular means there are two different modes of file use in \SpecialChar LyX
26749 \begin_layout Itemize
26751 The loaded file is in the read-only mode.
26752 For editing on needs to check-out.
26757 consists of updating from the repository and gaining write lock.
26758 If the lock is not possible to obtain, we remain in unlocked state.
26761 \begin_layout Itemize
26763 The loaded file is in the
26764 \begin_inset Quotes els
26768 \begin_inset Quotes ers
26772 No other user is allowed to edit the file.
26777 consists of commiting changes and releasing write-lock.
26778 If no changes have been made to the document, no commit will be produced
26782 \begin_layout Plain Layout
26783 Don't be puzzled by the fact that you will be asked for commit message anyway.
26788 and only the write-lock will be released.
26791 \begin_layout Standard
26795 \begin_layout Labeling
26796 \labelwidthstring 00.00.0000
26799 svn commit -q -m"<description>" "<file-name>"
26800 \begin_inset Newline newline
26803 svn unlock "<file-name>"
26806 \begin_layout Labeling
26807 \labelwidthstring 00.00.0000
26810 svn update "<file-name>"
26811 \begin_inset Newline newline
26814 svn lock "<file-name>"
26817 \begin_layout Subsubsection
26820 \begin_inset CommandInset label
26822 name "subsec:Automatical-Locking-Property"
26828 Automatic Locking Property
26831 \begin_layout Standard
26832 The above mentioned automatic setting of write permissions of the .lyx file
26835 File\SpecialChar menuseparator
26837 \begin_inset space ~
26840 Control\SpecialChar menuseparator
26841 Use Locking Property
26844 This command is active only when the file is not locked on the svn server
26846 you need to check-out before proceeding).
26849 \begin_layout Labeling
26850 \labelwidthstring 00.00.0000
26852 \begin_inset space ~
26858 \begin_layout Labeling
26859 \labelwidthstring 00.00.0000
26862 svn propset svn:needs-lock ON "<file-name>"
26865 \begin_layout Labeling
26866 \labelwidthstring 00.00.0000
26869 svn propdel svn:needs-lock "<file-name>"
26872 \begin_layout Subsubsection
26873 \begin_inset CommandInset label
26875 name "subsec:VCS-Revision-Information"
26879 Revision Information in Documents
26882 \begin_layout Standard
26883 There are more possibilities how to activate revision information in our
26887 \begin_layout Itemize
26893 \begin_layout Itemize
26894 tree revision information (
26895 \begin_inset Flex Code
26898 \begin_layout Plain Layout
26905 The result is the output of the
26906 \begin_inset Flex Code
26909 \begin_layout Plain Layout
26915 command, the following table gives you an idea, how to read the results.
26918 \begin_layout Standard
26920 \begin_inset Tabular
26921 <lyxtabular version="3" rows="6" columns="2">
26922 <features tabularvalignment="middle">
26923 <column alignment="left" valignment="top">
26924 <column alignment="left" valignment="top">
26926 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26929 \begin_layout Plain Layout
26937 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26940 \begin_layout Plain Layout
26950 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26953 \begin_layout Plain Layout
26959 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26962 \begin_layout Plain Layout
26963 mixed revision working copy
26970 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26973 \begin_layout Plain Layout
26979 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26982 \begin_layout Plain Layout
26983 modified working copy
26990 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26993 \begin_layout Plain Layout
26999 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27002 \begin_layout Plain Layout
27003 switched working copy
27010 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
27013 \begin_layout Plain Layout
27019 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
27022 \begin_layout Plain Layout
27023 partial working copy, from a sparse checkout
27030 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
27033 \begin_layout Plain Layout
27039 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
27042 \begin_layout Plain Layout
27043 mixed revision, modified, switched working copy
27056 \begin_layout Itemize
27057 file revision information.
27058 The result comes from parsing the output of
27059 \begin_inset Flex Code
27062 \begin_layout Plain Layout
27064 \begin_inset space ~
27068 \begin_inset space ~
27072 \begin_inset space ~
27081 Supported flags are:
27085 \begin_layout Itemize
27086 version number of the last commit (
27087 \begin_inset Flex Code
27090 \begin_layout Plain Layout
27099 \begin_layout Itemize
27100 author of the last commit (
27101 \begin_inset Flex Code
27104 \begin_layout Plain Layout
27113 \begin_layout Itemize
27114 date of the last commit (
27115 \begin_inset Flex Code
27118 \begin_layout Plain Layout
27127 \begin_layout Itemize
27128 time of the last commit (
27129 \begin_inset Flex Code
27132 \begin_layout Plain Layout
27142 \begin_layout Standard
27143 You can obtain this info via InsetInfo (
27144 \change_inserted 5863208 1564400022
27147 Insert\SpecialChar menuseparator
27148 Field\SpecialChar menuseparator
27149 Version Control Revision
27150 \change_deleted 5863208 1564399852
27155 \begin_inset Flex Code
27158 \begin_layout Plain Layout
27159 info-insert buffer vcs-date
27167 The information will be available only when you have the file stored under
27168 svn managment (i.e.
27170 \begin_inset Flex Code
27173 \begin_layout Plain Layout
27179 directory is available with your document).
27183 \begin_layout Itemize
27184 Another—a hacking one—possibility is to use svn keywords
27188 \begin_layout Plain Layout
27189 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
27195 In short – you set file keywords property (e.g.
27198 svn propset svn:keywords 'Rev' file.lyx
27200 ) and then paste keyword \SpecialChar TeX
27205 \begin_layout Plain Layout
27206 This is an easy way how to ensure that \SpecialChar LyX
27207 won't break the line in the middle
27213 tag in your document (e.g.
27215 \begin_inset Flex Code
27218 \begin_layout Plain Layout
27225 This way svn client will automatically substitute revision number (e.g.
27227 \begin_inset Flex Code
27230 \begin_layout Plain Layout
27236 ) after each update and commit.
27237 There are more problems with this approach.
27238 Firstly, the '$' character is used in \SpecialChar TeX
27239 world for math equations, so any
27240 occurence of math formula
27241 \begin_inset Formula $Rev$
27245 \begin_inset Formula $Rev:59$
27248 in your \SpecialChar LyX
27250 Similarly for other keywords like Id, Date, Author, etc.
27251 Secondly svn output is dependent on your locales, so its very easy that
27252 svn would produce some problematic strings once Date is used.
27253 Thirdly you get the whole 'Rev: 59' string in your document instead of
27255 Until subversion implements user's custom keywords it will be hard to use
27256 this approach reliably or let \SpecialChar LyX
27257 to support it directly.
27260 \begin_layout Subsection
27261 SVN and Windows Environment
27264 \begin_layout Quote
27265 My inclination is to say that if the user cannot figure out the command
27266 line operations on their own fairly quickly, they would be well advised
27267 to use TortoiseSVN.
27273 \begin_layout Subsubsection
27277 \begin_layout Standard
27278 In addition to installing \SpecialChar LyX
27279 , and having access to a Subversion repository,
27280 the user will need to install the Subversion client program.
27281 A Windows installer for the client program is available from
27282 \begin_inset CommandInset href
27285 target "http://www.collab.net/nonav/downloads/subversion/"
27291 The user may also want to install
27292 \begin_inset CommandInset href
27295 target "http://tortoisesvn.tigris.org/"
27300 , which integrates Subversion operations into the context (rightclick) menu
27301 of Windows Explorer.
27302 Operations done outside \SpecialChar LyX
27303 will typically be more convenient using the Explorer
27305 Note that TortoiseSVN is not a replacement for the client program, which
27306 is what \SpecialChar LyX
27310 \begin_layout Subsubsection
27311 Bringing a document under Subversion control
27314 \begin_layout Standard
27315 Before a \SpecialChar LyX
27316 document can be brought under version control in Subversion, its
27317 parent directory needs to be under version control.
27318 If the document is being added to a project already in the repository,
27319 this is accomplished by checking the project out to the directory where
27320 the new document will be placed.
27321 If the project itself is not yet under version control (for instance, if
27322 this document starts a new project), the directory must be imported into
27324 This is done outside \SpecialChar LyX
27326 Both import and checkout are easily accomplished from the Explorer context
27327 menu using TortoiseSVN, or alternatively can be done using the command
27328 line client at a DOS prompt.
27329 The procedure for importing the project using TortoiseSVN is described
27330 below, assuming an existing repository and a new project being started
27338 For information on using the Subversion client program, run
27345 \begin_layout Enumerate
27352 in Windows Explorer, right click it, and select
27354 TortoiseSVN\SpecialChar menuseparator
27358 If necessary, adjust the URL for the repository, then click OK.
27361 \begin_layout Enumerate
27362 Right click the level of the repository under which you want to place the
27363 new project folder (typically the top level) and click
27367 Supply a name for the project folder and click OK.
27368 Add a message for the log file if desired, then click OK again.
27369 The new project folder should appear in the repository.
27370 Finally, click OK again to exit the repository browser.
27373 \begin_layout Enumerate
27374 Once again right click
27380 , this time selecting SVN Checkout\SpecialChar ldots
27381 Select the URL of the project folder
27382 you just created in the repository, and set the checkout directory to
27390 You will be warned about a non-empty folder; click OK to proceed.
27391 You should now have a
27402 \begin_layout Enumerate
27403 Create or open your document in \SpecialChar LyX
27406 File\SpecialChar menuseparator
27408 \begin_inset space ~
27411 Control\SpecialChar menuseparator
27415 Add a log message and click OK to commit the document to version control.
27418 \begin_layout Standard
27419 From this point onward, you should have full functionality in the
27421 File\SpecialChar menuseparator
27423 \begin_inset space ~
27429 You also have the option of checking the document in and out, viewing its
27431 using the TortoiseSVN context menu in Windows Explorer or the Subversion
27432 client program from a command prompt.
27435 \begin_layout Subsubsection
27436 SSH tunnel used with SVN under Windows
27439 \begin_layout Standard
27440 Compared with Linux setting up an svn client to communicate over ssh under
27441 Windows is a rather troublesome task.
27442 We will at least offer some hints how to setup the client side but prior
27443 knowledge about ssh and the Windows command line is needed, also be prepared
27444 for a great deal of frustration\SpecialChar ldots
27448 \begin_layout Enumerate
27449 Get an svn client for windows, as described in the previous sections.
27450 When it is a fresh install run some svn command (e.g.
27452 \begin_inset Flex Code
27455 \begin_layout Plain Layout
27461 ) to create config files, which you will need to change later on.
27464 \begin_layout Enumerate
27465 Choose an ssh client for Windows.
27466 There are several possibilities, we will use the one from Putty tools
27470 \begin_layout Plain Layout
27471 \begin_inset Flex URL
27474 \begin_layout Plain Layout
27476 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
27487 You will need to set the connection up so that the client doesn't ask for
27488 any password from you.
27489 To keep things easy we will use only keys without any additional password
27494 \begin_layout Enumerate
27496 \begin_inset Flex Code
27499 \begin_layout Plain Layout
27506 Save your private .ppk key file and put the public one on the server side.
27507 If the SVN server runs on Linux, note that the format of the public key
27508 is not compatible with Linux openssh and you will need to direcly copy-paste
27510 \begin_inset Quotes eld
27515 Public key for pasting into OpenSSH authorized_keys file
27518 \begin_inset Quotes erd
27521 edit field into the server's
27522 \begin_inset Flex Code
27525 \begin_layout Plain Layout
27526 ~/.ssh/authorized_keys
27532 \begin_inset Flex Code
27535 \begin_layout Plain Layout
27544 \begin_layout Enumerate
27546 \begin_inset Flex Code
27549 \begin_layout Plain Layout
27556 In the SVN config file
27560 \begin_layout Plain Layout
27561 Exact path depends on Windows version, usually somewhere around
27562 \begin_inset Flex Code
27565 \begin_layout Plain Layout
27568 Documents and Settings
27582 \begin_inset Flex Code
27585 \begin_layout Plain Layout
27600 , section [tunnels], setup ssh command, e.g.
27602 \begin_inset Flex Code
27605 \begin_layout Plain Layout
27606 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
27615 \begin_layout Plain Layout
27616 It will usually take a lot of time to get exact command right and it depends
27618 For example do not have some remote server saved as a default session in
27620 If things fail, try to connect via plink without SVN first.
27629 \begin_layout Enumerate
27630 Checkout the SVN archive, e.
27631 \begin_inset space \thinspace{}
27635 \begin_inset Newline newline
27639 \begin_inset Flex Code
27642 \begin_layout Plain Layout
27643 svn co svn+ssh://user@server/repository_path
27651 \begin_layout Subsubsection
27652 End-of-Line Conversions
27655 \begin_layout Standard
27656 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
27658 use different line endings inside the .lyx files.
27659 This is not a problem as far as \SpecialChar LyX
27660 functionality is concerned, but the commit
27661 diffs will be huge and merge-conflicts prone.
27662 Fortunately SVN itself knows
27666 \begin_layout Plain Layout
27667 \begin_inset Flex URL
27670 \begin_layout Plain Layout
27672 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
27682 how to deal with CR/LF problems when switching .lyx files to the
27683 \begin_inset Flex Code
27686 \begin_layout Plain Layout
27696 \begin_layout Plain Layout
27698 \begin_inset Flex Code
27701 \begin_layout Plain Layout
27702 svn propset svn:eol-style native FILE_NAME
27715 \begin_layout Subsection
27716 GIT commands in \SpecialChar LyX
27720 \begin_layout Standard
27721 A minimal subset of GIT commands is now supported by \SpecialChar LyX
27723 You can find the commands in the
27725 File\SpecialChar menuseparator
27727 \begin_inset space ~
27733 Please note that if you use password protected access to repository via
27734 ssh, you will be asked in terminal window.
27736 was tested against GIT 1.7.
27740 \begin_layout Plain Layout
27741 Windows users please note that you need to ensure that git is on the path.
27742 This can be set from within \SpecialChar LyX
27745 Tools\SpecialChar menuseparator
27746 Preferences\SpecialChar menuseparator
27747 Paths\SpecialChar menuseparator
27758 \begin_layout Standard
27759 One big difference of GIT and the other supported version control systems
27760 is the distributed nature of GIT: With traditional version control systems
27761 there is one central server which hosts the repository.
27762 Users commit their changes to the server, and get updates made by other
27764 With GIT, users commit to a local repository.
27765 The local repository can be synchronized with one or more remote repositories
27767 \begin_inset Flex Code
27770 \begin_layout Plain Layout
27777 \begin_inset Flex Code
27780 \begin_layout Plain Layout
27788 does not interact in any way with remote GIT repositories.
27789 It works exclusively with the local repository in a very similar way as
27790 with a central CVS or SVN repository.
27791 If you use remote GIT repositories you need to do the
27792 \begin_inset Flex Code
27795 \begin_layout Plain Layout
27802 \begin_inset Flex Code
27805 \begin_layout Plain Layout
27811 operations with your favourite GIT client.
27814 \begin_layout Subsubsection
27820 \begin_layout Standard
27821 If your document is not under revision control, this is the only item shown
27823 And if it is under revision control, the
27827 item is not visible.
27830 \begin_layout Standard
27831 This command registers in GIT your document ONLY in case you have already
27832 the documents directory under GIT control (in particular
27837 This means you have to checkout the archive by yourself.
27840 \begin_layout Standard
27841 Then you are asked interactively to supply an initial description of the
27843 Don't forget that registered file is not yet committed.
27846 \begin_layout Standard
27847 GIT command that is run:
27850 \begin_inset Quotes qld
27854 \begin_inset Quotes qld
27860 \begin_layout Standard
27865 to understand the switches.
27868 \begin_layout Subsubsection
27874 \begin_layout Standard
27875 When you are finished editing a file, you commit your changes.
27876 When you do this, you are asked for a description of the changes.
27877 After that changes are committed.
27880 \begin_layout Standard
27883 git commit -q -m"<description>" <file-name>
27886 \begin_layout Subsubsection
27889 Revert To Repository Version
27892 \begin_layout Standard
27893 This will discard all changes made to the document since the last check
27895 You get a warning before changes are discarded.
27898 \begin_layout Standard
27902 \begin_inset Quotes qld
27906 \begin_inset Quotes qld
27912 \begin_layout Subsubsection
27918 \begin_layout Standard
27919 This will rename the current document including the version history.
27920 It requires a clean document without any changes since the last checkin.
27921 You are asked for a file name and a description of the rename operation.
27922 After that the document is renamed, both locally and in the repository.
27923 If the parent directories of the new and old file names differ, all relative
27924 paths of included files are adjusted (like in
27926 File\SpecialChar menuseparator
27931 Finally, the document is reloaded using the new name.
27934 \begin_layout Labeling
27935 \labelwidthstring 00.00.0000
27937 \begin_inset space ~
27941 \begin_inset space ~
27945 \begin_inset Newline newline
27949 \begin_inset Flex Code
27952 \begin_layout Plain Layout
27956 \begin_inset Quotes qld
27960 \begin_inset Quotes qld
27964 \begin_inset Quotes qld
27968 \begin_inset Quotes qld
27977 \begin_inset Newline newline
27981 \begin_inset Flex Code
27984 \begin_layout Plain Layout
27993 \begin_layout Subsubsection
27999 \begin_layout Standard
28000 This shows the complete history of the GIT document.
28004 \begin_inset Quotes qld
28008 \begin_inset Quotes qld
28013 is shown in a browser.
28016 \begin_layout Subsubsection
28020 \begin_layout Standard
28022 supports GIT hash number of the last commit to the file,
28023 \change_inserted 1119979965 1564297456
28024 its abbreviated form,
28026 author name, date and time of last commit.
28027 All those are extracted from
28029 git log -n 1 --pretty=format:%H%n
28030 \change_inserted 1119979965 1564297427
28036 Tree version information is obtained via
28038 git describe --abbrev --dirty --long
28042 \begin_inset CommandInset ref
28044 reference "subsec:VCS-Revision-Information"
28051 \begin_layout Subsection
28055 \begin_layout Standard
28056 With the recent addition of the
28057 \begin_inset Flex Code
28060 \begin_layout Plain Layout
28066 function \SpecialChar LyX
28067 power users are allowed to create their own commands for revision
28071 \begin_layout Standard
28072 As an example you can see how two TortoiseSVN commands could be integrated
28076 \begin_layout Description
28078 \begin_inset Flex Code
28081 \begin_layout Plain Layout
28082 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
28090 \begin_layout Description
28092 \begin_inset Flex Code
28095 \begin_layout Plain Layout
28096 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
28104 \begin_layout Subsection
28105 Version control and Document comparison
28108 \begin_layout Standard
28109 One of the typical uses of version control is to inspect the changes between
28110 revisions, usually by creating
28111 \begin_inset Flex Code
28114 \begin_layout Plain Layout
28121 While this is useful for plain text files, it is much less useful in the
28122 case of \SpecialChar LyX
28123 files, which have more a complicated structure.
28124 Hence we provide binding to the Document comparison feature.
28125 There are two ways of calling this feature – either by direct call of
28126 \begin_inset Flex Code
28129 \begin_layout Plain Layout
28136 function (for details see \SpecialChar LyX
28137 functions manual) or by the toolbar icon
28150 One can either compare two chosen revisions of the document or he can simply
28151 compare the current version of edited text with older revisions (where
28153 \begin_inset Flex Noun
28156 \begin_layout Plain Layout
28162 ' revisions back means comparison of the edited file with last commited
28167 \begin_layout Standard
28168 This feature is supported for SVN and RCS though due to the more complicated
28169 versioning scheme of RCS there is a constraint – when addressing the revisions
28170 in dialog, numbers always point to the last number in RCS revision number,
28173 We don't currently support GIT addressing of revisions, one can just compare
28174 edited document with its revision X steps backs, where X is addressed as
28176 \begin_inset Flex Code
28179 \begin_layout Plain Layout
28188 \begin_layout Section
28189 Literate Programming
28192 \begin_layout Standard
28197 (kayvan@sylvan.com)
28201 original documentation written by
28203 Edmar Wienskoski Jr.
28206 (edmar-w-jr@technologist.com)
28209 \begin_layout Subsection
28213 \begin_layout Standard
28214 The main purpose of this documentation is to show you how to use \SpecialChar LyX
28216 programming, where it is assumed that you are familiar with this programming
28217 technique, and know what
28218 \begin_inset Quotes eld
28222 \begin_inset Quotes erd
28226 \begin_inset Quotes eld
28230 \begin_inset Quotes erd
28234 If that is not the case, please follow the web links provided in the following
28236 There is a lot of good documentation out there covering old development
28237 history to the latest tools tips.
28240 \begin_layout Standard
28241 It is also assumed that you are familiar with \SpecialChar LyX
28242 itself to a point that you
28243 are comfortable changing your \SpecialChar LyX
28244 preferences, and X resources file.
28245 If that is not the case please refer to other \SpecialChar LyX
28246 documentation to cover your
28250 \begin_layout Subsection
28251 Literate Programming
28254 \begin_layout Standard
28255 From the Literate Programming FAQ:
28258 \begin_layout Quotation
28259 Literate programming is the combination of documentation and source together
28260 in a fashion suited for reading by human beings.
28261 In fact, literate programs should be enjoyable reading, even inviting!
28262 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
28263 and documentation in a single file.
28264 Literate programming tools then parse the file to produce either readable
28265 documentation or compilable source.
28266 The WEB style of literate programming was created by D.
28267 \begin_inset space \thinspace{}
28271 Knuth during the development of his \SpecialChar TeX
28272 typesetting software.
28276 \begin_layout Standard
28277 Another excerpt says:
28280 \begin_layout Quotation
28283 How is literate programming different from verbose commenting?
28286 \begin_layout Quotation
28287 There are three distinguishing characteristics.
28288 In order of importance, they are:
28292 \begin_layout Itemize
28293 flexible order of elaboration
28296 \begin_layout Itemize
28297 automatic support for browsing
28300 \begin_layout Itemize
28301 typeset documentation, especially diagrams and mathematics
28305 \begin_layout Standard
28306 Now that I sparked your curiosity, take a look in the references.
28309 \begin_layout Subsubsection
28313 \begin_layout Standard
28314 The complete Literate Programming FAQ can be found at:
28317 \begin_layout Quote
28318 Literate Programming FAQ
28319 \begin_inset Flex URL
28322 \begin_layout Plain Layout
28324 http://www.literateprogramming.com/lpfaq.pdf
28332 \begin_layout Standard
28333 The FAQ lists 23 (twenty three!) different literate programming tools.
28334 Where some are specialized or
28335 \begin_inset Quotes eld
28339 \begin_inset Quotes erd
28342 for particular programming languages, while other have general scope.
28347 for my own use for several reasons:
28350 \begin_layout Itemize
28351 It can generate the documentation either in \SpecialChar LaTeX
28355 \begin_layout Itemize
28356 It has a open architecture, i.
28357 \begin_inset space \thinspace{}
28361 \begin_inset space \space{}
28364 it is easy to plug in new filters
28368 \begin_layout Plain Layout
28373 are programs that read a given data stream and output a manipulated data
28375 That way, a WEB file (consisting of literate code) can be turned into a
28376 file consisting only of C program code or \SpecialChar LaTeX
28382 and to perform special processing that you may need.
28386 \begin_layout Itemize
28387 There is a good selection of filters available already (the HTML is one
28391 \begin_layout Itemize
28395 \begin_layout Standard
28396 The Noweb web page can be found at:
28399 \begin_layout Quote
28401 \begin_inset Flex URL
28404 \begin_layout Plain Layout
28406 https://www.cs.tufts.edu/~nr/noweb/
28414 \begin_layout Standard
28415 Starting from there you can reach many other interesting links and even
28416 some literate program examples.
28419 \begin_layout Subsection
28421 and Literate Programming with Noweb
28424 \begin_layout Standard
28425 The \SpecialChar LyX
28426 support for Literate Programming is provided by using the generic \SpecialChar LyX
28428 converters mechanism.
28429 This support is provided in a
28430 \begin_inset Quotes eld
28434 \begin_inset Quotes erd
28438 \begin_inset space \thinspace{}
28442 \begin_inset space \space{}
28445 you will be able to use this new \SpecialChar LyX
28446 feature with some other literate programming
28447 tool of your choice by just changing your \SpecialChar LyX
28451 \begin_layout Subsubsection
28452 Generating documents and code (weaving and tangling)
28455 \begin_layout Paragraph
28456 Using the noweb module
28459 \begin_layout Standard
28460 If you have installed Noweb and \SpecialChar LyX
28461 successfully, whenever you open a new document,
28462 after you have chosen its document class, use the
28464 Document\SpecialChar menuseparator
28468 \begin_inset Quotes eld
28472 \begin_inset Quotes erd
28476 If Noweb is correctly installed, when you click on the
28477 \begin_inset Quotes eld
28481 \begin_inset Quotes erd
28484 link, you will see the
28485 \begin_inset Quotes eld
28489 \begin_inset Quotes erd
28492 module in the available list and you can add it to your document.
28495 \begin_layout Paragraph
28499 \begin_layout Standard
28501 enables you to write code with a custom inset named
28502 \begin_inset Flex Noun
28505 \begin_layout Plain Layout
28512 Noweb delimits chunks like this:
28515 \begin_layout LyX-Code
28519 \begin_layout LyX-Code
28523 \begin_layout LyX-Code
28527 \begin_layout LyX-Code
28531 \begin_layout LyX-Code
28535 \begin_layout Standard
28536 The problem is that whatever is written in between the << and the
28540 must be taken literally, i.
28541 \begin_inset space \thinspace{}
28545 \begin_inset space \space{}
28549 should be prevented from making any special interpretation of what has
28551 This is also handled by
28552 \begin_inset Flex Noun
28555 \begin_layout Plain Layout
28561 , that works like a normal text inset but has a free spacing capability.
28564 \begin_layout Standard
28565 As a special note, you can also use the
28566 \begin_inset Quotes eld
28570 \begin_inset Quotes erd
28573 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
28577 \begin_layout LyX-Code
28581 \begin_layout LyX-Code
28582 def some_function(args):
28585 \begin_layout LyX-Code
28586 "This is the doc string for this function."
28589 \begin_layout LyX-Code
28590 print "My args: ", args
28593 \begin_layout LyX-Code
28594 @ %def some_function
28597 \begin_layout Standard
28598 For an example of this usage and the resulting cross-reference output, look
28599 at the Literate python program in
28601 LIBDIR/examples/listerrors.lyx
28603 which should make this all clear.
28606 \begin_layout Paragraph
28607 Generating the documentation
28610 \begin_layout Standard
28611 At this point you already have a new document file with a proper document
28612 class, and with some code and text on it.
28613 How do I print it? The answer is simple, you select
28615 View\SpecialChar menuseparator
28619 Just like you would do for a plain document.
28620 No special procedure is required.
28623 \begin_layout Standard
28624 To help orientate you, I will now explain what happens inside \SpecialChar LyX
28628 \begin_layout Enumerate
28631 Update\SpecialChar menuseparator
28634 menu option is chosen, a \SpecialChar LaTeX
28640 \begin_layout Standard
28641 If the document is of any literate class the generated file will be named
28642 with an extension name defined by the
28643 \begin_inset Quotes eld
28647 \begin_inset Quotes erd
28650 format (defined in the Preferences panel), otherwise the file will have
28659 \begin_layout Enumerate
28660 Note that the only difference so far is in the name of the file, no special
28661 processing is required by \SpecialChar LyX
28663 Given that you formatted the code using the
28664 \begin_inset Flex Noun
28667 \begin_layout Plain Layout
28673 inset that, by itself, takes care of the business.
28676 \begin_layout Enumerate
28677 If the document is of any literate class \SpecialChar LyX
28678 will then use the internal \SpecialChar LyX
28680 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
28685 \begin_layout Plain Layout
28686 The converters are defined in the
28688 Tools\SpecialChar menuseparator
28692 \begin_inset Quotes eld
28696 \begin_inset Quotes erd
28708 manual for general information about converters.
28713 to generate the \SpecialChar LaTeX
28718 \begin_layout Standard
28719 Otherwise it will just skip this step.
28723 \begin_layout Enumerate
28724 Finally, \SpecialChar LaTeX
28725 is invoked and the regular post processing continues as in a plain
28729 \begin_layout Standard
28730 Independence from a particular
28731 \begin_inset Quotes eld
28735 \begin_inset Quotes erd
28738 is easily achieved by changing the commands that are run by the various
28742 \begin_layout Paragraph
28743 Generating the code
28746 \begin_layout Standard
28747 When the build menu option is chosen or the corresponding button in the
28748 toolbar is pressed, a \SpecialChar LaTeX
28749 file is generated just like step 1 above.
28750 Next, \SpecialChar LyX
28756 This converter needs to be defined by the user and is not installed by
28757 default, though the Program format is.
28758 This converter (like any other converter) will have two parts:
28761 \begin_layout Enumerate
28762 The converter program itself.
28763 This program performs the conversion from the one format to the other (in
28764 this case, from the Noweb format to the Program pseudo-format).
28767 \begin_layout Enumerate
28768 The error log parser.
28769 This is a program whose sole purpose is to rewrite error messages in a
28770 format that \SpecialChar LyX
28772 This makes it possible for \SpecialChar LyX
28773 to place error boxes in the right places in
28777 \begin_layout Standard
28778 The first part, the
28779 \begin_inset Quotes eld
28783 \begin_inset Quotes erd
28786 setting, should be set to
28789 \begin_layout LyX-Code
28797 \begin_layout Standard
28798 This basically means that \SpecialChar LyX
28800 \begin_inset Quotes eld
28804 \begin_inset Quotes erd
28807 (a program or script) with the name of the Noweb file (normally a file
28808 in the \SpecialChar LyX
28809 temp directory) and the directory path of the original \SpecialChar LyX
28814 \begin_layout Standard
28815 This is an implementation of
28816 \begin_inset Quotes eld
28820 \begin_inset Quotes erd
28823 that you can place in a directory on your path:
28826 \begin_layout LyX-Code
28832 \begin_layout LyX-Code
28838 \begin_layout LyX-Code
28841 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
28844 \begin_layout Standard
28845 The next part of the converter setting is the
28846 \begin_inset Quotes eld
28850 \begin_inset Quotes erd
28853 which is to be set to
28856 \begin_layout LyX-Code
28859 parselog=$$s/scripts/listerrors
28862 \begin_layout Standard
28863 This will run any errors that are generated by the
28864 \begin_inset Quotes eld
28868 \begin_inset Quotes erd
28871 process through the
28872 \begin_inset Quotes eld
28876 \begin_inset Quotes erd
28882 \begin_layout Standard
28883 The build will normally take place in \SpecialChar LyX
28884 's temporary directory, so the files
28885 produced by the conversion will be in that directory.
28887 will copy out what it regards as the `main' file, but the
28891 conversion may produce several files, and so most of these would then be
28892 deleted when \SpecialChar LyX
28894 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
28895 the build-script chunk can place the generated files in that location.
28898 \begin_layout Paragraph
28899 Build instructions in the document
28902 \begin_layout Standard
28903 The last piece of the integration between \SpecialChar LyX
28905 \begin_inset Quotes eld
28909 \begin_inset Quotes erd
28913 Generally, the instructions for building your program should be embedded
28914 in a chunk of its own.
28916 \begin_inset Quotes eld
28920 \begin_inset Quotes erd
28923 above uses the notangle command to look for this chunk (called
28924 \begin_inset Quotes eld
28928 \begin_inset Quotes erd
28931 ) and runs its contents through
28932 \begin_inset Quotes eld
28936 \begin_inset Quotes erd
28942 \begin_layout Standard
28943 Typically, such a chunk would look something like this:
28946 \begin_layout LyX-Code
28950 \begin_layout LyX-Code
28952 \begin_inset Newline newline
28955 if [ -z "${NOWEB_SOURCE}" ]
28956 \begin_inset Newline newline
28962 \begin_layout LyX-Code
28963 NOWEB_SOURCE=myfile.nw
28964 \begin_inset Newline newline
28968 \begin_inset Newline newline
28972 code to extract files ...
28973 use NOWEB_OUTPUT_DIR here ...]
28974 \begin_inset Newline newline
28978 code to compile files ...]
28979 \begin_inset Newline newline
28985 \begin_layout Standard
28988 LIBDIR/examples/listerrors.lyx
28992 LIBDIR/examples/Literate.lyx
28994 which implement two versions of the
28995 \begin_inset Quotes eld
28999 \begin_inset Quotes erd
29002 program for some illustrations of how all of these pieces go together or
29005 LIBDIR/examples/noweb2lyx.lyx.
29008 Interestingly, these three files show off the language-indepence of the
29010 literate programming support since they are written in Python, C and Perl
29014 \begin_layout Subsubsection
29015 Configuring \SpecialChar LyX
29019 \begin_layout Standard
29020 All the Literate Programming support is configured by the
29022 Tools\SpecialChar menuseparator
29026 \begin_inset Quotes eld
29030 \begin_inset Quotes erd
29034 The important parts are:
29037 \begin_layout Description
29039 \begin_inset space ~
29043 \begin_inset Quotes eld
29047 \begin_inset Quotes erd
29051 \begin_inset space ~
29054 format Set up via the File Formats tab, this is where the Noweb-specific
29064 , the file extension is set to
29069 This tells \SpecialChar LyX
29070 to create a file with a
29074 extension in the first step of the conversion process.
29077 \begin_layout Description
29079 \begin_inset space ~
29087 \begin_inset space ~
29090 format This is an empty format whose sole purpose is to be the endpoint
29091 of a conversion (which then allows us to set up a converter for it).
29094 \begin_layout Description
29104 This converter performs the
29105 \begin_inset Quotes eld
29109 \begin_inset Quotes erd
29112 of the literate document.
29113 For Noweb, it is set to
29114 \begin_inset Quotes eld
29119 noweave -delay -index $$i > $$o
29122 \begin_inset Quotes erd
29128 \begin_layout Description
29138 \begin_inset Quotes eld
29142 \begin_inset Quotes erd
29146 As stated above, the Converter is set to
29147 \begin_inset Quotes eld
29155 \begin_inset Quotes erd
29158 , with Flags set to
29159 \begin_inset Newline newline
29163 \begin_inset Quotes eld
29168 parselog=$$s/scripts/listerrors
29171 \begin_inset Quotes erd
29177 \begin_layout Subsubsection
29181 \begin_layout Standard
29182 There is also a new function implemented in the \SpecialChar LyX
29184 \begin_inset Quotes eld
29187 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
29191 \begin_layout Standard
29192 When debugging code with ddd/gdb, it is possible to invoke a text editor
29193 at the current execution position with a single key stroke.
29194 The default ddd configuration for that is shift-ctrl-V.
29195 It happens that you can define the editor command line invocation in ddd
29198 Edit\SpecialChar menuseparator
29199 Preferences\SpecialChar menuseparator
29202 dialog and changing the "Edit Sources" entry.
29205 \begin_layout Standard
29206 I take advantage of the newly created \SpecialChar LyX
29207 server function and this ddd feature,
29209 \begin_inset Quotes eld
29213 \begin_inset Quotes erd
29219 \begin_layout LyX-Code
29220 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
29223 \begin_layout Standard
29224 With this, whenever you are using ddd and find a point in the program that
29225 you want to edit, you just press shift-ctrl-V (in the ddd window), and
29226 ddd will forward this information to \SpecialChar LyX
29227 through the \SpecialChar LyX
29228 server and then the
29230 window will show the same file with the cursor at the same position ddd
29232 No more guessing or long scrolling to locate a point in the program back
29236 \begin_layout Standard
29237 Note however that you must enable the \SpecialChar LyX
29238 server to get this feature working
29239 (it is disabled by default).
29241 \begin_inset space ~
29245 \begin_inset CommandInset ref
29247 reference "sec:Starting-the-Server"
29251 explains how to do that.
29254 \begin_layout Subsubsection
29258 \begin_layout Standard
29259 There are six new buttons that can be added to your \SpecialChar LyX
29261 Four of these buttons are short cuts to layout styles:
29279 , one for the custom inset
29284 The last one is a short cut to the
29285 \begin_inset Quotes eld
29289 \begin_inset Quotes erd
29296 \begin_layout Standard
29298 has a range of buttons that are available for tool bar customization.
29299 In my toolbar I like to combine the six short cuts above with two more:
29304 \SpecialChar menuseparator
29309 \SpecialChar menuseparator
29316 Document\SpecialChar menuseparator
29317 View\SpecialChar menuseparator
29321 Here is how it looks like:
29324 \begin_layout LyX-Code
29328 \begin_layout LyX-Code
29332 \begin_layout LyX-Code
29333 Icon "layout Standard"
29336 \begin_layout LyX-Code
29337 Icon "layout Section"
29340 \begin_layout LyX-Code
29341 Icon "layout \SpecialChar LaTeX
29345 \begin_layout LyX-Code
29346 Icon "layout \SpecialChar LyX
29350 \begin_layout LyX-Code
29351 Icon "flex.insert Chunk"
29354 \begin_layout LyX-Code
29358 \begin_layout LyX-Code
29362 \begin_layout LyX-Code
29363 Icon "buffer-typeset"
29366 \begin_layout LyX-Code
29367 Icon "build-program"
29370 \begin_layout LyX-Code
29374 \begin_layout LyX-Code
29378 \begin_layout LyX-Code
29382 \begin_layout LyX-Code
29386 \begin_layout LyX-Code
29390 \begin_layout Subsubsection
29391 Colors customization
29394 \begin_layout Standard
29395 There are a number of colors in \SpecialChar LyX
29396 that can be customized in
29401 One of the things that bothers people is the \SpecialChar LaTeX
29403 The default color is red, since the chunks uses \SpecialChar LaTeX
29404 font, and there is a lot
29405 of chunks in literate documents, you may get tired of seeing everything
29407 You can change it by going to the tabs
29416 \begin_layout Standard
29417 The next thing is the visible presence of the newline character in the screen.
29418 You can choose the color of this particular character and make it blend
29420 I recommend you choosing a color that is close to the background but not
29421 equal, that way you still can see it is there, but it is not bothering
29425 \begin_layout Subsection
29430 \begin_layout Standard
29439 is documented in the
29443 example file and in the Sweave manual (menu
29445 Help\SpecialChar menuseparator
29451 \begin_layout Chapter
29453 \change_deleted 564990737 1671355343
29457 \begin_layout Standard
29459 \change_deleted 564990737 1671355343
29460 You can do everything with \SpecialChar LyX
29461 that you can do with \SpecialChar LaTeX
29463 However, \SpecialChar LyX
29464 cannot support every \SpecialChar LaTeX
29466 But you can always use \SpecialChar TeX
29468 This chapter shows you some more special things you might want to use.
29469 For other special things you can do with figures, tables, floats, boxes
29470 and notes, have a look at the
29473 \begin_inset space ~