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 Section
2872 \change_inserted 564990737 1670439534
2876 \begin_layout Standard
2878 \change_inserted 564990737 1670439557
2879 See also the document classes in the Collections (section
2880 \begin_inset space ~
2884 \begin_inset CommandInset ref
2886 reference "sec:Collections"
2893 \begin_layout Section
2895 \change_inserted 564990737 1670439560
2899 \begin_layout Standard
2901 \change_inserted 564990737 1670439581
2902 See also the document classes in the Collections (section
2903 \begin_inset space ~
2907 \begin_inset CommandInset ref
2909 reference "sec:Collections"
2916 \begin_layout Section
2918 \change_inserted 564990737 1670439605
2922 \begin_layout Section
2924 \change_inserted 564990737 1670439627
2928 \begin_layout Section
2930 \change_inserted 564990737 1670439660
2934 \begin_layout Section
2936 \change_inserted 564990737 1670439661
2940 \begin_layout Subsection
2942 \change_inserted 564990737 1670439661
2946 \begin_layout Standard
2948 \change_inserted 564990737 1670439661
2957 document class for preparing reports.
2962 document class, this provides parts, chapters and sections but does not
2963 provide the paragraph styles needed for a book; like the
2967 document class, it provides the abstract paragraph style.
2968 In two-sided mode, it does not start a new chapter on the right hand page.
2971 \begin_layout Standard
2973 \change_inserted 564990737 1670439674
2978 document classes are described in the Collections (section
2979 \begin_inset space ~
2983 \begin_inset CommandInset ref
2985 reference "sec:Collections"
2992 \begin_layout Section
2994 \change_inserted 564990737 1670439674
2998 \begin_layout Chapter
3002 \begin_layout Section
3003 Customizing Bibliographies with Bib\SpecialChar TeX
3007 \begin_layout Standard
3008 The most basic information about how to use Bib\SpecialChar TeX
3013 with \SpecialChar LyX
3014 is contained in the section
3016 Bibliography databases
3023 The following subsections explain special bibliography features supported
3028 \begin_layout Subsection
3029 Alternative Citation Styles
3032 \begin_layout Standard
3033 Standard Bib\SpecialChar TeX
3035 \begin_inset space \thinspace{}
3039 \begin_inset space \space{}
3043 \begin_inset Quotes eld
3047 \begin_inset Quotes erd
3050 ) to refer to a cited work.
3051 However, in many scientific disciplines, other citation styles are in use.
3052 The most common one is the author-year style (e.
3053 \begin_inset space \thinspace{}
3057 \begin_inset space \space{}
3061 \begin_inset Quotes eld
3065 \begin_inset Quotes erd
3070 supports three packages that provide this style,
3071 \begin_inset Flex Code
3074 \begin_layout Plain Layout
3081 \begin_inset Flex Code
3084 \begin_layout Plain Layout
3091 \begin_inset Flex Code
3094 \begin_layout Plain Layout
3101 Each of these packages has their pros and cons, which cannot be listed
3103 If you only want to have simple author-year (or author-numerical) style,
3104 or if you want to use one of the countless style files for
3105 \begin_inset Flex Code
3108 \begin_layout Plain Layout
3114 , then the established
3115 \begin_inset Flex Code
3118 \begin_layout Plain Layout
3124 package is probably your choice.
3125 If you look for specific citation styles common in law studies, you might
3127 \begin_inset Flex Code
3130 \begin_layout Plain Layout
3137 If you want to have full control over the formatting or look for advanced
3138 features such as ibidem, footnote citations, full title citations, advanced
3139 date formats (such as 400 BC) or full localization to other languages than
3140 English, you should definitely consider
3141 \begin_inset Flex Code
3144 \begin_layout Plain Layout
3150 , which exceeds all other packages in terms of features, but is also quite
3151 heavy and more resource-hungry.
3154 \begin_layout Standard
3155 The handling of these packages in \SpecialChar LyX
3156 is basically the same.
3158 \begin_inset Flex Noun
3161 \begin_layout Plain Layout
3162 Document\SpecialChar menuseparator
3169 \begin_inset Flex Noun
3172 \begin_layout Plain Layout
3179 \begin_inset Flex Noun
3182 \begin_layout Plain Layout
3189 \begin_inset Flex Noun
3192 \begin_layout Plain Layout
3199 \begin_inset Flex Noun
3202 \begin_layout Plain Layout
3209 \begin_inset Flex Noun
3212 \begin_layout Plain Layout
3213 Biblatex (Natbib mode)
3219 \begin_inset Flex Noun
3222 \begin_layout Plain Layout
3229 \begin_inset Flex Noun
3232 \begin_layout Plain Layout
3239 \begin_inset space ~
3242 6.5.3 in the User's Guide for more information on these choices).
3243 With all these packages, you will get some extra features in the citation
3244 dialog and you can select the style of the reference (
3245 \begin_inset Quotes eld
3249 \begin_inset Quotes erd
3253 \begin_inset Quotes eld
3257 \begin_inset Quotes erd
3261 \begin_inset Quotes eld
3265 \begin_inset Quotes erd
3269 \begin_inset Quotes eld
3273 \begin_inset Quotes erd
3277 Note that either package needs specifically designed style files.
3278 They all ship their own, but there are lots of additional style files,
3279 and there is even an interactive style file builder
3283 \begin_layout Plain Layout
3285 \begin_inset Flex URL
3288 \begin_layout Plain Layout
3290 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
3301 \begin_inset Flex Code
3304 \begin_layout Plain Layout
3313 \begin_layout Subsection
3314 Subdivided Bibliographies
3317 \begin_layout Standard
3318 Sometimes you might need to divide your bibliography into several sections.
3319 If you are for instance a historian, the possibility to separate sources
3320 and scientific works is most likely a
3321 \begin_inset Quotes eld
3325 \begin_inset Quotes erd
3329 Unfortunately, Bib\SpecialChar TeX
3330 itself does not allow you to do this.
3331 But with the help of some \SpecialChar LaTeX
3332 packages, Bib\SpecialChar TeX
3333 can be extended to fit your needs.
3336 \begin_layout Standard
3338 provides native support for one of these packages,
3346 \begin_layout Plain Layout
3348 \begin_inset Flex URL
3351 \begin_layout Plain Layout
3353 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
3363 The advantage of this package (compared to other packages such as
3367 ) is that you don't need to define new citation commands.
3368 Instead, you need to prepare different bibliographic databases which include
3369 the entries for the different sections of the bibliography.
3370 For example: If you want to divide your bibliography into the sections
3372 \begin_inset Quotes eld
3376 \begin_inset Quotes erd
3380 \begin_inset Quotes eld
3384 \begin_inset Quotes erd
3387 , you first need to create two bibliographic databases, e.
3388 \begin_inset space \thinspace{}
3392 \begin_inset space \space{}
3396 \begin_inset Flex Code
3399 \begin_layout Plain Layout
3406 \begin_inset Flex Code
3409 \begin_layout Plain Layout
3419 \begin_layout Standard
3421 \begin_inset Flex Noun
3424 \begin_layout Plain Layout
3425 Document\SpecialChar menuseparator
3432 \begin_inset Flex Noun
3435 \begin_layout Plain Layout
3442 \begin_inset Flex Noun
3445 \begin_layout Plain Layout
3446 Subdivided bibliography
3452 Now you can insert multiple Bib\SpecialChar TeX
3453 bibliographies, one for each section of
3455 Returning to our example: Insert the Bib\SpecialChar TeX
3457 \begin_inset Flex Code
3460 \begin_layout Plain Layout
3466 and a second one for the database
3467 \begin_inset Flex Code
3470 \begin_layout Plain Layout
3477 You are free to use the same or different styles for each section.
3478 Additionally, you can choose if the bibliography section should contain
3480 \begin_inset Quotes eld
3483 all cited references
3484 \begin_inset Quotes erd
3487 of the specified database(s) (which is the default),
3488 \begin_inset Quotes eld
3491 all uncited references
3492 \begin_inset Quotes erd
3496 \begin_inset Quotes eld
3500 \begin_inset Quotes erd
3504 This might be useful if you would like to separate your bibliography into
3506 \begin_inset Quotes eld
3510 \begin_inset Quotes erd
3514 \begin_inset Quotes eld
3518 \begin_inset Quotes erd
3522 \begin_inset Quotes eld
3526 \begin_inset Quotes erd
3530 The titles for the sections can be added as ordinary sections or subsections.
3532 \begin_inset Flex Code
3535 \begin_layout Plain Layout
3541 removes the bibliography title, you have to manually re-add that, too (as
3542 a chapter* or section*, for instance).
3545 \begin_layout Standard
3550 , the procedure is a bit different.
3559 , the aforementioned
3560 \begin_inset Flex Noun
3563 \begin_layout Plain Layout
3564 Subdivided bibliography
3569 option is disabled if you use
3578 provides its own means to generate subdivided bibliographies.
3579 You can either add keywords to bibliography entries via the
3580 \begin_inset Flex Code
3583 \begin_layout Plain Layout
3589 entry option and then filter bibliography sections by keyword (by adding
3591 \begin_inset Flex Code
3594 \begin_layout Plain Layout
3601 \begin_inset Flex Noun
3604 \begin_layout Plain Layout
3610 field of the dialog that opens if you left-click on the
3611 \begin_inset Flex Noun
3614 \begin_layout Plain Layout
3615 Biblatex Generated Bibliography
3620 button), or you can filter by entry types (such as
3629 \begin_inset space \thinspace{}
3634 \begin_inset Flex Code
3637 \begin_layout Plain Layout
3644 \begin_inset Flex Code
3647 \begin_layout Plain Layout
3654 \begin_inset Flex Noun
3657 \begin_layout Plain Layout
3663 field, or you can create so-called
3664 \begin_inset Quotes eld
3667 Bibliography Categories
3668 \begin_inset Quotes erd
3671 to which you can assign individual entries.
3672 Please refer to the Biblatex manual, section
3674 Subdivided Bibliographies
3679 \begin_layout Subsection
3680 Multiple Bibliographies
3681 \begin_inset CommandInset label
3683 name "subsec:Multiple-Bibliographies"
3690 \begin_layout Standard
3691 Multiple bibliographies, e.
3692 \begin_inset space \thinspace{}
3696 \begin_inset space \space{}
3699 a bibliography for each part, chapter, section, subsection or child (sub-documen
3700 t) of the document, are also supported by \SpecialChar LyX
3702 In order to enable it, go to
3703 \begin_inset Flex Noun
3706 \begin_layout Plain Layout
3707 Document\SpecialChar menuseparator
3708 Settings\SpecialChar menuseparator
3714 and select the relevant unit (e.
3715 \begin_inset space \thinspace{}
3719 \begin_inset Quotes eld
3723 \begin_inset Quotes erd
3727 \begin_inset Flex Noun
3730 \begin_layout Plain Layout
3731 Multiple Bibliographies
3737 Then add a Bib(la)\SpecialChar TeX
3738 bibliography to each unit (e.
3739 \begin_inset space \thinspace{}
3742 g., section) of your document.
3743 In the output, a separate bibliography, containing only the references
3744 done in the current unit is generated.
3747 \begin_layout Standard
3748 If you use Bib\SpecialChar TeX
3750 \begin_inset Flex Code
3753 \begin_layout Plain Layout
3760 \begin_inset Flex Code
3763 \begin_layout Plain Layout
3769 package is used to create multiple bibliographies.
3770 The former package is used if you select
3771 \begin_inset Quotes eld
3775 \begin_inset Quotes erd
3783 \begin_inset Flex Noun
3786 \begin_layout Plain Layout
3787 Sectioned Bibliography
3794 \begin_inset Flex Code
3797 \begin_layout Plain Layout
3807 \begin_layout Plain Layout
3808 An alternative approach, if you are willing to use some
3809 \begin_inset Flex Noun
3812 \begin_layout Plain Layout
3820 \begin_inset space ~
3824 \begin_inset CommandInset ref
3826 reference "sec:Inserting-TeX-Code"
3831 \begin_inset Flex Code
3834 \begin_layout Plain Layout
3846 \begin_inset Flex Code
3849 \begin_layout Plain Layout
3855 is used, \SpecialChar LyX
3856 encloses the specified units in
3857 \begin_inset Flex Code
3860 \begin_layout Plain Layout
3867 \begin_inset Flex Code
3870 \begin_layout Plain Layout
3879 \begin_inset Flex Code
3882 \begin_layout Plain Layout
3890 in order to create the units.
3891 Note that this approach has some limitations.
3892 First, every citation reference has to be inside some
3893 \begin_inset Flex Code
3896 \begin_layout Plain Layout
3903 So citations outside a defined unit (e.
3904 \begin_inset space \thinspace{}
3907 g., before the first section if you use
3908 \begin_inset Quotes eld
3912 \begin_inset Quotes erd
3916 \begin_inset Quotes eld
3920 \begin_inset Quotes erd
3924 You can also create your own units by entering
3925 \begin_inset Flex Code
3928 \begin_layout Plain Layout
3937 \begin_inset Flex Code
3940 \begin_layout Plain Layout
3949 code (for instance to work around the mentioned limitation).
3951 \begin_inset Flex Code
3954 \begin_layout Plain Layout
3961 A second limitation is that
3962 \begin_inset Flex Code
3965 \begin_layout Plain Layout
3971 always processes all references of a bibliography database, even if they
3973 This can result in odd labels (e.
3974 \begin_inset space \thinspace{}
3979 \begin_inset Quotes eld
3983 \begin_inset Quotes erd
3986 if two works of this author from 2014 are in the database, even if only
3990 \begin_layout Standard
3996 \begin_inset Flex Code
3999 \begin_layout Plain Layout
4005 option is used instead.
4006 If you need specific units, you can start them with the \SpecialChar TeX
4008 \begin_inset Flex Code
4011 \begin_layout Plain Layout
4020 \begin_inset Flex Code
4023 \begin_layout Plain Layout
4032 If you also want to control the end of the unit, use the environment
4033 \begin_inset Flex Code
4036 \begin_layout Plain Layout
4046 \begin_inset Flex Code
4049 \begin_layout Plain Layout
4059 \begin_inset Flex Code
4062 \begin_layout Plain Layout
4069 In addition to the individual bibliography of the current unit,
4073 also provides an easy way to output all bibliographies, subsequently, at
4075 \begin_inset space \thinspace{}
4078 g., at the end of the document).
4080 \begin_inset Quotes eld
4084 \begin_inset Quotes erd
4087 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
4093 manual for more information on this topic.
4096 \begin_layout Section
4100 \begin_layout Subsection
4104 \begin_layout Standard
4105 When you are working on a large file with many sections, it is often convenient
4106 to break up the document into several files, or perhaps you have something
4107 where a table may change from time to time, but the preceding text does
4109 In these cases, you should seriously consider using multipart documents.
4110 For example, scientific papers often have five major sections: the introduction
4111 , observations, results, discussion, and conclusion.
4112 Each of these could be its own separate \SpecialChar LyX
4114 \begin_inset Quotes eld
4118 \begin_inset Quotes erd
4121 file which contains the title, authors, abstract, references, etc., plus
4122 the five included files.
4123 It is important to note that each of these files is a full \SpecialChar LyX
4125 can be formatted and printed on its own, as well as included in a master
4127 Each of these files must have the same document class, however—don't attempt
4128 to mix book classes with article classes.
4129 You may also include \SpecialChar LaTeX
4130 files; however, these files must not have their own
4132 \begin_inset space \thinspace{}
4136 \begin_inset space \space{}
4139 everything up to and including the
4140 \begin_inset Flex Code
4143 \begin_layout Plain Layout
4152 \begin_inset Flex Code
4155 \begin_layout Plain Layout
4163 line must be deleted) or else errors will be generated when you try to
4167 \begin_layout Standard
4169 allows you to include files quite easily with
4170 \begin_inset Flex Noun
4173 \begin_layout Plain Layout
4174 Insert\SpecialChar menuseparator
4176 \begin_inset space ~
4185 When you click on this selection a small box is inserted into the file
4186 at the current cursor location.
4187 Clicking on the box raises a dialog which allows you to select the file
4188 to be included, and the method of its inclusion.
4192 \begin_layout Standard
4193 The file selection box should by now be obvious.
4194 The three inclusion methods are
4195 \begin_inset Quotes eld
4199 \begin_inset Quotes erd
4203 \begin_inset Quotes eld
4207 \begin_inset Quotes erd
4211 \begin_inset Quotes eld
4215 \begin_inset Quotes erd
4220 \begin_inset Quotes eld
4224 \begin_inset Quotes erd
4228 \begin_inset Quotes eld
4232 \begin_inset Quotes erd
4235 are similar in many ways, but there are also some notable differences:
4238 \begin_layout Enumerate
4240 \begin_inset Quotes eld
4244 \begin_inset Quotes erd
4247 are typeset beginning on a new page, while files that are
4248 \begin_inset Quotes eld
4252 \begin_inset Quotes erd
4255 are typeset starting on the current page.
4258 \begin_layout Enumerate
4259 \begin_inset Quotes eld
4263 \begin_inset Quotes erd
4266 files cannot themselves
4267 \begin_inset Quotes eld
4271 \begin_inset Quotes erd
4275 \begin_inset Quotes eld
4279 \begin_inset Quotes erd
4284 \begin_inset Quotes eld
4288 \begin_inset Quotes erd
4291 , on the other hand, infinite sub-inputting is possible.
4294 \begin_layout Enumerate
4295 \begin_inset Quotes eld
4299 \begin_inset Quotes erd
4302 allow for the output of only selected
4303 \begin_inset Quotes eld
4307 \begin_inset Quotes erd
4310 files, while maintaining the actual counters (pagination etc.) and references
4311 (please refer to the section
4314 \begin_inset space ~
4322 \begin_inset space ~
4327 manual for details).
4330 \begin_layout Standard
4332 \begin_inset Quotes eld
4336 \begin_inset Quotes erd
4339 is the preferred method for chapters that are outsourced to child documents,
4341 \begin_inset Quotes eld
4345 \begin_inset Quotes erd
4348 is more suitable for arbitrary file inheritance.
4351 \begin_layout Standard
4353 \begin_inset Quotes eld
4357 \begin_inset Quotes erd
4360 included file allows you to include a file typeset exactly as it appears
4362 \begin_inset space \thinspace{}
4366 \begin_inset space \space{}
4370 \begin_inset Flex Code
4373 \begin_layout Plain Layout
4379 mode, with the characters set in a fixed-width typewriter font.
4380 Normally, spaces in this file are invisible, though two consecutive spaces
4381 are conserved, unlike \SpecialChar LyX
4382 's normal treatment of spaces.
4383 However, setting the
4384 \begin_inset Flex Noun
4387 \begin_layout Plain Layout
4389 \begin_inset space ~
4393 \begin_inset space ~
4397 \begin_inset space ~
4405 checkbox typesets a mark to unambiguously define the presence of a space.
4409 \begin_layout Standard
4410 Generally, the master file is converted into a full \SpecialChar LaTeX
4411 file before typesetting,
4412 while the included files are converted to \SpecialChar LaTeX
4413 files that do not have all the
4414 preamble information.
4417 \begin_layout Subsection
4418 Cross-References Between Files
4421 \begin_layout Standard
4422 \begin_inset Box Shadowbox
4432 height_special "totalheight"
4437 backgroundcolor "none"
4440 \begin_layout Plain Layout
4441 This section is somewhat out of date.
4442 Need to describe default master documents and how children are opened when
4452 \begin_layout Standard
4453 It is possible to set up cross-references between the different files.
4454 First, open all the files in question: let's call them A and B in a two
4455 file example, where B is included in A.
4456 Let's say you insert a label in A, then want to reference it in B.
4457 Open the cross-reference dialog whilst in document B, and you can select
4459 \begin_inset Quotes eld
4463 \begin_inset Quotes erd
4469 \begin_layout Subsection
4470 Bibliography Lists in all Subdocuments
4473 \begin_layout Standard
4474 If you work with child documents, you might want to have only one main bibliogra
4475 phy at the end, but still be able to have a selected bibliography for the
4476 child if you output it on its own.
4477 Here is how to achieve this.
4480 \begin_layout Standard
4481 For the main document, you just insert a bibliography inset at the place
4482 where the main bibliography has to appear (within the master file or within
4484 If the bibliography inset is in the master file, the references will be
4485 inherited by all children, so they are available in the citation dialog
4489 \begin_layout Standard
4490 For child-specific bibliographies, insert bibliography insets within the
4491 child documents, at the place where the bibliography should appear when
4492 the child is compiled separately.
4493 However, the trick is to insert them into a branch (
4495 Insert\SpecialChar menuseparator
4496 Branch\SpecialChar menuseparator
4497 Insert New Branch...
4500 \begin_inset space \thinspace{}
4505 \begin_inset Quotes eld
4509 \begin_inset Quotes erd
4513 Within the children, activate the branch (
4515 Document\SpecialChar menuseparator
4516 Settings...\SpecialChar menuseparator
4520 Within the master, deactivate the branch (
4522 Document\SpecialChar menuseparator
4523 Settings...\SpecialChar menuseparator
4527 Now the child's bibliography will be ignored by the master, but considered
4531 \begin_layout Standard
4532 If you need multiple bibliographies (e.
4533 \begin_inset space \thinspace{}
4536 g., one per child in the
4540 ), please refer to sec.
4541 \begin_inset space ~
4545 \begin_inset CommandInset ref
4547 reference "subsec:Multiple-Bibliographies"
4554 \begin_layout Section
4559 \begin_layout Standard
4560 Users sometimes need to be able to
4561 \begin_inset Quotes eld
4565 \begin_inset Quotes erd
4569 file together with all the images (and other files) on which it depends,
4570 either for sending to a publisher or for sharing with a co-author.
4572 includes a Python script (
4573 \begin_inset Flex Code
4576 \begin_layout Plain Layout
4582 ) that automates this process.
4583 To use it, you must have either the
4584 \begin_inset Flex Code
4587 \begin_layout Plain Layout
4594 \begin_inset Flex Code
4597 \begin_layout Plain Layout
4603 python modules installed on your system.
4604 By default, the script prefers the
4605 \begin_inset Flex Code
4608 \begin_layout Plain Layout
4615 \begin_inset Flex Code
4618 \begin_layout Plain Layout
4624 format on Unix-like systems and the
4625 \begin_inset Flex Code
4628 \begin_layout Plain Layout
4637 \begin_layout Standard
4639 's configuration process will set the script up to export a `\SpecialChar LyX
4641 and this format will then be available under
4642 \begin_inset Flex Code
4645 \begin_layout Plain Layout
4646 File\SpecialChar menuseparator
4655 \begin_layout Standard
4656 Independently of the platform, the generation of a particular archive format
4657 can be forced by adding either the
4658 \begin_inset Flex Code
4661 \begin_layout Plain Layout
4668 \begin_inset Flex Code
4671 \begin_layout Plain Layout
4678 \begin_inset Flex Code
4681 \begin_layout Plain Layout
4688 \begin_inset Flex Code
4691 \begin_layout Plain Layout
4697 format) switch to the
4698 \begin_inset Flex Code
4701 \begin_layout Plain Layout
4703 \SpecialChar menuseparator
4711 \begin_inset Flex Code
4714 \begin_layout Plain Layout
4715 Tools\SpecialChar menuseparator
4716 Preferences\SpecialChar menuseparator
4717 File Handling\SpecialChar menuseparator
4724 (Make sure you add the switch after the script name, not before it.)
4727 \begin_layout Section
4728 Fancy Headers and Footers
4731 \begin_layout Standard
4732 The default page layout is rather plain; for an
4733 \begin_inset Flex Code
4736 \begin_layout Plain Layout
4742 document class, all you get is a centered page number at the bottom of
4744 This document uses KOMA-script's book class, so it appears to be a bit
4746 But to really put on a show, you need to set the document page style to
4748 \begin_inset Quotes eld
4752 \begin_inset Quotes erd
4755 , as mentioned in the
4760 This section describes the \SpecialChar LaTeX
4761 code you need to insert in your \SpecialChar LaTeX
4763 order to get the desired effects.
4766 \begin_layout Standard
4767 For more information on fancy headers, see the
4768 \begin_inset Flex Code
4771 \begin_layout Plain Layout
4777 package documentation.
4779 \begin_inset Flex URL
4782 \begin_layout Plain Layout
4784 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4792 \begin_layout Standard
4793 The page header is divided into three fields, not surprisingly labeled
4794 \begin_inset Quotes eld
4798 \begin_inset Quotes erd
4802 \begin_inset Quotes eld
4806 \begin_inset Quotes erd
4810 \begin_inset Quotes eld
4814 \begin_inset Quotes erd
4818 The footer is also divided into these three fields.
4819 The \SpecialChar LaTeX
4820 commands to set these fields in the simplest manner are
4821 \begin_inset Flex Code
4824 \begin_layout Plain Layout
4833 \begin_inset Flex Code
4836 \begin_layout Plain Layout
4845 \begin_inset Flex Code
4848 \begin_layout Plain Layout
4857 \begin_inset Flex Code
4860 \begin_layout Plain Layout
4869 Suppose you wish to put your name in the upper left hand corner of each
4871 Simply insert the following command in the preamble:
4874 \begin_layout Standard
4883 \begin_layout Standard
4884 You will now see your name in the upper left.
4885 If a field has a default entry that you would like to get rid of (often
4886 the page number appears in the central footer) simply include a command
4887 with a blank argument, e.
4888 \begin_inset space \thinspace{}
4894 \begin_layout Standard
4902 \begin_layout Standard
4903 Let's get really fancy: lets put the section number with the word
4904 \begin_inset Quotes eld
4908 \begin_inset Quotes erd
4912 \begin_inset space \thinspace{}
4916 \begin_inset space \space{}
4919 Section 3) in the upper left, the page number (e.
4920 \begin_inset space \thinspace{}
4924 \begin_inset space \space{}
4927 Page 4) in the upper right, your name in the lower left, and the date in
4929 The following commands should now appear in the preamble:
4932 \begin_layout Standard
4942 \begin_layout Standard
4950 \begin_layout Standard
4960 \begin_layout Standard
4969 \begin_layout Standard
4977 \begin_layout Standard
4987 \begin_layout Standard
4989 \begin_inset Flex Code
4992 \begin_layout Plain Layout
5001 \begin_inset Flex Code
5004 \begin_layout Plain Layout
5012 access \SpecialChar LaTeX
5013 's section and page counters, and so print out the current section
5016 \begin_inset Flex Code
5019 \begin_layout Plain Layout
5027 simply prints out today's date.
5030 \begin_layout Standard
5031 The thicknesses of the horizontal rules drawn beneath the header and above
5032 the footer can also be modified.
5033 If you don't want one of the rules, set its thickness to 0.
5034 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
5040 \begin_inset Flex Code
5043 \begin_layout Plain Layout
5048 headrulewidth}{0.4pt}
5054 \begin_inset Flex Code
5057 \begin_layout Plain Layout
5062 footrulewidth}{0.4pt}
5067 to set the thicknesses.
5070 \begin_layout Standard
5071 You can switch the header/footer settings on and off for individual pages
5073 \begin_inset Flex Code
5076 \begin_layout Plain Layout
5079 thispagestyle{empty}
5085 \begin_inset Flex Code
5088 \begin_layout Plain Layout
5091 thispagestyle{plain}
5097 \begin_inset Flex Code
5100 \begin_layout Plain Layout
5103 thispagestyle{fancy}
5109 Simply insert them in the text on the page you want changed and mark them
5112 In fact, title pages are marked as plain by default, while following pages
5113 are marked fancy when using the global fancy setting.
5116 \begin_layout Standard
5117 As a final example, it is possible to include an image in the header or
5119 Suppose you want to put a company logo in the upper lefthand corner.
5120 You might try something like
5123 \begin_layout Standard
5132 includegraphics{logo.eps}}}
5135 \begin_layout Standard
5137 (you may need to preface this with
5138 \begin_inset Flex Code
5141 \begin_layout Plain Layout
5144 usepackage{graphics}
5149 if you don't include graphics elsewhere in your document).
5152 \begin_layout Section
5153 Itemize Bullet Selection
5154 \begin_inset CommandInset label
5163 \begin_layout Standard
5169 \begin_layout Subsection
5173 \begin_layout Standard
5175 provides 216 bullet shapes that can be accessed from a simple dialog.
5176 Using this dialog you can easily specify what bullet shape to use at each
5177 level of an itemized list.
5178 These settings are document-wide so you won't be able to specify different
5179 sets of bullets for different paragraphs.
5183 \begin_layout Plain Layout
5184 Well, actually you can but you'll have to do it by hand.
5192 \begin_layout Subsection
5196 \begin_layout Standard
5197 Open the dialog by selecting the
5198 \begin_inset Flex Noun
5201 \begin_layout Plain Layout
5202 Document\SpecialChar menuseparator
5208 menu item and then select the
5209 \begin_inset Flex Noun
5212 \begin_layout Plain Layout
5221 \begin_layout Standard
5222 The dialog provides you with a table of bullet shapes.
5223 A column of buttons on the left of the table provides access to the six
5224 different panels of bullet shapes.
5225 The row of buttons across the top is used to select which bullet depth
5228 \change_deleted 244031559 1603875981
5229 A text entry under the table shows the currently selected bullet shape's
5231 equivalent and this can be edited if desired.
5232 If you do modify the text you will also need to specify any needed packages
5233 in the \SpecialChar LaTeX
5239 \begin_layout Standard
5240 The six panels are divided up by the packages they require.
5241 The following table shows the mappings from button name to \SpecialChar LaTeX
5245 \begin_layout Standard
5247 \begin_inset Tabular
5248 <lyxtabular version="3" rows="7" columns="2">
5249 <features tabularvalignment="middle">
5250 <column alignment="center" valignment="top" width="0pt">
5251 <column alignment="center" valignment="top" width="0pt">
5253 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
5256 \begin_layout Plain Layout
5271 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
5274 \begin_layout Plain Layout
5291 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
5294 \begin_layout Plain Layout
5309 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
5312 \begin_layout Plain Layout
5321 base \SpecialChar LaTeX
5329 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
5332 \begin_layout Plain Layout
5347 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
5350 \begin_layout Plain Layout
5367 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
5370 \begin_layout Plain Layout
5385 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
5388 \begin_layout Plain Layout
5405 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
5408 \begin_layout Plain Layout
5423 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
5426 \begin_layout Plain Layout
5443 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
5446 \begin_layout Plain Layout
5461 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
5464 \begin_layout Plain Layout
5481 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
5484 \begin_layout Plain Layout
5499 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
5502 \begin_layout Plain Layout
5525 \begin_layout Standard
5527 doesn't stop you using bullets from packages you don't have.
5528 If you get errors from \SpecialChar LaTeX
5529 when you try to view or print the file, then it
5530 is likely you are missing a package.
5534 \begin_layout Plain Layout
5536 doesn't restrict your use since you may be editing locally and exporting
5545 \begin_layout Subsection
5549 \begin_layout Standard
5550 Select which bullet depth you want to change then select the bullet shape
5552 Any changes will not be visible in \SpecialChar LyX
5553 , but are visible when viewing the document.
5556 \begin_layout Standard
5557 You can reset a bullet shape to the default simply by clicking your right
5558 mouse button on the appropriate bullet depth button.
5562 \begin_layout Plain Layout
5567 want to have multiple sets of paragraphs with different sets of bullets
5568 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
5570 The bullet selection dialog can help though because it provides you with
5571 the \SpecialChar LaTeX
5572 code for a wide range of bullet shapes.
5573 To make your own custom paragraphs you have the following options:
5576 \begin_layout Plain Layout
5580 \begin_layout Plain Layout
5596 \begin_layout Plain Layout
5600 \begin_layout Plain Layout
5622 \begin_layout Itemize
5623 Use the \SpecialChar LaTeX
5625 \begin_inset Flex Code
5628 \begin_layout Plain Layout
5636 to specify a new bullet shape for a given depth.
5637 You'll also need to save the current bullet shape so you can restore it
5639 In this itemized list the following \SpecialChar LaTeX
5640 code was used to change the bullet
5641 used for the first depth.
5645 \begin_layout LyX-Code
5655 \begin_layout LyX-Code
5672 \begin_layout Itemize
5673 Note that the itemize depth is specified in Roman numerals as part of the
5683 \begin_layout Itemize
5684 \begin_inset Argument item:1
5687 \begin_layout Plain Layout
5691 \begin_layout Plain Layout
5709 Specify each individual entry by starting each item with the bullet shape
5711 \begin_inset Quotes eld
5715 \begin_inset Quotes erd
5720 Insert\SpecialChar menuseparator
5724 \begin_inset Flex Noun
5727 \begin_layout Plain Layout
5735 For example, this item was started with
5736 \begin_inset Flex Code
5739 \begin_layout Plain Layout
5754 \begin_layout Plain Layout
5758 \begin_layout Plain Layout
5774 \begin_layout Plain Layout
5775 You'll also need to revert the labelitem back to its previous setting for
5776 the global bullet shape settings to remain in effect.
5777 The way used here was:
5780 \begin_layout LyX-Code
5795 \begin_layout Chapter
5797 and the World Wide Web
5800 \begin_layout Standard
5802 has long supported the export of documents to various web-friendly formats,
5804 Before version 2.0, however, HTML export was always accomplished by the
5805 use of external converters.
5809 \begin_layout Plain Layout
5810 For details on the use of external converters with \SpecialChar LyX
5815 section of the Customization manual.
5820 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5822 intermediate format, such as
5823 \begin_inset Flex Code
5826 \begin_layout Plain Layout
5833 \begin_inset Flex Code
5836 \begin_layout Plain Layout
5843 \begin_inset Flex Code
5846 \begin_layout Plain Layout
5852 , relying upon \SpecialChar LyX
5853 to produce the \SpecialChar LaTeX
5854 ; and there is a converter that works directly
5857 \begin_inset Flex Code
5860 \begin_layout Plain Layout
5868 All of these have different advantages and disadvantages.
5872 \begin_layout Standard
5873 The \SpecialChar LaTeX
5874 -based converters have the advantage that, in principle, they know everythin
5875 g about the exported document that \SpecialChar LaTeX
5877 Such converters do not care, for example, if a certain block of code was
5878 produced by \SpecialChar LyX
5879 or was Evil Red Text.
5880 These converters know about
5881 \begin_inset Flex Code
5884 \begin_layout Plain Layout
5890 files, counters, and references, and can often make use of the
5891 \begin_inset Flex Code
5894 \begin_layout Plain Layout
5900 files generated by Bib\SpecialChar TeX
5902 On the other hand, \SpecialChar LaTeX
5903 is a very hard language to parse—it is sometimes said
5904 that only \SpecialChar TeX
5905 itself understands \SpecialChar TeX
5906 —and \SpecialChar LaTeX
5907 -based converters will often choke on
5908 what seem to be quite simple constructs; complex ones can throw them completely
5909 , and as of this writing, for example, the
5913 manual will not export with
5914 \begin_inset Flex Code
5917 \begin_layout Plain Layout
5923 , though the others will.
5924 The other issue concerns how math is handled.
5925 These converters typically convert the formulae into little pictures that
5926 are then linked from the HTML document.
5927 Since these are actually generated by \SpecialChar LaTeX
5928 , they are accurate.
5929 But they do not scale well, and just getting them to look as if they are
5930 actually meant to be in your document—so that the font sizes seem to be
5931 roughly the same—can be a challenge.
5934 \begin_layout Standard
5936 \begin_inset Flex Code
5939 \begin_layout Plain Layout
5947 \begin_inset CommandInset href
5949 name "http://pinchito.es/elyxer/"
5950 target "http://pinchito.es/elyxer/"
5955 ) solves some of these problems.
5956 In particular, the formulae it produces scale perfectly, since it renders
5957 math using a combination of HTML and CSS rather than converting the formulae
5959 But even moderately complex formula are rendered less well than with
5960 \begin_inset Flex Code
5963 \begin_layout Plain Layout
5969 ; this reflects the limitations of HTML.
5973 \begin_layout Plain Layout
5975 \begin_inset Flex Code
5978 \begin_layout Plain Layout
5985 can also use jsMath and MathJax for equations, but this setting is only
5986 available globally and requires one to have access to a server that runs
5992 More importantly (as of version 1.1.1, at least),
5993 \begin_inset Flex Code
5996 \begin_layout Plain Layout
6003 has limited support for math macros and no support for user-defined paragraph
6004 or character styles.
6005 These limitations make
6006 \begin_inset Flex Code
6009 \begin_layout Plain Layout
6016 unsuitable for many of the documents \SpecialChar LyX
6018 In principle, of course, these problems could be solved, but the \SpecialChar LyX
6020 have decided to follow a different path and have made \SpecialChar LyX
6022 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
6023 , DocBook, and plaintext.
6026 \begin_layout Standard
6027 As of this writing, XHTML output remains under development and should probably
6029 \begin_inset Quotes eld
6033 \begin_inset Quotes erd
6040 \begin_layout Plain Layout
6042 \begin_inset Flex Code
6045 \begin_layout Plain Layout
6046 development/HTML/HTML.notes
6051 , which can be found in the \SpecialChar LyX
6053 \begin_inset CommandInset href
6055 name "accessed online"
6056 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
6061 , usually contains up-to-date information about the state of XHTML output.
6062 See also the list of XHTML bugs on
6063 \begin_inset CommandInset href
6065 name "the bug tracker"
6066 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"
6076 Still, the developers have chosen this approach because it has several
6077 potential advantages over the other two.
6080 \begin_layout Standard
6081 These advantages are primarily due to the fact that the XHTML output routines,
6082 since they are part of \SpecialChar LyX
6083 , know everything \SpecialChar LyX
6084 knows about the document being
6089 \begin_layout Plain Layout
6090 Another advantage is that, since these routines are internal to \SpecialChar LyX
6092 immune to changes in \SpecialChar LyX
6093 's file format, or to changes in the semantics of
6099 So they know about the table of contents (as displayed in the outline),
6100 about the counters associated with different paragraph styles, and about
6101 user-defined styles.
6102 The XHTML output routines know what \SpecialChar LyX
6103 knows about internationalization,
6104 too, so they will output
6105 \begin_inset Quotes eld
6109 \begin_inset Quotes erd
6113 \begin_inset Quotes eld
6121 \begin_inset Quotes erd
6124 , depending upon the language in effect at the time.
6128 \begin_layout Standard
6129 Quite generally, the output routines know what \SpecialChar LyX
6130 knows about document layout,
6131 that is, about how the document is to be rendered on screen.
6132 We use this information when we output the document as XHTML.
6133 In particular, \SpecialChar LyX
6138 generates CSS style information corresponding to the layout information
6139 it uses to render the document on screen: if section headings are supposed
6140 to be sans-serif and bold as seen in \SpecialChar LyX
6141 , then (by default) they will be sans-seri
6142 f and bold when viewed in a web browser, too.
6143 And this is true not just for pre-defined styles, like Section, but for
6144 any style, including user-defined styles.
6145 Indeed, the XHTML output routines make no distinction between user-defined
6147 \change_deleted 244031559 1603876931
6149 \change_inserted 244031559 1603876940
6152 styles and \SpecialChar LyX
6153 's own pre-defined styles: in each case, everything \SpecialChar LyX
6155 the styles is contained in the layout files.
6156 And much the same is true as regards pre-defined textual insets, such as
6157 footnotes, and various custom insets.
6161 \begin_layout Standard
6162 The result is that XHTML output can be customized and extended in exactly
6163 the same way \SpecialChar LaTeX
6164 output can be customized and extended: through layout files
6166 See chapter five of the
6170 manual for the details.
6173 \begin_layout Standard
6174 The remainder of this chapter contains more detailed information on XHTML
6175 output, its limitations, and ways to work around those limitations.
6178 \begin_layout Section
6179 Math Output in XHTML
6182 \begin_layout Standard
6184 offers four choices for how math is rendered.
6185 These have various advantages and disadvantages:
6188 \begin_layout Itemize
6190 \begin_inset Newline newline
6193 MathML is a dialect of XML designed specifically for mathematics on the
6194 web, and it typically renders very well in browsers that support it.
6195 The disadvantage is that not all browsers support MathML, and support is
6196 not complete even in the Gecko-based browsers, such as Firefox.
6197 \begin_inset Newline newline
6201 is unable to render a formula as MathML—for example, if the formula
6203 \begin_inset Flex Code
6206 \begin_layout Plain Layout
6212 package or ERT—then it will instead output the formula as an image.
6216 \begin_layout Itemize
6218 \begin_inset Newline newline
6222 \begin_inset Flex Code
6225 \begin_layout Plain Layout
6231 outputs math as HTML, styled by CSS.
6235 \begin_layout Plain Layout
6237 has borrowed some of the CSS for its HTML output from
6238 \begin_inset Flex Code
6241 \begin_layout Plain Layout
6252 For simple formulae, this can work quite well, though with more complicated
6253 formulae it tends to break down.
6254 Still, this method has the advantage that it is very widely supported and
6255 so it may be appropriate for documents that contain only a little, fairly
6257 \begin_inset Newline newline
6260 If Lyx is unable to render a formula as HTML—for example, if the formula
6262 \begin_inset Flex Code
6265 \begin_layout Plain Layout
6271 package or ERT—then it will instead output the formula as an image.
6275 \begin_layout Itemize
6277 \begin_inset Newline newline
6281 \begin_inset Flex Code
6284 \begin_layout Plain Layout
6291 will output formulae as images, the very same images, in fact, that are
6292 used for instant preview.
6296 \begin_layout Plain Layout
6297 Instant preview does
6301 have to be on for images to be output, however.
6306 The advantage to this method is that the images are simply generated by
6308 , so they are very accurate.
6309 The disadvantage, as mentioned earlier, is that these are bitmapped images,
6310 so they do not scale terribly well, and one cannot copy them, etc.
6311 \begin_inset Newline newline
6314 The size of the images can be controlled by setting the
6315 \begin_inset Quotes eld
6319 \begin_inset Quotes erd
6323 \begin_inset Flex Noun
6326 \begin_layout Plain Layout
6327 Document\SpecialChar menuseparator
6328 Settings\SpecialChar menuseparator
6338 \begin_layout Plain Layout
6339 For those who want to know, this controls the resolution of the image in
6340 dots per inch and is based upon a default of 75 dpi.
6346 \begin_inset Newline newline
6350 for some reason fails to create an image for a formula (e.g., if a required
6352 package is not installed), then it will fall back to outputing the raw
6357 \begin_layout Itemize
6360 \begin_inset Newline newline
6363 Finally, \SpecialChar LyX
6364 will happily output math as \SpecialChar LaTeX
6366 As well as being the output of last resort, this method can be used with
6368 \begin_inset CommandInset href
6371 target "http://www.math.union.edu/~dpvc/jsMath/"
6376 , which uses JavaScript to render \SpecialChar LaTeX
6377 embedded in HTML documents.
6379 wraps the \SpecialChar LaTeX
6381 \begin_inset Flex Code
6384 \begin_layout Plain Layout
6390 (for inline formulas) or
6391 \begin_inset Flex Code
6394 \begin_layout Plain Layout
6400 (for displayed formulas) with
6401 \begin_inset Flex Code
6404 \begin_layout Plain Layout
6410 , as is required for jsMath.
6413 \begin_layout Standard
6414 One of these output methods must be selected under
6415 \begin_inset Flex Noun
6418 \begin_layout Plain Layout
6419 Document\SpecialChar menuseparator
6420 Settings\SpecialChar menuseparator
6427 By default, \SpecialChar LyX
6429 This is a document-wide setting, therefore.
6432 \begin_layout Standard
6433 Eventually, \SpecialChar LyX
6434 will offer the user the option to select an alternate output
6435 method for a particular inset, say, one that isn't being rendered very
6440 \begin_layout Plain Layout
6441 That said, since \SpecialChar LyX
6442 falls back to images if the inset contains ERT, then one
6443 can force output as an image by putting some harmless ERT into the math,
6445 \begin_inset Formula $a=b\relax$
6456 \begin_layout Section
6457 Bibliography and Citations
6460 \begin_layout Standard
6461 XHTML output fully supports bibliographies and citations.
6465 \begin_layout Standard
6466 Citation labels are generated by the same machinery that generates \SpecialChar LyX
6468 labels, so the labels will look in the output much as they do in \SpecialChar LyX
6471 If you are using numerical citations, then \SpecialChar LyX
6472 will output numerical labels,
6473 such as [1] or [17], rather than simply showing the citation key in square
6474 brackets, as it does on-screen.
6475 If you are using author-year citations, then \SpecialChar LyX
6476 will add lowercase letters
6477 to the years, just as Bib\SpecialChar TeX
6478 does, if it finds more than one citation for
6479 a given author-year combination.
6480 The labels will be printed with the bibliography entries.
6481 Note that there is, at present, no way to customize the appearance of the
6482 labels, for example, to choose between square brackets and parentheses.
6485 \begin_layout Standard
6486 Bibliography output is handled by the same machinery that handles the presentati
6487 on of reference information in the citation dialog, so you will see in the
6488 XHTML output pretty much what you would see if you were to look at a given
6489 entry in the citation dialog.
6490 The formatting can be customized in your layout file or, preferably, in
6496 manual for the details.
6499 \begin_layout Standard
6500 The main defect at present is that cross-referenced information is printed
6501 with every entry with which it is associated.
6502 So you can see things like this:
6507 \begin_inset Quotes eld
6510 Context and Logical Form
6511 \begin_inset Quotes erd
6516 Language in Context: Selected Essays
6518 (Oxford: Oxford University Press, 2007), pp.
6524 \begin_inset Quotes eld
6527 Semantics in Context
6528 \begin_inset Quotes erd
6533 Language in Context: Selected Essays
6535 (Oxford: Oxford University Press, 2007), pp.
6539 \begin_layout Standard
6540 This should be fixed before long.
6543 \begin_layout Standard
6544 There is no support at present for sectioned bibliographies.
6545 If you have multiple bibliographies, then \SpecialChar LyX
6546 will print the same bibliography
6550 \begin_layout Section
6554 \begin_layout Standard
6556 will happily export indexes as XHTML, but with certain limitations at the
6560 \begin_layout Standard
6561 Index export will be most reliable when you do not attempt to use the fancy
6562 constructs that are described in the section on indexes in the
6570 \begin_layout Plain Layout
6571 The main issue here is that \SpecialChar LyX
6572 itself does not really handle these.
6573 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
6579 We'll describe how they are handled using the subsection headings from
6583 \begin_layout Itemize
6584 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
6585 makes an effort to support these,
6586 but the entries must be separated by
6587 \begin_inset Quotes eld
6591 \begin_inset Quotes erd
6594 , that is, there must be spaces around the exclamation point.
6595 This is because it is otherwise too difficult to check for escaped exclamation
6596 points, ones in math, and so forth.
6599 \begin_layout Itemize
6600 Page Ranges: There is no support at all for page ranges, since these make
6601 no sense with XHMTL.
6602 Instead, you will just get two index entries, one at either end.
6605 \begin_layout Itemize
6606 Cross-referencing: There is no support for cross-referencing.
6608 finds an entry containing the
6609 \begin_inset Quotes eld
6612 |see\SpecialChar ldots
6614 \begin_inset Quotes erd
6617 construct, it is just dropped, and the rest is treated as an ordinary index
6621 \begin_layout Itemize
6622 Index Entry Order: \SpecialChar LyX
6623 does support attempts to fix the sorting order.
6624 It will take what is before the first `@' it finds and use that for sorting,
6625 taking what follows the first `@' to be the actual entry.
6626 At present, \SpecialChar LyX
6627 does not check for escaped `@', so do not try to index email
6631 \begin_layout Itemize
6632 Index Entry Layout: You can format entries by using the text style dialog,
6633 or by using any other method available within \SpecialChar LyX
6635 There is no support for constructs like:
6636 \begin_inset Quotes eld
6640 \begin_inset Quotes erd
6644 Indeed, if \SpecialChar LyX
6645 finds a pipe symbol, `|', in an entry, it will delete it and
6646 everything that follows it.
6649 \begin_layout Itemize
6650 Multiple Indexes: There is no support for multiple indexes.
6651 Rather, all index entries will be printed as one large index.
6652 To avoid our printing several versions of the index, we print only the
6653 main index, so make sure you have one.
6656 \begin_layout Section
6657 Nomenclature and Glossary
6660 \begin_layout Standard
6661 There is at present no support for glossaries.
6662 Adding it would be fairly trivial, and welcome.
6665 \begin_layout Chapter
6667 \change_inserted 1075283030 1616534180
6671 \begin_layout Standard
6673 \change_inserted 1075283030 1616534386
6674 Apart from HTML, \SpecialChar LyX
6675 can generate documents in the DocBook XML vocabulary.
6676 With versions 2.3 and before, only select templates could be used to generate
6677 DocBook documents (only version 4).
6678 Starting with \SpecialChar LyX
6679 2.4, most \SpecialChar LyX
6680 layouts can generate valid DocBook documents (only
6682 This feature is built into \SpecialChar LyX
6683 and does not require the use of external tools.
6686 \begin_layout Standard
6688 \change_inserted 1075283030 1616534437
6689 The result is that the DocBook output can be customized and extended in
6690 exactly the same way \SpecialChar LaTeX
6691 output can be customized and extended: through layout
6693 See chapter five of the
6697 manual for the details.
6700 \begin_layout Standard
6702 \change_inserted 1075283030 1616534475
6703 Most \SpecialChar LyX
6704 features are supported with DocBook, like math output.
6707 \begin_layout Itemize
6709 \change_inserted 1075283030 1616534741
6710 Math output is performed mostly in MathML (the major exception being constructio
6711 ns not supported by \SpecialChar LyX
6714 All formulae are also available in raw \SpecialChar TeX
6715 in the DocBook output for further
6719 \begin_layout Itemize
6721 \change_inserted 1075283030 1616534852
6722 Bibliographies and citations are implemented, including with an external
6724 Bibliography entries are not prerendered when the detailed information
6725 are available, but rather output with the standard DocBook constructs.
6726 The external DocBook processor is expected to handle the rendering of entries.
6729 \begin_layout Itemize
6731 \change_inserted 1075283030 1616534863
6732 Indexes are supported, including multiple indices.
6737 ), page ranges, and cross-references (
6741 ) are supported, with the exception of the same symbols escaped.
6750 ) are not supported.
6751 There is no support for escaping of index entries.
6754 \begin_layout Itemize
6756 \change_inserted 1075283030 1616534884
6757 Glossaries are implemented.
6760 \begin_layout Standard
6762 \change_inserted 1075283030 1616534894
6763 Two major parameters can be set at the document level.
6766 \begin_layout Itemize
6768 \change_inserted 1075283030 1616534948
6769 Format for tables: \SpecialChar LyX
6770 can generate tables either as HTML (default value) or
6771 CALS, depending on the user's requirements.
6772 Most DocBook processors accept both formats.
6775 \begin_layout Itemize
6777 \change_inserted 1075283030 1616535006
6778 MathML prefix: in DocBook, MathML is included within its own name space,
6780 The implication is that there must be an indication of the tags belonging
6781 to the MathML standard.
6782 Three choices are offered:
6786 \begin_layout Itemize
6788 \change_inserted 1075283030 1616535044
6789 Inline: the MathML name space is defined for each formula (using the
6793 attribute on each formula)
6796 \begin_layout Itemize
6798 \change_inserted 1075283030 1616535090
6803 prefix (default): the MathML name space is defined at the document level
6808 attribute on the root element).
6809 Each MathML is prefixed with
6818 \begin_layout Itemize
6820 \change_inserted 1075283030 1616620405
6825 prefix: similar to the
6834 \begin_layout Standard
6836 \change_inserted 1075283030 1616620470
6837 This option is especially useful if you want \SpecialChar LyX
6838 to match your personal style
6839 or to work with buggy software that only accepts one prefix for MathML.
6845 \begin_layout Chapter
6846 The \SpecialChar LyX
6850 \begin_layout Section
6854 \begin_layout Standard
6855 The `\SpecialChar LyX
6856 server' allows other programs to talk to \SpecialChar LyX
6857 , invoke \SpecialChar LyX
6858 commands, and retrieve
6859 information about the \SpecialChar LyX
6861 This is only intended for advanced users, but they should find it useful.
6862 It is by writing to the \SpecialChar LyX
6863 server, for example, that bibliography managers,
6864 such as JabRef, are able to
6865 \begin_inset Quotes eld
6869 \begin_inset Quotes erd
6872 citations to \SpecialChar LyX
6876 \begin_layout Section
6877 Starting the \SpecialChar LyX
6879 \begin_inset CommandInset label
6881 name "sec:Starting-the-Server"
6888 \begin_layout Standard
6889 The \SpecialChar LyX
6890 server works through the use of a pair of named pipes.
6891 These are usually located in
6892 \begin_inset Flex Code
6895 \begin_layout Plain Layout
6901 , (except on Windows, where
6905 named pipes are special objects located in
6906 \begin_inset Flex Code
6909 \begin_layout Plain Layout
6921 ) and have the names
6922 \begin_inset Quotes eld
6926 \begin_inset Flex Code
6929 \begin_layout Plain Layout
6936 \begin_inset Quotes erd
6940 \begin_inset Quotes eld
6944 \begin_inset Flex Code
6947 \begin_layout Plain Layout
6954 \begin_inset Quotes erd
6958 External programs write into
6959 \begin_inset Flex Code
6962 \begin_layout Plain Layout
6968 and read back data from
6969 \begin_inset Flex Code
6972 \begin_layout Plain Layout
6979 The stem of the pipe names can be defined in the
6980 \begin_inset Flex Noun
6983 \begin_layout Plain Layout
6984 Tools\SpecialChar menuseparator
6991 \begin_inset Flex Code
6994 \begin_layout Plain Layout
6995 "/home/myhome/lyxpipe"
7001 \begin_inset Flex Code
7004 \begin_layout Plain Layout
7018 on Windows (where any working path instead of lyxpipe can be used, for
7020 \begin_inset Flex Code
7023 \begin_layout Plain Layout
7046 configure this manually in order for the server to start.
7049 \begin_layout Standard
7052 \begin_inset Flex Code
7055 \begin_layout Plain Layout
7062 \begin_inset Flex Code
7065 \begin_layout Plain Layout
7071 ' to create the pipes.
7072 If one of the pipes already exists, \SpecialChar LyX
7073 will assume that another \SpecialChar LyX
7075 is already running and will not start the server.
7076 On POSIX (Unix like) systems, if for some other reason, an unused
7077 \begin_inset Quotes eld
7081 \begin_inset Quotes erd
7084 pipe is left in existence when \SpecialChar LyX
7085 closes, then \SpecialChar LyX
7086 will try to delete it.
7087 If this fails for some reason, you will need to delete the pipes manually
7088 and then restart \SpecialChar LyX
7090 On Windows, pipes are deleted by the OS on program termination or crash,
7092 \begin_inset Quotes eld
7096 \begin_inset Quotes erd
7099 pipes should not be possible.
7102 \begin_layout Standard
7103 To have several \SpecialChar LyX
7104 processes with servers at the same time, you have to use
7105 different configurations, perhaps by using separate user directories, each
7107 \begin_inset Flex Code
7110 \begin_layout Plain Layout
7116 file, for each process.
7119 \begin_layout Standard
7120 If you are developing a client program, you might find it useful to enable
7121 debugging information from the \SpecialChar LyX
7123 Do this by starting \SpecialChar LyX
7125 \begin_inset Flex Code
7128 \begin_layout Plain Layout
7137 \begin_layout Standard
7138 You can find a complete example client written in C++ in the source distribution
7140 \begin_inset Flex Code
7143 \begin_layout Plain Layout
7144 development/lyxserver/server_monitor.cpp
7152 \begin_layout Standard
7153 Another useful tool is the command-line based client found in
7154 \begin_inset Flex Code
7157 \begin_layout Plain Layout
7158 src/client/lyxclient
7166 \begin_layout Section
7167 Normal communication
7170 \begin_layout Standard
7171 To issue a \SpecialChar LyX
7172 call, the client writes a line of ASCII text into the input
7174 This line has the following format:
7191 \begin_layout Description
7192 clientname is a name that the client can choose arbitrarily.
7193 Its only use is that \SpecialChar LyX
7194 will echo it if it sends an answer—so a client can
7195 dispatch results from different requesters.
7198 \begin_layout Description
7199 function is the function you want \SpecialChar LyX
7201 It is the same as the commands you'd use in the minibuffer.
7204 \begin_layout Description
7205 argument is an optional argument which is meaningful only to some functions
7207 \begin_inset Quotes eld
7211 \begin_inset Quotes erd
7214 LFUN will insert the argument as text at the cursor position).
7217 \begin_layout Standard
7218 The answer from \SpecialChar LyX
7219 will arrive in the output pipe and be of the form
7236 \begin_layout Standard
7245 are just echoed from the command request, while
7249 is more or less useful information filled according to how the command
7250 execution worked out.
7251 Some commands, such as
7252 \begin_inset Quotes eld
7256 \begin_inset Quotes erd
7259 , will return information about the internal state of \SpecialChar LyX
7261 return an empty data-response.
7262 This means that the command execution went fine.
7265 \begin_layout Standard
7266 In case of errors, the response from \SpecialChar LyX
7284 \begin_layout Standard
7289 should contain an explanation of why the command failed.
7292 \begin_layout Standard
7296 \begin_layout LyX-Code
7297 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
7298 \begin_inset Newline newline
7301 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
7302 \begin_inset Newline newline
7305 read a <~/.lyxpipe.out
7306 \begin_inset Newline newline
7312 \begin_layout Subsection
7313 AppleScript (Mac OS X)
7316 \begin_layout Standard
7317 Since \SpecialChar LyX
7318 2.1, \SpecialChar LyX
7319 supports basic interactions with AppleScript for normal communicatio
7320 n through the command run.
7321 This command takes a direct argument (the
7325 to perform) and an optional argument.
7326 It either returns the output of the function or triggers an error with
7327 the error message and code.
7330 \begin_layout Standard
7334 \begin_layout LyX-Code
7335 tell application "\SpecialChar LyX
7339 \begin_layout LyX-Code
7343 \begin_layout LyX-Code
7344 -- Stores the current file name into f
7347 \begin_layout LyX-Code
7348 set f to (run "server-get-filename" with argument "")
7351 \begin_layout LyX-Code
7352 on error the error_message number the error_number
7355 \begin_layout LyX-Code
7356 display dialog "Error: " & the error_number & ".
7360 \begin_layout LyX-Code
7361 & the error_message buttons {"OK"} default button 1
7364 \begin_layout LyX-Code
7368 \begin_layout LyX-Code
7372 \begin_layout Section
7376 \begin_layout Standard
7378 can notify clients of events going on asynchronously.
7379 Currently it will only do this if the user binds a key sequence with the
7381 \begin_inset Quotes eld
7385 \begin_inset Quotes erd
7389 The format of the string \SpecialChar LyX
7390 sends is as follows:
7394 \begin_inset Flex Code
7397 \begin_layout Plain Layout
7408 \begin_layout Standard
7413 is the printed representation of the key sequence that was actually typed
7417 \begin_layout Standard
7418 This mechanism can be used to extend \SpecialChar LyX
7419 's command set and implement macros.
7420 Bind some key sequence to
7421 \begin_inset Quotes eld
7425 \begin_inset Quotes erd
7429 Then start a client that listens on the output pipe, dispatches the command
7430 according to the sequence, and starts a function that may use \SpecialChar LyX
7433 requests to issue a command or a series of commands to \SpecialChar LyX
7437 \begin_layout Section
7438 The simple \SpecialChar LyX
7442 \begin_layout Standard
7444 implements a simple protocol that can be used for session management.
7445 All messages are of the form
7458 \begin_layout Standard
7464 \begin_inset Quotes eld
7468 \begin_inset Quotes erd
7472 \begin_inset Quotes eld
7476 \begin_inset Quotes erd
7481 \begin_inset Quotes eld
7485 \begin_inset Quotes erd
7488 is received from a client, \SpecialChar LyX
7489 will report back to inform the client that
7490 it's listening to it's messages, while
7491 \begin_inset Quotes eld
7495 \begin_inset Quotes erd
7498 sent from \SpecialChar LyX
7499 will inform clients that \SpecialChar LyX
7503 \begin_layout Section
7504 Reverse DVI/PDF search
7507 \begin_layout Standard
7508 Some DVI/PDF viewers
7512 \begin_layout Plain Layout
7513 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
7514 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
7523 facility (also called
7528 This means that you can tell \SpecialChar LyX
7529 to put the cursor to a specific line in the
7530 document by clicking at the respective position in the DVI/PDF output.
7531 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
7533 This is done via the \SpecialChar LyX
7534 server either by using the named pipe (
7538 ), or the UNIX domain socket (
7542 ) that \SpecialChar LyX
7543 creates in its temporary directory (this is the way the
7544 \begin_inset Flex Code
7547 \begin_layout Plain Layout
7553 program communicates with \SpecialChar LyX
7555 In some cases, you need a helper script that mediates between the viewer
7556 and \SpecialChar LyX
7557 , in others, the viewer can communicate with \SpecialChar LyX
7559 This depends on the selected viewer and on your operating system.
7560 The same applies to the way viewers need to be configured and the way the
7561 reverse search is actually performed.
7562 In what follows, we will thus describe how to setup reverse search for
7564 Before we turn to this, though, we will explain what needs to be done generally
7565 to enable reverse search in the DVI/PDF output.
7568 \begin_layout Subsection
7570 \begin_inset CommandInset label
7572 name "subsec:rev-search"
7579 \begin_layout Standard
7580 In most cases \SpecialChar LyX
7581 will do the work for you by pressing the following button
7585 arg "buffer-toggle-output-sync"
7589 Alternatively, you can also enable the feature by checking
7591 Synchronize with Output
7594 \begin_inset Flex Noun
7597 \begin_layout Plain Layout
7598 Document\SpecialChar menuseparator
7599 Settings\SpecialChar menuseparator
7606 In such a case \SpecialChar LyX
7607 will automatically insert the necessary Sync\SpecialChar TeX
7609 PDF) or load the srcltx package (for DVI) respectively.
7610 This option can be easily reached also on
7611 \begin_inset Flex Code
7614 \begin_layout Plain Layout
7623 \begin_layout Standard
7624 If you need a different setting, you can select or input a custom macro
7625 from the drop down box just below
7626 \begin_inset Flex Noun
7629 \begin_layout Plain Layout
7630 Document\SpecialChar menuseparator
7631 Settings\SpecialChar menuseparator
7632 Output\SpecialChar menuseparator
7633 Synchronize with Output
7641 \begin_layout Standard
7642 Note that the method
7643 \begin_inset Flex Code
7646 \begin_layout Plain Layout
7654 enables gzip compression.
7655 If your viewer does not support it, you should instead use
7656 \begin_inset Flex Code
7659 \begin_layout Plain Layout
7670 \begin_layout Standard
7671 Please also note that including the
7672 \begin_inset Flex Code
7675 \begin_layout Plain Layout
7682 \begin_inset Flex Code
7685 \begin_layout Plain Layout
7691 sometimes has an undesired impact on the typesetting.
7692 Thus, you should switch output synchronization off for the final typesetting
7694 \begin_inset Flex Code
7697 \begin_layout Plain Layout
7704 \begin_inset Flex Code
7707 \begin_layout Plain Layout
7717 \begin_layout Standard
7718 In case you need some more special settings that are not covered by the
7719 automatic settings, read the next section about how to set up output synchroniz
7721 If the automatic setup suits your needs, you can readily jump to section
7722 \begin_inset space ~
7726 \begin_inset CommandInset ref
7728 reference "subsec:configuring-viewers"
7732 , where the necessary configuration steps in your viewer – needed both with
7733 the automatic and the manual setup – are described.
7736 \begin_layout Subsection
7740 \begin_layout Standard
7742 provides several different methods for reverse search.
7743 Some are built-in in the
7744 \begin_inset Flex Code
7747 \begin_layout Plain Layout
7753 program, some are provided by external packages.
7754 Your choice depends on whether your \SpecialChar LaTeX
7755 distribution already provides a given
7756 method (the built-in methods are rather new) and whether your viewer can
7758 The available methods are described in the following.
7761 \begin_layout Subsubsection*
7762 Built-in DVI-search via src-specials (DVI only)
7765 \begin_layout Standard
7766 This method provides the DVI file with the necessary information for reverse
7768 It is available in \SpecialChar LaTeX
7769 since quite some time (any somewhat recent \SpecialChar LaTeX
7771 should include it), and it works reliably.
7772 To enable it, change the
7773 \begin_inset Flex Noun
7776 \begin_layout Plain Layout
7787 \begin_inset Flex Noun
7790 \begin_layout Plain Layout
7801 \begin_inset Flex Noun
7804 \begin_layout Plain Layout
7805 Preferences\SpecialChar menuseparator
7806 File Handling\SpecialChar menuseparator
7813 \begin_inset Flex Code
7816 \begin_layout Plain Layout
7817 latex -src-specials $$i
7823 If this doesn't work, check if your \SpecialChar TeX
7824 engine needs different options (the
7825 syntax might differ in some distributions).
7828 \begin_layout Subsubsection*
7829 External Packages (PDFSync and scrltx)
7832 \begin_layout Standard
7841 provide reverse search facility for PDF output (via pdflatex) and DVI output,
7843 In order to enable it, load the packages in the \SpecialChar LyX
7847 \begin_layout Itemize
7848 \begin_inset Flex Code
7851 \begin_layout Plain Layout
7859 for reverse PDF search,
7862 \begin_layout Itemize
7863 \begin_inset Flex Code
7866 \begin_layout Plain Layout
7869 usepackage[active]{srcltx}
7874 for reverse DVI search.
7877 \begin_layout Standard
7878 If you want to be able to perform both DVI and PDF reverse searches, you
7879 can also insert in the preamble the following lines
7882 \begin_layout LyX-Code
7886 \begin_inset Newline newline
7892 \begin_inset Newline newline
7898 \begin_inset Newline newline
7904 \begin_inset Newline newline
7909 usepackage[active]{srcltx}
7910 \begin_inset Newline newline
7918 \begin_layout Standard
7919 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7920 right package will be used.
7923 \begin_layout Standard
7924 Note that PDFSync might affect the output layout of your document.
7925 It is therefore advised to disable PDFsync for final documents.
7928 \begin_layout Subsubsection*
7929 Built-in reverse search via Sync\SpecialChar TeX
7933 \begin_layout Standard
7935 \begin_inset Flex Code
7938 \begin_layout Plain Layout
7944 have built-in support for both PDF and DVI reverse search.
7947 Sync\SpecialChar TeX
7950 facility is basically the result of the integration of the PDFSync package
7951 to the pdftex program and its merge with the
7956 You need at least \SpecialChar TeX
7957 Live 2008 or a recent Mik\SpecialChar TeX
7958 distribution in order to use
7963 \begin_layout Plain Layout
7964 For some reason, Mik\SpecialChar TeX
7965 does not understand/obey the command \SpecialChar LyX
7967 the preamble when you check the "Enable Forward/Reverse Search" button
7968 in the toolbar and does not generate the necessary info.
7971 \begin_layout Plain Layout
7972 The generation of the required info can be forced by changing the converter
7974 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7975 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7976 the -synctex=1 switch).
7981 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
7982 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
7983 already provide Sync\SpecialChar TeX
7987 \begin_layout Standard
7988 To enable Sync\SpecialChar TeX
7989 for DVI output, change the
7990 \begin_inset Flex Noun
7993 \begin_layout Plain Layout
8004 \begin_inset Flex Noun
8007 \begin_layout Plain Layout
8018 \begin_inset Flex Noun
8021 \begin_layout Plain Layout
8022 Preferences\SpecialChar menuseparator
8023 File Handling\SpecialChar menuseparator
8030 \begin_inset Flex Code
8033 \begin_layout Plain Layout
8034 latex -synctex=1 $$i
8039 , and for PDF output, change the
8040 \begin_inset Flex Noun
8043 \begin_layout Plain Layout
8048 (pdflatex) -> PDF (pdflatex)
8054 \begin_inset Flex Code
8057 \begin_layout Plain Layout
8058 pdflatex -synctex=1 $$i
8064 Should your viewer not be considered in the following description, or in
8065 case of missing success, please check the documentation of your viewer
8066 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
8071 \begin_layout Plain Layout
8072 Note that the option
8073 \begin_inset Flex Code
8076 \begin_layout Plain Layout
8082 option enables gzip compression.
8083 If your viewer does not support it, you should instead use
8084 \begin_inset Flex Code
8087 \begin_layout Plain Layout
8101 \begin_layout Subsection
8102 Configuring and using specific viewers
8103 \begin_inset CommandInset label
8105 name "subsec:configuring-viewers"
8112 \begin_layout Subsubsection*
8113 Xdvi (all platforms)
8116 \begin_layout Standard
8118 \begin_inset Flex Code
8121 \begin_layout Plain Layout
8127 , you don't need to do anything else for performing a reverse DVI search,
8129 already provides the necessary hooks for automatically using the
8130 \begin_inset Flex Code
8133 \begin_layout Plain Layout
8140 Just setup your document as described above (reverse search is triggered
8141 by Ctrl-click or Alt-click on Mac OSX, respectively).
8144 \begin_layout Standard
8145 However, if for whatever reason you want to use the named pipe instead of
8146 the socket for communicating with \SpecialChar LyX
8147 , simply change the DVI viewer in
8148 \begin_inset Flex Noun
8151 \begin_layout Plain Layout
8152 Preferences\SpecialChar menuseparator
8153 File Handling\SpecialChar menuseparator
8163 \begin_layout Plain Layout
8164 On Mac OSX you have to use
8165 \begin_inset Flex Code
8168 \begin_layout Plain Layout
8169 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
8180 \begin_inset Flex Code
8183 \begin_layout Plain Layout
8184 xdvi -editor "lyxeditor.sh %f %l"
8190 \begin_inset Flex Code
8193 \begin_layout Plain Layout
8199 is a suitable script.
8200 For example, a minimal shell script is the following one:
8203 \begin_layout LyX-Code
8205 \begin_inset Newline newline
8208 LYXPIPE="/path/to/lyxpipe"
8209 \begin_inset Newline newline
8212 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
8213 \begin_inset Newline newline
8216 echo "$COMMAND" > "${LYXPIPE}".in || exit
8217 \begin_inset Newline newline
8220 read TMP < "${LYXPIPE}".out || exit
8223 \begin_layout Standard
8225 \begin_inset Flex Code
8228 \begin_layout Plain Layout
8234 is the LyXServer pipe path specified in
8235 \begin_inset Flex Noun
8238 \begin_layout Plain Layout
8239 Preferences\SpecialChar menuseparator
8249 \begin_layout Plain Layout
8251 \begin_inset Flex Code
8254 \begin_layout Plain Layout
8260 folder of a source distribution you can find a
8261 \begin_inset Flex Code
8264 \begin_layout Plain Layout
8270 script which is able to locate the
8274 based on your preferences.
8282 \begin_layout Subsubsection*
8286 \begin_layout Standard
8288 \begin_inset Flex Code
8291 \begin_layout Plain Layout
8292 /Applications/MacDviX_Folder/calleditor.script
8297 , add the following lines:
8300 \begin_layout LyX-Code
8301 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
8302 \begin_inset Newline newline
8308 \begin_layout Standard
8309 Modify the lines accordingly if you install \SpecialChar LyX
8310 somewhere else than in the
8311 Applications folder.
8314 \begin_layout Standard
8315 Reverse search is triggered by Alt-click (OPTION-click).
8318 \begin_layout Subsubsection*
8322 \begin_layout Standard
8324 \begin_inset Flex Code
8327 \begin_layout Plain Layout
8328 open -a Skim.app $$i
8333 to the viewer setting in
8334 \begin_inset Flex Noun
8337 \begin_layout Plain Layout
8338 Preferences\SpecialChar menuseparator
8339 File Handling\SpecialChar menuseparator
8340 File formats\SpecialChar menuseparator
8347 \begin_inset Flex Noun
8350 \begin_layout Plain Layout
8351 Skim\SpecialChar menuseparator
8352 Preferences\SpecialChar menuseparator
8359 \begin_inset Flex Noun
8362 \begin_layout Plain Layout
8368 preset and enter command
8369 \begin_inset Flex Noun
8372 \begin_layout Plain Layout
8373 /Applications/\SpecialChar LyX
8374 .app/Contents/MacOS/lyxeditor
8382 \begin_layout Standard
8383 Reverse search is triggered by COMMAND-SHIFT-click
8386 \begin_layout Subsubsection*
8390 \begin_layout Standard
8391 Reverse search with evince does not work out of the box, but it can be achieved
8392 by means of some third party helper scripts.
8394 \begin_inset CommandInset href
8396 target "https://wiki.lyx.org/LyX/SyncTeX"
8404 \begin_layout Subsubsection*
8408 \begin_layout Standard
8410 \begin_inset Flex Noun
8413 \begin_layout Plain Layout
8414 Settings\SpecialChar menuseparator
8415 Configure Okular\SpecialChar menuseparator
8422 \begin_inset Quotes erd
8426 This inserts the appropriate command (
8427 \begin_inset Flex Code
8430 \begin_layout Plain Layout
8439 \begin_layout Standard
8440 Reverse search is triggered by SHIFT-click.
8442 \change_inserted -712698321 1578211026
8443 Note that this only works if Okular is in
8444 \begin_inset Quotes eld
8448 \begin_inset Quotes erd
8452 \begin_inset space \thinspace{}
8455 e., the hand symbol is clicked).
8460 \begin_layout Subsubsection*
8464 \begin_layout Standard
8465 Qpdfview supports Sync\SpecialChar TeX
8466 since version 0.3.5.
8468 \begin_inset Flex Noun
8471 \begin_layout Plain Layout
8472 Edit\SpecialChar menuseparator
8473 Settings\SpecialChar menuseparator
8479 , click on the input field of the
8480 \begin_inset Quotes eld
8484 \begin_inset Quotes erd
8487 item and add the command
8488 \begin_inset Flex Code
8491 \begin_layout Plain Layout
8500 \begin_layout Standard
8501 Reverse search is triggered by double-click or, in more recent versions,
8505 \begin_layout Subsubsection*
8509 \begin_layout Standard
8510 Launch yap, choose its
8511 \begin_inset Flex Noun
8514 \begin_layout Plain Layout
8515 View\SpecialChar menuseparator
8522 \begin_inset Quotes eld
8526 \begin_inset Quotes erd
8531 \begin_inset Quotes eld
8534 New\SpecialChar ldots
8536 \begin_inset Quotes erd
8539 button and, in the window that opens, enter
8540 \begin_inset Quotes eld
8545 \begin_inset Quotes erd
8548 (or any other name you like) in the
8549 \begin_inset Quotes eld
8553 \begin_inset Quotes erd
8557 Now click on the button labeled
8558 \begin_inset Quotes eld
8563 \begin_inset Quotes erd
8566 to open a file dialog and navigate to the directory containing the batch
8568 \begin_inset Flex Code
8571 \begin_layout Plain Layout
8579 \begin_inset Flex Code
8582 \begin_layout Plain Layout
8588 and then specify the program arguments as
8589 \begin_inset Flex Code
8592 \begin_layout Plain Layout
8600 \begin_inset Flex Code
8603 \begin_layout Plain Layout
8609 wrapper is used for communicating with \SpecialChar LyX
8617 \begin_layout LyX-Code
8619 \begin_inset Newline newline
8622 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
8631 \begin_inset Newline newline
8645 \begin_layout Standard
8646 Make sure that the \SpecialChar LyX
8647 Server pipe path you specified in \SpecialChar LyX
8649 \begin_inset Flex Code
8652 \begin_layout Plain Layout
8666 , otherwise change the
8667 \begin_inset Flex Code
8670 \begin_layout Plain Layout
8676 wrapper accordingly.
8679 \begin_layout Standard
8680 In yap, reverse search is triggered by double-click.
8683 \begin_layout Subsubsection*
8684 SumatraPDF (Windows)
8687 \begin_layout Standard
8688 In order to use SumatraPDF for inverse search, enter
8689 \begin_inset Flex Code
8692 \begin_layout Plain Layout
8693 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
8698 in the viewer setting in
8699 \begin_inset Flex Noun
8702 \begin_layout Plain Layout
8703 Preferences\SpecialChar menuseparator
8704 File Handling\SpecialChar menuseparator
8705 File formats\SpecialChar menuseparator
8712 \begin_inset Flex Code
8715 \begin_layout Plain Layout
8721 is the previous wrapper.
8722 If SumatraPDF.exe is not in your command PATH, use its full file name.
8725 \begin_layout Standard
8726 Reverse search is triggered by double-click.
8729 \begin_layout Subsubsection*
8733 \begin_layout Standard
8734 First of all, make sure that yap is your default DVI viewer in the Windows
8735 environment, then launch it, choose its
8736 \begin_inset Flex Noun
8739 \begin_layout Plain Layout
8740 View\SpecialChar menuseparator
8747 \begin_inset Quotes eld
8751 \begin_inset Quotes erd
8756 \begin_inset Quotes eld
8759 New\SpecialChar ldots
8761 \begin_inset Quotes erd
8764 button and, in the window that opens, enter
8765 \begin_inset Quotes eld
8770 \begin_inset Quotes erd
8773 (or any other name you like) in the
8774 \begin_inset Quotes eld
8778 \begin_inset Quotes erd
8782 Now click on the button labeled
8783 \begin_inset Quotes eld
8788 \begin_inset Quotes erd
8791 to open a file dialog and navigate to the directory containing the
8792 \begin_inset Flex Code
8795 \begin_layout Plain Layout
8801 program (which is installed by default on Cygwin along with the \SpecialChar LyX
8804 \begin_inset Flex Code
8807 \begin_layout Plain Layout
8813 and then specify the program arguments as
8814 \begin_inset Flex Code
8817 \begin_layout Plain Layout
8824 In this way, you will be using the
8828 for communicating with \SpecialChar LyX
8830 If, for whatever reason, you want to use the
8835 \begin_inset Flex Code
8838 \begin_layout Plain Layout
8844 option and be sure to specify the \SpecialChar LyX
8845 Server pipe path in the \SpecialChar LyX
8849 \begin_layout Standard
8850 In yap, reverse search is triggered by double-click.
8853 \begin_layout Subsubsection*
8857 \begin_layout Standard
8858 In order to use SumatraPDF for inverse search, enter
8859 \begin_inset Flex Code
8862 \begin_layout Plain Layout
8863 SumatraPDF -inverse-search "lyxeditor -g %f %l"
8868 in the viewer setting in
8869 \begin_inset Flex Noun
8872 \begin_layout Plain Layout
8873 Preferences\SpecialChar menuseparator
8874 File Handling\SpecialChar menuseparator
8875 File formats\SpecialChar menuseparator
8882 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8884 \begin_inset Flex Code
8887 \begin_layout Plain Layout
8893 enables communication via the
8899 \begin_inset Flex Code
8902 \begin_layout Plain Layout
8908 option if you want to use the
8912 , and be sure to specify the \SpecialChar LyX
8913 Server pipe path in the \SpecialChar LyX
8917 \begin_layout Standard
8918 Reverse search is triggered by double-click.
8921 \begin_layout Section
8925 \begin_layout Standard
8926 Forward search is, as the name implies, in a sense the
8927 \begin_inset Quotes eld
8931 \begin_inset Quotes erd
8935 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8937 If forward search is set up (as described in what follows), you can put
8938 the cursor anywhere in your \SpecialChar LyX
8940 \begin_inset Flex Noun
8943 \begin_layout Plain Layout
8944 Navigate\SpecialChar menuseparator
8951 \begin_inset Flex Noun
8954 \begin_layout Plain Layout
8960 in the context menu via right mouse click), and then the viewer will jump
8961 to that position as well.
8962 This implies, of course, that your viewer supports this function.
8965 \begin_layout Standard
8966 To make forward search possible, you first need to provide the generated
8967 output PDF/DVI file with additional information about the \SpecialChar TeX
8969 This can be done via the methods described in the section
8970 \begin_inset CommandInset ref
8972 reference "subsec:rev-search"
8979 \begin_layout Standard
8980 Additionally, you need to configure \SpecialChar LyX
8981 for using your viewers in
8982 \begin_inset Flex Noun
8985 \begin_layout Plain Layout
8986 Tools\SpecialChar menuseparator
8987 Preferences\SpecialChar menuseparator
8988 Output\SpecialChar menuseparator
8995 We provide a range of tested configurations for some viewers, which you
8996 can select from the drop down list.
8997 If none of these configurations suits you, you have to find out and enter
8998 a suitable configuration yourself.
8999 The definition syntax uses the following placeholders:
9002 \begin_layout Itemize
9004 \begin_inset Flex Code
9007 \begin_layout Plain Layout
9016 \begin_layout Itemize
9018 \begin_inset Flex Code
9021 \begin_layout Plain Layout
9027 : name of the (temporary) exported .tex file (without path)
9030 \begin_layout Itemize
9032 \begin_inset Flex Code
9035 \begin_layout Plain Layout
9041 : name of the (temporary) exported .tex file (including path)
9044 \begin_layout Itemize
9046 \begin_inset Flex Code
9049 \begin_layout Plain Layout
9055 : name of the exported output file (either dvi or pdf, depending on which
9056 one exists in the temporary directory)
9059 \begin_layout Standard
9060 Note that only some of the viewers provide full and usable forward search
9061 functionality out of the box, among them yap, xdvi, okular
9065 \begin_layout Plain Layout
9066 You might want to set
9067 \begin_inset Flex Code
9070 \begin_layout Plain Layout
9077 \begin_inset Flex Noun
9080 \begin_layout Plain Layout
9081 Tools\SpecialChar menuseparator
9082 Preferences\SpecialChar menuseparator
9083 File Handling\SpecialChar menuseparator
9085 \begin_inset space ~
9098 , qpdfview, and SumatraPDF
9102 \begin_layout Plain Layout
9103 SumatraPDF can also use DDE commands through the external program CMCDDE
9105 \begin_inset CommandInset href
9107 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
9118 Others, such as evince
9122 \begin_layout Plain Layout
9123 Forward search with evince can be achieved by means of third party helper
9126 \begin_inset CommandInset href
9128 target "https://wiki.lyx.org/LyX/SyncTeX"
9138 , require some extra tools in order to use forward search.
9139 While many of the widespread PDF viewers (most notably Adobe Reader) do
9140 not support forward search at all, some other viewers – e.
9141 \begin_inset space \thinspace{}
9145 xpdf – allow at least to reload the document and jump to a specific page
9146 of the file, so you can at least navigate
9147 \begin_inset Quotes eld
9151 \begin_inset Quotes erd
9155 This latter functionality is provided by an external call of synctex (see
9156 the predefined example configurations).
9160 \begin_layout Standard
9161 Forward search works both with DVI and PDF output.
9163 simply checks which preview format you have used before (i.
9164 \begin_inset space \thinspace{}
9167 e., which format is already there in the temporary directory) and chooses
9168 the appropriate configuration for the respective format.
9171 \begin_layout Chapter
9172 Special Document Classes
9175 \begin_layout Section
9177 \change_deleted 564990737 1669742044
9181 \begin_layout Standard
9183 \change_deleted 564990737 1669742044
9189 \begin_layout Subsection
9191 \change_deleted 564990737 1669742044
9195 \begin_layout Standard
9197 \change_deleted 564990737 1669742044
9198 This section describes how \SpecialChar LyX
9199 can be used to write articles for submission
9200 to the scientific journal
9202 Astronomy and Astrophysics
9205 \begin_inset Flex URL
9208 \begin_layout Plain Layout
9210 https://www.aanda.org/
9215 ) using Version 5.01 of the document class
9220 This package can be downloaded from the ftp site
9223 \begin_layout Standard
9225 \change_deleted 564990737 1669742044
9226 \begin_inset VSpace medskip
9232 \begin_layout Standard
9235 \change_deleted 564990737 1669742044
9236 \begin_inset Flex URL
9239 \begin_layout Plain Layout
9241 ftp://ftp.edpsciences.org/pub/aa/readme.html
9249 \begin_layout Standard
9251 \change_deleted 564990737 1669742044
9252 \begin_inset VSpace medskip
9258 \begin_layout Standard
9260 \change_deleted 564990737 1669742044
9261 A manual comes together with that package, and this text is not meant to
9262 replace the original manual but is merely a short guide in how to realize
9263 the correct form of your paper.
9267 \begin_layout Standard
9269 \change_deleted 564990737 1669742044
9270 Please note that the publisher of the journal was changed from Springer
9271 to EDP Sciences starting January 1, 2001.
9272 That change involved also some slight changes to the style files, namely
9273 the removal of the thesaurus command.
9274 The \SpecialChar LyX
9275 class aa supports the newest version of these style files, V 5.01.
9276 If you have an older version installed, please upgrade.
9277 For compatibility, the old (version 4) layout has been kept as
9282 Please refer to the comments in
9285 Dir/layouts/aapaper.layout
9290 \begin_layout Subsection
9292 \change_deleted 564990737 1669742044
9296 \begin_layout Standard
9298 \change_deleted 564990737 1669742044
9299 It is recommended you start from the example template distributed with \SpecialChar LyX
9301 If you are not using a template, note the following settings:
9304 \begin_layout Itemize
9306 \change_deleted 564990737 1669742044
9313 Document\SpecialChar menuseparator
9316 dialog (OK, that one was obvious).
9319 \begin_layout Itemize
9321 \change_deleted 564990737 1669742044
9322 Don't change the option
9325 \begin_inset space ~
9335 The whole layout is done by the macros, you shouldn't change anything.
9338 \begin_layout Subsection
9340 \change_deleted 564990737 1669742044
9344 \begin_layout Standard
9346 \change_deleted 564990737 1669742044
9347 First thing to enter is the header information.
9348 It consists of seven entries, of which some are optional.
9352 \begin_layout Itemize
9354 \change_deleted 564990737 1669742044
9362 \begin_layout Itemize
9364 \change_deleted 564990737 1669742044
9372 \begin_layout Itemize
9374 \change_deleted 564990737 1669742044
9382 \begin_layout Itemize
9384 \change_deleted 564990737 1669742044
9392 \begin_layout Itemize
9394 \change_deleted 564990737 1669742044
9399 : [optional] if more than one author: whom to contact for offprint requests.
9402 \begin_layout Itemize
9404 \change_deleted 564990737 1669742044
9409 : [optional] mail address for contacts.
9412 \begin_layout Itemize
9414 \change_deleted 564990737 1669742044
9422 Received: <date>; Accepted <date>
9425 \begin_layout Standard
9427 \change_deleted 564990737 1669742044
9428 There is no need to issue the
9434 command, this is done automatically by \SpecialChar LyX
9435 when the header is finished.
9436 Although the order of the single header entries doesn't matter it is advised
9437 to keep the above sequence, just to get the best optics and meets the layout
9438 of the real document.
9441 \begin_layout Standard
9443 \change_deleted 564990737 1669742044
9444 If you want to place footnotes in the header block, e.
9445 \begin_inset space \thinspace{}
9449 \begin_inset space \space{}
9452 to state your present address, just use the standard footnote via the menu
9455 Insert\SpecialChar menuseparator
9460 will automagically use the term
9469 \begin_layout Standard
9471 \change_deleted 564990737 1669742044
9474 Edit\SpecialChar menuseparator
9477 , you'll find two insets which are relevant for the titling:
9480 \begin_layout Itemize
9482 \change_deleted 564990737 1669742044
9489 to mark corresponding author\SpecialChar breakableslash
9491 The institutes are numbered sequentially as they appear in the
9495 field, so you have to put a marker to each author.
9498 \begin_layout Itemize
9500 \change_deleted 564990737 1669742044
9505 to supply an email address for fast contact.
9508 \begin_layout Standard
9510 \change_deleted 564990737 1669742044
9511 In addition to these topics, the macros use one additional \SpecialChar LaTeX
9513 has no counterpart in \SpecialChar LyX
9517 \begin_layout Itemize
9519 \change_deleted 564990737 1669742044
9526 to separate different names for more than one author and institute, respectivel
9530 \begin_layout Standard
9532 \change_deleted 564990737 1669742044
9533 The appropriate command has to be entered in \SpecialChar LyX
9534 and marked as \SpecialChar LaTeX
9540 \begin_layout Subsection
9542 \change_deleted 564990737 1669742044
9546 \begin_layout Standard
9548 \change_deleted 564990737 1669742044
9549 The abstract should immediately follow the header block.
9550 With version 5 the abstract environment was changed to a command, and there
9551 is now a restriction to only one paragraph.
9552 In addition, it should contain an entry with the keywords.
9553 This is done via the paragraph style
9558 Refer to the example paper.
9561 \begin_layout Subsection
9563 \change_deleted 564990737 1669742044
9564 Supported environments
9567 \begin_layout Standard
9569 \change_deleted 564990737 1669742044
9570 The A&A paper layout supports the following environments for structuring
9574 \begin_layout Itemize
9576 \change_deleted 564990737 1669742044
9582 \begin_layout Itemize
9584 \change_deleted 564990737 1669742044
9590 \begin_layout Itemize
9592 \change_deleted 564990737 1669742044
9598 \begin_layout Itemize
9600 \change_deleted 564990737 1669742044
9606 \begin_layout Itemize
9608 \change_deleted 564990737 1669742044
9614 \begin_layout Itemize
9616 \change_deleted 564990737 1669742044
9622 \begin_layout Itemize
9624 \change_deleted 564990737 1669742044
9630 \begin_layout Itemize
9632 \change_deleted 564990737 1669742044
9638 \begin_layout Itemize
9640 \change_deleted 564990737 1669742044
9646 \begin_layout Itemize
9648 \change_deleted 564990737 1669742044
9654 \begin_layout Itemize
9656 \change_deleted 564990737 1669742044
9662 \begin_layout Itemize
9664 \change_deleted 564990737 1669742044
9671 \begin_layout Subsection
9673 \change_deleted 564990737 1669742044
9674 Commands not supported by \SpecialChar LyX
9678 \begin_layout Standard
9680 \change_deleted 564990737 1669742044
9681 Some commands are not yet supported by the
9685 layout for \SpecialChar LyX
9687 Some have already been mentioned.
9688 For the sake of completeness, they are listed all together here:
9691 \begin_layout Itemize
9693 \change_deleted 564990737 1669742044
9701 \begin_layout Itemize
9703 \change_deleted 564990737 1669742044
9711 \begin_layout Itemize
9713 \change_deleted 564990737 1669742044
9721 \begin_layout Itemize
9723 \change_deleted 564990737 1669742044
9731 \begin_layout Standard
9733 \change_deleted 564990737 1669742044
9734 If you want to use any of these commands, you have to enter them yourself.
9737 Do not forget to mark them as \SpecialChar LaTeX
9741 \begin_layout Subsection
9743 \change_deleted 564990737 1669742044
9744 Figure and Table Floats
9747 \begin_layout Standard
9749 \change_deleted 564990737 1669742044
9751 provides support for the necessary float environments
9753 figure, figure*, table
9759 , therefore we won't tell much about it here.
9763 \begin_inset space ~
9769 Just remember that tables should be left-aligned.
9770 For that, select the table and change the alignment in
9772 Edit\SpecialChar menuseparator
9774 \begin_inset space ~
9780 \begin_layout Standard
9782 \change_deleted 564990737 1669742044
9783 There is only one special thing: the figures with caption besides the figure.
9784 To create such a figure, you have to do the following:
9787 \begin_layout Enumerate
9789 \change_deleted 564990737 1669742044
9790 Create a wide figure float:
9792 Insert\SpecialChar menuseparator
9793 Float\SpecialChar menuseparator
9796 , then right click in the figure and select
9799 \begin_inset space ~
9807 \begin_layout Enumerate
9809 \change_deleted 564990737 1669742044
9810 Enter your caption text.
9813 \begin_layout Enumerate
9815 \change_deleted 564990737 1669742044
9820 to move the cursor above the caption.
9823 \begin_layout Enumerate
9825 \change_deleted 564990737 1669742044
9829 \begin_layout Enumerate
9831 \change_deleted 564990737 1669742044
9832 Position the cursor behind the figure and insert a horizontal fill:
9834 Insert\SpecialChar menuseparator
9836 \begin_inset space ~
9839 Character\SpecialChar menuseparator
9841 \begin_inset space ~
9849 \begin_layout Enumerate
9851 \change_deleted 564990737 1669742044
9852 Switch to \SpecialChar LaTeX
9856 \begin_inset space ~
9864 \begin_layout Enumerate
9866 \change_deleted 564990737 1669742044
9876 Do not close the brace!
9879 \begin_layout Enumerate
9881 \change_deleted 564990737 1669742044
9882 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
9887 \begin_inset space ~
9899 \begin_layout Standard
9901 \change_deleted 564990737 1669742044
9902 Also, refer to the figures in the example paper.
9905 \begin_layout Subsection
9907 \change_deleted 564990737 1669742044
9911 \begin_layout Standard
9913 \change_deleted 564990737 1669742044
9914 For submission, the paper has to be formated in a special double-spacing
9916 For this purpose, you have to give the option
9920 to the document class.
9921 This must be done using the custom class options field in the
9923 Document\SpecialChar menuseparator
9927 Just enter the string
9934 \begin_layout Subsection
9936 \change_deleted 564990737 1669742044
9940 \begin_layout Standard
9942 \change_deleted 564990737 1669742044
9947 directory contains an example paper written with \SpecialChar LyX
9949 It is the example paper from the original macro package, translated to
9952 Use it for inspiration, and compare the original \SpecialChar LaTeX
9953 code with \SpecialChar LyX
9957 \begin_layout Section
9962 \begin_layout Standard
9968 \begin_layout Subsection
9972 \begin_layout Standard
9974 is a set of macros produced by the American Astronomical Society to
9975 facilitate electronic manuscript submission to the three journals they
9976 publish: the Astrophysical Journal (including the Letters and Supplement),
9977 the Astronomical Journal, and the Publications of the Astronomical Society
9980 has proven to be an excellent tool for generating these documents, especially
9981 given its equation, citation, and figure handling capabilities.
9983 requires version 5.0 (or higher) of these macros; preferably 6.0, which
9984 is the version described here, or higher.
9985 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9986 2.09 and are fundamentally
9987 incompatible with \SpecialChar LyX
9989 The AAS\SpecialChar TeX
9990 package may be downloaded from the AAS\SpecialChar TeX
9994 \begin_layout Standard
9995 \begin_inset VSpace medskip
10001 \begin_layout Standard
10003 \begin_inset Flex URL
10006 \begin_layout Plain Layout
10008 https://aas.org/aastex/aastex-downloads
10016 \begin_layout Standard
10017 \begin_inset VSpace medskip
10023 \begin_layout Standard
10024 A complete user guide is contained in that package and you should familiarize
10025 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
10028 will not reduce the need to figure out all the AAS\SpecialChar TeX
10029 commands, it will only
10030 reduce the drudgery of typing everything in.
10031 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
10033 completely to the requirements of the journal to which you are submitting
10037 \begin_layout Subsection
10038 Starting a New Paper
10041 \begin_layout Standard
10042 I strongly suggest that you start with the AAS\SpecialChar TeX
10046 File\SpecialChar menuseparator
10053 , enter the new file name, then choose the
10058 This will show the most common fields found in a manuscript.
10059 Simply overwrite the existing text (including the brackets,
10063 ) with the correct information.
10064 Many of the AAS\SpecialChar TeX
10065 commands and environments can be implemented directly in
10068 For commands such as these, the \SpecialChar LaTeX
10069 code must be entered directly and marked
10071 Such commands are referred to as \SpecialChar TeX
10072 code, or Evil Red Text.
10073 I tried to minimize the amount of \SpecialChar TeX
10074 code needed in an AAS\SpecialChar TeX
10078 \begin_layout Subsection
10079 Finishing Your Paper
10082 \begin_layout Standard
10083 When the paper is finished to your satisfaction and previews/prints correctly,
10085 \begin_inset Quotes eld
10089 \begin_inset Quotes erd
10092 actions which need to be done before you submit it to the journals.
10096 \begin_layout Enumerate
10097 Export your paper as a \SpecialChar LaTeX
10100 File\SpecialChar menuseparator
10101 Export\SpecialChar menuseparator
10109 \begin_layout Enumerate
10114 file with your favorite text editor
10118 \begin_layout Enumerate
10119 remove the comment lines before the
10128 \begin_layout Enumerate
10133 usepackage...{fontenc}
10135 line if it appears (usually just after
10147 line if it appears.
10150 \begin_layout Enumerate
10151 remove everything between (and including) the
10163 commands, except for any commands you specifically put into the \SpecialChar LaTeX
10165 (which should appear immediately after the
10166 \begin_inset Quotes eld
10169 User specified \SpecialChar LaTeX
10171 \begin_inset Quotes erd
10182 \begin_layout Enumerate
10183 Run the resulting file through \SpecialChar LaTeX
10184 to make sure it still processes correctly.
10187 \begin_layout Enumerate
10188 Reread the journal requirements to make sure your filenames and formats
10192 \begin_layout Enumerate
10196 \begin_layout Subsection
10197 Comments On Specific Commands
10200 \begin_layout Standard
10201 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
10203 AAS\SpecialChar TeX
10208 ) gives a good description of each.
10209 Thus it's probably easiest for me to go down the list as found in the guide
10210 and offer comments where necessary.
10211 So let's begin \SpecialChar ldots
10215 \begin_layout Subsubsection
10216 Things that work as expected
10219 \begin_layout Standard
10220 Because they work as you might expect, I simply list them and the section
10321 begin{thebibliography}
10329 (2.13.2), all the cite commands and their variations (2.13.2), the generic
10330 graphicx figure commands (2.14.1),
10354 (2.15.4, amongst other places),
10381 \begin_layout Standard
10382 The following style options also work correctly:
10403 Simply put them in the
10409 Layout\SpecialChar menuseparator
10415 \begin_layout Subsubsection
10416 Things that work, but require more comment
10419 \begin_layout Standard
10420 The following items work, but require a little more discussion:
10423 \begin_layout Itemize
10424 These items are reserved for use by the journal editors, but you can put
10425 them into the \SpecialChar LaTeX
10426 preamble if you feel compelled to do so:
10459 \begin_layout Itemize
10460 These items may be placed in the \SpecialChar LaTeX
10461 preamble, and are included as blanks in
10483 \begin_layout Itemize
10490 (2.3) – can only be used
10491 \begin_inset Quotes eld
10495 \begin_inset Quotes erd
10498 , not in the middle of a paragraph.
10499 Use \SpecialChar TeX
10500 code if you need to embed it.
10503 \begin_layout Itemize
10510 (2.3) – will have extra {} after it.
10511 This should not cause an error.
10514 \begin_layout Itemize
10521 (2.6) – can only be used
10522 \begin_inset Quotes eld
10526 \begin_inset Quotes erd
10529 , not in the middle of a paragraph.
10530 Use \SpecialChar TeX
10531 code if you need to embed it.
10534 \begin_layout Itemize
10541 (2.8) – can't insert a cross-reference tag, you must type the tag name by
10545 \begin_layout Itemize
10552 (2.8) – same as for
10559 \begin_layout Itemize
10566 (2.9) – will have extra {} after it.
10567 This should not cause an error.
10570 \begin_layout Itemize
10577 (2.11) – will have extra {} after it.
10578 This should not cause an error.
10581 \begin_layout Itemize
10588 (2.14.2) – you can insert an optional filename argument by placing the cursor
10589 at the beginning of the text and selecting
10591 Insert\SpecialChar menuseparator
10596 \begin_inset Quotes eld
10600 \begin_inset Quotes erd
10603 inserts an optional argument of the type needed by
10610 Hopefully it will be renamed someday.
10613 \begin_layout Itemize
10626 for the catalog ID optional parameter
10629 \begin_layout Itemize
10642 for the catalog ID optional parameter
10645 \begin_layout Subsubsection
10646 Things not implemented, use \SpecialChar TeX
10650 \begin_layout Standard
10661 setcounter{equation}
10663 (2.12), Journal name abbreviations (2.13.4),
10699 (2.15.4, insert it as the first element in the lefthand cell after where
10701 Don't use any of \SpecialChar LyX
10702 's rules in the table),
10714 (2.15.5), much of Misc (2.17, except
10765 \begin_layout Subsubsection
10766 Things that cannot be implemented
10769 \begin_layout Standard
10771 at least in any meaningful sort of way, so I suggest ignoring them.
10772 They are the references environment (2.13.3), and the deluxetable environment
10774 If you really, really need to use deluxetable, I suggest editing it in
10775 a separate file with a text editor, then using
10777 Insert\SpecialChar menuseparator
10779 \begin_inset space ~
10784 to include it in your \SpecialChar LyX
10790 file to see an example of this.
10793 \begin_layout Subsection
10794 FAQs, Tips, Tricks, and Other Ruminations
10797 \begin_layout Subsubsection
10798 Getting \SpecialChar LyX
10799 and AAS\SpecialChar TeX
10803 \begin_layout Standard
10804 It can be a bit tricky to get \SpecialChar LyX
10805 to recognize a new layout and document class.
10806 When all else fails, do this:
10809 \begin_layout Enumerate
10810 Make certain that \SpecialChar LaTeX
10811 can find AAS\SpecialChar TeX
10813 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
10814 distribution into a
10815 directory completely unrelated to \SpecialChar LaTeX
10816 or AAS\SpecialChar TeX
10817 and run \SpecialChar LaTeX
10825 \begin_layout Enumerate
10830 appears in \SpecialChar LyX
10838 \begin_layout Enumerate
10841 Tools\SpecialChar menuseparator
10844 in \SpecialChar LyX
10845 , then restart \SpecialChar LyX
10849 \begin_layout Enumerate
10850 Open a regular new file, not from a template.
10851 Does AAS\SpecialChar TeX
10852 appear in the class list in
10854 Document\SpecialChar menuseparator
10860 \begin_layout Standard
10861 If you get a warning from an existing AAS\SpecialChar TeX
10862 document about not being able
10863 to find the AAS\SpecialChar TeX
10864 layout or a message about
10865 \begin_inset Quotes eld
10868 You should not mix title layouts with normal ones
10869 \begin_inset Quotes erd
10872 , things haven't been installed correctly.
10875 \begin_layout Subsubsection
10877 error processing a table
10880 \begin_layout Standard
10882 , by default, attempts to center the table caption/title.
10883 This seems to produce a bad interaction in AAS\SpecialChar TeX
10884 so you should click somewhere
10885 in the caption/title, then select
10887 Edit\SpecialChar menuseparator
10889 \begin_inset space ~
10903 This took care of it for me.
10906 \begin_layout Subsubsection
10910 \begin_layout Standard
10911 A couple of things: 1) I have noticed some funny spacing in the reference
10912 entries in the text.
10913 When you enter the bibliography item data, make sure their is
10917 space between the last author and the parenthesis setting off the year;
10921 \begin_inset space \thinspace{}
10925 \begin_inset space \space{}
10939 2) Entering the references at all is not obvious.
10940 The easiest thing is to start typing your first reference at the end of
10941 the document, then mark it as type
10946 That will put a small gray box in front of what you just typed.
10947 Click on the box to fill in the rest of the information.
10948 For new references, go to the end of an existing reference and press return.
10949 That will create a new line with its own box, etc.
10952 \begin_layout Subsubsection
10953 Including EPS files
10956 \begin_layout Standard
10957 Even though AAS\SpecialChar TeX
10958 provides its own figure commands (
10964 , for example), I much prefer \SpecialChar LaTeX
10965 's standard figure commands (with the default
10974 \begin_inset space ~
10977 commands as \SpecialChar TeX
10978 code into a Figure Float box if you desire, but I never have
10979 much luck getting the layout right.
10980 With the standard graphics, \SpecialChar LyX
10985 usepackage{graphicx}
10987 command into the \SpecialChar LaTeX
10988 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10990 interspersing the figures in the text.
10991 I believe ApJ accepts figures exactly this way now; AJ might still use
10993 \begin_inset Quotes eld
10996 stack everything at the end
10997 \begin_inset Quotes erd
11003 \begin_layout Subsubsection
11004 Things I could have done, but didn't
11007 \begin_layout Standard
11009 \begin_inset Quotes eld
11013 \begin_inset Quotes erd
11016 things I could have implemented, but chose not to.
11017 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
11019 even though it is double-spaced in the paper manuscript.
11020 Also, I chose not to make separate layouts for the preprint and preprint2
11022 Since I assume you will spend most of your time in the plain manuscript
11023 mode anyway, I decided not to chew up more disk space with this.
11027 \begin_layout Subsection
11031 \begin_layout Standard
11032 Your mileage may vary.
11033 I've now had papers published by both ApJ and AJ that have had 98% of the
11034 effort done in \SpecialChar LyX
11035 ; the last 2% was the \SpecialChar LaTeX
11036 post-processing and a few cleanups.
11037 I have had no trouble with the submission process, and I'm sure the journals
11038 were never aware that there might be a difference.
11039 So, go forth and publish!
11042 \begin_layout Section
11046 \begin_layout Standard
11052 \begin_layout Subsection
11056 \begin_layout Standard
11057 Broadway is for writing plays.
11058 The format is more decorative than Hollywood, and much less standardized.
11059 This format should be suitable for workshops.
11062 \begin_layout Subsection
11066 \begin_layout Standard
11067 The same as in Hollywood.
11070 \begin_layout Subsection
11074 \begin_layout Standard
11079 names as labels then cross-reference the label to insert the name.
11080 The cross-reference dialog will show the current cast of characters.
11083 \begin_layout Subsection
11084 Paper size and Margins
11087 \begin_layout Standard
11088 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
11091 \begin_layout Subsection
11095 \begin_layout Standard
11096 The following environments are available.
11097 You can use broadway.bind to get the bind keys shown at the right.
11100 \begin_layout Itemize
11104 \begin_inset Newline newline
11109 You should not have to use this, but it is here for anything that does not
11113 \begin_layout Itemize
11117 \begin_inset space \hfill{}
11121 \begin_inset Newline newline
11126 Used to describe stage setting and the action.
11127 First use of speaker names in all CAPs.
11130 \begin_layout Itemize
11134 \begin_inset space \hfill{}
11138 \begin_inset Newline newline
11143 Automatically numbered.
11144 On screen it will be arabic, but will print as Roman.
11147 \begin_layout Itemize
11151 \begin_inset space \hfill{}
11155 \begin_inset Newline newline
11165 It is just centered text.
11168 \begin_layout Itemize
11172 \begin_inset space \hfill{}
11176 \begin_inset Newline newline
11181 Not automatically numbered.
11182 You supply the number.
11183 This is because I couldn't figure out how.
11186 \begin_layout Itemize
11190 \begin_inset space \hfill{}
11194 \begin_inset Newline newline
11199 A special case of Narrative to describe the setting and action as the curtain
11203 \begin_layout Itemize
11207 \begin_inset space \hfill{}
11211 \begin_inset Newline newline
11216 The speaker's (actor's) title, centered in all CAPS.
11219 \begin_layout Itemize
11223 \begin_inset space \hfill{}
11227 \begin_inset Newline newline
11232 Instructions to the speaker.
11233 The parentheses are automatically inserted.
11234 The ( will appear on screen, but both will be in the printed play.
11235 This environment is only used within
11242 \begin_layout Itemize
11246 \begin_inset space \hfill{}
11250 \begin_inset Newline newline
11255 What the Speaker says.
11258 \begin_layout Itemize
11262 \begin_inset space \hfill{}
11266 \begin_inset Newline newline
11271 The curtain comes down.
11274 \begin_layout Itemize
11278 \begin_inset space \hfill{}
11284 \begin_layout Itemize
11288 \begin_inset space \hfill{}
11294 \begin_layout Itemize
11298 \begin_inset space \hfill{}
11304 \begin_layout Standard
11308 \begin_layout Section
11312 \begin_layout Standard
11317 can be used to type letters according to German conventions.
11318 A template file is included in
11320 .../lyx/share/templates
11322 for you to use as a starting point.
11325 \begin_layout Section
11329 \begin_layout Standard
11330 See the \SpecialChar LyX
11336 It contains all infos you need.
11339 \begin_layout Section
11342 Foil\SpecialChar TeX
11346 \begin_inset CommandInset label
11355 \begin_layout Standard
11361 \begin_layout Subsection
11365 \begin_layout Standard
11366 This section describes how to use \SpecialChar LyX
11367 to make slides for overhead projectors.
11368 There are two document classes that can do this: the default slides class
11371 Foil\SpecialChar TeX
11375 This section documents the latter.
11378 \begin_layout Standard
11379 I'm going to say this again, nice and clear, so that there's no misunderstanding
11383 \begin_layout Standard
11384 \begin_inset VSpace bigskip
11390 \begin_layout Standard
11394 This section documents the class
11395 \begin_inset Quotes eld
11403 \begin_inset Quotes erd
11411 \begin_layout Standard
11412 \begin_inset VSpace bigskip
11418 \begin_layout Standard
11419 If you're looking for the documentation for
11420 \begin_inset Quotes eld
11428 \begin_inset Quotes erd
11431 , check out section
11432 \begin_inset space ~
11436 \begin_inset CommandInset ref
11438 reference "sec:slitex"
11443 If your machine doesn't have the
11451 installed, you'll probably have to use the default
11455 class, which isn't quite as good as
11460 \begin_layout Standard
11465 class is designed for use with version
11466 \begin_inset space ~
11474 class file which is now an integral part of \SpecialChar LaTeX2e
11478 \begin_layout Subsection
11482 \begin_layout Standard
11483 Obviously, to use this document class, you need to select
11494 \begin_inset space ~
11500 There are some settings in the
11503 \begin_inset space ~
11508 dialog that you should know about that are specific to this class:
11511 \begin_layout Itemize
11512 Don't change the options
11523 \begin_inset space ~
11529 They're ignored by the
11536 \begin_layout Itemize
11537 The default font size is 20
11538 \begin_inset space \thinspace{}
11541 pt with the other options being 17
11542 \begin_inset space \thinspace{}
11546 \begin_inset space \thinspace{}
11550 \begin_inset space \thinspace{}
11556 \begin_layout Itemize
11557 The default font is
11565 but all math equations are still typeset in the usual roman font.
11568 \begin_layout Itemize
11571 Foil\SpecialChar TeX
11574 supports A4 and Letter paper sizes as well as a special size for working
11576 \begin_inset space \thinspace{}
11580 It doesn't support A5, B5, legal or executive paper sizes.
11583 \begin_layout Itemize
11584 Don't bother changing the
11588 settings because they are ignored anyway.
11589 All floats appear where they are defined in the text.
11592 \begin_layout Itemize
11597 setting behaves a bit differently for this class.
11600 Foil\SpecialChar TeX
11603 provides extensive footer and header capabilities including a user-defined
11606 \begin_inset space ~
11610 \begin_inset CommandInset ref
11612 reference "sec:foilfoot"
11617 The title page is treated differently to all other pages in the document
11626 has the logo centered at the bottom of the page (if one is defined).
11627 The possible page style choices and what they do are as follows:
11631 \begin_layout Labeling
11632 \labelwidthstring MMMMMMM
11639 The final output contains no page numbers, or other headers or footers
11640 (except footnotes of course).
11644 \begin_layout Labeling
11645 \labelwidthstring MMMMMMM
11652 The final output contains page numbers centered at the bottom of the page.
11653 No other headings or footers (other than footnotes).
11656 \begin_layout Labeling
11657 \labelwidthstring MMMMMMM
11662 Page numbers in lower right corner.
11663 Additional headers and footers are also shown.
11664 This is also the default.
11667 \begin_layout Labeling
11668 \labelwidthstring MMMMMMM
11673 Gives you access to the
11677 package although its use with
11679 Foil\SpecialChar TeX
11682 is discouraged by the writer of the
11684 Foil\SpecialChar TeX
11687 package because of some potential page layout clashes.
11691 \begin_layout Subsubsection
11695 \begin_layout Standard
11696 The following options may be used in the extra class options in the
11698 Document\SpecialChar menuseparator
11704 \begin_layout Labeling
11705 \labelwidthstring MMMMMMx
11710 This sets up the page layout for 7.33
11711 \begin_inset space \thinspace{}
11715 \begin_inset space \thinspace{}
11718 in paper, which is about the same aspect ratio as a 35
11719 \begin_inset space \thinspace{}
11722 mm slide, making it a bit easier to work with this medium.
11725 \begin_layout Labeling
11726 \labelwidthstring MMMMMMx
11731 Places a rule across the page below the header on every page except the
11735 \begin_layout Labeling
11736 \labelwidthstring MMMMMMx
11741 Places a rule across the page above the footer on every page except the
11745 \begin_layout Labeling
11746 \labelwidthstring MMMMMMx
11751 This is automatically set each time you create a new
11758 Foil\SpecialChar TeX
11761 to use the dvips driver to rotate those pages that are set as landscape
11765 \begin_layout Labeling
11766 \labelwidthstring MMMMMMx
11771 Simply changes the page dimensions to those of a landscape page but doesn't
11773 Thus if you use this option you need to use an external program to rotate
11774 each page or feed your paper through your printer as landscape.
11775 Note that this option effectively reverses the roles of the
11783 environments (don't worry these are described in the next section).
11786 \begin_layout Labeling
11787 \labelwidthstring MMMMMMx
11792 Equation numbers on the left.
11795 \begin_layout Labeling
11796 \labelwidthstring MMMMMMx
11801 Flush-left equations.
11804 \begin_layout Subsection
11805 Supported Environments
11808 \begin_layout Standard
11809 Most of the environments commonly supported in other classes are also supported
11815 There are several additional environments provided by
11817 Foil\SpecialChar TeX
11820 as well as a couple added by \SpecialChar LyX
11822 The following environments are shared with other classes:
11825 \begin_layout Standard
11826 \begin_inset Flex Multiple Columns
11829 \begin_layout Itemize
11835 \begin_layout Itemize
11841 \begin_layout Itemize
11847 \begin_layout Itemize
11853 \begin_layout Itemize
11859 \begin_layout Itemize
11866 \begin_layout Itemize
11872 \begin_layout Itemize
11878 \begin_layout Itemize
11884 \begin_layout Itemize
11890 \begin_layout Itemize
11896 \begin_layout Itemize
11902 \begin_layout Itemize
11908 \begin_layout Itemize
11914 \begin_layout Itemize
11925 \begin_layout Standard
11926 That is, all the major environments apart from the sectioning environments.
11927 Since foils are essentially self-contained sections, with a title and body,
11930 Foil\SpecialChar TeX
11933 provides specific commands for starting new foils and these are:
11936 \begin_layout Itemize
11942 \begin_layout Itemize
11948 \begin_layout Standard
11950 also provides slightly modified versions of these two environments called:
11953 \begin_layout Itemize
11959 \begin_layout Itemize
11962 ShortRotatefoilhead
11965 \begin_layout Standard
11966 and the differences will be explained in the next section.
11969 \begin_layout Standard
11970 Since foils are often used in presenting ideas or new theorems and such
11973 Foil\SpecialChar TeX
11976 also provides a comprehensive box of goodies for presenting them:
11979 \begin_layout Standard
11980 \begin_inset Flex Multiple Columns
11983 \begin_layout Itemize
11989 \begin_layout Itemize
11995 \begin_layout Itemize
12001 \begin_layout Itemize
12007 \begin_layout Itemize
12013 \begin_layout Itemize
12019 \begin_layout Itemize
12025 \begin_layout Itemize
12031 \begin_layout Itemize
12037 \begin_layout Itemize
12043 \begin_layout Itemize
12054 \begin_layout Standard
12055 The starred versions are unnumbered while the unstarred versions are numbered.
12056 There are also two list environments added by \SpecialChar LyX
12060 \begin_layout Itemize
12066 \begin_layout Itemize
12072 \begin_layout Standard
12075 Foil\SpecialChar TeX
12078 provides some powerful header and footer capabilities that are best set
12079 in the preamble although they may be set at any point in a document.
12080 If you want to change these settings in your document the best place to
12081 do so is at the very top of a foil, i.
12082 \begin_inset space \thinspace{}
12088 \begin_inset space \space{}
12093 straight after the foilhead.
12096 \begin_layout Standard
12097 For this purpose, the following command styles are provided [
12104 \begin_layout Standard
12105 \begin_inset Flex Multiple Columns
12108 \begin_layout Itemize
12112 \begin_inset space ~
12118 \begin_layout Itemize
12124 \begin_layout Itemize
12128 \begin_inset space ~
12134 \begin_layout Itemize
12138 \begin_inset space ~
12144 \begin_layout Itemize
12148 \begin_inset space ~
12155 \begin_layout Plain Layout
12156 \begin_inset space ~
12168 \begin_layout Standard
12169 There are also a few commands provided by
12171 Foil\SpecialChar TeX
12174 that aren't directly supported by \SpecialChar LyX
12175 but I'll tell you what they do and how
12176 to use them in section
12177 \begin_inset space ~
12181 \begin_inset CommandInset ref
12183 reference "sec:unsuppfoils"
12190 \begin_layout Subsection
12191 Building a Set of Foils
12194 \begin_layout Standard
12195 This section will give a simple introduction to using the different environments
12196 to build a set of foils.
12197 If you want to see an example set of foils, take a look at the
12201 file you find in \SpecialChar LyX
12209 \begin_layout Subsubsection
12210 Give It a Title Page
12213 \begin_layout Standard
12214 Unlike other classes that provide
12234 creates the title on a page of its own.
12235 If you leave out the
12239 environment \SpecialChar LaTeX
12240 will substitute the current date (every time you regenerate
12244 \begin_layout Subsubsection
12248 \begin_layout Standard
12249 As I mentioned earlier, there are four ways of starting a new foil.
12250 For portrait foils you should use
12259 The difference between these two environments is the amount of space between
12260 the title of the foil (the foilhead) and the body of the foil.
12263 \begin_layout Standard
12264 Landscape foils are generated using the
12270 ShortRotatefoilhead
12273 Again the only difference is the spacing between foilhead and body.
12274 Both of the short versions have 0.5
12275 \begin_inset space ~
12278 inches less separation between the foilhead and the body.
12282 \begin_layout Standard
12283 One problem with the support for landscape foils is the requirement that
12284 you have to use the
12288 driver to generate the PostScript output otherwise the foils won't be rotated.
12289 It is possible to get landscape foils even if you haven't got the
12293 driver provided you can feed your foils sideways through your printer ;-)
12296 \begin_layout Subsubsection
12297 Theorems, Lemmas, Proofs and more
12300 \begin_layout Standard
12301 You can't have two of the same type of these environments directly following
12303 If you use a normal paragraph break, , you will just be extending the previous
12304 environment as if you had merged the two environments together.
12305 Rather than that, you need to insert a so-called separator.
12306 Please refer to the section entitled
12317 \begin_layout Subsubsection
12321 \begin_layout Standard
12322 You get all the commonly supported list styles found in other classes as
12323 well as two new ones.
12324 I'll only describe the new ones here.
12325 If you want to find out more about the other list environments check out
12331 If you intend to use itemized lists you might also want to read about the
12335 \begin_inset space ~
12339 \begin_inset space ~
12344 dialog described above in section
12345 \begin_inset space ~
12349 \begin_inset CommandInset ref
12351 reference "sec:bullet"
12358 \begin_layout Standard
12359 The two new list styles,
12367 , are designed to make it easier for you to create lists of do's and don'ts
12368 or right and wrong by providing dedicated environments that use a tick
12369 or a cross as the label of the list.
12370 These lists are in fact dedicated variants of the
12375 They do however require that you have the
12379 packages installed.
12382 \begin_layout Subsubsection
12386 \begin_layout Standard
12389 Foil\SpecialChar TeX
12392 redefines the floating tables and figures so that they appear exactly where
12393 they are in the text rather than pushing them to the top of the page or
12394 to some user specified location.
12395 In fact if you change the float placement settings they are simply ignored.
12398 \begin_layout Subsubsection
12399 Page Headers and Footers
12400 \begin_inset CommandInset label
12402 name "sec:foilfoot"
12409 \begin_layout Standard
12413 \begin_inset space ~
12422 are two commands used to control the left-footer text string.
12423 The first is meant to allow you to include a graphic logo on your foils
12425 \begin_inset Quotes eld
12430 Foil\SpecialChar TeX
12434 \begin_inset Quotes erd
12438 While the second is meant to provide a classification for the audience,
12442 \begin_inset space \thinspace{}
12448 \begin_inset space \space{}
12452 It is empty by default.
12455 \begin_layout Standard
12456 The remaining page corners can be filled by
12459 \begin_inset space ~
12464 (which defaults to page numbers),
12467 \begin_inset space ~
12475 \begin_inset space ~
12483 \begin_layout Subsection
12486 Foil\SpecialChar TeX
12490 \begin_inset CommandInset label
12492 name "sec:unsuppfoils"
12499 \begin_layout Standard
12500 All the commands mentioned below need to be set in a
12510 within another environment.
12513 \begin_layout Subsubsection
12517 \begin_layout Standard
12518 All lengths are adjusted using the
12541 should be replaced by the name given to the length you want to change and
12546 is the length value.
12547 All lengths should be specified in units of length such as inches (
12559 ) or relative to some document or font-based length such as
12569 \begin_layout Standard
12570 It's possible to change the spacing between a foilhead and the body of the
12571 foil by adjusting the length specified by
12578 For example, to make
12583 \begin_inset space \space{}
12586 in closer to their bodies put the following in the preamble:
12592 foilheadskip}{-0.5in}
12595 \begin_layout Standard
12596 The spacings around floats can be adjusted by setting these lengths:
12599 \begin_layout Labeling
12600 \labelwidthstring MMMMMMMMMMM
12607 Separation between the text and the top of the float
12610 \begin_layout Labeling
12611 \labelwidthstring MMMMMMMMMMM
12618 Separation between the float and the caption
12621 \begin_layout Labeling
12622 \labelwidthstring MMMMMMMMMMM
12629 Separation between the caption and the following text
12632 \begin_layout Labeling
12633 \labelwidthstring MMMMMMMMMMM
12640 You can make the captions narrower than the surrounding text by adjusting
12642 Best done relative to
12651 \begin_layout Standard
12652 There are also several title page related lengths that you may find useful
12653 if you have a long title or several authors:
12656 \begin_layout Labeling
12657 \labelwidthstring MMMMMMMMMMM
12664 Separation from headers to
12669 \begin_layout Labeling
12670 \labelwidthstring MMMMMMMMMMM
12688 \begin_layout Labeling
12689 \labelwidthstring MMMMMMMMMMM
12703 \begin_layout Labeling
12704 \labelwidthstring MMMMMMMMMMM
12720 \begin_layout Labeling
12721 \labelwidthstring MMMMMMMMMMM
12737 \begin_layout Standard
12738 The last length related command affects all the list environments.
12749 a list environment then all the vertical spacing between the list items
12751 Note that this is a command not a length so it doesn't require
12757 like the stuff mentioned above.
12760 \begin_layout Subsubsection
12761 Headers and Footers
12764 \begin_layout Standard
12777 commands control whether the logo in the
12781 definition appear on a given page.
12788 in the preamble then none of the foils will have the logo on them.
12789 If you don't want the logo on a particular page place the
12795 directly after the foilhead of that page and the
12801 directly after the next foilhead.
12804 \begin_layout Standard
12805 If you decide to use the
12809 page style setting in the
12812 \begin_inset space ~
12817 dialog you should probably add
12827 to your preamble so headers and footers on landscape pages are correctly
12828 placed when rotated.
12829 This is due to some clashes between the page layouts provided by the
12840 \begin_layout Section
12841 Hollywood (Hollywood spec scripts)
12844 \begin_layout Standard
12850 \begin_layout Subsection
12854 \begin_layout Standard
12855 Getting the format of a Hollywood script right is a
12856 \begin_inset Quotes eld
12860 \begin_inset Quotes erd
12863 It is designed to make the readers focus on content and to be easy and
12864 familiar for the actors to read.
12865 Each page of a script should be one minute of film.
12866 Nothing goes in a script that you cannot see or hear on screen.
12867 The courier 12 pt font should be used throughout.
12871 \begin_layout Subsection
12875 \begin_layout Standard
12876 Speakers' lines should NEVER break in mid-sentence.
12877 If a speaker's lines continue over a page break, repeat the
12881 title followed by (Cont'd).
12884 \begin_layout Subsection
12888 \begin_layout Standard
12893 names as labels then cross-reference the label to insert the name.
12894 The cross-reference dialog will show the current cast of characters.
12895 You can use this to insert the speaker name in narratives also.
12898 \begin_layout Subsection
12899 Paper size and Margins
12902 \begin_layout Standard
12903 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12906 \begin_layout Subsection
12910 \begin_layout Standard
12911 The following environments are available.
12912 You can use hollywood.bind to get the bind keys shown at the right.
12915 \begin_layout Itemize
12919 \begin_inset Newline newline
12924 Used where nothing else works.
12928 \begin_layout Itemize
12934 \begin_inset space \hfill{}
12942 \begin_inset Newline newline
12945 Usually followed by something like
12946 \begin_inset Quotes eld
12949 on Sally waking up.
12950 \begin_inset Quotes erd
12956 \begin_layout Itemize
12960 \begin_inset space \hfill{}
12964 \begin_inset Newline newline
12969 Introduces a new INTERIOR camera set-up.
12970 Always followed by DAY or NIGHT, or something similar to define the lighting
12972 Everthing on this line in CAPS.
12975 \begin_layout Itemize
12979 \begin_inset space \hfill{}
12983 \begin_inset Newline newline
12988 Introduces a new EXTERIOR camera set-up.
12989 Everthing on this line in CAPS.
12992 \begin_layout Itemize
12996 \begin_inset space \hfill{}
13000 \begin_inset Newline newline
13005 The character speaking.
13008 \begin_layout Itemize
13012 \begin_inset space \hfill{}
13016 \begin_inset Newline newline
13021 Instructions to the speaker.
13022 The () are automatically inserted.
13025 \begin_layout Itemize
13029 \begin_inset space \hfill{}
13033 \begin_inset Newline newline
13045 \begin_layout Itemize
13049 \begin_inset space \hfill{}
13053 \begin_inset Newline newline
13058 Camera movement instruction.
13060 \begin_inset space \thinspace{}
13064 \begin_inset space \space{}
13070 \begin_layout Itemize
13074 \begin_inset space \hfill{}
13080 \begin_layout Itemize
13084 \begin_inset space \hfill{}
13090 \begin_layout Itemize
13094 \begin_inset space \hfill{}
13100 \begin_layout Itemize
13104 \begin_inset space \hfill{}
13110 \begin_layout Subsection
13114 \begin_layout Itemize
13118 \begin_layout Itemize
13122 \begin_layout Itemize
13124 \begin_inset space \thinspace{}
13131 \begin_layout Itemize
13136 \begin_layout Itemize
13137 PAN — camera movement
13140 \begin_layout Itemize
13141 INSERT — cut to close-up of
13144 \begin_layout Section
13146 \change_deleted 564990737 1669755802
13150 \begin_layout Standard
13152 \change_deleted 564990737 1669755802
13155 Panayotis Papasotiriou
13158 \begin_layout Subsection
13160 \change_deleted 564990737 1669755802
13164 \begin_layout Standard
13166 \change_deleted 564990737 1669755802
13167 The ijmpc package is a set of macros that facilitates electronic manuscript
13170 International Journal of Modern Physics C
13173 Similarly, the ijmpd package is for creating manuscripts to be submitted
13176 International Journal of Modern Physics D
13179 Both journals are published by World Scientific.
13180 The corresponding document classes are named
13189 These files, together with instructions for the authors, can be downloaded
13191 \begin_inset Flex URL
13194 \begin_layout Plain Layout
13196 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
13202 \begin_inset Flex URL
13205 \begin_layout Plain Layout
13207 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
13213 Both packages are modified versions of the standard
13214 \begin_inset Quotes eld
13218 \begin_inset Quotes erd
13221 package, and they are almost (but not exactly) identical.
13222 Most of their features are supported by \SpecialChar LyX
13224 I have used \SpecialChar LyX
13225 successfully to write articles submitted to both journals
13226 without any problem.
13229 \begin_layout Subsection
13231 \change_deleted 564990737 1669755802
13235 \begin_layout Standard
13237 \change_deleted 564990737 1669755802
13238 As usual, the easiest way to write a paper is to start with a template.
13241 File\SpecialChar menuseparator
13257 This will give an (almost) empty document that includes the most common
13258 fields found in a manuscript.
13259 Simply overwrite the existing text (including the brackets,
13264 You should keep in mind the following remarks.
13267 \begin_layout Enumerate
13269 \change_deleted 564990737 1669755802
13271 won't let you change the font size and the page style of the document,
13272 because such modifications are not allowed by both packages.
13275 \begin_layout Enumerate
13277 \change_deleted 564990737 1669755802
13278 The language of the document should not be changed.
13279 Before previewing your paper, be sure that the babel package is not used.
13280 To do this, click on
13283 arg "dialog-show document"
13288 \SpecialChar menuseparator
13292 \begin_inset Quotes eld
13296 \begin_inset Quotes erd
13306 \begin_layout Enumerate
13308 \change_deleted 564990737 1669755802
13310 \begin_inset Quotes eld
13314 \begin_inset Quotes erd
13317 style must be used to define keywords.
13320 \begin_layout Enumerate
13322 \change_deleted 564990737 1669755802
13323 The ijmpc package provides a style named
13324 \begin_inset Quotes eld
13327 Classification Codes
13328 \begin_inset Quotes erd
13331 , which can be used to define classification codes, such as PACS numbers.
13332 Note that this facility is not supported by the ijmpd package.
13335 \begin_layout Enumerate
13337 \change_deleted 564990737 1669755802
13338 Several new environments are available:
13339 \begin_inset Quotes eld
13343 \begin_inset Quotes erd
13347 \begin_inset Quotes eld
13351 \begin_inset Quotes erd
13355 \begin_inset Quotes eld
13359 \begin_inset Quotes erd
13363 \begin_inset Quotes eld
13367 \begin_inset Quotes erd
13371 \begin_inset Quotes eld
13375 \begin_inset Quotes erd
13379 \begin_inset Quotes eld
13383 \begin_inset Quotes erd
13387 \begin_inset Quotes eld
13391 \begin_inset Quotes erd
13395 \begin_inset Quotes eld
13399 \begin_inset Quotes erd
13403 \begin_inset Quotes eld
13407 \begin_inset Quotes erd
13411 \begin_inset Quotes eld
13415 \begin_inset Quotes erd
13419 \begin_inset Quotes eld
13423 \begin_inset Quotes erd
13427 \begin_inset Quotes eld
13431 \begin_inset Quotes erd
13435 \begin_inset Quotes eld
13439 \begin_inset Quotes erd
13443 \begin_inset Quotes eld
13447 \begin_inset Quotes erd
13451 Their use is more or less obvious.
13453 supports all these environments; it will use the proper label, text style,
13454 and numbering scheme for each of them.
13457 \begin_layout Enumerate
13459 \change_deleted 564990737 1669755802
13460 Both packages use basic citations; the natbib package should not be used.
13461 In \SpecialChar LyX
13462 , citation references are shown as usual; in the output, citations are
13463 shown as superscripts.
13464 If you want to use a citation as normal text, you should use the
13469 \begin_inset space \thinspace{}
13473 \begin_inset space \space{}
13477 \begin_inset Quotes eld
13481 \begin_inset space \space{}
13491 \begin_inset Quotes erd
13497 \begin_layout Enumerate
13499 \change_deleted 564990737 1669755802
13501 \begin_inset Quotes eld
13505 \begin_inset Quotes erd
13508 section in both packages.
13509 To put acknowledgments, just use the
13510 \begin_inset Quotes eld
13514 \begin_inset Quotes erd
13520 \begin_layout Enumerate
13522 \change_deleted 564990737 1669755802
13523 Appendices may be added to the paper,
13527 the Acknowledgments and
13533 provides a special environment, called
13534 \begin_inset Quotes eld
13538 \begin_inset Quotes erd
13541 which marks the beginning of the appendices.
13542 This environment should be left blank; it just sends a \SpecialChar LaTeX
13543 command, but nothing
13545 In \SpecialChar LyX
13547 \begin_inset Quotes eld
13551 \begin_inset Quotes erd
13554 is printed with blue letters, as a signal that all sections after that
13555 point are appendices.
13556 To write an appendix, use the
13557 \begin_inset Quotes eld
13561 \begin_inset Quotes erd
13566 will number each appendix with capital letters, as required by both journals.
13568 \begin_inset Quotes eld
13572 \begin_inset Quotes erd
13579 be present before the first appendix; if not, all appendices will be numbered
13580 as normal sections in the output.
13583 \begin_layout Enumerate
13585 \change_deleted 564990737 1669755802
13586 The ijmpc and the ijmpd packages use the
13590 command to implement table captions.
13591 As a result, a table created by \SpecialChar LyX
13592 is printed correctly, but its caption
13594 However, you can use some \SpecialChar TeX
13595 code to overcome this problem, so that captions
13596 are printed as expected.
13597 To do so, create a float table as usual, remove the caption, and replace
13598 it with the \SpecialChar TeX
13609 (sic); you must also the \SpecialChar TeX
13614 immediately after the tabular material.
13615 Study the example table included in the template files to see how this
13616 trick is implemented.
13617 Alternatively, If you need table captions, you should implement the whole
13622 file, then include this file to the \SpecialChar LyX
13625 Insert\SpecialChar menuseparator
13626 File\SpecialChar menuseparator
13628 \begin_inset space ~
13634 Details on how to create a table float can be found in the files
13642 , included in the corresponding packages.
13645 \begin_layout Subsection
13647 \change_deleted 564990737 1669755802
13648 Preparing a paper for submission
13651 \begin_layout Standard
13653 \change_deleted 564990737 1669755802
13654 Before you submit your paper you must export the \SpecialChar LyX
13655 document as a \SpecialChar LaTeX
13658 File\SpecialChar menuseparator
13659 Export\SpecialChar menuseparator
13667 \begin_layout Plain Layout
13668 Actually you have the choice between \SpecialChar LaTeX
13669 (plain) and pdflatex.
13670 If you intend to use pdflatex to prepare the paper, you should use the
13671 pdflatex option so that included graphics are converted to PDF format,
13672 ready for use by pdflatex.
13677 , then make the following changes to the resulting
13684 \begin_layout Enumerate
13686 \change_deleted 564990737 1669755802
13687 Remove the comment lines before the
13696 \begin_layout Enumerate
13698 \change_deleted 564990737 1669755802
13699 Remove everything between (and including) the
13711 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13715 \begin_layout Standard
13717 \change_deleted 564990737 1669755802
13722 file should be saved and processed through \SpecialChar LaTeX
13723 as many times as necessary.
13724 You may also want to check the resulting
13733 \begin_layout Section
13735 \change_deleted 564990737 1669801478
13739 \begin_layout Standard
13741 \change_deleted 564990737 1669801478
13747 \begin_layout Subsection
13749 \change_deleted 564990737 1669801478
13753 \begin_layout Standard
13755 \change_deleted 564990737 1669801478
13756 The iopart package provides a document class to create electronic manuscript
13757 submission to the journals published by the Institute of Physics.
13758 Instructions for the authors how to create a paper using the iopart class
13759 can be downloaded together with the iopart package from the site
13760 \begin_inset Flex URL
13763 \begin_layout Plain Layout
13765 ftp://ftp.iop.org/pub/journals/latex2e
13773 \begin_layout Subsection
13775 \change_deleted 564990737 1669801478
13779 \begin_layout Standard
13781 \change_deleted 564990737 1669801478
13782 The easiest way to write a paper is to start with the template
13786 that is available via
13788 File\SpecialChar menuseparator
13791 The template explains how to use the special text environments.
13792 Here are the most important advices:
13795 \begin_layout Itemize
13797 \change_deleted 564990737 1669801478
13798 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13799 no AMS packages are loaded in
13801 Document\SpecialChar menuseparator
13802 Settings\SpecialChar menuseparator
13808 \begin_layout Itemize
13810 \change_deleted 564990737 1669801478
13813 The title environment defines the kind of your paper.
13814 So use one of the following environments for the title:
13818 \begin_layout Itemize
13820 \change_deleted 564990737 1669801478
13829 \begin_layout Itemize
13831 \change_deleted 564990737 1669801478
13840 \begin_layout Itemize
13842 \change_deleted 564990737 1669801478
13848 for a Topical review
13851 \begin_layout Itemize
13853 \change_deleted 564990737 1669801478
13862 \begin_layout Itemize
13864 \change_deleted 564990737 1669801478
13873 \begin_layout Itemize
13875 \change_deleted 564990737 1669801478
13881 for a Paper (same as Title)
13884 \begin_layout Itemize
13886 \change_deleted 564990737 1669801478
13892 for a Preliminary communication
13895 \begin_layout Itemize
13897 \change_deleted 564990737 1669801478
13903 for a Rapid communication
13906 \begin_layout Itemize
13908 \change_deleted 564990737 1669801478
13914 for a Letter to the editor
13918 \begin_layout Itemize
13920 \change_deleted 564990737 1669801478
13923 All title environments except of
13927 can have an optional short title.
13930 \begin_layout Itemize
13932 \change_deleted 564990737 1669801478
13933 There is a general title environment
13937 which is not directly supported by \SpecialChar LyX
13939 This can be used as \SpecialChar TeX
13940 code when your document doesn't fit into one of the
13944 \begin_layout Standard
13946 \change_deleted 564990737 1669801478
13947 For more informations like hints for special table and formula formatting,
13948 look at the IOP author guidelines.
13953 \begin_layout Section
13955 \change_deleted 564990737 1670317155
13959 \begin_layout Standard
13961 \change_deleted 564990737 1670317155
13964 Panayotis Papasotiriou
13967 \begin_layout Subsection
13969 \change_deleted 564990737 1670317155
13973 \begin_layout Standard
13975 \change_deleted 564990737 1670317155
13976 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13977 that facilitates electronic manuscript submission to the journals they
13979 Most known of them (at least in my domain of interest) are
13981 Astrophysics and Space Science
13987 , but there are many others (see a complete list at
13988 \begin_inset Flex URL
13991 \begin_layout Plain Layout
13993 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13999 The Kluwer package may be downloaded from the site
14000 \begin_inset Flex URL
14003 \begin_layout Plain Layout
14005 http://www.wkap.nl/kaphtml.htm/STYLEFILES
14011 A complete user guide is contained in that package (but it can also be
14012 downloaded separately).
14015 \begin_layout Standard
14017 \change_deleted 564990737 1670317155
14019 supports many features of the package but not everything.
14020 However, the \SpecialChar TeX
14021 code needed is reduced to some
14022 \begin_inset Quotes eld
14026 \begin_inset Quotes erd
14029 commands of the package (see
14030 \begin_inset space ~
14034 \begin_inset CommandInset ref
14036 reference "subsec:kluwer_peculiarities"
14041 I have recently used \SpecialChar LyX
14042 to write an article submitted to the
14044 Astrophysics and Space Science
14046 without any problem.
14049 \begin_layout Subsection
14051 \change_deleted 564990737 1670317155
14055 \begin_layout Standard
14057 \change_deleted 564990737 1670317155
14058 The easiest way to write a paper is to start with the Kluwer template file.
14061 File\SpecialChar menuseparator
14073 This will give an (almost) empty document that includes the most common
14074 fields found in a manuscript and a short description of their use.
14075 As in most templates, simply overwrite the existing text (including the
14080 ) with the correct information.
14083 \begin_layout Subsection
14085 \change_deleted 564990737 1670317155
14086 Preparing a paper for submission
14089 \begin_layout Standard
14091 \change_deleted 564990737 1670317155
14092 As in the AAS\SpecialChar TeX
14093 package, before you submit your paper to a journal you must
14095 \begin_inset Quotes eld
14099 \begin_inset Quotes erd
14105 \begin_layout Enumerate
14107 \change_deleted 564990737 1670317155
14108 Export your paper as a \SpecialChar LaTeX
14110 To do this, click on
14112 File\SpecialChar menuseparator
14113 Export\SpecialChar menuseparator
14121 \begin_layout Enumerate
14123 \change_deleted 564990737 1670317155
14128 file with a text editor and make the following changes
14132 \begin_layout Enumerate
14134 \change_deleted 564990737 1670317155
14135 remove the comment lines before the
14144 \begin_layout Enumerate
14146 \change_deleted 564990737 1670317155
14147 remove everything between (and including) the
14159 commands, except for any commands you specifically put into the \SpecialChar LaTeX
14163 \begin_layout Standard
14165 \change_deleted 564990737 1670317155
14174 \begin_layout Enumerate
14176 \change_deleted 564990737 1670317155
14181 file through \SpecialChar LaTeX
14182 as many times as necessary (usually up to three).
14185 \begin_layout Enumerate
14187 \change_deleted 564990737 1670317155
14193 \begin_inset space \thinspace{}
14197 \begin_inset space \space{}
14204 , and check if everything is OK (it should, if you didn't make any mistake).
14207 \begin_layout Subsection
14209 \change_deleted 564990737 1670317155
14210 \begin_inset Quotes eld
14214 \begin_inset Quotes erd
14217 of the Kluwer package
14218 \begin_inset CommandInset label
14220 name "subsec:kluwer_peculiarities"
14227 \begin_layout Standard
14229 \change_deleted 564990737 1670317155
14230 The Kluwer package has the following
14231 \begin_inset Quotes eld
14235 \begin_inset Quotes erd
14241 \begin_layout Enumerate
14243 \change_deleted 564990737 1670317155
14244 It is possible to write multiple articles in the same \SpecialChar LaTeX
14249 \begin_layout Plain Layout
14250 I can't imagine any good reason to do this.
14256 Each article must be included in the environment
14257 \begin_inset Quotes eld
14261 \begin_inset Quotes erd
14265 Unfortunately, this environment cannot be omitted, even if you write just
14267 Therefore, each article starts with the command
14273 and, obviously, ends with the command
14280 Although this can be implemented in \SpecialChar LyX
14281 , I didn't included it, since it looks
14282 ugly and can confuse the novice user.
14283 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
14286 \begin_inset Quotes eld
14291 \begin_inset Quotes erd
14297 \begin_layout Enumerate
14299 \change_deleted 564990737 1670317155
14300 Information given at the beginning of the article (i.
14301 \begin_inset space \thinspace{}
14305 \begin_inset space \space{}
14308 title, subtitle, author, institution, running title, running author, abstract
14309 and keywords) must be included in an environment called
14310 \begin_inset Quotes eld
14314 \begin_inset Quotes erd
14318 This is not implemented in \SpecialChar LyX
14319 , so you must enter title, subtitle etc.
14320 \begin_inset space ~
14323 between two \SpecialChar TeX
14339 \begin_layout Enumerate
14341 \change_deleted 564990737 1670317155
14342 According to the user manual, the label of each bibliography item must be
14366 \begin_layout Standard
14368 \change_deleted 564990737 1670317155
14373 template takes care of all these
14374 \begin_inset Quotes eld
14378 \begin_inset Quotes erd
14382 If you start a new paper using this template you don't need to do anything
14387 \begin_layout Enumerate
14389 \change_deleted 564990737 1670317155
14390 don't delete the \SpecialChar TeX
14391 code included in the template, and
14394 \begin_layout Enumerate
14396 \change_deleted 564990737 1670317155
14397 copy the example bibliography item included in the template and modify it
14398 as necessary to enter new bibliography items.
14401 \begin_layout Section
14405 \begin_layout Standard
14411 \begin_layout Subsection
14415 \begin_layout Standard
14416 The \SpecialChar LyX
14419 article (koma-script)
14423 report (koma-script)
14441 correspond to the \SpecialChar LaTeX
14459 \begin_inset space ~
14462 of the Koma-Script family.
14463 They are replacements for the standard document classes
14479 , resp., and fit better to European typography conventions in a number of
14483 \begin_layout Itemize
14484 Standard character size is 11pt in
14486 article (koma-script)
14490 report (koma-script)
14498 letter (koma-script)
14503 \begin_layout Itemize
14504 Headings, labels of the description environment, and a number of elements
14507 letter (koma-script)
14509 document class are set in a bold sans serif font.
14513 \begin_layout Plain Layout
14514 There is a big difference between the bold sans serif old cm fonts and new
14515 ec fonts, especially in the appearance of headings.
14516 In comparison, the ec bold sans serif fonts look a bit thin.
14517 Here the \SpecialChar LaTeX
14526 helps to produce the
14527 \begin_inset Quotes eld
14531 \begin_inset Quotes erd
14534 appearance when using the ec fonts.
14539 The numbering of chapter headings is made in the same way as the numbering
14540 of section headings, that is without the extra line
14541 \begin_inset Quotes eld
14544 Chapter\SpecialChar ldots
14546 \begin_inset Quotes erd
14550 In addition, the appearance of the headings can be modified by using a
14551 number of options (in \SpecialChar LyX
14552 to be entered in the field
14555 \begin_inset space ~
14562 Layout\SpecialChar menuseparator
14569 \begin_layout Itemize
14570 The main means in the Koma-Script document classes to design the type area
14579 (in \SpecialChar LyX
14580 to be entered in the extra class options field in the dialog
14582 Document\SpecialChar menuseparator
14586 They make a clearer modification of page margins possible as do the options
14589 Document\SpecialChar menuseparator
14596 \begin_layout Itemize
14597 The \SpecialChar LaTeX
14598 document classes of the Koma-Script family define a number of additional
14600 Those part of it which makes sense in \SpecialChar LyX
14601 is implemented in corresponding
14605 \begin_layout Standard
14606 Detailed descriptions of the \SpecialChar LaTeX
14607 document classes of the Koma-Script family
14608 can be found in the Koma-Script documentation
14619 \begin_layout Subsection
14620 article (koma-script), report (koma-script), and book (koma-script)
14623 \begin_layout Standard
14624 The document classes
14626 article (koma-script)
14630 report (koma-script)
14640 are implemented in the layout files
14653 They contain all the paragraph types of the corresponding standard document
14666 , resp., partly modified, with the exception of the \SpecialChar LyX
14671 -type, which is replaced by the new
14675 -type having the same functionality.
14680 -Type there is a number of new paragraph types added.
14687 letter (koma-script)
14692 \begin_layout Itemize
14701 : are equivalents to
14709 , resp., additionally inserting an entry in the table of contents.
14718 are not contained in
14720 article (koma-script)
14725 \begin_layout Itemize
14734 : behave exactly as
14742 , resp., additionally clearing running heads.
14747 is not contained in
14749 article (koma-script)
14755 \begin_layout Plain Layout
14768 report (koma-script)
14770 , but since this is identical to
14774 , is has not been implemented in \SpecialChar LyX
14783 \begin_layout Itemize
14788 : generates a heading directly above the following paragraph in the standard
14789 character size without affecting the structure of the document.
14792 \begin_layout Itemize
14801 are special captions which respect the different space settings needed
14802 for captions placed above or below an element (if you follow strict typographic
14803 rules, you might want to place table captions always above the table).
14804 You can also use the class option
14808 , which will switch
14821 You need at least Koma-Script version 2.8q to use this.
14824 \begin_layout Itemize
14829 : can be used to set a bonmot, e.
14830 \begin_inset space \thinspace{}
14834 \begin_inset space \space{}
14837 at the beginning of a chapter.
14838 If you use the optional argument (
14840 Insert\SpecialChar menuseparator
14842 \begin_inset space ~
14847 ), you can insert the dictum's author there.
14848 Dictum and author are separated by a line.
14849 You need at least Koma-Script version 2.8q to use this.
14854 is not contained in
14856 article (koma-script)
14861 \begin_layout Standard
14862 The following types, together with the standard types
14874 , form the title area of the document.
14875 They must be entered ahead of the first
14876 \begin_inset Quotes eld
14880 \begin_inset Quotes erd
14887 \begin_layout Plain Layout
14888 The corresponding \SpecialChar LaTeX
14889 commands must appear before the
14900 When such a type is used more than once, the latter usage overwrites the
14901 former one, that means, for every type only the latest usage is valid.
14902 The order of the different types however has, like
14914 , no effect on the appearance of the produced document.
14917 \begin_layout Itemize
14922 : produces a centered paragraph above the ordinary title (
14934 ) for the subject of the document.
14937 \begin_layout Itemize
14942 : produces a centered paragraph below the ordinary title (
14954 ) for the publishers' name.
14957 \begin_layout Itemize
14964 report (koma-script)
14970 produces a centered paragraph on its own page behind the title page, or
14973 article (koma-script)
14975 produces a centered paragraph below the ordinary title (
14991 ) for a dedication.
14994 \begin_layout Itemize
14999 : produces a left aligned paragraph above the ordinary title (
15015 ) for a document`s head.
15018 \begin_layout Itemize
15023 : produces in a double-sided print in
15025 report (koma-script)
15031 a left-aligned paragraph at the top of the title page`s back or has no
15032 effect in a single-sided print or in
15034 article (koma-script)
15039 \begin_layout Itemize
15044 : produces in a double-sided print in
15046 report (koma-script)
15052 a left-aligned paragraph at the bottom of the title page`s back or has
15053 no effect in a single-sided print or in
15055 article (koma-script)
15060 \begin_layout Itemize
15065 : produces a special
15066 \begin_inset Quotes eld
15070 \begin_inset Quotes erd
15073 page ahead of the actual document containing a paragraph without special
15077 \begin_layout Standard
15078 The layout files for the document classes
15080 article (koma-script)
15084 report (koma-script)
15090 do include the file
15095 This is thought of as a place to define your own types.
15100 in your personal layout directory and edit the file!
15103 \begin_layout Subsection
15104 letter (koma-script)
15107 \begin_layout Description
15108 Note: This section discusses the obsolete
15110 KOMA-Script-Letter (v.
15111 \begin_inset space ~
15116 , which is not even included anymore in recent KOMA releases.
15117 Please refer to the next section for the current KOMA-Script-Letter class
15119 \begin_inset space ~
15125 \begin_layout Standard
15129 letter (koma-script)
15131 is implemented in the layout file
15136 It contains all the paragraph types of the corresponding standard document
15141 , partly modified, with the exception of the \SpecialChar LyX
15155 type, which is replaced by the new
15160 In addition, it contains, in contrast to the standard document class, the
15179 Furthermore, there are a number of new letter specific types.
15182 \begin_layout Standard
15183 The appearance of the letter produced by this document class can be controlled
15184 by a number of \SpecialChar LaTeX
15185 commands, which you can put in the \SpecialChar LaTeX
15190 \begin_layout Plain Layout
15191 For example, the standard appearance of the letter`s heading, consisting
15192 of name and address, is quite self-willed.
15194 \begin_inset Quotes eld
15198 \begin_inset Quotes erd
15201 heading is produced by the following \SpecialChar LaTeX
15202 commands in the preamble:
15205 \begin_layout LyX-Code
15215 \begin_layout LyX-Code
15231 \begin_layout LyX-Code
15241 \begin_layout LyX-Code
15261 A detailed German description of such \SpecialChar LaTeX
15262 commands can be found in the Koma-Script
15268 With it, the letter's author can produce his personal letter layout.
15271 \begin_layout Standard
15280 define the beginning of the letter and must be used in every letter.
15281 To emphasize them in the \SpecialChar LyX
15282 document class, they are marked with the letter
15292 \begin_inset space ~
15295 in the left margin.
15296 It is possible to write any number of letters in one file.
15301 type produces a new letter using the same addressee and a
15305 type produces a new addressee.
15322 are ordinary paragraph types and can also be used several times in one
15323 and the same letter.
15326 \begin_layout Itemize
15331 : produces a paragraph for the addressee and implicitly defines the beginning
15335 \begin_layout Itemize
15340 : produces a paragraph for the form of address and implicitly produces a
15344 \begin_layout Itemize
15349 : produces a paragraph for a close.
15352 \begin_layout Itemize
15357 : produces a paragraph for a postscript.
15360 \begin_layout Itemize
15365 : produces a paragraph for a distribution list.
15368 \begin_layout Itemize
15373 : produces a paragraph for enclosures.
15376 \begin_layout Standard
15417 are input types provided with a label to enter information, which will
15418 be processed by the document class.
15422 \begin_layout Plain Layout
15423 It could be seen as a matter of inconsequence, that the types
15431 described above are not such input types as well.
15432 Because of the special meaning of those types, however, I have implemented
15433 them as ordinary paragraph types with a one letter mark in the left margin.
15434 Moreover, it would affect my feeling of symmetry, if the
15442 type had such a serious different appearance.
15447 The types must be used ahead of the corresponding
15454 \begin_layout Standard
15455 An implementation of these types in a WYSIWYG fashion does not seem to make
15456 sense, because the real appearance of the produced letter does not only
15457 depend on the usage of the particular type, but also on other factors.
15458 For example, a signature entered in the
15462 type will in the standard behavior appear in the produced letter only,
15463 when in the same letter also a
15468 The entered value of the
15472 type will in the standard behavior not appear in the produced letter at
15474 The possibility to design the letter`s heading freely is already indicated
15475 in a footnote above.
15478 \begin_layout Standard
15479 The input types can also be used as empty paragraphs.
15480 This makes sense e.
15481 \begin_inset space \thinspace{}
15485 \begin_inset space \space{}
15497 type is not used at all, in the standard behavior the value of the
15501 type is used as signature, whereas if an empty
15505 type is used, no signature value is defined.
15508 \begin_layout Standard
15509 By using the input types it is possible to write a letter template, containing
15510 filled input types with your personal dates (name, address, etc.) and empty
15511 input types for other dates you want to enter.
15514 \begin_layout Itemize
15519 : sender's name, in the standard behavior appears as a centered paragraph
15520 in small caps in the letter`s heading.
15523 \begin_layout Itemize
15528 : sender's signature, in the standard behavior appears below the
15537 type is used, the value of the
15541 type appears instead.
15544 \begin_layout Itemize
15549 : sender's address, in the standard behavior appears in a centered paragraph
15550 in the letter`s heading below the sender's name.
15553 \begin_layout Itemize
15558 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15569 \begin_layout Itemize
15574 : place of the letter`s making.
15577 \begin_layout Itemize
15582 : date of the letter`s making.
15591 , in the standard behavior, produce the place and the date in a right-aligned
15592 line below the addressee's field.
15597 type is used, neither place nor date appear, independent of the value of
15607 type is used, the date of the letter `s production is used.
15610 \begin_layout Itemize
15615 : sender`s back address, in the standard behavior appears above the addressee's
15616 field in a small sans serif font.
15619 \begin_layout Itemize
15624 : special mail information, in the standard behavior appears underlined
15625 above the addressee's field below the back address.
15628 \begin_layout Itemize
15633 : additional information, in the standard behavior appears on right side
15634 below the addressee`s field.
15637 \begin_layout Itemize
15642 : the letter's title, in the standard behavior appears in a big, bold, sans
15643 serif font above the subject.
15646 \begin_layout Itemize
15651 : the letter's subject, in the standard behavior appears in a bold font
15659 \begin_layout Standard
15680 produce a business letter like line above the
15684 line containing the fields
15685 \begin_inset Quotes eld
15689 \begin_inset Quotes erd
15693 \begin_inset Quotes eld
15697 \begin_inset Quotes erd
15701 \begin_inset Quotes eld
15705 \begin_inset Quotes erd
15709 \begin_inset Quotes eld
15713 \begin_inset Quotes erd
15717 \begin_inset Quotes eld
15721 \begin_inset Quotes erd
15725 \begin_inset Quotes eld
15729 \begin_inset Quotes erd
15733 For the date field, the value of the
15739 \begin_inset Quotes eld
15742 business letter types
15743 \begin_inset Quotes erd
15746 is used, the value of the
15750 type however does not appear, but only the \SpecialChar LaTeX
15758 The ordinary output of place and date in a right-aligned line below the
15759 addressee`s field is suppressed.
15760 The types are implemented as input types provided with a label and must
15761 be used ahead of the corresponding
15768 \begin_layout Itemize
15776 \begin_layout Itemize
15784 \begin_layout Itemize
15792 \begin_layout Itemize
15800 \begin_layout Itemize
15808 \begin_layout Subsection
15809 The new letter class: letter (koma-script v.2)
15812 \begin_layout Standard
15818 \begin_layout Standard
15819 \begin_inset VSpace medskip
15825 \begin_layout Standard
15827 Koma-Script version 2.8 has introduced a new letter class
15831 which supersedes the now unsupported
15836 It has — on the \SpecialChar LaTeX
15837 side — a completely new interface and is not compatible
15838 with the old class.
15839 Therefore, \SpecialChar LyX
15840 supports both, though it is recommended you use the new class.
15843 \begin_layout Standard
15844 This class covers the same functionality as
15846 letter (koma-script),
15849 The basic items are
15853 (receiver's address, same as
15857 in the old layout),
15870 will start a new letter (i.
15871 \begin_inset space \thinspace{}
15875 \begin_inset space \space{}
15878 you can write several letters per document).
15879 New elements are sender's
15895 and the possibility to use a
15901 Insert\SpecialChar menuseparator
15907 \begin_layout Standard
15908 The biggest improvement is, though, that the letter's layout is configurable
15909 to meet almost any needs.
15910 This can be done via the preamble or with a special style file (Letter
15911 Class Option, extension
15915 ), that will be read in as a class option.
15919 \begin_layout Plain Layout
15920 The KOMA package comes with some default
15925 There is, for instance, a
15929 file that follows german typesetting rules, or a
15933 that provides the default layout of the old
15938 The latter can be loaded with the class option
15944 Layout\SpecialChar menuseparator
15945 Document\SpecialChar menuseparator
15957 template that is included in \SpecialChar LyX
15959 A detailed description is to be found in the Koma-Script documentation
15967 \begin_layout Subsection
15971 \begin_layout Standard
15972 Visualizing the Koma-Script document classes in \SpecialChar LyX
15973 , the \SpecialChar LyX
15974 internals cause some
15978 \begin_layout Itemize
15979 The chapter number of a
15983 type appears on a line of its own above the chapter heading instead of
15984 appearing in the same line ahead of it.
15985 The cause for that is the \SpecialChar LyX
15986 internal behavior for the labeltype
15990 in the layout file.
15993 \begin_layout Itemize
15994 The headings of the types
16002 are only put in the
16003 \begin_inset Quotes eld
16007 \begin_inset Quotes erd
16011 table of contents, but not in the \SpecialChar LyX
16012 table of contents (
16014 Document\SpecialChar menuseparator
16016 \begin_inset space ~
16020 \begin_inset space ~
16028 \begin_layout Itemize
16029 The paragraphs in a
16033 document class appear in a skip separation mode, not indented.
16034 This is the standard behavior, no special \SpecialChar LaTeX
16035 commands are needed for that.
16038 Document\SpecialChar menuseparator
16041 dialog the corresponding radio button indicates
16050 value always has the effect that extra \SpecialChar LaTeX
16051 commands are inserted in the document
16052 to produce the gap, which is not what is wanted in this case.
16055 \begin_layout Section
16059 \begin_layout Standard
16065 \begin_layout Subsection
16069 \begin_layout Standard
16070 Memoir is a very powerful and constantly evolving class.
16071 It has been designed with regard to fictional and non-fictional literature.
16072 Its aim is to let the user have maximum control over the typesetting of
16074 Memoir is based on the standard book class, but it can also emulate the
16075 article class (see below).
16078 \begin_layout Standard
16079 Peter Wilson, the developer of Memoir, is known as the author of lots of
16080 useful packages in the \SpecialChar LaTeX
16082 Most of them have been merged with Memoir.
16083 Therefore, it is much easier to layout the table of contents, appendices,
16084 chapter designs and such.
16086 , though, does not support all of these goodies natively.
16087 Some of them might be added to forthcoming releases
16091 \begin_layout Plain Layout
16092 You are invited to send suggestions to
16093 \begin_inset Flex URL
16096 \begin_layout Plain Layout
16098 lyx-devel@lists.lyx.org
16108 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
16110 Of course you can still use all features with the help of some native \SpecialChar LaTeX
16112 commands (\SpecialChar TeX
16117 \begin_layout Plain Layout
16122 \begin_layout Plain Layout
16132 \begin_inset space ~
16136 \begin_inset CommandInset ref
16138 reference "sec:Inserting-TeX-Code"
16148 In this section, we can only list those features that are natively supported
16149 by \SpecialChar LyX
16151 For detailed descriptions (and for the rest of features) we recommend you
16152 have a look at the detailed manual of the Memoir class
16156 \begin_layout Plain Layout
16161 \begin_layout Plain Layout
16171 \begin_inset Flex URL
16174 \begin_layout Plain Layout
16176 CTAN:/macros/latex/memoir/memman.pdf
16186 , which is not only a user guide for the class, but also both a comprehensive
16187 description on good typesetting and a superb example for good typesetting
16191 \begin_layout Subsection
16192 Basic features and restrictions
16195 \begin_layout Standard
16196 Memoir supports basically all features of the standard book classes.
16197 There are, however, some differences, as follows:
16200 \begin_layout Description
16202 \begin_inset space ~
16205 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
16208 \begin_layout Description
16210 \begin_inset space ~
16213 style: The fancy page style is not supported, due to a command clash between
16214 Memoir and the fancyhdr package (they both define a command with the same
16215 name, which confuses \SpecialChar LaTeX
16217 Instead, Memoir comes with a number of its own page styles (see
16219 Document\SpecialChar menuseparator
16220 Settings\SpecialChar menuseparator
16222 \begin_inset space ~
16228 If you want to use these for the chapter pages, you have to use the command
16235 in the main text or in preamble (e.
16236 \begin_inset space \thinspace{}
16240 \begin_inset space \space{}
16247 chapterstyle{companion}
16252 \begin_layout Description
16253 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
16254 optional argument in the standard classes.
16255 With this, you can specify an alternative version of the title for the
16256 table of contents and the headers (for instance, if the title is too long).
16257 In \SpecialChar LyX
16258 , you can do this via
16260 Insert\SpecialChar menuseparator
16262 \begin_inset space ~
16267 at the beginning of a chapter/section.
16268 Memoir features a second optional argument and thus separates the table
16269 of contents from the header.
16270 You can define three variants of a title with this: one for the main text,
16271 one for the table of contents, and one for the headers.
16273 makes these available in form of specific
16284 \begin_layout Description
16285 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
16286 of contents, the list of figures and the list of table start a new page
16288 Memoir does not follow this route.
16289 You have to insert a page break yourself, if you want to have one.
16292 \begin_layout Description
16293 Titlepage: For some unknown reason, Memoir uses pagination on the title
16294 page (in the standard classes, title pages are
16295 \begin_inset Quotes eld
16299 \begin_inset Quotes erd
16303 If you want an empty title page, type
16307 aliaspagestyle{title}{empty}
16312 \begin_layout Description
16313 Article: With the class option
16319 Document\SpecialChar menuseparator
16320 Settings\SpecialChar menuseparator
16321 Class Settings\SpecialChar menuseparator
16323 \begin_inset space ~
16328 ), you can emulate article style.
16329 That is, counters (footnotes, figures, tables etc.) will not be reset on
16330 new chapters, chapters don't start a new page (but are—in contrary to
16331 \begin_inset Quotes eld
16335 \begin_inset Quotes erd
16338 article classes—still allowed), parts, though, use their own page, as in
16342 \begin_layout Description
16343 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
16344 font commands, which have been used in the old \SpecialChar LaTeX
16346 \begin_inset space \thinspace{}
16350 \begin_inset space \space{}
16366 It produces an error and stops \SpecialChar LaTeX
16367 whenever such a command appears.
16372 reallows the commands and spits out warnings instead (which does at least
16373 not stop \SpecialChar LaTeX
16375 Since a lot of packages and particularly Bib\SpecialChar TeX
16376 style files are still using
16377 those commands, we have decided to use this option by default.
16380 \begin_layout Subsection
16384 \begin_layout Standard
16385 We will only describe the features supported by \SpecialChar LyX
16386 (which is not much currently).
16387 Please consult the Memoir manual
16391 \begin_layout Plain Layout
16396 \begin_layout Plain Layout
16406 \begin_inset Flex URL
16409 \begin_layout Plain Layout
16411 CTAN:/macros/latex/memoir/memman.pdf
16424 \begin_layout Description
16425 Abstract: You may wonder why an abstract is an extra feature.
16426 Well, it is in book class.
16427 Usually books don't have abstracts.
16428 Memoir, however, has.
16429 You can use it wherever and how often you like.
16432 \begin_layout Description
16433 Chapterprecis: You may know this older typesetting style: The contents of
16434 a chapter are summarized below the title and also in the table of contents
16436 \begin_inset space \thinspace{}
16440 \begin_inset space \space{}
16445 Our hero arrives in Troia; he loses some friends; he finds others
16448 Chapterprecis does exactly this.
16449 It is therefore only sensible below a chapter.
16452 \begin_layout Description
16453 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16454 The epigraph environment provides an elegant way of typesetting such a
16456 The motto itself (text) and its (optional) author (source) are divided
16458 The author (source) can be inserted via
16460 Insert\SpecialChar menuseparator
16467 \begin_layout Description
16468 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16469 complex figurative poems).
16471 can only support a few of them.
16472 One is poemtitle, which is a centered title for poems, which will also
16473 be added to the table of contents (verse is the standard environment for
16475 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16477 because they have to be nested inside regular verse environments, which
16478 is not possible with \SpecialChar LyX
16482 \begin_layout Description
16483 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
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