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 1671042028
7124 \begin_layout Standard
7126 \change_inserted 564990737 1671042028
7132 \begin_inset space \thinspace{}
7142 This provides the following additional environments:
7145 \begin_inset space ~
7153 \begin_inset space ~
7161 \begin_inset space ~
7184 is available in the menu
7189 ile\SpecialChar menuseparator
7191 \begin_inset space ~
7199 \begin_inset space ~
7205 It has been customized with further environments and contains all the informati
7207 However, the documentation is also available from
7208 \begin_inset CommandInset href
7211 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
7219 \begin_layout Subsection
7221 \change_inserted 564990737 1671042046
7227 \begin_layout Standard
7229 \change_inserted 564990737 1671042046
7235 \begin_inset space \thinspace{}
7240 provides an alternative to the
7245 It provides similar functionality, but you might prefer this layout with
7246 sans serif sections, headings, and more.
7249 \begin_layout Subsection
7254 \begin_layout Standard
7260 \begin_layout Standard
7261 \begin_inset VSpace bigskip
7267 \begin_layout Standard
7272 \begin_inset space ~
7277 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
7279 \begin_inset Formula $\beta$
7282 release of May, 1999) class.
7285 \begin_layout Standard
7291 textclass, which works with Rev\SpecialChar TeX
7293 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
7295 That means that it doesn't interact very well with \SpecialChar LyX
7296 , which requires \SpecialChar LaTeX2e
7298 it has been kludged to work.
7299 Since Rev\SpecialChar TeX
7300 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
7307 \begin_inset space ~
7312 textclass should also be pretty easy to use.
7315 \begin_layout Standard
7316 These documents are supposed to be used in
7320 to the Rev\SpecialChar TeX
7321 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
7323 and assume you'll know what to put in the preamble if necessary.
7326 \begin_layout Subsubsection
7330 \begin_layout Standard
7331 All you need to do is install Rev\SpecialChar TeX
7332 4, as described in the package's README
7334 The package can be found at The Rev\SpecialChar TeX
7336 \begin_inset Flex URL
7339 \begin_layout Plain Layout
7341 http://publish.aps.org/revtex4/
7347 Install it somewhere that \SpecialChar LaTeX
7349 Test it by trying to \SpecialChar LaTeX
7350 a short Rev\SpecialChar TeX
7351 4 document in some random directory (i.
7352 \begin_inset space \thinspace{}
7356 \begin_inset space \space{}
7359 not the directory where you installed the class file.) Then, if you reconfigure
7361 , it will find the class file and let you use the Rev\SpecialChar TeX
7365 \begin_layout Standard
7366 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
7375 \begin_inset space ~
7380 template, found in the templates directory.
7383 \begin_layout Subsubsection
7387 \begin_layout Standard
7388 Optional arguments to
7395 \begin_inset Quotes eld
7399 \begin_inset Quotes erd
7403 \begin_inset Quotes eld
7407 \begin_inset Quotes erd
7413 \begin_inset space ~
7421 \begin_inset space ~
7427 Remember that in Rev\SpecialChar TeX
7428 , at least one optional argument is required!
7431 \begin_layout Standard
7432 Other preamble matter, like
7439 \begin_inset space ~
7446 \begin_inset space ~
7451 dialog, also as usual.
7454 \begin_layout Subsubsection
7458 \begin_layout Standard
7459 The layouts basically correspond to the commands in Rev\SpecialChar TeX
7461 For example, the Email layout corresponds to
7468 Note that (at least as of Rev\SpecialChar TeX
7477 layouts are exactly equivalent, so you shouldn't need to use both.
7481 \begin_layout Plain Layout
7482 In case you're curious, both were included so that
7486 would be able to translate both
7506 \begin_layout Subsubsection
7510 \begin_layout Standard
7511 There are a couple of important unique aspects of Rev\SpecialChar TeX
7513 bugs that will be even more confusing in \SpecialChar LyX
7517 \begin_layout Standard
7518 In Rev\SpecialChar TeX
7536 The \SpecialChar LyX
7537 equivalent is that there is a separate Thanks layout.
7542 write footnotes in the
7546 layout, or weird things may happen.
7547 See the Rev\SpecialChar TeX
7548 4 documentation for more details.
7551 \begin_layout Standard
7555 \begin_inset space ~
7563 \begin_inset space ~
7572 layouts must be placed
7580 layout and the corresponding
7597 , the \SpecialChar LaTeX
7601 \begin_layout Subsection
7603 \change_inserted 564990737 1671042072
7609 \begin_layout Standard
7611 \change_inserted 564990737 1671042072
7618 classes were replaced in 2013 with a completely new
7623 This package provides a \SpecialChar LaTeX
7624 class and templates for books to be published
7625 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
7626 Research, Springer VS Research, or Springer VS Forschung.
7627 The documentation is available in German from
7628 \begin_inset CommandInset href
7631 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
7639 \begin_layout Section
7641 \change_inserted 564990737 1670439560
7645 \begin_layout Standard
7647 \change_inserted 564990737 1670439581
7648 See also the document classes in the Collections (section
7649 \begin_inset space ~
7653 \begin_inset CommandInset ref
7655 reference "sec:Collections"
7662 \begin_layout Subsection
7666 \begin_layout Standard
7672 \begin_layout Subsubsection
7676 \begin_layout Standard
7677 Memoir is a very powerful and constantly evolving class.
7678 It has been designed with regard to fictional and non-fictional literature.
7679 Its aim is to let the user have maximum control over the typesetting of
7681 Memoir is based on the standard book class, but it can also emulate the
7682 article class (see below).
7685 \begin_layout Standard
7686 Peter Wilson, the developer of Memoir, is known as the author of lots of
7687 useful packages in the \SpecialChar LaTeX
7689 Most of them have been merged with Memoir.
7690 Therefore, it is much easier to layout the table of contents, appendices,
7691 chapter designs and such.
7693 , though, does not support all of these goodies natively.
7694 Some of them might be added to forthcoming releases
7698 \begin_layout Plain Layout
7699 You are invited to send suggestions to
7700 \begin_inset Flex URL
7703 \begin_layout Plain Layout
7705 lyx-devel@lists.lyx.org
7715 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
7717 Of course you can still use all features with the help of some native \SpecialChar LaTeX
7719 commands (\SpecialChar TeX
7724 \begin_layout Plain Layout
7729 \begin_layout Plain Layout
7739 \begin_inset space ~
7743 \begin_inset CommandInset ref
7745 reference "sec:Inserting-TeX-Code"
7755 In this section, we can only list those features that are natively supported
7758 For detailed descriptions (and for the rest of features) we recommend you
7759 have a look at the detailed manual of the Memoir class
7763 \begin_layout Plain Layout
7768 \begin_layout Plain Layout
7778 \begin_inset Flex URL
7781 \begin_layout Plain Layout
7783 CTAN:/macros/latex/memoir/memman.pdf
7793 , which is not only a user guide for the class, but also both a comprehensive
7794 description on good typesetting and a superb example for good typesetting
7798 \begin_layout Subsubsection
7799 Basic features and restrictions
7802 \begin_layout Standard
7803 Memoir supports basically all features of the standard book classes.
7804 There are, however, some differences, as follows:
7807 \begin_layout Description
7809 \begin_inset space ~
7812 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
7815 \begin_layout Description
7817 \begin_inset space ~
7820 style: The fancy page style is not supported, due to a command clash between
7821 Memoir and the fancyhdr package (they both define a command with the same
7822 name, which confuses \SpecialChar LaTeX
7824 Instead, Memoir comes with a number of its own page styles (see
7826 Document\SpecialChar menuseparator
7827 Settings\SpecialChar menuseparator
7829 \begin_inset space ~
7835 If you want to use these for the chapter pages, you have to use the command
7842 in the main text or in preamble (e.
7843 \begin_inset space \thinspace{}
7847 \begin_inset space \space{}
7854 chapterstyle{companion}
7859 \begin_layout Description
7860 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
7861 optional argument in the standard classes.
7862 With this, you can specify an alternative version of the title for the
7863 table of contents and the headers (for instance, if the title is too long).
7865 , you can do this via
7867 Insert\SpecialChar menuseparator
7869 \begin_inset space ~
7874 at the beginning of a chapter/section.
7875 Memoir features a second optional argument and thus separates the table
7876 of contents from the header.
7877 You can define three variants of a title with this: one for the main text,
7878 one for the table of contents, and one for the headers.
7880 makes these available in form of specific
7891 \begin_layout Description
7892 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
7893 of contents, the list of figures and the list of table start a new page
7895 Memoir does not follow this route.
7896 You have to insert a page break yourself, if you want to have one.
7899 \begin_layout Description
7900 Titlepage: For some unknown reason, Memoir uses pagination on the title
7901 page (in the standard classes, title pages are
7902 \begin_inset Quotes eld
7906 \begin_inset Quotes erd
7910 If you want an empty title page, type
7914 aliaspagestyle{title}{empty}
7919 \begin_layout Description
7920 Article: With the class option
7926 Document\SpecialChar menuseparator
7927 Settings\SpecialChar menuseparator
7928 Class Settings\SpecialChar menuseparator
7930 \begin_inset space ~
7935 ), you can emulate article style.
7936 That is, counters (footnotes, figures, tables etc.) will not be reset on
7937 new chapters, chapters don't start a new page (but are—in contrary to
7938 \begin_inset Quotes eld
7942 \begin_inset Quotes erd
7945 article classes—still allowed), parts, though, use their own page, as in
7949 \begin_layout Description
7950 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
7951 font commands, which have been used in the old \SpecialChar LaTeX
7953 \begin_inset space \thinspace{}
7957 \begin_inset space \space{}
7973 It produces an error and stops \SpecialChar LaTeX
7974 whenever such a command appears.
7979 reallows the commands and spits out warnings instead (which does at least
7980 not stop \SpecialChar LaTeX
7982 Since a lot of packages and particularly Bib\SpecialChar TeX
7983 style files are still using
7984 those commands, we have decided to use this option by default.
7987 \begin_layout Subsubsection
7991 \begin_layout Standard
7992 We will only describe the features supported by \SpecialChar LyX
7993 (which is not much currently).
7994 Please consult the Memoir manual
7998 \begin_layout Plain Layout
8003 \begin_layout Plain Layout
8013 \begin_inset Flex URL
8016 \begin_layout Plain Layout
8018 CTAN:/macros/latex/memoir/memman.pdf
8031 \begin_layout Description
8032 Abstract: You may wonder why an abstract is an extra feature.
8033 Well, it is in book class.
8034 Usually books don't have abstracts.
8035 Memoir, however, has.
8036 You can use it wherever and how often you like.
8039 \begin_layout Description
8040 Chapterprecis: You may know this older typesetting style: The contents of
8041 a chapter are summarized below the title and also in the table of contents
8043 \begin_inset space \thinspace{}
8047 \begin_inset space \space{}
8052 Our hero arrives in Troia; he loses some friends; he finds others
8055 Chapterprecis does exactly this.
8056 It is therefore only sensible below a chapter.
8059 \begin_layout Description
8060 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
8061 The epigraph environment provides an elegant way of typesetting such a
8063 The motto itself (text) and its (optional) author (source) are divided
8065 The author (source) can be inserted via
8067 Insert\SpecialChar menuseparator
8074 \begin_layout Description
8075 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
8076 complex figurative poems).
8078 can only support a few of them.
8079 One is poemtitle, which is a centered title for poems, which will also
8080 be added to the table of contents (verse is the standard environment for
8082 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
8084 because they have to be nested inside regular verse environments, which
8085 is not possible with \SpecialChar LyX
8089 \begin_layout Description
8090 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
8093 \begin_layout Section
8095 \change_inserted 564990737 1670439605
8099 \begin_layout Section
8101 \change_inserted 564990737 1671041968
8105 \begin_layout Subsection
8107 \change_inserted 564990737 1671041970
8113 \begin_layout Standard
8115 \change_inserted 564990737 1671041970
8126 document class for writing letters according to the
8128 Deutsches Institut für Normung
8140 ile\SpecialChar menuseparator
8142 \begin_inset space ~
8150 \begin_inset space ~
8155 offers guidance on its use.
8156 The documentation is available from
8157 \begin_inset CommandInset href
8160 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
8168 \begin_layout Section
8170 \change_inserted 564990737 1670439660
8174 \begin_layout Subsection
8177 Foil\SpecialChar TeX
8181 \begin_inset CommandInset label
8190 \begin_layout Standard
8196 \begin_layout Subsubsection
8200 \begin_layout Standard
8201 This section describes how to use \SpecialChar LyX
8202 to make slides for overhead projectors.
8203 There are two document classes that can do this: the default slides class
8206 Foil\SpecialChar TeX
8210 This section documents the latter.
8213 \begin_layout Standard
8214 I'm going to say this again, nice and clear, so that there's no misunderstanding
8218 \begin_layout Standard
8219 \begin_inset VSpace bigskip
8225 \begin_layout Standard
8229 This section documents the class
8230 \begin_inset Quotes eld
8238 \begin_inset Quotes erd
8246 \begin_layout Standard
8247 \begin_inset VSpace bigskip
8253 \begin_layout Standard
8254 If you're looking for the documentation for
8255 \begin_inset Quotes eld
8263 \begin_inset Quotes erd
8267 \begin_inset space ~
8271 \begin_inset CommandInset ref
8273 reference "sec:slitex"
8278 If your machine doesn't have the
8286 installed, you'll probably have to use the default
8290 class, which isn't quite as good as
8295 \begin_layout Standard
8300 class is designed for use with version
8301 \begin_inset space ~
8309 class file which is now an integral part of \SpecialChar LaTeX2e
8313 \begin_layout Subsubsection
8317 \begin_layout Standard
8318 Obviously, to use this document class, you need to select
8329 \begin_inset space ~
8335 There are some settings in the
8338 \begin_inset space ~
8343 dialog that you should know about that are specific to this class:
8346 \begin_layout Itemize
8347 Don't change the options
8358 \begin_inset space ~
8364 They're ignored by the
8371 \begin_layout Itemize
8372 The default font size is 20
8373 \begin_inset space \thinspace{}
8376 pt with the other options being 17
8377 \begin_inset space \thinspace{}
8381 \begin_inset space \thinspace{}
8385 \begin_inset space \thinspace{}
8391 \begin_layout Itemize
8400 but all math equations are still typeset in the usual roman font.
8403 \begin_layout Itemize
8406 Foil\SpecialChar TeX
8409 supports A4 and Letter paper sizes as well as a special size for working
8411 \begin_inset space \thinspace{}
8415 It doesn't support A5, B5, legal or executive paper sizes.
8418 \begin_layout Itemize
8419 Don't bother changing the
8423 settings because they are ignored anyway.
8424 All floats appear where they are defined in the text.
8427 \begin_layout Itemize
8432 setting behaves a bit differently for this class.
8435 Foil\SpecialChar TeX
8438 provides extensive footer and header capabilities including a user-defined
8441 \begin_inset space ~
8445 \begin_inset CommandInset ref
8447 reference "sec:foilfoot"
8452 The title page is treated differently to all other pages in the document
8461 has the logo centered at the bottom of the page (if one is defined).
8462 The possible page style choices and what they do are as follows:
8466 \begin_layout Labeling
8467 \labelwidthstring MMMMMMM
8474 The final output contains no page numbers, or other headers or footers
8475 (except footnotes of course).
8479 \begin_layout Labeling
8480 \labelwidthstring MMMMMMM
8487 The final output contains page numbers centered at the bottom of the page.
8488 No other headings or footers (other than footnotes).
8491 \begin_layout Labeling
8492 \labelwidthstring MMMMMMM
8497 Page numbers in lower right corner.
8498 Additional headers and footers are also shown.
8499 This is also the default.
8502 \begin_layout Labeling
8503 \labelwidthstring MMMMMMM
8508 Gives you access to the
8512 package although its use with
8514 Foil\SpecialChar TeX
8517 is discouraged by the writer of the
8519 Foil\SpecialChar TeX
8522 package because of some potential page layout clashes.
8526 \begin_layout Paragraph
8530 \begin_layout Standard
8531 The following options may be used in the extra class options in the
8533 Document\SpecialChar menuseparator
8539 \begin_layout Labeling
8540 \labelwidthstring MMMMMMx
8545 This sets up the page layout for 7.33
8546 \begin_inset space \thinspace{}
8550 \begin_inset space \thinspace{}
8553 in paper, which is about the same aspect ratio as a 35
8554 \begin_inset space \thinspace{}
8557 mm slide, making it a bit easier to work with this medium.
8560 \begin_layout Labeling
8561 \labelwidthstring MMMMMMx
8566 Places a rule across the page below the header on every page except the
8570 \begin_layout Labeling
8571 \labelwidthstring MMMMMMx
8576 Places a rule across the page above the footer on every page except the
8580 \begin_layout Labeling
8581 \labelwidthstring MMMMMMx
8586 This is automatically set each time you create a new
8593 Foil\SpecialChar TeX
8596 to use the dvips driver to rotate those pages that are set as landscape
8600 \begin_layout Labeling
8601 \labelwidthstring MMMMMMx
8606 Simply changes the page dimensions to those of a landscape page but doesn't
8608 Thus if you use this option you need to use an external program to rotate
8609 each page or feed your paper through your printer as landscape.
8610 Note that this option effectively reverses the roles of the
8618 environments (don't worry these are described in the next section).
8621 \begin_layout Labeling
8622 \labelwidthstring MMMMMMx
8627 Equation numbers on the left.
8630 \begin_layout Labeling
8631 \labelwidthstring MMMMMMx
8636 Flush-left equations.
8639 \begin_layout Subsubsection
8640 Supported Environments
8643 \begin_layout Standard
8644 Most of the environments commonly supported in other classes are also supported
8650 There are several additional environments provided by
8652 Foil\SpecialChar TeX
8655 as well as a couple added by \SpecialChar LyX
8657 The following environments are shared with other classes:
8660 \begin_layout Standard
8661 \begin_inset Flex Multiple Columns
8664 \begin_layout Itemize
8670 \begin_layout Itemize
8676 \begin_layout Itemize
8682 \begin_layout Itemize
8688 \begin_layout Itemize
8694 \begin_layout Itemize
8701 \begin_layout Itemize
8707 \begin_layout Itemize
8713 \begin_layout Itemize
8719 \begin_layout Itemize
8725 \begin_layout Itemize
8731 \begin_layout Itemize
8737 \begin_layout Itemize
8743 \begin_layout Itemize
8749 \begin_layout Itemize
8760 \begin_layout Standard
8761 That is, all the major environments apart from the sectioning environments.
8762 Since foils are essentially self-contained sections, with a title and body,
8765 Foil\SpecialChar TeX
8768 provides specific commands for starting new foils and these are:
8771 \begin_layout Itemize
8777 \begin_layout Itemize
8783 \begin_layout Standard
8785 also provides slightly modified versions of these two environments called:
8788 \begin_layout Itemize
8794 \begin_layout Itemize
8800 \begin_layout Standard
8801 and the differences will be explained in the next section.
8804 \begin_layout Standard
8805 Since foils are often used in presenting ideas or new theorems and such
8808 Foil\SpecialChar TeX
8811 also provides a comprehensive box of goodies for presenting them:
8814 \begin_layout Standard
8815 \begin_inset Flex Multiple Columns
8818 \begin_layout Itemize
8824 \begin_layout Itemize
8830 \begin_layout Itemize
8836 \begin_layout Itemize
8842 \begin_layout Itemize
8848 \begin_layout Itemize
8854 \begin_layout Itemize
8860 \begin_layout Itemize
8866 \begin_layout Itemize
8872 \begin_layout Itemize
8878 \begin_layout Itemize
8889 \begin_layout Standard
8890 The starred versions are unnumbered while the unstarred versions are numbered.
8891 There are also two list environments added by \SpecialChar LyX
8895 \begin_layout Itemize
8901 \begin_layout Itemize
8907 \begin_layout Standard
8910 Foil\SpecialChar TeX
8913 provides some powerful header and footer capabilities that are best set
8914 in the preamble although they may be set at any point in a document.
8915 If you want to change these settings in your document the best place to
8916 do so is at the very top of a foil, i.
8917 \begin_inset space \thinspace{}
8923 \begin_inset space \space{}
8928 straight after the foilhead.
8931 \begin_layout Standard
8932 For this purpose, the following command styles are provided [
8939 \begin_layout Standard
8940 \begin_inset Flex Multiple Columns
8943 \begin_layout Itemize
8947 \begin_inset space ~
8953 \begin_layout Itemize
8959 \begin_layout Itemize
8963 \begin_inset space ~
8969 \begin_layout Itemize
8973 \begin_inset space ~
8979 \begin_layout Itemize
8983 \begin_inset space ~
8990 \begin_layout Plain Layout
8991 \begin_inset space ~
9003 \begin_layout Standard
9004 There are also a few commands provided by
9006 Foil\SpecialChar TeX
9009 that aren't directly supported by \SpecialChar LyX
9010 but I'll tell you what they do and how
9011 to use them in section
9012 \begin_inset space ~
9016 \begin_inset CommandInset ref
9018 reference "sec:unsuppfoils"
9025 \begin_layout Subsubsection
9026 Building a Set of Foils
9029 \begin_layout Standard
9030 This section will give a simple introduction to using the different environments
9031 to build a set of foils.
9032 If you want to see an example set of foils, take a look at the
9036 file you find in \SpecialChar LyX
9044 \begin_layout Paragraph
9045 Give It a Title Page
9048 \begin_layout Standard
9049 Unlike other classes that provide
9069 creates the title on a page of its own.
9070 If you leave out the
9074 environment \SpecialChar LaTeX
9075 will substitute the current date (every time you regenerate
9079 \begin_layout Paragraph
9083 \begin_layout Standard
9084 As I mentioned earlier, there are four ways of starting a new foil.
9085 For portrait foils you should use
9094 The difference between these two environments is the amount of space between
9095 the title of the foil (the foilhead) and the body of the foil.
9098 \begin_layout Standard
9099 Landscape foils are generated using the
9108 Again the only difference is the spacing between foilhead and body.
9109 Both of the short versions have 0.5
9110 \begin_inset space ~
9113 inches less separation between the foilhead and the body.
9117 \begin_layout Standard
9118 One problem with the support for landscape foils is the requirement that
9123 driver to generate the PostScript output otherwise the foils won't be rotated.
9124 It is possible to get landscape foils even if you haven't got the
9128 driver provided you can feed your foils sideways through your printer ;-)
9131 \begin_layout Paragraph
9132 Theorems, Lemmas, Proofs and more
9135 \begin_layout Standard
9136 You can't have two of the same type of these environments directly following
9138 If you use a normal paragraph break, , you will just be extending the previous
9139 environment as if you had merged the two environments together.
9140 Rather than that, you need to insert a so-called separator.
9141 Please refer to the section entitled
9152 \begin_layout Paragraph
9156 \begin_layout Standard
9157 You get all the commonly supported list styles found in other classes as
9158 well as two new ones.
9159 I'll only describe the new ones here.
9160 If you want to find out more about the other list environments check out
9166 If you intend to use itemized lists you might also want to read about the
9170 \begin_inset space ~
9174 \begin_inset space ~
9179 dialog described above in section
9180 \begin_inset space ~
9184 \change_inserted 564990737 1671355684
9186 \begin_inset CommandInset ref
9188 reference "chap:bullets"
9193 \change_deleted 564990737 1671355684
9195 \begin_inset CommandInset ref
9197 reference "sec:bullet"
9206 \begin_layout Standard
9207 The two new list styles,
9215 , are designed to make it easier for you to create lists of do's and don'ts
9216 or right and wrong by providing dedicated environments that use a tick
9217 or a cross as the label of the list.
9218 These lists are in fact dedicated variants of the
9223 They do however require that you have the
9230 \begin_layout Paragraph
9234 \begin_layout Standard
9237 Foil\SpecialChar TeX
9240 redefines the floating tables and figures so that they appear exactly where
9241 they are in the text rather than pushing them to the top of the page or
9242 to some user specified location.
9243 In fact if you change the float placement settings they are simply ignored.
9246 \begin_layout Paragraph
9247 Page Headers and Footers
9248 \begin_inset CommandInset label
9257 \begin_layout Standard
9261 \begin_inset space ~
9270 are two commands used to control the left-footer text string.
9271 The first is meant to allow you to include a graphic logo on your foils
9273 \begin_inset Quotes eld
9278 Foil\SpecialChar TeX
9282 \begin_inset Quotes erd
9286 While the second is meant to provide a classification for the audience,
9290 \begin_inset space \thinspace{}
9296 \begin_inset space \space{}
9300 It is empty by default.
9303 \begin_layout Standard
9304 The remaining page corners can be filled by
9307 \begin_inset space ~
9312 (which defaults to page numbers),
9315 \begin_inset space ~
9323 \begin_inset space ~
9331 \begin_layout Subsubsection
9334 Foil\SpecialChar TeX
9338 \begin_inset CommandInset label
9340 name "sec:unsuppfoils"
9347 \begin_layout Standard
9348 All the commands mentioned below need to be set in a
9358 within another environment.
9361 \begin_layout Paragraph
9365 \begin_layout Standard
9366 All lengths are adjusted using the
9389 should be replaced by the name given to the length you want to change and
9394 is the length value.
9395 All lengths should be specified in units of length such as inches (
9407 ) or relative to some document or font-based length such as
9417 \begin_layout Standard
9418 It's possible to change the spacing between a foilhead and the body of the
9419 foil by adjusting the length specified by
9426 For example, to make
9431 \begin_inset space \space{}
9434 in closer to their bodies put the following in the preamble:
9440 foilheadskip}{-0.5in}
9443 \begin_layout Standard
9444 The spacings around floats can be adjusted by setting these lengths:
9447 \begin_layout Labeling
9448 \labelwidthstring MMMMMMMMMMM
9455 Separation between the text and the top of the float
9458 \begin_layout Labeling
9459 \labelwidthstring MMMMMMMMMMM
9466 Separation between the float and the caption
9469 \begin_layout Labeling
9470 \labelwidthstring MMMMMMMMMMM
9477 Separation between the caption and the following text
9480 \begin_layout Labeling
9481 \labelwidthstring MMMMMMMMMMM
9488 You can make the captions narrower than the surrounding text by adjusting
9490 Best done relative to
9499 \begin_layout Standard
9500 There are also several title page related lengths that you may find useful
9501 if you have a long title or several authors:
9504 \begin_layout Labeling
9505 \labelwidthstring MMMMMMMMMMM
9512 Separation from headers to
9517 \begin_layout Labeling
9518 \labelwidthstring MMMMMMMMMMM
9536 \begin_layout Labeling
9537 \labelwidthstring MMMMMMMMMMM
9551 \begin_layout Labeling
9552 \labelwidthstring MMMMMMMMMMM
9568 \begin_layout Labeling
9569 \labelwidthstring MMMMMMMMMMM
9585 \begin_layout Standard
9586 The last length related command affects all the list environments.
9597 a list environment then all the vertical spacing between the list items
9599 Note that this is a command not a length so it doesn't require
9605 like the stuff mentioned above.
9608 \begin_layout Paragraph
9612 \begin_layout Standard
9625 commands control whether the logo in the
9629 definition appear on a given page.
9636 in the preamble then none of the foils will have the logo on them.
9637 If you don't want the logo on a particular page place the
9643 directly after the foilhead of that page and the
9649 directly after the next foilhead.
9652 \begin_layout Standard
9653 If you decide to use the
9657 page style setting in the
9660 \begin_inset space ~
9665 dialog you should probably add
9675 to your preamble so headers and footers on landscape pages are correctly
9676 placed when rotated.
9677 This is due to some clashes between the page layouts provided by the
9688 \begin_layout Subsection
9695 \begin_inset CommandInset label
9704 \begin_layout Standard
9712 \begin_layout Subsubsection
9716 \begin_layout Standard
9717 This section describes how to use \SpecialChar LyX
9718 to make slides for overhead projectors.
9719 There are two document classes that can do this: the default slides class
9722 Foil\SpecialChar TeX
9726 This section documents the former.
9729 \begin_layout Standard
9730 I'm going to say this again, nice and clear, so that there's no misunderstanding
9734 \begin_layout Standard
9735 \begin_inset VSpace bigskip
9741 \begin_layout Standard
9745 This section documents the class
9746 \begin_inset Quotes eld
9754 \begin_inset Quotes erd
9762 \begin_layout Standard
9763 \begin_inset VSpace bigskip
9769 \begin_layout Standard
9770 If you're looking for the documentation for
9771 \begin_inset Quotes eld
9776 slides (Foil\SpecialChar TeX
9780 \begin_inset Quotes erd
9784 \begin_inset space ~
9788 \begin_inset CommandInset ref
9790 reference "sec:foiltex"
9800 \begin_inset Quotes eld
9805 slides (Foil\SpecialChar TeX
9809 \begin_inset Quotes erd
9812 ] is actually somewhat better than the default
9820 \begin_layout Plain Layout
9822 or so I've been told repeatedly by its advocates.
9823 Having never used it, I have no idea if this claim is true or not.
9828 which this section documents.
9831 \begin_layout Standard
9832 This class is the \SpecialChar LaTeX2e
9833 improvement of the old
9839 Every \SpecialChar LaTeX2e
9840 distribution includes this class [which I'll just refer to as
9841 \begin_inset Quotes eld
9849 \begin_inset Quotes erd
9852 from now on], so you're bound to have it.
9853 As I noted earlier, there are other classes, such as
9857 , which also produce slides for overhead projectors and do a better job
9859 However, there are some things which
9863 can do which the others can't, such as generate overlays.
9864 Read on to learn more!
9867 \begin_layout Subsubsection
9869 \begin_inset CommandInset label
9871 name "sec:slidesetup"
9878 \begin_layout Standard
9879 Obviously, to use this document class, you need to select
9880 \begin_inset Quotes eld
9888 \begin_inset Quotes erd
9891 from the class list in the
9893 Document\SpecialChar menuseparator
9897 There are some other special things you should know about this class:
9900 \begin_layout Itemize
9901 Don't bother changing the options
9906 They're not supported by the
9913 \begin_layout Itemize
9917 \begin_inset space ~
9922 behaves a bit differently for this class.
9923 The possible choices and what they do are as follows:
9927 \begin_layout Description
9932 The final output contains page numbers in the lower right corner.
9935 \begin_layout Description
9944 , but also prints out any time markers you've put in.
9945 This is the default.
9948 \begin_layout Description
9953 The final output contains no page numbers, time markers, or alignment markers.
9957 \begin_layout Itemize
9962 class has an extra option:
9968 \begin_inset Quotes eld
9976 \begin_inset Quotes erd
9979 in the extra class options.
9983 \begin_layout Standard
9984 Using this options allows you to add time markers to
9990 \begin_inset space ~
9994 \begin_inset CommandInset ref
9996 reference "sec:slideNote"
10004 \begin_layout Standard
10005 You can also use the template file
10006 \begin_inset Quotes eld
10014 \begin_inset Quotes erd
10017 to automatically set up a document to use the
10023 File\SpecialChar menuseparator
10025 \begin_inset space ~
10029 \begin_inset space ~
10034 to open your new document].
10035 The template file also contains some examples of the special paragraph
10036 environments used by this class.
10037 I'll describe those next.
10040 \begin_layout Subsubsection
10041 Paragraph Environments
10044 \begin_layout Paragraph
10045 Supported Environments
10048 \begin_layout Standard
10049 The first thing you'll notice when you start up a new
10053 document is the font size and type: it's the equivalent of the size
10054 \begin_inset Quotes eld
10062 \begin_inset Quotes erd
10068 \begin_inset space ~
10074 This is also what's used in the output.
10076 \begin_inset Quotes eld
10080 \begin_inset Quotes erd
10083 to remind you that this is a slide.
10084 Your final slides will use a larger font; ergo, you'll have less space.
10085 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
10088 \begin_layout Standard
10089 The next thing that becomes obvious is the changes to the paragraph environment
10090 pull-down box [at the far-left end of the toolbar].
10091 Most of the paragraph environments you're used to seeing are missing.
10092 There are also five new ones.
10097 class itself only supports certain paragraph environments:
10100 \begin_layout Itemize
10106 \begin_layout Itemize
10112 \begin_layout Itemize
10118 \begin_layout Itemize
10124 \begin_layout Itemize
10130 \begin_layout Itemize
10136 \begin_layout Itemize
10142 \begin_layout Itemize
10148 \begin_layout Itemize
10154 \begin_layout Itemize
10161 \begin_layout Standard
10162 All of the other standard environments, including the section-heading environmen
10163 ts, aren't used in the
10170 \begin_layout Standard
10171 On the other hand, you'll notice the following new environments:
10174 \begin_layout Itemize
10180 \begin_layout Itemize
10186 \begin_layout Itemize
10192 \begin_layout Itemize
10198 \begin_layout Itemize
10204 \begin_layout Standard
10205 These five are kind of quirky, due to a
10206 \begin_inset Quotes eld
10210 \begin_inset Quotes erd
10213 in \SpecialChar LyX
10215 You see, \SpecialChar LyX
10216 doesn't permit you to nest any other paragraph environment into
10217 an empty environment.
10218 Now, that's fine and dandy, but it means that you wouldn't be able to start
10219 a slide with anything except plain text.
10220 To deal with this, I've performed a little
10221 \begin_inset Quotes eld
10226 \begin_inset Quotes erd
10232 \begin_layout Paragraph
10233 Quirks of the New Environments
10234 \begin_inset CommandInset label
10236 name "sec:slideQuirk"
10243 \begin_layout Standard
10244 All five of the new paragraph environments are somewhat quirky due to inherent
10245 limitiations in the current version of \SpecialChar LyX
10247 As I just mentioned, \SpecialChar LyX
10248 forbids environments that begin with another environment.
10249 To get around this, the
10253 environment isn't a paragraph environment as described in the
10261 \begin_layout Standard
10262 You should consider
10275 \begin_inset Quotes eld
10278 pseudo-environments.
10279 \begin_inset Quotes erd
10282 They look like a section heading or a
10283 \begin_inset Quotes eld
10291 \begin_inset Quotes erd
10294 but really begin a [and, if necessary, end the previous] paragraph environment.
10304 \begin_inset Quotes eld
10308 \begin_inset Quotes erd
10311 These two perform some action.
10314 \begin_layout Standard
10315 A common feature of all five environments,
10335 , is a rather long-ish label.
10336 The text following this label — ordinarily the contents of the paragraph
10337 environment — is utterly irrelevant for
10359 completely ignores it.
10360 In fact, you can leave these five environments completely empty.
10364 \begin_layout Standard
10369 to put any text after the rather long-ish label, you might want to.
10370 This could be a short description of the contents of the
10375 In that case, enter your descriptive comment and hit
10379 as you normally would.
10382 \begin_layout Standard
10383 If, on the other hand, you don't want to enter any descriptive text, you'll
10384 hit another \SpecialChar LyX
10387 , like nature, abhors a vacuum, and will not let you start a new paragraph
10388 environment until you put something in the old one.
10392 \begin_layout Itemize
10393 Start entering the text that will
10421 \begin_layout Itemize
10422 Now move to the beginning of that paragraph.
10426 \begin_layout Itemize
10435 \begin_layout Itemize
10436 Finally, change this new, empty paragraph to a
10460 \begin_layout Standard
10461 Some future version of \SpecialChar LyX
10462 will, hopefully, resolve this quirkiness\SpecialChar ldots
10466 \begin_layout Subsubsection
10467 Making a Presentation with
10480 \begin_layout Paragraph
10488 \begin_layout Standard
10489 If you're expecting this section to teach you how to actually make a presentatio
10490 n, you'll be sorely disappointed.
10491 Naturally, I'll describe all of the ways the
10495 class can assist you in preparing the materials for a presentation.
10496 Filling in the contents, however, is up to you.
10501 the \SpecialChar LyX
10505 \begin_layout Standard
10510 environment [in the manner described in section
10511 \begin_inset space ~
10515 \begin_inset CommandInset ref
10517 reference "sec:slideQuirk"
10521 ] tells \SpecialChar LyX
10522 to begin a new slide [duh].
10523 The label for this environment/
10524 \begin_inset Quotes erd
10528 \begin_inset Quotes erd
10532 \begin_inset Quotes eld
10536 \begin_inset Quotes erd
10539 in cool blue, followed by the label,
10540 \begin_inset Quotes eld
10544 \begin_inset Quotes erd
10548 Any text or paragraph environments that follow this one go on the new slide.
10552 \begin_layout Standard
10553 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
10555 (this can be specified in the
10560 In fact, you'll want to, once you finish entering the contents of one slide.
10561 If you've entered more text than can physically fit on a slide, the extra
10562 overflows onto a new slide.
10563 I don't recommend doing this, however, since the overflow slide won't have
10564 any page number on it.
10565 Furthermore, it may interfere with any
10569 you've made to accompany the oversized
10576 \begin_layout Standard
10585 environments work the same way as the
10590 They both create an
10591 \begin_inset Quotes eld
10595 \begin_inset Quotes erd
10598 followed by a label [
10599 \begin_inset Quotes eld
10603 \begin_inset Quotes erd
10607 \begin_inset Quotes eld
10611 \begin_inset Quotes erd
10615 The color is a stunning magenta instead of blue, and the
10616 \begin_inset Quotes eld
10620 \begin_inset Quotes erd
10623 will look different, in style and in length.
10624 The label fonts of all three also differ from one another.
10627 \begin_layout Standard
10632 , if the contents of a
10640 exceed the physical size of a slide or sheet of paper, the extra will overflow
10642 Again, you should avoid this.
10643 It defeats the whole purpose of
10654 \begin_layout Paragraph
10664 \begin_layout Standard
10669 is a slide that sits atop another slide.
10670 Perhaps you wish to discuss a figure on the main
10674 before displaying the text associated with it.
10675 One way to accomplish this is tape a flap of dark paper over the part of
10680 you want to display later.
10681 This method fails, however, if you wish to overlap one graph with another,
10683 You would then have to fumble while speaking to align the two separate,
10688 s to align the two graphs.
10693 environment in both cases makes life much easier.
10696 \begin_layout Standard
10701 receives the page number of its
10702 \begin_inset Quotes eld
10706 \begin_inset Quotes erd
10714 \begin_inset Quotes eld
10722 \begin_inset Quotes erd
10729 \begin_layout Plain Layout
10730 Presumably, mutliple
10735 \begin_inset Quotes eld
10743 \begin_inset Quotes erd
10747 \begin_inset Quotes eld
10755 \begin_inset Quotes erd
10759 \begin_inset Quotes eld
10767 \begin_inset Quotes erd
10771 \begin_inset space ~
10774 appended to the page number of the parent
10784 Clearly, you want the contents of both the
10792 to each fit on a single physical slide! You should probably consider an
10798 \begin_inset Quotes eld
10802 \begin_inset Quotes erd
10810 Indeed, the \SpecialChar LyX
10815 class provides a visual cue for this: the label at the start of an
10819 is shorter than that at the start of a
10824 Lastly, when you generate printable output, you'll find alignment markers
10825 in all four corners of both the
10829 page and its parent
10834 These will assist you in lining up the two physical slides.
10837 \begin_layout Standard
10838 The major problem in overlaying two slides is aligning the contents of the
10839 two transparencies.
10840 How much space should you leave for that graph on the second slide? Worse
10841 still, what if you want a graph and a sentence on second slide, but there
10842 is text on the main transparency that goes in between them? You could try
10843 and insert vertical space of the right size.
10844 The better way is to use
10855 \begin_layout Standard
10856 As their names imply,
10864 are two command-like paragraph environments that make all subsequent text
10865 invisible and visible, respectively.
10867 \begin_inset space ~
10871 \begin_inset CommandInset ref
10873 reference "sec:slideQuirk"
10877 that you don't place anything
10881 these two environments, however.
10886 , it inserts a centered, sky-blue label into the page reading
10887 \begin_inset Quotes eld
10890 <Invisible Text Follows>
10891 \begin_inset Quotes erd
10895 For paragraphs following this label, the parts of the
10903 ; it doesn't matter which] where they would be contain instead blank space.
10907 \begin_layout Standard
10912 , the corresponding centered label is
10913 \begin_inset Quotes eld
10916 <Visible Text Follows>
10917 \begin_inset Quotes erd
10921 Paragraphs following this label behave normally.
10922 Note that the beginning of a new
10934 automatically shuts off an
10939 It's therefore not necessary to use
10950 \begin_layout Standard
10951 By now, it should be obvious how to create overlay transparencies using
10952 the proper combination of
10971 \begin_layout Enumerate
10976 , including everything that will appear on it, whether on the main slide
10984 \begin_layout Enumerate
10985 Before each figure or paragraph that will appear only on the
10994 If necessary, insert a
10998 environment after the
11005 \begin_layout Enumerate
11010 immediately following the
11017 \begin_layout Enumerate
11018 Copy the contents of this
11029 \begin_layout Enumerate
11034 , change all of the
11045 \begin_layout Standard
11047 You've just made an
11054 \begin_layout Standard
11055 There's one problem with the way I've designed the \SpecialChar LyX
11060 class: you can't make text in the middle of a paragraph invisible, nor
11061 make text in the middle of an invisible paragraph visible again.
11062 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
11067 \begin_layout Plain Layout
11068 The commands of interest are:
11071 \begin_layout Itemize
11076 invisible \SpecialChar ldots
11080 \begin_layout Itemize
11085 visible \SpecialChar ldots
11089 \begin_layout Plain Layout
11091 and need to be marked as \SpecialChar TeX
11094 \begin_inset Quotes eld
11098 \begin_inset Quotes erd
11101 you wish to change goes in between the brackets [and after the
11114 If you don't know how to mark text as \SpecialChar TeX
11115 , see the appropriate section of
11128 \begin_layout Paragraph
11138 \begin_inset CommandInset label
11140 name "sec:slideNote"
11147 \begin_layout Standard
11156 is associated with a
11157 \begin_inset Quotes eld
11161 \begin_inset Quotes erd
11169 Here, too, the \SpecialChar LyX
11174 class provides visual cues.
11179 is shorter than that of a
11183 [yet longer than that of an
11187 ] and, like the label of an
11191 is shockingly magenta.
11192 Additionally, the printed
11196 has the page number of its
11197 \begin_inset Quotes eld
11201 \begin_inset Quotes erd
11209 \begin_inset Quotes eld
11217 \begin_inset Quotes erd
11221 \begin_inset Quotes eld
11229 \begin_inset Quotes erd
11233 \begin_inset Quotes eld
11241 \begin_inset Quotes erd
11245 You can have multiple
11249 s associated with a single
11261 , you'll probably want to break up long
11265 s so that they fit on a single sheet of paper.
11268 \begin_layout Standard
11273 is obvious: it contains anything additional you might want to say about
11279 It could also be used as a sheet of reminders for a particular
11284 In the case of the latter, you might want to make use of time markers.
11285 Currently, the \SpecialChar LyX
11291 \begin_inset Quotes eld
11295 \begin_inset Quotes erd
11298 support for time markers, a
11300 Sli\SpecialChar TeX
11304 So, you'll have to resort to using the \SpecialChar LaTeX
11308 \begin_layout Standard
11309 To use time markers, you'll need to specify the extra class option
11310 \begin_inset Quotes eld
11318 \begin_inset Quotes erd
11322 \begin_inset space ~
11326 \begin_inset CommandInset ref
11328 reference "sec:slidesetup"
11333 This option turns on timing marks, which will appear in the lower-left-hand
11339 To set what appears in the time marker, you use the \SpecialChar LaTeX
11341 \begin_inset Quotes eld
11351 \begin_inset Quotes erd
11355 \begin_inset Quotes eld
11365 \begin_inset Quotes erd
11369 The arguments of both commands are time measured in seconds.
11371 \begin_inset Quotes eld
11381 \begin_inset Quotes erd
11384 sets the time marker to a given time.
11386 \begin_inset Quotes eld
11396 \begin_inset Quotes erd
11399 increments the time marker by the specified amount.
11400 Using time markers and
11404 s in this fashion, you can remind yourself how much time to spend on a particula
11412 \begin_layout Standard
11413 There's one last feature to describe.
11414 Clearly, you'd like to print out all of your
11422 s on transparencies while printing all of your
11439 with which it is associated.
11440 What's a person to do?
11443 \begin_layout Standard
11444 Luckily, there are two \SpecialChar LaTeX
11445 commands that allow you to select what to print
11447 Both must be placed into the preamble of your document.
11449 \begin_inset Quotes eld
11461 \begin_inset Quotes erd
11464 will cause the output to contain only the
11473 Correspondingly, the command
11474 \begin_inset Quotes eld
11486 \begin_inset Quotes erd
11489 prevents the output of anything but
11494 I'd advise placing both commands in the preamble and initially comment
11496 You can then preview your entire presentation as you write.
11497 When you're done writing, you can then uncomment one of the two to select
11498 what you want to print.
11499 I like to uncomment
11500 \begin_inset Quotes eld
11512 \begin_inset Quotes erd
11515 , print to a file with
11516 \begin_inset Quotes eld
11524 \begin_inset Quotes erd
11527 in its name, comment it back out, then uncomment
11528 \begin_inset Quotes eld
11540 \begin_inset Quotes erd
11544 \begin_inset Quotes eld
11552 \begin_inset Quotes erd
11556 I can then send either file to a printer, loading transparencies or plain
11557 paper as appropriate.
11560 \begin_layout Standard
11561 You can also provide other arguments to the
11562 \begin_inset Quotes eld
11572 \begin_inset Quotes erd
11576 \begin_inset Quotes eld
11586 \begin_inset Quotes erd
11590 See a good \SpecialChar LaTeX
11594 \begin_layout Subsubsection
11599 Class Template File
11602 \begin_layout Standard
11603 I have also provided a template file,
11604 \begin_inset Quotes eld
11612 \begin_inset Quotes erd
11620 To use it, begin your new presentation with
11622 File\SpecialChar menuseparator
11624 \begin_inset space ~
11628 \begin_inset space ~
11634 Your new \SpecialChar LyX
11635 presentation file will contain an example
11656 additionally contain an example of the use of
11665 Lastly, the preamble will contain:
11668 \begin_layout LyX-Code
11669 % Uncomment to print out only slides and overlays
11672 \begin_layout LyX-Code
11676 \begin_layout LyX-Code
11682 \begin_inset Newline newline
11688 \begin_layout LyX-Code
11689 % Uncomment to print out only notes
11692 \begin_layout LyX-Code
11696 \begin_layout LyX-Code
11704 \begin_layout Standard
11705 One final thing: I created this class to support the \SpecialChar LaTeX2e
11707 \begin_inset Quotes eld
11712 Sli\SpecialChar TeX
11716 \begin_inset Quotes erd
11719 class, one of the built-in \SpecialChar LaTeX2e
11721 Neither I nor the rest of the \SpecialChar LyX
11722 Team endorse or oppose the use of this built-in
11724 It's here if you want it or need it.
11725 There exist other \SpecialChar LaTeX2e
11726 classes for creating presentations, such as the
11731 \begin_inset space ~
11735 \begin_inset CommandInset ref
11737 reference "sec:foiltex"
11742 \begin_inset Quotes eld
11750 \begin_inset Quotes erd
11753 package [present on some \SpecialChar TeX
11755 The latter is not yet supported under \SpecialChar LyX
11760 \begin_layout Plain Layout
11761 Perhaps you can take on the task\SpecialChar ldots
11767 I know nothing about these other classes.
11768 Try them out to see what sort of alternative they provide.
11771 \begin_layout Section
11773 \change_inserted 564990737 1670439661
11777 \begin_layout Subsection
11779 \change_inserted 564990737 1670439661
11783 \begin_layout Standard
11785 \change_inserted 564990737 1670439661
11794 document class for preparing reports.
11799 document class, this provides parts, chapters and sections but does not
11800 provide the paragraph styles needed for a book; like the
11804 document class, it provides the abstract paragraph style.
11805 In two-sided mode, it does not start a new chapter on the right hand page.
11808 \begin_layout Standard
11810 \change_inserted 564990737 1670439674
11815 document classes are described in the Collections (section
11816 \begin_inset space ~
11820 \begin_inset CommandInset ref
11822 reference "sec:Collections"
11829 \begin_layout Section
11831 \change_inserted 564990737 1670439674
11835 \begin_layout Subsection
11839 \begin_layout Standard
11845 \begin_layout Subsubsection
11849 \begin_layout Standard
11850 Broadway is for writing plays.
11851 The format is more decorative than Hollywood, and much less standardized.
11852 This format should be suitable for workshops.
11855 \begin_layout Subsubsection
11859 \begin_layout Standard
11860 The same as in Hollywood.
11863 \begin_layout Subsubsection
11867 \begin_layout Standard
11872 names as labels then cross-reference the label to insert the name.
11873 The cross-reference dialog will show the current cast of characters.
11876 \begin_layout Subsubsection
11877 Paper size and Margins
11880 \begin_layout Standard
11881 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11884 \begin_layout Subsubsection
11888 \begin_layout Standard
11889 The following environments are available.
11890 You can use broadway.bind to get the bind keys shown at the right.
11893 \begin_layout Itemize
11897 \begin_inset Newline newline
11902 You should not have to use this, but it is here for anything that does not
11906 \begin_layout Itemize
11910 \begin_inset space \hfill{}
11914 \begin_inset Newline newline
11919 Used to describe stage setting and the action.
11920 First use of speaker names in all CAPs.
11923 \begin_layout Itemize
11927 \begin_inset space \hfill{}
11931 \begin_inset Newline newline
11936 Automatically numbered.
11937 On screen it will be arabic, but will print as Roman.
11940 \begin_layout Itemize
11944 \begin_inset space \hfill{}
11948 \begin_inset Newline newline
11958 It is just centered text.
11961 \begin_layout Itemize
11965 \begin_inset space \hfill{}
11969 \begin_inset Newline newline
11974 Not automatically numbered.
11975 You supply the number.
11976 This is because I couldn't figure out how.
11979 \begin_layout Itemize
11983 \begin_inset space \hfill{}
11987 \begin_inset Newline newline
11992 A special case of Narrative to describe the setting and action as the curtain
11996 \begin_layout Itemize
12000 \begin_inset space \hfill{}
12004 \begin_inset Newline newline
12009 The speaker's (actor's) title, centered in all CAPS.
12012 \begin_layout Itemize
12016 \begin_inset space \hfill{}
12020 \begin_inset Newline newline
12025 Instructions to the speaker.
12026 The parentheses are automatically inserted.
12027 The ( will appear on screen, but both will be in the printed play.
12028 This environment is only used within
12035 \begin_layout Itemize
12039 \begin_inset space \hfill{}
12043 \begin_inset Newline newline
12048 What the Speaker says.
12051 \begin_layout Itemize
12055 \begin_inset space \hfill{}
12059 \begin_inset Newline newline
12064 The curtain comes down.
12067 \begin_layout Itemize
12071 \begin_inset space \hfill{}
12077 \begin_layout Itemize
12081 \begin_inset space \hfill{}
12087 \begin_layout Itemize
12091 \begin_inset space \hfill{}
12097 \begin_layout Standard
12101 \begin_layout Subsection
12102 Hollywood (Hollywood spec scripts)
12105 \begin_layout Standard
12111 \begin_layout Subsubsection
12115 \begin_layout Standard
12116 Getting the format of a Hollywood script right is a
12117 \begin_inset Quotes eld
12121 \begin_inset Quotes erd
12124 It is designed to make the readers focus on content and to be easy and
12125 familiar for the actors to read.
12126 Each page of a script should be one minute of film.
12127 Nothing goes in a script that you cannot see or hear on screen.
12128 The courier 12 pt font should be used throughout.
12132 \begin_layout Subsubsection
12136 \begin_layout Standard
12137 Speakers' lines should NEVER break in mid-sentence.
12138 If a speaker's lines continue over a page break, repeat the
12142 title followed by (Cont'd).
12145 \begin_layout Subsubsection
12149 \begin_layout Standard
12154 names as labels then cross-reference the label to insert the name.
12155 The cross-reference dialog will show the current cast of characters.
12156 You can use this to insert the speaker name in narratives also.
12159 \begin_layout Subsubsection
12160 Paper size and Margins
12163 \begin_layout Standard
12164 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12167 \begin_layout Subsubsection
12171 \begin_layout Standard
12172 The following environments are available.
12173 You can use hollywood.bind to get the bind keys shown at the right.
12176 \begin_layout Itemize
12180 \begin_inset Newline newline
12185 Used where nothing else works.
12189 \begin_layout Itemize
12195 \begin_inset space \hfill{}
12203 \begin_inset Newline newline
12206 Usually followed by something like
12207 \begin_inset Quotes eld
12210 on Sally waking up.
12211 \begin_inset Quotes erd
12217 \begin_layout Itemize
12221 \begin_inset space \hfill{}
12225 \begin_inset Newline newline
12230 Introduces a new INTERIOR camera set-up.
12231 Always followed by DAY or NIGHT, or something similar to define the lighting
12233 Everthing on this line in CAPS.
12236 \begin_layout Itemize
12240 \begin_inset space \hfill{}
12244 \begin_inset Newline newline
12249 Introduces a new EXTERIOR camera set-up.
12250 Everthing on this line in CAPS.
12253 \begin_layout Itemize
12257 \begin_inset space \hfill{}
12261 \begin_inset Newline newline
12266 The character speaking.
12269 \begin_layout Itemize
12273 \begin_inset space \hfill{}
12277 \begin_inset Newline newline
12282 Instructions to the speaker.
12283 The () are automatically inserted.
12286 \begin_layout Itemize
12290 \begin_inset space \hfill{}
12294 \begin_inset Newline newline
12306 \begin_layout Itemize
12310 \begin_inset space \hfill{}
12314 \begin_inset Newline newline
12319 Camera movement instruction.
12321 \begin_inset space \thinspace{}
12325 \begin_inset space \space{}
12331 \begin_layout Itemize
12335 \begin_inset space \hfill{}
12341 \begin_layout Itemize
12345 \begin_inset space \hfill{}
12351 \begin_layout Itemize
12355 \begin_inset space \hfill{}
12361 \begin_layout Itemize
12365 \begin_inset space \hfill{}
12371 \begin_layout Subsubsection
12375 \begin_layout Itemize
12379 \begin_layout Itemize
12383 \begin_layout Itemize
12385 \begin_inset space \thinspace{}
12392 \begin_layout Itemize
12397 \begin_layout Itemize
12398 PAN — camera movement
12401 \begin_layout Itemize
12402 INSERT — cut to close-up of
12405 \begin_layout Chapter
12407 \change_inserted 564990737 1671185876
12411 \begin_layout Section
12412 Multiple Text Columns
12415 \begin_layout Standard
12416 This feature is independent of the option
12418 Two-column document
12420 in the document settings under
12425 If you want to have 2
12426 \begin_inset space ~
12429 columns for the whole document, it is recommended to use the
12431 Two-column document
12434 For all other cases use this feature.
12437 \begin_layout Standard
12438 To use multiple text columns in your document, you have to load the module
12445 Document\SpecialChar menuseparator
12446 Settings\SpecialChar menuseparator
12449 ) and must have the \SpecialChar LaTeX
12451 \begin_inset Flex Code
12454 \begin_layout Plain Layout
12463 \begin_layout Standard
12464 Footnotes within multiple columns will be placed at the bottom of the page
12465 and not under each column.
12466 Within the different columns you can use everything, with the limitation
12467 that for floats you need to use the float option
12474 \begin_layout Subsection
12478 \begin_layout Standard
12479 If you want to have 2
12480 \begin_inset space ~
12483 columns in your text, insert a multicolumn inset via the menu
12485 Insert\SpecialChar menuseparator
12487 \begin_inset space ~
12490 Insets\SpecialChar menuseparator
12492 \begin_inset space ~
12497 where the columns should start.
12498 Write all text that should be printed in 2
12499 \begin_inset space ~
12502 columns into this inset.
12505 \begin_layout Standard
12506 Here is an example:
12509 \begin_layout Standard
12511 \begin_inset Flex Multiple Columns
12514 \begin_layout Plain Layout
12519 The Adventure of the Empty House
12522 \begin_inset Newline newline
12525 by Sir Arthur Conan Doyle
12528 \begin_layout Plain Layout
12531 It was in the spring of the year 1894 that all London was interested, and
12532 the fashionable world dismayed, by the murder of the Honourable Ronald
12533 Adair under most unusual and inexplicable circumstances.
12534 The public has already learned those particulars of the crime which came
12535 out in the police investigation, but a good deal was suppressed upon that
12536 occasion, since the case for the prosecution was so overwhelmingly strong
12537 that it was not necessary to bring forward all the facts.
12538 Only now, at the end of nearly ten years, am I allowed to supply those
12539 missing links which make up the whole of that remarkable chain.
12540 The crime was of interest in itself, but that interest was as nothing to
12541 me compared to the inconceivable sequel, which afforded me the greatest
12542 shock and surprise of any event in my adventurous life.
12543 Even now, after this long interval, I find myself thrilling as I think
12544 of it, and feeling once more that sudden flood of joy, amazement, and increduli
12545 ty which utterly submerged my mind.
12546 Let me say to that public, which has shown some interest in those glimpses
12547 which I have occasionally given them of the thoughts and actions of a very
12548 remarkable man, that they are not to blame me if I have not shared my knowledge
12549 with them, for I should have considered it my first duty to do so, had
12550 I not been barred by a positive prohibition from his own lips, which was
12551 only withdrawn upon the third of last month.
12559 \begin_layout Standard
12560 To get 3 or more columns, set the cursor into the multicolumn inset and
12563 Insert\SpecialChar menuseparator
12565 \begin_inset space ~
12569 \begin_inset space ~
12575 The number of the desired columns is written into that inset (for 3
12576 \begin_inset space ~
12580 \begin_inset Quotes eld
12584 \begin_inset Quotes erd
12588 \begin_inset Newline newline
12591 Here is an example with 3
12592 \begin_inset space ~
12598 \begin_layout Standard
12599 \begin_inset Flex Multiple Columns
12602 \begin_layout Plain Layout
12605 \begin_inset Argument 1
12608 \begin_layout Plain Layout
12615 It can be imagined that my close intimacy with Sherlock Holmes had interested
12616 me deeply in crime, and that after his disappearance I never failed to
12617 read with care the various problems which came before the public.
12618 And I even attempted, more than once, for my own private satisfaction,
12619 to employ his methods in their solution, though with indifferent success.
12620 There was none, however, which appealed to me like this tragedy of Ronald
12622 As I read the evidence at the inquest, which led up to a verdict of willful
12623 murder against some person or persons unknown, I realized more clearly
12624 than I had ever done the loss which the community had sustained by the
12625 death of Sherlock Holmes.
12626 There were points about this strange business which would, I was sure,
12627 have specially appealed to him, and the efforts of the police would have
12628 been supplemented, or more probably anticipated, by the trained observation
12629 and the alert mind of the first criminal agent in Europe.
12630 All day, as I drove upon my round, I turned over the case in my mind and
12631 found no explanation which appeared to me to be adequate.
12632 At the risk of telling a twice-told tale, I will recapitulate the facts
12633 as they were known to the public at the conclusion of the inquest.
12641 \begin_layout Standard
12642 You can have up to 10
12643 \begin_inset space ~
12646 columns if you want to, but that might not be very pleasant for the readers
12650 \begin_layout Standard
12651 \begin_inset Newpage newpage
12657 \begin_layout Subsection
12658 Columns inside Columns
12661 \begin_layout Standard
12662 You can also have columns inside columns:
12665 \begin_layout Standard
12666 \begin_inset Flex Multiple Columns
12669 \begin_layout Plain Layout
12672 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
12673 at that time governor of one of the Australian colonies.
12674 Adair's mother had returned from Australia to undergo the operation for
12675 cataract, and she, her son Ronald, and her daughter Hilda were living together
12679 \begin_layout Plain Layout
12680 \begin_inset Flex Multiple Columns
12683 \begin_layout Plain Layout
12686 The youth moved in the best society
12687 \begin_inset space ~
12690 – had, so far as was known, no enemies and no particular vices.
12691 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
12692 had been broken off by mutual consent some months before, and there was
12693 no sign that it had left any very profound feeling behind it.
12694 For the rest {sic} the man's life moved in a narrow and conventional circle,
12695 for his habits were quiet and his nature unemotional.
12696 Yet it was upon this easy-going young aristocrat that death came, in most
12697 strange and unexpected form, between the hours of ten and eleven-twenty
12698 on the night of March 30, 1894.
12706 \begin_layout Plain Layout
12709 Ronald Adair was fond of cards
12710 \begin_inset space ~
12713 – playing continually, but never for such stakes as would hurt him.
12714 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
12715 It was shown that, after dinner on the day of his death, he had played
12716 a rubber of whist at the latter club.
12717 He had also played there in the afternoon.
12722 The evidence of those who had played with him
12723 \begin_inset space ~
12727 Murray, Sir John Hardy, and Colonel Moran
12728 \begin_inset space ~
12731 – showed that the game was whist, and that there was a fairly equal fall
12733 Adair might have lost five pounds, but not more.
12734 His fortune was a considerable one, and such a loss could not in any way
12736 He had played nearly every day at one club or other, but he was a cautious
12737 player, and usually rose a winner.
12738 It came out in evidence that, in partnership with Colonel Moran, he had
12739 actually won as much as four hundred and twenty pounds in a sitting, some
12740 weeks before, from Godfrey Milner and Lord Balmoral.
12741 So much for his recent history as it came out at the inquest.
12749 \begin_layout Subsection
12753 \begin_layout Standard
12754 The examples in this section show some more special features of multiple
12758 \begin_layout Standard
12759 For more features of multiple columns, have a look at the
12760 \begin_inset CommandInset href
12762 name "documentation"
12763 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
12768 of the \SpecialChar LaTeX
12770 \begin_inset Flex Code
12773 \begin_layout Plain Layout
12782 \begin_layout Subsubsection
12786 \begin_layout Standard
12787 To add a preface text for multiple columns, set the cursor into the multicolumn
12788 inset and use the menu
12790 Insert\SpecialChar menuseparator
12794 Write your preface text into that inset.
12795 \begin_inset Newline newline
12798 This is an example with some preface text:
12801 \begin_layout Standard
12802 \begin_inset VSpace bigskip
12808 \begin_layout Standard
12809 \begin_inset Flex Multiple Columns
12812 \begin_layout Plain Layout
12813 \begin_inset Argument 2
12816 \begin_layout Plain Layout
12817 And the story continues and continues and continues and continues\SpecialChar ldots
12825 On the evening of the crime, he returned from the club exactly at ten.
12826 His mother and sister were out spending the evening with a relation.
12827 The servant deposed that she heard him enter the front room on the second
12828 floor, generally used as his sitting-room.
12829 She had lit a fire there, and as it smoked she had opened the window.
12830 No sound was heard from the room until eleven-twenty, the hour of the return
12831 of Lady Maynooth and her daughter.
12832 Desiring to say good-night, she attempted to enter her son's room.
12833 The door was locked on the inside, and no answer could be got to their
12834 cries and knocking.
12835 Help was obtained, and the door forced.
12836 The unfortunate young man was found lying near the table.
12837 His head had been horribly mutilated by an expanding revolver bullet, but
12838 no weapon of any sort was to be found in the room.
12846 \begin_layout Standard
12847 You can also use a section heading as the preface if you use a section command
12848 as \SpecialChar TeX
12850 For example the command
12853 \begin_layout LyX-Code
12856 subsection{subsection title}
12859 \begin_layout Standard
12860 creates a subsection.
12861 In this example the preface is a subsubsection:
12864 \begin_layout Standard
12865 \begin_inset Flex Multiple Columns
12868 \begin_layout Plain Layout
12869 \begin_inset Argument 2
12872 \begin_layout Plain Layout
12876 \begin_layout Plain Layout
12885 This is a subsubsection heading as a preface
12889 \begin_layout Plain Layout
12903 A minute examination of the circumstances served only to make the case more
12905 In the first place, no reason could be given why the young man should have
12906 fastened the door upon the inside.
12907 There was the possibility that the murderer had done this, and had afterwards
12908 escaped by the window.
12909 The drop was at least twenty feet, however, and a bed of crocuses in full
12911 Neither the flowers nor the earth showed any sign of having been disturbed,
12912 nor were there any marks upon the narrow strip of grass which separated
12913 the house from the road.
12914 Apparently, therefore, it was the young man himself who had fastened the
12916 But how did he come by his death? No one could have climbed up to the window
12917 without leaving traces.
12918 Suppose a man had fired through the window, he would indeed be a remarkable
12919 shot who could with a revolver inflict so deadly a wound.
12920 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
12921 a hundred yards of the house.
12922 No one had heard a shot.
12930 \begin_layout Standard
12931 If there is less vertical space than 6
12932 \begin_inset space ~
12935 text lines is left on the page at the beginning of the multiple columns,
12936 a page break will be inserted before the multiple columns.
12937 Depending on the number of lines of the preface text, you might want to
12939 This is done by setting the cursor into the mulitcolumn inset behind the
12940 preface (if there is any) and using the menu
12942 Insert\SpecialChar menuseparator
12944 \begin_inset space ~
12948 \begin_inset space ~
12952 \begin_inset space ~
12958 Insert into that inset the amount of space like e.
12959 \begin_inset space \thinspace{}
12963 \begin_inset space \space{}
12967 \begin_inset Quotes eld
12971 \begin_inset Quotes erd
12975 \begin_inset Newline newline
12978 In this example the space is set to 7
12979 \begin_inset space ~
12982 text lines by using
12983 \begin_inset Flex Code
12986 \begin_layout Plain Layout
12995 \begin_inset Flex Code
12998 \begin_layout Plain Layout
13006 needs to be inserted as \SpecialChar TeX
13010 \begin_layout Standard
13011 \begin_inset Flex Multiple Columns
13014 \begin_layout Plain Layout
13015 \begin_inset Argument 3
13018 \begin_layout Plain Layout
13023 \begin_layout Plain Layout
13039 On the evening of the crime, he returned from the club exactly at ten.
13040 His mother and sister were out spending the evening with a relation.
13041 The servant deposed that she heard him enter the front room on the second
13042 floor, generally used as his sitting-room.
13043 She had lit a fire there, and as it smoked she had opened the window.
13044 No sound was heard from the room until eleven-twenty, the hour of the return
13045 of Lady Maynooth and her daughter.
13046 Desiring to say good-night, she attempted to enter her son's room.
13047 The door was locked on the inside, and no answer could be got to their
13048 cries and knocking.
13049 Help was obtained, and the door forced.
13050 The unfortunate young man was found lying near the table.
13051 His head had been horribly mutilated by an expanding revolver bullet, but
13052 no weapon of any sort was to be found in the room.
13060 \begin_layout Subsubsection
13064 \begin_layout Standard
13065 The amount of space before and after multiple columns can be changed by
13066 changing the length
13067 \begin_inset Flex Code
13070 \begin_layout Plain Layout
13079 For example the command
13082 \begin_layout LyX-Code
13090 \begin_layout Standard
13091 in \SpecialChar TeX
13092 Code changes its value to 3
13093 \begin_inset space \thinspace{}
13097 The change must be made before the multiple columns' start.
13098 The predefined value is 13
13099 \begin_inset space \thinspace{}
13105 \begin_layout Standard
13107 \begin_inset Flex Code
13110 \begin_layout Plain Layout
13119 \begin_inset space \thinspace{}
13125 \begin_layout Standard
13129 \begin_layout Plain Layout
13135 multicolsep}{2.5cm}
13143 \begin_layout Standard
13144 \begin_inset Flex Multiple Columns
13147 \begin_layout Plain Layout
13150 All day I turned these facts over in my mind, endeavouring to hit upon some
13151 theory which could reconcile them all, and to find that line of least resistanc
13152 e which my poor friend had declared to be the starting-point of every investigat
13154 I confess that I made little progress.
13155 In the evening I strolled across the Park, and found myself about six o'clock
13156 at the Oxford Street end of Park Lane.
13157 A group of loafers upon the pavements, all staring up at a particular window,
13158 directed me to the house which I had come to see.
13159 A tall, thin man with coloured glasses, whom I strongly suspected of being
13160 a plain-clothes detective, was pointing out some theory of his own, while
13161 the others crowded round to listen to what he said.
13162 I got as near him as I could, but his observations seemed to me to be absurd,
13163 so I withdrew again in some disgust.
13164 As I did so I struck against an elderly, deformed man, who had been behind
13165 me, and I knocked down several books which he was carrying.
13173 \begin_layout Standard
13174 \begin_inset Note Greyedout
13177 \begin_layout Plain Layout
13182 The values you set with
13183 \begin_inset Flex Code
13186 \begin_layout Plain Layout
13194 will be used for all following multiple columns until you change them again.
13202 \begin_layout Standard
13206 \begin_layout Plain Layout
13218 \begin_inset Note Note
13221 \begin_layout Plain Layout
13222 go back to the default
13230 \begin_layout Standard
13231 \begin_inset Newpage newpage
13237 \begin_layout Subsubsection
13241 \begin_layout Standard
13242 A column break can be forced by inserting the command
13243 \begin_inset Flex Code
13246 \begin_layout Plain Layout
13254 as \SpecialChar TeX
13255 Code to that position in the text where the column should be broken.
13256 Note that this leads in most cases to whitespace in the text.
13257 \begin_inset Newline newline
13260 Here is an example:
13263 \begin_layout Standard
13264 \begin_inset Flex Multiple Columns
13267 \begin_layout Plain Layout
13270 \begin_inset Quotes eld
13273 You're surprised to see me, sir,
13274 \begin_inset Quotes erd
13277 said he, in a strange, croaking voice.
13280 \begin_layout Plain Layout
13283 I acknowledged that I was.
13286 \begin_layout Plain Layout
13289 \begin_inset Quotes eld
13292 Well, I've a conscience, sir, and when I chanced to see you go into this
13293 house, as I came hobbling after you, I thought to myself, I'll just step
13294 in and see that kind gentleman, and tell him that if I was a bit gruff
13295 in my manner there was not any harm meant, and that I am much obliged to
13296 him for picking up my books.
13297 \begin_inset Quotes erd
13303 \begin_layout Plain Layout
13306 \begin_inset Quotes eld
13309 You make too much of a trifle,
13310 \begin_inset Quotes erd
13315 \begin_inset Quotes eld
13318 May I ask how you knew who I was?
13319 \begin_inset Quotes erd
13322 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
13326 \begin_layout Plain Layout
13338 \begin_layout Plain Layout
13341 \begin_inset Quotes eld
13344 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13345 you'll find my little bookshop at the corner of Church Street, and very
13346 happy to see you, I am sure.
13347 Maybe you collect yourself, sir.
13351 \begin_inset space ~
13365 \begin_inset space ~
13368 – a bargain, every one of them.
13369 With five volumes you could just fill that gap on that second shelf.
13370 It looks untidy, does it not, sir?
13371 \begin_inset Quotes erd
13382 \begin_layout Subsubsection
13386 \begin_layout Standard
13387 The width of the columns is automatically calculated, but you can modify
13388 the space between the columns.
13389 This is done by changing the length
13390 \begin_inset Flex Code
13393 \begin_layout Plain Layout
13402 Its predefined value is 10
13403 \begin_inset space \thinspace{}
13407 Here is an example where
13408 \begin_inset Flex Code
13411 \begin_layout Plain Layout
13420 \begin_inset space \thinspace{}
13426 \begin_layout Standard
13430 \begin_layout Plain Layout
13444 \begin_layout Standard
13445 \begin_inset Flex Multiple Columns
13448 \begin_layout Plain Layout
13451 My observations of No.
13452 \begin_inset space \space{}
13455 427 Park Lane did little to clear up the problem in which I was interested.
13456 The house was separated from the street by a low wall and railing, the
13457 whole not more than five feet high.
13458 It was perfectly easy, therefore, for anyone to get into the garden, but
13459 the window was entirely inaccessible, since there was no water pipe or
13460 anything which could help the most active man to climb it.
13461 More puzzled than ever, I retraced my steps to Kensington.
13462 I had not been in my study five minutes when the maid entered to say that
13463 a person desired to see me.
13464 To my astonishment it was none other than my strange old book collector,
13465 his sharp, wizened face peering out from a frame of white hair, and his
13466 precious volumes, a dozen of them at least, wedged under his right arm.
13474 \begin_layout Standard
13478 \begin_layout Plain Layout
13490 \begin_inset Note Note
13493 \begin_layout Plain Layout
13494 go back to the default
13502 \begin_layout Subsubsection
13506 \begin_layout Standard
13507 Between the columns a rule with a width of the length
13508 \begin_inset Flex Code
13511 \begin_layout Plain Layout
13520 If this rule width is set to 0
13521 \begin_inset space \thinspace{}
13524 pt (this is the default), the rule is suppressed.
13525 In the following example the rule is 2
13526 \begin_inset space \thinspace{}
13532 \begin_layout Standard
13536 \begin_layout Plain Layout
13542 columnseprule}{2pt}
13550 \begin_layout Standard
13551 \begin_inset Flex Multiple Columns
13554 \begin_layout Plain Layout
13557 \begin_inset Quotes eld
13560 You're surprised to see me, sir,
13561 \begin_inset Quotes erd
13564 said he, in a strange, croaking voice.
13567 \begin_layout Plain Layout
13570 I acknowledged that I was.
13573 \begin_layout Plain Layout
13576 \begin_inset Quotes eld
13579 Well, I've a conscience, sir, and when I chanced to see you go into this
13580 house, as I came hobbling after you, I thought to myself, I'll just step
13581 in and see that kind gentleman, and tell him that if I was a bit gruff
13582 in my manner there was not any harm meant, and that I am much obliged to
13583 him for picking up my books.
13584 \begin_inset Quotes erd
13590 \begin_layout Plain Layout
13593 \begin_inset Quotes eld
13596 You make too much of a trifle,
13597 \begin_inset Quotes erd
13602 \begin_inset Quotes eld
13605 May I ask how you knew who I was?
13606 \begin_inset Quotes erd
13612 \begin_layout Plain Layout
13615 \begin_inset Quotes eld
13618 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13619 you'll find my little bookshop at the corner of Church Street, and very
13620 happy to see you, I am sure.
13621 Maybe you collect yourself, sir.
13625 \begin_inset space ~
13639 \begin_inset space ~
13642 – a bargain, every one of them.
13643 With five volumes you could just fill that gap on that second shelf.
13644 It looks untidy, does it not, sir?
13645 \begin_inset Quotes erd
13656 \begin_layout Standard
13657 \begin_inset VSpace defskip
13663 \begin_layout Standard
13664 The rule can be colored by redefining the command
13665 \begin_inset Flex Code
13668 \begin_layout Plain Layout
13677 This is done by inserting the command
13680 \begin_layout LyX-Code
13685 columnseprulecolor}{
13690 \begin_layout Standard
13691 as \SpecialChar TeX
13692 Code before the multicolumn inset.
13694 \begin_inset Flex Code
13697 \begin_layout Plain Layout
13703 in this command by a color of your choice.
13704 You can use all pre- and self-defined colors.
13712 \begin_inset space ~
13717 for more information about pre- and self-defined colors.
13718 To go back to the default color insert the command
13721 \begin_layout LyX-Code
13726 columnseprulecolor}{
13731 \begin_layout Standard
13732 Here is the example with a cyan rule and 1
13733 \begin_inset space \thinspace{}
13736 cm column separation:
13739 \begin_layout Standard
13743 \begin_layout Plain Layout
13752 \begin_layout Plain Layout
13758 columnseprulecolor}{
13768 \begin_layout Standard
13769 \begin_inset Flex Multiple Columns
13772 \begin_layout Plain Layout
13775 \begin_inset Quotes eld
13778 You're surprised to see me, sir,
13779 \begin_inset Quotes erd
13782 said he, in a strange, croaking voice.
13785 \begin_layout Plain Layout
13788 I acknowledged that I was.
13791 \begin_layout Plain Layout
13794 \begin_inset Quotes eld
13797 Well, I've a conscience, sir, and when I chanced to see you go into this
13798 house, as I came hobbling after you, I thought to myself, I'll just step
13799 in and see that kind gentleman, and tell him that if I was a bit gruff
13800 in my manner there was not any harm meant, and that I am much obliged to
13801 him for picking up my books.
13802 \begin_inset Quotes erd
13808 \begin_layout Plain Layout
13811 \begin_inset Quotes eld
13814 You make too much of a trifle,
13815 \begin_inset Quotes erd
13820 \begin_inset Quotes eld
13823 May I ask how you knew who I was?
13824 \begin_inset Quotes erd
13830 \begin_layout Plain Layout
13833 \begin_inset Quotes eld
13836 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
13837 you'll find my little bookshop at the corner of Church Street, and very
13838 happy to see you, I am sure.
13839 Maybe you collect yourself, sir.
13843 \begin_inset space ~
13857 \begin_inset space ~
13860 – a bargain, every one of them.
13861 With five volumes you could just fill that gap on that second shelf.
13862 It looks untidy, does it not, sir?
13863 \begin_inset Quotes erd
13874 \begin_layout Standard
13878 \begin_layout Plain Layout
13884 columnseprule}{0pt}
13887 \begin_layout Plain Layout
13893 columnseprulecolor}{
13901 \begin_inset Note Note
13904 \begin_layout Plain Layout
13905 go back to the default
13913 \begin_layout Section
13915 \change_inserted 564990737 1671270380
13919 \begin_layout Subsection
13921 \change_inserted 564990737 1671270398
13923 \change_deleted 564990737 1671270396
13929 \begin_layout Standard
13932 as well as any other text processor uses by default rectangular paragraphs.
13933 For special cases like for example posters, invitation cards or poems you
13934 can modify the paragraph shape to one of your choice.
13935 This can be done by using the \SpecialChar LaTeX
13937 \begin_inset Flex Code
13940 \begin_layout Plain Layout
13946 which is loaded by using in the document settings the module
13948 Custom paragraph shapes
13953 \begin_layout Subsubsection
13957 \begin_layout Standard
13962 provides the following shapes:
13965 \begin_layout Standard
13966 \begin_inset Tabular
13967 <lyxtabular version="3" rows="13" columns="3">
13968 <features booktabs="true" islongtable="true" longtabularalignment="center">
13969 <column alignment="left" valignment="middle" width="16col%">
13970 <column alignment="left" valignment="middle" width="40col%">
13971 <column alignment="left" valignment="middle" width="35col%">
13972 <row endhead="true">
13973 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
13976 \begin_layout Plain Layout
13985 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
13988 \begin_layout Plain Layout
13997 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
14000 \begin_layout Plain Layout
14010 <row interlinespace="default">
14011 <cell alignment="left" valignment="top" usebox="none">
14014 \begin_layout Plain Layout
14022 <cell alignment="left" valignment="top" usebox="none">
14025 \begin_layout Plain Layout
14028 Circle with circular hole (in the size of a CD/DVD)
14033 <cell alignment="left" valignment="top" usebox="none">
14036 \begin_layout Plain Layout
14039 Cannot be scaled, take care there is not too much text
14045 <row interlinespace="default">
14046 <cell alignment="left" valignment="top" usebox="none">
14049 \begin_layout Plain Layout
14057 <cell alignment="left" valignment="top" usebox="none">
14060 \begin_layout Plain Layout
14068 <cell alignment="left" valignment="top" usebox="none">
14071 \begin_layout Plain Layout
14074 Fragile, calculation might fail
14080 <row interlinespace="default">
14081 <cell alignment="left" valignment="top" usebox="none">
14084 \begin_layout Plain Layout
14092 <cell alignment="left" valignment="top" usebox="none">
14095 \begin_layout Plain Layout
14098 Rhomboid (symbolizing a
14099 \begin_inset Quotes eld
14103 \begin_inset Quotes erd
14111 <cell alignment="left" valignment="top" usebox="none">
14114 \begin_layout Plain Layout
14123 <row interlinespace="default">
14124 <cell alignment="left" valignment="top" usebox="none">
14127 \begin_layout Plain Layout
14135 <cell alignment="left" valignment="top" usebox="none">
14138 \begin_layout Plain Layout
14146 <cell alignment="left" valignment="top" usebox="none">
14149 \begin_layout Plain Layout
14158 <row interlinespace="default">
14159 <cell alignment="left" valignment="top" usebox="none">
14162 \begin_layout Plain Layout
14170 <cell alignment="left" valignment="top" usebox="none">
14173 \begin_layout Plain Layout
14181 <cell alignment="left" valignment="top" usebox="none">
14184 \begin_layout Plain Layout
14193 <row interlinespace="default">
14194 <cell alignment="left" valignment="top" usebox="none">
14197 \begin_layout Plain Layout
14205 <cell alignment="left" valignment="top" usebox="none">
14208 \begin_layout Plain Layout
14211 Nut for bolt (hexagon with circular hole)
14216 <cell alignment="left" valignment="top" usebox="none">
14219 \begin_layout Plain Layout
14228 <row interlinespace="default">
14229 <cell alignment="left" valignment="top" usebox="none">
14232 \begin_layout Plain Layout
14240 <cell alignment="left" valignment="top" usebox="none">
14243 \begin_layout Plain Layout
14251 <cell alignment="left" valignment="top" usebox="none">
14254 \begin_layout Plain Layout
14263 <row interlinespace="default">
14264 <cell alignment="left" valignment="top" usebox="none">
14267 \begin_layout Plain Layout
14275 <cell alignment="left" valignment="top" usebox="none">
14278 \begin_layout Plain Layout
14286 <cell alignment="left" valignment="top" usebox="none">
14289 \begin_layout Plain Layout
14298 <row interlinespace="default">
14299 <cell alignment="left" valignment="top" usebox="none">
14302 \begin_layout Plain Layout
14310 <cell alignment="left" valignment="top" usebox="none">
14313 \begin_layout Plain Layout
14321 <cell alignment="left" valignment="top" usebox="none">
14324 \begin_layout Plain Layout
14333 <row interlinespace="default">
14334 <cell alignment="left" valignment="top" usebox="none">
14337 \begin_layout Plain Layout
14345 <cell alignment="left" valignment="top" usebox="none">
14348 \begin_layout Plain Layout
14351 Normal/reversed rain drop
14356 <cell alignment="left" valignment="top" usebox="none">
14359 \begin_layout Plain Layout
14362 Fragile, calculation might fail
14368 <row interlinespace="default">
14369 <cell alignment="left" valignment="top" usebox="none">
14372 \begin_layout Plain Layout
14381 <cell alignment="left" valignment="top" usebox="none">
14384 \begin_layout Plain Layout
14387 The \SpecialChar TeX
14393 <cell alignment="left" valignment="top" usebox="none">
14396 \begin_layout Plain Layout
14405 <row interlinespace="default">
14406 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
14409 \begin_layout Plain Layout
14413 \begin_inset Newline newline
14421 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
14424 \begin_layout Plain Layout
14427 Triangles in different orientations
14432 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
14435 \begin_layout Plain Layout
14451 \begin_layout Standard
14452 To use a shape for your paragraph, simply select it in \SpecialChar LyX
14454 for environments in the toolbar.
14457 \begin_layout Standard
14458 \begin_inset Newpage newpage
14464 \begin_layout Standard
14465 Here is an example paragraph in the shape of a nut:
14468 \begin_layout Standard
14469 \begin_inset VSpace bigskip
14478 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14479 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14481 At vero eos et accusam et justo duo dolores et ea rebum.
14482 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14484 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14485 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14489 \begin_layout Standard
14490 \begin_inset VSpace bigskip
14496 \begin_layout Standard
14497 \begin_inset Note Greyedout
14500 \begin_layout Plain Layout
14509 paragraphs cannot run over a page break.
14517 \begin_layout Standard
14518 \begin_inset VSpace bigskip
14524 \begin_layout Standard
14526 \begin_inset Flex Code
14529 \begin_layout Plain Layout
14535 takes care that the shape will always be preserved, no matter how much
14536 text is in the paragraph.
14537 Therefore the paragraph size changes with the amount of contained text.
14538 This can lead to paragraph sizes exceeding the page margins.
14539 To demonstrate the size scaling, here is the same example paragraph but
14540 with twice as much text:
14543 \begin_layout Standard
14544 \begin_inset Newpage newpage
14553 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14554 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14556 At vero eos et accusam et justo duo dolores et ea rebum.
14557 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14559 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14560 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14562 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14563 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14565 At vero eos et accusam et justo duo dolores et ea rebum.
14566 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14568 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14569 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14573 \begin_layout Standard
14574 \begin_inset VSpace bigskip
14580 \begin_layout Standard
14581 An exception is the shape
14586 It cannot be scaled because it must fit the size of a CD/DVD.
14587 Therefore the amount of text that fits into the shape is limited.
14588 \begin_inset Newline newline
14599 shape are fragile, meaning that the calculation of their size can fail,
14600 depending on the amount of text.
14601 You will then get the \SpecialChar LaTeX
14603 \begin_inset Quotes eld
14606 Arithmetic overflow
14607 \begin_inset Quotes erd
14611 In this case one can try to remove or add some text; if nothing works one
14612 has to use another shape.
14615 \begin_layout Standard
14616 \begin_inset VSpace bigskip
14622 \begin_layout Standard
14623 For shapes with tips you will maybe see that \SpecialChar LaTeX
14624 's hyphenation routine fails
14625 for text in the tips.
14626 Therefore it is often necessary to add hyphenation points
14631 arg "specialchar-insert hyphenation"
14636 ) to the corresponding text parts.
14639 \begin_layout Standard
14640 \begin_inset VSpace bigskip
14646 \begin_layout Standard
14647 Shapepar paragraphs are either always centered or placed on the page so
14648 that their left border touches the left page margin.
14649 You can therefore not use the paragraph dialog to align such paragraphs.
14650 A solution is to put the paragraph into a minipage or parbox and align
14652 The problem is hereby to find the right width for the box.
14653 Because if it is too wide and you center the box, the paragraph is not
14654 centered too because it sticks at the left side of the box.
14655 So you might have to play a bit with the width until it fits.
14656 Here are two heart-shaped paragraphs, the first one is not aligned, the
14657 second one is right-aligned:
14660 \begin_layout Standard
14661 \begin_inset Newpage newpage
14667 \begin_layout Heart
14671 Lo\SpecialChar softhyphen
14672 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14673 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14675 At vero eos et accusam et justo duo dolores et ea rebum.
14676 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14680 \begin_layout Standard
14681 \begin_inset VSpace bigskip
14687 \begin_layout Standard
14690 \begin_inset Box Frameless
14700 height_special "totalheight"
14705 backgroundcolor "none"
14708 \begin_layout Heart
14712 Lo\SpecialChar softhyphen
14713 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14714 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14716 At vero eos et accusam et justo duo dolores et ea rebum.
14717 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14726 \begin_layout Subsubsection
14730 \begin_layout Standard
14731 You can define any shape you want.
14732 Doing this manually is a lot of work because every coordinate must be specified.
14733 But there is a way to let the computer calculate the coordinates:
14736 \begin_layout Enumerate
14737 Install the program
14738 \begin_inset CommandInset href
14741 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
14749 \begin_layout Enumerate
14756 TeX/LaTeX\SpecialChar menuseparator
14757 Settings\SpecialChar menuseparator
14760 and select the font size you are using in your document.
14761 For example this document uses the size 12
14762 \begin_inset space \thinspace{}
14768 \begin_layout Enumerate
14772 \begin_layout Enumerate
14775 TeX/LaTeX\SpecialChar menuseparator
14778 to export the shape to coordinates.
14779 In the appearing dialog use either the outline of your shape for the coordinate
14780 s or the path itself.
14784 \begin_layout Plain Layout
14785 For more information see
14786 \begin_inset CommandInset href
14788 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
14801 \begin_layout Standard
14802 The coordinates are written into a \SpecialChar TeX
14804 To use it for your \SpecialChar LyX
14808 \begin_layout Enumerate
14809 Place the cursor before the first character of your paragraph (or into a
14813 \begin_layout Enumerate
14814 Open in \SpecialChar LyX
14817 Insert\SpecialChar menuseparator
14818 File\SpecialChar menuseparator
14820 \begin_inset space ~
14825 , select the file and use
14834 \begin_layout Standard
14835 \begin_inset VSpace defskip
14841 \begin_layout Standard
14842 \begin_inset Note Greyedout
14845 \begin_layout Plain Layout
14850 : The changed shape only applies to the current paragraph; everything is
14851 reset to normal for the next paragraph.
14852 Therefore the shape definition file must be input into every paragraph
14853 with the desired shape.
14861 \begin_layout Standard
14862 \begin_inset VSpace bigskip
14868 \begin_layout Standard
14869 Here is an example:
14872 \begin_layout Standard
14873 \begin_inset VSpace bigskip
14879 \begin_layout Standard
14880 \begin_inset CommandInset include
14882 filename "SpecialParagraphShape.tex"
14889 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14890 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14892 At vero eos et accusam et justo duo dolores et ea rebum.
14893 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
14895 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
14896 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
14900 \begin_layout Standard
14901 \begin_inset VSpace bigskip
14907 \begin_layout Standard
14912 to draw complexer shapes in
14916 you can draw the shape in a program of your choice and import the resulting
14922 Then you only need to draw a line or spline along the outline of the image.
14925 \begin_layout Standard
14926 \begin_inset VSpace bigskip
14932 \begin_layout Standard
14935 Custom paragraph shapes
14937 also provides the two commands
14945 which can be used to define custom shapes coordinate by coordinate.
14949 \begin_layout Plain Layout
14950 These commands are internally used for all shapes described here.
14955 For information how these styles are used and about further customization
14956 possibilities, have a look at the
14957 \begin_inset CommandInset href
14959 name "documentation"
14960 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
14966 \begin_inset Flex Code
14969 \begin_layout Plain Layout
14978 \begin_layout Chapter
14980 \change_deleted 564990737 1671304317
14984 \change_inserted 564990737 1671304322
14986 \change_deleted 564990737 1671304331
14987 ies with Bib\SpecialChar TeX
14993 \begin_layout Standard
14994 The most basic information about how to use Bib\SpecialChar TeX
14999 with \SpecialChar LyX
15000 is contained in the section
15002 Bibliography databases
15009 The following subsections explain special bibliography features supported
15010 by \SpecialChar LyX
15014 \begin_layout Section
15015 Alternative Citation Styles
15018 \begin_layout Standard
15019 Standard Bib\SpecialChar TeX
15021 \begin_inset space \thinspace{}
15025 \begin_inset space \space{}
15029 \begin_inset Quotes eld
15033 \begin_inset Quotes erd
15036 ) to refer to a cited work.
15037 However, in many scientific disciplines, other citation styles are in use.
15038 The most common one is the author-year style (e.
15039 \begin_inset space \thinspace{}
15043 \begin_inset space \space{}
15047 \begin_inset Quotes eld
15051 \begin_inset Quotes erd
15056 supports three packages that provide this style,
15057 \begin_inset Flex Code
15060 \begin_layout Plain Layout
15067 \begin_inset Flex Code
15070 \begin_layout Plain Layout
15077 \begin_inset Flex Code
15080 \begin_layout Plain Layout
15087 Each of these packages has their pros and cons, which cannot be listed
15089 If you only want to have simple author-year (or author-numerical) style,
15090 or if you want to use one of the countless style files for
15091 \begin_inset Flex Code
15094 \begin_layout Plain Layout
15100 , then the established
15101 \begin_inset Flex Code
15104 \begin_layout Plain Layout
15110 package is probably your choice.
15111 If you look for specific citation styles common in law studies, you might
15113 \begin_inset Flex Code
15116 \begin_layout Plain Layout
15123 If you want to have full control over the formatting or look for advanced
15124 features such as ibidem, footnote citations, full title citations, advanced
15125 date formats (such as 400 BC) or full localization to other languages than
15126 English, you should definitely consider
15127 \begin_inset Flex Code
15130 \begin_layout Plain Layout
15136 , which exceeds all other packages in terms of features, but is also quite
15137 heavy and more resource-hungry.
15140 \begin_layout Standard
15141 The handling of these packages in \SpecialChar LyX
15142 is basically the same.
15144 \begin_inset Flex Noun
15147 \begin_layout Plain Layout
15148 Document\SpecialChar menuseparator
15155 \begin_inset Flex Noun
15158 \begin_layout Plain Layout
15165 \begin_inset Flex Noun
15168 \begin_layout Plain Layout
15175 \begin_inset Flex Noun
15178 \begin_layout Plain Layout
15185 \begin_inset Flex Noun
15188 \begin_layout Plain Layout
15195 \begin_inset Flex Noun
15198 \begin_layout Plain Layout
15199 Biblatex (Natbib mode)
15205 \begin_inset Flex Noun
15208 \begin_layout Plain Layout
15215 \begin_inset Flex Noun
15218 \begin_layout Plain Layout
15225 \begin_inset space ~
15228 6.5.3 in the User's Guide for more information on these choices).
15229 With all these packages, you will get some extra features in the citation
15230 dialog and you can select the style of the reference (
15231 \begin_inset Quotes eld
15235 \begin_inset Quotes erd
15239 \begin_inset Quotes eld
15243 \begin_inset Quotes erd
15247 \begin_inset Quotes eld
15251 \begin_inset Quotes erd
15255 \begin_inset Quotes eld
15259 \begin_inset Quotes erd
15263 Note that either package needs specifically designed style files.
15264 They all ship their own, but there are lots of additional style files,
15265 and there is even an interactive style file builder
15269 \begin_layout Plain Layout
15271 \begin_inset Flex URL
15274 \begin_layout Plain Layout
15276 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
15287 \begin_inset Flex Code
15290 \begin_layout Plain Layout
15299 \begin_layout Section
15300 Subdivided Bibliographies
15303 \begin_layout Standard
15304 Sometimes you might need to divide your bibliography into several sections.
15305 If you are for instance a historian, the possibility to separate sources
15306 and scientific works is most likely a
15307 \begin_inset Quotes eld
15311 \begin_inset Quotes erd
15315 Unfortunately, Bib\SpecialChar TeX
15316 itself does not allow you to do this.
15317 But with the help of some \SpecialChar LaTeX
15318 packages, Bib\SpecialChar TeX
15319 can be extended to fit your needs.
15322 \begin_layout Standard
15324 provides native support for one of these packages,
15332 \begin_layout Plain Layout
15334 \begin_inset Flex URL
15337 \begin_layout Plain Layout
15339 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
15349 The advantage of this package (compared to other packages such as
15353 ) is that you don't need to define new citation commands.
15354 Instead, you need to prepare different bibliographic databases which include
15355 the entries for the different sections of the bibliography.
15356 For example: If you want to divide your bibliography into the sections
15358 \begin_inset Quotes eld
15362 \begin_inset Quotes erd
15366 \begin_inset Quotes eld
15370 \begin_inset Quotes erd
15373 , you first need to create two bibliographic databases, e.
15374 \begin_inset space \thinspace{}
15378 \begin_inset space \space{}
15382 \begin_inset Flex Code
15385 \begin_layout Plain Layout
15392 \begin_inset Flex Code
15395 \begin_layout Plain Layout
15405 \begin_layout Standard
15407 \begin_inset Flex Noun
15410 \begin_layout Plain Layout
15411 Document\SpecialChar menuseparator
15418 \begin_inset Flex Noun
15421 \begin_layout Plain Layout
15428 \begin_inset Flex Noun
15431 \begin_layout Plain Layout
15432 Subdivided bibliography
15438 Now you can insert multiple Bib\SpecialChar TeX
15439 bibliographies, one for each section of
15441 Returning to our example: Insert the Bib\SpecialChar TeX
15443 \begin_inset Flex Code
15446 \begin_layout Plain Layout
15452 and a second one for the database
15453 \begin_inset Flex Code
15456 \begin_layout Plain Layout
15463 You are free to use the same or different styles for each section.
15464 Additionally, you can choose if the bibliography section should contain
15466 \begin_inset Quotes eld
15469 all cited references
15470 \begin_inset Quotes erd
15473 of the specified database(s) (which is the default),
15474 \begin_inset Quotes eld
15477 all uncited references
15478 \begin_inset Quotes erd
15482 \begin_inset Quotes eld
15486 \begin_inset Quotes erd
15490 This might be useful if you would like to separate your bibliography into
15492 \begin_inset Quotes eld
15496 \begin_inset Quotes erd
15500 \begin_inset Quotes eld
15504 \begin_inset Quotes erd
15508 \begin_inset Quotes eld
15512 \begin_inset Quotes erd
15516 The titles for the sections can be added as ordinary sections or subsections.
15518 \begin_inset Flex Code
15521 \begin_layout Plain Layout
15527 removes the bibliography title, you have to manually re-add that, too (as
15528 a chapter* or section*, for instance).
15531 \begin_layout Standard
15536 , the procedure is a bit different.
15545 , the aforementioned
15546 \begin_inset Flex Noun
15549 \begin_layout Plain Layout
15550 Subdivided bibliography
15555 option is disabled if you use
15564 provides its own means to generate subdivided bibliographies.
15565 You can either add keywords to bibliography entries via the
15566 \begin_inset Flex Code
15569 \begin_layout Plain Layout
15575 entry option and then filter bibliography sections by keyword (by adding
15577 \begin_inset Flex Code
15580 \begin_layout Plain Layout
15587 \begin_inset Flex Noun
15590 \begin_layout Plain Layout
15596 field of the dialog that opens if you left-click on the
15597 \begin_inset Flex Noun
15600 \begin_layout Plain Layout
15601 Biblatex Generated Bibliography
15606 button), or you can filter by entry types (such as
15615 \begin_inset space \thinspace{}
15620 \begin_inset Flex Code
15623 \begin_layout Plain Layout
15630 \begin_inset Flex Code
15633 \begin_layout Plain Layout
15640 \begin_inset Flex Noun
15643 \begin_layout Plain Layout
15649 field, or you can create so-called
15650 \begin_inset Quotes eld
15653 Bibliography Categories
15654 \begin_inset Quotes erd
15657 to which you can assign individual entries.
15658 Please refer to the Biblatex manual, section
15660 Subdivided Bibliographies
15665 \begin_layout Section
15666 Multiple Bibliographies
15667 \begin_inset CommandInset label
15669 name "subsec:Multiple-Bibliographies"
15676 \begin_layout Standard
15677 Multiple bibliographies, e.
15678 \begin_inset space \thinspace{}
15682 \begin_inset space \space{}
15685 a bibliography for each part, chapter, section, subsection or child (sub-documen
15686 t) of the document, are also supported by \SpecialChar LyX
15688 In order to enable it, go to
15689 \begin_inset Flex Noun
15692 \begin_layout Plain Layout
15693 Document\SpecialChar menuseparator
15694 Settings\SpecialChar menuseparator
15700 and select the relevant unit (e.
15701 \begin_inset space \thinspace{}
15705 \begin_inset Quotes eld
15709 \begin_inset Quotes erd
15713 \begin_inset Flex Noun
15716 \begin_layout Plain Layout
15717 Multiple Bibliographies
15723 Then add a Bib(la)\SpecialChar TeX
15724 bibliography to each unit (e.
15725 \begin_inset space \thinspace{}
15728 g., section) of your document.
15729 In the output, a separate bibliography, containing only the references
15730 done in the current unit is generated.
15733 \begin_layout Standard
15734 If you use Bib\SpecialChar TeX
15736 \begin_inset Flex Code
15739 \begin_layout Plain Layout
15746 \begin_inset Flex Code
15749 \begin_layout Plain Layout
15755 package is used to create multiple bibliographies.
15756 The former package is used if you select
15757 \begin_inset Quotes eld
15761 \begin_inset Quotes erd
15769 \begin_inset Flex Noun
15772 \begin_layout Plain Layout
15773 Sectioned Bibliography
15779 In all other cases,
15780 \begin_inset Flex Code
15783 \begin_layout Plain Layout
15793 \begin_layout Plain Layout
15794 An alternative approach, if you are willing to use some
15795 \begin_inset Flex Noun
15798 \begin_layout Plain Layout
15806 \begin_inset space ~
15810 \begin_inset CommandInset ref
15812 reference "sec:Inserting-TeX-Code"
15817 \begin_inset Flex Code
15820 \begin_layout Plain Layout
15832 \begin_inset Flex Code
15835 \begin_layout Plain Layout
15841 is used, \SpecialChar LyX
15842 encloses the specified units in
15843 \begin_inset Flex Code
15846 \begin_layout Plain Layout
15853 \begin_inset Flex Code
15856 \begin_layout Plain Layout
15865 \begin_inset Flex Code
15868 \begin_layout Plain Layout
15876 in order to create the units.
15877 Note that this approach has some limitations.
15878 First, every citation reference has to be inside some
15879 \begin_inset Flex Code
15882 \begin_layout Plain Layout
15889 So citations outside a defined unit (e.
15890 \begin_inset space \thinspace{}
15893 g., before the first section if you use
15894 \begin_inset Quotes eld
15898 \begin_inset Quotes erd
15902 \begin_inset Quotes eld
15906 \begin_inset Quotes erd
15910 You can also create your own units by entering
15911 \begin_inset Flex Code
15914 \begin_layout Plain Layout
15923 \begin_inset Flex Code
15926 \begin_layout Plain Layout
15934 as \SpecialChar TeX
15935 code (for instance to work around the mentioned limitation).
15937 \begin_inset Flex Code
15940 \begin_layout Plain Layout
15946 s cannot be nested.
15947 A second limitation is that
15948 \begin_inset Flex Code
15951 \begin_layout Plain Layout
15957 always processes all references of a bibliography database, even if they
15959 This can result in odd labels (e.
15960 \begin_inset space \thinspace{}
15965 \begin_inset Quotes eld
15969 \begin_inset Quotes erd
15972 if two works of this author from 2014 are in the database, even if only
15976 \begin_layout Standard
15982 \begin_inset Flex Code
15985 \begin_layout Plain Layout
15991 option is used instead.
15992 If you need specific units, you can start them with the \SpecialChar TeX
15994 \begin_inset Flex Code
15997 \begin_layout Plain Layout
16006 \begin_inset Flex Code
16009 \begin_layout Plain Layout
16018 If you also want to control the end of the unit, use the environment
16019 \begin_inset Flex Code
16022 \begin_layout Plain Layout
16032 \begin_inset Flex Code
16035 \begin_layout Plain Layout
16045 \begin_inset Flex Code
16048 \begin_layout Plain Layout
16054 s cannot be nested.
16055 In addition to the individual bibliography of the current unit,
16059 also provides an easy way to output all bibliographies, subsequently, at
16061 \begin_inset space \thinspace{}
16064 g., at the end of the document).
16066 \begin_inset Quotes eld
16069 all reference units
16070 \begin_inset Quotes erd
16073 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
16075 Please refer to the
16079 manual for more information on this topic.
16082 \begin_layout Chapter
16084 \change_deleted 564990737 1671355654
16088 \change_inserted 564990737 1671355667
16090 \change_deleted 564990737 1671355661
16092 \change_inserted 564990737 1671355684
16094 \begin_inset CommandInset label
16096 name "chap:bullets"
16101 \change_deleted 564990737 1671355684
16103 \begin_inset CommandInset label
16114 \begin_layout Standard
16120 \begin_layout Section
16124 \begin_layout Standard
16126 provides 216 bullet shapes that can be accessed from a simple dialog.
16127 Using this dialog you can easily specify what bullet shape to use at each
16128 level of an itemized list.
16129 These settings are document-wide so you won't be able to specify different
16130 sets of bullets for different paragraphs.
16134 \begin_layout Plain Layout
16135 Well, actually you can but you'll have to do it by hand.
16143 \begin_layout Section
16147 \begin_layout Standard
16148 Open the dialog by selecting the
16149 \begin_inset Flex Noun
16152 \begin_layout Plain Layout
16153 Document\SpecialChar menuseparator
16159 menu item and then select the
16160 \begin_inset Flex Noun
16163 \begin_layout Plain Layout
16172 \begin_layout Standard
16173 The dialog provides you with a table of bullet shapes.
16174 A column of buttons on the left of the table provides access to the six
16175 different panels of bullet shapes.
16176 The row of buttons across the top is used to select which bullet depth
16179 \change_deleted 244031559 1603875981
16180 A text entry under the table shows the currently selected bullet shape's
16182 equivalent and this can be edited if desired.
16183 If you do modify the text you will also need to specify any needed packages
16184 in the \SpecialChar LaTeX
16190 \begin_layout Standard
16191 The six panels are divided up by the packages they require.
16192 The following table shows the mappings from button name to \SpecialChar LaTeX
16196 \begin_layout Standard
16198 \begin_inset Tabular
16199 <lyxtabular version="3" rows="7" columns="2">
16200 <features tabularvalignment="middle">
16201 <column alignment="center" valignment="top" width="0pt">
16202 <column alignment="center" valignment="top" width="0pt">
16204 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
16207 \begin_layout Plain Layout
16222 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
16225 \begin_layout Plain Layout
16242 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16245 \begin_layout Plain Layout
16260 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16263 \begin_layout Plain Layout
16272 base \SpecialChar LaTeX
16280 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16283 \begin_layout Plain Layout
16298 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16301 \begin_layout Plain Layout
16318 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16321 \begin_layout Plain Layout
16336 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16339 \begin_layout Plain Layout
16356 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16359 \begin_layout Plain Layout
16374 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16377 \begin_layout Plain Layout
16394 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
16397 \begin_layout Plain Layout
16412 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
16415 \begin_layout Plain Layout
16432 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
16435 \begin_layout Plain Layout
16450 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
16453 \begin_layout Plain Layout
16476 \begin_layout Standard
16478 doesn't stop you using bullets from packages you don't have.
16479 If you get errors from \SpecialChar LaTeX
16480 when you try to view or print the file, then it
16481 is likely you are missing a package.
16485 \begin_layout Plain Layout
16487 doesn't restrict your use since you may be editing locally and exporting
16496 \begin_layout Section
16500 \begin_layout Standard
16501 Select which bullet depth you want to change then select the bullet shape
16503 Any changes will not be visible in \SpecialChar LyX
16504 , but are visible when viewing the document.
16507 \begin_layout Standard
16508 You can reset a bullet shape to the default simply by clicking your right
16509 mouse button on the appropriate bullet depth button.
16513 \begin_layout Plain Layout
16518 want to have multiple sets of paragraphs with different sets of bullets
16519 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
16521 The bullet selection dialog can help though because it provides you with
16522 the \SpecialChar LaTeX
16523 code for a wide range of bullet shapes.
16524 To make your own custom paragraphs you have the following options:
16527 \begin_layout Plain Layout
16531 \begin_layout Plain Layout
16547 \begin_layout Plain Layout
16551 \begin_layout Plain Layout
16573 \begin_layout Itemize
16574 Use the \SpecialChar LaTeX
16576 \begin_inset Flex Code
16579 \begin_layout Plain Layout
16587 to specify a new bullet shape for a given depth.
16588 You'll also need to save the current bullet shape so you can restore it
16590 In this itemized list the following \SpecialChar LaTeX
16591 code was used to change the bullet
16592 used for the first depth.
16596 \begin_layout LyX-Code
16606 \begin_layout LyX-Code
16623 \begin_layout Itemize
16624 Note that the itemize depth is specified in Roman numerals as part of the
16634 \begin_layout Itemize
16635 \begin_inset Argument item:1
16638 \begin_layout Plain Layout
16642 \begin_layout Plain Layout
16660 Specify each individual entry by starting each item with the bullet shape
16662 \begin_inset Quotes eld
16666 \begin_inset Quotes erd
16669 inset (available at
16671 Insert\SpecialChar menuseparator
16675 \begin_inset Flex Noun
16678 \begin_layout Plain Layout
16686 For example, this item was started with
16687 \begin_inset Flex Code
16690 \begin_layout Plain Layout
16705 \begin_layout Plain Layout
16709 \begin_layout Plain Layout
16725 \begin_layout Plain Layout
16726 You'll also need to revert the labelitem back to its previous setting for
16727 the global bullet shape settings to remain in effect.
16728 The way used here was:
16731 \begin_layout LyX-Code
16746 \begin_layout Chapter
16750 \begin_layout Section
16751 Multipart Documents
16754 \begin_layout Subsection
16758 \begin_layout Standard
16759 When you are working on a large file with many sections, it is often convenient
16760 to break up the document into several files, or perhaps you have something
16761 where a table may change from time to time, but the preceding text does
16763 In these cases, you should seriously consider using multipart documents.
16764 For example, scientific papers often have five major sections: the introduction
16765 , observations, results, discussion, and conclusion.
16766 Each of these could be its own separate \SpecialChar LyX
16768 \begin_inset Quotes eld
16772 \begin_inset Quotes erd
16775 file which contains the title, authors, abstract, references, etc., plus
16776 the five included files.
16777 It is important to note that each of these files is a full \SpecialChar LyX
16779 can be formatted and printed on its own, as well as included in a master
16781 Each of these files must have the same document class, however—don't attempt
16782 to mix book classes with article classes.
16783 You may also include \SpecialChar LaTeX
16784 files; however, these files must not have their own
16786 \begin_inset space \thinspace{}
16790 \begin_inset space \space{}
16793 everything up to and including the
16794 \begin_inset Flex Code
16797 \begin_layout Plain Layout
16805 line as well as the
16806 \begin_inset Flex Code
16809 \begin_layout Plain Layout
16817 line must be deleted) or else errors will be generated when you try to
16821 \begin_layout Standard
16823 allows you to include files quite easily with
16824 \begin_inset Flex Noun
16827 \begin_layout Plain Layout
16828 Insert\SpecialChar menuseparator
16830 \begin_inset space ~
16839 When you click on this selection a small box is inserted into the file
16840 at the current cursor location.
16841 Clicking on the box raises a dialog which allows you to select the file
16842 to be included, and the method of its inclusion.
16846 \begin_layout Standard
16847 The file selection box should by now be obvious.
16848 The three inclusion methods are
16849 \begin_inset Quotes eld
16853 \begin_inset Quotes erd
16857 \begin_inset Quotes eld
16861 \begin_inset Quotes erd
16865 \begin_inset Quotes eld
16869 \begin_inset Quotes erd
16874 \begin_inset Quotes eld
16878 \begin_inset Quotes erd
16882 \begin_inset Quotes eld
16886 \begin_inset Quotes erd
16889 are similar in many ways, but there are also some notable differences:
16892 \begin_layout Enumerate
16894 \begin_inset Quotes eld
16898 \begin_inset Quotes erd
16901 are typeset beginning on a new page, while files that are
16902 \begin_inset Quotes eld
16906 \begin_inset Quotes erd
16909 are typeset starting on the current page.
16912 \begin_layout Enumerate
16913 \begin_inset Quotes eld
16917 \begin_inset Quotes erd
16920 files cannot themselves
16921 \begin_inset Quotes eld
16925 \begin_inset Quotes erd
16929 \begin_inset Quotes eld
16933 \begin_inset Quotes erd
16938 \begin_inset Quotes eld
16942 \begin_inset Quotes erd
16945 , on the other hand, infinite sub-inputting is possible.
16948 \begin_layout Enumerate
16949 \begin_inset Quotes eld
16953 \begin_inset Quotes erd
16956 allow for the output of only selected
16957 \begin_inset Quotes eld
16961 \begin_inset Quotes erd
16964 files, while maintaining the actual counters (pagination etc.) and references
16965 (please refer to the section
16968 \begin_inset space ~
16976 \begin_inset space ~
16981 manual for details).
16984 \begin_layout Standard
16986 \begin_inset Quotes eld
16990 \begin_inset Quotes erd
16993 is the preferred method for chapters that are outsourced to child documents,
16995 \begin_inset Quotes eld
16999 \begin_inset Quotes erd
17002 is more suitable for arbitrary file inheritance.
17005 \begin_layout Standard
17007 \begin_inset Quotes eld
17011 \begin_inset Quotes erd
17014 included file allows you to include a file typeset exactly as it appears
17016 \begin_inset space \thinspace{}
17020 \begin_inset space \space{}
17024 \begin_inset Flex Code
17027 \begin_layout Plain Layout
17033 mode, with the characters set in a fixed-width typewriter font.
17034 Normally, spaces in this file are invisible, though two consecutive spaces
17035 are conserved, unlike \SpecialChar LyX
17036 's normal treatment of spaces.
17037 However, setting the
17038 \begin_inset Flex Noun
17041 \begin_layout Plain Layout
17043 \begin_inset space ~
17047 \begin_inset space ~
17051 \begin_inset space ~
17059 checkbox typesets a mark to unambiguously define the presence of a space.
17063 \begin_layout Standard
17064 Generally, the master file is converted into a full \SpecialChar LaTeX
17065 file before typesetting,
17066 while the included files are converted to \SpecialChar LaTeX
17067 files that do not have all the
17068 preamble information.
17071 \begin_layout Subsection
17072 Cross-References Between Files
17075 \begin_layout Standard
17076 \begin_inset Box Shadowbox
17086 height_special "totalheight"
17091 backgroundcolor "none"
17094 \begin_layout Plain Layout
17095 This section is somewhat out of date.
17096 Need to describe default master documents and how children are opened when
17106 \begin_layout Standard
17107 It is possible to set up cross-references between the different files.
17108 First, open all the files in question: let's call them A and B in a two
17109 file example, where B is included in A.
17110 Let's say you insert a label in A, then want to reference it in B.
17111 Open the cross-reference dialog whilst in document B, and you can select
17113 \begin_inset Quotes eld
17117 \begin_inset Quotes erd
17123 \begin_layout Subsection
17124 Bibliography Lists in all Subdocuments
17127 \begin_layout Standard
17128 If you work with child documents, you might want to have only one main bibliogra
17129 phy at the end, but still be able to have a selected bibliography for the
17130 child if you output it on its own.
17131 Here is how to achieve this.
17134 \begin_layout Standard
17135 For the main document, you just insert a bibliography inset at the place
17136 where the main bibliography has to appear (within the master file or within
17138 If the bibliography inset is in the master file, the references will be
17139 inherited by all children, so they are available in the citation dialog
17143 \begin_layout Standard
17144 For child-specific bibliographies, insert bibliography insets within the
17145 child documents, at the place where the bibliography should appear when
17146 the child is compiled separately.
17147 However, the trick is to insert them into a branch (
17149 Insert\SpecialChar menuseparator
17150 Branch\SpecialChar menuseparator
17151 Insert New Branch...
17154 \begin_inset space \thinspace{}
17159 \begin_inset Quotes eld
17163 \begin_inset Quotes erd
17167 Within the children, activate the branch (
17169 Document\SpecialChar menuseparator
17170 Settings...\SpecialChar menuseparator
17174 Within the master, deactivate the branch (
17176 Document\SpecialChar menuseparator
17177 Settings...\SpecialChar menuseparator
17181 Now the child's bibliography will be ignored by the master, but considered
17185 \begin_layout Standard
17186 If you need multiple bibliographies (e.
17187 \begin_inset space \thinspace{}
17190 g., one per child in the
17194 ), please refer to sec.
17195 \begin_inset space ~
17199 \begin_inset CommandInset ref
17201 reference "subsec:Multiple-Bibliographies"
17208 \begin_layout Section
17213 \begin_layout Standard
17214 Users sometimes need to be able to
17215 \begin_inset Quotes eld
17219 \begin_inset Quotes erd
17223 file together with all the images (and other files) on which it depends,
17224 either for sending to a publisher or for sharing with a co-author.
17226 includes a Python script (
17227 \begin_inset Flex Code
17230 \begin_layout Plain Layout
17236 ) that automates this process.
17237 To use it, you must have either the
17238 \begin_inset Flex Code
17241 \begin_layout Plain Layout
17248 \begin_inset Flex Code
17251 \begin_layout Plain Layout
17257 python modules installed on your system.
17258 By default, the script prefers the
17259 \begin_inset Flex Code
17262 \begin_layout Plain Layout
17269 \begin_inset Flex Code
17272 \begin_layout Plain Layout
17278 format on Unix-like systems and the
17279 \begin_inset Flex Code
17282 \begin_layout Plain Layout
17291 \begin_layout Standard
17293 's configuration process will set the script up to export a `\SpecialChar LyX
17295 and this format will then be available under
17296 \begin_inset Flex Code
17299 \begin_layout Plain Layout
17300 File\SpecialChar menuseparator
17309 \begin_layout Standard
17310 Independently of the platform, the generation of a particular archive format
17311 can be forced by adding either the
17312 \begin_inset Flex Code
17315 \begin_layout Plain Layout
17322 \begin_inset Flex Code
17325 \begin_layout Plain Layout
17332 \begin_inset Flex Code
17335 \begin_layout Plain Layout
17342 \begin_inset Flex Code
17345 \begin_layout Plain Layout
17351 format) switch to the
17352 \begin_inset Flex Code
17355 \begin_layout Plain Layout
17357 \SpecialChar menuseparator
17365 \begin_inset Flex Code
17368 \begin_layout Plain Layout
17369 Tools\SpecialChar menuseparator
17370 Preferences\SpecialChar menuseparator
17371 File Handling\SpecialChar menuseparator
17378 (Make sure you add the switch after the script name, not before it.)
17381 \begin_layout Section
17382 Fancy Headers and Footers
17385 \begin_layout Standard
17386 The default page layout is rather plain; for an
17387 \begin_inset Flex Code
17390 \begin_layout Plain Layout
17396 document class, all you get is a centered page number at the bottom of
17398 This document uses KOMA-script's book class, so it appears to be a bit
17400 But to really put on a show, you need to set the document page style to
17402 \begin_inset Quotes eld
17406 \begin_inset Quotes erd
17409 , as mentioned in the
17414 This section describes the \SpecialChar LaTeX
17415 code you need to insert in your \SpecialChar LaTeX
17417 order to get the desired effects.
17420 \begin_layout Standard
17421 For more information on fancy headers, see the
17422 \begin_inset Flex Code
17425 \begin_layout Plain Layout
17431 package documentation.
17433 \begin_inset Flex URL
17436 \begin_layout Plain Layout
17438 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
17446 \begin_layout Standard
17447 The page header is divided into three fields, not surprisingly labeled
17448 \begin_inset Quotes eld
17452 \begin_inset Quotes erd
17456 \begin_inset Quotes eld
17460 \begin_inset Quotes erd
17464 \begin_inset Quotes eld
17468 \begin_inset Quotes erd
17472 The footer is also divided into these three fields.
17473 The \SpecialChar LaTeX
17474 commands to set these fields in the simplest manner are
17475 \begin_inset Flex Code
17478 \begin_layout Plain Layout
17487 \begin_inset Flex Code
17490 \begin_layout Plain Layout
17499 \begin_inset Flex Code
17502 \begin_layout Plain Layout
17511 \begin_inset Flex Code
17514 \begin_layout Plain Layout
17523 Suppose you wish to put your name in the upper left hand corner of each
17525 Simply insert the following command in the preamble:
17528 \begin_layout Standard
17537 \begin_layout Standard
17538 You will now see your name in the upper left.
17539 If a field has a default entry that you would like to get rid of (often
17540 the page number appears in the central footer) simply include a command
17541 with a blank argument, e.
17542 \begin_inset space \thinspace{}
17548 \begin_layout Standard
17556 \begin_layout Standard
17557 Let's get really fancy: lets put the section number with the word
17558 \begin_inset Quotes eld
17562 \begin_inset Quotes erd
17566 \begin_inset space \thinspace{}
17570 \begin_inset space \space{}
17573 Section 3) in the upper left, the page number (e.
17574 \begin_inset space \thinspace{}
17578 \begin_inset space \space{}
17581 Page 4) in the upper right, your name in the lower left, and the date in
17583 The following commands should now appear in the preamble:
17586 \begin_layout Standard
17596 \begin_layout Standard
17604 \begin_layout Standard
17614 \begin_layout Standard
17623 \begin_layout Standard
17631 \begin_layout Standard
17641 \begin_layout Standard
17643 \begin_inset Flex Code
17646 \begin_layout Plain Layout
17655 \begin_inset Flex Code
17658 \begin_layout Plain Layout
17666 access \SpecialChar LaTeX
17667 's section and page counters, and so print out the current section
17670 \begin_inset Flex Code
17673 \begin_layout Plain Layout
17681 simply prints out today's date.
17684 \begin_layout Standard
17685 The thicknesses of the horizontal rules drawn beneath the header and above
17686 the footer can also be modified.
17687 If you don't want one of the rules, set its thickness to 0.
17688 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
17694 \begin_inset Flex Code
17697 \begin_layout Plain Layout
17702 headrulewidth}{0.4pt}
17708 \begin_inset Flex Code
17711 \begin_layout Plain Layout
17716 footrulewidth}{0.4pt}
17721 to set the thicknesses.
17724 \begin_layout Standard
17725 You can switch the header/footer settings on and off for individual pages
17726 using commands like
17727 \begin_inset Flex Code
17730 \begin_layout Plain Layout
17733 thispagestyle{empty}
17739 \begin_inset Flex Code
17742 \begin_layout Plain Layout
17745 thispagestyle{plain}
17751 \begin_inset Flex Code
17754 \begin_layout Plain Layout
17757 thispagestyle{fancy}
17763 Simply insert them in the text on the page you want changed and mark them
17764 as \SpecialChar TeX
17766 In fact, title pages are marked as plain by default, while following pages
17767 are marked fancy when using the global fancy setting.
17770 \begin_layout Standard
17771 As a final example, it is possible to include an image in the header or
17773 Suppose you want to put a company logo in the upper lefthand corner.
17774 You might try something like
17777 \begin_layout Standard
17786 includegraphics{logo.eps}}}
17789 \begin_layout Standard
17791 (you may need to preface this with
17792 \begin_inset Flex Code
17795 \begin_layout Plain Layout
17798 usepackage{graphics}
17803 if you don't include graphics elsewhere in your document).
17806 \begin_layout Chapter
17808 and the World Wide Web
17811 \begin_layout Standard
17813 has long supported the export of documents to various web-friendly formats,
17815 Before version 2.0, however, HTML export was always accomplished by the
17816 use of external converters.
17820 \begin_layout Plain Layout
17821 For details on the use of external converters with \SpecialChar LyX
17826 section of the Customization manual.
17831 These fall into two large groups: there are converters that use \SpecialChar LaTeX
17833 intermediate format, such as
17834 \begin_inset Flex Code
17837 \begin_layout Plain Layout
17844 \begin_inset Flex Code
17847 \begin_layout Plain Layout
17854 \begin_inset Flex Code
17857 \begin_layout Plain Layout
17863 , relying upon \SpecialChar LyX
17864 to produce the \SpecialChar LaTeX
17865 ; and there is a converter that works directly
17866 on \SpecialChar LyX
17868 \begin_inset Flex Code
17871 \begin_layout Plain Layout
17879 All of these have different advantages and disadvantages.
17883 \begin_layout Standard
17884 The \SpecialChar LaTeX
17885 -based converters have the advantage that, in principle, they know everythin
17886 g about the exported document that \SpecialChar LaTeX
17888 Such converters do not care, for example, if a certain block of code was
17889 produced by \SpecialChar LyX
17890 or was Evil Red Text.
17891 These converters know about
17892 \begin_inset Flex Code
17895 \begin_layout Plain Layout
17901 files, counters, and references, and can often make use of the
17902 \begin_inset Flex Code
17905 \begin_layout Plain Layout
17911 files generated by Bib\SpecialChar TeX
17913 On the other hand, \SpecialChar LaTeX
17914 is a very hard language to parse—it is sometimes said
17915 that only \SpecialChar TeX
17916 itself understands \SpecialChar TeX
17917 —and \SpecialChar LaTeX
17918 -based converters will often choke on
17919 what seem to be quite simple constructs; complex ones can throw them completely
17920 , and as of this writing, for example, the
17924 manual will not export with
17925 \begin_inset Flex Code
17928 \begin_layout Plain Layout
17934 , though the others will.
17935 The other issue concerns how math is handled.
17936 These converters typically convert the formulae into little pictures that
17937 are then linked from the HTML document.
17938 Since these are actually generated by \SpecialChar LaTeX
17939 , they are accurate.
17940 But they do not scale well, and just getting them to look as if they are
17941 actually meant to be in your document—so that the font sizes seem to be
17942 roughly the same—can be a challenge.
17945 \begin_layout Standard
17947 \begin_inset Flex Code
17950 \begin_layout Plain Layout
17958 \begin_inset CommandInset href
17960 name "http://pinchito.es/elyxer/"
17961 target "http://pinchito.es/elyxer/"
17966 ) solves some of these problems.
17967 In particular, the formulae it produces scale perfectly, since it renders
17968 math using a combination of HTML and CSS rather than converting the formulae
17970 But even moderately complex formula are rendered less well than with
17971 \begin_inset Flex Code
17974 \begin_layout Plain Layout
17980 ; this reflects the limitations of HTML.
17984 \begin_layout Plain Layout
17986 \begin_inset Flex Code
17989 \begin_layout Plain Layout
17996 can also use jsMath and MathJax for equations, but this setting is only
17997 available globally and requires one to have access to a server that runs
18003 More importantly (as of version 1.1.1, at least),
18004 \begin_inset Flex Code
18007 \begin_layout Plain Layout
18014 has limited support for math macros and no support for user-defined paragraph
18015 or character styles.
18016 These limitations make
18017 \begin_inset Flex Code
18020 \begin_layout Plain Layout
18027 unsuitable for many of the documents \SpecialChar LyX
18029 In principle, of course, these problems could be solved, but the \SpecialChar LyX
18031 have decided to follow a different path and have made \SpecialChar LyX
18033 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
18034 , DocBook, and plaintext.
18037 \begin_layout Standard
18038 As of this writing, XHTML output remains under development and should probably
18040 \begin_inset Quotes eld
18044 \begin_inset Quotes erd
18051 \begin_layout Plain Layout
18053 \begin_inset Flex Code
18056 \begin_layout Plain Layout
18057 development/HTML/HTML.notes
18062 , which can be found in the \SpecialChar LyX
18064 \begin_inset CommandInset href
18066 name "accessed online"
18067 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
18072 , usually contains up-to-date information about the state of XHTML output.
18073 See also the list of XHTML bugs on
18074 \begin_inset CommandInset href
18076 name "the bug tracker"
18077 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"
18087 Still, the developers have chosen this approach because it has several
18088 potential advantages over the other two.
18091 \begin_layout Standard
18092 These advantages are primarily due to the fact that the XHTML output routines,
18093 since they are part of \SpecialChar LyX
18094 , know everything \SpecialChar LyX
18095 knows about the document being
18100 \begin_layout Plain Layout
18101 Another advantage is that, since these routines are internal to \SpecialChar LyX
18103 immune to changes in \SpecialChar LyX
18104 's file format, or to changes in the semantics of
18110 So they know about the table of contents (as displayed in the outline),
18111 about the counters associated with different paragraph styles, and about
18112 user-defined styles.
18113 The XHTML output routines know what \SpecialChar LyX
18114 knows about internationalization,
18115 too, so they will output
18116 \begin_inset Quotes eld
18120 \begin_inset Quotes erd
18124 \begin_inset Quotes eld
18132 \begin_inset Quotes erd
18135 , depending upon the language in effect at the time.
18139 \begin_layout Standard
18140 Quite generally, the output routines know what \SpecialChar LyX
18141 knows about document layout,
18142 that is, about how the document is to be rendered on screen.
18143 We use this information when we output the document as XHTML.
18144 In particular, \SpecialChar LyX
18149 generates CSS style information corresponding to the layout information
18150 it uses to render the document on screen: if section headings are supposed
18151 to be sans-serif and bold as seen in \SpecialChar LyX
18152 , then (by default) they will be sans-seri
18153 f and bold when viewed in a web browser, too.
18154 And this is true not just for pre-defined styles, like Section, but for
18155 any style, including user-defined styles.
18156 Indeed, the XHTML output routines make no distinction between user-defined
18158 \change_deleted 244031559 1603876931
18160 \change_inserted 244031559 1603876940
18163 styles and \SpecialChar LyX
18164 's own pre-defined styles: in each case, everything \SpecialChar LyX
18166 the styles is contained in the layout files.
18167 And much the same is true as regards pre-defined textual insets, such as
18168 footnotes, and various custom insets.
18172 \begin_layout Standard
18173 The result is that XHTML output can be customized and extended in exactly
18174 the same way \SpecialChar LaTeX
18175 output can be customized and extended: through layout files
18177 See chapter five of the
18181 manual for the details.
18184 \begin_layout Standard
18185 The remainder of this chapter contains more detailed information on XHTML
18186 output, its limitations, and ways to work around those limitations.
18189 \begin_layout Section
18190 Math Output in XHTML
18193 \begin_layout Standard
18195 offers four choices for how math is rendered.
18196 These have various advantages and disadvantages:
18199 \begin_layout Itemize
18201 \begin_inset Newline newline
18204 MathML is a dialect of XML designed specifically for mathematics on the
18205 web, and it typically renders very well in browsers that support it.
18206 The disadvantage is that not all browsers support MathML, and support is
18207 not complete even in the Gecko-based browsers, such as Firefox.
18208 \begin_inset Newline newline
18211 If \SpecialChar LyX
18212 is unable to render a formula as MathML—for example, if the formula
18214 \begin_inset Flex Code
18217 \begin_layout Plain Layout
18223 package or ERT—then it will instead output the formula as an image.
18227 \begin_layout Itemize
18229 \begin_inset Newline newline
18232 As mentioned above,
18233 \begin_inset Flex Code
18236 \begin_layout Plain Layout
18242 outputs math as HTML, styled by CSS.
18246 \begin_layout Plain Layout
18248 has borrowed some of the CSS for its HTML output from
18249 \begin_inset Flex Code
18252 \begin_layout Plain Layout
18263 For simple formulae, this can work quite well, though with more complicated
18264 formulae it tends to break down.
18265 Still, this method has the advantage that it is very widely supported and
18266 so it may be appropriate for documents that contain only a little, fairly
18268 \begin_inset Newline newline
18271 If Lyx is unable to render a formula as HTML—for example, if the formula
18273 \begin_inset Flex Code
18276 \begin_layout Plain Layout
18282 package or ERT—then it will instead output the formula as an image.
18286 \begin_layout Itemize
18288 \begin_inset Newline newline
18292 \begin_inset Flex Code
18295 \begin_layout Plain Layout
18302 will output formulae as images, the very same images, in fact, that are
18303 used for instant preview.
18307 \begin_layout Plain Layout
18308 Instant preview does
18312 have to be on for images to be output, however.
18317 The advantage to this method is that the images are simply generated by
18319 , so they are very accurate.
18320 The disadvantage, as mentioned earlier, is that these are bitmapped images,
18321 so they do not scale terribly well, and one cannot copy them, etc.
18322 \begin_inset Newline newline
18325 The size of the images can be controlled by setting the
18326 \begin_inset Quotes eld
18329 Math Images Scaling
18330 \begin_inset Quotes erd
18334 \begin_inset Flex Noun
18337 \begin_layout Plain Layout
18338 Document\SpecialChar menuseparator
18339 Settings\SpecialChar menuseparator
18349 \begin_layout Plain Layout
18350 For those who want to know, this controls the resolution of the image in
18351 dots per inch and is based upon a default of 75 dpi.
18357 \begin_inset Newline newline
18360 If \SpecialChar LyX
18361 for some reason fails to create an image for a formula (e.g., if a required
18363 package is not installed), then it will fall back to outputing the raw
18368 \begin_layout Itemize
18371 \begin_inset Newline newline
18374 Finally, \SpecialChar LyX
18375 will happily output math as \SpecialChar LaTeX
18377 As well as being the output of last resort, this method can be used with
18379 \begin_inset CommandInset href
18382 target "http://www.math.union.edu/~dpvc/jsMath/"
18387 , which uses JavaScript to render \SpecialChar LaTeX
18388 embedded in HTML documents.
18390 wraps the \SpecialChar LaTeX
18392 \begin_inset Flex Code
18395 \begin_layout Plain Layout
18401 (for inline formulas) or
18402 \begin_inset Flex Code
18405 \begin_layout Plain Layout
18411 (for displayed formulas) with
18412 \begin_inset Flex Code
18415 \begin_layout Plain Layout
18421 , as is required for jsMath.
18424 \begin_layout Standard
18425 One of these output methods must be selected under
18426 \begin_inset Flex Noun
18429 \begin_layout Plain Layout
18430 Document\SpecialChar menuseparator
18431 Settings\SpecialChar menuseparator
18438 By default, \SpecialChar LyX
18440 This is a document-wide setting, therefore.
18443 \begin_layout Standard
18444 Eventually, \SpecialChar LyX
18445 will offer the user the option to select an alternate output
18446 method for a particular inset, say, one that isn't being rendered very
18451 \begin_layout Plain Layout
18452 That said, since \SpecialChar LyX
18453 falls back to images if the inset contains ERT, then one
18454 can force output as an image by putting some harmless ERT into the math,
18456 \begin_inset Formula $a=b\relax$
18467 \begin_layout Section
18468 Bibliography and Citations
18471 \begin_layout Standard
18472 XHTML output fully supports bibliographies and citations.
18476 \begin_layout Standard
18477 Citation labels are generated by the same machinery that generates \SpecialChar LyX
18479 labels, so the labels will look in the output much as they do in \SpecialChar LyX
18482 If you are using numerical citations, then \SpecialChar LyX
18483 will output numerical labels,
18484 such as [1] or [17], rather than simply showing the citation key in square
18485 brackets, as it does on-screen.
18486 If you are using author-year citations, then \SpecialChar LyX
18487 will add lowercase letters
18488 to the years, just as Bib\SpecialChar TeX
18489 does, if it finds more than one citation for
18490 a given author-year combination.
18491 The labels will be printed with the bibliography entries.
18492 Note that there is, at present, no way to customize the appearance of the
18493 labels, for example, to choose between square brackets and parentheses.
18496 \begin_layout Standard
18497 Bibliography output is handled by the same machinery that handles the presentati
18498 on of reference information in the citation dialog, so you will see in the
18499 XHTML output pretty much what you would see if you were to look at a given
18500 entry in the citation dialog.
18501 The formatting can be customized in your layout file or, preferably, in
18507 manual for the details.
18510 \begin_layout Standard
18511 The main defect at present is that cross-referenced information is printed
18512 with every entry with which it is associated.
18513 So you can see things like this:
18516 \begin_layout Quote
18518 \begin_inset Quotes eld
18521 Context and Logical Form
18522 \begin_inset Quotes erd
18527 Language in Context: Selected Essays
18529 (Oxford: Oxford University Press, 2007), pp.
18533 \begin_layout Quote
18535 \begin_inset Quotes eld
18538 Semantics in Context
18539 \begin_inset Quotes erd
18544 Language in Context: Selected Essays
18546 (Oxford: Oxford University Press, 2007), pp.
18550 \begin_layout Standard
18551 This should be fixed before long.
18554 \begin_layout Standard
18555 There is no support at present for sectioned bibliographies.
18556 If you have multiple bibliographies, then \SpecialChar LyX
18557 will print the same bibliography
18561 \begin_layout Section
18565 \begin_layout Standard
18567 will happily export indexes as XHTML, but with certain limitations at the
18571 \begin_layout Standard
18572 Index export will be most reliable when you do not attempt to use the fancy
18573 constructs that are described in the section on indexes in the
18581 \begin_layout Plain Layout
18582 The main issue here is that \SpecialChar LyX
18583 itself does not really handle these.
18584 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
18590 We'll describe how they are handled using the subsection headings from
18594 \begin_layout Itemize
18595 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
18596 makes an effort to support these,
18597 but the entries must be separated by
18598 \begin_inset Quotes eld
18602 \begin_inset Quotes erd
18605 , that is, there must be spaces around the exclamation point.
18606 This is because it is otherwise too difficult to check for escaped exclamation
18607 points, ones in math, and so forth.
18610 \begin_layout Itemize
18611 Page Ranges: There is no support at all for page ranges, since these make
18612 no sense with XHMTL.
18613 Instead, you will just get two index entries, one at either end.
18616 \begin_layout Itemize
18617 Cross-referencing: There is no support for cross-referencing.
18618 If \SpecialChar LyX
18619 finds an entry containing the
18620 \begin_inset Quotes eld
18623 |see\SpecialChar ldots
18625 \begin_inset Quotes erd
18628 construct, it is just dropped, and the rest is treated as an ordinary index
18632 \begin_layout Itemize
18633 Index Entry Order: \SpecialChar LyX
18634 does support attempts to fix the sorting order.
18635 It will take what is before the first `@' it finds and use that for sorting,
18636 taking what follows the first `@' to be the actual entry.
18637 At present, \SpecialChar LyX
18638 does not check for escaped `@', so do not try to index email
18642 \begin_layout Itemize
18643 Index Entry Layout: You can format entries by using the text style dialog,
18644 or by using any other method available within \SpecialChar LyX
18646 There is no support for constructs like:
18647 \begin_inset Quotes eld
18651 \begin_inset Quotes erd
18655 Indeed, if \SpecialChar LyX
18656 finds a pipe symbol, `|', in an entry, it will delete it and
18657 everything that follows it.
18660 \begin_layout Itemize
18661 Multiple Indexes: There is no support for multiple indexes.
18662 Rather, all index entries will be printed as one large index.
18663 To avoid our printing several versions of the index, we print only the
18664 main index, so make sure you have one.
18667 \begin_layout Section
18668 Nomenclature and Glossary
18671 \begin_layout Standard
18672 There is at present no support for glossaries.
18673 Adding it would be fairly trivial, and welcome.
18676 \begin_layout Chapter
18678 \change_inserted 1075283030 1616534180
18682 \begin_layout Standard
18684 \change_inserted 1075283030 1616534386
18685 Apart from HTML, \SpecialChar LyX
18686 can generate documents in the DocBook XML vocabulary.
18687 With versions 2.3 and before, only select templates could be used to generate
18688 DocBook documents (only version 4).
18689 Starting with \SpecialChar LyX
18690 2.4, most \SpecialChar LyX
18691 layouts can generate valid DocBook documents (only
18693 This feature is built into \SpecialChar LyX
18694 and does not require the use of external tools.
18697 \begin_layout Standard
18699 \change_inserted 1075283030 1616534437
18700 The result is that the DocBook output can be customized and extended in
18701 exactly the same way \SpecialChar LaTeX
18702 output can be customized and extended: through layout
18704 See chapter five of the
18708 manual for the details.
18711 \begin_layout Standard
18713 \change_inserted 1075283030 1616534475
18714 Most \SpecialChar LyX
18715 features are supported with DocBook, like math output.
18718 \begin_layout Itemize
18720 \change_inserted 1075283030 1616534741
18721 Math output is performed mostly in MathML (the major exception being constructio
18722 ns not supported by \SpecialChar LyX
18725 All formulae are also available in raw \SpecialChar TeX
18726 in the DocBook output for further
18730 \begin_layout Itemize
18732 \change_inserted 1075283030 1616534852
18733 Bibliographies and citations are implemented, including with an external
18735 Bibliography entries are not prerendered when the detailed information
18736 are available, but rather output with the standard DocBook constructs.
18737 The external DocBook processor is expected to handle the rendering of entries.
18740 \begin_layout Itemize
18742 \change_inserted 1075283030 1616534863
18743 Indexes are supported, including multiple indices.
18748 ), page ranges, and cross-references (
18752 ) are supported, with the exception of the same symbols escaped.
18761 ) are not supported.
18762 There is no support for escaping of index entries.
18765 \begin_layout Itemize
18767 \change_inserted 1075283030 1616534884
18768 Glossaries are implemented.
18771 \begin_layout Standard
18773 \change_inserted 1075283030 1616534894
18774 Two major parameters can be set at the document level.
18777 \begin_layout Itemize
18779 \change_inserted 1075283030 1616534948
18780 Format for tables: \SpecialChar LyX
18781 can generate tables either as HTML (default value) or
18782 CALS, depending on the user's requirements.
18783 Most DocBook processors accept both formats.
18786 \begin_layout Itemize
18788 \change_inserted 1075283030 1616535006
18789 MathML prefix: in DocBook, MathML is included within its own name space,
18791 The implication is that there must be an indication of the tags belonging
18792 to the MathML standard.
18793 Three choices are offered:
18797 \begin_layout Itemize
18799 \change_inserted 1075283030 1616535044
18800 Inline: the MathML name space is defined for each formula (using the
18804 attribute on each formula)
18807 \begin_layout Itemize
18809 \change_inserted 1075283030 1616535090
18814 prefix (default): the MathML name space is defined at the document level
18819 attribute on the root element).
18820 Each MathML is prefixed with
18829 \begin_layout Itemize
18831 \change_inserted 1075283030 1616620405
18836 prefix: similar to the
18845 \begin_layout Standard
18847 \change_inserted 1075283030 1616620470
18848 This option is especially useful if you want \SpecialChar LyX
18849 to match your personal style
18850 or to work with buggy software that only accepts one prefix for MathML.
18856 \begin_layout Chapter
18857 The \SpecialChar LyX
18861 \begin_layout Section
18865 \begin_layout Standard
18866 The `\SpecialChar LyX
18867 server' allows other programs to talk to \SpecialChar LyX
18868 , invoke \SpecialChar LyX
18869 commands, and retrieve
18870 information about the \SpecialChar LyX
18872 This is only intended for advanced users, but they should find it useful.
18873 It is by writing to the \SpecialChar LyX
18874 server, for example, that bibliography managers,
18875 such as JabRef, are able to
18876 \begin_inset Quotes eld
18880 \begin_inset Quotes erd
18883 citations to \SpecialChar LyX
18887 \begin_layout Section
18888 Starting the \SpecialChar LyX
18890 \begin_inset CommandInset label
18892 name "sec:Starting-the-Server"
18899 \begin_layout Standard
18900 The \SpecialChar LyX
18901 server works through the use of a pair of named pipes.
18902 These are usually located in
18903 \begin_inset Flex Code
18906 \begin_layout Plain Layout
18912 , (except on Windows, where
18916 named pipes are special objects located in
18917 \begin_inset Flex Code
18920 \begin_layout Plain Layout
18932 ) and have the names
18933 \begin_inset Quotes eld
18937 \begin_inset Flex Code
18940 \begin_layout Plain Layout
18947 \begin_inset Quotes erd
18951 \begin_inset Quotes eld
18955 \begin_inset Flex Code
18958 \begin_layout Plain Layout
18965 \begin_inset Quotes erd
18969 External programs write into
18970 \begin_inset Flex Code
18973 \begin_layout Plain Layout
18979 and read back data from
18980 \begin_inset Flex Code
18983 \begin_layout Plain Layout
18990 The stem of the pipe names can be defined in the
18991 \begin_inset Flex Noun
18994 \begin_layout Plain Layout
18995 Tools\SpecialChar menuseparator
19001 dialog, for example
19002 \begin_inset Flex Code
19005 \begin_layout Plain Layout
19006 "/home/myhome/lyxpipe"
19012 \begin_inset Flex Code
19015 \begin_layout Plain Layout
19029 on Windows (where any working path instead of lyxpipe can be used, for
19031 \begin_inset Flex Code
19034 \begin_layout Plain Layout
19057 configure this manually in order for the server to start.
19060 \begin_layout Standard
19063 \begin_inset Flex Code
19066 \begin_layout Plain Layout
19073 \begin_inset Flex Code
19076 \begin_layout Plain Layout
19082 ' to create the pipes.
19083 If one of the pipes already exists, \SpecialChar LyX
19084 will assume that another \SpecialChar LyX
19086 is already running and will not start the server.
19087 On POSIX (Unix like) systems, if for some other reason, an unused
19088 \begin_inset Quotes eld
19092 \begin_inset Quotes erd
19095 pipe is left in existence when \SpecialChar LyX
19096 closes, then \SpecialChar LyX
19097 will try to delete it.
19098 If this fails for some reason, you will need to delete the pipes manually
19099 and then restart \SpecialChar LyX
19101 On Windows, pipes are deleted by the OS on program termination or crash,
19103 \begin_inset Quotes eld
19107 \begin_inset Quotes erd
19110 pipes should not be possible.
19113 \begin_layout Standard
19114 To have several \SpecialChar LyX
19115 processes with servers at the same time, you have to use
19116 different configurations, perhaps by using separate user directories, each
19118 \begin_inset Flex Code
19121 \begin_layout Plain Layout
19127 file, for each process.
19130 \begin_layout Standard
19131 If you are developing a client program, you might find it useful to enable
19132 debugging information from the \SpecialChar LyX
19134 Do this by starting \SpecialChar LyX
19136 \begin_inset Flex Code
19139 \begin_layout Plain Layout
19148 \begin_layout Standard
19149 You can find a complete example client written in C++ in the source distribution
19151 \begin_inset Flex Code
19154 \begin_layout Plain Layout
19155 development/lyxserver/server_monitor.cpp
19163 \begin_layout Standard
19164 Another useful tool is the command-line based client found in
19165 \begin_inset Flex Code
19168 \begin_layout Plain Layout
19169 src/client/lyxclient
19177 \begin_layout Section
19178 Normal communication
19181 \begin_layout Standard
19182 To issue a \SpecialChar LyX
19183 call, the client writes a line of ASCII text into the input
19185 This line has the following format:
19188 \begin_layout Quote
19202 \begin_layout Description
19203 clientname is a name that the client can choose arbitrarily.
19204 Its only use is that \SpecialChar LyX
19205 will echo it if it sends an answer—so a client can
19206 dispatch results from different requesters.
19209 \begin_layout Description
19210 function is the function you want \SpecialChar LyX
19212 It is the same as the commands you'd use in the minibuffer.
19215 \begin_layout Description
19216 argument is an optional argument which is meaningful only to some functions
19218 \begin_inset Quotes eld
19222 \begin_inset Quotes erd
19225 LFUN will insert the argument as text at the cursor position).
19228 \begin_layout Standard
19229 The answer from \SpecialChar LyX
19230 will arrive in the output pipe and be of the form
19233 \begin_layout Quote
19247 \begin_layout Standard
19256 are just echoed from the command request, while
19260 is more or less useful information filled according to how the command
19261 execution worked out.
19262 Some commands, such as
19263 \begin_inset Quotes eld
19267 \begin_inset Quotes erd
19270 , will return information about the internal state of \SpecialChar LyX
19272 return an empty data-response.
19273 This means that the command execution went fine.
19276 \begin_layout Standard
19277 In case of errors, the response from \SpecialChar LyX
19278 will have this form
19281 \begin_layout Quote
19295 \begin_layout Standard
19300 should contain an explanation of why the command failed.
19303 \begin_layout Standard
19307 \begin_layout LyX-Code
19308 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
19309 \begin_inset Newline newline
19312 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
19313 \begin_inset Newline newline
19316 read a <~/.lyxpipe.out
19317 \begin_inset Newline newline
19323 \begin_layout Subsection
19324 AppleScript (Mac OS X)
19327 \begin_layout Standard
19328 Since \SpecialChar LyX
19329 2.1, \SpecialChar LyX
19330 supports basic interactions with AppleScript for normal communicatio
19331 n through the command run.
19332 This command takes a direct argument (the
19336 to perform) and an optional argument.
19337 It either returns the output of the function or triggers an error with
19338 the error message and code.
19341 \begin_layout Standard
19345 \begin_layout LyX-Code
19346 tell application "\SpecialChar LyX
19350 \begin_layout LyX-Code
19354 \begin_layout LyX-Code
19355 -- Stores the current file name into f
19358 \begin_layout LyX-Code
19359 set f to (run "server-get-filename" with argument "")
19362 \begin_layout LyX-Code
19363 on error the error_message number the error_number
19366 \begin_layout LyX-Code
19367 display dialog "Error: " & the error_number & ".
19371 \begin_layout LyX-Code
19372 & the error_message buttons {"OK"} default button 1
19375 \begin_layout LyX-Code
19379 \begin_layout LyX-Code
19383 \begin_layout Section
19387 \begin_layout Standard
19389 can notify clients of events going on asynchronously.
19390 Currently it will only do this if the user binds a key sequence with the
19392 \begin_inset Quotes eld
19396 \begin_inset Quotes erd
19400 The format of the string \SpecialChar LyX
19401 sends is as follows:
19404 \begin_layout Quote
19405 \begin_inset Flex Code
19408 \begin_layout Plain Layout
19419 \begin_layout Standard
19424 is the printed representation of the key sequence that was actually typed
19428 \begin_layout Standard
19429 This mechanism can be used to extend \SpecialChar LyX
19430 's command set and implement macros.
19431 Bind some key sequence to
19432 \begin_inset Quotes eld
19436 \begin_inset Quotes erd
19440 Then start a client that listens on the output pipe, dispatches the command
19441 according to the sequence, and starts a function that may use \SpecialChar LyX
19444 requests to issue a command or a series of commands to \SpecialChar LyX
19448 \begin_layout Section
19449 The simple \SpecialChar LyX
19453 \begin_layout Standard
19455 implements a simple protocol that can be used for session management.
19456 All messages are of the form
19459 \begin_layout Quote
19469 \begin_layout Standard
19475 \begin_inset Quotes eld
19479 \begin_inset Quotes erd
19483 \begin_inset Quotes eld
19487 \begin_inset Quotes erd
19492 \begin_inset Quotes eld
19496 \begin_inset Quotes erd
19499 is received from a client, \SpecialChar LyX
19500 will report back to inform the client that
19501 it's listening to it's messages, while
19502 \begin_inset Quotes eld
19506 \begin_inset Quotes erd
19509 sent from \SpecialChar LyX
19510 will inform clients that \SpecialChar LyX
19514 \begin_layout Section
19515 Reverse DVI/PDF search
19518 \begin_layout Standard
19519 Some DVI/PDF viewers
19523 \begin_layout Plain Layout
19524 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
19525 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
19534 facility (also called
19539 This means that you can tell \SpecialChar LyX
19540 to put the cursor to a specific line in the
19541 document by clicking at the respective position in the DVI/PDF output.
19542 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
19544 This is done via the \SpecialChar LyX
19545 server either by using the named pipe (
19549 ), or the UNIX domain socket (
19553 ) that \SpecialChar LyX
19554 creates in its temporary directory (this is the way the
19555 \begin_inset Flex Code
19558 \begin_layout Plain Layout
19564 program communicates with \SpecialChar LyX
19566 In some cases, you need a helper script that mediates between the viewer
19567 and \SpecialChar LyX
19568 , in others, the viewer can communicate with \SpecialChar LyX
19570 This depends on the selected viewer and on your operating system.
19571 The same applies to the way viewers need to be configured and the way the
19572 reverse search is actually performed.
19573 In what follows, we will thus describe how to setup reverse search for
19575 Before we turn to this, though, we will explain what needs to be done generally
19576 to enable reverse search in the DVI/PDF output.
19579 \begin_layout Subsection
19581 \begin_inset CommandInset label
19583 name "subsec:rev-search"
19590 \begin_layout Standard
19591 In most cases \SpecialChar LyX
19592 will do the work for you by pressing the following button
19596 arg "buffer-toggle-output-sync"
19600 Alternatively, you can also enable the feature by checking
19602 Synchronize with Output
19605 \begin_inset Flex Noun
19608 \begin_layout Plain Layout
19609 Document\SpecialChar menuseparator
19610 Settings\SpecialChar menuseparator
19617 In such a case \SpecialChar LyX
19618 will automatically insert the necessary Sync\SpecialChar TeX
19620 PDF) or load the srcltx package (for DVI) respectively.
19621 This option can be easily reached also on
19622 \begin_inset Flex Code
19625 \begin_layout Plain Layout
19634 \begin_layout Standard
19635 If you need a different setting, you can select or input a custom macro
19636 from the drop down box just below
19637 \begin_inset Flex Noun
19640 \begin_layout Plain Layout
19641 Document\SpecialChar menuseparator
19642 Settings\SpecialChar menuseparator
19643 Output\SpecialChar menuseparator
19644 Synchronize with Output
19652 \begin_layout Standard
19653 Note that the method
19654 \begin_inset Flex Code
19657 \begin_layout Plain Layout
19665 enables gzip compression.
19666 If your viewer does not support it, you should instead use
19667 \begin_inset Flex Code
19670 \begin_layout Plain Layout
19681 \begin_layout Standard
19682 Please also note that including the
19683 \begin_inset Flex Code
19686 \begin_layout Plain Layout
19693 \begin_inset Flex Code
19696 \begin_layout Plain Layout
19702 sometimes has an undesired impact on the typesetting.
19703 Thus, you should switch output synchronization off for the final typesetting
19705 \begin_inset Flex Code
19708 \begin_layout Plain Layout
19715 \begin_inset Flex Code
19718 \begin_layout Plain Layout
19728 \begin_layout Standard
19729 In case you need some more special settings that are not covered by the
19730 automatic settings, read the next section about how to set up output synchroniz
19732 If the automatic setup suits your needs, you can readily jump to section
19733 \begin_inset space ~
19737 \begin_inset CommandInset ref
19739 reference "subsec:configuring-viewers"
19743 , where the necessary configuration steps in your viewer – needed both with
19744 the automatic and the manual setup – are described.
19747 \begin_layout Subsection
19751 \begin_layout Standard
19753 provides several different methods for reverse search.
19754 Some are built-in in the
19755 \begin_inset Flex Code
19758 \begin_layout Plain Layout
19764 program, some are provided by external packages.
19765 Your choice depends on whether your \SpecialChar LaTeX
19766 distribution already provides a given
19767 method (the built-in methods are rather new) and whether your viewer can
19769 The available methods are described in the following.
19772 \begin_layout Subsubsection*
19773 Built-in DVI-search via src-specials (DVI only)
19776 \begin_layout Standard
19777 This method provides the DVI file with the necessary information for reverse
19779 It is available in \SpecialChar LaTeX
19780 since quite some time (any somewhat recent \SpecialChar LaTeX
19782 should include it), and it works reliably.
19783 To enable it, change the
19784 \begin_inset Flex Noun
19787 \begin_layout Plain Layout
19798 \begin_inset Flex Noun
19801 \begin_layout Plain Layout
19812 \begin_inset Flex Noun
19815 \begin_layout Plain Layout
19816 Preferences\SpecialChar menuseparator
19817 File Handling\SpecialChar menuseparator
19824 \begin_inset Flex Code
19827 \begin_layout Plain Layout
19828 latex -src-specials $$i
19834 If this doesn't work, check if your \SpecialChar TeX
19835 engine needs different options (the
19836 syntax might differ in some distributions).
19839 \begin_layout Subsubsection*
19840 External Packages (PDFSync and scrltx)
19843 \begin_layout Standard
19852 provide reverse search facility for PDF output (via pdflatex) and DVI output,
19854 In order to enable it, load the packages in the \SpecialChar LyX
19858 \begin_layout Itemize
19859 \begin_inset Flex Code
19862 \begin_layout Plain Layout
19865 usepackage{pdfsync}
19870 for reverse PDF search,
19873 \begin_layout Itemize
19874 \begin_inset Flex Code
19877 \begin_layout Plain Layout
19880 usepackage[active]{srcltx}
19885 for reverse DVI search.
19888 \begin_layout Standard
19889 If you want to be able to perform both DVI and PDF reverse searches, you
19890 can also insert in the preamble the following lines
19893 \begin_layout LyX-Code
19897 \begin_inset Newline newline
19903 \begin_inset Newline newline
19908 usepackage{pdfsync}
19909 \begin_inset Newline newline
19915 \begin_inset Newline newline
19920 usepackage[active]{srcltx}
19921 \begin_inset Newline newline
19929 \begin_layout Standard
19930 This way, you can preview the file as either DVI or PDF (pdflatex) and the
19931 right package will be used.
19934 \begin_layout Standard
19935 Note that PDFSync might affect the output layout of your document.
19936 It is therefore advised to disable PDFsync for final documents.
19939 \begin_layout Subsubsection*
19940 Built-in reverse search via Sync\SpecialChar TeX
19944 \begin_layout Standard
19946 \begin_inset Flex Code
19949 \begin_layout Plain Layout
19955 have built-in support for both PDF and DVI reverse search.
19958 Sync\SpecialChar TeX
19961 facility is basically the result of the integration of the PDFSync package
19962 to the pdftex program and its merge with the
19967 You need at least \SpecialChar TeX
19968 Live 2008 or a recent Mik\SpecialChar TeX
19969 distribution in order to use
19974 \begin_layout Plain Layout
19975 For some reason, Mik\SpecialChar TeX
19976 does not understand/obey the command \SpecialChar LyX
19978 the preamble when you check the "Enable Forward/Reverse Search" button
19979 in the toolbar and does not generate the necessary info.
19982 \begin_layout Plain Layout
19983 The generation of the required info can be forced by changing the converter
19984 "\SpecialChar LaTeX
19985 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
19986 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
19987 the -synctex=1 switch).
19992 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
19993 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
19994 already provide Sync\SpecialChar TeX
19998 \begin_layout Standard
19999 To enable Sync\SpecialChar TeX
20000 for DVI output, change the
20001 \begin_inset Flex Noun
20004 \begin_layout Plain Layout
20015 \begin_inset Flex Noun
20018 \begin_layout Plain Layout
20023 (plain) -> DraftDVI
20029 \begin_inset Flex Noun
20032 \begin_layout Plain Layout
20033 Preferences\SpecialChar menuseparator
20034 File Handling\SpecialChar menuseparator
20041 \begin_inset Flex Code
20044 \begin_layout Plain Layout
20045 latex -synctex=1 $$i
20050 , and for PDF output, change the
20051 \begin_inset Flex Noun
20054 \begin_layout Plain Layout
20059 (pdflatex) -> PDF (pdflatex)
20065 \begin_inset Flex Code
20068 \begin_layout Plain Layout
20069 pdflatex -synctex=1 $$i
20075 Should your viewer not be considered in the following description, or in
20076 case of missing success, please check the documentation of your viewer
20077 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
20082 \begin_layout Plain Layout
20083 Note that the option
20084 \begin_inset Flex Code
20087 \begin_layout Plain Layout
20093 option enables gzip compression.
20094 If your viewer does not support it, you should instead use
20095 \begin_inset Flex Code
20098 \begin_layout Plain Layout
20112 \begin_layout Subsection
20113 Configuring and using specific viewers
20114 \begin_inset CommandInset label
20116 name "subsec:configuring-viewers"
20123 \begin_layout Subsubsection*
20124 Xdvi (all platforms)
20127 \begin_layout Standard
20129 \begin_inset Flex Code
20132 \begin_layout Plain Layout
20138 , you don't need to do anything else for performing a reverse DVI search,
20139 as \SpecialChar LyX
20140 already provides the necessary hooks for automatically using the
20141 \begin_inset Flex Code
20144 \begin_layout Plain Layout
20151 Just setup your document as described above (reverse search is triggered
20152 by Ctrl-click or Alt-click on Mac OSX, respectively).
20155 \begin_layout Standard
20156 However, if for whatever reason you want to use the named pipe instead of
20157 the socket for communicating with \SpecialChar LyX
20158 , simply change the DVI viewer in
20159 \begin_inset Flex Noun
20162 \begin_layout Plain Layout
20163 Preferences\SpecialChar menuseparator
20164 File Handling\SpecialChar menuseparator
20174 \begin_layout Plain Layout
20175 On Mac OSX you have to use
20176 \begin_inset Flex Code
20179 \begin_layout Plain Layout
20180 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
20191 \begin_inset Flex Code
20194 \begin_layout Plain Layout
20195 xdvi -editor "lyxeditor.sh %f %l"
20201 \begin_inset Flex Code
20204 \begin_layout Plain Layout
20210 is a suitable script.
20211 For example, a minimal shell script is the following one:
20214 \begin_layout LyX-Code
20216 \begin_inset Newline newline
20219 LYXPIPE="/path/to/lyxpipe"
20220 \begin_inset Newline newline
20223 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
20224 \begin_inset Newline newline
20227 echo "$COMMAND" > "${LYXPIPE}".in || exit
20228 \begin_inset Newline newline
20231 read TMP < "${LYXPIPE}".out || exit
20234 \begin_layout Standard
20236 \begin_inset Flex Code
20239 \begin_layout Plain Layout
20245 is the LyXServer pipe path specified in
20246 \begin_inset Flex Noun
20249 \begin_layout Plain Layout
20250 Preferences\SpecialChar menuseparator
20260 \begin_layout Plain Layout
20262 \begin_inset Flex Code
20265 \begin_layout Plain Layout
20271 folder of a source distribution you can find a
20272 \begin_inset Flex Code
20275 \begin_layout Plain Layout
20281 script which is able to locate the
20285 based on your preferences.
20293 \begin_layout Subsubsection*
20297 \begin_layout Standard
20299 \begin_inset Flex Code
20302 \begin_layout Plain Layout
20303 /Applications/MacDviX_Folder/calleditor.script
20308 , add the following lines:
20311 \begin_layout LyX-Code
20312 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
20313 \begin_inset Newline newline
20319 \begin_layout Standard
20320 Modify the lines accordingly if you install \SpecialChar LyX
20321 somewhere else than in the
20322 Applications folder.
20325 \begin_layout Standard
20326 Reverse search is triggered by Alt-click (OPTION-click).
20329 \begin_layout Subsubsection*
20333 \begin_layout Standard
20335 \begin_inset Flex Code
20338 \begin_layout Plain Layout
20339 open -a Skim.app $$i
20344 to the viewer setting in
20345 \begin_inset Flex Noun
20348 \begin_layout Plain Layout
20349 Preferences\SpecialChar menuseparator
20350 File Handling\SpecialChar menuseparator
20351 File formats\SpecialChar menuseparator
20358 \begin_inset Flex Noun
20361 \begin_layout Plain Layout
20362 Skim\SpecialChar menuseparator
20363 Preferences\SpecialChar menuseparator
20370 \begin_inset Flex Noun
20373 \begin_layout Plain Layout
20379 preset and enter command
20380 \begin_inset Flex Noun
20383 \begin_layout Plain Layout
20384 /Applications/\SpecialChar LyX
20385 .app/Contents/MacOS/lyxeditor
20393 \begin_layout Standard
20394 Reverse search is triggered by COMMAND-SHIFT-click
20397 \begin_layout Subsubsection*
20401 \begin_layout Standard
20402 Reverse search with evince does not work out of the box, but it can be achieved
20403 by means of some third party helper scripts.
20405 \begin_inset CommandInset href
20407 target "https://wiki.lyx.org/LyX/SyncTeX"
20415 \begin_layout Subsubsection*
20419 \begin_layout Standard
20421 \begin_inset Flex Noun
20424 \begin_layout Plain Layout
20425 Settings\SpecialChar menuseparator
20426 Configure Okular\SpecialChar menuseparator
20433 \begin_inset Quotes erd
20437 This inserts the appropriate command (
20438 \begin_inset Flex Code
20441 \begin_layout Plain Layout
20450 \begin_layout Standard
20451 Reverse search is triggered by SHIFT-click.
20453 \change_inserted -712698321 1578211026
20454 Note that this only works if Okular is in
20455 \begin_inset Quotes eld
20459 \begin_inset Quotes erd
20463 \begin_inset space \thinspace{}
20466 e., the hand symbol is clicked).
20471 \begin_layout Subsubsection*
20475 \begin_layout Standard
20476 Qpdfview supports Sync\SpecialChar TeX
20477 since version 0.3.5.
20479 \begin_inset Flex Noun
20482 \begin_layout Plain Layout
20483 Edit\SpecialChar menuseparator
20484 Settings\SpecialChar menuseparator
20490 , click on the input field of the
20491 \begin_inset Quotes eld
20495 \begin_inset Quotes erd
20498 item and add the command
20499 \begin_inset Flex Code
20502 \begin_layout Plain Layout
20511 \begin_layout Standard
20512 Reverse search is triggered by double-click or, in more recent versions,
20516 \begin_layout Subsubsection*
20520 \begin_layout Standard
20521 Launch yap, choose its
20522 \begin_inset Flex Noun
20525 \begin_layout Plain Layout
20526 View\SpecialChar menuseparator
20532 menu and select the
20533 \begin_inset Quotes eld
20537 \begin_inset Quotes erd
20542 \begin_inset Quotes eld
20545 New\SpecialChar ldots
20547 \begin_inset Quotes erd
20550 button and, in the window that opens, enter
20551 \begin_inset Quotes eld
20556 \begin_inset Quotes erd
20559 (or any other name you like) in the
20560 \begin_inset Quotes eld
20564 \begin_inset Quotes erd
20568 Now click on the button labeled
20569 \begin_inset Quotes eld
20574 \begin_inset Quotes erd
20577 to open a file dialog and navigate to the directory containing the batch
20579 \begin_inset Flex Code
20582 \begin_layout Plain Layout
20590 \begin_inset Flex Code
20593 \begin_layout Plain Layout
20599 and then specify the program arguments as
20600 \begin_inset Flex Code
20603 \begin_layout Plain Layout
20611 \begin_inset Flex Code
20614 \begin_layout Plain Layout
20620 wrapper is used for communicating with \SpecialChar LyX
20628 \begin_layout LyX-Code
20630 \begin_inset Newline newline
20633 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
20642 \begin_inset Newline newline
20656 \begin_layout Standard
20657 Make sure that the \SpecialChar LyX
20658 Server pipe path you specified in \SpecialChar LyX
20660 \begin_inset Flex Code
20663 \begin_layout Plain Layout
20677 , otherwise change the
20678 \begin_inset Flex Code
20681 \begin_layout Plain Layout
20687 wrapper accordingly.
20690 \begin_layout Standard
20691 In yap, reverse search is triggered by double-click.
20694 \begin_layout Subsubsection*
20695 SumatraPDF (Windows)
20698 \begin_layout Standard
20699 In order to use SumatraPDF for inverse search, enter
20700 \begin_inset Flex Code
20703 \begin_layout Plain Layout
20704 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
20709 in the viewer setting in
20710 \begin_inset Flex Noun
20713 \begin_layout Plain Layout
20714 Preferences\SpecialChar menuseparator
20715 File Handling\SpecialChar menuseparator
20716 File formats\SpecialChar menuseparator
20723 \begin_inset Flex Code
20726 \begin_layout Plain Layout
20732 is the previous wrapper.
20733 If SumatraPDF.exe is not in your command PATH, use its full file name.
20736 \begin_layout Standard
20737 Reverse search is triggered by double-click.
20740 \begin_layout Subsubsection*
20744 \begin_layout Standard
20745 First of all, make sure that yap is your default DVI viewer in the Windows
20746 environment, then launch it, choose its
20747 \begin_inset Flex Noun
20750 \begin_layout Plain Layout
20751 View\SpecialChar menuseparator
20757 menu and select the
20758 \begin_inset Quotes eld
20762 \begin_inset Quotes erd
20767 \begin_inset Quotes eld
20770 New\SpecialChar ldots
20772 \begin_inset Quotes erd
20775 button and, in the window that opens, enter
20776 \begin_inset Quotes eld
20781 \begin_inset Quotes erd
20784 (or any other name you like) in the
20785 \begin_inset Quotes eld
20789 \begin_inset Quotes erd
20793 Now click on the button labeled
20794 \begin_inset Quotes eld
20799 \begin_inset Quotes erd
20802 to open a file dialog and navigate to the directory containing the
20803 \begin_inset Flex Code
20806 \begin_layout Plain Layout
20812 program (which is installed by default on Cygwin along with the \SpecialChar LyX
20815 \begin_inset Flex Code
20818 \begin_layout Plain Layout
20824 and then specify the program arguments as
20825 \begin_inset Flex Code
20828 \begin_layout Plain Layout
20835 In this way, you will be using the
20839 for communicating with \SpecialChar LyX
20841 If, for whatever reason, you want to use the
20846 \begin_inset Flex Code
20849 \begin_layout Plain Layout
20855 option and be sure to specify the \SpecialChar LyX
20856 Server pipe path in the \SpecialChar LyX
20860 \begin_layout Standard
20861 In yap, reverse search is triggered by double-click.
20864 \begin_layout Subsubsection*
20865 SumatraPDF (Cygwin)
20868 \begin_layout Standard
20869 In order to use SumatraPDF for inverse search, enter
20870 \begin_inset Flex Code
20873 \begin_layout Plain Layout
20874 SumatraPDF -inverse-search "lyxeditor -g %f %l"
20879 in the viewer setting in
20880 \begin_inset Flex Noun
20883 \begin_layout Plain Layout
20884 Preferences\SpecialChar menuseparator
20885 File Handling\SpecialChar menuseparator
20886 File formats\SpecialChar menuseparator
20893 If SumatraPDF.exe is not in your command PATH, use its full posix path.
20895 \begin_inset Flex Code
20898 \begin_layout Plain Layout
20904 enables communication via the
20910 \begin_inset Flex Code
20913 \begin_layout Plain Layout
20919 option if you want to use the
20923 , and be sure to specify the \SpecialChar LyX
20924 Server pipe path in the \SpecialChar LyX
20928 \begin_layout Standard
20929 Reverse search is triggered by double-click.
20932 \begin_layout Section
20936 \begin_layout Standard
20937 Forward search is, as the name implies, in a sense the
20938 \begin_inset Quotes eld
20942 \begin_inset Quotes erd
20946 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
20948 If forward search is set up (as described in what follows), you can put
20949 the cursor anywhere in your \SpecialChar LyX
20951 \begin_inset Flex Noun
20954 \begin_layout Plain Layout
20955 Navigate\SpecialChar menuseparator
20962 \begin_inset Flex Noun
20965 \begin_layout Plain Layout
20971 in the context menu via right mouse click), and then the viewer will jump
20972 to that position as well.
20973 This implies, of course, that your viewer supports this function.
20976 \begin_layout Standard
20977 To make forward search possible, you first need to provide the generated
20978 output PDF/DVI file with additional information about the \SpecialChar TeX
20980 This can be done via the methods described in the section
20981 \begin_inset CommandInset ref
20983 reference "subsec:rev-search"
20990 \begin_layout Standard
20991 Additionally, you need to configure \SpecialChar LyX
20992 for using your viewers in
20993 \begin_inset Flex Noun
20996 \begin_layout Plain Layout
20997 Tools\SpecialChar menuseparator
20998 Preferences\SpecialChar menuseparator
20999 Output\SpecialChar menuseparator
21006 We provide a range of tested configurations for some viewers, which you
21007 can select from the drop down list.
21008 If none of these configurations suits you, you have to find out and enter
21009 a suitable configuration yourself.
21010 The definition syntax uses the following placeholders:
21013 \begin_layout Itemize
21015 \begin_inset Flex Code
21018 \begin_layout Plain Layout
21027 \begin_layout Itemize
21029 \begin_inset Flex Code
21032 \begin_layout Plain Layout
21038 : name of the (temporary) exported .tex file (without path)
21041 \begin_layout Itemize
21043 \begin_inset Flex Code
21046 \begin_layout Plain Layout
21052 : name of the (temporary) exported .tex file (including path)
21055 \begin_layout Itemize
21057 \begin_inset Flex Code
21060 \begin_layout Plain Layout
21066 : name of the exported output file (either dvi or pdf, depending on which
21067 one exists in the temporary directory)
21070 \begin_layout Standard
21071 Note that only some of the viewers provide full and usable forward search
21072 functionality out of the box, among them yap, xdvi, okular
21076 \begin_layout Plain Layout
21077 You might want to set
21078 \begin_inset Flex Code
21081 \begin_layout Plain Layout
21088 \begin_inset Flex Noun
21091 \begin_layout Plain Layout
21092 Tools\SpecialChar menuseparator
21093 Preferences\SpecialChar menuseparator
21094 File Handling\SpecialChar menuseparator
21096 \begin_inset space ~
21109 , qpdfview, and SumatraPDF
21113 \begin_layout Plain Layout
21114 SumatraPDF can also use DDE commands through the external program CMCDDE
21115 — downloadable from
21116 \begin_inset CommandInset href
21118 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
21129 Others, such as evince
21133 \begin_layout Plain Layout
21134 Forward search with evince can be achieved by means of third party helper
21137 \begin_inset CommandInset href
21139 target "https://wiki.lyx.org/LyX/SyncTeX"
21149 , require some extra tools in order to use forward search.
21150 While many of the widespread PDF viewers (most notably Adobe Reader) do
21151 not support forward search at all, some other viewers – e.
21152 \begin_inset space \thinspace{}
21156 xpdf – allow at least to reload the document and jump to a specific page
21157 of the file, so you can at least navigate
21158 \begin_inset Quotes eld
21162 \begin_inset Quotes erd
21166 This latter functionality is provided by an external call of synctex (see
21167 the predefined example configurations).
21171 \begin_layout Standard
21172 Forward search works both with DVI and PDF output.
21174 simply checks which preview format you have used before (i.
21175 \begin_inset space \thinspace{}
21178 e., which format is already there in the temporary directory) and chooses
21179 the appropriate configuration for the respective format.
21182 \begin_layout Chapter
21184 \change_deleted 564990737 1671097409
21185 Special Document Classes
21190 \begin_layout Section
21192 \change_deleted 564990737 1669742044
21196 \begin_layout Standard
21198 \change_deleted 564990737 1669742044
21204 \begin_layout Subsection
21206 \change_deleted 564990737 1669742044
21210 \begin_layout Standard
21212 \change_deleted 564990737 1669742044
21213 This section describes how \SpecialChar LyX
21214 can be used to write articles for submission
21215 to the scientific journal
21217 Astronomy and Astrophysics
21220 \begin_inset Flex URL
21223 \begin_layout Plain Layout
21225 https://www.aanda.org/
21230 ) using Version 5.01 of the document class
21235 This package can be downloaded from the ftp site
21238 \begin_layout Standard
21240 \change_deleted 564990737 1669742044
21241 \begin_inset VSpace medskip
21247 \begin_layout Standard
21250 \change_deleted 564990737 1669742044
21251 \begin_inset Flex URL
21254 \begin_layout Plain Layout
21256 ftp://ftp.edpsciences.org/pub/aa/readme.html
21264 \begin_layout Standard
21266 \change_deleted 564990737 1669742044
21267 \begin_inset VSpace medskip
21273 \begin_layout Standard
21275 \change_deleted 564990737 1669742044
21276 A manual comes together with that package, and this text is not meant to
21277 replace the original manual but is merely a short guide in how to realize
21278 the correct form of your paper.
21282 \begin_layout Standard
21284 \change_deleted 564990737 1669742044
21285 Please note that the publisher of the journal was changed from Springer
21286 to EDP Sciences starting January 1, 2001.
21287 That change involved also some slight changes to the style files, namely
21288 the removal of the thesaurus command.
21289 The \SpecialChar LyX
21290 class aa supports the newest version of these style files, V 5.01.
21291 If you have an older version installed, please upgrade.
21292 For compatibility, the old (version 4) layout has been kept as
21297 Please refer to the comments in
21300 Dir/layouts/aapaper.layout
21305 \begin_layout Subsection
21307 \change_deleted 564990737 1669742044
21311 \begin_layout Standard
21313 \change_deleted 564990737 1669742044
21314 It is recommended you start from the example template distributed with \SpecialChar LyX
21316 If you are not using a template, note the following settings:
21319 \begin_layout Itemize
21321 \change_deleted 564990737 1669742044
21328 Document\SpecialChar menuseparator
21331 dialog (OK, that one was obvious).
21334 \begin_layout Itemize
21336 \change_deleted 564990737 1669742044
21337 Don't change the option
21340 \begin_inset space ~
21350 The whole layout is done by the macros, you shouldn't change anything.
21353 \begin_layout Subsection
21355 \change_deleted 564990737 1669742044
21359 \begin_layout Standard
21361 \change_deleted 564990737 1669742044
21362 First thing to enter is the header information.
21363 It consists of seven entries, of which some are optional.
21367 \begin_layout Itemize
21369 \change_deleted 564990737 1669742044
21377 \begin_layout Itemize
21379 \change_deleted 564990737 1669742044
21387 \begin_layout Itemize
21389 \change_deleted 564990737 1669742044
21397 \begin_layout Itemize
21399 \change_deleted 564990737 1669742044
21407 \begin_layout Itemize
21409 \change_deleted 564990737 1669742044
21414 : [optional] if more than one author: whom to contact for offprint requests.
21417 \begin_layout Itemize
21419 \change_deleted 564990737 1669742044
21424 : [optional] mail address for contacts.
21427 \begin_layout Itemize
21429 \change_deleted 564990737 1669742044
21435 Suggested format is
21437 Received: <date>; Accepted <date>
21440 \begin_layout Standard
21442 \change_deleted 564990737 1669742044
21443 There is no need to issue the
21449 command, this is done automatically by \SpecialChar LyX
21450 when the header is finished.
21451 Although the order of the single header entries doesn't matter it is advised
21452 to keep the above sequence, just to get the best optics and meets the layout
21453 of the real document.
21456 \begin_layout Standard
21458 \change_deleted 564990737 1669742044
21459 If you want to place footnotes in the header block, e.
21460 \begin_inset space \thinspace{}
21464 \begin_inset space \space{}
21467 to state your present address, just use the standard footnote via the menu
21470 Insert\SpecialChar menuseparator
21475 will automagically use the term
21484 \begin_layout Standard
21486 \change_deleted 564990737 1669742044
21489 Edit\SpecialChar menuseparator
21492 , you'll find two insets which are relevant for the titling:
21495 \begin_layout Itemize
21497 \change_deleted 564990737 1669742044
21504 to mark corresponding author\SpecialChar breakableslash
21506 The institutes are numbered sequentially as they appear in the
21510 field, so you have to put a marker to each author.
21513 \begin_layout Itemize
21515 \change_deleted 564990737 1669742044
21520 to supply an email address for fast contact.
21523 \begin_layout Standard
21525 \change_deleted 564990737 1669742044
21526 In addition to these topics, the macros use one additional \SpecialChar LaTeX
21528 has no counterpart in \SpecialChar LyX
21532 \begin_layout Itemize
21534 \change_deleted 564990737 1669742044
21541 to separate different names for more than one author and institute, respectivel
21545 \begin_layout Standard
21547 \change_deleted 564990737 1669742044
21548 The appropriate command has to be entered in \SpecialChar LyX
21549 and marked as \SpecialChar LaTeX
21555 \begin_layout Subsection
21557 \change_deleted 564990737 1669742044
21561 \begin_layout Standard
21563 \change_deleted 564990737 1669742044
21564 The abstract should immediately follow the header block.
21565 With version 5 the abstract environment was changed to a command, and there
21566 is now a restriction to only one paragraph.
21567 In addition, it should contain an entry with the keywords.
21568 This is done via the paragraph style
21573 Refer to the example paper.
21576 \begin_layout Subsection
21578 \change_deleted 564990737 1669742044
21579 Supported environments
21582 \begin_layout Standard
21584 \change_deleted 564990737 1669742044
21585 The A&A paper layout supports the following environments for structuring
21589 \begin_layout Itemize
21591 \change_deleted 564990737 1669742044
21597 \begin_layout Itemize
21599 \change_deleted 564990737 1669742044
21605 \begin_layout Itemize
21607 \change_deleted 564990737 1669742044
21613 \begin_layout Itemize
21615 \change_deleted 564990737 1669742044
21621 \begin_layout Itemize
21623 \change_deleted 564990737 1669742044
21629 \begin_layout Itemize
21631 \change_deleted 564990737 1669742044
21637 \begin_layout Itemize
21639 \change_deleted 564990737 1669742044
21645 \begin_layout Itemize
21647 \change_deleted 564990737 1669742044
21653 \begin_layout Itemize
21655 \change_deleted 564990737 1669742044
21661 \begin_layout Itemize
21663 \change_deleted 564990737 1669742044
21669 \begin_layout Itemize
21671 \change_deleted 564990737 1669742044
21677 \begin_layout Itemize
21679 \change_deleted 564990737 1669742044
21686 \begin_layout Subsection
21688 \change_deleted 564990737 1669742044
21689 Commands not supported by \SpecialChar LyX
21693 \begin_layout Standard
21695 \change_deleted 564990737 1669742044
21696 Some commands are not yet supported by the
21700 layout for \SpecialChar LyX
21702 Some have already been mentioned.
21703 For the sake of completeness, they are listed all together here:
21706 \begin_layout Itemize
21708 \change_deleted 564990737 1669742044
21716 \begin_layout Itemize
21718 \change_deleted 564990737 1669742044
21726 \begin_layout Itemize
21728 \change_deleted 564990737 1669742044
21736 \begin_layout Itemize
21738 \change_deleted 564990737 1669742044
21746 \begin_layout Standard
21748 \change_deleted 564990737 1669742044
21749 If you want to use any of these commands, you have to enter them yourself.
21752 Do not forget to mark them as \SpecialChar LaTeX
21756 \begin_layout Subsection
21758 \change_deleted 564990737 1669742044
21759 Figure and Table Floats
21762 \begin_layout Standard
21764 \change_deleted 564990737 1669742044
21766 provides support for the necessary float environments
21768 figure, figure*, table
21774 , therefore we won't tell much about it here.
21778 \begin_inset space ~
21784 Just remember that tables should be left-aligned.
21785 For that, select the table and change the alignment in
21787 Edit\SpecialChar menuseparator
21789 \begin_inset space ~
21795 \begin_layout Standard
21797 \change_deleted 564990737 1669742044
21798 There is only one special thing: the figures with caption besides the figure.
21799 To create such a figure, you have to do the following:
21802 \begin_layout Enumerate
21804 \change_deleted 564990737 1669742044
21805 Create a wide figure float:
21807 Insert\SpecialChar menuseparator
21808 Float\SpecialChar menuseparator
21811 , then right click in the figure and select
21814 \begin_inset space ~
21822 \begin_layout Enumerate
21824 \change_deleted 564990737 1669742044
21825 Enter your caption text.
21828 \begin_layout Enumerate
21830 \change_deleted 564990737 1669742044
21835 to move the cursor above the caption.
21838 \begin_layout Enumerate
21840 \change_deleted 564990737 1669742044
21844 \begin_layout Enumerate
21846 \change_deleted 564990737 1669742044
21847 Position the cursor behind the figure and insert a horizontal fill:
21849 Insert\SpecialChar menuseparator
21851 \begin_inset space ~
21854 Character\SpecialChar menuseparator
21856 \begin_inset space ~
21864 \begin_layout Enumerate
21866 \change_deleted 564990737 1669742044
21867 Switch to \SpecialChar LaTeX
21871 \begin_inset space ~
21879 \begin_layout Enumerate
21881 \change_deleted 564990737 1669742044
21891 Do not close the brace!
21894 \begin_layout Enumerate
21896 \change_deleted 564990737 1669742044
21897 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
21902 \begin_inset space ~
21914 \begin_layout Standard
21916 \change_deleted 564990737 1669742044
21917 Also, refer to the figures in the example paper.
21920 \begin_layout Subsection
21922 \change_deleted 564990737 1669742044
21926 \begin_layout Standard
21928 \change_deleted 564990737 1669742044
21929 For submission, the paper has to be formated in a special double-spacing
21931 For this purpose, you have to give the option
21935 to the document class.
21936 This must be done using the custom class options field in the
21938 Document\SpecialChar menuseparator
21942 Just enter the string
21949 \begin_layout Subsection
21951 \change_deleted 564990737 1669742044
21955 \begin_layout Standard
21957 \change_deleted 564990737 1669742044
21962 directory contains an example paper written with \SpecialChar LyX
21964 It is the example paper from the original macro package, translated to
21967 Use it for inspiration, and compare the original \SpecialChar LaTeX
21968 code with \SpecialChar LyX
21972 \begin_layout Section
21974 \change_deleted 564990737 1671097429
21978 \begin_layout Standard
21980 \change_deleted 564990737 1671097429
21985 can be used to type letters according to German conventions.
21986 A template file is included in
21988 .../lyx/share/templates
21990 for you to use as a starting point.
21993 \begin_layout Section
21995 \change_deleted 564990737 1671097429
21999 \begin_layout Standard
22001 \change_deleted 564990737 1671097429
22002 See the \SpecialChar LyX
22008 It contains all infos you need.
22011 \begin_layout Section
22013 \change_deleted 564990737 1669755802
22017 \begin_layout Standard
22019 \change_deleted 564990737 1669755802
22022 Panayotis Papasotiriou
22025 \begin_layout Subsection
22027 \change_deleted 564990737 1669755802
22031 \begin_layout Standard
22033 \change_deleted 564990737 1669755802
22034 The ijmpc package is a set of macros that facilitates electronic manuscript
22037 International Journal of Modern Physics C
22040 Similarly, the ijmpd package is for creating manuscripts to be submitted
22043 International Journal of Modern Physics D
22046 Both journals are published by World Scientific.
22047 The corresponding document classes are named
22056 These files, together with instructions for the authors, can be downloaded
22058 \begin_inset Flex URL
22061 \begin_layout Plain Layout
22063 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
22069 \begin_inset Flex URL
22072 \begin_layout Plain Layout
22074 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
22080 Both packages are modified versions of the standard
22081 \begin_inset Quotes eld
22085 \begin_inset Quotes erd
22088 package, and they are almost (but not exactly) identical.
22089 Most of their features are supported by \SpecialChar LyX
22091 I have used \SpecialChar LyX
22092 successfully to write articles submitted to both journals
22093 without any problem.
22096 \begin_layout Subsection
22098 \change_deleted 564990737 1669755802
22102 \begin_layout Standard
22104 \change_deleted 564990737 1669755802
22105 As usual, the easiest way to write a paper is to start with a template.
22108 File\SpecialChar menuseparator
22124 This will give an (almost) empty document that includes the most common
22125 fields found in a manuscript.
22126 Simply overwrite the existing text (including the brackets,
22131 You should keep in mind the following remarks.
22134 \begin_layout Enumerate
22136 \change_deleted 564990737 1669755802
22138 won't let you change the font size and the page style of the document,
22139 because such modifications are not allowed by both packages.
22142 \begin_layout Enumerate
22144 \change_deleted 564990737 1669755802
22145 The language of the document should not be changed.
22146 Before previewing your paper, be sure that the babel package is not used.
22147 To do this, click on
22150 arg "dialog-show document"
22155 \SpecialChar menuseparator
22159 \begin_inset Quotes eld
22163 \begin_inset Quotes erd
22173 \begin_layout Enumerate
22175 \change_deleted 564990737 1669755802
22177 \begin_inset Quotes eld
22181 \begin_inset Quotes erd
22184 style must be used to define keywords.
22187 \begin_layout Enumerate
22189 \change_deleted 564990737 1669755802
22190 The ijmpc package provides a style named
22191 \begin_inset Quotes eld
22194 Classification Codes
22195 \begin_inset Quotes erd
22198 , which can be used to define classification codes, such as PACS numbers.
22199 Note that this facility is not supported by the ijmpd package.
22202 \begin_layout Enumerate
22204 \change_deleted 564990737 1669755802
22205 Several new environments are available:
22206 \begin_inset Quotes eld
22210 \begin_inset Quotes erd
22214 \begin_inset Quotes eld
22218 \begin_inset Quotes erd
22222 \begin_inset Quotes eld
22226 \begin_inset Quotes erd
22230 \begin_inset Quotes eld
22234 \begin_inset Quotes erd
22238 \begin_inset Quotes eld
22242 \begin_inset Quotes erd
22246 \begin_inset Quotes eld
22250 \begin_inset Quotes erd
22254 \begin_inset Quotes eld
22258 \begin_inset Quotes erd
22262 \begin_inset Quotes eld
22266 \begin_inset Quotes erd
22270 \begin_inset Quotes eld
22274 \begin_inset Quotes erd
22278 \begin_inset Quotes eld
22282 \begin_inset Quotes erd
22286 \begin_inset Quotes eld
22290 \begin_inset Quotes erd
22294 \begin_inset Quotes eld
22298 \begin_inset Quotes erd
22302 \begin_inset Quotes eld
22306 \begin_inset Quotes erd
22310 \begin_inset Quotes eld
22314 \begin_inset Quotes erd
22318 Their use is more or less obvious.
22320 supports all these environments; it will use the proper label, text style,
22321 and numbering scheme for each of them.
22324 \begin_layout Enumerate
22326 \change_deleted 564990737 1669755802
22327 Both packages use basic citations; the natbib package should not be used.
22328 In \SpecialChar LyX
22329 , citation references are shown as usual; in the output, citations are
22330 shown as superscripts.
22331 If you want to use a citation as normal text, you should use the
22336 \begin_inset space \thinspace{}
22340 \begin_inset space \space{}
22344 \begin_inset Quotes eld
22348 \begin_inset space \space{}
22358 \begin_inset Quotes erd
22364 \begin_layout Enumerate
22366 \change_deleted 564990737 1669755802
22368 \begin_inset Quotes eld
22372 \begin_inset Quotes erd
22375 section in both packages.
22376 To put acknowledgments, just use the
22377 \begin_inset Quotes eld
22381 \begin_inset Quotes erd
22387 \begin_layout Enumerate
22389 \change_deleted 564990737 1669755802
22390 Appendices may be added to the paper,
22394 the Acknowledgments and
22400 provides a special environment, called
22401 \begin_inset Quotes eld
22405 \begin_inset Quotes erd
22408 which marks the beginning of the appendices.
22409 This environment should be left blank; it just sends a \SpecialChar LaTeX
22410 command, but nothing
22412 In \SpecialChar LyX
22414 \begin_inset Quotes eld
22418 \begin_inset Quotes erd
22421 is printed with blue letters, as a signal that all sections after that
22422 point are appendices.
22423 To write an appendix, use the
22424 \begin_inset Quotes eld
22428 \begin_inset Quotes erd
22433 will number each appendix with capital letters, as required by both journals.
22435 \begin_inset Quotes eld
22439 \begin_inset Quotes erd
22446 be present before the first appendix; if not, all appendices will be numbered
22447 as normal sections in the output.
22450 \begin_layout Enumerate
22452 \change_deleted 564990737 1669755802
22453 The ijmpc and the ijmpd packages use the
22457 command to implement table captions.
22458 As a result, a table created by \SpecialChar LyX
22459 is printed correctly, but its caption
22461 However, you can use some \SpecialChar TeX
22462 code to overcome this problem, so that captions
22463 are printed as expected.
22464 To do so, create a float table as usual, remove the caption, and replace
22465 it with the \SpecialChar TeX
22476 (sic); you must also the \SpecialChar TeX
22481 immediately after the tabular material.
22482 Study the example table included in the template files to see how this
22483 trick is implemented.
22484 Alternatively, If you need table captions, you should implement the whole
22489 file, then include this file to the \SpecialChar LyX
22492 Insert\SpecialChar menuseparator
22493 File\SpecialChar menuseparator
22495 \begin_inset space ~
22501 Details on how to create a table float can be found in the files
22509 , included in the corresponding packages.
22512 \begin_layout Subsection
22514 \change_deleted 564990737 1669755802
22515 Preparing a paper for submission
22518 \begin_layout Standard
22520 \change_deleted 564990737 1669755802
22521 Before you submit your paper you must export the \SpecialChar LyX
22522 document as a \SpecialChar LaTeX
22525 File\SpecialChar menuseparator
22526 Export\SpecialChar menuseparator
22534 \begin_layout Plain Layout
22535 Actually you have the choice between \SpecialChar LaTeX
22536 (plain) and pdflatex.
22537 If you intend to use pdflatex to prepare the paper, you should use the
22538 pdflatex option so that included graphics are converted to PDF format,
22539 ready for use by pdflatex.
22544 , then make the following changes to the resulting
22551 \begin_layout Enumerate
22553 \change_deleted 564990737 1669755802
22554 Remove the comment lines before the
22563 \begin_layout Enumerate
22565 \change_deleted 564990737 1669755802
22566 Remove everything between (and including) the
22578 commands, except for any commands you specifically put into the \SpecialChar LaTeX
22582 \begin_layout Standard
22584 \change_deleted 564990737 1669755802
22589 file should be saved and processed through \SpecialChar LaTeX
22590 as many times as necessary.
22591 You may also want to check the resulting
22600 \begin_layout Section
22602 \change_deleted 564990737 1669801478
22606 \begin_layout Standard
22608 \change_deleted 564990737 1669801478
22614 \begin_layout Subsection
22616 \change_deleted 564990737 1669801478
22620 \begin_layout Standard
22622 \change_deleted 564990737 1669801478
22623 The iopart package provides a document class to create electronic manuscript
22624 submission to the journals published by the Institute of Physics.
22625 Instructions for the authors how to create a paper using the iopart class
22626 can be downloaded together with the iopart package from the site
22627 \begin_inset Flex URL
22630 \begin_layout Plain Layout
22632 ftp://ftp.iop.org/pub/journals/latex2e
22640 \begin_layout Subsection
22642 \change_deleted 564990737 1669801478
22646 \begin_layout Standard
22648 \change_deleted 564990737 1669801478
22649 The easiest way to write a paper is to start with the template
22653 that is available via
22655 File\SpecialChar menuseparator
22658 The template explains how to use the special text environments.
22659 Here are the most important advices:
22662 \begin_layout Itemize
22664 \change_deleted 564990737 1669801478
22665 To be able to compile your document to a PDF, PS, or DVI, ensure that the
22666 no AMS packages are loaded in
22668 Document\SpecialChar menuseparator
22669 Settings\SpecialChar menuseparator
22675 \begin_layout Itemize
22677 \change_deleted 564990737 1669801478
22680 The title environment defines the kind of your paper.
22681 So use one of the following environments for the title:
22685 \begin_layout Itemize
22687 \change_deleted 564990737 1669801478
22696 \begin_layout Itemize
22698 \change_deleted 564990737 1669801478
22707 \begin_layout Itemize
22709 \change_deleted 564990737 1669801478
22715 for a Topical review
22718 \begin_layout Itemize
22720 \change_deleted 564990737 1669801478
22729 \begin_layout Itemize
22731 \change_deleted 564990737 1669801478
22740 \begin_layout Itemize
22742 \change_deleted 564990737 1669801478
22748 for a Paper (same as Title)
22751 \begin_layout Itemize
22753 \change_deleted 564990737 1669801478
22759 for a Preliminary communication
22762 \begin_layout Itemize
22764 \change_deleted 564990737 1669801478
22770 for a Rapid communication
22773 \begin_layout Itemize
22775 \change_deleted 564990737 1669801478
22781 for a Letter to the editor
22785 \begin_layout Itemize
22787 \change_deleted 564990737 1669801478
22790 All title environments except of
22794 can have an optional short title.
22797 \begin_layout Itemize
22799 \change_deleted 564990737 1669801478
22800 There is a general title environment
22804 which is not directly supported by \SpecialChar LyX
22806 This can be used as \SpecialChar TeX
22807 code when your document doesn't fit into one of the
22811 \begin_layout Standard
22813 \change_deleted 564990737 1669801478
22814 For more informations like hints for special table and formula formatting,
22815 look at the IOP author guidelines.
22820 \begin_layout Section
22822 \change_deleted 564990737 1670317155
22826 \begin_layout Standard
22828 \change_deleted 564990737 1670317155
22831 Panayotis Papasotiriou
22834 \begin_layout Subsection
22836 \change_deleted 564990737 1670317155
22840 \begin_layout Standard
22842 \change_deleted 564990737 1670317155
22843 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
22844 that facilitates electronic manuscript submission to the journals they
22846 Most known of them (at least in my domain of interest) are
22848 Astrophysics and Space Science
22854 , but there are many others (see a complete list at
22855 \begin_inset Flex URL
22858 \begin_layout Plain Layout
22860 http://www.wkap.nl/jrnllist.htm/JRNLHOME
22866 The Kluwer package may be downloaded from the site
22867 \begin_inset Flex URL
22870 \begin_layout Plain Layout
22872 http://www.wkap.nl/kaphtml.htm/STYLEFILES
22878 A complete user guide is contained in that package (but it can also be
22879 downloaded separately).
22882 \begin_layout Standard
22884 \change_deleted 564990737 1670317155
22886 supports many features of the package but not everything.
22887 However, the \SpecialChar TeX
22888 code needed is reduced to some
22889 \begin_inset Quotes eld
22893 \begin_inset Quotes erd
22896 commands of the package (see
22897 \begin_inset space ~
22901 \begin_inset CommandInset ref
22903 reference "subsec:kluwer_peculiarities"
22908 I have recently used \SpecialChar LyX
22909 to write an article submitted to the
22911 Astrophysics and Space Science
22913 without any problem.
22916 \begin_layout Subsection
22918 \change_deleted 564990737 1670317155
22922 \begin_layout Standard
22924 \change_deleted 564990737 1670317155
22925 The easiest way to write a paper is to start with the Kluwer template file.
22928 File\SpecialChar menuseparator
22940 This will give an (almost) empty document that includes the most common
22941 fields found in a manuscript and a short description of their use.
22942 As in most templates, simply overwrite the existing text (including the
22947 ) with the correct information.
22950 \begin_layout Subsection
22952 \change_deleted 564990737 1670317155
22953 Preparing a paper for submission
22956 \begin_layout Standard
22958 \change_deleted 564990737 1670317155
22959 As in the AAS\SpecialChar TeX
22960 package, before you submit your paper to a journal you must
22962 \begin_inset Quotes eld
22966 \begin_inset Quotes erd
22972 \begin_layout Enumerate
22974 \change_deleted 564990737 1670317155
22975 Export your paper as a \SpecialChar LaTeX
22977 To do this, click on
22979 File\SpecialChar menuseparator
22980 Export\SpecialChar menuseparator
22988 \begin_layout Enumerate
22990 \change_deleted 564990737 1670317155
22995 file with a text editor and make the following changes
22999 \begin_layout Enumerate
23001 \change_deleted 564990737 1670317155
23002 remove the comment lines before the
23011 \begin_layout Enumerate
23013 \change_deleted 564990737 1670317155
23014 remove everything between (and including) the
23026 commands, except for any commands you specifically put into the \SpecialChar LaTeX
23030 \begin_layout Standard
23032 \change_deleted 564990737 1670317155
23041 \begin_layout Enumerate
23043 \change_deleted 564990737 1670317155
23048 file through \SpecialChar LaTeX
23049 as many times as necessary (usually up to three).
23052 \begin_layout Enumerate
23054 \change_deleted 564990737 1670317155
23060 \begin_inset space \thinspace{}
23064 \begin_inset space \space{}
23071 , and check if everything is OK (it should, if you didn't make any mistake).
23074 \begin_layout Subsection
23076 \change_deleted 564990737 1670317155
23077 \begin_inset Quotes eld
23081 \begin_inset Quotes erd
23084 of the Kluwer package
23085 \begin_inset CommandInset label
23087 name "subsec:kluwer_peculiarities"
23094 \begin_layout Standard
23096 \change_deleted 564990737 1670317155
23097 The Kluwer package has the following
23098 \begin_inset Quotes eld
23102 \begin_inset Quotes erd
23108 \begin_layout Enumerate
23110 \change_deleted 564990737 1670317155
23111 It is possible to write multiple articles in the same \SpecialChar LaTeX
23116 \begin_layout Plain Layout
23117 I can't imagine any good reason to do this.
23123 Each article must be included in the environment
23124 \begin_inset Quotes eld
23128 \begin_inset Quotes erd
23132 Unfortunately, this environment cannot be omitted, even if you write just
23134 Therefore, each article starts with the command
23140 and, obviously, ends with the command
23147 Although this can be implemented in \SpecialChar LyX
23148 , I didn't included it, since it looks
23149 ugly and can confuse the novice user.
23150 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
23153 \begin_inset Quotes eld
23158 \begin_inset Quotes erd
23164 \begin_layout Enumerate
23166 \change_deleted 564990737 1670317155
23167 Information given at the beginning of the article (i.
23168 \begin_inset space \thinspace{}
23172 \begin_inset space \space{}
23175 title, subtitle, author, institution, running title, running author, abstract
23176 and keywords) must be included in an environment called
23177 \begin_inset Quotes eld
23181 \begin_inset Quotes erd
23185 This is not implemented in \SpecialChar LyX
23186 , so you must enter title, subtitle etc.
23187 \begin_inset space ~
23190 between two \SpecialChar TeX
23206 \begin_layout Enumerate
23208 \change_deleted 564990737 1670317155
23209 According to the user manual, the label of each bibliography item must be
23233 \begin_layout Standard
23235 \change_deleted 564990737 1670317155
23240 template takes care of all these
23241 \begin_inset Quotes eld
23245 \begin_inset Quotes erd
23249 If you start a new paper using this template you don't need to do anything
23254 \begin_layout Enumerate
23256 \change_deleted 564990737 1670317155
23257 don't delete the \SpecialChar TeX
23258 code included in the template, and
23261 \begin_layout Enumerate
23263 \change_deleted 564990737 1670317155
23264 copy the example bibliography item included in the template and modify it
23265 as necessary to enter new bibliography items.
23268 \begin_layout Section
23270 \change_deleted 564990737 1671097446
23274 \begin_layout Standard
23276 \change_deleted 564990737 1671097446
23281 provides an alternative to the standard
23286 It provides similar functionality, but you might prefer this layout with
23287 sans serif sections, headings, and more.
23290 \begin_layout Section
23292 \change_deleted 564990737 1671097446
23293 Springer Journals (
23300 \begin_layout Standard
23302 \change_deleted 564990737 1671097446
23308 \begin_layout Subsection
23310 \change_deleted 564990737 1671097446
23314 \begin_layout Standard
23316 \change_deleted 564990737 1671097446
23317 These are the layout files for some of the journal formats used by Springer
23318 Verlag and listed on
23319 \begin_inset Flex URL
23322 \begin_layout Plain Layout
23324 http://www.springer.de/author/tex/help-journals.html
23329 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
23331 It is a modular system: the things common to all journals are implemented
23336 , which journal-specific layout files (such as, e.
23337 \begin_inset space \thinspace{}
23341 \begin_inset space \space{}
23348 for Journal of Geodesy) can include.
23351 \begin_layout Standard
23353 \change_deleted 564990737 1671097446
23354 This means that implementing support for any other Springer journal on this
23355 list is as simple as writing your own
23363 file following the outline given in
23371 \begin_layout Standard
23373 \change_deleted 564990737 1671097446
23374 It is reasonably well tested only for the Journal of Geodesy.
23383 come with the standard \SpecialChar LyX
23385 Install the relevant class file (downloaded from Springer) in a proper
23386 directory, reconfigure \SpecialChar LaTeX
23387 (in the te\SpecialChar TeX
23392 , as root if necessary — doesn't \SpecialChar LyX
23393 take care of this?), reconfigure \SpecialChar LyX
23398 \begin_layout Subsection
23400 \change_deleted 564990737 1671097446
23404 \begin_layout Standard
23406 \change_deleted 564990737 1671097446
23407 A large number of theorem-like styles —
23419 \begin_layout Standard
23421 \change_deleted 564990737 1671097446
23424 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
23425 _Title, Author_Running, Institute,
23426 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
23429 See the Springer class file documentation for details.
23432 \begin_layout Subsection
23434 \change_deleted 564990737 1671097446
23438 \begin_layout Itemize
23440 \change_deleted 564990737 1671097446
23452 \begin_layout Itemize
23454 \change_deleted 564990737 1671097446
23457 Probability Theory and Related Fields
23463 — Jean-Marc Lasgouttes
23466 \begin_layout Standard
23468 \change_deleted 564990737 1671097446
23469 Add your own, it isn't so hard!
23472 \begin_layout Subsection
23474 \change_deleted 564990737 1671097446
23478 \begin_layout Standard
23480 \change_deleted 564990737 1671097446
23481 These files are partly based on the older
23485 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
23487 file from Springer.
23492 layout, are now defunct.
23493 Jean-Marc Lasgouttes helped out big in making me find my way around the
23495 layout file mechanism.
23498 \begin_layout Subsection
23500 \change_deleted 564990737 1671097446
23504 \begin_layout Standard
23506 \change_deleted 564990737 1671097446
23508 But probably less than in the old hacked-\SpecialChar LaTeX
23516 \begin_layout Chapter
23518 Features needing Extra Software
23521 \begin_layout Section
23522 Checking \SpecialChar TeX
23526 \begin_layout Standard
23532 \begin_layout Subsection
23536 \begin_layout Standard
23545 \begin_layout Plain Layout
23550 is not yet available when you are using the \SpecialChar LaTeX
23551 distribution MiK\SpecialChar TeX
23557 , you'll find in the
23564 \begin_inset space ~
23575 \begin_inset Newline newline
23579 \begin_inset CommandInset href
23581 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
23589 \begin_layout Standard
23592 Chk\SpecialChar TeX
23595 package is a program that was written by
23596 \begin_inset Flex Noun
23599 \begin_layout Plain Layout
23601 \begin_inset space ~
23609 in frustration because some constructs in \SpecialChar LaTeX
23610 are sometimes non-intuitive,
23611 and easy to forget.
23612 The program runs over your \SpecialChar LaTeX
23613 file, checks the integrity of the file, and
23614 flags some common errors.
23615 In other technical words, it is
23619 for \SpecialChar LaTeX
23623 \begin_layout Standard
23624 Well, what is a syntax checker doing in \SpecialChar LyX
23625 which is supposed to produce correct
23627 anyways? The answer is simple: Just as
23631 not only checks the
23635 of C programs, but also does
23639 checks for type-errors,
23641 Chk\SpecialChar TeX
23644 catches some common
23648 errors, in addition to the syntactical ones.
23651 Chk\SpecialChar TeX
23654 is capable of detecting several common errors, such as
23657 \begin_layout Itemize
23658 Ellipsis detection:
23659 \begin_inset Newline newline
23662 Use \SpecialChar ldots
23666 \begin_layout Itemize
23667 No space in front of/after parenthesis:
23668 \begin_inset Newline newline
23674 \begin_layout Itemize
23675 Enforcement of normal space after common abbreviations:
23676 \begin_inset Newline newline
23680 \begin_inset space \thinspace{}
23684 \begin_inset space \space{}
23687 is too wide spacing.
23690 \begin_layout Itemize
23691 Enforcement of end-of-sentence space when the last sentence ends with a
23693 \begin_inset Newline newline
23697 And this is wrong spacing.
23700 \begin_layout Itemize
23701 Space in front of labels and similar commands:
23702 \begin_inset Newline newline
23705 The label should stick right up to the text to avoid falling to a wrong
23708 \begin_inset CommandInset label
23718 \begin_layout Plain Layout
23719 This footnote is in danger of falling off to a wrong page
23724 The label is separated too much.
23727 \begin_layout Itemize
23728 Space in front of references, instead of hard spaces:
23729 \begin_inset Newline newline
23732 If you have bad luck, the text will break right between the referenced text
23733 and reference number, and that's a pity.
23735 \begin_inset CommandInset ref
23737 reference "sec:chktex"
23744 \begin_layout Itemize
23746 \begin_inset Quotes eld
23750 \begin_inset Quotes erd
23754 \begin_inset Formula $\times$
23758 \begin_inset Newline newline
23761 2x2 looks cheap compared to
23762 \begin_inset Formula $2\times2$
23768 \begin_layout Standard
23769 and more \SpecialChar ldots
23770 It is an invaluable tool when you are
23771 \begin_inset Quotes eld
23775 \begin_inset Quotes erd
23778 your document before printing, and you should run it right after the obligatory
23779 spelling check, and before you go fine tuning the typesetting.
23782 \begin_layout Subsection
23786 \begin_layout Standard
23787 If you have the program installed, usage is as simple as choosing
23789 Tools\SpecialChar menuseparator
23791 \begin_inset space ~
23797 This will make \SpecialChar LyX
23798 generate a \SpecialChar LaTeX
23799 file of your document, start
23801 Chk\SpecialChar TeX
23804 to check it, and then make \SpecialChar LyX
23806 \begin_inset Quotes eld
23810 \begin_inset Quotes erd
23813 with the warnings from
23815 Chk\SpecialChar TeX
23818 , if there were any.
23819 The warnings will be placed close to the point of the mistake, and you
23820 can quickly find them by using the
23822 Navigate\SpecialChar menuseparator
23825 menu item, or the shortcut key
23834 Open the error boxes by clicking on them with the mouse, or use the shortcut
23843 bindings, or the corresponding
23852 Read the warning and correct the mistake, if it is a mistake.
23853 If you have trouble understanding what the warning is about, you can safely
23855 Remember that there is a hidden layer between the document on screen and
23856 the technical details in invoking
23858 Chk\SpecialChar TeX
23861 , and this gap can make some warnings seem arcane or just plain silly.
23864 \begin_layout Standard
23865 This document is an excellent testing bed for the feature, and it should
23866 provide quite a few warnings for you to fiddle with.
23867 Since computers are only so smart, expect most of the warnings to be false
23871 \begin_layout Subsection
23872 How to fine tune it
23875 \begin_layout Standard
23876 Sometimes, you'll find that
23878 Chk\SpecialChar TeX
23881 makes more noise than suits your mood.
23882 Then you can choose not to use it, wait until your mood changes, or try
23885 Chk\SpecialChar TeX
23888 to get better along with you.
23891 \begin_layout Standard
23894 Chk\SpecialChar TeX
23901 very configurable and extensible, you should not expect to solve all problems
23904 Chk\SpecialChar TeX
23907 in \SpecialChar LyX
23909 Since \SpecialChar LyX
23910 has to generate a somewhat special \SpecialChar LaTeX
23911 file to be able to match the
23912 line numbers from the
23914 Chk\SpecialChar TeX
23921 \begin_layout Plain Layout
23922 You can inspect the specific output from
23928 Document\SpecialChar menuseparator
23931 \begin_inset space ~
23945 to the internal document structure, some of the warnings will not appear
23947 There are two things you can do about this:
23950 \begin_layout Itemize
23953 Chk\SpecialChar TeX
23956 invocation command line in
23957 \begin_inset Flex Noun
23960 \begin_layout Plain Layout
23961 Tools\SpecialChar menuseparator
23962 Preferences\SpecialChar menuseparator
23963 Output\SpecialChar menuseparator
23964 LaTeX\SpecialChar menuseparator
23972 Chk\SpecialChar TeX
23975 installation configuration file (usually with the file
23980 See below to learn what warnings can be enabled and disabled on the command
23984 \begin_layout Itemize
23985 Export your document as a raw \SpecialChar LaTeX
23988 File\SpecialChar menuseparator
23989 Export\SpecialChar menuseparator
23998 Invoked in this way, it can be a hassle to find the corresponding place
23999 in the document inside \SpecialChar LyX
24000 , but with a little patience, you should be able
24004 \begin_layout Standard
24005 Here follows the warning messages that can be enabled and disabled in
24014 to disable a warning, and
24018 to enable a warning.
24019 The emphasized entries are disabled by default, because the default is
24022 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
24027 \begin_layout Standard
24028 Notice that you should only use the options that enable and disable warnings,
24029 because \SpecialChar LyX
24030 relies on some of the other command line parameters to be set
24031 in a specific way to have a chance to communicate with
24038 \begin_layout Enumerate
24042 Command terminated with space.
24045 \begin_layout Enumerate
24048 Non-breaking space (
24049 \begin_inset Quotes eld
24057 \begin_inset Quotes erd
24060 ) should have been used.
24063 \begin_layout Enumerate
24067 You should enclose the previous parenthesis with
24068 \begin_inset Quotes eld
24076 \begin_inset Quotes erd
24082 \begin_layout Enumerate
24085 Italic correction (
24086 \begin_inset Quotes eld
24096 \begin_inset Quotes erd
24099 ) found in non-italic buffer.
24102 \begin_layout Enumerate
24105 Italic correction (
24106 \begin_inset Quotes eld
24116 \begin_inset Quotes erd
24119 ) found more than once.
24122 \begin_layout Enumerate
24126 No italic correction (
24127 \begin_inset Quotes eld
24137 \begin_inset Quotes erd
24143 \begin_layout Enumerate
24147 \begin_inset Quotes eld
24155 \begin_inset Quotes erd
24159 \begin_inset Quotes eld
24167 \begin_inset Quotes erd
24173 \begin_layout Enumerate
24176 Wrong length of dash may have been used.
24179 \begin_layout Enumerate
24183 \begin_inset Quotes eld
24191 \begin_inset Quotes erd
24195 \begin_inset Quotes eld
24203 \begin_inset Quotes erd
24209 \begin_layout Enumerate
24213 \begin_inset Quotes eld
24221 \begin_inset Quotes erd
24227 \begin_layout Enumerate
24231 \begin_inset Quotes eld
24239 \begin_inset Quotes erd
24242 to achieve an ellipsis.
24245 \begin_layout Enumerate
24248 Inter-word spacing (
24249 \begin_inset Quotes eld
24259 \begin_inset Quotes eld
24262 ) should perhaps be used.
24265 \begin_layout Enumerate
24268 Inter-sentence spacing (
24269 \begin_inset Quotes eld
24279 \begin_inset Quotes erd
24282 ) should perhaps be used.
24285 \begin_layout Enumerate
24288 Could not find argument for command.
24291 \begin_layout Enumerate
24295 \begin_inset Quotes eld
24303 \begin_inset Quotes erd
24309 \begin_layout Enumerate
24312 Math mode still on at end of \SpecialChar LaTeX
24316 \begin_layout Enumerate
24320 \begin_inset Quotes eld
24328 \begin_inset Quotes erd
24331 doesn't match the number of
24332 \begin_inset Quotes eld
24340 \begin_inset Quotes erd
24346 \begin_layout Enumerate
24349 You should use either
24352 \begin_inset Quotes eld
24360 \begin_inset Quotes erd
24365 as an alternative to
24366 \begin_inset Quotes eld
24374 \begin_inset Quotes erd
24380 \begin_layout Enumerate
24387 " (ASCII 39) instead of "
24394 \begin_layout Enumerate
24397 User-specified pattern found.
24400 \begin_layout Enumerate
24403 This command might not be intended.
24406 \begin_layout Enumerate
24413 \begin_layout Enumerate
24431 \begin_layout Enumerate
24434 Delete this space to maintain correct page references.
24437 \begin_layout Enumerate
24441 You might wish to put this between a pair of
24442 \begin_inset Quotes eld
24450 \begin_inset Quotes erd
24456 \begin_layout Enumerate
24459 You ought to remove spaces in front of punctuation.
24462 \begin_layout Enumerate
24465 Could not execute \SpecialChar LaTeX
24469 \begin_layout Enumerate
24478 in front of small punctuation.
24481 \begin_layout Enumerate
24489 may look prettier here.
24492 \begin_layout Enumerate
24496 Multiple spaces detected in output.
24499 \begin_layout Enumerate
24502 This text may be ignored.
24505 \begin_layout Enumerate
24511 \begin_inset Quotes eld
24516 to begin quotation, not
24523 \begin_layout Enumerate
24530 to end quotation, not
24533 \begin_inset Quotes eld
24541 \begin_layout Enumerate
24547 \begin_layout Enumerate
24550 You should perhaps use
24551 \begin_inset Quotes eld
24559 \begin_inset Quotes erd
24565 \begin_layout Enumerate
24568 You should put a space in front of/after parenthesis.
24571 \begin_layout Enumerate
24574 You should avoid spaces in front of/after parenthesis.
24577 \begin_layout Enumerate
24581 You should not use punctuation in front of/after quotes.
24584 \begin_layout Enumerate
24587 Double space found.
24590 \begin_layout Enumerate
24593 You should put punctuation outside inner/inside display math mode.
24596 \begin_layout Enumerate
24599 You ought to not use primitive \SpecialChar TeX
24600 in \SpecialChar LaTeX
24604 \begin_layout Enumerate
24607 You should remove spaces in front of
24608 \begin_inset Quotes eld
24616 \begin_inset Quotes erd
24622 \begin_layout Enumerate
24625 \begin_inset Quotes eld
24633 \begin_inset Quotes erd
24636 is normally not followed by
24637 \begin_inset Quotes eld
24645 \begin_inset Quotes erd
24651 \begin_layout Standard
24652 In later versions of \SpecialChar LyX
24653 , we hope to provide a more complete interface to this
24654 tool (and it's smaller cousin
24658 ) to exploit the full power of it.
24659 But it's not exactly useless as it is now: go try it on one of your existing
24660 documents of a certain length and be surprised.
24663 \begin_layout Section
24664 Version Control in \SpecialChar LyX
24668 \begin_layout Standard
24671 Lars Gullik Bjønnes
24678 \begin_layout Subsection
24682 \begin_layout Standard
24684 supports some of the most basic RCS/CVS/SVN/GIT commands.
24685 If you need something a bit more sophisticated you will have to do that
24686 manually in a terminal.
24689 \begin_layout Standard
24690 Also note that CVS support is not as good as subversion support, so we advise
24692 A good place to start learning Subversion is the SVN Book
24696 \begin_layout Plain Layout
24697 \begin_inset CommandInset href
24699 target "http://svnbook.red-bean.com/"
24710 In the case of RCS you should read
24711 \begin_inset Quotes eld
24715 \begin_inset Quotes erd
24718 (a man file, read it with
24723 This file describes all the basic features of RCS.
24724 You should especially notice the comment about a RCS directory, and the
24725 notion of a master RCS file (the file ending in
24732 \begin_layout Standard
24733 Before you begin to use the version control features in \SpecialChar LyX
24735 familiar with RCS/CVS/SVN/GIT usage.
24736 The implementation in \SpecialChar LyX
24737 assumes a recent version of the GNU RCS or CVS/SVN
24738 package — no guarantees are made for older versions.
24739 Most of the log messages are not currently displayed after operations —
24740 you can check them in the Messages pane if you are unsure.
24741 Regular users of version control will appreciate the VC toolbar, which
24744 View\SpecialChar menuseparator
24745 Toolbars\SpecialChar menuseparator
24747 \begin_inset space ~
24755 \begin_layout Standard
24756 For introducing your own external commands consult
24757 \begin_inset Flex Code
24760 \begin_layout Plain Layout
24774 \begin_layout Standard
24775 It is strongly recommended to store documents in uncompressed format if
24776 using version control (uncheck
24778 Document\SpecialChar menuseparator
24781 if it is checked): Uncompressed LyX documents are text files and therefore
24782 for merging two different versions by version control systems.
24783 Compressed LyX documents are binary files, which cannot be merged by version
24787 \begin_layout Subsection
24788 RCS commands in \SpecialChar LyX
24792 \begin_layout Standard
24793 The following sections describe the RCS commands supported by \SpecialChar LyX
24795 You can find them in the
24797 File\SpecialChar menuseparator
24799 \begin_inset space ~
24806 was tested against RCS 5.7/5.8.
24809 \begin_layout Subsubsection
24815 \begin_layout Standard
24816 If your document is not under revision control, this is the only item shown
24818 And if it is under revision control, the
24822 item is not visible.
24826 \begin_layout Standard
24827 This command registers your document with RCS (unless you are under the
24828 directory managed by CVS)\SpecialChar endofsentence
24829 You are asked interactively to supply an initial
24830 description of the document.
24831 The document is now set in Read-Only mode and you have to
24834 \begin_inset space ~
24838 \begin_inset space ~
24842 \begin_inset space ~
24847 , before making any changes to it.
24848 A document under revision control has a
24849 \begin_inset Quotes eld
24852 [RCS:<version> <locker>]
24853 \begin_inset Quotes erd
24856 item tagged to the filename in the minibuffer.
24859 \begin_layout Standard
24860 RCS command that is run:
24863 \begin_layout LyX-Code
24866 ci -q -u -i -t-"<initial description>" <file-name>
24869 \begin_layout Standard
24874 to understand the switches.
24878 \begin_layout Subsubsection
24884 \begin_layout Standard
24885 When you are finished editing a file, you check in your changes.
24886 When you do this, you are asked for a description of the changes.
24887 This is stored in the history log.
24888 The version number is bumped, your changes are applied to the master RCS
24889 file, the document is unlocked and set to Read-Only mode.
24892 \begin_layout Itemize
24895 ci -q -u -m"<description>" <file-name>
24898 \begin_layout Subsubsection
24904 \begin_layout Standard
24905 By doing this you lock the document so that only you can edit it.
24906 This will also make the document Read-Write only for you.
24907 You will usually continue editing for a while and when you are finished
24908 you check in your changes.
24909 The status line is changed to reflect that you have locked the file.
24912 \begin_layout Itemize
24915 co -q -l <file-name>
24918 \begin_layout Subsubsection
24921 Revert To Repository Version
24924 \begin_layout Standard
24925 This will discard all changes made to the document since the last check
24927 You get a warning before changes are discarded.
24930 \begin_layout Itemize
24933 co -f -u<version> <file-name>
24936 \begin_layout Subsubsection
24942 \begin_layout Standard
24943 This will create a copy of the current document.
24944 Since RCS does not support copy operations natively, the version history
24945 is not preserved, and the copy is added as a new file.
24946 It requires a clean document without any changes since the last checkin.
24947 You are asked for a file name and a description of the copy operation.
24948 After that the copy is created, both locally and in the repository.
24949 If the parent directories of the copied and original document differ, all
24950 relative paths of included files of the copy are adjusted (like in
24952 File\SpecialChar menuseparator
24957 Finally, the copy is loaded instead of the original document.
24960 \begin_layout Labeling
24961 \labelwidthstring 00.00.0000
24963 \begin_inset space ~
24967 \begin_inset space ~
24971 \begin_inset Newline newline
24975 \begin_inset Flex Code
24978 \begin_layout Plain Layout
24981 \begin_inset Quotes qld
24985 \begin_inset Quotes qld
24994 \begin_inset Flex Code
24997 \begin_layout Plain Layout
25000 \begin_inset Quotes qld
25004 \begin_inset Quotes qld
25013 \begin_inset Newline newline
25017 \begin_inset Flex Code
25020 \begin_layout Plain Layout
25024 \begin_inset Quotes qld
25028 \begin_inset Quotes qld
25039 \begin_layout Subsubsection
25045 \begin_layout Standard
25046 This makes as if the last check in never happened.
25047 No changes are made to the document loaded into \SpecialChar LyX
25048 , but the last version
25049 is removed from the master RCS file.
25052 \begin_layout Itemize
25055 rcs -o<version> <file-name>
25058 \begin_layout Subsubsection
25064 \begin_layout Standard
25065 This shows the complete history of the RCS document.
25070 is shown in a browser.
25078 \begin_layout Subsubsection
25082 \begin_layout Standard
25084 supports RCS version number, author name, date and time of last commit.
25085 All those are extracted from
25087 rlog -r <file-name>
25091 \begin_inset CommandInset ref
25093 reference "subsec:VCS-Revision-Information"
25100 \begin_layout Subsection
25101 CVS commands in \SpecialChar LyX
25105 \begin_layout Standard
25106 A subset of CVS operations is supported by \SpecialChar LyX
25108 You can find the commands in the
25110 File\SpecialChar menuseparator
25112 \begin_inset space ~
25118 The version control system SVN is more powerful, so please use it instead
25119 of CVS if possible.
25122 \begin_layout Subsubsection
25128 \begin_layout Standard
25129 If you start from scratch with CVS you have to create your repository and
25130 checkout the working copy with external tools.
25131 If you're using a client-server setup you may need to login before doing
25132 the first repository checkout.
25135 \begin_layout Standard
25136 If your documents are under revision control and others are using the same
25137 repository problems arise when different changes to the same document at
25138 the same location happen.
25139 Standard CVS repositories don't operate with a file locking mechanism.
25140 This may be surprising, but conflicts only occur if people disagree on
25141 the proper content of the same part of a document.
25142 So, if co-workers are used to communicate regularly, these conflicts occur
25144 If they don't communicate they have a fundamental problem anyway.
25145 Nevertheless some people like to work with so called
25146 \begin_inset Quotes eld
25150 \begin_inset Quotes erd
25154 If they do so the working copy of all files is readonly when checked out
25155 first and the user starts editing after using a special command to make
25156 the working copy writable.
25157 When the changes are checked in the working copy returns to readonly state.
25158 With \SpecialChar LyX
25159 one has to edit the
25160 \begin_inset Flex Code
25163 \begin_layout Plain Layout
25169 file and add the line
25170 \begin_inset Flex Code
25173 \begin_layout Plain Layout
25179 to work with reserved checkouts.
25180 The benefit is the possibility to see who is using a writable copy of some
25182 It's not guaranteed only one user makes a copy writable.
25185 \begin_layout Standard
25187 tries to guess if you're using reserved or non-reserved checkouts.
25188 If your working copy is readonly or it is writable and an additional copy
25189 of your document exists in the CVS/Base sub-directory a reserved otherwise
25190 a non-reserved checkout is assumed.
25191 When a reserved checkout is detected you have to use
25192 \begin_inset Flex Noun
25195 \begin_layout Plain Layout
25201 to make your working copy writable if it's readonly.
25203 \begin_inset Flex Noun
25206 \begin_layout Plain Layout
25212 operation is possible and that makes your working copy readonly again after
25213 transferring your changes to the repository.
25216 \begin_layout Standard
25217 More information about CVS can be found here
25218 \begin_inset Flex URL
25221 \begin_layout Plain Layout
25223 http://www.nongnu.org/cvs
25229 \begin_inset Flex URL
25232 \begin_layout Plain Layout
25234 http://ximbiot.com/cvs
25242 \begin_layout Standard
25247 to understand the sub-commands and the switches mentioned below.
25250 \begin_layout Subsubsection
25256 \begin_layout Standard
25257 If your document is not under revision control, this is the only item shown
25259 And if it is under revision control, the
25263 item is not visible.
25267 \begin_layout Standard
25268 This command registers in CVS your document
25269 \begin_inset Flex Strong
25272 \begin_layout Plain Layout
25280 in the case you have already the documents directory under CVS control
25286 This means you have to create or checkout the archive by yourself using
25288 (In case you forget that step \SpecialChar LyX
25289 registers the document with RCS.)
25292 \begin_layout Standard
25293 Then you are asked interactively to supply an initial description of the
25295 Don't forget that registered file is not yet checked in.
25298 \begin_layout Standard
25299 CVS command that is run:
25301 cvs -q add -m"<entered message>" "<file-name>"
25304 \begin_layout Standard
25309 above and for all other CVS commands is an abbreviation for
25310 \begin_inset Quotes eld
25313 change the current working directory to file location and use the file name
25314 without path component as argument
25315 \begin_inset Quotes erd
25321 \begin_layout Subsubsection
25327 \begin_layout Standard
25328 When you are finished editing a file, you commit your changes.
25329 When you do this and you had changed the document, you are asked for a
25330 description of the changes.
25331 After that changes are written to the repository.
25332 In case you didn't change the document and a reserved checkout is detected
25333 the reservation made on
25334 \begin_inset Flex Noun
25337 \begin_layout Plain Layout
25346 \begin_layout Labeling
25347 \labelwidthstring 00.00.0000
25349 \begin_inset space ~
25353 \begin_inset space ~
25357 \begin_inset Newline newline
25361 \begin_inset Flex Code
25364 \begin_layout Plain Layout
25367 -q commit -m"<description>" "<file-name>"
25373 \begin_inset Newline newline
25377 \begin_inset Flex Code
25380 \begin_layout Plain Layout
25391 \begin_layout Subsubsection
25397 \begin_layout Standard
25398 When you are sharing a repository with others, you may have to incorporate
25399 their changes into your working copy.
25402 \begin_layout Standard
25405 cvs -q update "<file-name>"
25408 \begin_layout Standard
25409 If a readonly checkout is detected the working copy is made writable and
25413 \begin_layout Standard
25416 cvs -q edit "<file-name>"
25419 \begin_layout Subsubsection
25422 Revert To Repository Version
25425 \begin_layout Standard
25426 This will discard all changes made to the document since the last check
25428 You get a warning before changes are discarded.
25429 Firstly the file is deleted, secondly CVS update command is run.
25432 \begin_layout Standard
25435 cvs -q update "<file-name>"
25438 \begin_layout Standard
25439 If a reserved checkout is detected and the working copy has no changes only
25440 the reservation is undone.
25443 \begin_layout Standard
25446 cvs -q unedit "<file-name>"
25449 \begin_layout Subsubsection
25455 \begin_layout Standard
25456 This will create a copy of the current document.
25457 Since CVS does not support copy operations natively, the version history
25458 is not preserved, and the copy is added as a new file.
25459 It requires a clean document without any changes since the last checkin.
25460 You are asked for a file name and a description of the copy operation.
25461 After that the copy is created, both locally and in the repository.
25462 If the parent directories of the copied and original document differ, all
25463 relative paths of included files of the copy are adjusted (like in
25465 File\SpecialChar menuseparator
25470 Finally, the copy is loaded instead of the original document.
25473 \begin_layout Labeling
25474 \labelwidthstring 00.00.0000
25476 \begin_inset space ~
25480 \begin_inset space ~
25484 \begin_inset Newline newline
25488 \begin_inset Flex Code
25491 \begin_layout Plain Layout
25498 \begin_inset Flex Code
25501 \begin_layout Plain Layout
25508 \begin_inset Newline newline
25512 \begin_inset Flex Code
25515 \begin_layout Plain Layout
25516 cvs -q add "<new-file-name>"
25524 \begin_layout Subsubsection
25530 \begin_layout Standard
25531 This will rename the current document.
25532 Since CVS does not support rename operations natively, the version history
25533 is not preserved, the renamed document is added as a new file, and the
25534 original document is deleted.
25535 It requires a clean document without any changes since the last checkin.
25536 You are asked for a file name and a description of the rename operation.
25537 After that the document is renamed, both locally and in the repository.
25538 If the parent directories of the new and old file names differ, all relative
25539 paths of included files are adjusted (like in
25541 File\SpecialChar menuseparator
25546 Finally, the document is reloaded using the new name.
25549 \begin_layout Labeling
25550 \labelwidthstring 00.00.0000
25552 \begin_inset space ~
25556 \begin_inset space ~
25560 \begin_inset Newline newline
25564 \begin_inset Flex Code
25567 \begin_layout Plain Layout
25574 \begin_inset Flex Code
25577 \begin_layout Plain Layout
25584 \begin_inset Newline newline
25588 \begin_inset Flex Code
25591 \begin_layout Plain Layout
25592 cvs -q add "<new-file-name>"
25598 \begin_inset Newline newline
25602 \begin_inset Flex Code
25605 \begin_layout Plain Layout
25606 cvs -q remove "<file-name>"
25614 \begin_layout Subsubsection
25615 Update of the local directory checkout from repository
25618 \begin_layout Standard
25619 Once your documents gets more complex, containing sub-documents and pictures,
25621 \begin_inset Flex Code
25624 \begin_layout Plain Layout
25630 files and so on using version control becomes more complicated.
25632 supports updating the whole tree in which resides the document.
25633 This become especially useful once you cooperate with people which neither
25634 have detailed knowledge about CVS usage nor they have ambition to commit
25635 additional material to the repository.
25636 You have to organize the files structure so that all external files are
25637 in the same directory or subdirectories of the document.
25638 It's good practice anyway to store multipart documents in an extra directory.
25641 \begin_layout Standard
25643 \begin_inset Flex Code
25646 \begin_layout Plain Layout
25647 Update local directory from repository
25652 command updates the whole directory.
25653 If local changes are detected user is warned before update starts.
25654 In case of merge conflicts both versions of the conflicting document parts
25655 are placed in the final document.
25656 You have to review and correct the result of the merge.
25657 You'll find the conflicts enclosed in pairs of
25658 \begin_inset Flex Code
25661 \begin_layout Plain Layout
25668 \begin_inset Flex Code
25671 \begin_layout Plain Layout
25678 \begin_inset Flex Code
25681 \begin_layout Plain Layout
25688 The first part is your version as before the update operation with the
25689 document name prepended.
25690 The second one is the repository version with the version number after
25692 \begin_inset Flex Code
25695 \begin_layout Plain Layout
25704 \begin_layout Labeling
25705 \labelwidthstring 00.00.0000
25707 \begin_inset space ~
25711 \begin_inset space ~
25715 \begin_inset Newline newline
25719 \begin_inset Flex Code
25722 \begin_layout Plain Layout
25730 (Ask if changes are detected.)
25731 \begin_inset Newline newline
25735 \begin_inset Flex Code
25738 \begin_layout Plain Layout
25739 cd $path; cvs -q update
25749 \begin_layout Standard
25751 \begin_inset Flex Code
25754 \begin_layout Plain Layout
25760 stands for the path to the document.
25763 \begin_layout Subsubsection
25769 \begin_layout Standard
25770 This shows the complete history of the CVS document.
25773 cvs log "<file-name>"
25775 is shown in a browser.
25778 \begin_layout Subsubsection
25782 \begin_layout Standard
25784 supports CVS version number, author name, date and time of last commit.
25785 All those are extracted from
25787 cvs log -r <file-name>
25791 \begin_inset CommandInset ref
25793 reference "subsec:VCS-Revision-Information"
25800 \begin_layout Subsection
25801 SVN commands in \SpecialChar LyX
25805 \begin_layout Standard
25806 SVN is now partially supported by \SpecialChar LyX
25808 You can find the commands in the
25810 File\SpecialChar menuseparator
25812 \begin_inset space ~
25818 Please note that if you use password protected access to repository via
25819 ssh, you will be asked in terminal window.
25821 was tested against SVN 1.5, 1.6, 1.7 and 1.8
25825 \begin_layout Plain Layout
25826 Most of the commands will work with 1.4 too, see
25827 \begin_inset CommandInset ref
25829 reference "subsec:SVN-Repo-Update"
25834 There seems to be currently unresolved permissions problem under SVN 1.8
25835 with reverting changes when file is locked.
25843 \begin_layout Subsubsection
25849 \begin_layout Standard
25850 If your document is not under revision control, this is the only item shown
25852 And if it is under revision control, the
25856 item is not visible.
25859 \begin_layout Standard
25860 This command registers in SVN your document ONLY in case you have already
25861 the documents directory under SVN control (in particular
25866 This means you have to checkout the archive by yourself.
25869 \begin_layout Standard
25870 Then you are asked interactively to supply an initial description of the
25872 Don't forget that registered file is not yet commited.
25875 \begin_layout Standard
25876 SVN command that is run:
25879 \begin_inset Quotes qld
25883 \begin_inset Quotes qld
25889 \begin_layout Standard
25894 to understand the switches.
25897 \begin_layout Subsubsection
25903 \begin_layout Standard
25904 When you are finished editing a file, you commit your changes.
25905 When you do this, you are asked for a description of the changes.
25906 After that changes are commited.
25909 \begin_layout Standard
25914 \begin_layout Plain Layout
25915 In case locking is not enabled.
25917 \begin_inset CommandInset ref
25919 reference "subsec:SVN-File-Locking"
25930 svn commit -q -m"<description>" <file-name>
25933 \begin_layout Subsubsection
25939 \begin_layout Standard
25940 Updates the changes of this file from the repository.
25941 Be sure you understand SVN merging and conflicts resolving before using
25942 this function, because all conflicts has to be resolved manually by you!
25945 \begin_layout Standard
25950 \begin_layout Plain Layout
25958 svn update --non-interactive
25959 \begin_inset Quotes qld
25963 \begin_inset Quotes qld
25969 \begin_layout Subsubsection
25972 Revert To Repository Version
25975 \begin_layout Standard
25976 This will discard all changes made to the document since the last check
25978 You get a warning before changes are discarded.
25981 \begin_layout Standard
25985 \begin_inset Quotes qld
25989 \begin_inset Quotes qld
25995 \begin_layout Subsubsection
26001 \begin_layout Standard
26002 This will create a copy of the current document including the version history.
26003 It requires a clean document without any changes since the last checkin.
26004 You are asked for a file name and a description of the copy operation.
26005 After that the copy is created, both locally and in the repository.
26006 If the parent directories of the copied and original document differ, all
26007 relative paths of included files of the copy are adjusted (like in
26009 File\SpecialChar menuseparator
26014 Finally, the copy is loaded instead of the original document.
26017 \begin_layout Labeling
26018 \labelwidthstring 00.00.0000
26020 \begin_inset space ~
26024 \begin_inset space ~
26028 \begin_inset Newline newline
26032 \begin_inset Flex Code
26035 \begin_layout Plain Layout
26039 \begin_inset Quotes qld
26043 \begin_inset Quotes qld
26047 \begin_inset Quotes qld
26051 \begin_inset Quotes qld
26060 \begin_inset Newline newline
26064 \begin_inset Flex Code
26067 \begin_layout Plain Layout
26076 \begin_layout Subsubsection
26082 \begin_layout Standard
26083 This will rename the current document including the version history.
26084 It requires a clean document without any changes since the last checkin.
26085 You are asked for a file name and a description of the rename operation.
26086 After that the document is renamed, both locally and in the repository.
26087 If the parent directories of the new and old file names differ, all relative
26088 paths of included files are adjusted (like in
26090 File\SpecialChar menuseparator
26095 Finally, the document is reloaded using the new name.
26098 \begin_layout Labeling
26099 \labelwidthstring 00.00.0000
26101 \begin_inset space ~
26105 \begin_inset space ~
26109 \begin_inset Newline newline
26113 \begin_inset Flex Code
26116 \begin_layout Plain Layout
26120 \begin_inset Quotes qld
26124 \begin_inset Quotes qld
26128 \begin_inset Quotes qld
26132 \begin_inset Quotes qld
26141 \begin_inset Newline newline
26145 \begin_inset Flex Code
26148 \begin_layout Plain Layout
26157 \begin_layout Subsubsection
26158 \begin_inset CommandInset label
26160 name "subsec:SVN-Repo-Update"
26164 Update of the local directory checkout from repository
26168 \begin_layout Plain Layout
26169 Note that this command will work only with subversion
26170 \begin_inset Formula $\geqq1.5$
26181 \begin_layout Standard
26182 All the commands above have one shortcoming – they deal with the current
26184 Once your document contains pictures, includes external
26185 \begin_inset Flex Code
26188 \begin_layout Plain Layout
26194 files and so on administration becomes more complicated.
26196 now supports updating the whole tree in which resides the document
26200 \begin_layout Plain Layout
26201 One need to organize the files structure so that all external files are
26202 in the same directory or subdirectories of the document.
26209 This become especially useful once you cooperate with people which neither
26210 know about subversion management nor they have ambition to commit additional
26211 material to the repository.
26215 \begin_layout Standard
26216 \begin_inset Flex Code
26219 \begin_layout Plain Layout
26220 Update local directory from repository
26225 command updates the whole directory and in case of merge conflicts local
26226 version of the files are left, so no unintended data loss occurs.
26227 If local changes are detected user is warned before update starts.
26230 \begin_layout Labeling
26231 \labelwidthstring 00.00.0000
26233 \begin_inset space ~
26237 \begin_inset space ~
26241 \begin_inset Newline newline
26245 \begin_inset Flex Code
26248 \begin_layout Plain Layout
26254 (Ask if changes are detected.)
26255 \begin_inset Newline newline
26259 \begin_inset Flex Code
26262 \begin_layout Plain Layout
26263 svn update --accept mine-full $path
26271 \begin_layout Standard
26273 \begin_inset Flex Code
26276 \begin_layout Plain Layout
26282 stands for the path to the document.
26285 \begin_layout Subsubsection
26291 \begin_layout Standard
26292 This shows the complete history of the SVN document.
26296 \begin_inset Quotes qld
26300 \begin_inset Quotes qld
26305 is shown in a browser.
26308 \begin_layout Subsubsection
26310 \begin_inset CommandInset label
26312 name "subsec:SVN-File-Locking"
26319 \begin_layout Standard
26320 The file exchange through various revision control systems brings the problem
26321 of merge conflicts in case two different users try to edit the same (parts
26323 When such a conflict happens it needs manual resolving and one reasonable
26324 alternative is to provide some kind of locking mechanism, which guarantees
26325 that only one user is allowed to edit file at the given time.
26328 \begin_layout Standard
26329 SVN has two such mechanisms to provide mutual exclusivity for file access
26330 – locks and automatic setting of write permissions (see sec.
26332 \begin_inset CommandInset ref
26334 reference "subsec:Automatical-Locking-Property"
26339 \begin_inset Flex Code
26342 \begin_layout Plain Layout
26352 \begin_layout Plain Layout
26353 \begin_inset Flex URL
26356 \begin_layout Plain Layout
26358 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
26369 If this property is detected for a given document \SpecialChar LyX
26370 starts to use SVN locks
26371 for document editing automatically and the whole check-in/out mechanism
26372 switches to the same regimen as for RCS.
26373 This in particular means there are two different modes of file use in \SpecialChar LyX
26377 \begin_layout Itemize
26379 The loaded file is in the read-only mode.
26380 For editing on needs to check-out.
26385 consists of updating from the repository and gaining write lock.
26386 If the lock is not possible to obtain, we remain in unlocked state.
26389 \begin_layout Itemize
26391 The loaded file is in the
26392 \begin_inset Quotes els
26396 \begin_inset Quotes ers
26400 No other user is allowed to edit the file.
26405 consists of commiting changes and releasing write-lock.
26406 If no changes have been made to the document, no commit will be produced
26410 \begin_layout Plain Layout
26411 Don't be puzzled by the fact that you will be asked for commit message anyway.
26416 and only the write-lock will be released.
26419 \begin_layout Standard
26423 \begin_layout Labeling
26424 \labelwidthstring 00.00.0000
26427 svn commit -q -m"<description>" "<file-name>"
26428 \begin_inset Newline newline
26431 svn unlock "<file-name>"
26434 \begin_layout Labeling
26435 \labelwidthstring 00.00.0000
26438 svn update "<file-name>"
26439 \begin_inset Newline newline
26442 svn lock "<file-name>"
26445 \begin_layout Subsubsection
26448 \begin_inset CommandInset label
26450 name "subsec:Automatical-Locking-Property"
26456 Automatic Locking Property
26459 \begin_layout Standard
26460 The above mentioned automatic setting of write permissions of the .lyx file
26463 File\SpecialChar menuseparator
26465 \begin_inset space ~
26468 Control\SpecialChar menuseparator
26469 Use Locking Property
26472 This command is active only when the file is not locked on the svn server
26474 you need to check-out before proceeding).
26477 \begin_layout Labeling
26478 \labelwidthstring 00.00.0000
26480 \begin_inset space ~
26486 \begin_layout Labeling
26487 \labelwidthstring 00.00.0000
26490 svn propset svn:needs-lock ON "<file-name>"
26493 \begin_layout Labeling
26494 \labelwidthstring 00.00.0000
26497 svn propdel svn:needs-lock "<file-name>"
26500 \begin_layout Subsubsection
26501 \begin_inset CommandInset label
26503 name "subsec:VCS-Revision-Information"
26507 Revision Information in Documents
26510 \begin_layout Standard
26511 There are more possibilities how to activate revision information in our
26515 \begin_layout Itemize
26521 \begin_layout Itemize
26522 tree revision information (
26523 \begin_inset Flex Code
26526 \begin_layout Plain Layout
26533 The result is the output of the
26534 \begin_inset Flex Code
26537 \begin_layout Plain Layout
26543 command, the following table gives you an idea, how to read the results.
26546 \begin_layout Standard
26548 \begin_inset Tabular
26549 <lyxtabular version="3" rows="6" columns="2">
26550 <features tabularvalignment="middle">
26551 <column alignment="left" valignment="top">
26552 <column alignment="left" valignment="top">
26554 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26557 \begin_layout Plain Layout
26565 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26568 \begin_layout Plain Layout
26578 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26581 \begin_layout Plain Layout
26587 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26590 \begin_layout Plain Layout
26591 mixed revision working copy
26598 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26601 \begin_layout Plain Layout
26607 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26610 \begin_layout Plain Layout
26611 modified working copy
26618 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26621 \begin_layout Plain Layout
26627 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26630 \begin_layout Plain Layout
26631 switched working copy
26638 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
26641 \begin_layout Plain Layout
26647 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
26650 \begin_layout Plain Layout
26651 partial working copy, from a sparse checkout
26658 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26661 \begin_layout Plain Layout
26667 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26670 \begin_layout Plain Layout
26671 mixed revision, modified, switched working copy
26684 \begin_layout Itemize
26685 file revision information.
26686 The result comes from parsing the output of
26687 \begin_inset Flex Code
26690 \begin_layout Plain Layout
26692 \begin_inset space ~
26696 \begin_inset space ~
26700 \begin_inset space ~
26709 Supported flags are:
26713 \begin_layout Itemize
26714 version number of the last commit (
26715 \begin_inset Flex Code
26718 \begin_layout Plain Layout
26727 \begin_layout Itemize
26728 author of the last commit (
26729 \begin_inset Flex Code
26732 \begin_layout Plain Layout
26741 \begin_layout Itemize
26742 date of the last commit (
26743 \begin_inset Flex Code
26746 \begin_layout Plain Layout
26755 \begin_layout Itemize
26756 time of the last commit (
26757 \begin_inset Flex Code
26760 \begin_layout Plain Layout
26770 \begin_layout Standard
26771 You can obtain this info via InsetInfo (
26772 \change_inserted 5863208 1564400022
26775 Insert\SpecialChar menuseparator
26776 Field\SpecialChar menuseparator
26777 Version Control Revision
26778 \change_deleted 5863208 1564399852
26783 \begin_inset Flex Code
26786 \begin_layout Plain Layout
26787 info-insert buffer vcs-date
26795 The information will be available only when you have the file stored under
26796 svn managment (i.e.
26798 \begin_inset Flex Code
26801 \begin_layout Plain Layout
26807 directory is available with your document).
26811 \begin_layout Itemize
26812 Another—a hacking one—possibility is to use svn keywords
26816 \begin_layout Plain Layout
26817 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
26823 In short – you set file keywords property (e.g.
26826 svn propset svn:keywords 'Rev' file.lyx
26828 ) and then paste keyword \SpecialChar TeX
26833 \begin_layout Plain Layout
26834 This is an easy way how to ensure that \SpecialChar LyX
26835 won't break the line in the middle
26841 tag in your document (e.g.
26843 \begin_inset Flex Code
26846 \begin_layout Plain Layout
26853 This way svn client will automatically substitute revision number (e.g.
26855 \begin_inset Flex Code
26858 \begin_layout Plain Layout
26864 ) after each update and commit.
26865 There are more problems with this approach.
26866 Firstly, the '$' character is used in \SpecialChar TeX
26867 world for math equations, so any
26868 occurence of math formula
26869 \begin_inset Formula $Rev$
26873 \begin_inset Formula $Rev:59$
26876 in your \SpecialChar LyX
26878 Similarly for other keywords like Id, Date, Author, etc.
26879 Secondly svn output is dependent on your locales, so its very easy that
26880 svn would produce some problematic strings once Date is used.
26881 Thirdly you get the whole 'Rev: 59' string in your document instead of
26883 Until subversion implements user's custom keywords it will be hard to use
26884 this approach reliably or let \SpecialChar LyX
26885 to support it directly.
26888 \begin_layout Subsection
26889 SVN and Windows Environment
26892 \begin_layout Quote
26893 My inclination is to say that if the user cannot figure out the command
26894 line operations on their own fairly quickly, they would be well advised
26895 to use TortoiseSVN.
26901 \begin_layout Subsubsection
26905 \begin_layout Standard
26906 In addition to installing \SpecialChar LyX
26907 , and having access to a Subversion repository,
26908 the user will need to install the Subversion client program.
26909 A Windows installer for the client program is available from
26910 \begin_inset CommandInset href
26913 target "http://www.collab.net/nonav/downloads/subversion/"
26919 The user may also want to install
26920 \begin_inset CommandInset href
26923 target "http://tortoisesvn.tigris.org/"
26928 , which integrates Subversion operations into the context (rightclick) menu
26929 of Windows Explorer.
26930 Operations done outside \SpecialChar LyX
26931 will typically be more convenient using the Explorer
26933 Note that TortoiseSVN is not a replacement for the client program, which
26934 is what \SpecialChar LyX
26938 \begin_layout Subsubsection
26939 Bringing a document under Subversion control
26942 \begin_layout Standard
26943 Before a \SpecialChar LyX
26944 document can be brought under version control in Subversion, its
26945 parent directory needs to be under version control.
26946 If the document is being added to a project already in the repository,
26947 this is accomplished by checking the project out to the directory where
26948 the new document will be placed.
26949 If the project itself is not yet under version control (for instance, if
26950 this document starts a new project), the directory must be imported into
26952 This is done outside \SpecialChar LyX
26954 Both import and checkout are easily accomplished from the Explorer context
26955 menu using TortoiseSVN, or alternatively can be done using the command
26956 line client at a DOS prompt.
26957 The procedure for importing the project using TortoiseSVN is described
26958 below, assuming an existing repository and a new project being started
26966 For information on using the Subversion client program, run
26973 \begin_layout Enumerate
26980 in Windows Explorer, right click it, and select
26982 TortoiseSVN\SpecialChar menuseparator
26986 If necessary, adjust the URL for the repository, then click OK.
26989 \begin_layout Enumerate
26990 Right click the level of the repository under which you want to place the
26991 new project folder (typically the top level) and click
26995 Supply a name for the project folder and click OK.
26996 Add a message for the log file if desired, then click OK again.
26997 The new project folder should appear in the repository.
26998 Finally, click OK again to exit the repository browser.
27001 \begin_layout Enumerate
27002 Once again right click
27008 , this time selecting SVN Checkout\SpecialChar ldots
27009 Select the URL of the project folder
27010 you just created in the repository, and set the checkout directory to
27018 You will be warned about a non-empty folder; click OK to proceed.
27019 You should now have a
27030 \begin_layout Enumerate
27031 Create or open your document in \SpecialChar LyX
27034 File\SpecialChar menuseparator
27036 \begin_inset space ~
27039 Control\SpecialChar menuseparator
27043 Add a log message and click OK to commit the document to version control.
27046 \begin_layout Standard
27047 From this point onward, you should have full functionality in the
27049 File\SpecialChar menuseparator
27051 \begin_inset space ~
27057 You also have the option of checking the document in and out, viewing its
27059 using the TortoiseSVN context menu in Windows Explorer or the Subversion
27060 client program from a command prompt.
27063 \begin_layout Subsubsection
27064 SSH tunnel used with SVN under Windows
27067 \begin_layout Standard
27068 Compared with Linux setting up an svn client to communicate over ssh under
27069 Windows is a rather troublesome task.
27070 We will at least offer some hints how to setup the client side but prior
27071 knowledge about ssh and the Windows command line is needed, also be prepared
27072 for a great deal of frustration\SpecialChar ldots
27076 \begin_layout Enumerate
27077 Get an svn client for windows, as described in the previous sections.
27078 When it is a fresh install run some svn command (e.g.
27080 \begin_inset Flex Code
27083 \begin_layout Plain Layout
27089 ) to create config files, which you will need to change later on.
27092 \begin_layout Enumerate
27093 Choose an ssh client for Windows.
27094 There are several possibilities, we will use the one from Putty tools
27098 \begin_layout Plain Layout
27099 \begin_inset Flex URL
27102 \begin_layout Plain Layout
27104 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
27115 You will need to set the connection up so that the client doesn't ask for
27116 any password from you.
27117 To keep things easy we will use only keys without any additional password
27122 \begin_layout Enumerate
27124 \begin_inset Flex Code
27127 \begin_layout Plain Layout
27134 Save your private .ppk key file and put the public one on the server side.
27135 If the SVN server runs on Linux, note that the format of the public key
27136 is not compatible with Linux openssh and you will need to direcly copy-paste
27138 \begin_inset Quotes eld
27143 Public key for pasting into OpenSSH authorized_keys file
27146 \begin_inset Quotes erd
27149 edit field into the server's
27150 \begin_inset Flex Code
27153 \begin_layout Plain Layout
27154 ~/.ssh/authorized_keys
27160 \begin_inset Flex Code
27163 \begin_layout Plain Layout
27172 \begin_layout Enumerate
27174 \begin_inset Flex Code
27177 \begin_layout Plain Layout
27184 In the SVN config file
27188 \begin_layout Plain Layout
27189 Exact path depends on Windows version, usually somewhere around
27190 \begin_inset Flex Code
27193 \begin_layout Plain Layout
27196 Documents and Settings
27210 \begin_inset Flex Code
27213 \begin_layout Plain Layout
27228 , section [tunnels], setup ssh command, e.g.
27230 \begin_inset Flex Code
27233 \begin_layout Plain Layout
27234 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
27243 \begin_layout Plain Layout
27244 It will usually take a lot of time to get exact command right and it depends
27246 For example do not have some remote server saved as a default session in
27248 If things fail, try to connect via plink without SVN first.
27257 \begin_layout Enumerate
27258 Checkout the SVN archive, e.
27259 \begin_inset space \thinspace{}
27263 \begin_inset Newline newline
27267 \begin_inset Flex Code
27270 \begin_layout Plain Layout
27271 svn co svn+ssh://user@server/repository_path
27279 \begin_layout Subsubsection
27280 End-of-Line Conversions
27283 \begin_layout Standard
27284 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
27286 use different line endings inside the .lyx files.
27287 This is not a problem as far as \SpecialChar LyX
27288 functionality is concerned, but the commit
27289 diffs will be huge and merge-conflicts prone.
27290 Fortunately SVN itself knows
27294 \begin_layout Plain Layout
27295 \begin_inset Flex URL
27298 \begin_layout Plain Layout
27300 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
27310 how to deal with CR/LF problems when switching .lyx files to the
27311 \begin_inset Flex Code
27314 \begin_layout Plain Layout
27324 \begin_layout Plain Layout
27326 \begin_inset Flex Code
27329 \begin_layout Plain Layout
27330 svn propset svn:eol-style native FILE_NAME
27343 \begin_layout Subsection
27344 GIT commands in \SpecialChar LyX
27348 \begin_layout Standard
27349 A minimal subset of GIT commands is now supported by \SpecialChar LyX
27351 You can find the commands in the
27353 File\SpecialChar menuseparator
27355 \begin_inset space ~
27361 Please note that if you use password protected access to repository via
27362 ssh, you will be asked in terminal window.
27364 was tested against GIT 1.7.
27368 \begin_layout Plain Layout
27369 Windows users please note that you need to ensure that git is on the path.
27370 This can be set from within \SpecialChar LyX
27373 Tools\SpecialChar menuseparator
27374 Preferences\SpecialChar menuseparator
27375 Paths\SpecialChar menuseparator
27386 \begin_layout Standard
27387 One big difference of GIT and the other supported version control systems
27388 is the distributed nature of GIT: With traditional version control systems
27389 there is one central server which hosts the repository.
27390 Users commit their changes to the server, and get updates made by other
27392 With GIT, users commit to a local repository.
27393 The local repository can be synchronized with one or more remote repositories
27395 \begin_inset Flex Code
27398 \begin_layout Plain Layout
27405 \begin_inset Flex Code
27408 \begin_layout Plain Layout
27416 does not interact in any way with remote GIT repositories.
27417 It works exclusively with the local repository in a very similar way as
27418 with a central CVS or SVN repository.
27419 If you use remote GIT repositories you need to do the
27420 \begin_inset Flex Code
27423 \begin_layout Plain Layout
27430 \begin_inset Flex Code
27433 \begin_layout Plain Layout
27439 operations with your favourite GIT client.
27442 \begin_layout Subsubsection
27448 \begin_layout Standard
27449 If your document is not under revision control, this is the only item shown
27451 And if it is under revision control, the
27455 item is not visible.
27458 \begin_layout Standard
27459 This command registers in GIT your document ONLY in case you have already
27460 the documents directory under GIT control (in particular
27465 This means you have to checkout the archive by yourself.
27468 \begin_layout Standard
27469 Then you are asked interactively to supply an initial description of the
27471 Don't forget that registered file is not yet committed.
27474 \begin_layout Standard
27475 GIT command that is run:
27478 \begin_inset Quotes qld
27482 \begin_inset Quotes qld
27488 \begin_layout Standard
27493 to understand the switches.
27496 \begin_layout Subsubsection
27502 \begin_layout Standard
27503 When you are finished editing a file, you commit your changes.
27504 When you do this, you are asked for a description of the changes.
27505 After that changes are committed.
27508 \begin_layout Standard
27511 git commit -q -m"<description>" <file-name>
27514 \begin_layout Subsubsection
27517 Revert To Repository Version
27520 \begin_layout Standard
27521 This will discard all changes made to the document since the last check
27523 You get a warning before changes are discarded.
27526 \begin_layout Standard
27530 \begin_inset Quotes qld
27534 \begin_inset Quotes qld
27540 \begin_layout Subsubsection
27546 \begin_layout Standard
27547 This will rename the current document including the version history.
27548 It requires a clean document without any changes since the last checkin.
27549 You are asked for a file name and a description of the rename operation.
27550 After that the document is renamed, both locally and in the repository.
27551 If the parent directories of the new and old file names differ, all relative
27552 paths of included files are adjusted (like in
27554 File\SpecialChar menuseparator
27559 Finally, the document is reloaded using the new name.
27562 \begin_layout Labeling
27563 \labelwidthstring 00.00.0000
27565 \begin_inset space ~
27569 \begin_inset space ~
27573 \begin_inset Newline newline
27577 \begin_inset Flex Code
27580 \begin_layout Plain Layout
27584 \begin_inset Quotes qld
27588 \begin_inset Quotes qld
27592 \begin_inset Quotes qld
27596 \begin_inset Quotes qld
27605 \begin_inset Newline newline
27609 \begin_inset Flex Code
27612 \begin_layout Plain Layout
27621 \begin_layout Subsubsection
27627 \begin_layout Standard
27628 This shows the complete history of the GIT document.
27632 \begin_inset Quotes qld
27636 \begin_inset Quotes qld
27641 is shown in a browser.
27644 \begin_layout Subsubsection
27648 \begin_layout Standard
27650 supports GIT hash number of the last commit to the file,
27651 \change_inserted 1119979965 1564297456
27652 its abbreviated form,
27654 author name, date and time of last commit.
27655 All those are extracted from
27657 git log -n 1 --pretty=format:%H%n
27658 \change_inserted 1119979965 1564297427
27664 Tree version information is obtained via
27666 git describe --abbrev --dirty --long
27670 \begin_inset CommandInset ref
27672 reference "subsec:VCS-Revision-Information"
27679 \begin_layout Subsection
27683 \begin_layout Standard
27684 With the recent addition of the
27685 \begin_inset Flex Code
27688 \begin_layout Plain Layout
27694 function \SpecialChar LyX
27695 power users are allowed to create their own commands for revision
27699 \begin_layout Standard
27700 As an example you can see how two TortoiseSVN commands could be integrated
27704 \begin_layout Description
27706 \begin_inset Flex Code
27709 \begin_layout Plain Layout
27710 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
27718 \begin_layout Description
27720 \begin_inset Flex Code
27723 \begin_layout Plain Layout
27724 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
27732 \begin_layout Subsection
27733 Version control and Document comparison
27736 \begin_layout Standard
27737 One of the typical uses of version control is to inspect the changes between
27738 revisions, usually by creating
27739 \begin_inset Flex Code
27742 \begin_layout Plain Layout
27749 While this is useful for plain text files, it is much less useful in the
27750 case of \SpecialChar LyX
27751 files, which have more a complicated structure.
27752 Hence we provide binding to the Document comparison feature.
27753 There are two ways of calling this feature – either by direct call of
27754 \begin_inset Flex Code
27757 \begin_layout Plain Layout
27764 function (for details see \SpecialChar LyX
27765 functions manual) or by the toolbar icon
27778 One can either compare two chosen revisions of the document or he can simply
27779 compare the current version of edited text with older revisions (where
27781 \begin_inset Flex Noun
27784 \begin_layout Plain Layout
27790 ' revisions back means comparison of the edited file with last commited
27795 \begin_layout Standard
27796 This feature is supported for SVN and RCS though due to the more complicated
27797 versioning scheme of RCS there is a constraint – when addressing the revisions
27798 in dialog, numbers always point to the last number in RCS revision number,
27801 We don't currently support GIT addressing of revisions, one can just compare
27802 edited document with its revision X steps backs, where X is addressed as
27804 \begin_inset Flex Code
27807 \begin_layout Plain Layout
27816 \begin_layout Section
27817 Literate Programming
27820 \begin_layout Standard
27825 (kayvan@sylvan.com)
27829 original documentation written by
27831 Edmar Wienskoski Jr.
27834 (edmar-w-jr@technologist.com)
27837 \begin_layout Subsection
27841 \begin_layout Standard
27842 The main purpose of this documentation is to show you how to use \SpecialChar LyX
27844 programming, where it is assumed that you are familiar with this programming
27845 technique, and know what
27846 \begin_inset Quotes eld
27850 \begin_inset Quotes erd
27854 \begin_inset Quotes eld
27858 \begin_inset Quotes erd
27862 If that is not the case, please follow the web links provided in the following
27864 There is a lot of good documentation out there covering old development
27865 history to the latest tools tips.
27868 \begin_layout Standard
27869 It is also assumed that you are familiar with \SpecialChar LyX
27870 itself to a point that you
27871 are comfortable changing your \SpecialChar LyX
27872 preferences, and X resources file.
27873 If that is not the case please refer to other \SpecialChar LyX
27874 documentation to cover your
27878 \begin_layout Subsection
27879 Literate Programming
27882 \begin_layout Standard
27883 From the Literate Programming FAQ:
27886 \begin_layout Quotation
27887 Literate programming is the combination of documentation and source together
27888 in a fashion suited for reading by human beings.
27889 In fact, literate programs should be enjoyable reading, even inviting!
27890 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
27891 and documentation in a single file.
27892 Literate programming tools then parse the file to produce either readable
27893 documentation or compilable source.
27894 The WEB style of literate programming was created by D.
27895 \begin_inset space \thinspace{}
27899 Knuth during the development of his \SpecialChar TeX
27900 typesetting software.
27904 \begin_layout Standard
27905 Another excerpt says:
27908 \begin_layout Quotation
27911 How is literate programming different from verbose commenting?
27914 \begin_layout Quotation
27915 There are three distinguishing characteristics.
27916 In order of importance, they are:
27920 \begin_layout Itemize
27921 flexible order of elaboration
27924 \begin_layout Itemize
27925 automatic support for browsing
27928 \begin_layout Itemize
27929 typeset documentation, especially diagrams and mathematics
27933 \begin_layout Standard
27934 Now that I sparked your curiosity, take a look in the references.
27937 \begin_layout Subsubsection
27941 \begin_layout Standard
27942 The complete Literate Programming FAQ can be found at:
27945 \begin_layout Quote
27946 Literate Programming FAQ
27947 \begin_inset Flex URL
27950 \begin_layout Plain Layout
27952 http://www.literateprogramming.com/lpfaq.pdf
27960 \begin_layout Standard
27961 The FAQ lists 23 (twenty three!) different literate programming tools.
27962 Where some are specialized or
27963 \begin_inset Quotes eld
27967 \begin_inset Quotes erd
27970 for particular programming languages, while other have general scope.
27975 for my own use for several reasons:
27978 \begin_layout Itemize
27979 It can generate the documentation either in \SpecialChar LaTeX
27983 \begin_layout Itemize
27984 It has a open architecture, i.
27985 \begin_inset space \thinspace{}
27989 \begin_inset space \space{}
27992 it is easy to plug in new filters
27996 \begin_layout Plain Layout
28001 are programs that read a given data stream and output a manipulated data
28003 That way, a WEB file (consisting of literate code) can be turned into a
28004 file consisting only of C program code or \SpecialChar LaTeX
28010 and to perform special processing that you may need.
28014 \begin_layout Itemize
28015 There is a good selection of filters available already (the HTML is one
28019 \begin_layout Itemize
28023 \begin_layout Standard
28024 The Noweb web page can be found at:
28027 \begin_layout Quote
28029 \begin_inset Flex URL
28032 \begin_layout Plain Layout
28034 https://www.cs.tufts.edu/~nr/noweb/
28042 \begin_layout Standard
28043 Starting from there you can reach many other interesting links and even
28044 some literate program examples.
28047 \begin_layout Subsection
28049 and Literate Programming with Noweb
28052 \begin_layout Standard
28053 The \SpecialChar LyX
28054 support for Literate Programming is provided by using the generic \SpecialChar LyX
28056 converters mechanism.
28057 This support is provided in a
28058 \begin_inset Quotes eld
28062 \begin_inset Quotes erd
28066 \begin_inset space \thinspace{}
28070 \begin_inset space \space{}
28073 you will be able to use this new \SpecialChar LyX
28074 feature with some other literate programming
28075 tool of your choice by just changing your \SpecialChar LyX
28079 \begin_layout Subsubsection
28080 Generating documents and code (weaving and tangling)
28083 \begin_layout Paragraph
28084 Using the noweb module
28087 \begin_layout Standard
28088 If you have installed Noweb and \SpecialChar LyX
28089 successfully, whenever you open a new document,
28090 after you have chosen its document class, use the
28092 Document\SpecialChar menuseparator
28096 \begin_inset Quotes eld
28100 \begin_inset Quotes erd
28104 If Noweb is correctly installed, when you click on the
28105 \begin_inset Quotes eld
28109 \begin_inset Quotes erd
28112 link, you will see the
28113 \begin_inset Quotes eld
28117 \begin_inset Quotes erd
28120 module in the available list and you can add it to your document.
28123 \begin_layout Paragraph
28127 \begin_layout Standard
28129 enables you to write code with a custom inset named
28130 \begin_inset Flex Noun
28133 \begin_layout Plain Layout
28140 Noweb delimits chunks like this:
28143 \begin_layout LyX-Code
28147 \begin_layout LyX-Code
28151 \begin_layout LyX-Code
28155 \begin_layout LyX-Code
28159 \begin_layout LyX-Code
28163 \begin_layout Standard
28164 The problem is that whatever is written in between the << and the
28168 must be taken literally, i.
28169 \begin_inset space \thinspace{}
28173 \begin_inset space \space{}
28177 should be prevented from making any special interpretation of what has
28179 This is also handled by
28180 \begin_inset Flex Noun
28183 \begin_layout Plain Layout
28189 , that works like a normal text inset but has a free spacing capability.
28192 \begin_layout Standard
28193 As a special note, you can also use the
28194 \begin_inset Quotes eld
28198 \begin_inset Quotes erd
28201 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
28205 \begin_layout LyX-Code
28209 \begin_layout LyX-Code
28210 def some_function(args):
28213 \begin_layout LyX-Code
28214 "This is the doc string for this function."
28217 \begin_layout LyX-Code
28218 print "My args: ", args
28221 \begin_layout LyX-Code
28222 @ %def some_function
28225 \begin_layout Standard
28226 For an example of this usage and the resulting cross-reference output, look
28227 at the Literate python program in
28229 LIBDIR/examples/listerrors.lyx
28231 which should make this all clear.
28234 \begin_layout Paragraph
28235 Generating the documentation
28238 \begin_layout Standard
28239 At this point you already have a new document file with a proper document
28240 class, and with some code and text on it.
28241 How do I print it? The answer is simple, you select
28243 View\SpecialChar menuseparator
28247 Just like you would do for a plain document.
28248 No special procedure is required.
28251 \begin_layout Standard
28252 To help orientate you, I will now explain what happens inside \SpecialChar LyX
28256 \begin_layout Enumerate
28259 Update\SpecialChar menuseparator
28262 menu option is chosen, a \SpecialChar LaTeX
28268 \begin_layout Standard
28269 If the document is of any literate class the generated file will be named
28270 with an extension name defined by the
28271 \begin_inset Quotes eld
28275 \begin_inset Quotes erd
28278 format (defined in the Preferences panel), otherwise the file will have
28287 \begin_layout Enumerate
28288 Note that the only difference so far is in the name of the file, no special
28289 processing is required by \SpecialChar LyX
28291 Given that you formatted the code using the
28292 \begin_inset Flex Noun
28295 \begin_layout Plain Layout
28301 inset that, by itself, takes care of the business.
28304 \begin_layout Enumerate
28305 If the document is of any literate class \SpecialChar LyX
28306 will then use the internal \SpecialChar LyX
28308 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
28313 \begin_layout Plain Layout
28314 The converters are defined in the
28316 Tools\SpecialChar menuseparator
28320 \begin_inset Quotes eld
28324 \begin_inset Quotes erd
28336 manual for general information about converters.
28341 to generate the \SpecialChar LaTeX
28346 \begin_layout Standard
28347 Otherwise it will just skip this step.
28351 \begin_layout Enumerate
28352 Finally, \SpecialChar LaTeX
28353 is invoked and the regular post processing continues as in a plain
28357 \begin_layout Standard
28358 Independence from a particular
28359 \begin_inset Quotes eld
28363 \begin_inset Quotes erd
28366 is easily achieved by changing the commands that are run by the various
28370 \begin_layout Paragraph
28371 Generating the code
28374 \begin_layout Standard
28375 When the build menu option is chosen or the corresponding button in the
28376 toolbar is pressed, a \SpecialChar LaTeX
28377 file is generated just like step 1 above.
28378 Next, \SpecialChar LyX
28384 This converter needs to be defined by the user and is not installed by
28385 default, though the Program format is.
28386 This converter (like any other converter) will have two parts:
28389 \begin_layout Enumerate
28390 The converter program itself.
28391 This program performs the conversion from the one format to the other (in
28392 this case, from the Noweb format to the Program pseudo-format).
28395 \begin_layout Enumerate
28396 The error log parser.
28397 This is a program whose sole purpose is to rewrite error messages in a
28398 format that \SpecialChar LyX
28400 This makes it possible for \SpecialChar LyX
28401 to place error boxes in the right places in
28405 \begin_layout Standard
28406 The first part, the
28407 \begin_inset Quotes eld
28411 \begin_inset Quotes erd
28414 setting, should be set to
28417 \begin_layout LyX-Code
28425 \begin_layout Standard
28426 This basically means that \SpecialChar LyX
28428 \begin_inset Quotes eld
28432 \begin_inset Quotes erd
28435 (a program or script) with the name of the Noweb file (normally a file
28436 in the \SpecialChar LyX
28437 temp directory) and the directory path of the original \SpecialChar LyX
28442 \begin_layout Standard
28443 This is an implementation of
28444 \begin_inset Quotes eld
28448 \begin_inset Quotes erd
28451 that you can place in a directory on your path:
28454 \begin_layout LyX-Code
28460 \begin_layout LyX-Code
28466 \begin_layout LyX-Code
28469 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
28472 \begin_layout Standard
28473 The next part of the converter setting is the
28474 \begin_inset Quotes eld
28478 \begin_inset Quotes erd
28481 which is to be set to
28484 \begin_layout LyX-Code
28487 parselog=$$s/scripts/listerrors
28490 \begin_layout Standard
28491 This will run any errors that are generated by the
28492 \begin_inset Quotes eld
28496 \begin_inset Quotes erd
28499 process through the
28500 \begin_inset Quotes eld
28504 \begin_inset Quotes erd
28510 \begin_layout Standard
28511 The build will normally take place in \SpecialChar LyX
28512 's temporary directory, so the files
28513 produced by the conversion will be in that directory.
28515 will copy out what it regards as the `main' file, but the
28519 conversion may produce several files, and so most of these would then be
28520 deleted when \SpecialChar LyX
28522 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
28523 the build-script chunk can place the generated files in that location.
28526 \begin_layout Paragraph
28527 Build instructions in the document
28530 \begin_layout Standard
28531 The last piece of the integration between \SpecialChar LyX
28533 \begin_inset Quotes eld
28537 \begin_inset Quotes erd
28541 Generally, the instructions for building your program should be embedded
28542 in a chunk of its own.
28544 \begin_inset Quotes eld
28548 \begin_inset Quotes erd
28551 above uses the notangle command to look for this chunk (called
28552 \begin_inset Quotes eld
28556 \begin_inset Quotes erd
28559 ) and runs its contents through
28560 \begin_inset Quotes eld
28564 \begin_inset Quotes erd
28570 \begin_layout Standard
28571 Typically, such a chunk would look something like this:
28574 \begin_layout LyX-Code
28578 \begin_layout LyX-Code
28580 \begin_inset Newline newline
28583 if [ -z "${NOWEB_SOURCE}" ]
28584 \begin_inset Newline newline
28590 \begin_layout LyX-Code
28591 NOWEB_SOURCE=myfile.nw
28592 \begin_inset Newline newline
28596 \begin_inset Newline newline
28600 code to extract files ...
28601 use NOWEB_OUTPUT_DIR here ...]
28602 \begin_inset Newline newline
28606 code to compile files ...]
28607 \begin_inset Newline newline
28613 \begin_layout Standard
28616 LIBDIR/examples/listerrors.lyx
28620 LIBDIR/examples/Literate.lyx
28622 which implement two versions of the
28623 \begin_inset Quotes eld
28627 \begin_inset Quotes erd
28630 program for some illustrations of how all of these pieces go together or
28633 LIBDIR/examples/noweb2lyx.lyx.
28636 Interestingly, these three files show off the language-indepence of the
28638 literate programming support since they are written in Python, C and Perl
28642 \begin_layout Subsubsection
28643 Configuring \SpecialChar LyX
28647 \begin_layout Standard
28648 All the Literate Programming support is configured by the
28650 Tools\SpecialChar menuseparator
28654 \begin_inset Quotes eld
28658 \begin_inset Quotes erd
28662 The important parts are:
28665 \begin_layout Description
28667 \begin_inset space ~
28671 \begin_inset Quotes eld
28675 \begin_inset Quotes erd
28679 \begin_inset space ~
28682 format Set up via the File Formats tab, this is where the Noweb-specific
28692 , the file extension is set to
28697 This tells \SpecialChar LyX
28698 to create a file with a
28702 extension in the first step of the conversion process.
28705 \begin_layout Description
28707 \begin_inset space ~
28715 \begin_inset space ~
28718 format This is an empty format whose sole purpose is to be the endpoint
28719 of a conversion (which then allows us to set up a converter for it).
28722 \begin_layout Description
28732 This converter performs the
28733 \begin_inset Quotes eld
28737 \begin_inset Quotes erd
28740 of the literate document.
28741 For Noweb, it is set to
28742 \begin_inset Quotes eld
28747 noweave -delay -index $$i > $$o
28750 \begin_inset Quotes erd
28756 \begin_layout Description
28766 \begin_inset Quotes eld
28770 \begin_inset Quotes erd
28774 As stated above, the Converter is set to
28775 \begin_inset Quotes eld
28783 \begin_inset Quotes erd
28786 , with Flags set to
28787 \begin_inset Newline newline
28791 \begin_inset Quotes eld
28796 parselog=$$s/scripts/listerrors
28799 \begin_inset Quotes erd
28805 \begin_layout Subsubsection
28809 \begin_layout Standard
28810 There is also a new function implemented in the \SpecialChar LyX
28812 \begin_inset Quotes eld
28815 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
28819 \begin_layout Standard
28820 When debugging code with ddd/gdb, it is possible to invoke a text editor
28821 at the current execution position with a single key stroke.
28822 The default ddd configuration for that is shift-ctrl-V.
28823 It happens that you can define the editor command line invocation in ddd
28826 Edit\SpecialChar menuseparator
28827 Preferences\SpecialChar menuseparator
28830 dialog and changing the "Edit Sources" entry.
28833 \begin_layout Standard
28834 I take advantage of the newly created \SpecialChar LyX
28835 server function and this ddd feature,
28837 \begin_inset Quotes eld
28841 \begin_inset Quotes erd
28847 \begin_layout LyX-Code
28848 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
28851 \begin_layout Standard
28852 With this, whenever you are using ddd and find a point in the program that
28853 you want to edit, you just press shift-ctrl-V (in the ddd window), and
28854 ddd will forward this information to \SpecialChar LyX
28855 through the \SpecialChar LyX
28856 server and then the
28858 window will show the same file with the cursor at the same position ddd
28860 No more guessing or long scrolling to locate a point in the program back
28864 \begin_layout Standard
28865 Note however that you must enable the \SpecialChar LyX
28866 server to get this feature working
28867 (it is disabled by default).
28869 \begin_inset space ~
28873 \begin_inset CommandInset ref
28875 reference "sec:Starting-the-Server"
28879 explains how to do that.
28882 \begin_layout Subsubsection
28886 \begin_layout Standard
28887 There are six new buttons that can be added to your \SpecialChar LyX
28889 Four of these buttons are short cuts to layout styles:
28907 , one for the custom inset
28912 The last one is a short cut to the
28913 \begin_inset Quotes eld
28917 \begin_inset Quotes erd
28924 \begin_layout Standard
28926 has a range of buttons that are available for tool bar customization.
28927 In my toolbar I like to combine the six short cuts above with two more:
28932 \SpecialChar menuseparator
28937 \SpecialChar menuseparator
28944 Document\SpecialChar menuseparator
28945 View\SpecialChar menuseparator
28949 Here is how it looks like:
28952 \begin_layout LyX-Code
28956 \begin_layout LyX-Code
28960 \begin_layout LyX-Code
28961 Icon "layout Standard"
28964 \begin_layout LyX-Code
28965 Icon "layout Section"
28968 \begin_layout LyX-Code
28969 Icon "layout \SpecialChar LaTeX
28973 \begin_layout LyX-Code
28974 Icon "layout \SpecialChar LyX
28978 \begin_layout LyX-Code
28979 Icon "flex.insert Chunk"
28982 \begin_layout LyX-Code
28986 \begin_layout LyX-Code
28990 \begin_layout LyX-Code
28991 Icon "buffer-typeset"
28994 \begin_layout LyX-Code
28995 Icon "build-program"
28998 \begin_layout LyX-Code
29002 \begin_layout LyX-Code
29006 \begin_layout LyX-Code
29010 \begin_layout LyX-Code
29014 \begin_layout LyX-Code
29018 \begin_layout Subsubsection
29019 Colors customization
29022 \begin_layout Standard
29023 There are a number of colors in \SpecialChar LyX
29024 that can be customized in
29029 One of the things that bothers people is the \SpecialChar LaTeX
29031 The default color is red, since the chunks uses \SpecialChar LaTeX
29032 font, and there is a lot
29033 of chunks in literate documents, you may get tired of seeing everything
29035 You can change it by going to the tabs
29044 \begin_layout Standard
29045 The next thing is the visible presence of the newline character in the screen.
29046 You can choose the color of this particular character and make it blend
29048 I recommend you choosing a color that is close to the background but not
29049 equal, that way you still can see it is there, but it is not bothering
29053 \begin_layout Subsection
29058 \begin_layout Standard
29067 is documented in the
29071 example file and in the Sweave manual (menu
29073 Help\SpecialChar menuseparator
29079 \begin_layout Chapter
29081 \change_deleted 564990737 1671355343
29085 \begin_layout Standard
29087 \change_deleted 564990737 1671355343
29088 You can do everything with \SpecialChar LyX
29089 that you can do with \SpecialChar LaTeX
29091 However, \SpecialChar LyX
29092 cannot support every \SpecialChar LaTeX
29094 But you can always use \SpecialChar TeX
29096 This chapter shows you some more special things you might want to use.
29097 For other special things you can do with figures, tables, floats, boxes
29098 and notes, have a look at the
29101 \begin_inset space ~