1 #LyX 2.4 created this file. For more info see https://www.lyx.org/
5 \save_transient_properties true
6 \origin /systemlyxdir/doc/
9 % DO NOT ALTER THIS PREAMBLE!!!
11 % This preamble is designed to ensure that the manual prints
12 % out as advertised. If you mess with this preamble,
13 % parts of the manual may not print out as expected. If you
14 % have problems LaTeXing this file, please contact
15 % the documentation team
16 % email: lyx-docs@lists.lyx.org
18 % the pages of the TOC are numbered roman
19 % and a PDF-bookmark for the TOC is added
21 \let\myTOC\tableofcontents
22 \renewcommand{\tableofcontents}{%
23 \pdfbookmark[1]{\contentsname}{}
26 \pagenumbering{arabic}}
28 % extra space for tables
29 \newcommand{\extratablespace}[1]{\noalign{\vskip#1}}
31 \options bibliography=totoc,index=totoc,BCOR7.5mm,titlepage,captions=tableheading
32 \use_default_options false
40 \maintain_unincluded_children no
42 \language_package default
45 \font_roman "lmodern" "default"
46 \font_sans "lmss" "default"
47 \font_typewriter "lmtt" "default"
48 \font_math "auto" "auto"
49 \font_default_family default
50 \use_non_tex_fonts false
54 \font_typewriter_osf false
55 \font_sf_scale 100 100
56 \font_tt_scale 100 100
58 \use_dash_ligatures true
60 \default_output_format pdf2
62 \bibtex_command default
63 \index_command default
67 \pdf_title "LyX's Additional Features manual"
68 \pdf_author "LyX Team"
69 \pdf_subject "LyX's additional features documentation"
70 \pdf_keywords "LyX, Documentation, Additional"
72 \pdf_bookmarksnumbered true
73 \pdf_bookmarksopen false
74 \pdf_bookmarksopenlevel 1
79 \pdf_pdfusetitle false
80 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
83 \use_package amsmath 1
84 \use_package amssymb 1
87 \use_package mathdots 1
88 \use_package mathtools 1
90 \use_package stackrel 1
91 \use_package stmaryrd 1
92 \use_package undertilde 1
94 \cite_engine_type default
98 \paperorientation portrait
104 \notefontcolor #0000ff
111 \paragraph_separation indent
112 \paragraph_indentation default
114 \math_indentation default
115 \math_numbering_side default
116 \quotes_style english
120 \paperpagestyle headings
122 \tracking_changes true
123 \output_changes false
125 \postpone_fragile_content false
129 \docbook_table_output 0
130 \docbook_mathml_prefix 1
131 \author -712698321 "Jürgen Spitzmüller"
134 \author 244031559 "Yuriy"
135 \author 564990737 "John Lyx"
136 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
137 \author 1075283030 "Thibaut"
138 \author 1119979965 "Joel A. Kulesza"
144 Additional \SpecialChar LyX
148 \begin_layout Subtitle
150 \change_deleted 630872221 1622909155
152 \change_inserted 630872221 1622909155
159 by the \SpecialChar LyX
164 \begin_layout Plain Layout
166 Principal maintainer of this file is
168 Richard Kimberly Heck
171 If you have comments or error corrections, please send them to the \SpecialChar LyX
174 \begin_inset Flex Code
177 \begin_layout Plain Layout
178 <lyx-docs@lists.lyx.org>
191 \begin_layout Standard
192 \begin_inset CommandInset toc
193 LatexCommand tableofcontents
200 \begin_layout Chapter
204 \begin_layout Standard
205 This manual is essentially Part II of the
207 User's Guide\SpecialChar endofsentence
210 The reason for separating the two documents is simple: the
214 is already quite lengthy, and it contains information on all of the basic
215 features one needs to know in order to prepare most documents.
216 However, the \SpecialChar LyX
217 Team has worked to make \SpecialChar LyX
218 extensible through various configuration
219 files and external packages.
220 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
222 create a layout file (or module) for it without having to alter \SpecialChar LyX
224 We've already had contributions of several new features this way, and some
225 of them are documented here.
226 There are also some more `advanced' features, such as how to control the
227 presentation of bibliographies and how to work with multi-part documents,
228 that are not covered in the
232 and are discussed here.
235 \begin_layout Standard
236 This manual also documents some special features, like fax support
237 \change_deleted 244031559 1603802929
239 \change_inserted 244031559 1603802931
243 \change_deleted 244031559 1603802954
246 , which require additional software to work properly.
247 There is also a chapter on \SpecialChar LyX
249 And lastly, there's a chapter of \SpecialChar LaTeX
250 tools and tips, things you can use to
251 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
253 After all, \SpecialChar LyX
258 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
262 \begin_layout Standard
263 If you haven't read the
267 yet, you are definitely in the wrong manual.
272 is the first place to go, since it describes the notation and format of
274 You should also be thoroughly familiar with the
278 and all of the basic features of \SpecialChar LyX
279 before attempting to read this one.
282 \begin_layout Standard
283 Since many of the topics in this manual depend heavily on \SpecialChar LyX
285 with \SpecialChar LaTeX
286 , this first chapter covers the inner workings of \SpecialChar LyX
289 to generate exactly the \SpecialChar LaTeX
291 It is obviously for more seasoned \SpecialChar LyX
295 \begin_layout Chapter
297 and \SpecialChar LaTeX
301 \begin_layout Section
303 Uses \SpecialChar LaTeX
307 \begin_layout Standard
308 This chapter is for both \SpecialChar TeX
309 -nicians and the \SpecialChar LaTeX
311 In it, we'll explain how \SpecialChar LyX
312 and \SpecialChar LaTeX
313 work together to produce printable output.
314 This is the only place in any of the manuals where we assume you know something
315 about \SpecialChar LaTeX
319 \begin_layout Standard
320 At one time, \SpecialChar LyX
322 \begin_inset Quotes eld
325 WYSIWYM frontend to \SpecialChar LaTeX
327 \begin_inset Quotes erd
330 but that's no longer true.
331 There are frontends to \SpecialChar LaTeX
336 \begin_layout Plain Layout
337 Some familar ones are \SpecialChar TeX
338 maker and kile, on Linux, and \SpecialChar TeX
340 There are also the \SpecialChar LaTeX
341 modes for vi and emacs, of course.
346 These are basically text editors with the ability to run \SpecialChar LaTeX
348 errors in the file you're editing.
349 Although \SpecialChar LyX
358 run \SpecialChar LaTeX
359 , and it also indicates errors in the file, it also does much, much
361 For one thing, you don't need to know \SpecialChar LaTeX
362 to use \SpecialChar LyX
365 has added its own extensions to \SpecialChar LaTeX
367 Try the following sometime: select
368 \begin_inset Flex Noun
371 \begin_layout Plain Layout
372 Export\SpecialChar menuseparator
379 \begin_inset Flex Noun
382 \begin_layout Plain Layout
389 \begin_inset Flex Noun
392 \begin_layout Plain Layout
393 View\SpecialChar menuseparator
403 ), then look at the preamble of the resulting
404 \begin_inset Flex Code
407 \begin_layout Plain Layout
414 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
416 These macros are defined automatically, according to the features you use
420 \begin_layout Standard
421 There are several commands that automatically invoke \SpecialChar LaTeX
426 \begin_layout Itemize
427 \begin_inset Flex Noun
430 \begin_layout Plain Layout
431 Document\SpecialChar menuseparator
440 \begin_layout Itemize
441 \begin_inset Flex Noun
444 \begin_layout Plain Layout
445 Document\SpecialChar menuseparator
454 \begin_layout Standard
455 They will only invoke \SpecialChar LaTeX
456 if the file has changed since the last time \SpecialChar LaTeX
462 \begin_layout Standard
463 When \SpecialChar LyX
464 runs \SpecialChar LaTeX
465 on the file you're editing, it performs these steps:
468 \begin_layout Enumerate
469 Convert the document to \SpecialChar LaTeX
470 and save to a file with the extension
471 \begin_inset Flex Code
474 \begin_layout Plain Layout
481 \begin_inset Flex Code
484 \begin_layout Plain Layout
493 \begin_layout Enumerate
494 Run \SpecialChar LaTeX
496 \begin_inset Flex Code
499 \begin_layout Plain Layout
505 file (maybe several times), and run any other commands (such as
506 \begin_inset Flex Code
509 \begin_layout Plain Layout
516 \begin_inset Flex Code
519 \begin_layout Plain Layout
525 ) needed to compile the \SpecialChar LaTeX
529 \begin_layout Enumerate
530 If there are any errors, show the error log.
533 \begin_layout Standard
534 If you have run \SpecialChar LaTeX
536 \begin_inset Flex Noun
539 \begin_layout Plain Layout
540 View\SpecialChar menuseparator
547 then runs a DVI viewer to display the DVI-file.
549 \begin_inset Flex Noun
552 \begin_layout Plain Layout
553 View\SpecialChar menuseparator
560 performs further steps:
563 \begin_layout Enumerate
565 \begin_inset Flex Code
568 \begin_layout Plain Layout
574 to convert the DVI file to PostScript.
577 \begin_layout Enumerate
578 Run a PostScript viewer, such as
579 \begin_inset Flex Code
582 \begin_layout Plain Layout
588 , to display the PostScript file.
591 \begin_layout Standard
593 does similar things when viewing, or exporting, other formats.
596 \begin_layout Section
597 Translating \SpecialChar LaTeX
598 files into \SpecialChar LyX
602 \begin_layout Standard
603 You can import a \SpecialChar LaTeX
604 file into \SpecialChar LyX
606 \begin_inset Flex Noun
609 \begin_layout Plain Layout
610 File\SpecialChar menuseparator
611 Import\SpecialChar menuseparator
617 command in \SpecialChar LyX
619 This will call a program named
620 \begin_inset Flex Code
623 \begin_layout Plain Layout
629 which will create a file
630 \begin_inset Flex Code
633 \begin_layout Plain Layout
640 \begin_inset Flex Code
643 \begin_layout Plain Layout
651 will then open that file.
655 \begin_layout Plain Layout
656 \begin_inset Flex Code
659 \begin_layout Plain Layout
665 can also be run from the command line, of course.
673 \begin_layout Standard
674 \begin_inset Flex Code
677 \begin_layout Plain Layout
683 will translate most legal \SpecialChar LaTeX
684 , but not everything.
685 It will put things it doesn't understand into \SpecialChar TeX
686 code, so after translating
688 \begin_inset Flex Code
691 \begin_layout Plain Layout
697 , you can look for \SpecialChar TeX
698 code and hand-edit it until it looks right.
701 \begin_layout Standard
702 If you don't know what \SpecialChar TeX
703 code is, read the next section.
706 \begin_layout Section
707 \begin_inset CommandInset label
709 name "sec:Inserting-TeX-Code"
713 Inserting \SpecialChar TeX
714 Code into \SpecialChar LyX
718 \begin_layout Standard
719 Anything you can do in \SpecialChar LaTeX
720 you can do in \SpecialChar LyX
721 , for a very simple reason: You can
722 always insert \SpecialChar TeX
723 code into any \SpecialChar LyX
726 cannot, and will never be able to, display every possible \SpecialChar LaTeX
728 If ever you need to insert \SpecialChar LaTeX
729 commands into your \SpecialChar LyX
730 document, you can use the
732 \begin_inset Flex Code
735 \begin_layout Plain Layout
742 box, which you can insert into your document with
743 \begin_inset Flex Noun
746 \begin_layout Plain Layout
747 Insert\SpecialChar menuseparator
757 or the keyboard shortcut
766 \begin_layout Standard
767 Here's an example of inserting \SpecialChar LaTeX
768 commands in a \SpecialChar LyX
770 The code looks like this:
773 \begin_layout LyX-Code
777 \begin_inset Newline newline
783 \begin_inset Newline newline
786 This is an example of a minipage environment.
788 \begin_inset Newline newline
791 can put nearly everything in it, even (non-floating)
792 \begin_inset Newline newline
797 \begin_inset Newline newline
803 \begin_inset Newline newline
807 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
830 \begin_inset Newline newline
836 \begin_inset Newline newline
842 \begin_inset Newline newline
848 \begin_inset Newline newline
856 \begin_layout LyX-Code
860 \begin_layout Standard
862 \begin_inset Flex Code
865 \begin_layout Plain Layout
872 box containing this text is directly after this paragraph.
873 Those of you reading the manual in \SpecialChar LyX
874 will only see the \SpecialChar TeX
876 Those reading a printed version of the manuals will see the actual results:
877 \begin_inset VSpace bigskip
883 \begin_layout Standard
887 \begin_layout Plain Layout
894 \begin_layout Plain Layout
901 \begin_layout Plain Layout
903 This is an example of a minipage environment.
904 You can put nearly everything in it, even (non-floating) figures and tables.
908 \begin_layout Plain Layout
915 \begin_layout Plain Layout
920 \begin_layout Plain Layout
927 \begin_layout Plain Layout
934 \begin_layout Plain Layout
941 \begin_layout Plain Layout
947 \begin_layout Plain Layout
954 \begin_layout Plain Layout
961 \begin_layout Plain Layout
968 \begin_layout Plain Layout
978 \begin_inset VSpace bigskip
984 \begin_layout Standard
985 In addition to using \SpecialChar TeX
986 code, you can also create a separate file containing
987 some complex \SpecialChar LaTeX
988 structure and then use
989 \begin_inset Flex Noun
992 \begin_layout Plain Layout
993 Insert\SpecialChar menuseparator
1003 to include your file (you should select the type
1004 \begin_inset Flex Code
1007 \begin_layout Plain Layout
1014 We recommend that you only do this if you have a
1015 \begin_inset Flex Code
1018 \begin_layout Plain Layout
1029 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1033 \begin_layout Standard
1034 There are a few last points to emphasize:
1037 \begin_layout Itemize
1043 check if your \SpecialChar LaTeX
1047 \begin_layout Itemize
1048 Beware of reinventing the wheel.
1051 \begin_layout Standard
1052 On that last point, \SpecialChar LyX
1053 does have quite a few features tucked into it, and
1055 Be sure to check the manuals to make sure that \SpecialChar LyX
1056 doesn't have such-and-such
1057 feature before you decide you have to do it by hand.
1058 Moreover, there are numerous \SpecialChar LaTeX
1059 packages out there to do all sorts of things,
1060 from labels to envelopes to fancy multipage tables.
1062 \change_inserted 244031559 1603815732
1064 \begin_inset CommandInset href
1067 target "https://www.ctan.org/"
1073 \change_deleted 244031559 1603815732
1075 \begin_inset CommandInset href
1078 target "http://www.ctan.org/"
1088 \begin_layout Standard
1089 If you do need to do some wild and fancy things within your document, be
1090 sure to check out a good \SpecialChar LaTeX
1091 book for assistance.
1092 There are a number of them listed in the bibliography of the
1099 \begin_layout Section
1101 and the \SpecialChar LaTeX
1105 \begin_layout Subsection
1106 About the \SpecialChar LaTeX
1110 \begin_layout Standard
1111 If you already know \SpecialChar LaTeX
1112 , there is no need to explain here what the preamble
1114 If you don't, the following will give you some ideas—we recommend again
1115 that you consult a \SpecialChar LaTeX
1116 book for further information.
1117 In any case, you should read the points below, because they explain what
1118 you can do and what you don't need to do in the \SpecialChar LaTeX
1119 preamble of a \SpecialChar LyX
1123 \begin_layout Standard
1124 The \SpecialChar LaTeX
1125 preamble comes at the very beginning of a document,
1133 \begin_layout Itemize
1134 Declare the document class.
1136 \begin_inset Newline newline
1140 already does this for you.
1141 If you're a seasoned \SpecialChar LaTeX
1142 -nician, and you have a custom document class you
1143 want to use, check out the
1145 Customization Manual
1147 for information on how to make \SpecialChar LyX
1151 \begin_layout Itemize
1152 Declare the usage of packages.
1154 \begin_inset Newline newline
1158 packages provide special commands, which are only available within a document
1159 when the package has been declared in the preamble.
1160 In addition to providing special commands, the inclusion of a package can
1161 change the document.
1162 For example, the package
1163 \begin_inset Flex Code
1166 \begin_layout Plain Layout
1172 forces all paragraphs to be indented.
1173 There are other packages for labels, envelopes, margins, etc.
1177 \begin_layout Itemize
1178 Set counters, variables, lengths and widths.
1180 \begin_inset Newline newline
1183 There are several \SpecialChar LaTeX
1184 counters and variables that
1188 be set globally from within the preamble in order to have the desired effect.
1189 (There are variables that you can set and reset inside the document, too.)
1190 Margins are a good example of something that must be set in the preamble.
1191 Another example is the label format for lists.
1192 You can actually set these just about anywhere, but it's best to do it
1193 just once, inside the preamble.
1196 \begin_layout Itemize
1197 Declare user defined commands (with
1198 \begin_inset Flex Code
1201 \begin_layout Plain Layout
1210 \begin_inset Flex Code
1213 \begin_layout Plain Layout
1222 \begin_inset Newline newline
1225 These are abbreviations for \SpecialChar LaTeX
1226 commands which appear very often inside a document.
1227 Although the preamble is a good place to declare such commands, they
1231 be declared anywhere (before they are used for the first time, of course).
1232 This can be useful if there is a lot of raw \SpecialChar LaTeX
1233 code in your document, which
1234 normally should not be the case.
1237 \begin_layout Standard
1239 adds its own set of definitions to the preamble of the
1240 \begin_inset Flex Code
1243 \begin_layout Plain Layout
1250 This makes \SpecialChar LaTeX
1251 files generated by \SpecialChar LyX
1255 \begin_layout Subsection
1256 Changing the Preamble
1259 \begin_layout Standard
1260 The commands which \SpecialChar LyX
1261 adds to the preamble of a \SpecialChar LaTeX
1262 file are fixed; you can't
1263 change them without patching \SpecialChar LyX
1265 You can, however, add your own stuff to the preamble by selecting
1266 \begin_inset Flex Noun
1269 \begin_layout Plain Layout
1272 \begin_inset space ~
1281 \begin_inset Flex Noun
1284 \begin_layout Plain Layout
1285 Document\SpecialChar menuseparator
1293 adds anything in the
1294 \begin_inset Flex Noun
1297 \begin_layout Plain Layout
1303 dialog to its own built-in preamble.
1304 Before adding your own declarations in the preamble, you should make sure
1305 that \SpecialChar LyX
1306 doesn't already support what you want to do.
1307 (Remember what we said about reinventing the wheel?) Also,
1309 make sure your preamble code is correct
1313 doesn't check it for you.
1314 If there is an error, you're likely to get an error like
1315 \begin_inset Quotes eld
1319 \begin_inset Flex Code
1322 \begin_layout Plain Layout
1331 \begin_inset Quotes erd
1335 If you see this error, check your preamble.
1338 \begin_layout Subsection
1342 \begin_layout Standard
1343 Here are some examples of what you can add to a preamble, and what they
1347 \begin_layout Subsubsection
1351 \begin_layout Standard
1352 There are two variables under \SpecialChar LaTeX
1353 that control page position:
1354 \begin_inset Flex Code
1357 \begin_layout Plain Layout
1366 \begin_inset Flex Code
1369 \begin_layout Plain Layout
1378 Their names should be self-explanatory.
1379 These variables are useful if you think for a moment about computer labels.
1380 Sometimes, the size of a print medium and the area of the medium that you
1381 can actually print on aren't the same.
1383 \begin_inset Flex Code
1386 \begin_layout Plain Layout
1395 \begin_inset Flex Code
1398 \begin_layout Plain Layout
1409 \begin_layout Standard
1410 The default values for
1411 \begin_inset Flex Code
1414 \begin_layout Plain Layout
1423 \begin_inset Flex Code
1426 \begin_layout Plain Layout
1435 \begin_inset space \thinspace{}
1439 \begin_inset space \thinspace{}
1443 \begin_inset space \space{}
1446 the page isn't shifted.
1447 Unfortunately, some DVI drivers always seem to shift the page.
1448 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1449 If you're using \SpecialChar LyX
1450 on a system that you don't personally maintain, and your
1451 sysadmin is a doofus,
1452 \begin_inset Flex Code
1455 \begin_layout Plain Layout
1464 \begin_inset Flex Code
1467 \begin_layout Plain Layout
1476 Suppose your left and top margins are always 0.5
1477 \begin_inset space \thinspace{}
1481 You can add this to the preamble:
1484 \begin_layout LyX-Code
1492 \begin_layout LyX-Code
1500 \begin_layout Standard
1501 and your margins should now be correct.
1504 \begin_layout Subsubsection
1508 \begin_layout Standard
1509 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1510 There's a rather nice package, available at your nearest CTAN archive,
1511 for printing sheets of labels:
1512 \begin_inset Flex Code
1515 \begin_layout Plain Layout
1522 Now, your system may not have this package installed by default.
1523 We leave that up to you to check.
1524 You'll also want to read the documentation for it; we're not going to do
1526 Since this is an example, however, we'll give you an example of how you
1530 \begin_layout Standard
1531 First, make sure you're using the
1532 \begin_inset Flex Code
1535 \begin_layout Plain Layout
1542 Next, you need to put the following in your preamble:
1545 \begin_layout LyX-Code
1551 \begin_layout LyX-Code
1557 \begin_layout LyX-Code
1563 \begin_layout LyX-Code
1569 \begin_layout LyX-Code
1575 \begin_layout LyX-Code
1581 \begin_layout LyX-Code
1587 \begin_layout Standard
1588 This sets things up for Avery label sheets, stock #5360.
1589 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1592 \begin_inset Flex Code
1595 \begin_layout Plain Layout
1604 \begin_inset Flex Code
1607 \begin_layout Plain Layout
1615 around each label text.
1616 This and other special features of
1617 \begin_inset Flex Code
1620 \begin_layout Plain Layout
1626 are explained in its documentation.
1629 \begin_layout Standard
1630 Someday, someone may write a \SpecialChar LyX
1631 layout file to support this package directly.
1632 Maybe that someone is you.
1635 \begin_layout Subsubsection
1636 Example #3: Paragraph Indentation
1639 \begin_layout Standard
1640 Americans are trained to indent the first line of
1645 As with all of their other weird quirks, most Americans will whine and
1646 moan until they can have their way and indent the first line of all paragraphs.
1655 \begin_layout Standard
1656 Of course, this behavior isn't standard typography.
1657 In books, you typically only indent the first line of a paragraph
1661 it follows another one.
1662 The idea behind indenting the first line of a paragraph is to distinguish
1663 neighboring paragraphs from one another.
1664 If there is no previous paragraph—for example, if it follows a figure or
1665 is the first paragraph in a section—then there is no need for indentation.
1669 \begin_layout Standard
1670 If you're a typical American (we're still joking!), though, you don't care
1671 about such esoteric things; you want your indentation! Add this to the
1675 \begin_layout LyX-Code
1678 usepackage{indentfirst}
1681 \begin_layout Standard
1682 If your \SpecialChar TeX
1683 distribution isn't braindead, you'll have this package, and all
1684 of your paragraphs will get the indentation the Founding Fathers intended
1688 \begin_layout Subsubsection
1689 Example #4: This Document
1692 \begin_layout Standard
1693 You can also check out the preamble of this document to get an idea of some
1694 of the advanced things you can do.
1697 \begin_layout Section
1699 and \SpecialChar LaTeX
1703 \begin_layout Standard
1704 When \SpecialChar LyX
1705 calls \SpecialChar LaTeX
1706 , it tells \SpecialChar LaTeX
1707 to blithely ignore any errors and keep going.
1708 It then uses the logfile from the \SpecialChar LaTeX
1709 run to do a post-mortem.
1710 After analyzing the logfile, \SpecialChar LyX
1711 displays a dialog listing the errors.
1712 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1714 where the error occurred.
1718 \begin_layout Plain Layout
1720 Analyzing the logfile is a tough job, and \SpecialChar LyX
1721 doesn't always go to the right
1723 There are also cases where \SpecialChar LaTeX
1724 reports the error on one line, but the actual
1726 This is not unlike forgetting a closing brace in a program: You'll get
1727 an error, but only later.
1735 \begin_layout Standard
1736 Some folks also like to look at the log file directly: It is available from
1738 \begin_inset Flex Noun
1741 \begin_layout Plain Layout
1742 Document\SpecialChar menuseparator
1744 \begin_inset space ~
1753 There are some fairly common error messages and warnings.
1754 We'll cover those here.
1755 You should look at a good \SpecialChar LaTeX
1756 book for a complete listing.
1759 \begin_layout Itemize
1760 \begin_inset Flex Code
1763 \begin_layout Plain Layout
1770 \begin_inset Newline newline
1773 Anything beginning with these words is a warning message for the purpose
1775 \begin_inset Quotes eld
1779 \begin_inset Quotes erd
1782 the \SpecialChar LaTeX
1784 You'll get messages like this if you added or changed cross-references
1785 or bibliography entries, in which case, \SpecialChar LaTeX
1786 is trying to tell you that you
1787 need to make another run.
1788 You can by-and-large ignore these.
1791 \begin_layout Itemize
1792 \begin_inset Flex Code
1795 \begin_layout Plain Layout
1802 \begin_inset Newline newline
1805 Another warning message, this time about fonts which \SpecialChar LaTeX
1807 The rest of the message will often say something about a replacement font
1808 that \SpecialChar LaTeX
1810 You can safely ignore these, too.
1813 \begin_layout Itemize
1814 \begin_inset Flex Code
1817 \begin_layout Plain Layout
1826 \begin_inset Newline newline
1835 It seems to generate at least one of these messages for just about any
1837 They are warnings about lines that were too long and run past the right
1839 This happens if \SpecialChar LaTeX
1840 does not find a reasonable way to break the lines (notoriously
1841 often with typewriter font, since this does not allow for automatic break
1843 In many cases, this is unnoticeable in the final output.
1844 (It can be just a point or two.) Sometimes, however, the lines run rather
1845 visibly into the margin; something you will not want to have in your final
1848 \begin_inset Newline newline
1851 There are several global ways to try to minimize the overfull lines.
1854 Enable micro-typographic extensions
1858 Document\SpecialChar menuseparator
1859 Settings\SpecialChar menuseparator
1862 might already improve things a lot.
1863 Furthermore, \SpecialChar LaTeX
1864 code such as the following in
1866 Document\SpecialChar menuseparator
1867 Settings\SpecialChar menuseparator
1870 usually reduces the overfull lines drastically (we use this in the preamble
1875 \begin_layout LyX-Code
1879 \begin_inset Newline newline
1885 \begin_inset Newline newline
1890 emergencystretch 1.5em
1891 \begin_inset Newline newline
1899 \begin_layout Standard
1900 In some cases, however, you eventually have to rewrite the text to get the
1901 line breaking right.
1905 \begin_layout Plain Layout
1906 For more information, see
1907 \begin_inset Flex URL
1910 \begin_layout Plain Layout
1912 http://www.tex.ac.uk/FAQ-overfull.html
1925 \begin_layout Standard
1926 In any case, you should check the respective lines, at least for the final
1927 version of your document.
1928 Your eyes will tell you if there's a problem with something that's too
1933 \begin_layout Plain Layout
1934 You can also enable the `draft' option in
1935 \begin_inset Flex Noun
1938 \begin_layout Plain Layout
1939 Document\SpecialChar menuseparator
1945 , and then \SpecialChar LaTeX
1946 will draw a black box in the margin of lines that are overfull.
1955 \begin_layout Itemize
1956 \begin_inset Flex Code
1959 \begin_layout Plain Layout
1968 \begin_inset Newline newline
1971 Not quite as common as its cousin.
1972 This happens again if \SpecialChar LaTeX
1973 does not find a reasonable break point and consequently
1974 generates too loose lines.
1975 As with the overfull lines, you should check if this is a visible problem.
1978 \begin_layout Itemize
1979 \begin_inset Flex Code
1982 \begin_layout Plain Layout
1991 \begin_inset Flex Code
1994 \begin_layout Plain Layout
2003 \begin_inset Newline newline
2006 Warnings about troubles breaking the page.
2007 Once again, just look at the output.
2008 Your eyes will tell you where something has gone wrong.
2011 \begin_layout Itemize
2012 \begin_inset Flex Code
2015 \begin_layout Plain Layout
2017 \begin_inset Quotes els
2021 \begin_inset Quotes ers
2030 \begin_inset Newline newline
2034 \begin_inset Quotes eld
2038 \begin_inset Quotes erd
2041 isn't installed on this system.
2042 This usually appears because some package your document needs isn't installed.
2043 If you didn't touch the preamble or didn't use the
2044 \begin_inset Flex Code
2047 \begin_layout Plain Layout
2055 command, then one of the packages \SpecialChar LyX
2056 tried to load is missing.
2058 \begin_inset Flex Noun
2061 \begin_layout Plain Layout
2062 Help\SpecialChar menuseparator
2069 to get a list of packages that \SpecialChar LyX
2071 This file is updated whenever you reconfigure \SpecialChar LyX
2073 \begin_inset Flex Noun
2076 \begin_layout Plain Layout
2077 Tools\SpecialChar menuseparator
2083 ) and tells you which packages have been detected and what they do.
2084 \begin_inset Newline newline
2088 \begin_inset Flex Code
2091 \begin_layout Plain Layout
2099 command and the package in question isn't installed, then you'll need to
2100 install it yourself.
2103 \begin_layout Itemize
2104 \begin_inset Flex Code
2107 \begin_layout Plain Layout
2108 LaTeX Error: Unknown option
2114 \begin_inset Newline newline
2117 Error messages beginning with this are trying to tell you that you specified
2118 a bad or undefined option to a package.
2119 Check the package's documentation.
2122 \begin_layout Itemize
2123 \begin_inset Flex Code
2126 \begin_layout Plain Layout
2127 Undefined control sequence
2133 \begin_inset Newline newline
2136 If you've inserted \SpecialChar LaTeX
2137 code into your document, but made a typo, you'll get
2139 You may have forgotten to load a package.
2140 In any case, this error message usually means that you used an undefined
2145 \begin_layout Standard
2146 There are other error and warning messages.
2147 Some are self-explanatory.
2148 These are usually \SpecialChar LaTeX
2150 Others are downright cryptic.
2151 These are usually \SpecialChar TeX
2152 error messages, and we really have
2156 what they mean or how to decipher them.
2160 \begin_layout Standard
2161 There's a general sequence you should follow if you get error messages:
2164 \begin_layout Enumerate
2165 Look at the \SpecialChar LaTeX
2166 code you inserted for typos.
2169 \begin_layout Enumerate
2170 If there are no typos, check that you used the command(s) correctly.
2173 \begin_layout Enumerate
2174 If you get a bunch of error boxes piled up at the very top of the document—and
2175 especially if you see a
2176 \begin_inset Quotes eld
2180 \begin_inset Flex Code
2183 \begin_layout Plain Layout
2192 \begin_inset Quotes erd
2195 error—it means that there are errors in the preamble.
2196 Start debugging your preamble.
2199 \begin_layout Enumerate
2200 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2202 document, the first suspect is your \SpecialChar LaTeX
2203 distribution itself.
2204 Check for missing packages and install them.
2207 \begin_layout Enumerate
2208 Okay, so there are no missing packages.
2209 Did you use any of the fine-tuning options in \SpecialChar LyX
2210 ? Specifically, did you
2214 any of them, like trying to manually insert lots of
2215 \begin_inset Flex Code
2218 \begin_layout Plain Layout
2220 \change_deleted 177693 1654669036
2222 \change_inserted 177693 1654669038
2226 \begin_inset space ~
2230 \change_deleted 177693 1654669040
2232 \change_inserted 177693 1654669041
2241 \begin_inset Flex Code
2244 \begin_layout Plain Layout
2251 \begin_inset Flex Code
2254 \begin_layout Plain Layout
2260 ? Did you try to kludge something together with these instead of using the
2261 appropriate paragraph environment?
2264 \begin_layout Enumerate
2265 All right, you didn't use any of the fine-tuning options, you played by
2267 Did you try to pull a fancy maneuver? Did you do something funky inside
2268 a table or an equation, like inserting a graphic into a table cell?
2271 \begin_layout Enumerate
2272 Do you have long sections of text where \SpecialChar LaTeX
2273 cannot find a place to break a
2274 line? By default, \SpecialChar LaTeX
2275 is rather strict about how much extra inter-word spacing
2276 it will add in order to break a line.
2277 Preferably, you should rework the paragraph to avoid the problem.
2280 \begin_layout Enumerate
2281 Did you go overboard with the nesting? \SpecialChar LyX
2282 (currently) doesn't check to make
2283 sure you're in the limits for nesting environments.
2284 If you nested a bunch of environments to the
2285 \begin_inset Formula $17^{\mathrm{th}}$
2288 level, that's the problem.
2289 (The limit in \SpecialChar LaTeX
2293 \begin_layout Enumerate
2294 Okay, you didn't get any error messages, but your output looks awful.
2295 If you have a table or figure that's too wide or long for the page, you
2300 \begin_layout Enumerate
2301 rescale the figure so it fits.
2304 \begin_layout Enumerate
2305 trim down the table so it fits.
2309 \begin_layout Enumerate
2310 If something else is wrong with the output, and you didn't try to pull anything
2311 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2314 \begin_layout Standard
2315 If all this doesn't help—well, then
2319 you might have found a bug in \SpecialChar LyX
2324 \begin_layout Chapter
2326 \change_inserted 564990737 1670439508
2330 \begin_layout Section
2332 \change_inserted 564990737 1670439533
2333 \begin_inset CommandInset label
2335 name "sec:Collections"
2342 \begin_layout Subsection
2343 AMS \SpecialChar LaTeX
2347 \begin_layout Standard
2354 Richard Kimberly Heck
2357 \begin_layout Standard
2358 \begin_inset VSpace bigskip
2364 \begin_layout Standard
2366 The AMS \SpecialChar LaTeX
2367 layouts are set up to conform to suggested styles for mathematical
2368 papers to be submitted to American Mathematical Society publications.
2369 The layouts are not tailored to a specific journal, but easily can be.
2370 You should refer to the AMS documentation for specific instructions for
2371 each journal (usually it will entail only changing a single line in the
2374 That documentation is available on the Web at
2375 \begin_inset Flex URL
2378 \begin_layout Plain Layout
2386 \begin_inset Flex URL
2389 \begin_layout Plain Layout
2391 ftp://ftp.ams.org/pub/tex/amslatex/
2397 These layouts are appropriate, and useful, for any mathematical writing.
2401 \begin_layout Standard
2402 There are two basic AMS \SpecialChar LaTeX
2406 \begin_layout Itemize
2407 amsart: The standard AMS article format.
2410 \begin_layout Itemize
2411 amsbook: the standard AMS book (really, monograph) format.
2415 \begin_layout Standard
2416 The layouts themselves contain only the minimum necessary to use the AMS
2418 They do not, in particular, contain any of the `theorem' environments used
2419 for setting theorems, lemmas, and the like.
2420 These are contained, instead, in the
2421 \begin_inset Flex Code
2424 \begin_layout Plain Layout
2430 module, which is loaded by default when you select one of the AMS classes.
2431 (It can also be used with other classes and can be removed, if you would
2432 rather use something else.) Less commonly used environments are in the
2433 \begin_inset Flex Code
2436 \begin_layout Plain Layout
2437 Theorems (AMS-Extended)
2442 module, which must be loaded manually.
2445 \begin_layout Standard
2446 By default, theorems and the like are numbered consecutively throughout
2447 the document, but this may be modified by loading the module
2448 \begin_inset Flex Code
2451 \begin_layout Plain Layout
2452 Theorems (Order by Section)
2457 or, if you are using
2458 \begin_inset Flex Code
2461 \begin_layout Plain Layout
2468 \begin_inset Flex Code
2471 \begin_layout Plain Layout
2472 Theorems (Order by Chapter)
2478 These will number the results as
2479 \begin_inset Formula $n.m$
2482 , where the first number refers to the section (or chapter) and the second
2483 refers to the total number of results so far in that section (or chapter).
2484 Many environments are also available unnumbered.
2485 These are indicated by an asterisk at the end.
2486 If you happen to want
2490 unnumbered results, the module
2491 \begin_inset Flex Code
2494 \begin_layout Plain Layout
2500 provides that option.
2503 \begin_layout Standard
2504 Note that these modules do not
2508 to be used with the AMS classes.
2509 It is perfectly possible to use the
2510 \begin_inset Flex Code
2513 \begin_layout Plain Layout
2519 module, and the others mentioned, with other classes, such as
2520 \begin_inset Flex Code
2523 \begin_layout Plain Layout
2530 \begin_inset Flex Code
2533 \begin_layout Plain Layout
2540 \begin_inset Flex Code
2543 \begin_layout Plain Layout
2552 \begin_layout Subsubsection
2553 What these layouts provide
2556 \begin_layout Standard
2557 There is a long list of included environments provided by these layouts.
2558 In AMS-\SpecialChar LaTeX
2559 , there is, in fact, an opportunity to define an unlimited variety
2560 of `theorem' environments.
2561 However, the AMS recommends the environments that are available in \SpecialChar LyX
2566 \begin_layout Standard
2567 The following environments—as well as the standard environments, such as
2569 \begin_inset Flex Noun
2572 \begin_layout Plain Layout
2579 \begin_inset Flex Noun
2582 \begin_layout Plain Layout
2589 \begin_inset Flex Noun
2592 \begin_layout Plain Layout
2599 \begin_inset Flex Noun
2602 \begin_layout Plain Layout
2609 \begin_inset Flex Noun
2612 \begin_layout Plain Layout
2619 \begin_inset Flex Code
2622 \begin_layout Plain Layout
2629 \begin_inset Flex Code
2632 \begin_layout Plain Layout
2641 \begin_layout Description
2642 Address This should be the author's permanent address.
2645 \begin_layout Description
2647 \begin_inset space ~
2650 Address This should be the author's temporary address at the time of submission,
2651 if different from the Address.
2654 \begin_layout Description
2655 Email Author's e-mail address
2658 \begin_layout Description
2659 URL Author's Web address, if desired.
2662 \begin_layout Description
2663 Keywords Key words or phrases used to identify specific topics discussed
2667 \begin_layout Description
2668 Subjectclass These refer to the AMS Subject Classifications, published and
2671 Mathematical Reviews
2674 These are also available online at the AMS cites listed above.
2677 \begin_layout Description
2681 \begin_layout Description
2685 \begin_layout Description
2689 \begin_layout Standard
2690 The following environments are provided by both the
2691 \begin_inset Flex Code
2694 \begin_layout Plain Layout
2701 \begin_inset Flex Code
2704 \begin_layout Plain Layout
2710 modules, in the latter case in both starred (unnumbered) and unstarred
2711 (numbered) versions.
2712 These same environments are provided only in the starred versions by the
2714 \begin_inset Flex Code
2717 \begin_layout Plain Layout
2726 \begin_layout Theorem
2727 This is typically used for the statements of major results.
2731 \begin_layout Corollary*
2732 This is used for statements which follow fairly directly from previous statement
2734 Again, these can be major results.
2739 These are smaller results needed to prove other statements.
2742 \begin_layout Proposition
2743 These are less major results which (hopefully) add to the general theory
2747 \begin_layout Conjecture
2748 These are statements provided without justification, which the author does
2749 not know how to prove, but which seem to be true (to the author, at least).
2752 \begin_layout Definition*
2753 Guess what this is for.
2754 The font is different for this environment than for the previous ones.
2758 \begin_layout Example*
2759 Used for examples illustrating proven results.
2762 \begin_layout Problem
2763 It's not really known what this is for.
2764 You should figure it out.
2767 \begin_layout Exercise*
2768 Write a description for this one.
2771 \begin_layout Remark
2772 This environment is also a type of theorem, usually a lesser sort of observation.
2775 \begin_layout Claim*
2776 Often used in the course of giving a proof of a larger result.
2780 Generally, these are used to break up long arguments, using specific instances
2786 The numbering scheme for cases is on its own, not together with other numbered
2792 At the end of this environment, a QED symbol (usually a square, but it can
2793 vary with different styles) is placed.
2794 If you want to have other environments within this one—for example, Case
2795 environments—and have the QED symbol appear only after them, then the other
2796 environments need to be nested within the proof environment.
2799 Nesting Environments
2805 for information on nesting.
2808 \begin_layout Standard
2809 And these environments are provided by
2810 \begin_inset Flex Code
2813 \begin_layout Plain Layout
2814 Theorems (AMS-Extended)
2822 \begin_layout Criterion*
2823 A required condition.
2826 \begin_layout Algorithm*
2827 A general procedure to be used.
2830 \begin_layout Axiom*
2831 This is a property or statement taken as true within the system being discussed.
2834 \begin_layout Condition*
2835 Sometimes used to state a condition assumed within the present context of
2840 Similar to a Remark.
2843 \begin_layout Notation*
2844 Used for the explanation of, yes, notation.
2847 \begin_layout Summary
2848 Do we really need to tell you?
2851 \begin_layout Acknowledgement*
2855 \begin_layout Conclusion*
2856 Sometimes used at the end of a long train of argument.
2860 Used in a way similar to Proposition, though perhaps lower on the scale.
2863 \begin_layout Standard
2864 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
2867 They need to be available on your system in order to use these environments.
2870 \begin_layout Subsection
2874 \begin_layout Standard
2880 \begin_layout Subsubsection
2884 \begin_layout Standard
2885 The \SpecialChar LyX
2888 article (koma-script)
2892 report (koma-script)
2910 correspond to the \SpecialChar LaTeX
2928 \begin_inset space ~
2931 of the Koma-Script family.
2932 They are replacements for the standard document classes
2948 , resp., and fit better to European typography conventions in a number of
2952 \begin_layout Itemize
2953 Standard character size is 11pt in
2955 article (koma-script)
2959 report (koma-script)
2967 letter (koma-script)
2972 \begin_layout Itemize
2973 Headings, labels of the description environment, and a number of elements
2976 letter (koma-script)
2978 document class are set in a bold sans serif font.
2982 \begin_layout Plain Layout
2983 There is a big difference between the bold sans serif old cm fonts and new
2984 ec fonts, especially in the appearance of headings.
2985 In comparison, the ec bold sans serif fonts look a bit thin.
2986 Here the \SpecialChar LaTeX
2995 helps to produce the
2996 \begin_inset Quotes eld
3000 \begin_inset Quotes erd
3003 appearance when using the ec fonts.
3008 The numbering of chapter headings is made in the same way as the numbering
3009 of section headings, that is without the extra line
3010 \begin_inset Quotes eld
3013 Chapter\SpecialChar ldots
3015 \begin_inset Quotes erd
3019 In addition, the appearance of the headings can be modified by using a
3020 number of options (in \SpecialChar LyX
3021 to be entered in the field
3024 \begin_inset space ~
3031 Layout\SpecialChar menuseparator
3038 \begin_layout Itemize
3039 The main means in the Koma-Script document classes to design the type area
3048 (in \SpecialChar LyX
3049 to be entered in the extra class options field in the dialog
3051 Document\SpecialChar menuseparator
3055 They make a clearer modification of page margins possible as do the options
3058 Document\SpecialChar menuseparator
3065 \begin_layout Itemize
3066 The \SpecialChar LaTeX
3067 document classes of the Koma-Script family define a number of additional
3069 Those part of it which makes sense in \SpecialChar LyX
3070 is implemented in corresponding
3074 \begin_layout Standard
3075 Detailed descriptions of the \SpecialChar LaTeX
3076 document classes of the Koma-Script family
3077 can be found in the Koma-Script documentation
3088 \begin_layout Subsubsection
3089 article (koma-script), report (koma-script), and book (koma-script)
3092 \begin_layout Standard
3093 The document classes
3095 article (koma-script)
3099 report (koma-script)
3109 are implemented in the layout files
3122 They contain all the paragraph types of the corresponding standard document
3135 , resp., partly modified, with the exception of the \SpecialChar LyX
3140 -type, which is replaced by the new
3144 -type having the same functionality.
3149 -Type there is a number of new paragraph types added.
3156 letter (koma-script)
3161 \begin_layout Itemize
3170 : are equivalents to
3178 , resp., additionally inserting an entry in the table of contents.
3187 are not contained in
3189 article (koma-script)
3194 \begin_layout Itemize
3211 , resp., additionally clearing running heads.
3218 article (koma-script)
3224 \begin_layout Plain Layout
3237 report (koma-script)
3239 , but since this is identical to
3243 , is has not been implemented in \SpecialChar LyX
3252 \begin_layout Itemize
3257 : generates a heading directly above the following paragraph in the standard
3258 character size without affecting the structure of the document.
3261 \begin_layout Itemize
3270 are special captions which respect the different space settings needed
3271 for captions placed above or below an element (if you follow strict typographic
3272 rules, you might want to place table captions always above the table).
3273 You can also use the class option
3290 You need at least Koma-Script version 2.8q to use this.
3293 \begin_layout Itemize
3298 : can be used to set a bonmot, e.
3299 \begin_inset space \thinspace{}
3303 \begin_inset space \space{}
3306 at the beginning of a chapter.
3307 If you use the optional argument (
3309 Insert\SpecialChar menuseparator
3311 \begin_inset space ~
3316 ), you can insert the dictum's author there.
3317 Dictum and author are separated by a line.
3318 You need at least Koma-Script version 2.8q to use this.
3325 article (koma-script)
3330 \begin_layout Standard
3331 The following types, together with the standard types
3343 , form the title area of the document.
3344 They must be entered ahead of the first
3345 \begin_inset Quotes eld
3349 \begin_inset Quotes erd
3356 \begin_layout Plain Layout
3357 The corresponding \SpecialChar LaTeX
3358 commands must appear before the
3369 When such a type is used more than once, the latter usage overwrites the
3370 former one, that means, for every type only the latest usage is valid.
3371 The order of the different types however has, like
3383 , no effect on the appearance of the produced document.
3386 \begin_layout Itemize
3391 : produces a centered paragraph above the ordinary title (
3403 ) for the subject of the document.
3406 \begin_layout Itemize
3411 : produces a centered paragraph below the ordinary title (
3423 ) for the publishers' name.
3426 \begin_layout Itemize
3433 report (koma-script)
3439 produces a centered paragraph on its own page behind the title page, or
3442 article (koma-script)
3444 produces a centered paragraph below the ordinary title (
3463 \begin_layout Itemize
3468 : produces a left aligned paragraph above the ordinary title (
3484 ) for a document`s head.
3487 \begin_layout Itemize
3492 : produces in a double-sided print in
3494 report (koma-script)
3500 a left-aligned paragraph at the top of the title page`s back or has no
3501 effect in a single-sided print or in
3503 article (koma-script)
3508 \begin_layout Itemize
3513 : produces in a double-sided print in
3515 report (koma-script)
3521 a left-aligned paragraph at the bottom of the title page`s back or has
3522 no effect in a single-sided print or in
3524 article (koma-script)
3529 \begin_layout Itemize
3534 : produces a special
3535 \begin_inset Quotes eld
3539 \begin_inset Quotes erd
3542 page ahead of the actual document containing a paragraph without special
3546 \begin_layout Standard
3547 The layout files for the document classes
3549 article (koma-script)
3553 report (koma-script)
3564 This is thought of as a place to define your own types.
3569 in your personal layout directory and edit the file!
3572 \begin_layout Subsubsection
3573 letter (koma-script)
3576 \begin_layout Description
3577 Note: This section discusses the obsolete
3579 KOMA-Script-Letter (v.
3580 \begin_inset space ~
3585 , which is not even included anymore in recent KOMA releases.
3586 Please refer to the next section for the current KOMA-Script-Letter class
3588 \begin_inset space ~
3594 \begin_layout Standard
3598 letter (koma-script)
3600 is implemented in the layout file
3605 It contains all the paragraph types of the corresponding standard document
3610 , partly modified, with the exception of the \SpecialChar LyX
3624 type, which is replaced by the new
3629 In addition, it contains, in contrast to the standard document class, the
3648 Furthermore, there are a number of new letter specific types.
3651 \begin_layout Standard
3652 The appearance of the letter produced by this document class can be controlled
3653 by a number of \SpecialChar LaTeX
3654 commands, which you can put in the \SpecialChar LaTeX
3659 \begin_layout Plain Layout
3660 For example, the standard appearance of the letter`s heading, consisting
3661 of name and address, is quite self-willed.
3663 \begin_inset Quotes eld
3667 \begin_inset Quotes erd
3670 heading is produced by the following \SpecialChar LaTeX
3671 commands in the preamble:
3674 \begin_layout LyX-Code
3684 \begin_layout LyX-Code
3700 \begin_layout LyX-Code
3710 \begin_layout LyX-Code
3730 A detailed German description of such \SpecialChar LaTeX
3731 commands can be found in the Koma-Script
3737 With it, the letter's author can produce his personal letter layout.
3740 \begin_layout Standard
3749 define the beginning of the letter and must be used in every letter.
3750 To emphasize them in the \SpecialChar LyX
3751 document class, they are marked with the letter
3761 \begin_inset space ~
3765 It is possible to write any number of letters in one file.
3770 type produces a new letter using the same addressee and a
3774 type produces a new addressee.
3791 are ordinary paragraph types and can also be used several times in one
3792 and the same letter.
3795 \begin_layout Itemize
3800 : produces a paragraph for the addressee and implicitly defines the beginning
3804 \begin_layout Itemize
3809 : produces a paragraph for the form of address and implicitly produces a
3813 \begin_layout Itemize
3818 : produces a paragraph for a close.
3821 \begin_layout Itemize
3826 : produces a paragraph for a postscript.
3829 \begin_layout Itemize
3834 : produces a paragraph for a distribution list.
3837 \begin_layout Itemize
3842 : produces a paragraph for enclosures.
3845 \begin_layout Standard
3886 are input types provided with a label to enter information, which will
3887 be processed by the document class.
3891 \begin_layout Plain Layout
3892 It could be seen as a matter of inconsequence, that the types
3900 described above are not such input types as well.
3901 Because of the special meaning of those types, however, I have implemented
3902 them as ordinary paragraph types with a one letter mark in the left margin.
3903 Moreover, it would affect my feeling of symmetry, if the
3911 type had such a serious different appearance.
3916 The types must be used ahead of the corresponding
3923 \begin_layout Standard
3924 An implementation of these types in a WYSIWYG fashion does not seem to make
3925 sense, because the real appearance of the produced letter does not only
3926 depend on the usage of the particular type, but also on other factors.
3927 For example, a signature entered in the
3931 type will in the standard behavior appear in the produced letter only,
3932 when in the same letter also a
3937 The entered value of the
3941 type will in the standard behavior not appear in the produced letter at
3943 The possibility to design the letter`s heading freely is already indicated
3944 in a footnote above.
3947 \begin_layout Standard
3948 The input types can also be used as empty paragraphs.
3950 \begin_inset space \thinspace{}
3954 \begin_inset space \space{}
3966 type is not used at all, in the standard behavior the value of the
3970 type is used as signature, whereas if an empty
3974 type is used, no signature value is defined.
3977 \begin_layout Standard
3978 By using the input types it is possible to write a letter template, containing
3979 filled input types with your personal dates (name, address, etc.) and empty
3980 input types for other dates you want to enter.
3983 \begin_layout Itemize
3988 : sender's name, in the standard behavior appears as a centered paragraph
3989 in small caps in the letter`s heading.
3992 \begin_layout Itemize
3997 : sender's signature, in the standard behavior appears below the
4006 type is used, the value of the
4010 type appears instead.
4013 \begin_layout Itemize
4018 : sender's address, in the standard behavior appears in a centered paragraph
4019 in the letter`s heading below the sender's name.
4022 \begin_layout Itemize
4027 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
4038 \begin_layout Itemize
4043 : place of the letter`s making.
4046 \begin_layout Itemize
4051 : date of the letter`s making.
4060 , in the standard behavior, produce the place and the date in a right-aligned
4061 line below the addressee's field.
4066 type is used, neither place nor date appear, independent of the value of
4076 type is used, the date of the letter `s production is used.
4079 \begin_layout Itemize
4084 : sender`s back address, in the standard behavior appears above the addressee's
4085 field in a small sans serif font.
4088 \begin_layout Itemize
4093 : special mail information, in the standard behavior appears underlined
4094 above the addressee's field below the back address.
4097 \begin_layout Itemize
4102 : additional information, in the standard behavior appears on right side
4103 below the addressee`s field.
4106 \begin_layout Itemize
4111 : the letter's title, in the standard behavior appears in a big, bold, sans
4112 serif font above the subject.
4115 \begin_layout Itemize
4120 : the letter's subject, in the standard behavior appears in a bold font
4128 \begin_layout Standard
4149 produce a business letter like line above the
4153 line containing the fields
4154 \begin_inset Quotes eld
4158 \begin_inset Quotes erd
4162 \begin_inset Quotes eld
4166 \begin_inset Quotes erd
4170 \begin_inset Quotes eld
4174 \begin_inset Quotes erd
4178 \begin_inset Quotes eld
4182 \begin_inset Quotes erd
4186 \begin_inset Quotes eld
4190 \begin_inset Quotes erd
4194 \begin_inset Quotes eld
4198 \begin_inset Quotes erd
4202 For the date field, the value of the
4208 \begin_inset Quotes eld
4211 business letter types
4212 \begin_inset Quotes erd
4215 is used, the value of the
4219 type however does not appear, but only the \SpecialChar LaTeX
4227 The ordinary output of place and date in a right-aligned line below the
4228 addressee`s field is suppressed.
4229 The types are implemented as input types provided with a label and must
4230 be used ahead of the corresponding
4237 \begin_layout Itemize
4245 \begin_layout Itemize
4253 \begin_layout Itemize
4261 \begin_layout Itemize
4269 \begin_layout Itemize
4277 \begin_layout Subsubsection
4278 The new letter class: letter (koma-script v.2)
4281 \begin_layout Standard
4287 \begin_layout Standard
4288 \begin_inset VSpace medskip
4294 \begin_layout Standard
4296 Koma-Script version 2.8 has introduced a new letter class
4300 which supersedes the now unsupported
4305 It has — on the \SpecialChar LaTeX
4306 side — a completely new interface and is not compatible
4308 Therefore, \SpecialChar LyX
4309 supports both, though it is recommended you use the new class.
4312 \begin_layout Standard
4313 This class covers the same functionality as
4315 letter (koma-script),
4322 (receiver's address, same as
4339 will start a new letter (i.
4340 \begin_inset space \thinspace{}
4344 \begin_inset space \space{}
4347 you can write several letters per document).
4348 New elements are sender's
4364 and the possibility to use a
4370 Insert\SpecialChar menuseparator
4376 \begin_layout Standard
4377 The biggest improvement is, though, that the letter's layout is configurable
4378 to meet almost any needs.
4379 This can be done via the preamble or with a special style file (Letter
4380 Class Option, extension
4384 ), that will be read in as a class option.
4388 \begin_layout Plain Layout
4389 The KOMA package comes with some default
4394 There is, for instance, a
4398 file that follows german typesetting rules, or a
4402 that provides the default layout of the old
4407 The latter can be loaded with the class option
4413 Layout\SpecialChar menuseparator
4414 Document\SpecialChar menuseparator
4426 template that is included in \SpecialChar LyX
4428 A detailed description is to be found in the Koma-Script documentation
4436 \begin_layout Subsubsection
4440 \begin_layout Standard
4441 Visualizing the Koma-Script document classes in \SpecialChar LyX
4442 , the \SpecialChar LyX
4443 internals cause some
4447 \begin_layout Itemize
4448 The chapter number of a
4452 type appears on a line of its own above the chapter heading instead of
4453 appearing in the same line ahead of it.
4454 The cause for that is the \SpecialChar LyX
4455 internal behavior for the labeltype
4462 \begin_layout Itemize
4463 The headings of the types
4472 \begin_inset Quotes eld
4476 \begin_inset Quotes erd
4480 table of contents, but not in the \SpecialChar LyX
4483 Document\SpecialChar menuseparator
4485 \begin_inset space ~
4489 \begin_inset space ~
4497 \begin_layout Itemize
4502 document class appear in a skip separation mode, not indented.
4503 This is the standard behavior, no special \SpecialChar LaTeX
4504 commands are needed for that.
4507 Document\SpecialChar menuseparator
4510 dialog the corresponding radio button indicates
4519 value always has the effect that extra \SpecialChar LaTeX
4520 commands are inserted in the document
4521 to produce the gap, which is not what is wanted in this case.
4524 \begin_layout Section
4526 \change_inserted 564990737 1670439534
4530 \begin_layout Standard
4532 \change_inserted 564990737 1670439557
4533 See also the document classes in the Collections (section
4534 \begin_inset space ~
4538 \begin_inset CommandInset ref
4540 reference "sec:Collections"
4547 \begin_layout Section
4549 \change_inserted 564990737 1670439560
4553 \begin_layout Standard
4555 \change_inserted 564990737 1670439581
4556 See also the document classes in the Collections (section
4557 \begin_inset space ~
4561 \begin_inset CommandInset ref
4563 reference "sec:Collections"
4570 \begin_layout Subsection
4574 \begin_layout Standard
4580 \begin_layout Subsubsection
4584 \begin_layout Standard
4585 Memoir is a very powerful and constantly evolving class.
4586 It has been designed with regard to fictional and non-fictional literature.
4587 Its aim is to let the user have maximum control over the typesetting of
4589 Memoir is based on the standard book class, but it can also emulate the
4590 article class (see below).
4593 \begin_layout Standard
4594 Peter Wilson, the developer of Memoir, is known as the author of lots of
4595 useful packages in the \SpecialChar LaTeX
4597 Most of them have been merged with Memoir.
4598 Therefore, it is much easier to layout the table of contents, appendices,
4599 chapter designs and such.
4601 , though, does not support all of these goodies natively.
4602 Some of them might be added to forthcoming releases
4606 \begin_layout Plain Layout
4607 You are invited to send suggestions to
4608 \begin_inset Flex URL
4611 \begin_layout Plain Layout
4613 lyx-devel@lists.lyx.org
4623 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
4625 Of course you can still use all features with the help of some native \SpecialChar LaTeX
4627 commands (\SpecialChar TeX
4632 \begin_layout Plain Layout
4637 \begin_layout Plain Layout
4647 \begin_inset space ~
4651 \begin_inset CommandInset ref
4653 reference "sec:Inserting-TeX-Code"
4663 In this section, we can only list those features that are natively supported
4666 For detailed descriptions (and for the rest of features) we recommend you
4667 have a look at the detailed manual of the Memoir class
4671 \begin_layout Plain Layout
4676 \begin_layout Plain Layout
4686 \begin_inset Flex URL
4689 \begin_layout Plain Layout
4691 CTAN:/macros/latex/memoir/memman.pdf
4701 , which is not only a user guide for the class, but also both a comprehensive
4702 description on good typesetting and a superb example for good typesetting
4706 \begin_layout Subsubsection
4707 Basic features and restrictions
4710 \begin_layout Standard
4711 Memoir supports basically all features of the standard book classes.
4712 There are, however, some differences, as follows:
4715 \begin_layout Description
4717 \begin_inset space ~
4720 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
4723 \begin_layout Description
4725 \begin_inset space ~
4728 style: The fancy page style is not supported, due to a command clash between
4729 Memoir and the fancyhdr package (they both define a command with the same
4730 name, which confuses \SpecialChar LaTeX
4732 Instead, Memoir comes with a number of its own page styles (see
4734 Document\SpecialChar menuseparator
4735 Settings\SpecialChar menuseparator
4737 \begin_inset space ~
4743 If you want to use these for the chapter pages, you have to use the command
4750 in the main text or in preamble (e.
4751 \begin_inset space \thinspace{}
4755 \begin_inset space \space{}
4762 chapterstyle{companion}
4767 \begin_layout Description
4768 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
4769 optional argument in the standard classes.
4770 With this, you can specify an alternative version of the title for the
4771 table of contents and the headers (for instance, if the title is too long).
4773 , you can do this via
4775 Insert\SpecialChar menuseparator
4777 \begin_inset space ~
4782 at the beginning of a chapter/section.
4783 Memoir features a second optional argument and thus separates the table
4784 of contents from the header.
4785 You can define three variants of a title with this: one for the main text,
4786 one for the table of contents, and one for the headers.
4788 makes these available in form of specific
4799 \begin_layout Description
4800 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
4801 of contents, the list of figures and the list of table start a new page
4803 Memoir does not follow this route.
4804 You have to insert a page break yourself, if you want to have one.
4807 \begin_layout Description
4808 Titlepage: For some unknown reason, Memoir uses pagination on the title
4809 page (in the standard classes, title pages are
4810 \begin_inset Quotes eld
4814 \begin_inset Quotes erd
4818 If you want an empty title page, type
4822 aliaspagestyle{title}{empty}
4827 \begin_layout Description
4828 Article: With the class option
4834 Document\SpecialChar menuseparator
4835 Settings\SpecialChar menuseparator
4836 Class Settings\SpecialChar menuseparator
4838 \begin_inset space ~
4843 ), you can emulate article style.
4844 That is, counters (footnotes, figures, tables etc.) will not be reset on
4845 new chapters, chapters don't start a new page (but are—in contrary to
4846 \begin_inset Quotes eld
4850 \begin_inset Quotes erd
4853 article classes—still allowed), parts, though, use their own page, as in
4857 \begin_layout Description
4858 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
4859 font commands, which have been used in the old \SpecialChar LaTeX
4861 \begin_inset space \thinspace{}
4865 \begin_inset space \space{}
4881 It produces an error and stops \SpecialChar LaTeX
4882 whenever such a command appears.
4887 reallows the commands and spits out warnings instead (which does at least
4888 not stop \SpecialChar LaTeX
4890 Since a lot of packages and particularly Bib\SpecialChar TeX
4891 style files are still using
4892 those commands, we have decided to use this option by default.
4895 \begin_layout Subsubsection
4899 \begin_layout Standard
4900 We will only describe the features supported by \SpecialChar LyX
4901 (which is not much currently).
4902 Please consult the Memoir manual
4906 \begin_layout Plain Layout
4911 \begin_layout Plain Layout
4921 \begin_inset Flex URL
4924 \begin_layout Plain Layout
4926 CTAN:/macros/latex/memoir/memman.pdf
4939 \begin_layout Description
4940 Abstract: You may wonder why an abstract is an extra feature.
4941 Well, it is in book class.
4942 Usually books don't have abstracts.
4943 Memoir, however, has.
4944 You can use it wherever and how often you like.
4947 \begin_layout Description
4948 Chapterprecis: You may know this older typesetting style: The contents of
4949 a chapter are summarized below the title and also in the table of contents
4951 \begin_inset space \thinspace{}
4955 \begin_inset space \space{}
4960 Our hero arrives in Troia; he loses some friends; he finds others
4963 Chapterprecis does exactly this.
4964 It is therefore only sensible below a chapter.
4967 \begin_layout Description
4968 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
4969 The epigraph environment provides an elegant way of typesetting such a
4971 The motto itself (text) and its (optional) author (source) are divided
4973 The author (source) can be inserted via
4975 Insert\SpecialChar menuseparator
4982 \begin_layout Description
4983 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
4984 complex figurative poems).
4986 can only support a few of them.
4987 One is poemtitle, which is a centered title for poems, which will also
4988 be added to the table of contents (verse is the standard environment for
4990 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
4992 because they have to be nested inside regular verse environments, which
4993 is not possible with \SpecialChar LyX
4997 \begin_layout Description
4998 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
5001 \begin_layout Section
5003 \change_inserted 564990737 1670439605
5007 \begin_layout Section
5009 \change_inserted 564990737 1670439627
5013 \begin_layout Section
5015 \change_inserted 564990737 1670439660
5019 \begin_layout Section
5021 \change_inserted 564990737 1670439661
5025 \begin_layout Subsection
5027 \change_inserted 564990737 1670439661
5031 \begin_layout Standard
5033 \change_inserted 564990737 1670439661
5042 document class for preparing reports.
5047 document class, this provides parts, chapters and sections but does not
5048 provide the paragraph styles needed for a book; like the
5052 document class, it provides the abstract paragraph style.
5053 In two-sided mode, it does not start a new chapter on the right hand page.
5056 \begin_layout Standard
5058 \change_inserted 564990737 1670439674
5063 document classes are described in the Collections (section
5064 \begin_inset space ~
5068 \begin_inset CommandInset ref
5070 reference "sec:Collections"
5077 \begin_layout Section
5079 \change_inserted 564990737 1670439674
5083 \begin_layout Subsection
5087 \begin_layout Standard
5093 \begin_layout Subsubsection
5097 \begin_layout Standard
5098 Broadway is for writing plays.
5099 The format is more decorative than Hollywood, and much less standardized.
5100 This format should be suitable for workshops.
5103 \begin_layout Subsubsection
5107 \begin_layout Standard
5108 The same as in Hollywood.
5111 \begin_layout Subsubsection
5115 \begin_layout Standard
5120 names as labels then cross-reference the label to insert the name.
5121 The cross-reference dialog will show the current cast of characters.
5124 \begin_layout Subsubsection
5125 Paper size and Margins
5128 \begin_layout Standard
5129 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
5132 \begin_layout Subsubsection
5136 \begin_layout Standard
5137 The following environments are available.
5138 You can use broadway.bind to get the bind keys shown at the right.
5141 \begin_layout Itemize
5145 \begin_inset Newline newline
5150 You should not have to use this, but it is here for anything that does not
5154 \begin_layout Itemize
5158 \begin_inset space \hfill{}
5162 \begin_inset Newline newline
5167 Used to describe stage setting and the action.
5168 First use of speaker names in all CAPs.
5171 \begin_layout Itemize
5175 \begin_inset space \hfill{}
5179 \begin_inset Newline newline
5184 Automatically numbered.
5185 On screen it will be arabic, but will print as Roman.
5188 \begin_layout Itemize
5192 \begin_inset space \hfill{}
5196 \begin_inset Newline newline
5206 It is just centered text.
5209 \begin_layout Itemize
5213 \begin_inset space \hfill{}
5217 \begin_inset Newline newline
5222 Not automatically numbered.
5223 You supply the number.
5224 This is because I couldn't figure out how.
5227 \begin_layout Itemize
5231 \begin_inset space \hfill{}
5235 \begin_inset Newline newline
5240 A special case of Narrative to describe the setting and action as the curtain
5244 \begin_layout Itemize
5248 \begin_inset space \hfill{}
5252 \begin_inset Newline newline
5257 The speaker's (actor's) title, centered in all CAPS.
5260 \begin_layout Itemize
5264 \begin_inset space \hfill{}
5268 \begin_inset Newline newline
5273 Instructions to the speaker.
5274 The parentheses are automatically inserted.
5275 The ( will appear on screen, but both will be in the printed play.
5276 This environment is only used within
5283 \begin_layout Itemize
5287 \begin_inset space \hfill{}
5291 \begin_inset Newline newline
5296 What the Speaker says.
5299 \begin_layout Itemize
5303 \begin_inset space \hfill{}
5307 \begin_inset Newline newline
5312 The curtain comes down.
5315 \begin_layout Itemize
5319 \begin_inset space \hfill{}
5325 \begin_layout Itemize
5329 \begin_inset space \hfill{}
5335 \begin_layout Itemize
5339 \begin_inset space \hfill{}
5345 \begin_layout Standard
5349 \begin_layout Subsection
5350 Hollywood (Hollywood spec scripts)
5353 \begin_layout Standard
5359 \begin_layout Subsubsection
5363 \begin_layout Standard
5364 Getting the format of a Hollywood script right is a
5365 \begin_inset Quotes eld
5369 \begin_inset Quotes erd
5372 It is designed to make the readers focus on content and to be easy and
5373 familiar for the actors to read.
5374 Each page of a script should be one minute of film.
5375 Nothing goes in a script that you cannot see or hear on screen.
5376 The courier 12 pt font should be used throughout.
5380 \begin_layout Subsubsection
5384 \begin_layout Standard
5385 Speakers' lines should NEVER break in mid-sentence.
5386 If a speaker's lines continue over a page break, repeat the
5390 title followed by (Cont'd).
5393 \begin_layout Subsubsection
5397 \begin_layout Standard
5402 names as labels then cross-reference the label to insert the name.
5403 The cross-reference dialog will show the current cast of characters.
5404 You can use this to insert the speaker name in narratives also.
5407 \begin_layout Subsubsection
5408 Paper size and Margins
5411 \begin_layout Standard
5412 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
5415 \begin_layout Subsubsection
5419 \begin_layout Standard
5420 The following environments are available.
5421 You can use hollywood.bind to get the bind keys shown at the right.
5424 \begin_layout Itemize
5428 \begin_inset Newline newline
5433 Used where nothing else works.
5437 \begin_layout Itemize
5443 \begin_inset space \hfill{}
5451 \begin_inset Newline newline
5454 Usually followed by something like
5455 \begin_inset Quotes eld
5459 \begin_inset Quotes erd
5465 \begin_layout Itemize
5469 \begin_inset space \hfill{}
5473 \begin_inset Newline newline
5478 Introduces a new INTERIOR camera set-up.
5479 Always followed by DAY or NIGHT, or something similar to define the lighting
5481 Everthing on this line in CAPS.
5484 \begin_layout Itemize
5488 \begin_inset space \hfill{}
5492 \begin_inset Newline newline
5497 Introduces a new EXTERIOR camera set-up.
5498 Everthing on this line in CAPS.
5501 \begin_layout Itemize
5505 \begin_inset space \hfill{}
5509 \begin_inset Newline newline
5514 The character speaking.
5517 \begin_layout Itemize
5521 \begin_inset space \hfill{}
5525 \begin_inset Newline newline
5530 Instructions to the speaker.
5531 The () are automatically inserted.
5534 \begin_layout Itemize
5538 \begin_inset space \hfill{}
5542 \begin_inset Newline newline
5554 \begin_layout Itemize
5558 \begin_inset space \hfill{}
5562 \begin_inset Newline newline
5567 Camera movement instruction.
5569 \begin_inset space \thinspace{}
5573 \begin_inset space \space{}
5579 \begin_layout Itemize
5583 \begin_inset space \hfill{}
5589 \begin_layout Itemize
5593 \begin_inset space \hfill{}
5599 \begin_layout Itemize
5603 \begin_inset space \hfill{}
5609 \begin_layout Itemize
5613 \begin_inset space \hfill{}
5619 \begin_layout Subsubsection
5623 \begin_layout Itemize
5627 \begin_layout Itemize
5631 \begin_layout Itemize
5633 \begin_inset space \thinspace{}
5640 \begin_layout Itemize
5645 \begin_layout Itemize
5646 PAN — camera movement
5649 \begin_layout Itemize
5650 INSERT — cut to close-up of
5653 \begin_layout Chapter
5657 \begin_layout Section
5658 Customizing Bibliographies with Bib\SpecialChar TeX
5662 \begin_layout Standard
5663 The most basic information about how to use Bib\SpecialChar TeX
5668 with \SpecialChar LyX
5669 is contained in the section
5671 Bibliography databases
5678 The following subsections explain special bibliography features supported
5683 \begin_layout Subsection
5684 Alternative Citation Styles
5687 \begin_layout Standard
5688 Standard Bib\SpecialChar TeX
5690 \begin_inset space \thinspace{}
5694 \begin_inset space \space{}
5698 \begin_inset Quotes eld
5702 \begin_inset Quotes erd
5705 ) to refer to a cited work.
5706 However, in many scientific disciplines, other citation styles are in use.
5707 The most common one is the author-year style (e.
5708 \begin_inset space \thinspace{}
5712 \begin_inset space \space{}
5716 \begin_inset Quotes eld
5720 \begin_inset Quotes erd
5725 supports three packages that provide this style,
5726 \begin_inset Flex Code
5729 \begin_layout Plain Layout
5736 \begin_inset Flex Code
5739 \begin_layout Plain Layout
5746 \begin_inset Flex Code
5749 \begin_layout Plain Layout
5756 Each of these packages has their pros and cons, which cannot be listed
5758 If you only want to have simple author-year (or author-numerical) style,
5759 or if you want to use one of the countless style files for
5760 \begin_inset Flex Code
5763 \begin_layout Plain Layout
5769 , then the established
5770 \begin_inset Flex Code
5773 \begin_layout Plain Layout
5779 package is probably your choice.
5780 If you look for specific citation styles common in law studies, you might
5782 \begin_inset Flex Code
5785 \begin_layout Plain Layout
5792 If you want to have full control over the formatting or look for advanced
5793 features such as ibidem, footnote citations, full title citations, advanced
5794 date formats (such as 400 BC) or full localization to other languages than
5795 English, you should definitely consider
5796 \begin_inset Flex Code
5799 \begin_layout Plain Layout
5805 , which exceeds all other packages in terms of features, but is also quite
5806 heavy and more resource-hungry.
5809 \begin_layout Standard
5810 The handling of these packages in \SpecialChar LyX
5811 is basically the same.
5813 \begin_inset Flex Noun
5816 \begin_layout Plain Layout
5817 Document\SpecialChar menuseparator
5824 \begin_inset Flex Noun
5827 \begin_layout Plain Layout
5834 \begin_inset Flex Noun
5837 \begin_layout Plain Layout
5844 \begin_inset Flex Noun
5847 \begin_layout Plain Layout
5854 \begin_inset Flex Noun
5857 \begin_layout Plain Layout
5864 \begin_inset Flex Noun
5867 \begin_layout Plain Layout
5868 Biblatex (Natbib mode)
5874 \begin_inset Flex Noun
5877 \begin_layout Plain Layout
5884 \begin_inset Flex Noun
5887 \begin_layout Plain Layout
5894 \begin_inset space ~
5897 6.5.3 in the User's Guide for more information on these choices).
5898 With all these packages, you will get some extra features in the citation
5899 dialog and you can select the style of the reference (
5900 \begin_inset Quotes eld
5904 \begin_inset Quotes erd
5908 \begin_inset Quotes eld
5912 \begin_inset Quotes erd
5916 \begin_inset Quotes eld
5920 \begin_inset Quotes erd
5924 \begin_inset Quotes eld
5928 \begin_inset Quotes erd
5932 Note that either package needs specifically designed style files.
5933 They all ship their own, but there are lots of additional style files,
5934 and there is even an interactive style file builder
5938 \begin_layout Plain Layout
5940 \begin_inset Flex URL
5943 \begin_layout Plain Layout
5945 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
5956 \begin_inset Flex Code
5959 \begin_layout Plain Layout
5968 \begin_layout Subsection
5969 Subdivided Bibliographies
5972 \begin_layout Standard
5973 Sometimes you might need to divide your bibliography into several sections.
5974 If you are for instance a historian, the possibility to separate sources
5975 and scientific works is most likely a
5976 \begin_inset Quotes eld
5980 \begin_inset Quotes erd
5984 Unfortunately, Bib\SpecialChar TeX
5985 itself does not allow you to do this.
5986 But with the help of some \SpecialChar LaTeX
5987 packages, Bib\SpecialChar TeX
5988 can be extended to fit your needs.
5991 \begin_layout Standard
5993 provides native support for one of these packages,
6001 \begin_layout Plain Layout
6003 \begin_inset Flex URL
6006 \begin_layout Plain Layout
6008 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
6018 The advantage of this package (compared to other packages such as
6022 ) is that you don't need to define new citation commands.
6023 Instead, you need to prepare different bibliographic databases which include
6024 the entries for the different sections of the bibliography.
6025 For example: If you want to divide your bibliography into the sections
6027 \begin_inset Quotes eld
6031 \begin_inset Quotes erd
6035 \begin_inset Quotes eld
6039 \begin_inset Quotes erd
6042 , you first need to create two bibliographic databases, e.
6043 \begin_inset space \thinspace{}
6047 \begin_inset space \space{}
6051 \begin_inset Flex Code
6054 \begin_layout Plain Layout
6061 \begin_inset Flex Code
6064 \begin_layout Plain Layout
6074 \begin_layout Standard
6076 \begin_inset Flex Noun
6079 \begin_layout Plain Layout
6080 Document\SpecialChar menuseparator
6087 \begin_inset Flex Noun
6090 \begin_layout Plain Layout
6097 \begin_inset Flex Noun
6100 \begin_layout Plain Layout
6101 Subdivided bibliography
6107 Now you can insert multiple Bib\SpecialChar TeX
6108 bibliographies, one for each section of
6110 Returning to our example: Insert the Bib\SpecialChar TeX
6112 \begin_inset Flex Code
6115 \begin_layout Plain Layout
6121 and a second one for the database
6122 \begin_inset Flex Code
6125 \begin_layout Plain Layout
6132 You are free to use the same or different styles for each section.
6133 Additionally, you can choose if the bibliography section should contain
6135 \begin_inset Quotes eld
6138 all cited references
6139 \begin_inset Quotes erd
6142 of the specified database(s) (which is the default),
6143 \begin_inset Quotes eld
6146 all uncited references
6147 \begin_inset Quotes erd
6151 \begin_inset Quotes eld
6155 \begin_inset Quotes erd
6159 This might be useful if you would like to separate your bibliography into
6161 \begin_inset Quotes eld
6165 \begin_inset Quotes erd
6169 \begin_inset Quotes eld
6173 \begin_inset Quotes erd
6177 \begin_inset Quotes eld
6181 \begin_inset Quotes erd
6185 The titles for the sections can be added as ordinary sections or subsections.
6187 \begin_inset Flex Code
6190 \begin_layout Plain Layout
6196 removes the bibliography title, you have to manually re-add that, too (as
6197 a chapter* or section*, for instance).
6200 \begin_layout Standard
6205 , the procedure is a bit different.
6214 , the aforementioned
6215 \begin_inset Flex Noun
6218 \begin_layout Plain Layout
6219 Subdivided bibliography
6224 option is disabled if you use
6233 provides its own means to generate subdivided bibliographies.
6234 You can either add keywords to bibliography entries via the
6235 \begin_inset Flex Code
6238 \begin_layout Plain Layout
6244 entry option and then filter bibliography sections by keyword (by adding
6246 \begin_inset Flex Code
6249 \begin_layout Plain Layout
6256 \begin_inset Flex Noun
6259 \begin_layout Plain Layout
6265 field of the dialog that opens if you left-click on the
6266 \begin_inset Flex Noun
6269 \begin_layout Plain Layout
6270 Biblatex Generated Bibliography
6275 button), or you can filter by entry types (such as
6284 \begin_inset space \thinspace{}
6289 \begin_inset Flex Code
6292 \begin_layout Plain Layout
6299 \begin_inset Flex Code
6302 \begin_layout Plain Layout
6309 \begin_inset Flex Noun
6312 \begin_layout Plain Layout
6318 field, or you can create so-called
6319 \begin_inset Quotes eld
6322 Bibliography Categories
6323 \begin_inset Quotes erd
6326 to which you can assign individual entries.
6327 Please refer to the Biblatex manual, section
6329 Subdivided Bibliographies
6334 \begin_layout Subsection
6335 Multiple Bibliographies
6336 \begin_inset CommandInset label
6338 name "subsec:Multiple-Bibliographies"
6345 \begin_layout Standard
6346 Multiple bibliographies, e.
6347 \begin_inset space \thinspace{}
6351 \begin_inset space \space{}
6354 a bibliography for each part, chapter, section, subsection or child (sub-documen
6355 t) of the document, are also supported by \SpecialChar LyX
6357 In order to enable it, go to
6358 \begin_inset Flex Noun
6361 \begin_layout Plain Layout
6362 Document\SpecialChar menuseparator
6363 Settings\SpecialChar menuseparator
6369 and select the relevant unit (e.
6370 \begin_inset space \thinspace{}
6374 \begin_inset Quotes eld
6378 \begin_inset Quotes erd
6382 \begin_inset Flex Noun
6385 \begin_layout Plain Layout
6386 Multiple Bibliographies
6392 Then add a Bib(la)\SpecialChar TeX
6393 bibliography to each unit (e.
6394 \begin_inset space \thinspace{}
6397 g., section) of your document.
6398 In the output, a separate bibliography, containing only the references
6399 done in the current unit is generated.
6402 \begin_layout Standard
6403 If you use Bib\SpecialChar TeX
6405 \begin_inset Flex Code
6408 \begin_layout Plain Layout
6415 \begin_inset Flex Code
6418 \begin_layout Plain Layout
6424 package is used to create multiple bibliographies.
6425 The former package is used if you select
6426 \begin_inset Quotes eld
6430 \begin_inset Quotes erd
6438 \begin_inset Flex Noun
6441 \begin_layout Plain Layout
6442 Sectioned Bibliography
6449 \begin_inset Flex Code
6452 \begin_layout Plain Layout
6462 \begin_layout Plain Layout
6463 An alternative approach, if you are willing to use some
6464 \begin_inset Flex Noun
6467 \begin_layout Plain Layout
6475 \begin_inset space ~
6479 \begin_inset CommandInset ref
6481 reference "sec:Inserting-TeX-Code"
6486 \begin_inset Flex Code
6489 \begin_layout Plain Layout
6501 \begin_inset Flex Code
6504 \begin_layout Plain Layout
6510 is used, \SpecialChar LyX
6511 encloses the specified units in
6512 \begin_inset Flex Code
6515 \begin_layout Plain Layout
6522 \begin_inset Flex Code
6525 \begin_layout Plain Layout
6534 \begin_inset Flex Code
6537 \begin_layout Plain Layout
6545 in order to create the units.
6546 Note that this approach has some limitations.
6547 First, every citation reference has to be inside some
6548 \begin_inset Flex Code
6551 \begin_layout Plain Layout
6558 So citations outside a defined unit (e.
6559 \begin_inset space \thinspace{}
6562 g., before the first section if you use
6563 \begin_inset Quotes eld
6567 \begin_inset Quotes erd
6571 \begin_inset Quotes eld
6575 \begin_inset Quotes erd
6579 You can also create your own units by entering
6580 \begin_inset Flex Code
6583 \begin_layout Plain Layout
6592 \begin_inset Flex Code
6595 \begin_layout Plain Layout
6604 code (for instance to work around the mentioned limitation).
6606 \begin_inset Flex Code
6609 \begin_layout Plain Layout
6616 A second limitation is that
6617 \begin_inset Flex Code
6620 \begin_layout Plain Layout
6626 always processes all references of a bibliography database, even if they
6628 This can result in odd labels (e.
6629 \begin_inset space \thinspace{}
6634 \begin_inset Quotes eld
6638 \begin_inset Quotes erd
6641 if two works of this author from 2014 are in the database, even if only
6645 \begin_layout Standard
6651 \begin_inset Flex Code
6654 \begin_layout Plain Layout
6660 option is used instead.
6661 If you need specific units, you can start them with the \SpecialChar TeX
6663 \begin_inset Flex Code
6666 \begin_layout Plain Layout
6675 \begin_inset Flex Code
6678 \begin_layout Plain Layout
6687 If you also want to control the end of the unit, use the environment
6688 \begin_inset Flex Code
6691 \begin_layout Plain Layout
6701 \begin_inset Flex Code
6704 \begin_layout Plain Layout
6714 \begin_inset Flex Code
6717 \begin_layout Plain Layout
6724 In addition to the individual bibliography of the current unit,
6728 also provides an easy way to output all bibliographies, subsequently, at
6730 \begin_inset space \thinspace{}
6733 g., at the end of the document).
6735 \begin_inset Quotes eld
6739 \begin_inset Quotes erd
6742 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
6748 manual for more information on this topic.
6751 \begin_layout Section
6755 \begin_layout Subsection
6759 \begin_layout Standard
6760 When you are working on a large file with many sections, it is often convenient
6761 to break up the document into several files, or perhaps you have something
6762 where a table may change from time to time, but the preceding text does
6764 In these cases, you should seriously consider using multipart documents.
6765 For example, scientific papers often have five major sections: the introduction
6766 , observations, results, discussion, and conclusion.
6767 Each of these could be its own separate \SpecialChar LyX
6769 \begin_inset Quotes eld
6773 \begin_inset Quotes erd
6776 file which contains the title, authors, abstract, references, etc., plus
6777 the five included files.
6778 It is important to note that each of these files is a full \SpecialChar LyX
6780 can be formatted and printed on its own, as well as included in a master
6782 Each of these files must have the same document class, however—don't attempt
6783 to mix book classes with article classes.
6784 You may also include \SpecialChar LaTeX
6785 files; however, these files must not have their own
6787 \begin_inset space \thinspace{}
6791 \begin_inset space \space{}
6794 everything up to and including the
6795 \begin_inset Flex Code
6798 \begin_layout Plain Layout
6807 \begin_inset Flex Code
6810 \begin_layout Plain Layout
6818 line must be deleted) or else errors will be generated when you try to
6822 \begin_layout Standard
6824 allows you to include files quite easily with
6825 \begin_inset Flex Noun
6828 \begin_layout Plain Layout
6829 Insert\SpecialChar menuseparator
6831 \begin_inset space ~
6840 When you click on this selection a small box is inserted into the file
6841 at the current cursor location.
6842 Clicking on the box raises a dialog which allows you to select the file
6843 to be included, and the method of its inclusion.
6847 \begin_layout Standard
6848 The file selection box should by now be obvious.
6849 The three inclusion methods are
6850 \begin_inset Quotes eld
6854 \begin_inset Quotes erd
6858 \begin_inset Quotes eld
6862 \begin_inset Quotes erd
6866 \begin_inset Quotes eld
6870 \begin_inset Quotes erd
6875 \begin_inset Quotes eld
6879 \begin_inset Quotes erd
6883 \begin_inset Quotes eld
6887 \begin_inset Quotes erd
6890 are similar in many ways, but there are also some notable differences:
6893 \begin_layout Enumerate
6895 \begin_inset Quotes eld
6899 \begin_inset Quotes erd
6902 are typeset beginning on a new page, while files that are
6903 \begin_inset Quotes eld
6907 \begin_inset Quotes erd
6910 are typeset starting on the current page.
6913 \begin_layout Enumerate
6914 \begin_inset Quotes eld
6918 \begin_inset Quotes erd
6921 files cannot themselves
6922 \begin_inset Quotes eld
6926 \begin_inset Quotes erd
6930 \begin_inset Quotes eld
6934 \begin_inset Quotes erd
6939 \begin_inset Quotes eld
6943 \begin_inset Quotes erd
6946 , on the other hand, infinite sub-inputting is possible.
6949 \begin_layout Enumerate
6950 \begin_inset Quotes eld
6954 \begin_inset Quotes erd
6957 allow for the output of only selected
6958 \begin_inset Quotes eld
6962 \begin_inset Quotes erd
6965 files, while maintaining the actual counters (pagination etc.) and references
6966 (please refer to the section
6969 \begin_inset space ~
6977 \begin_inset space ~
6982 manual for details).
6985 \begin_layout Standard
6987 \begin_inset Quotes eld
6991 \begin_inset Quotes erd
6994 is the preferred method for chapters that are outsourced to child documents,
6996 \begin_inset Quotes eld
7000 \begin_inset Quotes erd
7003 is more suitable for arbitrary file inheritance.
7006 \begin_layout Standard
7008 \begin_inset Quotes eld
7012 \begin_inset Quotes erd
7015 included file allows you to include a file typeset exactly as it appears
7017 \begin_inset space \thinspace{}
7021 \begin_inset space \space{}
7025 \begin_inset Flex Code
7028 \begin_layout Plain Layout
7034 mode, with the characters set in a fixed-width typewriter font.
7035 Normally, spaces in this file are invisible, though two consecutive spaces
7036 are conserved, unlike \SpecialChar LyX
7037 's normal treatment of spaces.
7038 However, setting the
7039 \begin_inset Flex Noun
7042 \begin_layout Plain Layout
7044 \begin_inset space ~
7048 \begin_inset space ~
7052 \begin_inset space ~
7060 checkbox typesets a mark to unambiguously define the presence of a space.
7064 \begin_layout Standard
7065 Generally, the master file is converted into a full \SpecialChar LaTeX
7066 file before typesetting,
7067 while the included files are converted to \SpecialChar LaTeX
7068 files that do not have all the
7069 preamble information.
7072 \begin_layout Subsection
7073 Cross-References Between Files
7076 \begin_layout Standard
7077 \begin_inset Box Shadowbox
7087 height_special "totalheight"
7092 backgroundcolor "none"
7095 \begin_layout Plain Layout
7096 This section is somewhat out of date.
7097 Need to describe default master documents and how children are opened when
7107 \begin_layout Standard
7108 It is possible to set up cross-references between the different files.
7109 First, open all the files in question: let's call them A and B in a two
7110 file example, where B is included in A.
7111 Let's say you insert a label in A, then want to reference it in B.
7112 Open the cross-reference dialog whilst in document B, and you can select
7114 \begin_inset Quotes eld
7118 \begin_inset Quotes erd
7124 \begin_layout Subsection
7125 Bibliography Lists in all Subdocuments
7128 \begin_layout Standard
7129 If you work with child documents, you might want to have only one main bibliogra
7130 phy at the end, but still be able to have a selected bibliography for the
7131 child if you output it on its own.
7132 Here is how to achieve this.
7135 \begin_layout Standard
7136 For the main document, you just insert a bibliography inset at the place
7137 where the main bibliography has to appear (within the master file or within
7139 If the bibliography inset is in the master file, the references will be
7140 inherited by all children, so they are available in the citation dialog
7144 \begin_layout Standard
7145 For child-specific bibliographies, insert bibliography insets within the
7146 child documents, at the place where the bibliography should appear when
7147 the child is compiled separately.
7148 However, the trick is to insert them into a branch (
7150 Insert\SpecialChar menuseparator
7151 Branch\SpecialChar menuseparator
7152 Insert New Branch...
7155 \begin_inset space \thinspace{}
7160 \begin_inset Quotes eld
7164 \begin_inset Quotes erd
7168 Within the children, activate the branch (
7170 Document\SpecialChar menuseparator
7171 Settings...\SpecialChar menuseparator
7175 Within the master, deactivate the branch (
7177 Document\SpecialChar menuseparator
7178 Settings...\SpecialChar menuseparator
7182 Now the child's bibliography will be ignored by the master, but considered
7186 \begin_layout Standard
7187 If you need multiple bibliographies (e.
7188 \begin_inset space \thinspace{}
7191 g., one per child in the
7195 ), please refer to sec.
7196 \begin_inset space ~
7200 \begin_inset CommandInset ref
7202 reference "subsec:Multiple-Bibliographies"
7209 \begin_layout Section
7214 \begin_layout Standard
7215 Users sometimes need to be able to
7216 \begin_inset Quotes eld
7220 \begin_inset Quotes erd
7224 file together with all the images (and other files) on which it depends,
7225 either for sending to a publisher or for sharing with a co-author.
7227 includes a Python script (
7228 \begin_inset Flex Code
7231 \begin_layout Plain Layout
7237 ) that automates this process.
7238 To use it, you must have either the
7239 \begin_inset Flex Code
7242 \begin_layout Plain Layout
7249 \begin_inset Flex Code
7252 \begin_layout Plain Layout
7258 python modules installed on your system.
7259 By default, the script prefers the
7260 \begin_inset Flex Code
7263 \begin_layout Plain Layout
7270 \begin_inset Flex Code
7273 \begin_layout Plain Layout
7279 format on Unix-like systems and the
7280 \begin_inset Flex Code
7283 \begin_layout Plain Layout
7292 \begin_layout Standard
7294 's configuration process will set the script up to export a `\SpecialChar LyX
7296 and this format will then be available under
7297 \begin_inset Flex Code
7300 \begin_layout Plain Layout
7301 File\SpecialChar menuseparator
7310 \begin_layout Standard
7311 Independently of the platform, the generation of a particular archive format
7312 can be forced by adding either the
7313 \begin_inset Flex Code
7316 \begin_layout Plain Layout
7323 \begin_inset Flex Code
7326 \begin_layout Plain Layout
7333 \begin_inset Flex Code
7336 \begin_layout Plain Layout
7343 \begin_inset Flex Code
7346 \begin_layout Plain Layout
7352 format) switch to the
7353 \begin_inset Flex Code
7356 \begin_layout Plain Layout
7358 \SpecialChar menuseparator
7366 \begin_inset Flex Code
7369 \begin_layout Plain Layout
7370 Tools\SpecialChar menuseparator
7371 Preferences\SpecialChar menuseparator
7372 File Handling\SpecialChar menuseparator
7379 (Make sure you add the switch after the script name, not before it.)
7382 \begin_layout Section
7383 Fancy Headers and Footers
7386 \begin_layout Standard
7387 The default page layout is rather plain; for an
7388 \begin_inset Flex Code
7391 \begin_layout Plain Layout
7397 document class, all you get is a centered page number at the bottom of
7399 This document uses KOMA-script's book class, so it appears to be a bit
7401 But to really put on a show, you need to set the document page style to
7403 \begin_inset Quotes eld
7407 \begin_inset Quotes erd
7410 , as mentioned in the
7415 This section describes the \SpecialChar LaTeX
7416 code you need to insert in your \SpecialChar LaTeX
7418 order to get the desired effects.
7421 \begin_layout Standard
7422 For more information on fancy headers, see the
7423 \begin_inset Flex Code
7426 \begin_layout Plain Layout
7432 package documentation.
7434 \begin_inset Flex URL
7437 \begin_layout Plain Layout
7439 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
7447 \begin_layout Standard
7448 The page header is divided into three fields, not surprisingly labeled
7449 \begin_inset Quotes eld
7453 \begin_inset Quotes erd
7457 \begin_inset Quotes eld
7461 \begin_inset Quotes erd
7465 \begin_inset Quotes eld
7469 \begin_inset Quotes erd
7473 The footer is also divided into these three fields.
7474 The \SpecialChar LaTeX
7475 commands to set these fields in the simplest manner are
7476 \begin_inset Flex Code
7479 \begin_layout Plain Layout
7488 \begin_inset Flex Code
7491 \begin_layout Plain Layout
7500 \begin_inset Flex Code
7503 \begin_layout Plain Layout
7512 \begin_inset Flex Code
7515 \begin_layout Plain Layout
7524 Suppose you wish to put your name in the upper left hand corner of each
7526 Simply insert the following command in the preamble:
7529 \begin_layout Standard
7538 \begin_layout Standard
7539 You will now see your name in the upper left.
7540 If a field has a default entry that you would like to get rid of (often
7541 the page number appears in the central footer) simply include a command
7542 with a blank argument, e.
7543 \begin_inset space \thinspace{}
7549 \begin_layout Standard
7557 \begin_layout Standard
7558 Let's get really fancy: lets put the section number with the word
7559 \begin_inset Quotes eld
7563 \begin_inset Quotes erd
7567 \begin_inset space \thinspace{}
7571 \begin_inset space \space{}
7574 Section 3) in the upper left, the page number (e.
7575 \begin_inset space \thinspace{}
7579 \begin_inset space \space{}
7582 Page 4) in the upper right, your name in the lower left, and the date in
7584 The following commands should now appear in the preamble:
7587 \begin_layout Standard
7597 \begin_layout Standard
7605 \begin_layout Standard
7615 \begin_layout Standard
7624 \begin_layout Standard
7632 \begin_layout Standard
7642 \begin_layout Standard
7644 \begin_inset Flex Code
7647 \begin_layout Plain Layout
7656 \begin_inset Flex Code
7659 \begin_layout Plain Layout
7667 access \SpecialChar LaTeX
7668 's section and page counters, and so print out the current section
7671 \begin_inset Flex Code
7674 \begin_layout Plain Layout
7682 simply prints out today's date.
7685 \begin_layout Standard
7686 The thicknesses of the horizontal rules drawn beneath the header and above
7687 the footer can also be modified.
7688 If you don't want one of the rules, set its thickness to 0.
7689 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
7695 \begin_inset Flex Code
7698 \begin_layout Plain Layout
7703 headrulewidth}{0.4pt}
7709 \begin_inset Flex Code
7712 \begin_layout Plain Layout
7717 footrulewidth}{0.4pt}
7722 to set the thicknesses.
7725 \begin_layout Standard
7726 You can switch the header/footer settings on and off for individual pages
7728 \begin_inset Flex Code
7731 \begin_layout Plain Layout
7734 thispagestyle{empty}
7740 \begin_inset Flex Code
7743 \begin_layout Plain Layout
7746 thispagestyle{plain}
7752 \begin_inset Flex Code
7755 \begin_layout Plain Layout
7758 thispagestyle{fancy}
7764 Simply insert them in the text on the page you want changed and mark them
7767 In fact, title pages are marked as plain by default, while following pages
7768 are marked fancy when using the global fancy setting.
7771 \begin_layout Standard
7772 As a final example, it is possible to include an image in the header or
7774 Suppose you want to put a company logo in the upper lefthand corner.
7775 You might try something like
7778 \begin_layout Standard
7787 includegraphics{logo.eps}}}
7790 \begin_layout Standard
7792 (you may need to preface this with
7793 \begin_inset Flex Code
7796 \begin_layout Plain Layout
7799 usepackage{graphics}
7804 if you don't include graphics elsewhere in your document).
7807 \begin_layout Section
7808 Itemize Bullet Selection
7809 \begin_inset CommandInset label
7818 \begin_layout Standard
7824 \begin_layout Subsection
7828 \begin_layout Standard
7830 provides 216 bullet shapes that can be accessed from a simple dialog.
7831 Using this dialog you can easily specify what bullet shape to use at each
7832 level of an itemized list.
7833 These settings are document-wide so you won't be able to specify different
7834 sets of bullets for different paragraphs.
7838 \begin_layout Plain Layout
7839 Well, actually you can but you'll have to do it by hand.
7847 \begin_layout Subsection
7851 \begin_layout Standard
7852 Open the dialog by selecting the
7853 \begin_inset Flex Noun
7856 \begin_layout Plain Layout
7857 Document\SpecialChar menuseparator
7863 menu item and then select the
7864 \begin_inset Flex Noun
7867 \begin_layout Plain Layout
7876 \begin_layout Standard
7877 The dialog provides you with a table of bullet shapes.
7878 A column of buttons on the left of the table provides access to the six
7879 different panels of bullet shapes.
7880 The row of buttons across the top is used to select which bullet depth
7883 \change_deleted 244031559 1603875981
7884 A text entry under the table shows the currently selected bullet shape's
7886 equivalent and this can be edited if desired.
7887 If you do modify the text you will also need to specify any needed packages
7888 in the \SpecialChar LaTeX
7894 \begin_layout Standard
7895 The six panels are divided up by the packages they require.
7896 The following table shows the mappings from button name to \SpecialChar LaTeX
7900 \begin_layout Standard
7902 \begin_inset Tabular
7903 <lyxtabular version="3" rows="7" columns="2">
7904 <features tabularvalignment="middle">
7905 <column alignment="center" valignment="top" width="0pt">
7906 <column alignment="center" valignment="top" width="0pt">
7908 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
7911 \begin_layout Plain Layout
7926 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
7929 \begin_layout Plain Layout
7946 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
7949 \begin_layout Plain Layout
7964 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
7967 \begin_layout Plain Layout
7976 base \SpecialChar LaTeX
7984 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
7987 \begin_layout Plain Layout
8002 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
8005 \begin_layout Plain Layout
8022 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
8025 \begin_layout Plain Layout
8040 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
8043 \begin_layout Plain Layout
8060 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
8063 \begin_layout Plain Layout
8078 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
8081 \begin_layout Plain Layout
8098 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
8101 \begin_layout Plain Layout
8116 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
8119 \begin_layout Plain Layout
8136 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
8139 \begin_layout Plain Layout
8154 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
8157 \begin_layout Plain Layout
8180 \begin_layout Standard
8182 doesn't stop you using bullets from packages you don't have.
8183 If you get errors from \SpecialChar LaTeX
8184 when you try to view or print the file, then it
8185 is likely you are missing a package.
8189 \begin_layout Plain Layout
8191 doesn't restrict your use since you may be editing locally and exporting
8200 \begin_layout Subsection
8204 \begin_layout Standard
8205 Select which bullet depth you want to change then select the bullet shape
8207 Any changes will not be visible in \SpecialChar LyX
8208 , but are visible when viewing the document.
8211 \begin_layout Standard
8212 You can reset a bullet shape to the default simply by clicking your right
8213 mouse button on the appropriate bullet depth button.
8217 \begin_layout Plain Layout
8222 want to have multiple sets of paragraphs with different sets of bullets
8223 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
8225 The bullet selection dialog can help though because it provides you with
8226 the \SpecialChar LaTeX
8227 code for a wide range of bullet shapes.
8228 To make your own custom paragraphs you have the following options:
8231 \begin_layout Plain Layout
8235 \begin_layout Plain Layout
8251 \begin_layout Plain Layout
8255 \begin_layout Plain Layout
8277 \begin_layout Itemize
8278 Use the \SpecialChar LaTeX
8280 \begin_inset Flex Code
8283 \begin_layout Plain Layout
8291 to specify a new bullet shape for a given depth.
8292 You'll also need to save the current bullet shape so you can restore it
8294 In this itemized list the following \SpecialChar LaTeX
8295 code was used to change the bullet
8296 used for the first depth.
8300 \begin_layout LyX-Code
8310 \begin_layout LyX-Code
8327 \begin_layout Itemize
8328 Note that the itemize depth is specified in Roman numerals as part of the
8338 \begin_layout Itemize
8339 \begin_inset Argument item:1
8342 \begin_layout Plain Layout
8346 \begin_layout Plain Layout
8364 Specify each individual entry by starting each item with the bullet shape
8366 \begin_inset Quotes eld
8370 \begin_inset Quotes erd
8375 Insert\SpecialChar menuseparator
8379 \begin_inset Flex Noun
8382 \begin_layout Plain Layout
8390 For example, this item was started with
8391 \begin_inset Flex Code
8394 \begin_layout Plain Layout
8409 \begin_layout Plain Layout
8413 \begin_layout Plain Layout
8429 \begin_layout Plain Layout
8430 You'll also need to revert the labelitem back to its previous setting for
8431 the global bullet shape settings to remain in effect.
8432 The way used here was:
8435 \begin_layout LyX-Code
8450 \begin_layout Chapter
8452 and the World Wide Web
8455 \begin_layout Standard
8457 has long supported the export of documents to various web-friendly formats,
8459 Before version 2.0, however, HTML export was always accomplished by the
8460 use of external converters.
8464 \begin_layout Plain Layout
8465 For details on the use of external converters with \SpecialChar LyX
8470 section of the Customization manual.
8475 These fall into two large groups: there are converters that use \SpecialChar LaTeX
8477 intermediate format, such as
8478 \begin_inset Flex Code
8481 \begin_layout Plain Layout
8488 \begin_inset Flex Code
8491 \begin_layout Plain Layout
8498 \begin_inset Flex Code
8501 \begin_layout Plain Layout
8507 , relying upon \SpecialChar LyX
8508 to produce the \SpecialChar LaTeX
8509 ; and there is a converter that works directly
8512 \begin_inset Flex Code
8515 \begin_layout Plain Layout
8523 All of these have different advantages and disadvantages.
8527 \begin_layout Standard
8528 The \SpecialChar LaTeX
8529 -based converters have the advantage that, in principle, they know everythin
8530 g about the exported document that \SpecialChar LaTeX
8532 Such converters do not care, for example, if a certain block of code was
8533 produced by \SpecialChar LyX
8534 or was Evil Red Text.
8535 These converters know about
8536 \begin_inset Flex Code
8539 \begin_layout Plain Layout
8545 files, counters, and references, and can often make use of the
8546 \begin_inset Flex Code
8549 \begin_layout Plain Layout
8555 files generated by Bib\SpecialChar TeX
8557 On the other hand, \SpecialChar LaTeX
8558 is a very hard language to parse—it is sometimes said
8559 that only \SpecialChar TeX
8560 itself understands \SpecialChar TeX
8561 —and \SpecialChar LaTeX
8562 -based converters will often choke on
8563 what seem to be quite simple constructs; complex ones can throw them completely
8564 , and as of this writing, for example, the
8568 manual will not export with
8569 \begin_inset Flex Code
8572 \begin_layout Plain Layout
8578 , though the others will.
8579 The other issue concerns how math is handled.
8580 These converters typically convert the formulae into little pictures that
8581 are then linked from the HTML document.
8582 Since these are actually generated by \SpecialChar LaTeX
8583 , they are accurate.
8584 But they do not scale well, and just getting them to look as if they are
8585 actually meant to be in your document—so that the font sizes seem to be
8586 roughly the same—can be a challenge.
8589 \begin_layout Standard
8591 \begin_inset Flex Code
8594 \begin_layout Plain Layout
8602 \begin_inset CommandInset href
8604 name "http://pinchito.es/elyxer/"
8605 target "http://pinchito.es/elyxer/"
8610 ) solves some of these problems.
8611 In particular, the formulae it produces scale perfectly, since it renders
8612 math using a combination of HTML and CSS rather than converting the formulae
8614 But even moderately complex formula are rendered less well than with
8615 \begin_inset Flex Code
8618 \begin_layout Plain Layout
8624 ; this reflects the limitations of HTML.
8628 \begin_layout Plain Layout
8630 \begin_inset Flex Code
8633 \begin_layout Plain Layout
8640 can also use jsMath and MathJax for equations, but this setting is only
8641 available globally and requires one to have access to a server that runs
8647 More importantly (as of version 1.1.1, at least),
8648 \begin_inset Flex Code
8651 \begin_layout Plain Layout
8658 has limited support for math macros and no support for user-defined paragraph
8659 or character styles.
8660 These limitations make
8661 \begin_inset Flex Code
8664 \begin_layout Plain Layout
8671 unsuitable for many of the documents \SpecialChar LyX
8673 In principle, of course, these problems could be solved, but the \SpecialChar LyX
8675 have decided to follow a different path and have made \SpecialChar LyX
8677 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
8678 , DocBook, and plaintext.
8681 \begin_layout Standard
8682 As of this writing, XHTML output remains under development and should probably
8684 \begin_inset Quotes eld
8688 \begin_inset Quotes erd
8695 \begin_layout Plain Layout
8697 \begin_inset Flex Code
8700 \begin_layout Plain Layout
8701 development/HTML/HTML.notes
8706 , which can be found in the \SpecialChar LyX
8708 \begin_inset CommandInset href
8710 name "accessed online"
8711 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
8716 , usually contains up-to-date information about the state of XHTML output.
8717 See also the list of XHTML bugs on
8718 \begin_inset CommandInset href
8720 name "the bug tracker"
8721 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"
8731 Still, the developers have chosen this approach because it has several
8732 potential advantages over the other two.
8735 \begin_layout Standard
8736 These advantages are primarily due to the fact that the XHTML output routines,
8737 since they are part of \SpecialChar LyX
8738 , know everything \SpecialChar LyX
8739 knows about the document being
8744 \begin_layout Plain Layout
8745 Another advantage is that, since these routines are internal to \SpecialChar LyX
8747 immune to changes in \SpecialChar LyX
8748 's file format, or to changes in the semantics of
8754 So they know about the table of contents (as displayed in the outline),
8755 about the counters associated with different paragraph styles, and about
8756 user-defined styles.
8757 The XHTML output routines know what \SpecialChar LyX
8758 knows about internationalization,
8759 too, so they will output
8760 \begin_inset Quotes eld
8764 \begin_inset Quotes erd
8768 \begin_inset Quotes eld
8776 \begin_inset Quotes erd
8779 , depending upon the language in effect at the time.
8783 \begin_layout Standard
8784 Quite generally, the output routines know what \SpecialChar LyX
8785 knows about document layout,
8786 that is, about how the document is to be rendered on screen.
8787 We use this information when we output the document as XHTML.
8788 In particular, \SpecialChar LyX
8793 generates CSS style information corresponding to the layout information
8794 it uses to render the document on screen: if section headings are supposed
8795 to be sans-serif and bold as seen in \SpecialChar LyX
8796 , then (by default) they will be sans-seri
8797 f and bold when viewed in a web browser, too.
8798 And this is true not just for pre-defined styles, like Section, but for
8799 any style, including user-defined styles.
8800 Indeed, the XHTML output routines make no distinction between user-defined
8802 \change_deleted 244031559 1603876931
8804 \change_inserted 244031559 1603876940
8807 styles and \SpecialChar LyX
8808 's own pre-defined styles: in each case, everything \SpecialChar LyX
8810 the styles is contained in the layout files.
8811 And much the same is true as regards pre-defined textual insets, such as
8812 footnotes, and various custom insets.
8816 \begin_layout Standard
8817 The result is that XHTML output can be customized and extended in exactly
8818 the same way \SpecialChar LaTeX
8819 output can be customized and extended: through layout files
8821 See chapter five of the
8825 manual for the details.
8828 \begin_layout Standard
8829 The remainder of this chapter contains more detailed information on XHTML
8830 output, its limitations, and ways to work around those limitations.
8833 \begin_layout Section
8834 Math Output in XHTML
8837 \begin_layout Standard
8839 offers four choices for how math is rendered.
8840 These have various advantages and disadvantages:
8843 \begin_layout Itemize
8845 \begin_inset Newline newline
8848 MathML is a dialect of XML designed specifically for mathematics on the
8849 web, and it typically renders very well in browsers that support it.
8850 The disadvantage is that not all browsers support MathML, and support is
8851 not complete even in the Gecko-based browsers, such as Firefox.
8852 \begin_inset Newline newline
8856 is unable to render a formula as MathML—for example, if the formula
8858 \begin_inset Flex Code
8861 \begin_layout Plain Layout
8867 package or ERT—then it will instead output the formula as an image.
8871 \begin_layout Itemize
8873 \begin_inset Newline newline
8877 \begin_inset Flex Code
8880 \begin_layout Plain Layout
8886 outputs math as HTML, styled by CSS.
8890 \begin_layout Plain Layout
8892 has borrowed some of the CSS for its HTML output from
8893 \begin_inset Flex Code
8896 \begin_layout Plain Layout
8907 For simple formulae, this can work quite well, though with more complicated
8908 formulae it tends to break down.
8909 Still, this method has the advantage that it is very widely supported and
8910 so it may be appropriate for documents that contain only a little, fairly
8912 \begin_inset Newline newline
8915 If Lyx is unable to render a formula as HTML—for example, if the formula
8917 \begin_inset Flex Code
8920 \begin_layout Plain Layout
8926 package or ERT—then it will instead output the formula as an image.
8930 \begin_layout Itemize
8932 \begin_inset Newline newline
8936 \begin_inset Flex Code
8939 \begin_layout Plain Layout
8946 will output formulae as images, the very same images, in fact, that are
8947 used for instant preview.
8951 \begin_layout Plain Layout
8952 Instant preview does
8956 have to be on for images to be output, however.
8961 The advantage to this method is that the images are simply generated by
8963 , so they are very accurate.
8964 The disadvantage, as mentioned earlier, is that these are bitmapped images,
8965 so they do not scale terribly well, and one cannot copy them, etc.
8966 \begin_inset Newline newline
8969 The size of the images can be controlled by setting the
8970 \begin_inset Quotes eld
8974 \begin_inset Quotes erd
8978 \begin_inset Flex Noun
8981 \begin_layout Plain Layout
8982 Document\SpecialChar menuseparator
8983 Settings\SpecialChar menuseparator
8993 \begin_layout Plain Layout
8994 For those who want to know, this controls the resolution of the image in
8995 dots per inch and is based upon a default of 75 dpi.
9001 \begin_inset Newline newline
9005 for some reason fails to create an image for a formula (e.g., if a required
9007 package is not installed), then it will fall back to outputing the raw
9012 \begin_layout Itemize
9015 \begin_inset Newline newline
9018 Finally, \SpecialChar LyX
9019 will happily output math as \SpecialChar LaTeX
9021 As well as being the output of last resort, this method can be used with
9023 \begin_inset CommandInset href
9026 target "http://www.math.union.edu/~dpvc/jsMath/"
9031 , which uses JavaScript to render \SpecialChar LaTeX
9032 embedded in HTML documents.
9034 wraps the \SpecialChar LaTeX
9036 \begin_inset Flex Code
9039 \begin_layout Plain Layout
9045 (for inline formulas) or
9046 \begin_inset Flex Code
9049 \begin_layout Plain Layout
9055 (for displayed formulas) with
9056 \begin_inset Flex Code
9059 \begin_layout Plain Layout
9065 , as is required for jsMath.
9068 \begin_layout Standard
9069 One of these output methods must be selected under
9070 \begin_inset Flex Noun
9073 \begin_layout Plain Layout
9074 Document\SpecialChar menuseparator
9075 Settings\SpecialChar menuseparator
9082 By default, \SpecialChar LyX
9084 This is a document-wide setting, therefore.
9087 \begin_layout Standard
9088 Eventually, \SpecialChar LyX
9089 will offer the user the option to select an alternate output
9090 method for a particular inset, say, one that isn't being rendered very
9095 \begin_layout Plain Layout
9096 That said, since \SpecialChar LyX
9097 falls back to images if the inset contains ERT, then one
9098 can force output as an image by putting some harmless ERT into the math,
9100 \begin_inset Formula $a=b\relax$
9111 \begin_layout Section
9112 Bibliography and Citations
9115 \begin_layout Standard
9116 XHTML output fully supports bibliographies and citations.
9120 \begin_layout Standard
9121 Citation labels are generated by the same machinery that generates \SpecialChar LyX
9123 labels, so the labels will look in the output much as they do in \SpecialChar LyX
9126 If you are using numerical citations, then \SpecialChar LyX
9127 will output numerical labels,
9128 such as [1] or [17], rather than simply showing the citation key in square
9129 brackets, as it does on-screen.
9130 If you are using author-year citations, then \SpecialChar LyX
9131 will add lowercase letters
9132 to the years, just as Bib\SpecialChar TeX
9133 does, if it finds more than one citation for
9134 a given author-year combination.
9135 The labels will be printed with the bibliography entries.
9136 Note that there is, at present, no way to customize the appearance of the
9137 labels, for example, to choose between square brackets and parentheses.
9140 \begin_layout Standard
9141 Bibliography output is handled by the same machinery that handles the presentati
9142 on of reference information in the citation dialog, so you will see in the
9143 XHTML output pretty much what you would see if you were to look at a given
9144 entry in the citation dialog.
9145 The formatting can be customized in your layout file or, preferably, in
9151 manual for the details.
9154 \begin_layout Standard
9155 The main defect at present is that cross-referenced information is printed
9156 with every entry with which it is associated.
9157 So you can see things like this:
9162 \begin_inset Quotes eld
9165 Context and Logical Form
9166 \begin_inset Quotes erd
9171 Language in Context: Selected Essays
9173 (Oxford: Oxford University Press, 2007), pp.
9179 \begin_inset Quotes eld
9182 Semantics in Context
9183 \begin_inset Quotes erd
9188 Language in Context: Selected Essays
9190 (Oxford: Oxford University Press, 2007), pp.
9194 \begin_layout Standard
9195 This should be fixed before long.
9198 \begin_layout Standard
9199 There is no support at present for sectioned bibliographies.
9200 If you have multiple bibliographies, then \SpecialChar LyX
9201 will print the same bibliography
9205 \begin_layout Section
9209 \begin_layout Standard
9211 will happily export indexes as XHTML, but with certain limitations at the
9215 \begin_layout Standard
9216 Index export will be most reliable when you do not attempt to use the fancy
9217 constructs that are described in the section on indexes in the
9225 \begin_layout Plain Layout
9226 The main issue here is that \SpecialChar LyX
9227 itself does not really handle these.
9228 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
9234 We'll describe how they are handled using the subsection headings from
9238 \begin_layout Itemize
9239 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
9240 makes an effort to support these,
9241 but the entries must be separated by
9242 \begin_inset Quotes eld
9246 \begin_inset Quotes erd
9249 , that is, there must be spaces around the exclamation point.
9250 This is because it is otherwise too difficult to check for escaped exclamation
9251 points, ones in math, and so forth.
9254 \begin_layout Itemize
9255 Page Ranges: There is no support at all for page ranges, since these make
9256 no sense with XHMTL.
9257 Instead, you will just get two index entries, one at either end.
9260 \begin_layout Itemize
9261 Cross-referencing: There is no support for cross-referencing.
9263 finds an entry containing the
9264 \begin_inset Quotes eld
9267 |see\SpecialChar ldots
9269 \begin_inset Quotes erd
9272 construct, it is just dropped, and the rest is treated as an ordinary index
9276 \begin_layout Itemize
9277 Index Entry Order: \SpecialChar LyX
9278 does support attempts to fix the sorting order.
9279 It will take what is before the first `@' it finds and use that for sorting,
9280 taking what follows the first `@' to be the actual entry.
9281 At present, \SpecialChar LyX
9282 does not check for escaped `@', so do not try to index email
9286 \begin_layout Itemize
9287 Index Entry Layout: You can format entries by using the text style dialog,
9288 or by using any other method available within \SpecialChar LyX
9290 There is no support for constructs like:
9291 \begin_inset Quotes eld
9295 \begin_inset Quotes erd
9299 Indeed, if \SpecialChar LyX
9300 finds a pipe symbol, `|', in an entry, it will delete it and
9301 everything that follows it.
9304 \begin_layout Itemize
9305 Multiple Indexes: There is no support for multiple indexes.
9306 Rather, all index entries will be printed as one large index.
9307 To avoid our printing several versions of the index, we print only the
9308 main index, so make sure you have one.
9311 \begin_layout Section
9312 Nomenclature and Glossary
9315 \begin_layout Standard
9316 There is at present no support for glossaries.
9317 Adding it would be fairly trivial, and welcome.
9320 \begin_layout Chapter
9322 \change_inserted 1075283030 1616534180
9326 \begin_layout Standard
9328 \change_inserted 1075283030 1616534386
9329 Apart from HTML, \SpecialChar LyX
9330 can generate documents in the DocBook XML vocabulary.
9331 With versions 2.3 and before, only select templates could be used to generate
9332 DocBook documents (only version 4).
9333 Starting with \SpecialChar LyX
9334 2.4, most \SpecialChar LyX
9335 layouts can generate valid DocBook documents (only
9337 This feature is built into \SpecialChar LyX
9338 and does not require the use of external tools.
9341 \begin_layout Standard
9343 \change_inserted 1075283030 1616534437
9344 The result is that the DocBook output can be customized and extended in
9345 exactly the same way \SpecialChar LaTeX
9346 output can be customized and extended: through layout
9348 See chapter five of the
9352 manual for the details.
9355 \begin_layout Standard
9357 \change_inserted 1075283030 1616534475
9358 Most \SpecialChar LyX
9359 features are supported with DocBook, like math output.
9362 \begin_layout Itemize
9364 \change_inserted 1075283030 1616534741
9365 Math output is performed mostly in MathML (the major exception being constructio
9366 ns not supported by \SpecialChar LyX
9369 All formulae are also available in raw \SpecialChar TeX
9370 in the DocBook output for further
9374 \begin_layout Itemize
9376 \change_inserted 1075283030 1616534852
9377 Bibliographies and citations are implemented, including with an external
9379 Bibliography entries are not prerendered when the detailed information
9380 are available, but rather output with the standard DocBook constructs.
9381 The external DocBook processor is expected to handle the rendering of entries.
9384 \begin_layout Itemize
9386 \change_inserted 1075283030 1616534863
9387 Indexes are supported, including multiple indices.
9392 ), page ranges, and cross-references (
9396 ) are supported, with the exception of the same symbols escaped.
9405 ) are not supported.
9406 There is no support for escaping of index entries.
9409 \begin_layout Itemize
9411 \change_inserted 1075283030 1616534884
9412 Glossaries are implemented.
9415 \begin_layout Standard
9417 \change_inserted 1075283030 1616534894
9418 Two major parameters can be set at the document level.
9421 \begin_layout Itemize
9423 \change_inserted 1075283030 1616534948
9424 Format for tables: \SpecialChar LyX
9425 can generate tables either as HTML (default value) or
9426 CALS, depending on the user's requirements.
9427 Most DocBook processors accept both formats.
9430 \begin_layout Itemize
9432 \change_inserted 1075283030 1616535006
9433 MathML prefix: in DocBook, MathML is included within its own name space,
9435 The implication is that there must be an indication of the tags belonging
9436 to the MathML standard.
9437 Three choices are offered:
9441 \begin_layout Itemize
9443 \change_inserted 1075283030 1616535044
9444 Inline: the MathML name space is defined for each formula (using the
9448 attribute on each formula)
9451 \begin_layout Itemize
9453 \change_inserted 1075283030 1616535090
9458 prefix (default): the MathML name space is defined at the document level
9463 attribute on the root element).
9464 Each MathML is prefixed with
9473 \begin_layout Itemize
9475 \change_inserted 1075283030 1616620405
9480 prefix: similar to the
9489 \begin_layout Standard
9491 \change_inserted 1075283030 1616620470
9492 This option is especially useful if you want \SpecialChar LyX
9493 to match your personal style
9494 or to work with buggy software that only accepts one prefix for MathML.
9500 \begin_layout Chapter
9501 The \SpecialChar LyX
9505 \begin_layout Section
9509 \begin_layout Standard
9510 The `\SpecialChar LyX
9511 server' allows other programs to talk to \SpecialChar LyX
9512 , invoke \SpecialChar LyX
9513 commands, and retrieve
9514 information about the \SpecialChar LyX
9516 This is only intended for advanced users, but they should find it useful.
9517 It is by writing to the \SpecialChar LyX
9518 server, for example, that bibliography managers,
9519 such as JabRef, are able to
9520 \begin_inset Quotes eld
9524 \begin_inset Quotes erd
9527 citations to \SpecialChar LyX
9531 \begin_layout Section
9532 Starting the \SpecialChar LyX
9534 \begin_inset CommandInset label
9536 name "sec:Starting-the-Server"
9543 \begin_layout Standard
9544 The \SpecialChar LyX
9545 server works through the use of a pair of named pipes.
9546 These are usually located in
9547 \begin_inset Flex Code
9550 \begin_layout Plain Layout
9556 , (except on Windows, where
9560 named pipes are special objects located in
9561 \begin_inset Flex Code
9564 \begin_layout Plain Layout
9576 ) and have the names
9577 \begin_inset Quotes eld
9581 \begin_inset Flex Code
9584 \begin_layout Plain Layout
9591 \begin_inset Quotes erd
9595 \begin_inset Quotes eld
9599 \begin_inset Flex Code
9602 \begin_layout Plain Layout
9609 \begin_inset Quotes erd
9613 External programs write into
9614 \begin_inset Flex Code
9617 \begin_layout Plain Layout
9623 and read back data from
9624 \begin_inset Flex Code
9627 \begin_layout Plain Layout
9634 The stem of the pipe names can be defined in the
9635 \begin_inset Flex Noun
9638 \begin_layout Plain Layout
9639 Tools\SpecialChar menuseparator
9646 \begin_inset Flex Code
9649 \begin_layout Plain Layout
9650 "/home/myhome/lyxpipe"
9656 \begin_inset Flex Code
9659 \begin_layout Plain Layout
9673 on Windows (where any working path instead of lyxpipe can be used, for
9675 \begin_inset Flex Code
9678 \begin_layout Plain Layout
9701 configure this manually in order for the server to start.
9704 \begin_layout Standard
9707 \begin_inset Flex Code
9710 \begin_layout Plain Layout
9717 \begin_inset Flex Code
9720 \begin_layout Plain Layout
9726 ' to create the pipes.
9727 If one of the pipes already exists, \SpecialChar LyX
9728 will assume that another \SpecialChar LyX
9730 is already running and will not start the server.
9731 On POSIX (Unix like) systems, if for some other reason, an unused
9732 \begin_inset Quotes eld
9736 \begin_inset Quotes erd
9739 pipe is left in existence when \SpecialChar LyX
9740 closes, then \SpecialChar LyX
9741 will try to delete it.
9742 If this fails for some reason, you will need to delete the pipes manually
9743 and then restart \SpecialChar LyX
9745 On Windows, pipes are deleted by the OS on program termination or crash,
9747 \begin_inset Quotes eld
9751 \begin_inset Quotes erd
9754 pipes should not be possible.
9757 \begin_layout Standard
9758 To have several \SpecialChar LyX
9759 processes with servers at the same time, you have to use
9760 different configurations, perhaps by using separate user directories, each
9762 \begin_inset Flex Code
9765 \begin_layout Plain Layout
9771 file, for each process.
9774 \begin_layout Standard
9775 If you are developing a client program, you might find it useful to enable
9776 debugging information from the \SpecialChar LyX
9778 Do this by starting \SpecialChar LyX
9780 \begin_inset Flex Code
9783 \begin_layout Plain Layout
9792 \begin_layout Standard
9793 You can find a complete example client written in C++ in the source distribution
9795 \begin_inset Flex Code
9798 \begin_layout Plain Layout
9799 development/lyxserver/server_monitor.cpp
9807 \begin_layout Standard
9808 Another useful tool is the command-line based client found in
9809 \begin_inset Flex Code
9812 \begin_layout Plain Layout
9813 src/client/lyxclient
9821 \begin_layout Section
9822 Normal communication
9825 \begin_layout Standard
9826 To issue a \SpecialChar LyX
9827 call, the client writes a line of ASCII text into the input
9829 This line has the following format:
9846 \begin_layout Description
9847 clientname is a name that the client can choose arbitrarily.
9848 Its only use is that \SpecialChar LyX
9849 will echo it if it sends an answer—so a client can
9850 dispatch results from different requesters.
9853 \begin_layout Description
9854 function is the function you want \SpecialChar LyX
9856 It is the same as the commands you'd use in the minibuffer.
9859 \begin_layout Description
9860 argument is an optional argument which is meaningful only to some functions
9862 \begin_inset Quotes eld
9866 \begin_inset Quotes erd
9869 LFUN will insert the argument as text at the cursor position).
9872 \begin_layout Standard
9873 The answer from \SpecialChar LyX
9874 will arrive in the output pipe and be of the form
9891 \begin_layout Standard
9900 are just echoed from the command request, while
9904 is more or less useful information filled according to how the command
9905 execution worked out.
9906 Some commands, such as
9907 \begin_inset Quotes eld
9911 \begin_inset Quotes erd
9914 , will return information about the internal state of \SpecialChar LyX
9916 return an empty data-response.
9917 This means that the command execution went fine.
9920 \begin_layout Standard
9921 In case of errors, the response from \SpecialChar LyX
9939 \begin_layout Standard
9944 should contain an explanation of why the command failed.
9947 \begin_layout Standard
9951 \begin_layout LyX-Code
9952 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
9953 \begin_inset Newline newline
9956 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
9957 \begin_inset Newline newline
9960 read a <~/.lyxpipe.out
9961 \begin_inset Newline newline
9967 \begin_layout Subsection
9968 AppleScript (Mac OS X)
9971 \begin_layout Standard
9972 Since \SpecialChar LyX
9973 2.1, \SpecialChar LyX
9974 supports basic interactions with AppleScript for normal communicatio
9975 n through the command run.
9976 This command takes a direct argument (the
9980 to perform) and an optional argument.
9981 It either returns the output of the function or triggers an error with
9982 the error message and code.
9985 \begin_layout Standard
9989 \begin_layout LyX-Code
9990 tell application "\SpecialChar LyX
9994 \begin_layout LyX-Code
9998 \begin_layout LyX-Code
9999 -- Stores the current file name into f
10002 \begin_layout LyX-Code
10003 set f to (run "server-get-filename" with argument "")
10006 \begin_layout LyX-Code
10007 on error the error_message number the error_number
10010 \begin_layout LyX-Code
10011 display dialog "Error: " & the error_number & ".
10015 \begin_layout LyX-Code
10016 & the error_message buttons {"OK"} default button 1
10019 \begin_layout LyX-Code
10023 \begin_layout LyX-Code
10027 \begin_layout Section
10031 \begin_layout Standard
10033 can notify clients of events going on asynchronously.
10034 Currently it will only do this if the user binds a key sequence with the
10036 \begin_inset Quotes eld
10040 \begin_inset Quotes erd
10044 The format of the string \SpecialChar LyX
10045 sends is as follows:
10048 \begin_layout Quote
10049 \begin_inset Flex Code
10052 \begin_layout Plain Layout
10063 \begin_layout Standard
10068 is the printed representation of the key sequence that was actually typed
10072 \begin_layout Standard
10073 This mechanism can be used to extend \SpecialChar LyX
10074 's command set and implement macros.
10075 Bind some key sequence to
10076 \begin_inset Quotes eld
10080 \begin_inset Quotes erd
10084 Then start a client that listens on the output pipe, dispatches the command
10085 according to the sequence, and starts a function that may use \SpecialChar LyX
10088 requests to issue a command or a series of commands to \SpecialChar LyX
10092 \begin_layout Section
10093 The simple \SpecialChar LyX
10097 \begin_layout Standard
10099 implements a simple protocol that can be used for session management.
10100 All messages are of the form
10103 \begin_layout Quote
10113 \begin_layout Standard
10119 \begin_inset Quotes eld
10123 \begin_inset Quotes erd
10127 \begin_inset Quotes eld
10131 \begin_inset Quotes erd
10136 \begin_inset Quotes eld
10140 \begin_inset Quotes erd
10143 is received from a client, \SpecialChar LyX
10144 will report back to inform the client that
10145 it's listening to it's messages, while
10146 \begin_inset Quotes eld
10150 \begin_inset Quotes erd
10153 sent from \SpecialChar LyX
10154 will inform clients that \SpecialChar LyX
10158 \begin_layout Section
10159 Reverse DVI/PDF search
10162 \begin_layout Standard
10163 Some DVI/PDF viewers
10167 \begin_layout Plain Layout
10168 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
10169 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
10178 facility (also called
10183 This means that you can tell \SpecialChar LyX
10184 to put the cursor to a specific line in the
10185 document by clicking at the respective position in the DVI/PDF output.
10186 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
10188 This is done via the \SpecialChar LyX
10189 server either by using the named pipe (
10193 ), or the UNIX domain socket (
10197 ) that \SpecialChar LyX
10198 creates in its temporary directory (this is the way the
10199 \begin_inset Flex Code
10202 \begin_layout Plain Layout
10208 program communicates with \SpecialChar LyX
10210 In some cases, you need a helper script that mediates between the viewer
10211 and \SpecialChar LyX
10212 , in others, the viewer can communicate with \SpecialChar LyX
10214 This depends on the selected viewer and on your operating system.
10215 The same applies to the way viewers need to be configured and the way the
10216 reverse search is actually performed.
10217 In what follows, we will thus describe how to setup reverse search for
10219 Before we turn to this, though, we will explain what needs to be done generally
10220 to enable reverse search in the DVI/PDF output.
10223 \begin_layout Subsection
10225 \begin_inset CommandInset label
10227 name "subsec:rev-search"
10234 \begin_layout Standard
10235 In most cases \SpecialChar LyX
10236 will do the work for you by pressing the following button
10240 arg "buffer-toggle-output-sync"
10244 Alternatively, you can also enable the feature by checking
10246 Synchronize with Output
10249 \begin_inset Flex Noun
10252 \begin_layout Plain Layout
10253 Document\SpecialChar menuseparator
10254 Settings\SpecialChar menuseparator
10261 In such a case \SpecialChar LyX
10262 will automatically insert the necessary Sync\SpecialChar TeX
10264 PDF) or load the srcltx package (for DVI) respectively.
10265 This option can be easily reached also on
10266 \begin_inset Flex Code
10269 \begin_layout Plain Layout
10278 \begin_layout Standard
10279 If you need a different setting, you can select or input a custom macro
10280 from the drop down box just below
10281 \begin_inset Flex Noun
10284 \begin_layout Plain Layout
10285 Document\SpecialChar menuseparator
10286 Settings\SpecialChar menuseparator
10287 Output\SpecialChar menuseparator
10288 Synchronize with Output
10296 \begin_layout Standard
10297 Note that the method
10298 \begin_inset Flex Code
10301 \begin_layout Plain Layout
10309 enables gzip compression.
10310 If your viewer does not support it, you should instead use
10311 \begin_inset Flex Code
10314 \begin_layout Plain Layout
10325 \begin_layout Standard
10326 Please also note that including the
10327 \begin_inset Flex Code
10330 \begin_layout Plain Layout
10337 \begin_inset Flex Code
10340 \begin_layout Plain Layout
10346 sometimes has an undesired impact on the typesetting.
10347 Thus, you should switch output synchronization off for the final typesetting
10349 \begin_inset Flex Code
10352 \begin_layout Plain Layout
10359 \begin_inset Flex Code
10362 \begin_layout Plain Layout
10372 \begin_layout Standard
10373 In case you need some more special settings that are not covered by the
10374 automatic settings, read the next section about how to set up output synchroniz
10376 If the automatic setup suits your needs, you can readily jump to section
10377 \begin_inset space ~
10381 \begin_inset CommandInset ref
10383 reference "subsec:configuring-viewers"
10387 , where the necessary configuration steps in your viewer – needed both with
10388 the automatic and the manual setup – are described.
10391 \begin_layout Subsection
10395 \begin_layout Standard
10397 provides several different methods for reverse search.
10398 Some are built-in in the
10399 \begin_inset Flex Code
10402 \begin_layout Plain Layout
10408 program, some are provided by external packages.
10409 Your choice depends on whether your \SpecialChar LaTeX
10410 distribution already provides a given
10411 method (the built-in methods are rather new) and whether your viewer can
10413 The available methods are described in the following.
10416 \begin_layout Subsubsection*
10417 Built-in DVI-search via src-specials (DVI only)
10420 \begin_layout Standard
10421 This method provides the DVI file with the necessary information for reverse
10423 It is available in \SpecialChar LaTeX
10424 since quite some time (any somewhat recent \SpecialChar LaTeX
10426 should include it), and it works reliably.
10427 To enable it, change the
10428 \begin_inset Flex Noun
10431 \begin_layout Plain Layout
10442 \begin_inset Flex Noun
10445 \begin_layout Plain Layout
10456 \begin_inset Flex Noun
10459 \begin_layout Plain Layout
10460 Preferences\SpecialChar menuseparator
10461 File Handling\SpecialChar menuseparator
10468 \begin_inset Flex Code
10471 \begin_layout Plain Layout
10472 latex -src-specials $$i
10478 If this doesn't work, check if your \SpecialChar TeX
10479 engine needs different options (the
10480 syntax might differ in some distributions).
10483 \begin_layout Subsubsection*
10484 External Packages (PDFSync and scrltx)
10487 \begin_layout Standard
10496 provide reverse search facility for PDF output (via pdflatex) and DVI output,
10498 In order to enable it, load the packages in the \SpecialChar LyX
10502 \begin_layout Itemize
10503 \begin_inset Flex Code
10506 \begin_layout Plain Layout
10509 usepackage{pdfsync}
10514 for reverse PDF search,
10517 \begin_layout Itemize
10518 \begin_inset Flex Code
10521 \begin_layout Plain Layout
10524 usepackage[active]{srcltx}
10529 for reverse DVI search.
10532 \begin_layout Standard
10533 If you want to be able to perform both DVI and PDF reverse searches, you
10534 can also insert in the preamble the following lines
10537 \begin_layout LyX-Code
10541 \begin_inset Newline newline
10547 \begin_inset Newline newline
10552 usepackage{pdfsync}
10553 \begin_inset Newline newline
10559 \begin_inset Newline newline
10564 usepackage[active]{srcltx}
10565 \begin_inset Newline newline
10573 \begin_layout Standard
10574 This way, you can preview the file as either DVI or PDF (pdflatex) and the
10575 right package will be used.
10578 \begin_layout Standard
10579 Note that PDFSync might affect the output layout of your document.
10580 It is therefore advised to disable PDFsync for final documents.
10583 \begin_layout Subsubsection*
10584 Built-in reverse search via Sync\SpecialChar TeX
10588 \begin_layout Standard
10590 \begin_inset Flex Code
10593 \begin_layout Plain Layout
10599 have built-in support for both PDF and DVI reverse search.
10602 Sync\SpecialChar TeX
10605 facility is basically the result of the integration of the PDFSync package
10606 to the pdftex program and its merge with the
10611 You need at least \SpecialChar TeX
10612 Live 2008 or a recent Mik\SpecialChar TeX
10613 distribution in order to use
10618 \begin_layout Plain Layout
10619 For some reason, Mik\SpecialChar TeX
10620 does not understand/obey the command \SpecialChar LyX
10622 the preamble when you check the "Enable Forward/Reverse Search" button
10623 in the toolbar and does not generate the necessary info.
10626 \begin_layout Plain Layout
10627 The generation of the required info can be forced by changing the converter
10628 "\SpecialChar LaTeX
10629 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
10630 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
10631 the -synctex=1 switch).
10636 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
10637 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
10638 already provide Sync\SpecialChar TeX
10642 \begin_layout Standard
10643 To enable Sync\SpecialChar TeX
10644 for DVI output, change the
10645 \begin_inset Flex Noun
10648 \begin_layout Plain Layout
10659 \begin_inset Flex Noun
10662 \begin_layout Plain Layout
10667 (plain) -> DraftDVI
10673 \begin_inset Flex Noun
10676 \begin_layout Plain Layout
10677 Preferences\SpecialChar menuseparator
10678 File Handling\SpecialChar menuseparator
10685 \begin_inset Flex Code
10688 \begin_layout Plain Layout
10689 latex -synctex=1 $$i
10694 , and for PDF output, change the
10695 \begin_inset Flex Noun
10698 \begin_layout Plain Layout
10703 (pdflatex) -> PDF (pdflatex)
10709 \begin_inset Flex Code
10712 \begin_layout Plain Layout
10713 pdflatex -synctex=1 $$i
10719 Should your viewer not be considered in the following description, or in
10720 case of missing success, please check the documentation of your viewer
10721 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
10726 \begin_layout Plain Layout
10727 Note that the option
10728 \begin_inset Flex Code
10731 \begin_layout Plain Layout
10737 option enables gzip compression.
10738 If your viewer does not support it, you should instead use
10739 \begin_inset Flex Code
10742 \begin_layout Plain Layout
10756 \begin_layout Subsection
10757 Configuring and using specific viewers
10758 \begin_inset CommandInset label
10760 name "subsec:configuring-viewers"
10767 \begin_layout Subsubsection*
10768 Xdvi (all platforms)
10771 \begin_layout Standard
10773 \begin_inset Flex Code
10776 \begin_layout Plain Layout
10782 , you don't need to do anything else for performing a reverse DVI search,
10783 as \SpecialChar LyX
10784 already provides the necessary hooks for automatically using the
10785 \begin_inset Flex Code
10788 \begin_layout Plain Layout
10795 Just setup your document as described above (reverse search is triggered
10796 by Ctrl-click or Alt-click on Mac OSX, respectively).
10799 \begin_layout Standard
10800 However, if for whatever reason you want to use the named pipe instead of
10801 the socket for communicating with \SpecialChar LyX
10802 , simply change the DVI viewer in
10803 \begin_inset Flex Noun
10806 \begin_layout Plain Layout
10807 Preferences\SpecialChar menuseparator
10808 File Handling\SpecialChar menuseparator
10818 \begin_layout Plain Layout
10819 On Mac OSX you have to use
10820 \begin_inset Flex Code
10823 \begin_layout Plain Layout
10824 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
10835 \begin_inset Flex Code
10838 \begin_layout Plain Layout
10839 xdvi -editor "lyxeditor.sh %f %l"
10845 \begin_inset Flex Code
10848 \begin_layout Plain Layout
10854 is a suitable script.
10855 For example, a minimal shell script is the following one:
10858 \begin_layout LyX-Code
10860 \begin_inset Newline newline
10863 LYXPIPE="/path/to/lyxpipe"
10864 \begin_inset Newline newline
10867 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
10868 \begin_inset Newline newline
10871 echo "$COMMAND" > "${LYXPIPE}".in || exit
10872 \begin_inset Newline newline
10875 read TMP < "${LYXPIPE}".out || exit
10878 \begin_layout Standard
10880 \begin_inset Flex Code
10883 \begin_layout Plain Layout
10889 is the LyXServer pipe path specified in
10890 \begin_inset Flex Noun
10893 \begin_layout Plain Layout
10894 Preferences\SpecialChar menuseparator
10904 \begin_layout Plain Layout
10906 \begin_inset Flex Code
10909 \begin_layout Plain Layout
10915 folder of a source distribution you can find a
10916 \begin_inset Flex Code
10919 \begin_layout Plain Layout
10925 script which is able to locate the
10929 based on your preferences.
10937 \begin_layout Subsubsection*
10941 \begin_layout Standard
10943 \begin_inset Flex Code
10946 \begin_layout Plain Layout
10947 /Applications/MacDviX_Folder/calleditor.script
10952 , add the following lines:
10955 \begin_layout LyX-Code
10956 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
10957 \begin_inset Newline newline
10963 \begin_layout Standard
10964 Modify the lines accordingly if you install \SpecialChar LyX
10965 somewhere else than in the
10966 Applications folder.
10969 \begin_layout Standard
10970 Reverse search is triggered by Alt-click (OPTION-click).
10973 \begin_layout Subsubsection*
10977 \begin_layout Standard
10979 \begin_inset Flex Code
10982 \begin_layout Plain Layout
10983 open -a Skim.app $$i
10988 to the viewer setting in
10989 \begin_inset Flex Noun
10992 \begin_layout Plain Layout
10993 Preferences\SpecialChar menuseparator
10994 File Handling\SpecialChar menuseparator
10995 File formats\SpecialChar menuseparator
11002 \begin_inset Flex Noun
11005 \begin_layout Plain Layout
11006 Skim\SpecialChar menuseparator
11007 Preferences\SpecialChar menuseparator
11014 \begin_inset Flex Noun
11017 \begin_layout Plain Layout
11023 preset and enter command
11024 \begin_inset Flex Noun
11027 \begin_layout Plain Layout
11028 /Applications/\SpecialChar LyX
11029 .app/Contents/MacOS/lyxeditor
11037 \begin_layout Standard
11038 Reverse search is triggered by COMMAND-SHIFT-click
11041 \begin_layout Subsubsection*
11045 \begin_layout Standard
11046 Reverse search with evince does not work out of the box, but it can be achieved
11047 by means of some third party helper scripts.
11049 \begin_inset CommandInset href
11051 target "https://wiki.lyx.org/LyX/SyncTeX"
11059 \begin_layout Subsubsection*
11063 \begin_layout Standard
11065 \begin_inset Flex Noun
11068 \begin_layout Plain Layout
11069 Settings\SpecialChar menuseparator
11070 Configure Okular\SpecialChar menuseparator
11077 \begin_inset Quotes erd
11081 This inserts the appropriate command (
11082 \begin_inset Flex Code
11085 \begin_layout Plain Layout
11094 \begin_layout Standard
11095 Reverse search is triggered by SHIFT-click.
11097 \change_inserted -712698321 1578211026
11098 Note that this only works if Okular is in
11099 \begin_inset Quotes eld
11103 \begin_inset Quotes erd
11107 \begin_inset space \thinspace{}
11110 e., the hand symbol is clicked).
11115 \begin_layout Subsubsection*
11119 \begin_layout Standard
11120 Qpdfview supports Sync\SpecialChar TeX
11121 since version 0.3.5.
11123 \begin_inset Flex Noun
11126 \begin_layout Plain Layout
11127 Edit\SpecialChar menuseparator
11128 Settings\SpecialChar menuseparator
11134 , click on the input field of the
11135 \begin_inset Quotes eld
11139 \begin_inset Quotes erd
11142 item and add the command
11143 \begin_inset Flex Code
11146 \begin_layout Plain Layout
11155 \begin_layout Standard
11156 Reverse search is triggered by double-click or, in more recent versions,
11160 \begin_layout Subsubsection*
11164 \begin_layout Standard
11165 Launch yap, choose its
11166 \begin_inset Flex Noun
11169 \begin_layout Plain Layout
11170 View\SpecialChar menuseparator
11176 menu and select the
11177 \begin_inset Quotes eld
11181 \begin_inset Quotes erd
11186 \begin_inset Quotes eld
11189 New\SpecialChar ldots
11191 \begin_inset Quotes erd
11194 button and, in the window that opens, enter
11195 \begin_inset Quotes eld
11200 \begin_inset Quotes erd
11203 (or any other name you like) in the
11204 \begin_inset Quotes eld
11208 \begin_inset Quotes erd
11212 Now click on the button labeled
11213 \begin_inset Quotes eld
11218 \begin_inset Quotes erd
11221 to open a file dialog and navigate to the directory containing the batch
11223 \begin_inset Flex Code
11226 \begin_layout Plain Layout
11234 \begin_inset Flex Code
11237 \begin_layout Plain Layout
11243 and then specify the program arguments as
11244 \begin_inset Flex Code
11247 \begin_layout Plain Layout
11255 \begin_inset Flex Code
11258 \begin_layout Plain Layout
11264 wrapper is used for communicating with \SpecialChar LyX
11272 \begin_layout LyX-Code
11274 \begin_inset Newline newline
11277 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
11286 \begin_inset Newline newline
11300 \begin_layout Standard
11301 Make sure that the \SpecialChar LyX
11302 Server pipe path you specified in \SpecialChar LyX
11304 \begin_inset Flex Code
11307 \begin_layout Plain Layout
11321 , otherwise change the
11322 \begin_inset Flex Code
11325 \begin_layout Plain Layout
11331 wrapper accordingly.
11334 \begin_layout Standard
11335 In yap, reverse search is triggered by double-click.
11338 \begin_layout Subsubsection*
11339 SumatraPDF (Windows)
11342 \begin_layout Standard
11343 In order to use SumatraPDF for inverse search, enter
11344 \begin_inset Flex Code
11347 \begin_layout Plain Layout
11348 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
11353 in the viewer setting in
11354 \begin_inset Flex Noun
11357 \begin_layout Plain Layout
11358 Preferences\SpecialChar menuseparator
11359 File Handling\SpecialChar menuseparator
11360 File formats\SpecialChar menuseparator
11367 \begin_inset Flex Code
11370 \begin_layout Plain Layout
11376 is the previous wrapper.
11377 If SumatraPDF.exe is not in your command PATH, use its full file name.
11380 \begin_layout Standard
11381 Reverse search is triggered by double-click.
11384 \begin_layout Subsubsection*
11388 \begin_layout Standard
11389 First of all, make sure that yap is your default DVI viewer in the Windows
11390 environment, then launch it, choose its
11391 \begin_inset Flex Noun
11394 \begin_layout Plain Layout
11395 View\SpecialChar menuseparator
11401 menu and select the
11402 \begin_inset Quotes eld
11406 \begin_inset Quotes erd
11411 \begin_inset Quotes eld
11414 New\SpecialChar ldots
11416 \begin_inset Quotes erd
11419 button and, in the window that opens, enter
11420 \begin_inset Quotes eld
11425 \begin_inset Quotes erd
11428 (or any other name you like) in the
11429 \begin_inset Quotes eld
11433 \begin_inset Quotes erd
11437 Now click on the button labeled
11438 \begin_inset Quotes eld
11443 \begin_inset Quotes erd
11446 to open a file dialog and navigate to the directory containing the
11447 \begin_inset Flex Code
11450 \begin_layout Plain Layout
11456 program (which is installed by default on Cygwin along with the \SpecialChar LyX
11459 \begin_inset Flex Code
11462 \begin_layout Plain Layout
11468 and then specify the program arguments as
11469 \begin_inset Flex Code
11472 \begin_layout Plain Layout
11479 In this way, you will be using the
11483 for communicating with \SpecialChar LyX
11485 If, for whatever reason, you want to use the
11490 \begin_inset Flex Code
11493 \begin_layout Plain Layout
11499 option and be sure to specify the \SpecialChar LyX
11500 Server pipe path in the \SpecialChar LyX
11504 \begin_layout Standard
11505 In yap, reverse search is triggered by double-click.
11508 \begin_layout Subsubsection*
11509 SumatraPDF (Cygwin)
11512 \begin_layout Standard
11513 In order to use SumatraPDF for inverse search, enter
11514 \begin_inset Flex Code
11517 \begin_layout Plain Layout
11518 SumatraPDF -inverse-search "lyxeditor -g %f %l"
11523 in the viewer setting in
11524 \begin_inset Flex Noun
11527 \begin_layout Plain Layout
11528 Preferences\SpecialChar menuseparator
11529 File Handling\SpecialChar menuseparator
11530 File formats\SpecialChar menuseparator
11537 If SumatraPDF.exe is not in your command PATH, use its full posix path.
11539 \begin_inset Flex Code
11542 \begin_layout Plain Layout
11548 enables communication via the
11554 \begin_inset Flex Code
11557 \begin_layout Plain Layout
11563 option if you want to use the
11567 , and be sure to specify the \SpecialChar LyX
11568 Server pipe path in the \SpecialChar LyX
11572 \begin_layout Standard
11573 Reverse search is triggered by double-click.
11576 \begin_layout Section
11580 \begin_layout Standard
11581 Forward search is, as the name implies, in a sense the
11582 \begin_inset Quotes eld
11586 \begin_inset Quotes erd
11590 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
11592 If forward search is set up (as described in what follows), you can put
11593 the cursor anywhere in your \SpecialChar LyX
11595 \begin_inset Flex Noun
11598 \begin_layout Plain Layout
11599 Navigate\SpecialChar menuseparator
11606 \begin_inset Flex Noun
11609 \begin_layout Plain Layout
11615 in the context menu via right mouse click), and then the viewer will jump
11616 to that position as well.
11617 This implies, of course, that your viewer supports this function.
11620 \begin_layout Standard
11621 To make forward search possible, you first need to provide the generated
11622 output PDF/DVI file with additional information about the \SpecialChar TeX
11624 This can be done via the methods described in the section
11625 \begin_inset CommandInset ref
11627 reference "subsec:rev-search"
11634 \begin_layout Standard
11635 Additionally, you need to configure \SpecialChar LyX
11636 for using your viewers in
11637 \begin_inset Flex Noun
11640 \begin_layout Plain Layout
11641 Tools\SpecialChar menuseparator
11642 Preferences\SpecialChar menuseparator
11643 Output\SpecialChar menuseparator
11650 We provide a range of tested configurations for some viewers, which you
11651 can select from the drop down list.
11652 If none of these configurations suits you, you have to find out and enter
11653 a suitable configuration yourself.
11654 The definition syntax uses the following placeholders:
11657 \begin_layout Itemize
11659 \begin_inset Flex Code
11662 \begin_layout Plain Layout
11671 \begin_layout Itemize
11673 \begin_inset Flex Code
11676 \begin_layout Plain Layout
11682 : name of the (temporary) exported .tex file (without path)
11685 \begin_layout Itemize
11687 \begin_inset Flex Code
11690 \begin_layout Plain Layout
11696 : name of the (temporary) exported .tex file (including path)
11699 \begin_layout Itemize
11701 \begin_inset Flex Code
11704 \begin_layout Plain Layout
11710 : name of the exported output file (either dvi or pdf, depending on which
11711 one exists in the temporary directory)
11714 \begin_layout Standard
11715 Note that only some of the viewers provide full and usable forward search
11716 functionality out of the box, among them yap, xdvi, okular
11720 \begin_layout Plain Layout
11721 You might want to set
11722 \begin_inset Flex Code
11725 \begin_layout Plain Layout
11732 \begin_inset Flex Noun
11735 \begin_layout Plain Layout
11736 Tools\SpecialChar menuseparator
11737 Preferences\SpecialChar menuseparator
11738 File Handling\SpecialChar menuseparator
11740 \begin_inset space ~
11753 , qpdfview, and SumatraPDF
11757 \begin_layout Plain Layout
11758 SumatraPDF can also use DDE commands through the external program CMCDDE
11759 — downloadable from
11760 \begin_inset CommandInset href
11762 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
11773 Others, such as evince
11777 \begin_layout Plain Layout
11778 Forward search with evince can be achieved by means of third party helper
11781 \begin_inset CommandInset href
11783 target "https://wiki.lyx.org/LyX/SyncTeX"
11793 , require some extra tools in order to use forward search.
11794 While many of the widespread PDF viewers (most notably Adobe Reader) do
11795 not support forward search at all, some other viewers – e.
11796 \begin_inset space \thinspace{}
11800 xpdf – allow at least to reload the document and jump to a specific page
11801 of the file, so you can at least navigate
11802 \begin_inset Quotes eld
11806 \begin_inset Quotes erd
11810 This latter functionality is provided by an external call of synctex (see
11811 the predefined example configurations).
11815 \begin_layout Standard
11816 Forward search works both with DVI and PDF output.
11818 simply checks which preview format you have used before (i.
11819 \begin_inset space \thinspace{}
11822 e., which format is already there in the temporary directory) and chooses
11823 the appropriate configuration for the respective format.
11826 \begin_layout Chapter
11827 Special Document Classes
11830 \begin_layout Section
11832 \change_deleted 564990737 1669742044
11836 \begin_layout Standard
11838 \change_deleted 564990737 1669742044
11844 \begin_layout Subsection
11846 \change_deleted 564990737 1669742044
11850 \begin_layout Standard
11852 \change_deleted 564990737 1669742044
11853 This section describes how \SpecialChar LyX
11854 can be used to write articles for submission
11855 to the scientific journal
11857 Astronomy and Astrophysics
11860 \begin_inset Flex URL
11863 \begin_layout Plain Layout
11865 https://www.aanda.org/
11870 ) using Version 5.01 of the document class
11875 This package can be downloaded from the ftp site
11878 \begin_layout Standard
11880 \change_deleted 564990737 1669742044
11881 \begin_inset VSpace medskip
11887 \begin_layout Standard
11890 \change_deleted 564990737 1669742044
11891 \begin_inset Flex URL
11894 \begin_layout Plain Layout
11896 ftp://ftp.edpsciences.org/pub/aa/readme.html
11904 \begin_layout Standard
11906 \change_deleted 564990737 1669742044
11907 \begin_inset VSpace medskip
11913 \begin_layout Standard
11915 \change_deleted 564990737 1669742044
11916 A manual comes together with that package, and this text is not meant to
11917 replace the original manual but is merely a short guide in how to realize
11918 the correct form of your paper.
11922 \begin_layout Standard
11924 \change_deleted 564990737 1669742044
11925 Please note that the publisher of the journal was changed from Springer
11926 to EDP Sciences starting January 1, 2001.
11927 That change involved also some slight changes to the style files, namely
11928 the removal of the thesaurus command.
11929 The \SpecialChar LyX
11930 class aa supports the newest version of these style files, V 5.01.
11931 If you have an older version installed, please upgrade.
11932 For compatibility, the old (version 4) layout has been kept as
11937 Please refer to the comments in
11940 Dir/layouts/aapaper.layout
11945 \begin_layout Subsection
11947 \change_deleted 564990737 1669742044
11951 \begin_layout Standard
11953 \change_deleted 564990737 1669742044
11954 It is recommended you start from the example template distributed with \SpecialChar LyX
11956 If you are not using a template, note the following settings:
11959 \begin_layout Itemize
11961 \change_deleted 564990737 1669742044
11968 Document\SpecialChar menuseparator
11971 dialog (OK, that one was obvious).
11974 \begin_layout Itemize
11976 \change_deleted 564990737 1669742044
11977 Don't change the option
11980 \begin_inset space ~
11990 The whole layout is done by the macros, you shouldn't change anything.
11993 \begin_layout Subsection
11995 \change_deleted 564990737 1669742044
11999 \begin_layout Standard
12001 \change_deleted 564990737 1669742044
12002 First thing to enter is the header information.
12003 It consists of seven entries, of which some are optional.
12007 \begin_layout Itemize
12009 \change_deleted 564990737 1669742044
12017 \begin_layout Itemize
12019 \change_deleted 564990737 1669742044
12027 \begin_layout Itemize
12029 \change_deleted 564990737 1669742044
12037 \begin_layout Itemize
12039 \change_deleted 564990737 1669742044
12047 \begin_layout Itemize
12049 \change_deleted 564990737 1669742044
12054 : [optional] if more than one author: whom to contact for offprint requests.
12057 \begin_layout Itemize
12059 \change_deleted 564990737 1669742044
12064 : [optional] mail address for contacts.
12067 \begin_layout Itemize
12069 \change_deleted 564990737 1669742044
12075 Suggested format is
12077 Received: <date>; Accepted <date>
12080 \begin_layout Standard
12082 \change_deleted 564990737 1669742044
12083 There is no need to issue the
12089 command, this is done automatically by \SpecialChar LyX
12090 when the header is finished.
12091 Although the order of the single header entries doesn't matter it is advised
12092 to keep the above sequence, just to get the best optics and meets the layout
12093 of the real document.
12096 \begin_layout Standard
12098 \change_deleted 564990737 1669742044
12099 If you want to place footnotes in the header block, e.
12100 \begin_inset space \thinspace{}
12104 \begin_inset space \space{}
12107 to state your present address, just use the standard footnote via the menu
12110 Insert\SpecialChar menuseparator
12115 will automagically use the term
12124 \begin_layout Standard
12126 \change_deleted 564990737 1669742044
12129 Edit\SpecialChar menuseparator
12132 , you'll find two insets which are relevant for the titling:
12135 \begin_layout Itemize
12137 \change_deleted 564990737 1669742044
12144 to mark corresponding author\SpecialChar breakableslash
12146 The institutes are numbered sequentially as they appear in the
12150 field, so you have to put a marker to each author.
12153 \begin_layout Itemize
12155 \change_deleted 564990737 1669742044
12160 to supply an email address for fast contact.
12163 \begin_layout Standard
12165 \change_deleted 564990737 1669742044
12166 In addition to these topics, the macros use one additional \SpecialChar LaTeX
12168 has no counterpart in \SpecialChar LyX
12172 \begin_layout Itemize
12174 \change_deleted 564990737 1669742044
12181 to separate different names for more than one author and institute, respectivel
12185 \begin_layout Standard
12187 \change_deleted 564990737 1669742044
12188 The appropriate command has to be entered in \SpecialChar LyX
12189 and marked as \SpecialChar LaTeX
12195 \begin_layout Subsection
12197 \change_deleted 564990737 1669742044
12201 \begin_layout Standard
12203 \change_deleted 564990737 1669742044
12204 The abstract should immediately follow the header block.
12205 With version 5 the abstract environment was changed to a command, and there
12206 is now a restriction to only one paragraph.
12207 In addition, it should contain an entry with the keywords.
12208 This is done via the paragraph style
12213 Refer to the example paper.
12216 \begin_layout Subsection
12218 \change_deleted 564990737 1669742044
12219 Supported environments
12222 \begin_layout Standard
12224 \change_deleted 564990737 1669742044
12225 The A&A paper layout supports the following environments for structuring
12229 \begin_layout Itemize
12231 \change_deleted 564990737 1669742044
12237 \begin_layout Itemize
12239 \change_deleted 564990737 1669742044
12245 \begin_layout Itemize
12247 \change_deleted 564990737 1669742044
12253 \begin_layout Itemize
12255 \change_deleted 564990737 1669742044
12261 \begin_layout Itemize
12263 \change_deleted 564990737 1669742044
12269 \begin_layout Itemize
12271 \change_deleted 564990737 1669742044
12277 \begin_layout Itemize
12279 \change_deleted 564990737 1669742044
12285 \begin_layout Itemize
12287 \change_deleted 564990737 1669742044
12293 \begin_layout Itemize
12295 \change_deleted 564990737 1669742044
12301 \begin_layout Itemize
12303 \change_deleted 564990737 1669742044
12309 \begin_layout Itemize
12311 \change_deleted 564990737 1669742044
12317 \begin_layout Itemize
12319 \change_deleted 564990737 1669742044
12326 \begin_layout Subsection
12328 \change_deleted 564990737 1669742044
12329 Commands not supported by \SpecialChar LyX
12333 \begin_layout Standard
12335 \change_deleted 564990737 1669742044
12336 Some commands are not yet supported by the
12340 layout for \SpecialChar LyX
12342 Some have already been mentioned.
12343 For the sake of completeness, they are listed all together here:
12346 \begin_layout Itemize
12348 \change_deleted 564990737 1669742044
12356 \begin_layout Itemize
12358 \change_deleted 564990737 1669742044
12366 \begin_layout Itemize
12368 \change_deleted 564990737 1669742044
12376 \begin_layout Itemize
12378 \change_deleted 564990737 1669742044
12386 \begin_layout Standard
12388 \change_deleted 564990737 1669742044
12389 If you want to use any of these commands, you have to enter them yourself.
12392 Do not forget to mark them as \SpecialChar LaTeX
12396 \begin_layout Subsection
12398 \change_deleted 564990737 1669742044
12399 Figure and Table Floats
12402 \begin_layout Standard
12404 \change_deleted 564990737 1669742044
12406 provides support for the necessary float environments
12408 figure, figure*, table
12414 , therefore we won't tell much about it here.
12418 \begin_inset space ~
12424 Just remember that tables should be left-aligned.
12425 For that, select the table and change the alignment in
12427 Edit\SpecialChar menuseparator
12429 \begin_inset space ~
12435 \begin_layout Standard
12437 \change_deleted 564990737 1669742044
12438 There is only one special thing: the figures with caption besides the figure.
12439 To create such a figure, you have to do the following:
12442 \begin_layout Enumerate
12444 \change_deleted 564990737 1669742044
12445 Create a wide figure float:
12447 Insert\SpecialChar menuseparator
12448 Float\SpecialChar menuseparator
12451 , then right click in the figure and select
12454 \begin_inset space ~
12462 \begin_layout Enumerate
12464 \change_deleted 564990737 1669742044
12465 Enter your caption text.
12468 \begin_layout Enumerate
12470 \change_deleted 564990737 1669742044
12475 to move the cursor above the caption.
12478 \begin_layout Enumerate
12480 \change_deleted 564990737 1669742044
12484 \begin_layout Enumerate
12486 \change_deleted 564990737 1669742044
12487 Position the cursor behind the figure and insert a horizontal fill:
12489 Insert\SpecialChar menuseparator
12491 \begin_inset space ~
12494 Character\SpecialChar menuseparator
12496 \begin_inset space ~
12504 \begin_layout Enumerate
12506 \change_deleted 564990737 1669742044
12507 Switch to \SpecialChar LaTeX
12511 \begin_inset space ~
12519 \begin_layout Enumerate
12521 \change_deleted 564990737 1669742044
12531 Do not close the brace!
12534 \begin_layout Enumerate
12536 \change_deleted 564990737 1669742044
12537 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
12542 \begin_inset space ~
12554 \begin_layout Standard
12556 \change_deleted 564990737 1669742044
12557 Also, refer to the figures in the example paper.
12560 \begin_layout Subsection
12562 \change_deleted 564990737 1669742044
12566 \begin_layout Standard
12568 \change_deleted 564990737 1669742044
12569 For submission, the paper has to be formated in a special double-spacing
12571 For this purpose, you have to give the option
12575 to the document class.
12576 This must be done using the custom class options field in the
12578 Document\SpecialChar menuseparator
12582 Just enter the string
12589 \begin_layout Subsection
12591 \change_deleted 564990737 1669742044
12595 \begin_layout Standard
12597 \change_deleted 564990737 1669742044
12602 directory contains an example paper written with \SpecialChar LyX
12604 It is the example paper from the original macro package, translated to
12607 Use it for inspiration, and compare the original \SpecialChar LaTeX
12608 code with \SpecialChar LyX
12612 \begin_layout Section
12613 AAS\SpecialChar TeX
12617 \begin_layout Standard
12623 \begin_layout Subsection
12627 \begin_layout Standard
12628 AAS\SpecialChar TeX
12629 is a set of macros produced by the American Astronomical Society to
12630 facilitate electronic manuscript submission to the three journals they
12631 publish: the Astrophysical Journal (including the Letters and Supplement),
12632 the Astronomical Journal, and the Publications of the Astronomical Society
12635 has proven to be an excellent tool for generating these documents, especially
12636 given its equation, citation, and figure handling capabilities.
12638 requires version 5.0 (or higher) of these macros; preferably 6.0, which
12639 is the version described here, or higher.
12640 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
12641 2.09 and are fundamentally
12642 incompatible with \SpecialChar LyX
12644 The AAS\SpecialChar TeX
12645 package may be downloaded from the AAS\SpecialChar TeX
12649 \begin_layout Standard
12650 \begin_inset VSpace medskip
12656 \begin_layout Standard
12658 \begin_inset Flex URL
12661 \begin_layout Plain Layout
12663 https://aas.org/aastex/aastex-downloads
12671 \begin_layout Standard
12672 \begin_inset VSpace medskip
12678 \begin_layout Standard
12679 A complete user guide is contained in that package and you should familiarize
12680 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
12683 will not reduce the need to figure out all the AAS\SpecialChar TeX
12684 commands, it will only
12685 reduce the drudgery of typing everything in.
12686 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
12688 completely to the requirements of the journal to which you are submitting
12692 \begin_layout Subsection
12693 Starting a New Paper
12696 \begin_layout Standard
12697 I strongly suggest that you start with the AAS\SpecialChar TeX
12701 File\SpecialChar menuseparator
12708 , enter the new file name, then choose the
12713 This will show the most common fields found in a manuscript.
12714 Simply overwrite the existing text (including the brackets,
12718 ) with the correct information.
12719 Many of the AAS\SpecialChar TeX
12720 commands and environments can be implemented directly in
12723 For commands such as these, the \SpecialChar LaTeX
12724 code must be entered directly and marked
12726 Such commands are referred to as \SpecialChar TeX
12727 code, or Evil Red Text.
12728 I tried to minimize the amount of \SpecialChar TeX
12729 code needed in an AAS\SpecialChar TeX
12733 \begin_layout Subsection
12734 Finishing Your Paper
12737 \begin_layout Standard
12738 When the paper is finished to your satisfaction and previews/prints correctly,
12740 \begin_inset Quotes eld
12744 \begin_inset Quotes erd
12747 actions which need to be done before you submit it to the journals.
12751 \begin_layout Enumerate
12752 Export your paper as a \SpecialChar LaTeX
12755 File\SpecialChar menuseparator
12756 Export\SpecialChar menuseparator
12764 \begin_layout Enumerate
12769 file with your favorite text editor
12773 \begin_layout Enumerate
12774 remove the comment lines before the
12783 \begin_layout Enumerate
12788 usepackage...{fontenc}
12790 line if it appears (usually just after
12802 line if it appears.
12805 \begin_layout Enumerate
12806 remove everything between (and including) the
12818 commands, except for any commands you specifically put into the \SpecialChar LaTeX
12820 (which should appear immediately after the
12821 \begin_inset Quotes eld
12824 User specified \SpecialChar LaTeX
12826 \begin_inset Quotes erd
12837 \begin_layout Enumerate
12838 Run the resulting file through \SpecialChar LaTeX
12839 to make sure it still processes correctly.
12842 \begin_layout Enumerate
12843 Reread the journal requirements to make sure your filenames and formats
12847 \begin_layout Enumerate
12851 \begin_layout Subsection
12852 Comments On Specific Commands
12855 \begin_layout Standard
12856 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
12858 AAS\SpecialChar TeX
12863 ) gives a good description of each.
12864 Thus it's probably easiest for me to go down the list as found in the guide
12865 and offer comments where necessary.
12866 So let's begin \SpecialChar ldots
12870 \begin_layout Subsubsection
12871 Things that work as expected
12874 \begin_layout Standard
12875 Because they work as you might expect, I simply list them and the section
12976 begin{thebibliography}
12984 (2.13.2), all the cite commands and their variations (2.13.2), the generic
12985 graphicx figure commands (2.14.1),
13009 (2.15.4, amongst other places),
13036 \begin_layout Standard
13037 The following style options also work correctly:
13058 Simply put them in the
13064 Layout\SpecialChar menuseparator
13070 \begin_layout Subsubsection
13071 Things that work, but require more comment
13074 \begin_layout Standard
13075 The following items work, but require a little more discussion:
13078 \begin_layout Itemize
13079 These items are reserved for use by the journal editors, but you can put
13080 them into the \SpecialChar LaTeX
13081 preamble if you feel compelled to do so:
13114 \begin_layout Itemize
13115 These items may be placed in the \SpecialChar LaTeX
13116 preamble, and are included as blanks in
13138 \begin_layout Itemize
13145 (2.3) – can only be used
13146 \begin_inset Quotes eld
13150 \begin_inset Quotes erd
13153 , not in the middle of a paragraph.
13154 Use \SpecialChar TeX
13155 code if you need to embed it.
13158 \begin_layout Itemize
13165 (2.3) – will have extra {} after it.
13166 This should not cause an error.
13169 \begin_layout Itemize
13176 (2.6) – can only be used
13177 \begin_inset Quotes eld
13181 \begin_inset Quotes erd
13184 , not in the middle of a paragraph.
13185 Use \SpecialChar TeX
13186 code if you need to embed it.
13189 \begin_layout Itemize
13196 (2.8) – can't insert a cross-reference tag, you must type the tag name by
13200 \begin_layout Itemize
13207 (2.8) – same as for
13214 \begin_layout Itemize
13221 (2.9) – will have extra {} after it.
13222 This should not cause an error.
13225 \begin_layout Itemize
13232 (2.11) – will have extra {} after it.
13233 This should not cause an error.
13236 \begin_layout Itemize
13243 (2.14.2) – you can insert an optional filename argument by placing the cursor
13244 at the beginning of the text and selecting
13246 Insert\SpecialChar menuseparator
13251 \begin_inset Quotes eld
13255 \begin_inset Quotes erd
13258 inserts an optional argument of the type needed by
13265 Hopefully it will be renamed someday.
13268 \begin_layout Itemize
13281 for the catalog ID optional parameter
13284 \begin_layout Itemize
13297 for the catalog ID optional parameter
13300 \begin_layout Subsubsection
13301 Things not implemented, use \SpecialChar TeX
13305 \begin_layout Standard
13316 setcounter{equation}
13318 (2.12), Journal name abbreviations (2.13.4),
13354 (2.15.4, insert it as the first element in the lefthand cell after where
13356 Don't use any of \SpecialChar LyX
13357 's rules in the table),
13369 (2.15.5), much of Misc (2.17, except
13420 \begin_layout Subsubsection
13421 Things that cannot be implemented
13424 \begin_layout Standard
13426 at least in any meaningful sort of way, so I suggest ignoring them.
13427 They are the references environment (2.13.3), and the deluxetable environment
13429 If you really, really need to use deluxetable, I suggest editing it in
13430 a separate file with a text editor, then using
13432 Insert\SpecialChar menuseparator
13434 \begin_inset space ~
13439 to include it in your \SpecialChar LyX
13445 file to see an example of this.
13448 \begin_layout Subsection
13449 FAQs, Tips, Tricks, and Other Ruminations
13452 \begin_layout Subsubsection
13453 Getting \SpecialChar LyX
13454 and AAS\SpecialChar TeX
13458 \begin_layout Standard
13459 It can be a bit tricky to get \SpecialChar LyX
13460 to recognize a new layout and document class.
13461 When all else fails, do this:
13464 \begin_layout Enumerate
13465 Make certain that \SpecialChar LaTeX
13466 can find AAS\SpecialChar TeX
13468 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
13469 distribution into a
13470 directory completely unrelated to \SpecialChar LaTeX
13471 or AAS\SpecialChar TeX
13472 and run \SpecialChar LaTeX
13480 \begin_layout Enumerate
13485 appears in \SpecialChar LyX
13493 \begin_layout Enumerate
13496 Tools\SpecialChar menuseparator
13499 in \SpecialChar LyX
13500 , then restart \SpecialChar LyX
13504 \begin_layout Enumerate
13505 Open a regular new file, not from a template.
13506 Does AAS\SpecialChar TeX
13507 appear in the class list in
13509 Document\SpecialChar menuseparator
13515 \begin_layout Standard
13516 If you get a warning from an existing AAS\SpecialChar TeX
13517 document about not being able
13518 to find the AAS\SpecialChar TeX
13519 layout or a message about
13520 \begin_inset Quotes eld
13523 You should not mix title layouts with normal ones
13524 \begin_inset Quotes erd
13527 , things haven't been installed correctly.
13530 \begin_layout Subsubsection
13532 error processing a table
13535 \begin_layout Standard
13537 , by default, attempts to center the table caption/title.
13538 This seems to produce a bad interaction in AAS\SpecialChar TeX
13539 so you should click somewhere
13540 in the caption/title, then select
13542 Edit\SpecialChar menuseparator
13544 \begin_inset space ~
13558 This took care of it for me.
13561 \begin_layout Subsubsection
13565 \begin_layout Standard
13566 A couple of things: 1) I have noticed some funny spacing in the reference
13567 entries in the text.
13568 When you enter the bibliography item data, make sure their is
13572 space between the last author and the parenthesis setting off the year;
13576 \begin_inset space \thinspace{}
13580 \begin_inset space \space{}
13594 2) Entering the references at all is not obvious.
13595 The easiest thing is to start typing your first reference at the end of
13596 the document, then mark it as type
13601 That will put a small gray box in front of what you just typed.
13602 Click on the box to fill in the rest of the information.
13603 For new references, go to the end of an existing reference and press return.
13604 That will create a new line with its own box, etc.
13607 \begin_layout Subsubsection
13608 Including EPS files
13611 \begin_layout Standard
13612 Even though AAS\SpecialChar TeX
13613 provides its own figure commands (
13619 , for example), I much prefer \SpecialChar LaTeX
13620 's standard figure commands (with the default
13629 \begin_inset space ~
13632 commands as \SpecialChar TeX
13633 code into a Figure Float box if you desire, but I never have
13634 much luck getting the layout right.
13635 With the standard graphics, \SpecialChar LyX
13640 usepackage{graphicx}
13642 command into the \SpecialChar LaTeX
13643 preamble and handle the figures in the standard \SpecialChar LaTeX2e
13645 interspersing the figures in the text.
13646 I believe ApJ accepts figures exactly this way now; AJ might still use
13648 \begin_inset Quotes eld
13651 stack everything at the end
13652 \begin_inset Quotes erd
13658 \begin_layout Subsubsection
13659 Things I could have done, but didn't
13662 \begin_layout Standard
13664 \begin_inset Quotes eld
13668 \begin_inset Quotes erd
13671 things I could have implemented, but chose not to.
13672 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
13674 even though it is double-spaced in the paper manuscript.
13675 Also, I chose not to make separate layouts for the preprint and preprint2
13677 Since I assume you will spend most of your time in the plain manuscript
13678 mode anyway, I decided not to chew up more disk space with this.
13682 \begin_layout Subsection
13686 \begin_layout Standard
13687 Your mileage may vary.
13688 I've now had papers published by both ApJ and AJ that have had 98% of the
13689 effort done in \SpecialChar LyX
13690 ; the last 2% was the \SpecialChar LaTeX
13691 post-processing and a few cleanups.
13692 I have had no trouble with the submission process, and I'm sure the journals
13693 were never aware that there might be a difference.
13694 So, go forth and publish!
13697 \begin_layout Section
13701 \begin_layout Standard
13706 can be used to type letters according to German conventions.
13707 A template file is included in
13709 .../lyx/share/templates
13711 for you to use as a starting point.
13714 \begin_layout Section
13718 \begin_layout Standard
13719 See the \SpecialChar LyX
13725 It contains all infos you need.
13728 \begin_layout Section
13731 Foil\SpecialChar TeX
13735 \begin_inset CommandInset label
13744 \begin_layout Standard
13750 \begin_layout Subsection
13754 \begin_layout Standard
13755 This section describes how to use \SpecialChar LyX
13756 to make slides for overhead projectors.
13757 There are two document classes that can do this: the default slides class
13760 Foil\SpecialChar TeX
13764 This section documents the latter.
13767 \begin_layout Standard
13768 I'm going to say this again, nice and clear, so that there's no misunderstanding
13772 \begin_layout Standard
13773 \begin_inset VSpace bigskip
13779 \begin_layout Standard
13783 This section documents the class
13784 \begin_inset Quotes eld
13792 \begin_inset Quotes erd
13800 \begin_layout Standard
13801 \begin_inset VSpace bigskip
13807 \begin_layout Standard
13808 If you're looking for the documentation for
13809 \begin_inset Quotes eld
13817 \begin_inset Quotes erd
13820 , check out section
13821 \begin_inset space ~
13825 \begin_inset CommandInset ref
13827 reference "sec:slitex"
13832 If your machine doesn't have the
13840 installed, you'll probably have to use the default
13844 class, which isn't quite as good as
13849 \begin_layout Standard
13854 class is designed for use with version
13855 \begin_inset space ~
13863 class file which is now an integral part of \SpecialChar LaTeX2e
13867 \begin_layout Subsection
13871 \begin_layout Standard
13872 Obviously, to use this document class, you need to select
13883 \begin_inset space ~
13889 There are some settings in the
13892 \begin_inset space ~
13897 dialog that you should know about that are specific to this class:
13900 \begin_layout Itemize
13901 Don't change the options
13912 \begin_inset space ~
13918 They're ignored by the
13925 \begin_layout Itemize
13926 The default font size is 20
13927 \begin_inset space \thinspace{}
13930 pt with the other options being 17
13931 \begin_inset space \thinspace{}
13935 \begin_inset space \thinspace{}
13939 \begin_inset space \thinspace{}
13945 \begin_layout Itemize
13946 The default font is
13954 but all math equations are still typeset in the usual roman font.
13957 \begin_layout Itemize
13960 Foil\SpecialChar TeX
13963 supports A4 and Letter paper sizes as well as a special size for working
13965 \begin_inset space \thinspace{}
13969 It doesn't support A5, B5, legal or executive paper sizes.
13972 \begin_layout Itemize
13973 Don't bother changing the
13977 settings because they are ignored anyway.
13978 All floats appear where they are defined in the text.
13981 \begin_layout Itemize
13986 setting behaves a bit differently for this class.
13989 Foil\SpecialChar TeX
13992 provides extensive footer and header capabilities including a user-defined
13995 \begin_inset space ~
13999 \begin_inset CommandInset ref
14001 reference "sec:foilfoot"
14006 The title page is treated differently to all other pages in the document
14015 has the logo centered at the bottom of the page (if one is defined).
14016 The possible page style choices and what they do are as follows:
14020 \begin_layout Labeling
14021 \labelwidthstring MMMMMMM
14028 The final output contains no page numbers, or other headers or footers
14029 (except footnotes of course).
14033 \begin_layout Labeling
14034 \labelwidthstring MMMMMMM
14041 The final output contains page numbers centered at the bottom of the page.
14042 No other headings or footers (other than footnotes).
14045 \begin_layout Labeling
14046 \labelwidthstring MMMMMMM
14051 Page numbers in lower right corner.
14052 Additional headers and footers are also shown.
14053 This is also the default.
14056 \begin_layout Labeling
14057 \labelwidthstring MMMMMMM
14062 Gives you access to the
14066 package although its use with
14068 Foil\SpecialChar TeX
14071 is discouraged by the writer of the
14073 Foil\SpecialChar TeX
14076 package because of some potential page layout clashes.
14080 \begin_layout Subsubsection
14084 \begin_layout Standard
14085 The following options may be used in the extra class options in the
14087 Document\SpecialChar menuseparator
14093 \begin_layout Labeling
14094 \labelwidthstring MMMMMMx
14099 This sets up the page layout for 7.33
14100 \begin_inset space \thinspace{}
14104 \begin_inset space \thinspace{}
14107 in paper, which is about the same aspect ratio as a 35
14108 \begin_inset space \thinspace{}
14111 mm slide, making it a bit easier to work with this medium.
14114 \begin_layout Labeling
14115 \labelwidthstring MMMMMMx
14120 Places a rule across the page below the header on every page except the
14124 \begin_layout Labeling
14125 \labelwidthstring MMMMMMx
14130 Places a rule across the page above the footer on every page except the
14134 \begin_layout Labeling
14135 \labelwidthstring MMMMMMx
14140 This is automatically set each time you create a new
14147 Foil\SpecialChar TeX
14150 to use the dvips driver to rotate those pages that are set as landscape
14154 \begin_layout Labeling
14155 \labelwidthstring MMMMMMx
14160 Simply changes the page dimensions to those of a landscape page but doesn't
14162 Thus if you use this option you need to use an external program to rotate
14163 each page or feed your paper through your printer as landscape.
14164 Note that this option effectively reverses the roles of the
14172 environments (don't worry these are described in the next section).
14175 \begin_layout Labeling
14176 \labelwidthstring MMMMMMx
14181 Equation numbers on the left.
14184 \begin_layout Labeling
14185 \labelwidthstring MMMMMMx
14190 Flush-left equations.
14193 \begin_layout Subsection
14194 Supported Environments
14197 \begin_layout Standard
14198 Most of the environments commonly supported in other classes are also supported
14204 There are several additional environments provided by
14206 Foil\SpecialChar TeX
14209 as well as a couple added by \SpecialChar LyX
14211 The following environments are shared with other classes:
14214 \begin_layout Standard
14215 \begin_inset Flex Multiple Columns
14218 \begin_layout Itemize
14224 \begin_layout Itemize
14230 \begin_layout Itemize
14236 \begin_layout Itemize
14242 \begin_layout Itemize
14248 \begin_layout Itemize
14255 \begin_layout Itemize
14261 \begin_layout Itemize
14267 \begin_layout Itemize
14273 \begin_layout Itemize
14279 \begin_layout Itemize
14285 \begin_layout Itemize
14291 \begin_layout Itemize
14297 \begin_layout Itemize
14303 \begin_layout Itemize
14314 \begin_layout Standard
14315 That is, all the major environments apart from the sectioning environments.
14316 Since foils are essentially self-contained sections, with a title and body,
14319 Foil\SpecialChar TeX
14322 provides specific commands for starting new foils and these are:
14325 \begin_layout Itemize
14331 \begin_layout Itemize
14337 \begin_layout Standard
14339 also provides slightly modified versions of these two environments called:
14342 \begin_layout Itemize
14348 \begin_layout Itemize
14351 ShortRotatefoilhead
14354 \begin_layout Standard
14355 and the differences will be explained in the next section.
14358 \begin_layout Standard
14359 Since foils are often used in presenting ideas or new theorems and such
14362 Foil\SpecialChar TeX
14365 also provides a comprehensive box of goodies for presenting them:
14368 \begin_layout Standard
14369 \begin_inset Flex Multiple Columns
14372 \begin_layout Itemize
14378 \begin_layout Itemize
14384 \begin_layout Itemize
14390 \begin_layout Itemize
14396 \begin_layout Itemize
14402 \begin_layout Itemize
14408 \begin_layout Itemize
14414 \begin_layout Itemize
14420 \begin_layout Itemize
14426 \begin_layout Itemize
14432 \begin_layout Itemize
14443 \begin_layout Standard
14444 The starred versions are unnumbered while the unstarred versions are numbered.
14445 There are also two list environments added by \SpecialChar LyX
14449 \begin_layout Itemize
14455 \begin_layout Itemize
14461 \begin_layout Standard
14464 Foil\SpecialChar TeX
14467 provides some powerful header and footer capabilities that are best set
14468 in the preamble although they may be set at any point in a document.
14469 If you want to change these settings in your document the best place to
14470 do so is at the very top of a foil, i.
14471 \begin_inset space \thinspace{}
14477 \begin_inset space \space{}
14482 straight after the foilhead.
14485 \begin_layout Standard
14486 For this purpose, the following command styles are provided [
14493 \begin_layout Standard
14494 \begin_inset Flex Multiple Columns
14497 \begin_layout Itemize
14501 \begin_inset space ~
14507 \begin_layout Itemize
14513 \begin_layout Itemize
14517 \begin_inset space ~
14523 \begin_layout Itemize
14527 \begin_inset space ~
14533 \begin_layout Itemize
14537 \begin_inset space ~
14544 \begin_layout Plain Layout
14545 \begin_inset space ~
14557 \begin_layout Standard
14558 There are also a few commands provided by
14560 Foil\SpecialChar TeX
14563 that aren't directly supported by \SpecialChar LyX
14564 but I'll tell you what they do and how
14565 to use them in section
14566 \begin_inset space ~
14570 \begin_inset CommandInset ref
14572 reference "sec:unsuppfoils"
14579 \begin_layout Subsection
14580 Building a Set of Foils
14583 \begin_layout Standard
14584 This section will give a simple introduction to using the different environments
14585 to build a set of foils.
14586 If you want to see an example set of foils, take a look at the
14590 file you find in \SpecialChar LyX
14598 \begin_layout Subsubsection
14599 Give It a Title Page
14602 \begin_layout Standard
14603 Unlike other classes that provide
14623 creates the title on a page of its own.
14624 If you leave out the
14628 environment \SpecialChar LaTeX
14629 will substitute the current date (every time you regenerate
14633 \begin_layout Subsubsection
14637 \begin_layout Standard
14638 As I mentioned earlier, there are four ways of starting a new foil.
14639 For portrait foils you should use
14648 The difference between these two environments is the amount of space between
14649 the title of the foil (the foilhead) and the body of the foil.
14652 \begin_layout Standard
14653 Landscape foils are generated using the
14659 ShortRotatefoilhead
14662 Again the only difference is the spacing between foilhead and body.
14663 Both of the short versions have 0.5
14664 \begin_inset space ~
14667 inches less separation between the foilhead and the body.
14671 \begin_layout Standard
14672 One problem with the support for landscape foils is the requirement that
14673 you have to use the
14677 driver to generate the PostScript output otherwise the foils won't be rotated.
14678 It is possible to get landscape foils even if you haven't got the
14682 driver provided you can feed your foils sideways through your printer ;-)
14685 \begin_layout Subsubsection
14686 Theorems, Lemmas, Proofs and more
14689 \begin_layout Standard
14690 You can't have two of the same type of these environments directly following
14692 If you use a normal paragraph break, , you will just be extending the previous
14693 environment as if you had merged the two environments together.
14694 Rather than that, you need to insert a so-called separator.
14695 Please refer to the section entitled
14706 \begin_layout Subsubsection
14710 \begin_layout Standard
14711 You get all the commonly supported list styles found in other classes as
14712 well as two new ones.
14713 I'll only describe the new ones here.
14714 If you want to find out more about the other list environments check out
14720 If you intend to use itemized lists you might also want to read about the
14724 \begin_inset space ~
14728 \begin_inset space ~
14733 dialog described above in section
14734 \begin_inset space ~
14738 \begin_inset CommandInset ref
14740 reference "sec:bullet"
14747 \begin_layout Standard
14748 The two new list styles,
14756 , are designed to make it easier for you to create lists of do's and don'ts
14757 or right and wrong by providing dedicated environments that use a tick
14758 or a cross as the label of the list.
14759 These lists are in fact dedicated variants of the
14764 They do however require that you have the
14768 packages installed.
14771 \begin_layout Subsubsection
14775 \begin_layout Standard
14778 Foil\SpecialChar TeX
14781 redefines the floating tables and figures so that they appear exactly where
14782 they are in the text rather than pushing them to the top of the page or
14783 to some user specified location.
14784 In fact if you change the float placement settings they are simply ignored.
14787 \begin_layout Subsubsection
14788 Page Headers and Footers
14789 \begin_inset CommandInset label
14791 name "sec:foilfoot"
14798 \begin_layout Standard
14802 \begin_inset space ~
14811 are two commands used to control the left-footer text string.
14812 The first is meant to allow you to include a graphic logo on your foils
14814 \begin_inset Quotes eld
14819 Foil\SpecialChar TeX
14823 \begin_inset Quotes erd
14827 While the second is meant to provide a classification for the audience,
14831 \begin_inset space \thinspace{}
14837 \begin_inset space \space{}
14841 It is empty by default.
14844 \begin_layout Standard
14845 The remaining page corners can be filled by
14848 \begin_inset space ~
14853 (which defaults to page numbers),
14856 \begin_inset space ~
14864 \begin_inset space ~
14872 \begin_layout Subsection
14875 Foil\SpecialChar TeX
14879 \begin_inset CommandInset label
14881 name "sec:unsuppfoils"
14888 \begin_layout Standard
14889 All the commands mentioned below need to be set in a
14899 within another environment.
14902 \begin_layout Subsubsection
14906 \begin_layout Standard
14907 All lengths are adjusted using the
14930 should be replaced by the name given to the length you want to change and
14935 is the length value.
14936 All lengths should be specified in units of length such as inches (
14948 ) or relative to some document or font-based length such as
14958 \begin_layout Standard
14959 It's possible to change the spacing between a foilhead and the body of the
14960 foil by adjusting the length specified by
14967 For example, to make
14972 \begin_inset space \space{}
14975 in closer to their bodies put the following in the preamble:
14981 foilheadskip}{-0.5in}
14984 \begin_layout Standard
14985 The spacings around floats can be adjusted by setting these lengths:
14988 \begin_layout Labeling
14989 \labelwidthstring MMMMMMMMMMM
14996 Separation between the text and the top of the float
14999 \begin_layout Labeling
15000 \labelwidthstring MMMMMMMMMMM
15007 Separation between the float and the caption
15010 \begin_layout Labeling
15011 \labelwidthstring MMMMMMMMMMM
15018 Separation between the caption and the following text
15021 \begin_layout Labeling
15022 \labelwidthstring MMMMMMMMMMM
15029 You can make the captions narrower than the surrounding text by adjusting
15031 Best done relative to
15040 \begin_layout Standard
15041 There are also several title page related lengths that you may find useful
15042 if you have a long title or several authors:
15045 \begin_layout Labeling
15046 \labelwidthstring MMMMMMMMMMM
15053 Separation from headers to
15058 \begin_layout Labeling
15059 \labelwidthstring MMMMMMMMMMM
15077 \begin_layout Labeling
15078 \labelwidthstring MMMMMMMMMMM
15092 \begin_layout Labeling
15093 \labelwidthstring MMMMMMMMMMM
15109 \begin_layout Labeling
15110 \labelwidthstring MMMMMMMMMMM
15126 \begin_layout Standard
15127 The last length related command affects all the list environments.
15138 a list environment then all the vertical spacing between the list items
15140 Note that this is a command not a length so it doesn't require
15146 like the stuff mentioned above.
15149 \begin_layout Subsubsection
15150 Headers and Footers
15153 \begin_layout Standard
15166 commands control whether the logo in the
15170 definition appear on a given page.
15177 in the preamble then none of the foils will have the logo on them.
15178 If you don't want the logo on a particular page place the
15184 directly after the foilhead of that page and the
15190 directly after the next foilhead.
15193 \begin_layout Standard
15194 If you decide to use the
15198 page style setting in the
15201 \begin_inset space ~
15206 dialog you should probably add
15216 to your preamble so headers and footers on landscape pages are correctly
15217 placed when rotated.
15218 This is due to some clashes between the page layouts provided by the
15229 \begin_layout Section
15231 \change_deleted 564990737 1669755802
15235 \begin_layout Standard
15237 \change_deleted 564990737 1669755802
15240 Panayotis Papasotiriou
15243 \begin_layout Subsection
15245 \change_deleted 564990737 1669755802
15249 \begin_layout Standard
15251 \change_deleted 564990737 1669755802
15252 The ijmpc package is a set of macros that facilitates electronic manuscript
15255 International Journal of Modern Physics C
15258 Similarly, the ijmpd package is for creating manuscripts to be submitted
15261 International Journal of Modern Physics D
15264 Both journals are published by World Scientific.
15265 The corresponding document classes are named
15274 These files, together with instructions for the authors, can be downloaded
15276 \begin_inset Flex URL
15279 \begin_layout Plain Layout
15281 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
15287 \begin_inset Flex URL
15290 \begin_layout Plain Layout
15292 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
15298 Both packages are modified versions of the standard
15299 \begin_inset Quotes eld
15303 \begin_inset Quotes erd
15306 package, and they are almost (but not exactly) identical.
15307 Most of their features are supported by \SpecialChar LyX
15309 I have used \SpecialChar LyX
15310 successfully to write articles submitted to both journals
15311 without any problem.
15314 \begin_layout Subsection
15316 \change_deleted 564990737 1669755802
15320 \begin_layout Standard
15322 \change_deleted 564990737 1669755802
15323 As usual, the easiest way to write a paper is to start with a template.
15326 File\SpecialChar menuseparator
15342 This will give an (almost) empty document that includes the most common
15343 fields found in a manuscript.
15344 Simply overwrite the existing text (including the brackets,
15349 You should keep in mind the following remarks.
15352 \begin_layout Enumerate
15354 \change_deleted 564990737 1669755802
15356 won't let you change the font size and the page style of the document,
15357 because such modifications are not allowed by both packages.
15360 \begin_layout Enumerate
15362 \change_deleted 564990737 1669755802
15363 The language of the document should not be changed.
15364 Before previewing your paper, be sure that the babel package is not used.
15365 To do this, click on
15368 arg "dialog-show document"
15373 \SpecialChar menuseparator
15377 \begin_inset Quotes eld
15381 \begin_inset Quotes erd
15391 \begin_layout Enumerate
15393 \change_deleted 564990737 1669755802
15395 \begin_inset Quotes eld
15399 \begin_inset Quotes erd
15402 style must be used to define keywords.
15405 \begin_layout Enumerate
15407 \change_deleted 564990737 1669755802
15408 The ijmpc package provides a style named
15409 \begin_inset Quotes eld
15412 Classification Codes
15413 \begin_inset Quotes erd
15416 , which can be used to define classification codes, such as PACS numbers.
15417 Note that this facility is not supported by the ijmpd package.
15420 \begin_layout Enumerate
15422 \change_deleted 564990737 1669755802
15423 Several new environments are available:
15424 \begin_inset Quotes eld
15428 \begin_inset Quotes erd
15432 \begin_inset Quotes eld
15436 \begin_inset Quotes erd
15440 \begin_inset Quotes eld
15444 \begin_inset Quotes erd
15448 \begin_inset Quotes eld
15452 \begin_inset Quotes erd
15456 \begin_inset Quotes eld
15460 \begin_inset Quotes erd
15464 \begin_inset Quotes eld
15468 \begin_inset Quotes erd
15472 \begin_inset Quotes eld
15476 \begin_inset Quotes erd
15480 \begin_inset Quotes eld
15484 \begin_inset Quotes erd
15488 \begin_inset Quotes eld
15492 \begin_inset Quotes erd
15496 \begin_inset Quotes eld
15500 \begin_inset Quotes erd
15504 \begin_inset Quotes eld
15508 \begin_inset Quotes erd
15512 \begin_inset Quotes eld
15516 \begin_inset Quotes erd
15520 \begin_inset Quotes eld
15524 \begin_inset Quotes erd
15528 \begin_inset Quotes eld
15532 \begin_inset Quotes erd
15536 Their use is more or less obvious.
15538 supports all these environments; it will use the proper label, text style,
15539 and numbering scheme for each of them.
15542 \begin_layout Enumerate
15544 \change_deleted 564990737 1669755802
15545 Both packages use basic citations; the natbib package should not be used.
15546 In \SpecialChar LyX
15547 , citation references are shown as usual; in the output, citations are
15548 shown as superscripts.
15549 If you want to use a citation as normal text, you should use the
15554 \begin_inset space \thinspace{}
15558 \begin_inset space \space{}
15562 \begin_inset Quotes eld
15566 \begin_inset space \space{}
15576 \begin_inset Quotes erd
15582 \begin_layout Enumerate
15584 \change_deleted 564990737 1669755802
15586 \begin_inset Quotes eld
15590 \begin_inset Quotes erd
15593 section in both packages.
15594 To put acknowledgments, just use the
15595 \begin_inset Quotes eld
15599 \begin_inset Quotes erd
15605 \begin_layout Enumerate
15607 \change_deleted 564990737 1669755802
15608 Appendices may be added to the paper,
15612 the Acknowledgments and
15618 provides a special environment, called
15619 \begin_inset Quotes eld
15623 \begin_inset Quotes erd
15626 which marks the beginning of the appendices.
15627 This environment should be left blank; it just sends a \SpecialChar LaTeX
15628 command, but nothing
15630 In \SpecialChar LyX
15632 \begin_inset Quotes eld
15636 \begin_inset Quotes erd
15639 is printed with blue letters, as a signal that all sections after that
15640 point are appendices.
15641 To write an appendix, use the
15642 \begin_inset Quotes eld
15646 \begin_inset Quotes erd
15651 will number each appendix with capital letters, as required by both journals.
15653 \begin_inset Quotes eld
15657 \begin_inset Quotes erd
15664 be present before the first appendix; if not, all appendices will be numbered
15665 as normal sections in the output.
15668 \begin_layout Enumerate
15670 \change_deleted 564990737 1669755802
15671 The ijmpc and the ijmpd packages use the
15675 command to implement table captions.
15676 As a result, a table created by \SpecialChar LyX
15677 is printed correctly, but its caption
15679 However, you can use some \SpecialChar TeX
15680 code to overcome this problem, so that captions
15681 are printed as expected.
15682 To do so, create a float table as usual, remove the caption, and replace
15683 it with the \SpecialChar TeX
15694 (sic); you must also the \SpecialChar TeX
15699 immediately after the tabular material.
15700 Study the example table included in the template files to see how this
15701 trick is implemented.
15702 Alternatively, If you need table captions, you should implement the whole
15707 file, then include this file to the \SpecialChar LyX
15710 Insert\SpecialChar menuseparator
15711 File\SpecialChar menuseparator
15713 \begin_inset space ~
15719 Details on how to create a table float can be found in the files
15727 , included in the corresponding packages.
15730 \begin_layout Subsection
15732 \change_deleted 564990737 1669755802
15733 Preparing a paper for submission
15736 \begin_layout Standard
15738 \change_deleted 564990737 1669755802
15739 Before you submit your paper you must export the \SpecialChar LyX
15740 document as a \SpecialChar LaTeX
15743 File\SpecialChar menuseparator
15744 Export\SpecialChar menuseparator
15752 \begin_layout Plain Layout
15753 Actually you have the choice between \SpecialChar LaTeX
15754 (plain) and pdflatex.
15755 If you intend to use pdflatex to prepare the paper, you should use the
15756 pdflatex option so that included graphics are converted to PDF format,
15757 ready for use by pdflatex.
15762 , then make the following changes to the resulting
15769 \begin_layout Enumerate
15771 \change_deleted 564990737 1669755802
15772 Remove the comment lines before the
15781 \begin_layout Enumerate
15783 \change_deleted 564990737 1669755802
15784 Remove everything between (and including) the
15796 commands, except for any commands you specifically put into the \SpecialChar LaTeX
15800 \begin_layout Standard
15802 \change_deleted 564990737 1669755802
15807 file should be saved and processed through \SpecialChar LaTeX
15808 as many times as necessary.
15809 You may also want to check the resulting
15818 \begin_layout Section
15820 \change_deleted 564990737 1669801478
15824 \begin_layout Standard
15826 \change_deleted 564990737 1669801478
15832 \begin_layout Subsection
15834 \change_deleted 564990737 1669801478
15838 \begin_layout Standard
15840 \change_deleted 564990737 1669801478
15841 The iopart package provides a document class to create electronic manuscript
15842 submission to the journals published by the Institute of Physics.
15843 Instructions for the authors how to create a paper using the iopart class
15844 can be downloaded together with the iopart package from the site
15845 \begin_inset Flex URL
15848 \begin_layout Plain Layout
15850 ftp://ftp.iop.org/pub/journals/latex2e
15858 \begin_layout Subsection
15860 \change_deleted 564990737 1669801478
15864 \begin_layout Standard
15866 \change_deleted 564990737 1669801478
15867 The easiest way to write a paper is to start with the template
15871 that is available via
15873 File\SpecialChar menuseparator
15876 The template explains how to use the special text environments.
15877 Here are the most important advices:
15880 \begin_layout Itemize
15882 \change_deleted 564990737 1669801478
15883 To be able to compile your document to a PDF, PS, or DVI, ensure that the
15884 no AMS packages are loaded in
15886 Document\SpecialChar menuseparator
15887 Settings\SpecialChar menuseparator
15893 \begin_layout Itemize
15895 \change_deleted 564990737 1669801478
15898 The title environment defines the kind of your paper.
15899 So use one of the following environments for the title:
15903 \begin_layout Itemize
15905 \change_deleted 564990737 1669801478
15914 \begin_layout Itemize
15916 \change_deleted 564990737 1669801478
15925 \begin_layout Itemize
15927 \change_deleted 564990737 1669801478
15933 for a Topical review
15936 \begin_layout Itemize
15938 \change_deleted 564990737 1669801478
15947 \begin_layout Itemize
15949 \change_deleted 564990737 1669801478
15958 \begin_layout Itemize
15960 \change_deleted 564990737 1669801478
15966 for a Paper (same as Title)
15969 \begin_layout Itemize
15971 \change_deleted 564990737 1669801478
15977 for a Preliminary communication
15980 \begin_layout Itemize
15982 \change_deleted 564990737 1669801478
15988 for a Rapid communication
15991 \begin_layout Itemize
15993 \change_deleted 564990737 1669801478
15999 for a Letter to the editor
16003 \begin_layout Itemize
16005 \change_deleted 564990737 1669801478
16008 All title environments except of
16012 can have an optional short title.
16015 \begin_layout Itemize
16017 \change_deleted 564990737 1669801478
16018 There is a general title environment
16022 which is not directly supported by \SpecialChar LyX
16024 This can be used as \SpecialChar TeX
16025 code when your document doesn't fit into one of the
16029 \begin_layout Standard
16031 \change_deleted 564990737 1669801478
16032 For more informations like hints for special table and formula formatting,
16033 look at the IOP author guidelines.
16038 \begin_layout Section
16040 \change_deleted 564990737 1670317155
16044 \begin_layout Standard
16046 \change_deleted 564990737 1670317155
16049 Panayotis Papasotiriou
16052 \begin_layout Subsection
16054 \change_deleted 564990737 1670317155
16058 \begin_layout Standard
16060 \change_deleted 564990737 1670317155
16061 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
16062 that facilitates electronic manuscript submission to the journals they
16064 Most known of them (at least in my domain of interest) are
16066 Astrophysics and Space Science
16072 , but there are many others (see a complete list at
16073 \begin_inset Flex URL
16076 \begin_layout Plain Layout
16078 http://www.wkap.nl/jrnllist.htm/JRNLHOME
16084 The Kluwer package may be downloaded from the site
16085 \begin_inset Flex URL
16088 \begin_layout Plain Layout
16090 http://www.wkap.nl/kaphtml.htm/STYLEFILES
16096 A complete user guide is contained in that package (but it can also be
16097 downloaded separately).
16100 \begin_layout Standard
16102 \change_deleted 564990737 1670317155
16104 supports many features of the package but not everything.
16105 However, the \SpecialChar TeX
16106 code needed is reduced to some
16107 \begin_inset Quotes eld
16111 \begin_inset Quotes erd
16114 commands of the package (see
16115 \begin_inset space ~
16119 \begin_inset CommandInset ref
16121 reference "subsec:kluwer_peculiarities"
16126 I have recently used \SpecialChar LyX
16127 to write an article submitted to the
16129 Astrophysics and Space Science
16131 without any problem.
16134 \begin_layout Subsection
16136 \change_deleted 564990737 1670317155
16140 \begin_layout Standard
16142 \change_deleted 564990737 1670317155
16143 The easiest way to write a paper is to start with the Kluwer template file.
16146 File\SpecialChar menuseparator
16158 This will give an (almost) empty document that includes the most common
16159 fields found in a manuscript and a short description of their use.
16160 As in most templates, simply overwrite the existing text (including the
16165 ) with the correct information.
16168 \begin_layout Subsection
16170 \change_deleted 564990737 1670317155
16171 Preparing a paper for submission
16174 \begin_layout Standard
16176 \change_deleted 564990737 1670317155
16177 As in the AAS\SpecialChar TeX
16178 package, before you submit your paper to a journal you must
16180 \begin_inset Quotes eld
16184 \begin_inset Quotes erd
16190 \begin_layout Enumerate
16192 \change_deleted 564990737 1670317155
16193 Export your paper as a \SpecialChar LaTeX
16195 To do this, click on
16197 File\SpecialChar menuseparator
16198 Export\SpecialChar menuseparator
16206 \begin_layout Enumerate
16208 \change_deleted 564990737 1670317155
16213 file with a text editor and make the following changes
16217 \begin_layout Enumerate
16219 \change_deleted 564990737 1670317155
16220 remove the comment lines before the
16229 \begin_layout Enumerate
16231 \change_deleted 564990737 1670317155
16232 remove everything between (and including) the
16244 commands, except for any commands you specifically put into the \SpecialChar LaTeX
16248 \begin_layout Standard
16250 \change_deleted 564990737 1670317155
16259 \begin_layout Enumerate
16261 \change_deleted 564990737 1670317155
16266 file through \SpecialChar LaTeX
16267 as many times as necessary (usually up to three).
16270 \begin_layout Enumerate
16272 \change_deleted 564990737 1670317155
16278 \begin_inset space \thinspace{}
16282 \begin_inset space \space{}
16289 , and check if everything is OK (it should, if you didn't make any mistake).
16292 \begin_layout Subsection
16294 \change_deleted 564990737 1670317155
16295 \begin_inset Quotes eld
16299 \begin_inset Quotes erd
16302 of the Kluwer package
16303 \begin_inset CommandInset label
16305 name "subsec:kluwer_peculiarities"
16312 \begin_layout Standard
16314 \change_deleted 564990737 1670317155
16315 The Kluwer package has the following
16316 \begin_inset Quotes eld
16320 \begin_inset Quotes erd
16326 \begin_layout Enumerate
16328 \change_deleted 564990737 1670317155
16329 It is possible to write multiple articles in the same \SpecialChar LaTeX
16334 \begin_layout Plain Layout
16335 I can't imagine any good reason to do this.
16341 Each article must be included in the environment
16342 \begin_inset Quotes eld
16346 \begin_inset Quotes erd
16350 Unfortunately, this environment cannot be omitted, even if you write just
16352 Therefore, each article starts with the command
16358 and, obviously, ends with the command
16365 Although this can be implemented in \SpecialChar LyX
16366 , I didn't included it, since it looks
16367 ugly and can confuse the novice user.
16368 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
16371 \begin_inset Quotes eld
16376 \begin_inset Quotes erd
16382 \begin_layout Enumerate
16384 \change_deleted 564990737 1670317155
16385 Information given at the beginning of the article (i.
16386 \begin_inset space \thinspace{}
16390 \begin_inset space \space{}
16393 title, subtitle, author, institution, running title, running author, abstract
16394 and keywords) must be included in an environment called
16395 \begin_inset Quotes eld
16399 \begin_inset Quotes erd
16403 This is not implemented in \SpecialChar LyX
16404 , so you must enter title, subtitle etc.
16405 \begin_inset space ~
16408 between two \SpecialChar TeX
16424 \begin_layout Enumerate
16426 \change_deleted 564990737 1670317155
16427 According to the user manual, the label of each bibliography item must be
16451 \begin_layout Standard
16453 \change_deleted 564990737 1670317155
16458 template takes care of all these
16459 \begin_inset Quotes eld
16463 \begin_inset Quotes erd
16467 If you start a new paper using this template you don't need to do anything
16472 \begin_layout Enumerate
16474 \change_deleted 564990737 1670317155
16475 don't delete the \SpecialChar TeX
16476 code included in the template, and
16479 \begin_layout Enumerate
16481 \change_deleted 564990737 1670317155
16482 copy the example bibliography item included in the template and modify it
16483 as necessary to enter new bibliography items.
16486 \begin_layout Section
16487 Article (mwart), book (mwbk) and report (mwrep)
16488 \begin_inset Argument status
16491 \begin_layout Plain Layout
16504 \begin_layout Standard
16510 \begin_layout Standard
16511 The \SpecialChar LyX
16528 correspond to the \SpecialChar LaTeX
16542 They are replacements for the standard document classes
16554 , resp., and fit better to Polish typography conventions in a number of points.
16558 \begin_layout Standard
16562 \begin_layout Itemize
16563 Unnumbered titles (with star, e.
16564 \begin_inset space \thinspace{}
16568 \begin_inset space \space{}
16575 ) are added into table of contents,
16578 \begin_layout Itemize
16579 Additional page styles:
16583 \begin_layout Description
16584 uheadings header with separated lines,
16587 \begin_layout Description
16588 myheadings custom header, contents headers via commands:
16603 \begin_layout Description
16604 myuheadings custom header with separated lines,
16607 \begin_layout Description
16608 outer page number is placed on outer side of page
16612 \begin_layout Itemize
16617 \begin_layout Description
16618 rmheadings serif titles — default,
16621 \begin_layout Description
16622 sfheadings sansserif titles,
16625 \begin_layout Description
16626 authortitle on title page first placed is author next title — default,
16629 \begin_layout Description
16630 titleauthor on title page first placed is title next author,
16633 \begin_layout Description
16634 withmarginpar reserve place on page for margins.
16638 \begin_layout Section
16642 \begin_layout Standard
16647 provides an alternative to the standard
16652 It provides similar functionality, but you might prefer this layout with
16653 sans serif sections, headings, and more.
16656 \begin_layout Section
16657 Rev\SpecialChar TeX
16661 \begin_layout Standard
16667 \begin_layout Standard
16668 \begin_inset VSpace bigskip
16674 \begin_layout Standard
16679 \begin_inset space ~
16684 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16686 \begin_inset Formula $\beta$
16689 release of May, 1999) class.
16692 \begin_layout Standard
16698 textclass, which works with Rev\SpecialChar TeX
16700 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16702 That means that it doesn't interact very well with \SpecialChar LyX
16703 , which requires \SpecialChar LaTeX2e
16705 it has been kludged to work.
16706 Since Rev\SpecialChar TeX
16707 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16712 Rev\SpecialChar TeX
16714 \begin_inset space ~
16719 textclass should also be pretty easy to use.
16722 \begin_layout Standard
16723 These documents are supposed to be used in
16727 to the Rev\SpecialChar TeX
16728 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16730 and assume you'll know what to put in the preamble if necessary.
16733 \begin_layout Subsection
16737 \begin_layout Standard
16738 All you need to do is install Rev\SpecialChar TeX
16739 4, as described in the package's README
16741 The package can be found at The Rev\SpecialChar TeX
16743 \begin_inset Flex URL
16746 \begin_layout Plain Layout
16748 http://publish.aps.org/revtex4/
16754 Install it somewhere that \SpecialChar LaTeX
16756 Test it by trying to \SpecialChar LaTeX
16757 a short Rev\SpecialChar TeX
16758 4 document in some random directory (i.
16759 \begin_inset space \thinspace{}
16763 \begin_inset space \space{}
16766 not the directory where you installed the class file.) Then, if you reconfigure
16768 , it will find the class file and let you use the Rev\SpecialChar TeX
16772 \begin_layout Standard
16773 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16782 \begin_inset space ~
16787 template, found in the templates directory.
16790 \begin_layout Subsection
16794 \begin_layout Standard
16795 Optional arguments to
16802 \begin_inset Quotes eld
16806 \begin_inset Quotes erd
16810 \begin_inset Quotes eld
16814 \begin_inset Quotes erd
16820 \begin_inset space ~
16828 \begin_inset space ~
16834 Remember that in Rev\SpecialChar TeX
16835 , at least one optional argument is required!
16838 \begin_layout Standard
16839 Other preamble matter, like
16846 \begin_inset space ~
16853 \begin_inset space ~
16858 dialog, also as usual.
16861 \begin_layout Subsection
16865 \begin_layout Standard
16866 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16868 For example, the Email layout corresponds to
16875 Note that (at least as of Rev\SpecialChar TeX
16884 layouts are exactly equivalent, so you shouldn't need to use both.
16888 \begin_layout Plain Layout
16889 In case you're curious, both were included so that
16893 would be able to translate both
16913 \begin_layout Subsection
16917 \begin_layout Standard
16918 There are a couple of important unique aspects of Rev\SpecialChar TeX
16919 4 which might cause
16920 bugs that will be even more confusing in \SpecialChar LyX
16924 \begin_layout Standard
16925 In Rev\SpecialChar TeX
16943 The \SpecialChar LyX
16944 equivalent is that there is a separate Thanks layout.
16949 write footnotes in the
16953 layout, or weird things may happen.
16954 See the Rev\SpecialChar TeX
16955 4 documentation for more details.
16958 \begin_layout Standard
16962 \begin_inset space ~
16970 \begin_inset space ~
16979 layouts must be placed
16987 layout and the corresponding
17004 , the \SpecialChar LaTeX
17008 \begin_layout Section
17009 Springer Journals (
17016 \begin_layout Standard
17022 \begin_layout Subsection
17026 \begin_layout Standard
17027 These are the layout files for some of the journal formats used by Springer
17028 Verlag and listed on
17029 \begin_inset Flex URL
17032 \begin_layout Plain Layout
17034 http://www.springer.de/author/tex/help-journals.html
17039 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
17041 It is a modular system: the things common to all journals are implemented
17046 , which journal-specific layout files (such as, e.
17047 \begin_inset space \thinspace{}
17051 \begin_inset space \space{}
17058 for Journal of Geodesy) can include.
17061 \begin_layout Standard
17062 This means that implementing support for any other Springer journal on this
17063 list is as simple as writing your own
17071 file following the outline given in
17079 \begin_layout Standard
17080 It is reasonably well tested only for the Journal of Geodesy.
17089 come with the standard \SpecialChar LyX
17091 Install the relevant class file (downloaded from Springer) in a proper
17092 directory, reconfigure \SpecialChar LaTeX
17093 (in the te\SpecialChar TeX
17098 , as root if necessary — doesn't \SpecialChar LyX
17099 take care of this?), reconfigure \SpecialChar LyX
17104 \begin_layout Subsection
17108 \begin_layout Standard
17109 A large number of theorem-like styles —
17121 \begin_layout Standard
17124 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
17125 _Title, Author_Running, Institute,
17126 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
17129 See the Springer class file documentation for details.
17132 \begin_layout Subsection
17136 \begin_layout Itemize
17148 \begin_layout Itemize
17151 Probability Theory and Related Fields
17157 — Jean-Marc Lasgouttes
17160 \begin_layout Standard
17161 Add your own, it isn't so hard!
17164 \begin_layout Subsection
17168 \begin_layout Standard
17169 These files are partly based on the older
17173 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
17175 file from Springer.
17180 layout, are now defunct.
17181 Jean-Marc Lasgouttes helped out big in making me find my way around the
17183 layout file mechanism.
17186 \begin_layout Subsection
17190 \begin_layout Standard
17192 But probably less than in the old hacked-\SpecialChar LaTeX
17200 \begin_layout Section
17203 Sli\SpecialChar TeX
17207 \begin_inset CommandInset label
17216 \begin_layout Standard
17224 \begin_layout Subsection
17228 \begin_layout Standard
17229 This section describes how to use \SpecialChar LyX
17230 to make slides for overhead projectors.
17231 There are two document classes that can do this: the default slides class
17234 Foil\SpecialChar TeX
17238 This section documents the former.
17241 \begin_layout Standard
17242 I'm going to say this again, nice and clear, so that there's no misunderstanding
17246 \begin_layout Standard
17247 \begin_inset VSpace bigskip
17253 \begin_layout Standard
17257 This section documents the class
17258 \begin_inset Quotes eld
17266 \begin_inset Quotes erd
17274 \begin_layout Standard
17275 \begin_inset VSpace bigskip
17281 \begin_layout Standard
17282 If you're looking for the documentation for
17283 \begin_inset Quotes eld
17288 slides (Foil\SpecialChar TeX
17292 \begin_inset Quotes erd
17295 , check out section
17296 \begin_inset space ~
17300 \begin_inset CommandInset ref
17302 reference "sec:foiltex"
17312 \begin_inset Quotes eld
17317 slides (Foil\SpecialChar TeX
17321 \begin_inset Quotes erd
17324 ] is actually somewhat better than the default
17332 \begin_layout Plain Layout
17334 or so I've been told repeatedly by its advocates.
17335 Having never used it, I have no idea if this claim is true or not.
17340 which this section documents.
17343 \begin_layout Standard
17344 This class is the \SpecialChar LaTeX2e
17345 improvement of the old
17347 Sli\SpecialChar TeX
17351 Every \SpecialChar LaTeX2e
17352 distribution includes this class [which I'll just refer to as
17353 \begin_inset Quotes eld
17361 \begin_inset Quotes erd
17364 from now on], so you're bound to have it.
17365 As I noted earlier, there are other classes, such as
17369 , which also produce slides for overhead projectors and do a better job
17371 However, there are some things which
17375 can do which the others can't, such as generate overlays.
17376 Read on to learn more!
17379 \begin_layout Subsection
17381 \begin_inset CommandInset label
17383 name "sec:slidesetup"
17390 \begin_layout Standard
17391 Obviously, to use this document class, you need to select
17392 \begin_inset Quotes eld
17400 \begin_inset Quotes erd
17403 from the class list in the
17405 Document\SpecialChar menuseparator
17409 There are some other special things you should know about this class:
17412 \begin_layout Itemize
17413 Don't bother changing the options
17418 They're not supported by the
17425 \begin_layout Itemize
17429 \begin_inset space ~
17434 behaves a bit differently for this class.
17435 The possible choices and what they do are as follows:
17439 \begin_layout Description
17444 The final output contains page numbers in the lower right corner.
17447 \begin_layout Description
17456 , but also prints out any time markers you've put in.
17457 This is the default.
17460 \begin_layout Description
17465 The final output contains no page numbers, time markers, or alignment markers.
17469 \begin_layout Itemize
17474 class has an extra option:
17480 \begin_inset Quotes eld
17488 \begin_inset Quotes erd
17491 in the extra class options.
17495 \begin_layout Standard
17496 Using this options allows you to add time markers to
17502 \begin_inset space ~
17506 \begin_inset CommandInset ref
17508 reference "sec:slideNote"
17516 \begin_layout Standard
17517 You can also use the template file
17518 \begin_inset Quotes eld
17526 \begin_inset Quotes erd
17529 to automatically set up a document to use the
17535 File\SpecialChar menuseparator
17537 \begin_inset space ~
17541 \begin_inset space ~
17546 to open your new document].
17547 The template file also contains some examples of the special paragraph
17548 environments used by this class.
17549 I'll describe those next.
17552 \begin_layout Subsection
17553 Paragraph Environments
17556 \begin_layout Subsubsection
17557 Supported Environments
17560 \begin_layout Standard
17561 The first thing you'll notice when you start up a new
17565 document is the font size and type: it's the equivalent of the size
17566 \begin_inset Quotes eld
17574 \begin_inset Quotes erd
17580 \begin_inset space ~
17586 This is also what's used in the output.
17588 \begin_inset Quotes eld
17592 \begin_inset Quotes erd
17595 to remind you that this is a slide.
17596 Your final slides will use a larger font; ergo, you'll have less space.
17597 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17600 \begin_layout Standard
17601 The next thing that becomes obvious is the changes to the paragraph environment
17602 pull-down box [at the far-left end of the toolbar].
17603 Most of the paragraph environments you're used to seeing are missing.
17604 There are also five new ones.
17609 class itself only supports certain paragraph environments:
17612 \begin_layout Itemize
17618 \begin_layout Itemize
17624 \begin_layout Itemize
17630 \begin_layout Itemize
17636 \begin_layout Itemize
17642 \begin_layout Itemize
17648 \begin_layout Itemize
17654 \begin_layout Itemize
17660 \begin_layout Itemize
17666 \begin_layout Itemize
17673 \begin_layout Standard
17674 All of the other standard environments, including the section-heading environmen
17675 ts, aren't used in the
17682 \begin_layout Standard
17683 On the other hand, you'll notice the following new environments:
17686 \begin_layout Itemize
17692 \begin_layout Itemize
17698 \begin_layout Itemize
17704 \begin_layout Itemize
17710 \begin_layout Itemize
17716 \begin_layout Standard
17717 These five are kind of quirky, due to a
17718 \begin_inset Quotes eld
17722 \begin_inset Quotes erd
17725 in \SpecialChar LyX
17727 You see, \SpecialChar LyX
17728 doesn't permit you to nest any other paragraph environment into
17729 an empty environment.
17730 Now, that's fine and dandy, but it means that you wouldn't be able to start
17731 a slide with anything except plain text.
17732 To deal with this, I've performed a little
17733 \begin_inset Quotes eld
17738 \begin_inset Quotes erd
17744 \begin_layout Subsubsection
17745 Quirks of the New Environments
17746 \begin_inset CommandInset label
17748 name "sec:slideQuirk"
17755 \begin_layout Standard
17756 All five of the new paragraph environments are somewhat quirky due to inherent
17757 limitiations in the current version of \SpecialChar LyX
17759 As I just mentioned, \SpecialChar LyX
17760 forbids environments that begin with another environment.
17761 To get around this, the
17765 environment isn't a paragraph environment as described in the
17773 \begin_layout Standard
17774 You should consider
17787 \begin_inset Quotes eld
17790 pseudo-environments.
17791 \begin_inset Quotes erd
17794 They look like a section heading or a
17795 \begin_inset Quotes eld
17803 \begin_inset Quotes erd
17806 but really begin a [and, if necessary, end the previous] paragraph environment.
17816 \begin_inset Quotes eld
17820 \begin_inset Quotes erd
17823 These two perform some action.
17826 \begin_layout Standard
17827 A common feature of all five environments,
17847 , is a rather long-ish label.
17848 The text following this label — ordinarily the contents of the paragraph
17849 environment — is utterly irrelevant for
17871 completely ignores it.
17872 In fact, you can leave these five environments completely empty.
17876 \begin_layout Standard
17881 to put any text after the rather long-ish label, you might want to.
17882 This could be a short description of the contents of the
17887 In that case, enter your descriptive comment and hit
17891 as you normally would.
17894 \begin_layout Standard
17895 If, on the other hand, you don't want to enter any descriptive text, you'll
17896 hit another \SpecialChar LyX
17899 , like nature, abhors a vacuum, and will not let you start a new paragraph
17900 environment until you put something in the old one.
17904 \begin_layout Itemize
17905 Start entering the text that will
17933 \begin_layout Itemize
17934 Now move to the beginning of that paragraph.
17938 \begin_layout Itemize
17947 \begin_layout Itemize
17948 Finally, change this new, empty paragraph to a
17972 \begin_layout Standard
17973 Some future version of \SpecialChar LyX
17974 will, hopefully, resolve this quirkiness\SpecialChar ldots
17978 \begin_layout Subsection
17979 Making a Presentation with
17992 \begin_layout Subsubsection
18000 \begin_layout Standard
18001 If you're expecting this section to teach you how to actually make a presentatio
18002 n, you'll be sorely disappointed.
18003 Naturally, I'll describe all of the ways the
18007 class can assist you in preparing the materials for a presentation.
18008 Filling in the contents, however, is up to you.
18013 the \SpecialChar LyX
18017 \begin_layout Standard
18022 environment [in the manner described in section
18023 \begin_inset space ~
18027 \begin_inset CommandInset ref
18029 reference "sec:slideQuirk"
18033 ] tells \SpecialChar LyX
18034 to begin a new slide [duh].
18035 The label for this environment/
18036 \begin_inset Quotes erd
18040 \begin_inset Quotes erd
18044 \begin_inset Quotes eld
18048 \begin_inset Quotes erd
18051 in cool blue, followed by the label,
18052 \begin_inset Quotes eld
18056 \begin_inset Quotes erd
18060 Any text or paragraph environments that follow this one go on the new slide.
18064 \begin_layout Standard
18065 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
18067 (this can be specified in the
18072 In fact, you'll want to, once you finish entering the contents of one slide.
18073 If you've entered more text than can physically fit on a slide, the extra
18074 overflows onto a new slide.
18075 I don't recommend doing this, however, since the overflow slide won't have
18076 any page number on it.
18077 Furthermore, it may interfere with any
18081 you've made to accompany the oversized
18088 \begin_layout Standard
18097 environments work the same way as the
18102 They both create an
18103 \begin_inset Quotes eld
18107 \begin_inset Quotes erd
18110 followed by a label [
18111 \begin_inset Quotes eld
18115 \begin_inset Quotes erd
18119 \begin_inset Quotes eld
18123 \begin_inset Quotes erd
18127 The color is a stunning magenta instead of blue, and the
18128 \begin_inset Quotes eld
18132 \begin_inset Quotes erd
18135 will look different, in style and in length.
18136 The label fonts of all three also differ from one another.
18139 \begin_layout Standard
18144 , if the contents of a
18152 exceed the physical size of a slide or sheet of paper, the extra will overflow
18154 Again, you should avoid this.
18155 It defeats the whole purpose of
18166 \begin_layout Subsubsection
18176 \begin_layout Standard
18181 is a slide that sits atop another slide.
18182 Perhaps you wish to discuss a figure on the main
18186 before displaying the text associated with it.
18187 One way to accomplish this is tape a flap of dark paper over the part of
18192 you want to display later.
18193 This method fails, however, if you wish to overlap one graph with another,
18195 You would then have to fumble while speaking to align the two separate,
18200 s to align the two graphs.
18205 environment in both cases makes life much easier.
18208 \begin_layout Standard
18213 receives the page number of its
18214 \begin_inset Quotes eld
18218 \begin_inset Quotes erd
18226 \begin_inset Quotes eld
18234 \begin_inset Quotes erd
18241 \begin_layout Plain Layout
18242 Presumably, mutliple
18247 \begin_inset Quotes eld
18255 \begin_inset Quotes erd
18259 \begin_inset Quotes eld
18267 \begin_inset Quotes erd
18271 \begin_inset Quotes eld
18279 \begin_inset Quotes erd
18283 \begin_inset space ~
18286 appended to the page number of the parent
18296 Clearly, you want the contents of both the
18304 to each fit on a single physical slide! You should probably consider an
18310 \begin_inset Quotes eld
18314 \begin_inset Quotes erd
18322 Indeed, the \SpecialChar LyX
18327 class provides a visual cue for this: the label at the start of an
18331 is shorter than that at the start of a
18336 Lastly, when you generate printable output, you'll find alignment markers
18337 in all four corners of both the
18341 page and its parent
18346 These will assist you in lining up the two physical slides.
18349 \begin_layout Standard
18350 The major problem in overlaying two slides is aligning the contents of the
18351 two transparencies.
18352 How much space should you leave for that graph on the second slide? Worse
18353 still, what if you want a graph and a sentence on second slide, but there
18354 is text on the main transparency that goes in between them? You could try
18355 and insert vertical space of the right size.
18356 The better way is to use
18367 \begin_layout Standard
18368 As their names imply,
18376 are two command-like paragraph environments that make all subsequent text
18377 invisible and visible, respectively.
18379 \begin_inset space ~
18383 \begin_inset CommandInset ref
18385 reference "sec:slideQuirk"
18389 that you don't place anything
18393 these two environments, however.
18398 , it inserts a centered, sky-blue label into the page reading
18399 \begin_inset Quotes eld
18402 <Invisible Text Follows>
18403 \begin_inset Quotes erd
18407 For paragraphs following this label, the parts of the
18415 ; it doesn't matter which] where they would be contain instead blank space.
18419 \begin_layout Standard
18424 , the corresponding centered label is
18425 \begin_inset Quotes eld
18428 <Visible Text Follows>
18429 \begin_inset Quotes erd
18433 Paragraphs following this label behave normally.
18434 Note that the beginning of a new
18446 automatically shuts off an
18451 It's therefore not necessary to use
18462 \begin_layout Standard
18463 By now, it should be obvious how to create overlay transparencies using
18464 the proper combination of
18483 \begin_layout Enumerate
18488 , including everything that will appear on it, whether on the main slide
18496 \begin_layout Enumerate
18497 Before each figure or paragraph that will appear only on the
18506 If necessary, insert a
18510 environment after the
18517 \begin_layout Enumerate
18522 immediately following the
18529 \begin_layout Enumerate
18530 Copy the contents of this
18541 \begin_layout Enumerate
18546 , change all of the
18557 \begin_layout Standard
18559 You've just made an
18566 \begin_layout Standard
18567 There's one problem with the way I've designed the \SpecialChar LyX
18572 class: you can't make text in the middle of a paragraph invisible, nor
18573 make text in the middle of an invisible paragraph visible again.
18574 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18579 \begin_layout Plain Layout
18580 The commands of interest are:
18583 \begin_layout Itemize
18588 invisible \SpecialChar ldots
18592 \begin_layout Itemize
18597 visible \SpecialChar ldots
18601 \begin_layout Plain Layout
18603 and need to be marked as \SpecialChar TeX
18606 \begin_inset Quotes eld
18610 \begin_inset Quotes erd
18613 you wish to change goes in between the brackets [and after the
18626 If you don't know how to mark text as \SpecialChar TeX
18627 , see the appropriate section of
18640 \begin_layout Subsubsection
18650 \begin_inset CommandInset label
18652 name "sec:slideNote"
18659 \begin_layout Standard
18668 is associated with a
18669 \begin_inset Quotes eld
18673 \begin_inset Quotes erd
18681 Here, too, the \SpecialChar LyX
18686 class provides visual cues.
18691 is shorter than that of a
18695 [yet longer than that of an
18699 ] and, like the label of an
18703 is shockingly magenta.
18704 Additionally, the printed
18708 has the page number of its
18709 \begin_inset Quotes eld
18713 \begin_inset Quotes erd
18721 \begin_inset Quotes eld
18729 \begin_inset Quotes erd
18733 \begin_inset Quotes eld
18741 \begin_inset Quotes erd
18745 \begin_inset Quotes eld
18753 \begin_inset Quotes erd
18757 You can have multiple
18761 s associated with a single
18773 , you'll probably want to break up long
18777 s so that they fit on a single sheet of paper.
18780 \begin_layout Standard
18785 is obvious: it contains anything additional you might want to say about
18791 It could also be used as a sheet of reminders for a particular
18796 In the case of the latter, you might want to make use of time markers.
18797 Currently, the \SpecialChar LyX
18803 \begin_inset Quotes eld
18807 \begin_inset Quotes erd
18810 support for time markers, a
18812 Sli\SpecialChar TeX
18816 So, you'll have to resort to using the \SpecialChar LaTeX
18820 \begin_layout Standard
18821 To use time markers, you'll need to specify the extra class option
18822 \begin_inset Quotes eld
18830 \begin_inset Quotes erd
18834 \begin_inset space ~
18838 \begin_inset CommandInset ref
18840 reference "sec:slidesetup"
18845 This option turns on timing marks, which will appear in the lower-left-hand
18851 To set what appears in the time marker, you use the \SpecialChar LaTeX
18853 \begin_inset Quotes eld
18863 \begin_inset Quotes erd
18867 \begin_inset Quotes eld
18877 \begin_inset Quotes erd
18881 The arguments of both commands are time measured in seconds.
18883 \begin_inset Quotes eld
18893 \begin_inset Quotes erd
18896 sets the time marker to a given time.
18898 \begin_inset Quotes eld
18908 \begin_inset Quotes erd
18911 increments the time marker by the specified amount.
18912 Using time markers and
18916 s in this fashion, you can remind yourself how much time to spend on a particula
18924 \begin_layout Standard
18925 There's one last feature to describe.
18926 Clearly, you'd like to print out all of your
18934 s on transparencies while printing all of your
18951 with which it is associated.
18952 What's a person to do?
18955 \begin_layout Standard
18956 Luckily, there are two \SpecialChar LaTeX
18957 commands that allow you to select what to print
18959 Both must be placed into the preamble of your document.
18961 \begin_inset Quotes eld
18973 \begin_inset Quotes erd
18976 will cause the output to contain only the
18985 Correspondingly, the command
18986 \begin_inset Quotes eld
18998 \begin_inset Quotes erd
19001 prevents the output of anything but
19006 I'd advise placing both commands in the preamble and initially comment
19008 You can then preview your entire presentation as you write.
19009 When you're done writing, you can then uncomment one of the two to select
19010 what you want to print.
19011 I like to uncomment
19012 \begin_inset Quotes eld
19024 \begin_inset Quotes erd
19027 , print to a file with
19028 \begin_inset Quotes eld
19036 \begin_inset Quotes erd
19039 in its name, comment it back out, then uncomment
19040 \begin_inset Quotes eld
19052 \begin_inset Quotes erd
19056 \begin_inset Quotes eld
19064 \begin_inset Quotes erd
19068 I can then send either file to a printer, loading transparencies or plain
19069 paper as appropriate.
19072 \begin_layout Standard
19073 You can also provide other arguments to the
19074 \begin_inset Quotes eld
19084 \begin_inset Quotes erd
19088 \begin_inset Quotes eld
19098 \begin_inset Quotes erd
19102 See a good \SpecialChar LaTeX
19106 \begin_layout Subsection
19111 Class Template File
19114 \begin_layout Standard
19115 I have also provided a template file,
19116 \begin_inset Quotes eld
19124 \begin_inset Quotes erd
19132 To use it, begin your new presentation with
19134 File\SpecialChar menuseparator
19136 \begin_inset space ~
19140 \begin_inset space ~
19146 Your new \SpecialChar LyX
19147 presentation file will contain an example
19168 additionally contain an example of the use of
19177 Lastly, the preamble will contain:
19180 \begin_layout LyX-Code
19181 % Uncomment to print out only slides and overlays
19184 \begin_layout LyX-Code
19188 \begin_layout LyX-Code
19194 \begin_inset Newline newline
19200 \begin_layout LyX-Code
19201 % Uncomment to print out only notes
19204 \begin_layout LyX-Code
19208 \begin_layout LyX-Code
19216 \begin_layout Standard
19217 One final thing: I created this class to support the \SpecialChar LaTeX2e
19219 \begin_inset Quotes eld
19224 Sli\SpecialChar TeX
19228 \begin_inset Quotes erd
19231 class, one of the built-in \SpecialChar LaTeX2e
19233 Neither I nor the rest of the \SpecialChar LyX
19234 Team endorse or oppose the use of this built-in
19236 It's here if you want it or need it.
19237 There exist other \SpecialChar LaTeX2e
19238 classes for creating presentations, such as the
19243 \begin_inset space ~
19247 \begin_inset CommandInset ref
19249 reference "sec:foiltex"
19254 \begin_inset Quotes eld
19262 \begin_inset Quotes erd
19265 package [present on some \SpecialChar TeX
19267 The latter is not yet supported under \SpecialChar LyX
19272 \begin_layout Plain Layout
19273 Perhaps you can take on the task\SpecialChar ldots
19279 I know nothing about these other classes.
19280 Try them out to see what sort of alternative they provide.
19283 \begin_layout Chapter
19285 Features needing Extra Software
19288 \begin_layout Section
19289 Checking \SpecialChar TeX
19293 \begin_layout Standard
19299 \begin_layout Subsection
19303 \begin_layout Standard
19312 \begin_layout Plain Layout
19317 is not yet available when you are using the \SpecialChar LaTeX
19318 distribution MiK\SpecialChar TeX
19324 , you'll find in the
19331 \begin_inset space ~
19342 \begin_inset Newline newline
19346 \begin_inset CommandInset href
19348 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19356 \begin_layout Standard
19359 Chk\SpecialChar TeX
19362 package is a program that was written by
19363 \begin_inset Flex Noun
19366 \begin_layout Plain Layout
19368 \begin_inset space ~
19376 in frustration because some constructs in \SpecialChar LaTeX
19377 are sometimes non-intuitive,
19378 and easy to forget.
19379 The program runs over your \SpecialChar LaTeX
19380 file, checks the integrity of the file, and
19381 flags some common errors.
19382 In other technical words, it is
19386 for \SpecialChar LaTeX
19390 \begin_layout Standard
19391 Well, what is a syntax checker doing in \SpecialChar LyX
19392 which is supposed to produce correct
19394 anyways? The answer is simple: Just as
19398 not only checks the
19402 of C programs, but also does
19406 checks for type-errors,
19408 Chk\SpecialChar TeX
19411 catches some common
19415 errors, in addition to the syntactical ones.
19418 Chk\SpecialChar TeX
19421 is capable of detecting several common errors, such as
19424 \begin_layout Itemize
19425 Ellipsis detection:
19426 \begin_inset Newline newline
19429 Use \SpecialChar ldots
19433 \begin_layout Itemize
19434 No space in front of/after parenthesis:
19435 \begin_inset Newline newline
19441 \begin_layout Itemize
19442 Enforcement of normal space after common abbreviations:
19443 \begin_inset Newline newline
19447 \begin_inset space \thinspace{}
19451 \begin_inset space \space{}
19454 is too wide spacing.
19457 \begin_layout Itemize
19458 Enforcement of end-of-sentence space when the last sentence ends with a
19460 \begin_inset Newline newline
19464 And this is wrong spacing.
19467 \begin_layout Itemize
19468 Space in front of labels and similar commands:
19469 \begin_inset Newline newline
19472 The label should stick right up to the text to avoid falling to a wrong
19475 \begin_inset CommandInset label
19485 \begin_layout Plain Layout
19486 This footnote is in danger of falling off to a wrong page
19491 The label is separated too much.
19494 \begin_layout Itemize
19495 Space in front of references, instead of hard spaces:
19496 \begin_inset Newline newline
19499 If you have bad luck, the text will break right between the referenced text
19500 and reference number, and that's a pity.
19502 \begin_inset CommandInset ref
19504 reference "sec:chktex"
19511 \begin_layout Itemize
19513 \begin_inset Quotes eld
19517 \begin_inset Quotes erd
19521 \begin_inset Formula $\times$
19525 \begin_inset Newline newline
19528 2x2 looks cheap compared to
19529 \begin_inset Formula $2\times2$
19535 \begin_layout Standard
19536 and more \SpecialChar ldots
19537 It is an invaluable tool when you are
19538 \begin_inset Quotes eld
19542 \begin_inset Quotes erd
19545 your document before printing, and you should run it right after the obligatory
19546 spelling check, and before you go fine tuning the typesetting.
19549 \begin_layout Subsection
19553 \begin_layout Standard
19554 If you have the program installed, usage is as simple as choosing
19556 Tools\SpecialChar menuseparator
19558 \begin_inset space ~
19564 This will make \SpecialChar LyX
19565 generate a \SpecialChar LaTeX
19566 file of your document, start
19568 Chk\SpecialChar TeX
19571 to check it, and then make \SpecialChar LyX
19573 \begin_inset Quotes eld
19577 \begin_inset Quotes erd
19580 with the warnings from
19582 Chk\SpecialChar TeX
19585 , if there were any.
19586 The warnings will be placed close to the point of the mistake, and you
19587 can quickly find them by using the
19589 Navigate\SpecialChar menuseparator
19592 menu item, or the shortcut key
19601 Open the error boxes by clicking on them with the mouse, or use the shortcut
19610 bindings, or the corresponding
19619 Read the warning and correct the mistake, if it is a mistake.
19620 If you have trouble understanding what the warning is about, you can safely
19622 Remember that there is a hidden layer between the document on screen and
19623 the technical details in invoking
19625 Chk\SpecialChar TeX
19628 , and this gap can make some warnings seem arcane or just plain silly.
19631 \begin_layout Standard
19632 This document is an excellent testing bed for the feature, and it should
19633 provide quite a few warnings for you to fiddle with.
19634 Since computers are only so smart, expect most of the warnings to be false
19638 \begin_layout Subsection
19639 How to fine tune it
19642 \begin_layout Standard
19643 Sometimes, you'll find that
19645 Chk\SpecialChar TeX
19648 makes more noise than suits your mood.
19649 Then you can choose not to use it, wait until your mood changes, or try
19652 Chk\SpecialChar TeX
19655 to get better along with you.
19658 \begin_layout Standard
19661 Chk\SpecialChar TeX
19668 very configurable and extensible, you should not expect to solve all problems
19671 Chk\SpecialChar TeX
19674 in \SpecialChar LyX
19676 Since \SpecialChar LyX
19677 has to generate a somewhat special \SpecialChar LaTeX
19678 file to be able to match the
19679 line numbers from the
19681 Chk\SpecialChar TeX
19688 \begin_layout Plain Layout
19689 You can inspect the specific output from
19695 Document\SpecialChar menuseparator
19698 \begin_inset space ~
19712 to the internal document structure, some of the warnings will not appear
19714 There are two things you can do about this:
19717 \begin_layout Itemize
19720 Chk\SpecialChar TeX
19723 invocation command line in
19724 \begin_inset Flex Noun
19727 \begin_layout Plain Layout
19728 Tools\SpecialChar menuseparator
19729 Preferences\SpecialChar menuseparator
19730 Output\SpecialChar menuseparator
19731 LaTeX\SpecialChar menuseparator
19739 Chk\SpecialChar TeX
19742 installation configuration file (usually with the file
19747 See below to learn what warnings can be enabled and disabled on the command
19751 \begin_layout Itemize
19752 Export your document as a raw \SpecialChar LaTeX
19755 File\SpecialChar menuseparator
19756 Export\SpecialChar menuseparator
19765 Invoked in this way, it can be a hassle to find the corresponding place
19766 in the document inside \SpecialChar LyX
19767 , but with a little patience, you should be able
19771 \begin_layout Standard
19772 Here follows the warning messages that can be enabled and disabled in
19781 to disable a warning, and
19785 to enable a warning.
19786 The emphasized entries are disabled by default, because the default is
19789 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19794 \begin_layout Standard
19795 Notice that you should only use the options that enable and disable warnings,
19796 because \SpecialChar LyX
19797 relies on some of the other command line parameters to be set
19798 in a specific way to have a chance to communicate with
19805 \begin_layout Enumerate
19809 Command terminated with space.
19812 \begin_layout Enumerate
19815 Non-breaking space (
19816 \begin_inset Quotes eld
19824 \begin_inset Quotes erd
19827 ) should have been used.
19830 \begin_layout Enumerate
19834 You should enclose the previous parenthesis with
19835 \begin_inset Quotes eld
19843 \begin_inset Quotes erd
19849 \begin_layout Enumerate
19852 Italic correction (
19853 \begin_inset Quotes eld
19863 \begin_inset Quotes erd
19866 ) found in non-italic buffer.
19869 \begin_layout Enumerate
19872 Italic correction (
19873 \begin_inset Quotes eld
19883 \begin_inset Quotes erd
19886 ) found more than once.
19889 \begin_layout Enumerate
19893 No italic correction (
19894 \begin_inset Quotes eld
19904 \begin_inset Quotes erd
19910 \begin_layout Enumerate
19914 \begin_inset Quotes eld
19922 \begin_inset Quotes erd
19926 \begin_inset Quotes eld
19934 \begin_inset Quotes erd
19940 \begin_layout Enumerate
19943 Wrong length of dash may have been used.
19946 \begin_layout Enumerate
19950 \begin_inset Quotes eld
19958 \begin_inset Quotes erd
19962 \begin_inset Quotes eld
19970 \begin_inset Quotes erd
19976 \begin_layout Enumerate
19980 \begin_inset Quotes eld
19988 \begin_inset Quotes erd
19994 \begin_layout Enumerate
19998 \begin_inset Quotes eld
20006 \begin_inset Quotes erd
20009 to achieve an ellipsis.
20012 \begin_layout Enumerate
20015 Inter-word spacing (
20016 \begin_inset Quotes eld
20026 \begin_inset Quotes eld
20029 ) should perhaps be used.
20032 \begin_layout Enumerate
20035 Inter-sentence spacing (
20036 \begin_inset Quotes eld
20046 \begin_inset Quotes erd
20049 ) should perhaps be used.
20052 \begin_layout Enumerate
20055 Could not find argument for command.
20058 \begin_layout Enumerate
20062 \begin_inset Quotes eld
20070 \begin_inset Quotes erd
20076 \begin_layout Enumerate
20079 Math mode still on at end of \SpecialChar LaTeX
20083 \begin_layout Enumerate
20087 \begin_inset Quotes eld
20095 \begin_inset Quotes erd
20098 doesn't match the number of
20099 \begin_inset Quotes eld
20107 \begin_inset Quotes erd
20113 \begin_layout Enumerate
20116 You should use either
20119 \begin_inset Quotes eld
20127 \begin_inset Quotes erd
20132 as an alternative to
20133 \begin_inset Quotes eld
20141 \begin_inset Quotes erd
20147 \begin_layout Enumerate
20154 " (ASCII 39) instead of "
20161 \begin_layout Enumerate
20164 User-specified pattern found.
20167 \begin_layout Enumerate
20170 This command might not be intended.
20173 \begin_layout Enumerate
20180 \begin_layout Enumerate
20198 \begin_layout Enumerate
20201 Delete this space to maintain correct page references.
20204 \begin_layout Enumerate
20208 You might wish to put this between a pair of
20209 \begin_inset Quotes eld
20217 \begin_inset Quotes erd
20223 \begin_layout Enumerate
20226 You ought to remove spaces in front of punctuation.
20229 \begin_layout Enumerate
20232 Could not execute \SpecialChar LaTeX
20236 \begin_layout Enumerate
20245 in front of small punctuation.
20248 \begin_layout Enumerate
20256 may look prettier here.
20259 \begin_layout Enumerate
20263 Multiple spaces detected in output.
20266 \begin_layout Enumerate
20269 This text may be ignored.
20272 \begin_layout Enumerate
20278 \begin_inset Quotes eld
20283 to begin quotation, not
20290 \begin_layout Enumerate
20297 to end quotation, not
20300 \begin_inset Quotes eld
20308 \begin_layout Enumerate
20314 \begin_layout Enumerate
20317 You should perhaps use
20318 \begin_inset Quotes eld
20326 \begin_inset Quotes erd
20332 \begin_layout Enumerate
20335 You should put a space in front of/after parenthesis.
20338 \begin_layout Enumerate
20341 You should avoid spaces in front of/after parenthesis.
20344 \begin_layout Enumerate
20348 You should not use punctuation in front of/after quotes.
20351 \begin_layout Enumerate
20354 Double space found.
20357 \begin_layout Enumerate
20360 You should put punctuation outside inner/inside display math mode.
20363 \begin_layout Enumerate
20366 You ought to not use primitive \SpecialChar TeX
20367 in \SpecialChar LaTeX
20371 \begin_layout Enumerate
20374 You should remove spaces in front of
20375 \begin_inset Quotes eld
20383 \begin_inset Quotes erd
20389 \begin_layout Enumerate
20392 \begin_inset Quotes eld
20400 \begin_inset Quotes erd
20403 is normally not followed by
20404 \begin_inset Quotes eld
20412 \begin_inset Quotes erd
20418 \begin_layout Standard
20419 In later versions of \SpecialChar LyX
20420 , we hope to provide a more complete interface to this
20421 tool (and it's smaller cousin
20425 ) to exploit the full power of it.
20426 But it's not exactly useless as it is now: go try it on one of your existing
20427 documents of a certain length and be surprised.
20430 \begin_layout Section
20431 Version Control in \SpecialChar LyX
20435 \begin_layout Standard
20438 Lars Gullik Bjønnes
20445 \begin_layout Subsection
20449 \begin_layout Standard
20451 supports some of the most basic RCS/CVS/SVN/GIT commands.
20452 If you need something a bit more sophisticated you will have to do that
20453 manually in a terminal.
20456 \begin_layout Standard
20457 Also note that CVS support is not as good as subversion support, so we advise
20459 A good place to start learning Subversion is the SVN Book
20463 \begin_layout Plain Layout
20464 \begin_inset CommandInset href
20466 target "http://svnbook.red-bean.com/"
20477 In the case of RCS you should read
20478 \begin_inset Quotes eld
20482 \begin_inset Quotes erd
20485 (a man file, read it with
20490 This file describes all the basic features of RCS.
20491 You should especially notice the comment about a RCS directory, and the
20492 notion of a master RCS file (the file ending in
20499 \begin_layout Standard
20500 Before you begin to use the version control features in \SpecialChar LyX
20502 familiar with RCS/CVS/SVN/GIT usage.
20503 The implementation in \SpecialChar LyX
20504 assumes a recent version of the GNU RCS or CVS/SVN
20505 package — no guarantees are made for older versions.
20506 Most of the log messages are not currently displayed after operations —
20507 you can check them in the Messages pane if you are unsure.
20508 Regular users of version control will appreciate the VC toolbar, which
20511 View\SpecialChar menuseparator
20512 Toolbars\SpecialChar menuseparator
20514 \begin_inset space ~
20522 \begin_layout Standard
20523 For introducing your own external commands consult
20524 \begin_inset Flex Code
20527 \begin_layout Plain Layout
20541 \begin_layout Standard
20542 It is strongly recommended to store documents in uncompressed format if
20543 using version control (uncheck
20545 Document\SpecialChar menuseparator
20548 if it is checked): Uncompressed LyX documents are text files and therefore
20549 for merging two different versions by version control systems.
20550 Compressed LyX documents are binary files, which cannot be merged by version
20554 \begin_layout Subsection
20555 RCS commands in \SpecialChar LyX
20559 \begin_layout Standard
20560 The following sections describe the RCS commands supported by \SpecialChar LyX
20562 You can find them in the
20564 File\SpecialChar menuseparator
20566 \begin_inset space ~
20573 was tested against RCS 5.7/5.8.
20576 \begin_layout Subsubsection
20582 \begin_layout Standard
20583 If your document is not under revision control, this is the only item shown
20585 And if it is under revision control, the
20589 item is not visible.
20593 \begin_layout Standard
20594 This command registers your document with RCS (unless you are under the
20595 directory managed by CVS)\SpecialChar endofsentence
20596 You are asked interactively to supply an initial
20597 description of the document.
20598 The document is now set in Read-Only mode and you have to
20601 \begin_inset space ~
20605 \begin_inset space ~
20609 \begin_inset space ~
20614 , before making any changes to it.
20615 A document under revision control has a
20616 \begin_inset Quotes eld
20619 [RCS:<version> <locker>]
20620 \begin_inset Quotes erd
20623 item tagged to the filename in the minibuffer.
20626 \begin_layout Standard
20627 RCS command that is run:
20630 \begin_layout LyX-Code
20633 ci -q -u -i -t-"<initial description>" <file-name>
20636 \begin_layout Standard
20641 to understand the switches.
20645 \begin_layout Subsubsection
20651 \begin_layout Standard
20652 When you are finished editing a file, you check in your changes.
20653 When you do this, you are asked for a description of the changes.
20654 This is stored in the history log.
20655 The version number is bumped, your changes are applied to the master RCS
20656 file, the document is unlocked and set to Read-Only mode.
20659 \begin_layout Itemize
20662 ci -q -u -m"<description>" <file-name>
20665 \begin_layout Subsubsection
20671 \begin_layout Standard
20672 By doing this you lock the document so that only you can edit it.
20673 This will also make the document Read-Write only for you.
20674 You will usually continue editing for a while and when you are finished
20675 you check in your changes.
20676 The status line is changed to reflect that you have locked the file.
20679 \begin_layout Itemize
20682 co -q -l <file-name>
20685 \begin_layout Subsubsection
20688 Revert To Repository Version
20691 \begin_layout Standard
20692 This will discard all changes made to the document since the last check
20694 You get a warning before changes are discarded.
20697 \begin_layout Itemize
20700 co -f -u<version> <file-name>
20703 \begin_layout Subsubsection
20709 \begin_layout Standard
20710 This will create a copy of the current document.
20711 Since RCS does not support copy operations natively, the version history
20712 is not preserved, and the copy is added as a new file.
20713 It requires a clean document without any changes since the last checkin.
20714 You are asked for a file name and a description of the copy operation.
20715 After that the copy is created, both locally and in the repository.
20716 If the parent directories of the copied and original document differ, all
20717 relative paths of included files of the copy are adjusted (like in
20719 File\SpecialChar menuseparator
20724 Finally, the copy is loaded instead of the original document.
20727 \begin_layout Labeling
20728 \labelwidthstring 00.00.0000
20730 \begin_inset space ~
20734 \begin_inset space ~
20738 \begin_inset Newline newline
20742 \begin_inset Flex Code
20745 \begin_layout Plain Layout
20748 \begin_inset Quotes qld
20752 \begin_inset Quotes qld
20761 \begin_inset Flex Code
20764 \begin_layout Plain Layout
20767 \begin_inset Quotes qld
20771 \begin_inset Quotes qld
20780 \begin_inset Newline newline
20784 \begin_inset Flex Code
20787 \begin_layout Plain Layout
20791 \begin_inset Quotes qld
20795 \begin_inset Quotes qld
20806 \begin_layout Subsubsection
20812 \begin_layout Standard
20813 This makes as if the last check in never happened.
20814 No changes are made to the document loaded into \SpecialChar LyX
20815 , but the last version
20816 is removed from the master RCS file.
20819 \begin_layout Itemize
20822 rcs -o<version> <file-name>
20825 \begin_layout Subsubsection
20831 \begin_layout Standard
20832 This shows the complete history of the RCS document.
20837 is shown in a browser.
20845 \begin_layout Subsubsection
20849 \begin_layout Standard
20851 supports RCS version number, author name, date and time of last commit.
20852 All those are extracted from
20854 rlog -r <file-name>
20858 \begin_inset CommandInset ref
20860 reference "subsec:VCS-Revision-Information"
20867 \begin_layout Subsection
20868 CVS commands in \SpecialChar LyX
20872 \begin_layout Standard
20873 A subset of CVS operations is supported by \SpecialChar LyX
20875 You can find the commands in the
20877 File\SpecialChar menuseparator
20879 \begin_inset space ~
20885 The version control system SVN is more powerful, so please use it instead
20886 of CVS if possible.
20889 \begin_layout Subsubsection
20895 \begin_layout Standard
20896 If you start from scratch with CVS you have to create your repository and
20897 checkout the working copy with external tools.
20898 If you're using a client-server setup you may need to login before doing
20899 the first repository checkout.
20902 \begin_layout Standard
20903 If your documents are under revision control and others are using the same
20904 repository problems arise when different changes to the same document at
20905 the same location happen.
20906 Standard CVS repositories don't operate with a file locking mechanism.
20907 This may be surprising, but conflicts only occur if people disagree on
20908 the proper content of the same part of a document.
20909 So, if co-workers are used to communicate regularly, these conflicts occur
20911 If they don't communicate they have a fundamental problem anyway.
20912 Nevertheless some people like to work with so called
20913 \begin_inset Quotes eld
20917 \begin_inset Quotes erd
20921 If they do so the working copy of all files is readonly when checked out
20922 first and the user starts editing after using a special command to make
20923 the working copy writable.
20924 When the changes are checked in the working copy returns to readonly state.
20925 With \SpecialChar LyX
20926 one has to edit the
20927 \begin_inset Flex Code
20930 \begin_layout Plain Layout
20936 file and add the line
20937 \begin_inset Flex Code
20940 \begin_layout Plain Layout
20946 to work with reserved checkouts.
20947 The benefit is the possibility to see who is using a writable copy of some
20949 It's not guaranteed only one user makes a copy writable.
20952 \begin_layout Standard
20954 tries to guess if you're using reserved or non-reserved checkouts.
20955 If your working copy is readonly or it is writable and an additional copy
20956 of your document exists in the CVS/Base sub-directory a reserved otherwise
20957 a non-reserved checkout is assumed.
20958 When a reserved checkout is detected you have to use
20959 \begin_inset Flex Noun
20962 \begin_layout Plain Layout
20968 to make your working copy writable if it's readonly.
20970 \begin_inset Flex Noun
20973 \begin_layout Plain Layout
20979 operation is possible and that makes your working copy readonly again after
20980 transferring your changes to the repository.
20983 \begin_layout Standard
20984 More information about CVS can be found here
20985 \begin_inset Flex URL
20988 \begin_layout Plain Layout
20990 http://www.nongnu.org/cvs
20996 \begin_inset Flex URL
20999 \begin_layout Plain Layout
21001 http://ximbiot.com/cvs
21009 \begin_layout Standard
21014 to understand the sub-commands and the switches mentioned below.
21017 \begin_layout Subsubsection
21023 \begin_layout Standard
21024 If your document is not under revision control, this is the only item shown
21026 And if it is under revision control, the
21030 item is not visible.
21034 \begin_layout Standard
21035 This command registers in CVS your document
21036 \begin_inset Flex Strong
21039 \begin_layout Plain Layout
21047 in the case you have already the documents directory under CVS control
21053 This means you have to create or checkout the archive by yourself using
21055 (In case you forget that step \SpecialChar LyX
21056 registers the document with RCS.)
21059 \begin_layout Standard
21060 Then you are asked interactively to supply an initial description of the
21062 Don't forget that registered file is not yet checked in.
21065 \begin_layout Standard
21066 CVS command that is run:
21068 cvs -q add -m"<entered message>" "<file-name>"
21071 \begin_layout Standard
21076 above and for all other CVS commands is an abbreviation for
21077 \begin_inset Quotes eld
21080 change the current working directory to file location and use the file name
21081 without path component as argument
21082 \begin_inset Quotes erd
21088 \begin_layout Subsubsection
21094 \begin_layout Standard
21095 When you are finished editing a file, you commit your changes.
21096 When you do this and you had changed the document, you are asked for a
21097 description of the changes.
21098 After that changes are written to the repository.
21099 In case you didn't change the document and a reserved checkout is detected
21100 the reservation made on
21101 \begin_inset Flex Noun
21104 \begin_layout Plain Layout
21113 \begin_layout Labeling
21114 \labelwidthstring 00.00.0000
21116 \begin_inset space ~
21120 \begin_inset space ~
21124 \begin_inset Newline newline
21128 \begin_inset Flex Code
21131 \begin_layout Plain Layout
21134 -q commit -m"<description>" "<file-name>"
21140 \begin_inset Newline newline
21144 \begin_inset Flex Code
21147 \begin_layout Plain Layout
21158 \begin_layout Subsubsection
21164 \begin_layout Standard
21165 When you are sharing a repository with others, you may have to incorporate
21166 their changes into your working copy.
21169 \begin_layout Standard
21172 cvs -q update "<file-name>"
21175 \begin_layout Standard
21176 If a readonly checkout is detected the working copy is made writable and
21180 \begin_layout Standard
21183 cvs -q edit "<file-name>"
21186 \begin_layout Subsubsection
21189 Revert To Repository Version
21192 \begin_layout Standard
21193 This will discard all changes made to the document since the last check
21195 You get a warning before changes are discarded.
21196 Firstly the file is deleted, secondly CVS update command is run.
21199 \begin_layout Standard
21202 cvs -q update "<file-name>"
21205 \begin_layout Standard
21206 If a reserved checkout is detected and the working copy has no changes only
21207 the reservation is undone.
21210 \begin_layout Standard
21213 cvs -q unedit "<file-name>"
21216 \begin_layout Subsubsection
21222 \begin_layout Standard
21223 This will create a copy of the current document.
21224 Since CVS does not support copy operations natively, the version history
21225 is not preserved, and the copy is added as a new file.
21226 It requires a clean document without any changes since the last checkin.
21227 You are asked for a file name and a description of the copy operation.
21228 After that the copy is created, both locally and in the repository.
21229 If the parent directories of the copied and original document differ, all
21230 relative paths of included files of the copy are adjusted (like in
21232 File\SpecialChar menuseparator
21237 Finally, the copy is loaded instead of the original document.
21240 \begin_layout Labeling
21241 \labelwidthstring 00.00.0000
21243 \begin_inset space ~
21247 \begin_inset space ~
21251 \begin_inset Newline newline
21255 \begin_inset Flex Code
21258 \begin_layout Plain Layout
21265 \begin_inset Flex Code
21268 \begin_layout Plain Layout
21275 \begin_inset Newline newline
21279 \begin_inset Flex Code
21282 \begin_layout Plain Layout
21283 cvs -q add "<new-file-name>"
21291 \begin_layout Subsubsection
21297 \begin_layout Standard
21298 This will rename the current document.
21299 Since CVS does not support rename operations natively, the version history
21300 is not preserved, the renamed document is added as a new file, and the
21301 original document is deleted.
21302 It requires a clean document without any changes since the last checkin.
21303 You are asked for a file name and a description of the rename operation.
21304 After that the document is renamed, both locally and in the repository.
21305 If the parent directories of the new and old file names differ, all relative
21306 paths of included files are adjusted (like in
21308 File\SpecialChar menuseparator
21313 Finally, the document is reloaded using the new name.
21316 \begin_layout Labeling
21317 \labelwidthstring 00.00.0000
21319 \begin_inset space ~
21323 \begin_inset space ~
21327 \begin_inset Newline newline
21331 \begin_inset Flex Code
21334 \begin_layout Plain Layout
21341 \begin_inset Flex Code
21344 \begin_layout Plain Layout
21351 \begin_inset Newline newline
21355 \begin_inset Flex Code
21358 \begin_layout Plain Layout
21359 cvs -q add "<new-file-name>"
21365 \begin_inset Newline newline
21369 \begin_inset Flex Code
21372 \begin_layout Plain Layout
21373 cvs -q remove "<file-name>"
21381 \begin_layout Subsubsection
21382 Update of the local directory checkout from repository
21385 \begin_layout Standard
21386 Once your documents gets more complex, containing sub-documents and pictures,
21388 \begin_inset Flex Code
21391 \begin_layout Plain Layout
21397 files and so on using version control becomes more complicated.
21399 supports updating the whole tree in which resides the document.
21400 This become especially useful once you cooperate with people which neither
21401 have detailed knowledge about CVS usage nor they have ambition to commit
21402 additional material to the repository.
21403 You have to organize the files structure so that all external files are
21404 in the same directory or subdirectories of the document.
21405 It's good practice anyway to store multipart documents in an extra directory.
21408 \begin_layout Standard
21410 \begin_inset Flex Code
21413 \begin_layout Plain Layout
21414 Update local directory from repository
21419 command updates the whole directory.
21420 If local changes are detected user is warned before update starts.
21421 In case of merge conflicts both versions of the conflicting document parts
21422 are placed in the final document.
21423 You have to review and correct the result of the merge.
21424 You'll find the conflicts enclosed in pairs of
21425 \begin_inset Flex Code
21428 \begin_layout Plain Layout
21435 \begin_inset Flex Code
21438 \begin_layout Plain Layout
21445 \begin_inset Flex Code
21448 \begin_layout Plain Layout
21455 The first part is your version as before the update operation with the
21456 document name prepended.
21457 The second one is the repository version with the version number after
21459 \begin_inset Flex Code
21462 \begin_layout Plain Layout
21471 \begin_layout Labeling
21472 \labelwidthstring 00.00.0000
21474 \begin_inset space ~
21478 \begin_inset space ~
21482 \begin_inset Newline newline
21486 \begin_inset Flex Code
21489 \begin_layout Plain Layout
21497 (Ask if changes are detected.)
21498 \begin_inset Newline newline
21502 \begin_inset Flex Code
21505 \begin_layout Plain Layout
21506 cd $path; cvs -q update
21516 \begin_layout Standard
21518 \begin_inset Flex Code
21521 \begin_layout Plain Layout
21527 stands for the path to the document.
21530 \begin_layout Subsubsection
21536 \begin_layout Standard
21537 This shows the complete history of the CVS document.
21540 cvs log "<file-name>"
21542 is shown in a browser.
21545 \begin_layout Subsubsection
21549 \begin_layout Standard
21551 supports CVS version number, author name, date and time of last commit.
21552 All those are extracted from
21554 cvs log -r <file-name>
21558 \begin_inset CommandInset ref
21560 reference "subsec:VCS-Revision-Information"
21567 \begin_layout Subsection
21568 SVN commands in \SpecialChar LyX
21572 \begin_layout Standard
21573 SVN is now partially supported by \SpecialChar LyX
21575 You can find the commands in the
21577 File\SpecialChar menuseparator
21579 \begin_inset space ~
21585 Please note that if you use password protected access to repository via
21586 ssh, you will be asked in terminal window.
21588 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21592 \begin_layout Plain Layout
21593 Most of the commands will work with 1.4 too, see
21594 \begin_inset CommandInset ref
21596 reference "subsec:SVN-Repo-Update"
21601 There seems to be currently unresolved permissions problem under SVN 1.8
21602 with reverting changes when file is locked.
21610 \begin_layout Subsubsection
21616 \begin_layout Standard
21617 If your document is not under revision control, this is the only item shown
21619 And if it is under revision control, the
21623 item is not visible.
21626 \begin_layout Standard
21627 This command registers in SVN your document ONLY in case you have already
21628 the documents directory under SVN control (in particular
21633 This means you have to checkout the archive by yourself.
21636 \begin_layout Standard
21637 Then you are asked interactively to supply an initial description of the
21639 Don't forget that registered file is not yet commited.
21642 \begin_layout Standard
21643 SVN command that is run:
21646 \begin_inset Quotes qld
21650 \begin_inset Quotes qld
21656 \begin_layout Standard
21661 to understand the switches.
21664 \begin_layout Subsubsection
21670 \begin_layout Standard
21671 When you are finished editing a file, you commit your changes.
21672 When you do this, you are asked for a description of the changes.
21673 After that changes are commited.
21676 \begin_layout Standard
21681 \begin_layout Plain Layout
21682 In case locking is not enabled.
21684 \begin_inset CommandInset ref
21686 reference "subsec:SVN-File-Locking"
21697 svn commit -q -m"<description>" <file-name>
21700 \begin_layout Subsubsection
21706 \begin_layout Standard
21707 Updates the changes of this file from the repository.
21708 Be sure you understand SVN merging and conflicts resolving before using
21709 this function, because all conflicts has to be resolved manually by you!
21712 \begin_layout Standard
21717 \begin_layout Plain Layout
21725 svn update --non-interactive
21726 \begin_inset Quotes qld
21730 \begin_inset Quotes qld
21736 \begin_layout Subsubsection
21739 Revert To Repository Version
21742 \begin_layout Standard
21743 This will discard all changes made to the document since the last check
21745 You get a warning before changes are discarded.
21748 \begin_layout Standard
21752 \begin_inset Quotes qld
21756 \begin_inset Quotes qld
21762 \begin_layout Subsubsection
21768 \begin_layout Standard
21769 This will create a copy of the current document including the version history.
21770 It requires a clean document without any changes since the last checkin.
21771 You are asked for a file name and a description of the copy operation.
21772 After that the copy is created, both locally and in the repository.
21773 If the parent directories of the copied and original document differ, all
21774 relative paths of included files of the copy are adjusted (like in
21776 File\SpecialChar menuseparator
21781 Finally, the copy is loaded instead of the original document.
21784 \begin_layout Labeling
21785 \labelwidthstring 00.00.0000
21787 \begin_inset space ~
21791 \begin_inset space ~
21795 \begin_inset Newline newline
21799 \begin_inset Flex Code
21802 \begin_layout Plain Layout
21806 \begin_inset Quotes qld
21810 \begin_inset Quotes qld
21814 \begin_inset Quotes qld
21818 \begin_inset Quotes qld
21827 \begin_inset Newline newline
21831 \begin_inset Flex Code
21834 \begin_layout Plain Layout
21843 \begin_layout Subsubsection
21849 \begin_layout Standard
21850 This will rename the current document including the version history.
21851 It requires a clean document without any changes since the last checkin.
21852 You are asked for a file name and a description of the rename operation.
21853 After that the document is renamed, both locally and in the repository.
21854 If the parent directories of the new and old file names differ, all relative
21855 paths of included files are adjusted (like in
21857 File\SpecialChar menuseparator
21862 Finally, the document is reloaded using the new name.
21865 \begin_layout Labeling
21866 \labelwidthstring 00.00.0000
21868 \begin_inset space ~
21872 \begin_inset space ~
21876 \begin_inset Newline newline
21880 \begin_inset Flex Code
21883 \begin_layout Plain Layout
21887 \begin_inset Quotes qld
21891 \begin_inset Quotes qld
21895 \begin_inset Quotes qld
21899 \begin_inset Quotes qld
21908 \begin_inset Newline newline
21912 \begin_inset Flex Code
21915 \begin_layout Plain Layout
21924 \begin_layout Subsubsection
21925 \begin_inset CommandInset label
21927 name "subsec:SVN-Repo-Update"
21931 Update of the local directory checkout from repository
21935 \begin_layout Plain Layout
21936 Note that this command will work only with subversion
21937 \begin_inset Formula $\geqq1.5$
21948 \begin_layout Standard
21949 All the commands above have one shortcoming – they deal with the current
21951 Once your document contains pictures, includes external
21952 \begin_inset Flex Code
21955 \begin_layout Plain Layout
21961 files and so on administration becomes more complicated.
21963 now supports updating the whole tree in which resides the document
21967 \begin_layout Plain Layout
21968 One need to organize the files structure so that all external files are
21969 in the same directory or subdirectories of the document.
21976 This become especially useful once you cooperate with people which neither
21977 know about subversion management nor they have ambition to commit additional
21978 material to the repository.
21982 \begin_layout Standard
21983 \begin_inset Flex Code
21986 \begin_layout Plain Layout
21987 Update local directory from repository
21992 command updates the whole directory and in case of merge conflicts local
21993 version of the files are left, so no unintended data loss occurs.
21994 If local changes are detected user is warned before update starts.
21997 \begin_layout Labeling
21998 \labelwidthstring 00.00.0000
22000 \begin_inset space ~
22004 \begin_inset space ~
22008 \begin_inset Newline newline
22012 \begin_inset Flex Code
22015 \begin_layout Plain Layout
22021 (Ask if changes are detected.)
22022 \begin_inset Newline newline
22026 \begin_inset Flex Code
22029 \begin_layout Plain Layout
22030 svn update --accept mine-full $path
22038 \begin_layout Standard
22040 \begin_inset Flex Code
22043 \begin_layout Plain Layout
22049 stands for the path to the document.
22052 \begin_layout Subsubsection
22058 \begin_layout Standard
22059 This shows the complete history of the SVN document.
22063 \begin_inset Quotes qld
22067 \begin_inset Quotes qld
22072 is shown in a browser.
22075 \begin_layout Subsubsection
22077 \begin_inset CommandInset label
22079 name "subsec:SVN-File-Locking"
22086 \begin_layout Standard
22087 The file exchange through various revision control systems brings the problem
22088 of merge conflicts in case two different users try to edit the same (parts
22090 When such a conflict happens it needs manual resolving and one reasonable
22091 alternative is to provide some kind of locking mechanism, which guarantees
22092 that only one user is allowed to edit file at the given time.
22095 \begin_layout Standard
22096 SVN has two such mechanisms to provide mutual exclusivity for file access
22097 – locks and automatic setting of write permissions (see sec.
22099 \begin_inset CommandInset ref
22101 reference "subsec:Automatical-Locking-Property"
22106 \begin_inset Flex Code
22109 \begin_layout Plain Layout
22119 \begin_layout Plain Layout
22120 \begin_inset Flex URL
22123 \begin_layout Plain Layout
22125 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
22136 If this property is detected for a given document \SpecialChar LyX
22137 starts to use SVN locks
22138 for document editing automatically and the whole check-in/out mechanism
22139 switches to the same regimen as for RCS.
22140 This in particular means there are two different modes of file use in \SpecialChar LyX
22144 \begin_layout Itemize
22146 The loaded file is in the read-only mode.
22147 For editing on needs to check-out.
22152 consists of updating from the repository and gaining write lock.
22153 If the lock is not possible to obtain, we remain in unlocked state.
22156 \begin_layout Itemize
22158 The loaded file is in the
22159 \begin_inset Quotes els
22163 \begin_inset Quotes ers
22167 No other user is allowed to edit the file.
22172 consists of commiting changes and releasing write-lock.
22173 If no changes have been made to the document, no commit will be produced
22177 \begin_layout Plain Layout
22178 Don't be puzzled by the fact that you will be asked for commit message anyway.
22183 and only the write-lock will be released.
22186 \begin_layout Standard
22190 \begin_layout Labeling
22191 \labelwidthstring 00.00.0000
22194 svn commit -q -m"<description>" "<file-name>"
22195 \begin_inset Newline newline
22198 svn unlock "<file-name>"
22201 \begin_layout Labeling
22202 \labelwidthstring 00.00.0000
22205 svn update "<file-name>"
22206 \begin_inset Newline newline
22209 svn lock "<file-name>"
22212 \begin_layout Subsubsection
22215 \begin_inset CommandInset label
22217 name "subsec:Automatical-Locking-Property"
22223 Automatic Locking Property
22226 \begin_layout Standard
22227 The above mentioned automatic setting of write permissions of the .lyx file
22230 File\SpecialChar menuseparator
22232 \begin_inset space ~
22235 Control\SpecialChar menuseparator
22236 Use Locking Property
22239 This command is active only when the file is not locked on the svn server
22241 you need to check-out before proceeding).
22244 \begin_layout Labeling
22245 \labelwidthstring 00.00.0000
22247 \begin_inset space ~
22253 \begin_layout Labeling
22254 \labelwidthstring 00.00.0000
22257 svn propset svn:needs-lock ON "<file-name>"
22260 \begin_layout Labeling
22261 \labelwidthstring 00.00.0000
22264 svn propdel svn:needs-lock "<file-name>"
22267 \begin_layout Subsubsection
22268 \begin_inset CommandInset label
22270 name "subsec:VCS-Revision-Information"
22274 Revision Information in Documents
22277 \begin_layout Standard
22278 There are more possibilities how to activate revision information in our
22282 \begin_layout Itemize
22288 \begin_layout Itemize
22289 tree revision information (
22290 \begin_inset Flex Code
22293 \begin_layout Plain Layout
22300 The result is the output of the
22301 \begin_inset Flex Code
22304 \begin_layout Plain Layout
22310 command, the following table gives you an idea, how to read the results.
22313 \begin_layout Standard
22315 \begin_inset Tabular
22316 <lyxtabular version="3" rows="6" columns="2">
22317 <features tabularvalignment="middle">
22318 <column alignment="left" valignment="top">
22319 <column alignment="left" valignment="top">
22321 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22324 \begin_layout Plain Layout
22332 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22335 \begin_layout Plain Layout
22345 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22348 \begin_layout Plain Layout
22354 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22357 \begin_layout Plain Layout
22358 mixed revision working copy
22365 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22368 \begin_layout Plain Layout
22374 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22377 \begin_layout Plain Layout
22378 modified working copy
22385 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22388 \begin_layout Plain Layout
22394 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22397 \begin_layout Plain Layout
22398 switched working copy
22405 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22408 \begin_layout Plain Layout
22414 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22417 \begin_layout Plain Layout
22418 partial working copy, from a sparse checkout
22425 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22428 \begin_layout Plain Layout
22434 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22437 \begin_layout Plain Layout
22438 mixed revision, modified, switched working copy
22451 \begin_layout Itemize
22452 file revision information.
22453 The result comes from parsing the output of
22454 \begin_inset Flex Code
22457 \begin_layout Plain Layout
22459 \begin_inset space ~
22463 \begin_inset space ~
22467 \begin_inset space ~
22476 Supported flags are:
22480 \begin_layout Itemize
22481 version number of the last commit (
22482 \begin_inset Flex Code
22485 \begin_layout Plain Layout
22494 \begin_layout Itemize
22495 author of the last commit (
22496 \begin_inset Flex Code
22499 \begin_layout Plain Layout
22508 \begin_layout Itemize
22509 date of the last commit (
22510 \begin_inset Flex Code
22513 \begin_layout Plain Layout
22522 \begin_layout Itemize
22523 time of the last commit (
22524 \begin_inset Flex Code
22527 \begin_layout Plain Layout
22537 \begin_layout Standard
22538 You can obtain this info via InsetInfo (
22539 \change_inserted 5863208 1564400022
22542 Insert\SpecialChar menuseparator
22543 Field\SpecialChar menuseparator
22544 Version Control Revision
22545 \change_deleted 5863208 1564399852
22550 \begin_inset Flex Code
22553 \begin_layout Plain Layout
22554 info-insert buffer vcs-date
22562 The information will be available only when you have the file stored under
22563 svn managment (i.e.
22565 \begin_inset Flex Code
22568 \begin_layout Plain Layout
22574 directory is available with your document).
22578 \begin_layout Itemize
22579 Another—a hacking one—possibility is to use svn keywords
22583 \begin_layout Plain Layout
22584 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22590 In short – you set file keywords property (e.g.
22593 svn propset svn:keywords 'Rev' file.lyx
22595 ) and then paste keyword \SpecialChar TeX
22600 \begin_layout Plain Layout
22601 This is an easy way how to ensure that \SpecialChar LyX
22602 won't break the line in the middle
22608 tag in your document (e.g.
22610 \begin_inset Flex Code
22613 \begin_layout Plain Layout
22620 This way svn client will automatically substitute revision number (e.g.
22622 \begin_inset Flex Code
22625 \begin_layout Plain Layout
22631 ) after each update and commit.
22632 There are more problems with this approach.
22633 Firstly, the '$' character is used in \SpecialChar TeX
22634 world for math equations, so any
22635 occurence of math formula
22636 \begin_inset Formula $Rev$
22640 \begin_inset Formula $Rev:59$
22643 in your \SpecialChar LyX
22645 Similarly for other keywords like Id, Date, Author, etc.
22646 Secondly svn output is dependent on your locales, so its very easy that
22647 svn would produce some problematic strings once Date is used.
22648 Thirdly you get the whole 'Rev: 59' string in your document instead of
22650 Until subversion implements user's custom keywords it will be hard to use
22651 this approach reliably or let \SpecialChar LyX
22652 to support it directly.
22655 \begin_layout Subsection
22656 SVN and Windows Environment
22659 \begin_layout Quote
22660 My inclination is to say that if the user cannot figure out the command
22661 line operations on their own fairly quickly, they would be well advised
22662 to use TortoiseSVN.
22668 \begin_layout Subsubsection
22672 \begin_layout Standard
22673 In addition to installing \SpecialChar LyX
22674 , and having access to a Subversion repository,
22675 the user will need to install the Subversion client program.
22676 A Windows installer for the client program is available from
22677 \begin_inset CommandInset href
22680 target "http://www.collab.net/nonav/downloads/subversion/"
22686 The user may also want to install
22687 \begin_inset CommandInset href
22690 target "http://tortoisesvn.tigris.org/"
22695 , which integrates Subversion operations into the context (rightclick) menu
22696 of Windows Explorer.
22697 Operations done outside \SpecialChar LyX
22698 will typically be more convenient using the Explorer
22700 Note that TortoiseSVN is not a replacement for the client program, which
22701 is what \SpecialChar LyX
22705 \begin_layout Subsubsection
22706 Bringing a document under Subversion control
22709 \begin_layout Standard
22710 Before a \SpecialChar LyX
22711 document can be brought under version control in Subversion, its
22712 parent directory needs to be under version control.
22713 If the document is being added to a project already in the repository,
22714 this is accomplished by checking the project out to the directory where
22715 the new document will be placed.
22716 If the project itself is not yet under version control (for instance, if
22717 this document starts a new project), the directory must be imported into
22719 This is done outside \SpecialChar LyX
22721 Both import and checkout are easily accomplished from the Explorer context
22722 menu using TortoiseSVN, or alternatively can be done using the command
22723 line client at a DOS prompt.
22724 The procedure for importing the project using TortoiseSVN is described
22725 below, assuming an existing repository and a new project being started
22733 For information on using the Subversion client program, run
22740 \begin_layout Enumerate
22747 in Windows Explorer, right click it, and select
22749 TortoiseSVN\SpecialChar menuseparator
22753 If necessary, adjust the URL for the repository, then click OK.
22756 \begin_layout Enumerate
22757 Right click the level of the repository under which you want to place the
22758 new project folder (typically the top level) and click
22762 Supply a name for the project folder and click OK.
22763 Add a message for the log file if desired, then click OK again.
22764 The new project folder should appear in the repository.
22765 Finally, click OK again to exit the repository browser.
22768 \begin_layout Enumerate
22769 Once again right click
22775 , this time selecting SVN Checkout\SpecialChar ldots
22776 Select the URL of the project folder
22777 you just created in the repository, and set the checkout directory to
22785 You will be warned about a non-empty folder; click OK to proceed.
22786 You should now have a
22797 \begin_layout Enumerate
22798 Create or open your document in \SpecialChar LyX
22801 File\SpecialChar menuseparator
22803 \begin_inset space ~
22806 Control\SpecialChar menuseparator
22810 Add a log message and click OK to commit the document to version control.
22813 \begin_layout Standard
22814 From this point onward, you should have full functionality in the
22816 File\SpecialChar menuseparator
22818 \begin_inset space ~
22824 You also have the option of checking the document in and out, viewing its
22826 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22827 client program from a command prompt.
22830 \begin_layout Subsubsection
22831 SSH tunnel used with SVN under Windows
22834 \begin_layout Standard
22835 Compared with Linux setting up an svn client to communicate over ssh under
22836 Windows is a rather troublesome task.
22837 We will at least offer some hints how to setup the client side but prior
22838 knowledge about ssh and the Windows command line is needed, also be prepared
22839 for a great deal of frustration\SpecialChar ldots
22843 \begin_layout Enumerate
22844 Get an svn client for windows, as described in the previous sections.
22845 When it is a fresh install run some svn command (e.g.
22847 \begin_inset Flex Code
22850 \begin_layout Plain Layout
22856 ) to create config files, which you will need to change later on.
22859 \begin_layout Enumerate
22860 Choose an ssh client for Windows.
22861 There are several possibilities, we will use the one from Putty tools
22865 \begin_layout Plain Layout
22866 \begin_inset Flex URL
22869 \begin_layout Plain Layout
22871 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22882 You will need to set the connection up so that the client doesn't ask for
22883 any password from you.
22884 To keep things easy we will use only keys without any additional password
22889 \begin_layout Enumerate
22891 \begin_inset Flex Code
22894 \begin_layout Plain Layout
22901 Save your private .ppk key file and put the public one on the server side.
22902 If the SVN server runs on Linux, note that the format of the public key
22903 is not compatible with Linux openssh and you will need to direcly copy-paste
22905 \begin_inset Quotes eld
22910 Public key for pasting into OpenSSH authorized_keys file
22913 \begin_inset Quotes erd
22916 edit field into the server's
22917 \begin_inset Flex Code
22920 \begin_layout Plain Layout
22921 ~/.ssh/authorized_keys
22927 \begin_inset Flex Code
22930 \begin_layout Plain Layout
22939 \begin_layout Enumerate
22941 \begin_inset Flex Code
22944 \begin_layout Plain Layout
22951 In the SVN config file
22955 \begin_layout Plain Layout
22956 Exact path depends on Windows version, usually somewhere around
22957 \begin_inset Flex Code
22960 \begin_layout Plain Layout
22963 Documents and Settings
22977 \begin_inset Flex Code
22980 \begin_layout Plain Layout
22995 , section [tunnels], setup ssh command, e.g.
22997 \begin_inset Flex Code
23000 \begin_layout Plain Layout
23001 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
23010 \begin_layout Plain Layout
23011 It will usually take a lot of time to get exact command right and it depends
23013 For example do not have some remote server saved as a default session in
23015 If things fail, try to connect via plink without SVN first.
23024 \begin_layout Enumerate
23025 Checkout the SVN archive, e.
23026 \begin_inset space \thinspace{}
23030 \begin_inset Newline newline
23034 \begin_inset Flex Code
23037 \begin_layout Plain Layout
23038 svn co svn+ssh://user@server/repository_path
23046 \begin_layout Subsubsection
23047 End-of-Line Conversions
23050 \begin_layout Standard
23051 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
23053 use different line endings inside the .lyx files.
23054 This is not a problem as far as \SpecialChar LyX
23055 functionality is concerned, but the commit
23056 diffs will be huge and merge-conflicts prone.
23057 Fortunately SVN itself knows
23061 \begin_layout Plain Layout
23062 \begin_inset Flex URL
23065 \begin_layout Plain Layout
23067 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
23077 how to deal with CR/LF problems when switching .lyx files to the
23078 \begin_inset Flex Code
23081 \begin_layout Plain Layout
23091 \begin_layout Plain Layout
23093 \begin_inset Flex Code
23096 \begin_layout Plain Layout
23097 svn propset svn:eol-style native FILE_NAME
23110 \begin_layout Subsection
23111 GIT commands in \SpecialChar LyX
23115 \begin_layout Standard
23116 A minimal subset of GIT commands is now supported by \SpecialChar LyX
23118 You can find the commands in the
23120 File\SpecialChar menuseparator
23122 \begin_inset space ~
23128 Please note that if you use password protected access to repository via
23129 ssh, you will be asked in terminal window.
23131 was tested against GIT 1.7.
23135 \begin_layout Plain Layout
23136 Windows users please note that you need to ensure that git is on the path.
23137 This can be set from within \SpecialChar LyX
23140 Tools\SpecialChar menuseparator
23141 Preferences\SpecialChar menuseparator
23142 Paths\SpecialChar menuseparator
23153 \begin_layout Standard
23154 One big difference of GIT and the other supported version control systems
23155 is the distributed nature of GIT: With traditional version control systems
23156 there is one central server which hosts the repository.
23157 Users commit their changes to the server, and get updates made by other
23159 With GIT, users commit to a local repository.
23160 The local repository can be synchronized with one or more remote repositories
23162 \begin_inset Flex Code
23165 \begin_layout Plain Layout
23172 \begin_inset Flex Code
23175 \begin_layout Plain Layout
23183 does not interact in any way with remote GIT repositories.
23184 It works exclusively with the local repository in a very similar way as
23185 with a central CVS or SVN repository.
23186 If you use remote GIT repositories you need to do the
23187 \begin_inset Flex Code
23190 \begin_layout Plain Layout
23197 \begin_inset Flex Code
23200 \begin_layout Plain Layout
23206 operations with your favourite GIT client.
23209 \begin_layout Subsubsection
23215 \begin_layout Standard
23216 If your document is not under revision control, this is the only item shown
23218 And if it is under revision control, the
23222 item is not visible.
23225 \begin_layout Standard
23226 This command registers in GIT your document ONLY in case you have already
23227 the documents directory under GIT control (in particular
23232 This means you have to checkout the archive by yourself.
23235 \begin_layout Standard
23236 Then you are asked interactively to supply an initial description of the
23238 Don't forget that registered file is not yet committed.
23241 \begin_layout Standard
23242 GIT command that is run:
23245 \begin_inset Quotes qld
23249 \begin_inset Quotes qld
23255 \begin_layout Standard
23260 to understand the switches.
23263 \begin_layout Subsubsection
23269 \begin_layout Standard
23270 When you are finished editing a file, you commit your changes.
23271 When you do this, you are asked for a description of the changes.
23272 After that changes are committed.
23275 \begin_layout Standard
23278 git commit -q -m"<description>" <file-name>
23281 \begin_layout Subsubsection
23284 Revert To Repository Version
23287 \begin_layout Standard
23288 This will discard all changes made to the document since the last check
23290 You get a warning before changes are discarded.
23293 \begin_layout Standard
23297 \begin_inset Quotes qld
23301 \begin_inset Quotes qld
23307 \begin_layout Subsubsection
23313 \begin_layout Standard
23314 This will rename the current document including the version history.
23315 It requires a clean document without any changes since the last checkin.
23316 You are asked for a file name and a description of the rename operation.
23317 After that the document is renamed, both locally and in the repository.
23318 If the parent directories of the new and old file names differ, all relative
23319 paths of included files are adjusted (like in
23321 File\SpecialChar menuseparator
23326 Finally, the document is reloaded using the new name.
23329 \begin_layout Labeling
23330 \labelwidthstring 00.00.0000
23332 \begin_inset space ~
23336 \begin_inset space ~
23340 \begin_inset Newline newline
23344 \begin_inset Flex Code
23347 \begin_layout Plain Layout
23351 \begin_inset Quotes qld
23355 \begin_inset Quotes qld
23359 \begin_inset Quotes qld
23363 \begin_inset Quotes qld
23372 \begin_inset Newline newline
23376 \begin_inset Flex Code
23379 \begin_layout Plain Layout
23388 \begin_layout Subsubsection
23394 \begin_layout Standard
23395 This shows the complete history of the GIT document.
23399 \begin_inset Quotes qld
23403 \begin_inset Quotes qld
23408 is shown in a browser.
23411 \begin_layout Subsubsection
23415 \begin_layout Standard
23417 supports GIT hash number of the last commit to the file,
23418 \change_inserted 1119979965 1564297456
23419 its abbreviated form,
23421 author name, date and time of last commit.
23422 All those are extracted from
23424 git log -n 1 --pretty=format:%H%n
23425 \change_inserted 1119979965 1564297427
23431 Tree version information is obtained via
23433 git describe --abbrev --dirty --long
23437 \begin_inset CommandInset ref
23439 reference "subsec:VCS-Revision-Information"
23446 \begin_layout Subsection
23450 \begin_layout Standard
23451 With the recent addition of the
23452 \begin_inset Flex Code
23455 \begin_layout Plain Layout
23461 function \SpecialChar LyX
23462 power users are allowed to create their own commands for revision
23466 \begin_layout Standard
23467 As an example you can see how two TortoiseSVN commands could be integrated
23471 \begin_layout Description
23473 \begin_inset Flex Code
23476 \begin_layout Plain Layout
23477 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23485 \begin_layout Description
23487 \begin_inset Flex Code
23490 \begin_layout Plain Layout
23491 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23499 \begin_layout Subsection
23500 Version control and Document comparison
23503 \begin_layout Standard
23504 One of the typical uses of version control is to inspect the changes between
23505 revisions, usually by creating
23506 \begin_inset Flex Code
23509 \begin_layout Plain Layout
23516 While this is useful for plain text files, it is much less useful in the
23517 case of \SpecialChar LyX
23518 files, which have more a complicated structure.
23519 Hence we provide binding to the Document comparison feature.
23520 There are two ways of calling this feature – either by direct call of
23521 \begin_inset Flex Code
23524 \begin_layout Plain Layout
23531 function (for details see \SpecialChar LyX
23532 functions manual) or by the toolbar icon
23545 One can either compare two chosen revisions of the document or he can simply
23546 compare the current version of edited text with older revisions (where
23548 \begin_inset Flex Noun
23551 \begin_layout Plain Layout
23557 ' revisions back means comparison of the edited file with last commited
23562 \begin_layout Standard
23563 This feature is supported for SVN and RCS though due to the more complicated
23564 versioning scheme of RCS there is a constraint – when addressing the revisions
23565 in dialog, numbers always point to the last number in RCS revision number,
23568 We don't currently support GIT addressing of revisions, one can just compare
23569 edited document with its revision X steps backs, where X is addressed as
23571 \begin_inset Flex Code
23574 \begin_layout Plain Layout
23583 \begin_layout Section
23584 Literate Programming
23587 \begin_layout Standard
23592 (kayvan@sylvan.com)
23596 original documentation written by
23598 Edmar Wienskoski Jr.
23601 (edmar-w-jr@technologist.com)
23604 \begin_layout Subsection
23608 \begin_layout Standard
23609 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23611 programming, where it is assumed that you are familiar with this programming
23612 technique, and know what
23613 \begin_inset Quotes eld
23617 \begin_inset Quotes erd
23621 \begin_inset Quotes eld
23625 \begin_inset Quotes erd
23629 If that is not the case, please follow the web links provided in the following
23631 There is a lot of good documentation out there covering old development
23632 history to the latest tools tips.
23635 \begin_layout Standard
23636 It is also assumed that you are familiar with \SpecialChar LyX
23637 itself to a point that you
23638 are comfortable changing your \SpecialChar LyX
23639 preferences, and X resources file.
23640 If that is not the case please refer to other \SpecialChar LyX
23641 documentation to cover your
23645 \begin_layout Subsection
23646 Literate Programming
23649 \begin_layout Standard
23650 From the Literate Programming FAQ:
23653 \begin_layout Quotation
23654 Literate programming is the combination of documentation and source together
23655 in a fashion suited for reading by human beings.
23656 In fact, literate programs should be enjoyable reading, even inviting!
23657 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23658 and documentation in a single file.
23659 Literate programming tools then parse the file to produce either readable
23660 documentation or compilable source.
23661 The WEB style of literate programming was created by D.
23662 \begin_inset space \thinspace{}
23666 Knuth during the development of his \SpecialChar TeX
23667 typesetting software.
23671 \begin_layout Standard
23672 Another excerpt says:
23675 \begin_layout Quotation
23678 How is literate programming different from verbose commenting?
23681 \begin_layout Quotation
23682 There are three distinguishing characteristics.
23683 In order of importance, they are:
23687 \begin_layout Itemize
23688 flexible order of elaboration
23691 \begin_layout Itemize
23692 automatic support for browsing
23695 \begin_layout Itemize
23696 typeset documentation, especially diagrams and mathematics
23700 \begin_layout Standard
23701 Now that I sparked your curiosity, take a look in the references.
23704 \begin_layout Subsubsection
23708 \begin_layout Standard
23709 The complete Literate Programming FAQ can be found at:
23712 \begin_layout Quote
23713 Literate Programming FAQ
23714 \begin_inset Flex URL
23717 \begin_layout Plain Layout
23719 http://www.literateprogramming.com/lpfaq.pdf
23727 \begin_layout Standard
23728 The FAQ lists 23 (twenty three!) different literate programming tools.
23729 Where some are specialized or
23730 \begin_inset Quotes eld
23734 \begin_inset Quotes erd
23737 for particular programming languages, while other have general scope.
23742 for my own use for several reasons:
23745 \begin_layout Itemize
23746 It can generate the documentation either in \SpecialChar LaTeX
23750 \begin_layout Itemize
23751 It has a open architecture, i.
23752 \begin_inset space \thinspace{}
23756 \begin_inset space \space{}
23759 it is easy to plug in new filters
23763 \begin_layout Plain Layout
23768 are programs that read a given data stream and output a manipulated data
23770 That way, a WEB file (consisting of literate code) can be turned into a
23771 file consisting only of C program code or \SpecialChar LaTeX
23777 and to perform special processing that you may need.
23781 \begin_layout Itemize
23782 There is a good selection of filters available already (the HTML is one
23786 \begin_layout Itemize
23790 \begin_layout Standard
23791 The Noweb web page can be found at:
23794 \begin_layout Quote
23796 \begin_inset Flex URL
23799 \begin_layout Plain Layout
23801 https://www.cs.tufts.edu/~nr/noweb/
23809 \begin_layout Standard
23810 Starting from there you can reach many other interesting links and even
23811 some literate program examples.
23814 \begin_layout Subsection
23816 and Literate Programming with Noweb
23819 \begin_layout Standard
23820 The \SpecialChar LyX
23821 support for Literate Programming is provided by using the generic \SpecialChar LyX
23823 converters mechanism.
23824 This support is provided in a
23825 \begin_inset Quotes eld
23829 \begin_inset Quotes erd
23833 \begin_inset space \thinspace{}
23837 \begin_inset space \space{}
23840 you will be able to use this new \SpecialChar LyX
23841 feature with some other literate programming
23842 tool of your choice by just changing your \SpecialChar LyX
23846 \begin_layout Subsubsection
23847 Generating documents and code (weaving and tangling)
23850 \begin_layout Paragraph
23851 Using the noweb module
23854 \begin_layout Standard
23855 If you have installed Noweb and \SpecialChar LyX
23856 successfully, whenever you open a new document,
23857 after you have chosen its document class, use the
23859 Document\SpecialChar menuseparator
23863 \begin_inset Quotes eld
23867 \begin_inset Quotes erd
23871 If Noweb is correctly installed, when you click on the
23872 \begin_inset Quotes eld
23876 \begin_inset Quotes erd
23879 link, you will see the
23880 \begin_inset Quotes eld
23884 \begin_inset Quotes erd
23887 module in the available list and you can add it to your document.
23890 \begin_layout Paragraph
23894 \begin_layout Standard
23896 enables you to write code with a custom inset named
23897 \begin_inset Flex Noun
23900 \begin_layout Plain Layout
23907 Noweb delimits chunks like this:
23910 \begin_layout LyX-Code
23914 \begin_layout LyX-Code
23918 \begin_layout LyX-Code
23922 \begin_layout LyX-Code
23926 \begin_layout LyX-Code
23930 \begin_layout Standard
23931 The problem is that whatever is written in between the << and the
23935 must be taken literally, i.
23936 \begin_inset space \thinspace{}
23940 \begin_inset space \space{}
23944 should be prevented from making any special interpretation of what has
23946 This is also handled by
23947 \begin_inset Flex Noun
23950 \begin_layout Plain Layout
23956 , that works like a normal text inset but has a free spacing capability.
23959 \begin_layout Standard
23960 As a special note, you can also use the
23961 \begin_inset Quotes eld
23965 \begin_inset Quotes erd
23968 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23972 \begin_layout LyX-Code
23976 \begin_layout LyX-Code
23977 def some_function(args):
23980 \begin_layout LyX-Code
23981 "This is the doc string for this function."
23984 \begin_layout LyX-Code
23985 print "My args: ", args
23988 \begin_layout LyX-Code
23989 @ %def some_function
23992 \begin_layout Standard
23993 For an example of this usage and the resulting cross-reference output, look
23994 at the Literate python program in
23996 LIBDIR/examples/listerrors.lyx
23998 which should make this all clear.
24001 \begin_layout Paragraph
24002 Generating the documentation
24005 \begin_layout Standard
24006 At this point you already have a new document file with a proper document
24007 class, and with some code and text on it.
24008 How do I print it? The answer is simple, you select
24010 View\SpecialChar menuseparator
24014 Just like you would do for a plain document.
24015 No special procedure is required.
24018 \begin_layout Standard
24019 To help orientate you, I will now explain what happens inside \SpecialChar LyX
24023 \begin_layout Enumerate
24026 Update\SpecialChar menuseparator
24029 menu option is chosen, a \SpecialChar LaTeX
24035 \begin_layout Standard
24036 If the document is of any literate class the generated file will be named
24037 with an extension name defined by the
24038 \begin_inset Quotes eld
24042 \begin_inset Quotes erd
24045 format (defined in the Preferences panel), otherwise the file will have
24054 \begin_layout Enumerate
24055 Note that the only difference so far is in the name of the file, no special
24056 processing is required by \SpecialChar LyX
24058 Given that you formatted the code using the
24059 \begin_inset Flex Noun
24062 \begin_layout Plain Layout
24068 inset that, by itself, takes care of the business.
24071 \begin_layout Enumerate
24072 If the document is of any literate class \SpecialChar LyX
24073 will then use the internal \SpecialChar LyX
24075 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
24080 \begin_layout Plain Layout
24081 The converters are defined in the
24083 Tools\SpecialChar menuseparator
24087 \begin_inset Quotes eld
24091 \begin_inset Quotes erd
24103 manual for general information about converters.
24108 to generate the \SpecialChar LaTeX
24113 \begin_layout Standard
24114 Otherwise it will just skip this step.
24118 \begin_layout Enumerate
24119 Finally, \SpecialChar LaTeX
24120 is invoked and the regular post processing continues as in a plain
24124 \begin_layout Standard
24125 Independence from a particular
24126 \begin_inset Quotes eld
24130 \begin_inset Quotes erd
24133 is easily achieved by changing the commands that are run by the various
24137 \begin_layout Paragraph
24138 Generating the code
24141 \begin_layout Standard
24142 When the build menu option is chosen or the corresponding button in the
24143 toolbar is pressed, a \SpecialChar LaTeX
24144 file is generated just like step 1 above.
24145 Next, \SpecialChar LyX
24151 This converter needs to be defined by the user and is not installed by
24152 default, though the Program format is.
24153 This converter (like any other converter) will have two parts:
24156 \begin_layout Enumerate
24157 The converter program itself.
24158 This program performs the conversion from the one format to the other (in
24159 this case, from the Noweb format to the Program pseudo-format).
24162 \begin_layout Enumerate
24163 The error log parser.
24164 This is a program whose sole purpose is to rewrite error messages in a
24165 format that \SpecialChar LyX
24167 This makes it possible for \SpecialChar LyX
24168 to place error boxes in the right places in
24172 \begin_layout Standard
24173 The first part, the
24174 \begin_inset Quotes eld
24178 \begin_inset Quotes erd
24181 setting, should be set to
24184 \begin_layout LyX-Code
24192 \begin_layout Standard
24193 This basically means that \SpecialChar LyX
24195 \begin_inset Quotes eld
24199 \begin_inset Quotes erd
24202 (a program or script) with the name of the Noweb file (normally a file
24203 in the \SpecialChar LyX
24204 temp directory) and the directory path of the original \SpecialChar LyX
24209 \begin_layout Standard
24210 This is an implementation of
24211 \begin_inset Quotes eld
24215 \begin_inset Quotes erd
24218 that you can place in a directory on your path:
24221 \begin_layout LyX-Code
24227 \begin_layout LyX-Code
24233 \begin_layout LyX-Code
24236 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
24239 \begin_layout Standard
24240 The next part of the converter setting is the
24241 \begin_inset Quotes eld
24245 \begin_inset Quotes erd
24248 which is to be set to
24251 \begin_layout LyX-Code
24254 parselog=$$s/scripts/listerrors
24257 \begin_layout Standard
24258 This will run any errors that are generated by the
24259 \begin_inset Quotes eld
24263 \begin_inset Quotes erd
24266 process through the
24267 \begin_inset Quotes eld
24271 \begin_inset Quotes erd
24277 \begin_layout Standard
24278 The build will normally take place in \SpecialChar LyX
24279 's temporary directory, so the files
24280 produced by the conversion will be in that directory.
24282 will copy out what it regards as the `main' file, but the
24286 conversion may produce several files, and so most of these would then be
24287 deleted when \SpecialChar LyX
24289 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
24290 the build-script chunk can place the generated files in that location.
24293 \begin_layout Paragraph
24294 Build instructions in the document
24297 \begin_layout Standard
24298 The last piece of the integration between \SpecialChar LyX
24300 \begin_inset Quotes eld
24304 \begin_inset Quotes erd
24308 Generally, the instructions for building your program should be embedded
24309 in a chunk of its own.
24311 \begin_inset Quotes eld
24315 \begin_inset Quotes erd
24318 above uses the notangle command to look for this chunk (called
24319 \begin_inset Quotes eld
24323 \begin_inset Quotes erd
24326 ) and runs its contents through
24327 \begin_inset Quotes eld
24331 \begin_inset Quotes erd
24337 \begin_layout Standard
24338 Typically, such a chunk would look something like this:
24341 \begin_layout LyX-Code
24345 \begin_layout LyX-Code
24347 \begin_inset Newline newline
24350 if [ -z "${NOWEB_SOURCE}" ]
24351 \begin_inset Newline newline
24357 \begin_layout LyX-Code
24358 NOWEB_SOURCE=myfile.nw
24359 \begin_inset Newline newline
24363 \begin_inset Newline newline
24367 code to extract files ...
24368 use NOWEB_OUTPUT_DIR here ...]
24369 \begin_inset Newline newline
24373 code to compile files ...]
24374 \begin_inset Newline newline
24380 \begin_layout Standard
24383 LIBDIR/examples/listerrors.lyx
24387 LIBDIR/examples/Literate.lyx
24389 which implement two versions of the
24390 \begin_inset Quotes eld
24394 \begin_inset Quotes erd
24397 program for some illustrations of how all of these pieces go together or
24400 LIBDIR/examples/noweb2lyx.lyx.
24403 Interestingly, these three files show off the language-indepence of the
24405 literate programming support since they are written in Python, C and Perl
24409 \begin_layout Subsubsection
24410 Configuring \SpecialChar LyX
24414 \begin_layout Standard
24415 All the Literate Programming support is configured by the
24417 Tools\SpecialChar menuseparator
24421 \begin_inset Quotes eld
24425 \begin_inset Quotes erd
24429 The important parts are:
24432 \begin_layout Description
24434 \begin_inset space ~
24438 \begin_inset Quotes eld
24442 \begin_inset Quotes erd
24446 \begin_inset space ~
24449 format Set up via the File Formats tab, this is where the Noweb-specific
24459 , the file extension is set to
24464 This tells \SpecialChar LyX
24465 to create a file with a
24469 extension in the first step of the conversion process.
24472 \begin_layout Description
24474 \begin_inset space ~
24482 \begin_inset space ~
24485 format This is an empty format whose sole purpose is to be the endpoint
24486 of a conversion (which then allows us to set up a converter for it).
24489 \begin_layout Description
24499 This converter performs the
24500 \begin_inset Quotes eld
24504 \begin_inset Quotes erd
24507 of the literate document.
24508 For Noweb, it is set to
24509 \begin_inset Quotes eld
24514 noweave -delay -index $$i > $$o
24517 \begin_inset Quotes erd
24523 \begin_layout Description
24533 \begin_inset Quotes eld
24537 \begin_inset Quotes erd
24541 As stated above, the Converter is set to
24542 \begin_inset Quotes eld
24550 \begin_inset Quotes erd
24553 , with Flags set to
24554 \begin_inset Newline newline
24558 \begin_inset Quotes eld
24563 parselog=$$s/scripts/listerrors
24566 \begin_inset Quotes erd
24572 \begin_layout Subsubsection
24576 \begin_layout Standard
24577 There is also a new function implemented in the \SpecialChar LyX
24579 \begin_inset Quotes eld
24582 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24586 \begin_layout Standard
24587 When debugging code with ddd/gdb, it is possible to invoke a text editor
24588 at the current execution position with a single key stroke.
24589 The default ddd configuration for that is shift-ctrl-V.
24590 It happens that you can define the editor command line invocation in ddd
24593 Edit\SpecialChar menuseparator
24594 Preferences\SpecialChar menuseparator
24597 dialog and changing the "Edit Sources" entry.
24600 \begin_layout Standard
24601 I take advantage of the newly created \SpecialChar LyX
24602 server function and this ddd feature,
24604 \begin_inset Quotes eld
24608 \begin_inset Quotes erd
24614 \begin_layout LyX-Code
24615 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24618 \begin_layout Standard
24619 With this, whenever you are using ddd and find a point in the program that
24620 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24621 ddd will forward this information to \SpecialChar LyX
24622 through the \SpecialChar LyX
24623 server and then the
24625 window will show the same file with the cursor at the same position ddd
24627 No more guessing or long scrolling to locate a point in the program back
24631 \begin_layout Standard
24632 Note however that you must enable the \SpecialChar LyX
24633 server to get this feature working
24634 (it is disabled by default).
24636 \begin_inset space ~
24640 \begin_inset CommandInset ref
24642 reference "sec:Starting-the-Server"
24646 explains how to do that.
24649 \begin_layout Subsubsection
24653 \begin_layout Standard
24654 There are six new buttons that can be added to your \SpecialChar LyX
24656 Four of these buttons are short cuts to layout styles:
24674 , one for the custom inset
24679 The last one is a short cut to the
24680 \begin_inset Quotes eld
24684 \begin_inset Quotes erd
24691 \begin_layout Standard
24693 has a range of buttons that are available for tool bar customization.
24694 In my toolbar I like to combine the six short cuts above with two more:
24699 \SpecialChar menuseparator
24704 \SpecialChar menuseparator
24711 Document\SpecialChar menuseparator
24712 View\SpecialChar menuseparator
24716 Here is how it looks like:
24719 \begin_layout LyX-Code
24723 \begin_layout LyX-Code
24727 \begin_layout LyX-Code
24728 Icon "layout Standard"
24731 \begin_layout LyX-Code
24732 Icon "layout Section"
24735 \begin_layout LyX-Code
24736 Icon "layout \SpecialChar LaTeX
24740 \begin_layout LyX-Code
24741 Icon "layout \SpecialChar LyX
24745 \begin_layout LyX-Code
24746 Icon "flex.insert Chunk"
24749 \begin_layout LyX-Code
24753 \begin_layout LyX-Code
24757 \begin_layout LyX-Code
24758 Icon "buffer-typeset"
24761 \begin_layout LyX-Code
24762 Icon "build-program"
24765 \begin_layout LyX-Code
24769 \begin_layout LyX-Code
24773 \begin_layout LyX-Code
24777 \begin_layout LyX-Code
24781 \begin_layout LyX-Code
24785 \begin_layout Subsubsection
24786 Colors customization
24789 \begin_layout Standard
24790 There are a number of colors in \SpecialChar LyX
24791 that can be customized in
24796 One of the things that bothers people is the \SpecialChar LaTeX
24798 The default color is red, since the chunks uses \SpecialChar LaTeX
24799 font, and there is a lot
24800 of chunks in literate documents, you may get tired of seeing everything
24802 You can change it by going to the tabs
24811 \begin_layout Standard
24812 The next thing is the visible presence of the newline character in the screen.
24813 You can choose the color of this particular character and make it blend
24815 I recommend you choosing a color that is close to the background but not
24816 equal, that way you still can see it is there, but it is not bothering
24820 \begin_layout Subsection
24825 \begin_layout Standard
24834 is documented in the
24838 example file and in the Sweave manual (menu
24840 Help\SpecialChar menuseparator
24846 \begin_layout Chapter
24850 \begin_layout Standard
24851 You can do everything with \SpecialChar LyX
24852 that you can do with \SpecialChar LaTeX
24854 However, \SpecialChar LyX
24855 cannot support every \SpecialChar LaTeX
24857 But you can always use \SpecialChar TeX
24859 This chapter shows you some more special things you might want to use.
24860 For other special things you can do with figures, tables, floats, boxes
24861 and notes, have a look at the
24864 \begin_inset space ~
24872 \begin_layout Section
24873 Multiple Text Columns
24876 \begin_layout Standard
24877 This feature is independent of the option
24879 Two-column document
24881 in the document settings under
24886 If you want to have 2
24887 \begin_inset space ~
24890 columns for the whole document, it is recommended to use the
24892 Two-column document
24895 For all other cases use this feature.
24898 \begin_layout Standard
24899 To use multiple text columns in your document, you have to load the module
24906 Document\SpecialChar menuseparator
24907 Settings\SpecialChar menuseparator
24910 ) and must have the \SpecialChar LaTeX
24912 \begin_inset Flex Code
24915 \begin_layout Plain Layout
24924 \begin_layout Standard
24925 Footnotes within multiple columns will be placed at the bottom of the page
24926 and not under each column.
24927 Within the different columns you can use everything, with the limitation
24928 that for floats you need to use the float option
24935 \begin_layout Subsection
24939 \begin_layout Standard
24940 If you want to have 2
24941 \begin_inset space ~
24944 columns in your text, insert a multicolumn inset via the menu
24946 Insert\SpecialChar menuseparator
24948 \begin_inset space ~
24951 Insets\SpecialChar menuseparator
24953 \begin_inset space ~
24958 where the columns should start.
24959 Write all text that should be printed in 2
24960 \begin_inset space ~
24963 columns into this inset.
24966 \begin_layout Standard
24967 Here is an example:
24970 \begin_layout Standard
24972 \begin_inset Flex Multiple Columns
24975 \begin_layout Plain Layout
24980 The Adventure of the Empty House
24983 \begin_inset Newline newline
24986 by Sir Arthur Conan Doyle
24989 \begin_layout Plain Layout
24992 It was in the spring of the year 1894 that all London was interested, and
24993 the fashionable world dismayed, by the murder of the Honourable Ronald
24994 Adair under most unusual and inexplicable circumstances.
24995 The public has already learned those particulars of the crime which came
24996 out in the police investigation, but a good deal was suppressed upon that
24997 occasion, since the case for the prosecution was so overwhelmingly strong
24998 that it was not necessary to bring forward all the facts.
24999 Only now, at the end of nearly ten years, am I allowed to supply those
25000 missing links which make up the whole of that remarkable chain.
25001 The crime was of interest in itself, but that interest was as nothing to
25002 me compared to the inconceivable sequel, which afforded me the greatest
25003 shock and surprise of any event in my adventurous life.
25004 Even now, after this long interval, I find myself thrilling as I think
25005 of it, and feeling once more that sudden flood of joy, amazement, and increduli
25006 ty which utterly submerged my mind.
25007 Let me say to that public, which has shown some interest in those glimpses
25008 which I have occasionally given them of the thoughts and actions of a very
25009 remarkable man, that they are not to blame me if I have not shared my knowledge
25010 with them, for I should have considered it my first duty to do so, had
25011 I not been barred by a positive prohibition from his own lips, which was
25012 only withdrawn upon the third of last month.
25020 \begin_layout Standard
25021 To get 3 or more columns, set the cursor into the multicolumn inset and
25024 Insert\SpecialChar menuseparator
25026 \begin_inset space ~
25030 \begin_inset space ~
25036 The number of the desired columns is written into that inset (for 3
25037 \begin_inset space ~
25041 \begin_inset Quotes eld
25045 \begin_inset Quotes erd
25049 \begin_inset Newline newline
25052 Here is an example with 3
25053 \begin_inset space ~
25059 \begin_layout Standard
25060 \begin_inset Flex Multiple Columns
25063 \begin_layout Plain Layout
25066 \begin_inset Argument 1
25069 \begin_layout Plain Layout
25076 It can be imagined that my close intimacy with Sherlock Holmes had interested
25077 me deeply in crime, and that after his disappearance I never failed to
25078 read with care the various problems which came before the public.
25079 And I even attempted, more than once, for my own private satisfaction,
25080 to employ his methods in their solution, though with indifferent success.
25081 There was none, however, which appealed to me like this tragedy of Ronald
25083 As I read the evidence at the inquest, which led up to a verdict of willful
25084 murder against some person or persons unknown, I realized more clearly
25085 than I had ever done the loss which the community had sustained by the
25086 death of Sherlock Holmes.
25087 There were points about this strange business which would, I was sure,
25088 have specially appealed to him, and the efforts of the police would have
25089 been supplemented, or more probably anticipated, by the trained observation
25090 and the alert mind of the first criminal agent in Europe.
25091 All day, as I drove upon my round, I turned over the case in my mind and
25092 found no explanation which appeared to me to be adequate.
25093 At the risk of telling a twice-told tale, I will recapitulate the facts
25094 as they were known to the public at the conclusion of the inquest.
25102 \begin_layout Standard
25103 You can have up to 10
25104 \begin_inset space ~
25107 columns if you want to, but that might not be very pleasant for the readers
25111 \begin_layout Standard
25112 \begin_inset Newpage newpage
25118 \begin_layout Subsection
25119 Columns inside Columns
25122 \begin_layout Standard
25123 You can also have columns inside columns:
25126 \begin_layout Standard
25127 \begin_inset Flex Multiple Columns
25130 \begin_layout Plain Layout
25133 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
25134 at that time governor of one of the Australian colonies.
25135 Adair's mother had returned from Australia to undergo the operation for
25136 cataract, and she, her son Ronald, and her daughter Hilda were living together
25140 \begin_layout Plain Layout
25141 \begin_inset Flex Multiple Columns
25144 \begin_layout Plain Layout
25147 The youth moved in the best society
25148 \begin_inset space ~
25151 – had, so far as was known, no enemies and no particular vices.
25152 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
25153 had been broken off by mutual consent some months before, and there was
25154 no sign that it had left any very profound feeling behind it.
25155 For the rest {sic} the man's life moved in a narrow and conventional circle,
25156 for his habits were quiet and his nature unemotional.
25157 Yet it was upon this easy-going young aristocrat that death came, in most
25158 strange and unexpected form, between the hours of ten and eleven-twenty
25159 on the night of March 30, 1894.
25167 \begin_layout Plain Layout
25170 Ronald Adair was fond of cards
25171 \begin_inset space ~
25174 – playing continually, but never for such stakes as would hurt him.
25175 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
25176 It was shown that, after dinner on the day of his death, he had played
25177 a rubber of whist at the latter club.
25178 He had also played there in the afternoon.
25183 The evidence of those who had played with him
25184 \begin_inset space ~
25188 Murray, Sir John Hardy, and Colonel Moran
25189 \begin_inset space ~
25192 – showed that the game was whist, and that there was a fairly equal fall
25194 Adair might have lost five pounds, but not more.
25195 His fortune was a considerable one, and such a loss could not in any way
25197 He had played nearly every day at one club or other, but he was a cautious
25198 player, and usually rose a winner.
25199 It came out in evidence that, in partnership with Colonel Moran, he had
25200 actually won as much as four hundred and twenty pounds in a sitting, some
25201 weeks before, from Godfrey Milner and Lord Balmoral.
25202 So much for his recent history as it came out at the inquest.
25210 \begin_layout Subsection
25214 \begin_layout Standard
25215 The examples in this section show some more special features of multiple
25219 \begin_layout Standard
25220 For more features of multiple columns, have a look at the
25221 \begin_inset CommandInset href
25223 name "documentation"
25224 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
25229 of the \SpecialChar LaTeX
25231 \begin_inset Flex Code
25234 \begin_layout Plain Layout
25243 \begin_layout Subsubsection
25247 \begin_layout Standard
25248 To add a preface text for multiple columns, set the cursor into the multicolumn
25249 inset and use the menu
25251 Insert\SpecialChar menuseparator
25255 Write your preface text into that inset.
25256 \begin_inset Newline newline
25259 This is an example with some preface text:
25262 \begin_layout Standard
25263 \begin_inset VSpace bigskip
25269 \begin_layout Standard
25270 \begin_inset Flex Multiple Columns
25273 \begin_layout Plain Layout
25274 \begin_inset Argument 2
25277 \begin_layout Plain Layout
25278 And the story continues and continues and continues and continues\SpecialChar ldots
25286 On the evening of the crime, he returned from the club exactly at ten.
25287 His mother and sister were out spending the evening with a relation.
25288 The servant deposed that she heard him enter the front room on the second
25289 floor, generally used as his sitting-room.
25290 She had lit a fire there, and as it smoked she had opened the window.
25291 No sound was heard from the room until eleven-twenty, the hour of the return
25292 of Lady Maynooth and her daughter.
25293 Desiring to say good-night, she attempted to enter her son's room.
25294 The door was locked on the inside, and no answer could be got to their
25295 cries and knocking.
25296 Help was obtained, and the door forced.
25297 The unfortunate young man was found lying near the table.
25298 His head had been horribly mutilated by an expanding revolver bullet, but
25299 no weapon of any sort was to be found in the room.
25307 \begin_layout Standard
25308 You can also use a section heading as the preface if you use a section command
25309 as \SpecialChar TeX
25311 For example the command
25314 \begin_layout LyX-Code
25317 subsection{subsection title}
25320 \begin_layout Standard
25321 creates a subsection.
25322 In this example the preface is a subsubsection:
25325 \begin_layout Standard
25326 \begin_inset Flex Multiple Columns
25329 \begin_layout Plain Layout
25330 \begin_inset Argument 2
25333 \begin_layout Plain Layout
25337 \begin_layout Plain Layout
25346 This is a subsubsection heading as a preface
25350 \begin_layout Plain Layout
25364 A minute examination of the circumstances served only to make the case more
25366 In the first place, no reason could be given why the young man should have
25367 fastened the door upon the inside.
25368 There was the possibility that the murderer had done this, and had afterwards
25369 escaped by the window.
25370 The drop was at least twenty feet, however, and a bed of crocuses in full
25372 Neither the flowers nor the earth showed any sign of having been disturbed,
25373 nor were there any marks upon the narrow strip of grass which separated
25374 the house from the road.
25375 Apparently, therefore, it was the young man himself who had fastened the
25377 But how did he come by his death? No one could have climbed up to the window
25378 without leaving traces.
25379 Suppose a man had fired through the window, he would indeed be a remarkable
25380 shot who could with a revolver inflict so deadly a wound.
25381 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25382 a hundred yards of the house.
25383 No one had heard a shot.
25391 \begin_layout Standard
25392 If there is less vertical space than 6
25393 \begin_inset space ~
25396 text lines is left on the page at the beginning of the multiple columns,
25397 a page break will be inserted before the multiple columns.
25398 Depending on the number of lines of the preface text, you might want to
25400 This is done by setting the cursor into the mulitcolumn inset behind the
25401 preface (if there is any) and using the menu
25403 Insert\SpecialChar menuseparator
25405 \begin_inset space ~
25409 \begin_inset space ~
25413 \begin_inset space ~
25419 Insert into that inset the amount of space like e.
25420 \begin_inset space \thinspace{}
25424 \begin_inset space \space{}
25428 \begin_inset Quotes eld
25432 \begin_inset Quotes erd
25436 \begin_inset Newline newline
25439 In this example the space is set to 7
25440 \begin_inset space ~
25443 text lines by using
25444 \begin_inset Flex Code
25447 \begin_layout Plain Layout
25456 \begin_inset Flex Code
25459 \begin_layout Plain Layout
25467 needs to be inserted as \SpecialChar TeX
25471 \begin_layout Standard
25472 \begin_inset Flex Multiple Columns
25475 \begin_layout Plain Layout
25476 \begin_inset Argument 3
25479 \begin_layout Plain Layout
25484 \begin_layout Plain Layout
25500 On the evening of the crime, he returned from the club exactly at ten.
25501 His mother and sister were out spending the evening with a relation.
25502 The servant deposed that she heard him enter the front room on the second
25503 floor, generally used as his sitting-room.
25504 She had lit a fire there, and as it smoked she had opened the window.
25505 No sound was heard from the room until eleven-twenty, the hour of the return
25506 of Lady Maynooth and her daughter.
25507 Desiring to say good-night, she attempted to enter her son's room.
25508 The door was locked on the inside, and no answer could be got to their
25509 cries and knocking.
25510 Help was obtained, and the door forced.
25511 The unfortunate young man was found lying near the table.
25512 His head had been horribly mutilated by an expanding revolver bullet, but
25513 no weapon of any sort was to be found in the room.
25521 \begin_layout Subsubsection
25525 \begin_layout Standard
25526 The amount of space before and after multiple columns can be changed by
25527 changing the length
25528 \begin_inset Flex Code
25531 \begin_layout Plain Layout
25540 For example the command
25543 \begin_layout LyX-Code
25551 \begin_layout Standard
25552 in \SpecialChar TeX
25553 Code changes its value to 3
25554 \begin_inset space \thinspace{}
25558 The change must be made before the multiple columns' start.
25559 The predefined value is 13
25560 \begin_inset space \thinspace{}
25566 \begin_layout Standard
25568 \begin_inset Flex Code
25571 \begin_layout Plain Layout
25580 \begin_inset space \thinspace{}
25586 \begin_layout Standard
25590 \begin_layout Plain Layout
25596 multicolsep}{2.5cm}
25604 \begin_layout Standard
25605 \begin_inset Flex Multiple Columns
25608 \begin_layout Plain Layout
25611 All day I turned these facts over in my mind, endeavouring to hit upon some
25612 theory which could reconcile them all, and to find that line of least resistanc
25613 e which my poor friend had declared to be the starting-point of every investigat
25615 I confess that I made little progress.
25616 In the evening I strolled across the Park, and found myself about six o'clock
25617 at the Oxford Street end of Park Lane.
25618 A group of loafers upon the pavements, all staring up at a particular window,
25619 directed me to the house which I had come to see.
25620 A tall, thin man with coloured glasses, whom I strongly suspected of being
25621 a plain-clothes detective, was pointing out some theory of his own, while
25622 the others crowded round to listen to what he said.
25623 I got as near him as I could, but his observations seemed to me to be absurd,
25624 so I withdrew again in some disgust.
25625 As I did so I struck against an elderly, deformed man, who had been behind
25626 me, and I knocked down several books which he was carrying.
25634 \begin_layout Standard
25635 \begin_inset Note Greyedout
25638 \begin_layout Plain Layout
25643 The values you set with
25644 \begin_inset Flex Code
25647 \begin_layout Plain Layout
25655 will be used for all following multiple columns until you change them again.
25663 \begin_layout Standard
25667 \begin_layout Plain Layout
25679 \begin_inset Note Note
25682 \begin_layout Plain Layout
25683 go back to the default
25691 \begin_layout Standard
25692 \begin_inset Newpage newpage
25698 \begin_layout Subsubsection
25702 \begin_layout Standard
25703 A column break can be forced by inserting the command
25704 \begin_inset Flex Code
25707 \begin_layout Plain Layout
25715 as \SpecialChar TeX
25716 Code to that position in the text where the column should be broken.
25717 Note that this leads in most cases to whitespace in the text.
25718 \begin_inset Newline newline
25721 Here is an example:
25724 \begin_layout Standard
25725 \begin_inset Flex Multiple Columns
25728 \begin_layout Plain Layout
25731 \begin_inset Quotes eld
25734 You're surprised to see me, sir,
25735 \begin_inset Quotes erd
25738 said he, in a strange, croaking voice.
25741 \begin_layout Plain Layout
25744 I acknowledged that I was.
25747 \begin_layout Plain Layout
25750 \begin_inset Quotes eld
25753 Well, I've a conscience, sir, and when I chanced to see you go into this
25754 house, as I came hobbling after you, I thought to myself, I'll just step
25755 in and see that kind gentleman, and tell him that if I was a bit gruff
25756 in my manner there was not any harm meant, and that I am much obliged to
25757 him for picking up my books.
25758 \begin_inset Quotes erd
25764 \begin_layout Plain Layout
25767 \begin_inset Quotes eld
25770 You make too much of a trifle,
25771 \begin_inset Quotes erd
25776 \begin_inset Quotes eld
25779 May I ask how you knew who I was?
25780 \begin_inset Quotes erd
25783 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25787 \begin_layout Plain Layout
25799 \begin_layout Plain Layout
25802 \begin_inset Quotes eld
25805 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25806 you'll find my little bookshop at the corner of Church Street, and very
25807 happy to see you, I am sure.
25808 Maybe you collect yourself, sir.
25812 \begin_inset space ~
25826 \begin_inset space ~
25829 – a bargain, every one of them.
25830 With five volumes you could just fill that gap on that second shelf.
25831 It looks untidy, does it not, sir?
25832 \begin_inset Quotes erd
25843 \begin_layout Subsubsection
25847 \begin_layout Standard
25848 The width of the columns is automatically calculated, but you can modify
25849 the space between the columns.
25850 This is done by changing the length
25851 \begin_inset Flex Code
25854 \begin_layout Plain Layout
25863 Its predefined value is 10
25864 \begin_inset space \thinspace{}
25868 Here is an example where
25869 \begin_inset Flex Code
25872 \begin_layout Plain Layout
25881 \begin_inset space \thinspace{}
25887 \begin_layout Standard
25891 \begin_layout Plain Layout
25905 \begin_layout Standard
25906 \begin_inset Flex Multiple Columns
25909 \begin_layout Plain Layout
25912 My observations of No.
25913 \begin_inset space \space{}
25916 427 Park Lane did little to clear up the problem in which I was interested.
25917 The house was separated from the street by a low wall and railing, the
25918 whole not more than five feet high.
25919 It was perfectly easy, therefore, for anyone to get into the garden, but
25920 the window was entirely inaccessible, since there was no water pipe or
25921 anything which could help the most active man to climb it.
25922 More puzzled than ever, I retraced my steps to Kensington.
25923 I had not been in my study five minutes when the maid entered to say that
25924 a person desired to see me.
25925 To my astonishment it was none other than my strange old book collector,
25926 his sharp, wizened face peering out from a frame of white hair, and his
25927 precious volumes, a dozen of them at least, wedged under his right arm.
25935 \begin_layout Standard
25939 \begin_layout Plain Layout
25951 \begin_inset Note Note
25954 \begin_layout Plain Layout
25955 go back to the default
25963 \begin_layout Subsubsection
25967 \begin_layout Standard
25968 Between the columns a rule with a width of the length
25969 \begin_inset Flex Code
25972 \begin_layout Plain Layout
25981 If this rule width is set to 0
25982 \begin_inset space \thinspace{}
25985 pt (this is the default), the rule is suppressed.
25986 In the following example the rule is 2
25987 \begin_inset space \thinspace{}
25993 \begin_layout Standard
25997 \begin_layout Plain Layout
26003 columnseprule}{2pt}
26011 \begin_layout Standard
26012 \begin_inset Flex Multiple Columns
26015 \begin_layout Plain Layout
26018 \begin_inset Quotes eld
26021 You're surprised to see me, sir,
26022 \begin_inset Quotes erd
26025 said he, in a strange, croaking voice.
26028 \begin_layout Plain Layout
26031 I acknowledged that I was.
26034 \begin_layout Plain Layout
26037 \begin_inset Quotes eld
26040 Well, I've a conscience, sir, and when I chanced to see you go into this
26041 house, as I came hobbling after you, I thought to myself, I'll just step
26042 in and see that kind gentleman, and tell him that if I was a bit gruff
26043 in my manner there was not any harm meant, and that I am much obliged to
26044 him for picking up my books.
26045 \begin_inset Quotes erd
26051 \begin_layout Plain Layout
26054 \begin_inset Quotes eld
26057 You make too much of a trifle,
26058 \begin_inset Quotes erd
26063 \begin_inset Quotes eld
26066 May I ask how you knew who I was?
26067 \begin_inset Quotes erd
26073 \begin_layout Plain Layout
26076 \begin_inset Quotes eld
26079 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26080 you'll find my little bookshop at the corner of Church Street, and very
26081 happy to see you, I am sure.
26082 Maybe you collect yourself, sir.
26086 \begin_inset space ~
26100 \begin_inset space ~
26103 – a bargain, every one of them.
26104 With five volumes you could just fill that gap on that second shelf.
26105 It looks untidy, does it not, sir?
26106 \begin_inset Quotes erd
26117 \begin_layout Standard
26118 \begin_inset VSpace defskip
26124 \begin_layout Standard
26125 The rule can be colored by redefining the command
26126 \begin_inset Flex Code
26129 \begin_layout Plain Layout
26138 This is done by inserting the command
26141 \begin_layout LyX-Code
26146 columnseprulecolor}{
26151 \begin_layout Standard
26152 as \SpecialChar TeX
26153 Code before the multicolumn inset.
26155 \begin_inset Flex Code
26158 \begin_layout Plain Layout
26164 in this command by a color of your choice.
26165 You can use all pre- and self-defined colors.
26173 \begin_inset space ~
26178 for more information about pre- and self-defined colors.
26179 To go back to the default color insert the command
26182 \begin_layout LyX-Code
26187 columnseprulecolor}{
26192 \begin_layout Standard
26193 Here is the example with a cyan rule and 1
26194 \begin_inset space \thinspace{}
26197 cm column separation:
26200 \begin_layout Standard
26204 \begin_layout Plain Layout
26213 \begin_layout Plain Layout
26219 columnseprulecolor}{
26229 \begin_layout Standard
26230 \begin_inset Flex Multiple Columns
26233 \begin_layout Plain Layout
26236 \begin_inset Quotes eld
26239 You're surprised to see me, sir,
26240 \begin_inset Quotes erd
26243 said he, in a strange, croaking voice.
26246 \begin_layout Plain Layout
26249 I acknowledged that I was.
26252 \begin_layout Plain Layout
26255 \begin_inset Quotes eld
26258 Well, I've a conscience, sir, and when I chanced to see you go into this
26259 house, as I came hobbling after you, I thought to myself, I'll just step
26260 in and see that kind gentleman, and tell him that if I was a bit gruff
26261 in my manner there was not any harm meant, and that I am much obliged to
26262 him for picking up my books.
26263 \begin_inset Quotes erd
26269 \begin_layout Plain Layout
26272 \begin_inset Quotes eld
26275 You make too much of a trifle,
26276 \begin_inset Quotes erd
26281 \begin_inset Quotes eld
26284 May I ask how you knew who I was?
26285 \begin_inset Quotes erd
26291 \begin_layout Plain Layout
26294 \begin_inset Quotes eld
26297 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26298 you'll find my little bookshop at the corner of Church Street, and very
26299 happy to see you, I am sure.
26300 Maybe you collect yourself, sir.
26304 \begin_inset space ~
26318 \begin_inset space ~
26321 – a bargain, every one of them.
26322 With five volumes you could just fill that gap on that second shelf.
26323 It looks untidy, does it not, sir?
26324 \begin_inset Quotes erd
26335 \begin_layout Standard
26339 \begin_layout Plain Layout
26345 columnseprule}{0pt}
26348 \begin_layout Plain Layout
26354 columnseprulecolor}{
26362 \begin_inset Note Note
26365 \begin_layout Plain Layout
26366 go back to the default
26374 \begin_layout Section
26375 Non-standard Paragraph Shapes
26378 \begin_layout Standard
26381 as well as any other text processor uses by default rectangular paragraphs.
26382 For special cases like for example posters, invitation cards or poems you
26383 can modify the paragraph shape to one of your choice.
26384 This can be done by using the \SpecialChar LaTeX
26386 \begin_inset Flex Code
26389 \begin_layout Plain Layout
26395 which is loaded by using in the document settings the module
26397 Custom paragraph shapes
26402 \begin_layout Subsection
26406 \begin_layout Standard
26411 provides the following shapes:
26414 \begin_layout Standard
26415 \begin_inset Tabular
26416 <lyxtabular version="3" rows="13" columns="3">
26417 <features booktabs="true" islongtable="true" longtabularalignment="center">
26418 <column alignment="left" valignment="middle" width="16col%">
26419 <column alignment="left" valignment="middle" width="40col%">
26420 <column alignment="left" valignment="middle" width="35col%">
26421 <row endhead="true">
26422 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26425 \begin_layout Plain Layout
26434 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26437 \begin_layout Plain Layout
26446 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26449 \begin_layout Plain Layout
26459 <row interlinespace="default">
26460 <cell alignment="left" valignment="top" usebox="none">
26463 \begin_layout Plain Layout
26471 <cell alignment="left" valignment="top" usebox="none">
26474 \begin_layout Plain Layout
26477 Circle with circular hole (in the size of a CD/DVD)
26482 <cell alignment="left" valignment="top" usebox="none">
26485 \begin_layout Plain Layout
26488 Cannot be scaled, take care there is not too much text
26494 <row interlinespace="default">
26495 <cell alignment="left" valignment="top" usebox="none">
26498 \begin_layout Plain Layout
26506 <cell alignment="left" valignment="top" usebox="none">
26509 \begin_layout Plain Layout
26517 <cell alignment="left" valignment="top" usebox="none">
26520 \begin_layout Plain Layout
26523 Fragile, calculation might fail
26529 <row interlinespace="default">
26530 <cell alignment="left" valignment="top" usebox="none">
26533 \begin_layout Plain Layout
26541 <cell alignment="left" valignment="top" usebox="none">
26544 \begin_layout Plain Layout
26547 Rhomboid (symbolizing a
26548 \begin_inset Quotes eld
26552 \begin_inset Quotes erd
26560 <cell alignment="left" valignment="top" usebox="none">
26563 \begin_layout Plain Layout
26572 <row interlinespace="default">
26573 <cell alignment="left" valignment="top" usebox="none">
26576 \begin_layout Plain Layout
26584 <cell alignment="left" valignment="top" usebox="none">
26587 \begin_layout Plain Layout
26595 <cell alignment="left" valignment="top" usebox="none">
26598 \begin_layout Plain Layout
26607 <row interlinespace="default">
26608 <cell alignment="left" valignment="top" usebox="none">
26611 \begin_layout Plain Layout
26619 <cell alignment="left" valignment="top" usebox="none">
26622 \begin_layout Plain Layout
26630 <cell alignment="left" valignment="top" usebox="none">
26633 \begin_layout Plain Layout
26642 <row interlinespace="default">
26643 <cell alignment="left" valignment="top" usebox="none">
26646 \begin_layout Plain Layout
26654 <cell alignment="left" valignment="top" usebox="none">
26657 \begin_layout Plain Layout
26660 Nut for bolt (hexagon with circular hole)
26665 <cell alignment="left" valignment="top" usebox="none">
26668 \begin_layout Plain Layout
26677 <row interlinespace="default">
26678 <cell alignment="left" valignment="top" usebox="none">
26681 \begin_layout Plain Layout
26689 <cell alignment="left" valignment="top" usebox="none">
26692 \begin_layout Plain Layout
26700 <cell alignment="left" valignment="top" usebox="none">
26703 \begin_layout Plain Layout
26712 <row interlinespace="default">
26713 <cell alignment="left" valignment="top" usebox="none">
26716 \begin_layout Plain Layout
26724 <cell alignment="left" valignment="top" usebox="none">
26727 \begin_layout Plain Layout
26735 <cell alignment="left" valignment="top" usebox="none">
26738 \begin_layout Plain Layout
26747 <row interlinespace="default">
26748 <cell alignment="left" valignment="top" usebox="none">
26751 \begin_layout Plain Layout
26759 <cell alignment="left" valignment="top" usebox="none">
26762 \begin_layout Plain Layout
26770 <cell alignment="left" valignment="top" usebox="none">
26773 \begin_layout Plain Layout
26782 <row interlinespace="default">
26783 <cell alignment="left" valignment="top" usebox="none">
26786 \begin_layout Plain Layout
26794 <cell alignment="left" valignment="top" usebox="none">
26797 \begin_layout Plain Layout
26800 Normal/reversed rain drop
26805 <cell alignment="left" valignment="top" usebox="none">
26808 \begin_layout Plain Layout
26811 Fragile, calculation might fail
26817 <row interlinespace="default">
26818 <cell alignment="left" valignment="top" usebox="none">
26821 \begin_layout Plain Layout
26830 <cell alignment="left" valignment="top" usebox="none">
26833 \begin_layout Plain Layout
26836 The \SpecialChar TeX
26842 <cell alignment="left" valignment="top" usebox="none">
26845 \begin_layout Plain Layout
26854 <row interlinespace="default">
26855 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26858 \begin_layout Plain Layout
26862 \begin_inset Newline newline
26870 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26873 \begin_layout Plain Layout
26876 Triangles in different orientations
26881 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26884 \begin_layout Plain Layout
26900 \begin_layout Standard
26901 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26903 for environments in the toolbar.
26906 \begin_layout Standard
26907 \begin_inset Newpage newpage
26913 \begin_layout Standard
26914 Here is an example paragraph in the shape of a nut:
26917 \begin_layout Standard
26918 \begin_inset VSpace bigskip
26927 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26928 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26930 At vero eos et accusam et justo duo dolores et ea rebum.
26931 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26933 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26934 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26938 \begin_layout Standard
26939 \begin_inset VSpace bigskip
26945 \begin_layout Standard
26946 \begin_inset Note Greyedout
26949 \begin_layout Plain Layout
26958 paragraphs cannot run over a page break.
26966 \begin_layout Standard
26967 \begin_inset VSpace bigskip
26973 \begin_layout Standard
26975 \begin_inset Flex Code
26978 \begin_layout Plain Layout
26984 takes care that the shape will always be preserved, no matter how much
26985 text is in the paragraph.
26986 Therefore the paragraph size changes with the amount of contained text.
26987 This can lead to paragraph sizes exceeding the page margins.
26988 To demonstrate the size scaling, here is the same example paragraph but
26989 with twice as much text:
26992 \begin_layout Standard
26993 \begin_inset Newpage newpage
27002 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27003 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27005 At vero eos et accusam et justo duo dolores et ea rebum.
27006 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27008 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27009 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27011 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27012 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27014 At vero eos et accusam et justo duo dolores et ea rebum.
27015 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27017 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27018 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27022 \begin_layout Standard
27023 \begin_inset VSpace bigskip
27029 \begin_layout Standard
27030 An exception is the shape
27035 It cannot be scaled because it must fit the size of a CD/DVD.
27036 Therefore the amount of text that fits into the shape is limited.
27037 \begin_inset Newline newline
27048 shape are fragile, meaning that the calculation of their size can fail,
27049 depending on the amount of text.
27050 You will then get the \SpecialChar LaTeX
27052 \begin_inset Quotes eld
27055 Arithmetic overflow
27056 \begin_inset Quotes erd
27060 In this case one can try to remove or add some text; if nothing works one
27061 has to use another shape.
27064 \begin_layout Standard
27065 \begin_inset VSpace bigskip
27071 \begin_layout Standard
27072 For shapes with tips you will maybe see that \SpecialChar LaTeX
27073 's hyphenation routine fails
27074 for text in the tips.
27075 Therefore it is often necessary to add hyphenation points
27080 arg "specialchar-insert hyphenation"
27085 ) to the corresponding text parts.
27088 \begin_layout Standard
27089 \begin_inset VSpace bigskip
27095 \begin_layout Standard
27096 Shapepar paragraphs are either always centered or placed on the page so
27097 that their left border touches the left page margin.
27098 You can therefore not use the paragraph dialog to align such paragraphs.
27099 A solution is to put the paragraph into a minipage or parbox and align
27101 The problem is hereby to find the right width for the box.
27102 Because if it is too wide and you center the box, the paragraph is not
27103 centered too because it sticks at the left side of the box.
27104 So you might have to play a bit with the width until it fits.
27105 Here are two heart-shaped paragraphs, the first one is not aligned, the
27106 second one is right-aligned:
27109 \begin_layout Standard
27110 \begin_inset Newpage newpage
27116 \begin_layout Heart
27120 Lo\SpecialChar softhyphen
27121 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27122 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27124 At vero eos et accusam et justo duo dolores et ea rebum.
27125 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27129 \begin_layout Standard
27130 \begin_inset VSpace bigskip
27136 \begin_layout Standard
27139 \begin_inset Box Frameless
27149 height_special "totalheight"
27154 backgroundcolor "none"
27157 \begin_layout Heart
27161 Lo\SpecialChar softhyphen
27162 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27163 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27165 At vero eos et accusam et justo duo dolores et ea rebum.
27166 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27175 \begin_layout Subsection
27179 \begin_layout Standard
27180 You can define any shape you want.
27181 Doing this manually is a lot of work because every coordinate must be specified.
27182 But there is a way to let the computer calculate the coordinates:
27185 \begin_layout Enumerate
27186 Install the program
27187 \begin_inset CommandInset href
27190 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
27198 \begin_layout Enumerate
27205 TeX/LaTeX\SpecialChar menuseparator
27206 Settings\SpecialChar menuseparator
27209 and select the font size you are using in your document.
27210 For example this document uses the size 12
27211 \begin_inset space \thinspace{}
27217 \begin_layout Enumerate
27221 \begin_layout Enumerate
27224 TeX/LaTeX\SpecialChar menuseparator
27227 to export the shape to coordinates.
27228 In the appearing dialog use either the outline of your shape for the coordinate
27229 s or the path itself.
27233 \begin_layout Plain Layout
27234 For more information see
27235 \begin_inset CommandInset href
27237 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
27250 \begin_layout Standard
27251 The coordinates are written into a \SpecialChar TeX
27253 To use it for your \SpecialChar LyX
27257 \begin_layout Enumerate
27258 Place the cursor before the first character of your paragraph (or into a
27262 \begin_layout Enumerate
27263 Open in \SpecialChar LyX
27266 Insert\SpecialChar menuseparator
27267 File\SpecialChar menuseparator
27269 \begin_inset space ~
27274 , select the file and use
27283 \begin_layout Standard
27284 \begin_inset VSpace defskip
27290 \begin_layout Standard
27291 \begin_inset Note Greyedout
27294 \begin_layout Plain Layout
27299 : The changed shape only applies to the current paragraph; everything is
27300 reset to normal for the next paragraph.
27301 Therefore the shape definition file must be input into every paragraph
27302 with the desired shape.
27310 \begin_layout Standard
27311 \begin_inset VSpace bigskip
27317 \begin_layout Standard
27318 Here is an example:
27321 \begin_layout Standard
27322 \begin_inset VSpace bigskip
27328 \begin_layout Standard
27329 \begin_inset CommandInset include
27331 filename "SpecialParagraphShape.tex"
27338 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27339 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27341 At vero eos et accusam et justo duo dolores et ea rebum.
27342 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27344 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27345 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27349 \begin_layout Standard
27350 \begin_inset VSpace bigskip
27356 \begin_layout Standard
27361 to draw complexer shapes in
27365 you can draw the shape in a program of your choice and import the resulting
27371 Then you only need to draw a line or spline along the outline of the image.
27374 \begin_layout Standard
27375 \begin_inset VSpace bigskip
27381 \begin_layout Standard
27384 Custom paragraph shapes
27386 also provides the two commands
27394 which can be used to define custom shapes coordinate by coordinate.
27398 \begin_layout Plain Layout
27399 These commands are internally used for all shapes described here.
27404 For information how these styles are used and about further customization
27405 possibilities, have a look at the
27406 \begin_inset CommandInset href
27408 name "documentation"
27409 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
27415 \begin_inset Flex Code
27418 \begin_layout Plain Layout