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
2328 \begin_layout Section
2329 Customizing Bibliographies with Bib\SpecialChar TeX
2333 \begin_layout Standard
2334 The most basic information about how to use Bib\SpecialChar TeX
2339 with \SpecialChar LyX
2340 is contained in the section
2342 Bibliography databases
2349 The following subsections explain special bibliography features supported
2354 \begin_layout Subsection
2355 Alternative Citation Styles
2358 \begin_layout Standard
2359 Standard Bib\SpecialChar TeX
2361 \begin_inset space \thinspace{}
2365 \begin_inset space \space{}
2369 \begin_inset Quotes eld
2373 \begin_inset Quotes erd
2376 ) to refer to a cited work.
2377 However, in many scientific disciplines, other citation styles are in use.
2378 The most common one is the author-year style (e.
2379 \begin_inset space \thinspace{}
2383 \begin_inset space \space{}
2387 \begin_inset Quotes eld
2391 \begin_inset Quotes erd
2396 supports three packages that provide this style,
2397 \begin_inset Flex Code
2400 \begin_layout Plain Layout
2407 \begin_inset Flex Code
2410 \begin_layout Plain Layout
2417 \begin_inset Flex Code
2420 \begin_layout Plain Layout
2427 Each of these packages has their pros and cons, which cannot be listed
2429 If you only want to have simple author-year (or author-numerical) style,
2430 or if you want to use one of the countless style files for
2431 \begin_inset Flex Code
2434 \begin_layout Plain Layout
2440 , then the established
2441 \begin_inset Flex Code
2444 \begin_layout Plain Layout
2450 package is probably your choice.
2451 If you look for specific citation styles common in law studies, you might
2453 \begin_inset Flex Code
2456 \begin_layout Plain Layout
2463 If you want to have full control over the formatting or look for advanced
2464 features such as ibidem, footnote citations, full title citations, advanced
2465 date formats (such as 400 BC) or full localization to other languages than
2466 English, you should definitely consider
2467 \begin_inset Flex Code
2470 \begin_layout Plain Layout
2476 , which exceeds all other packages in terms of features, but is also quite
2477 heavy and more resource-hungry.
2480 \begin_layout Standard
2481 The handling of these packages in \SpecialChar LyX
2482 is basically the same.
2484 \begin_inset Flex Noun
2487 \begin_layout Plain Layout
2488 Document\SpecialChar menuseparator
2495 \begin_inset Flex Noun
2498 \begin_layout Plain Layout
2505 \begin_inset Flex Noun
2508 \begin_layout Plain Layout
2515 \begin_inset Flex Noun
2518 \begin_layout Plain Layout
2525 \begin_inset Flex Noun
2528 \begin_layout Plain Layout
2535 \begin_inset Flex Noun
2538 \begin_layout Plain Layout
2539 Biblatex (Natbib mode)
2545 \begin_inset Flex Noun
2548 \begin_layout Plain Layout
2555 \begin_inset Flex Noun
2558 \begin_layout Plain Layout
2565 \begin_inset space ~
2568 6.5.3 in the User's Guide for more information on these choices).
2569 With all these packages, you will get some extra features in the citation
2570 dialog and you can select the style of the reference (
2571 \begin_inset Quotes eld
2575 \begin_inset Quotes erd
2579 \begin_inset Quotes eld
2583 \begin_inset Quotes erd
2587 \begin_inset Quotes eld
2591 \begin_inset Quotes erd
2595 \begin_inset Quotes eld
2599 \begin_inset Quotes erd
2603 Note that either package needs specifically designed style files.
2604 They all ship their own, but there are lots of additional style files,
2605 and there is even an interactive style file builder
2609 \begin_layout Plain Layout
2611 \begin_inset Flex URL
2614 \begin_layout Plain Layout
2616 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
2627 \begin_inset Flex Code
2630 \begin_layout Plain Layout
2639 \begin_layout Subsection
2640 Subdivided Bibliographies
2643 \begin_layout Standard
2644 Sometimes you might need to divide your bibliography into several sections.
2645 If you are for instance a historian, the possibility to separate sources
2646 and scientific works is most likely a
2647 \begin_inset Quotes eld
2651 \begin_inset Quotes erd
2655 Unfortunately, Bib\SpecialChar TeX
2656 itself does not allow you to do this.
2657 But with the help of some \SpecialChar LaTeX
2658 packages, Bib\SpecialChar TeX
2659 can be extended to fit your needs.
2662 \begin_layout Standard
2664 provides native support for one of these packages,
2672 \begin_layout Plain Layout
2674 \begin_inset Flex URL
2677 \begin_layout Plain Layout
2679 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
2689 The advantage of this package (compared to other packages such as
2693 ) is that you don't need to define new citation commands.
2694 Instead, you need to prepare different bibliographic databases which include
2695 the entries for the different sections of the bibliography.
2696 For example: If you want to divide your bibliography into the sections
2698 \begin_inset Quotes eld
2702 \begin_inset Quotes erd
2706 \begin_inset Quotes eld
2710 \begin_inset Quotes erd
2713 , you first need to create two bibliographic databases, e.
2714 \begin_inset space \thinspace{}
2718 \begin_inset space \space{}
2722 \begin_inset Flex Code
2725 \begin_layout Plain Layout
2732 \begin_inset Flex Code
2735 \begin_layout Plain Layout
2745 \begin_layout Standard
2747 \begin_inset Flex Noun
2750 \begin_layout Plain Layout
2751 Document\SpecialChar menuseparator
2758 \begin_inset Flex Noun
2761 \begin_layout Plain Layout
2768 \begin_inset Flex Noun
2771 \begin_layout Plain Layout
2772 Subdivided bibliography
2778 Now you can insert multiple Bib\SpecialChar TeX
2779 bibliographies, one for each section of
2781 Returning to our example: Insert the Bib\SpecialChar TeX
2783 \begin_inset Flex Code
2786 \begin_layout Plain Layout
2792 and a second one for the database
2793 \begin_inset Flex Code
2796 \begin_layout Plain Layout
2803 You are free to use the same or different styles for each section.
2804 Additionally, you can choose if the bibliography section should contain
2806 \begin_inset Quotes eld
2809 all cited references
2810 \begin_inset Quotes erd
2813 of the specified database(s) (which is the default),
2814 \begin_inset Quotes eld
2817 all uncited references
2818 \begin_inset Quotes erd
2822 \begin_inset Quotes eld
2826 \begin_inset Quotes erd
2830 This might be useful if you would like to separate your bibliography into
2832 \begin_inset Quotes eld
2836 \begin_inset Quotes erd
2840 \begin_inset Quotes eld
2844 \begin_inset Quotes erd
2848 \begin_inset Quotes eld
2852 \begin_inset Quotes erd
2856 The titles for the sections can be added as ordinary sections or subsections.
2858 \begin_inset Flex Code
2861 \begin_layout Plain Layout
2867 removes the bibliography title, you have to manually re-add that, too (as
2868 a chapter* or section*, for instance).
2871 \begin_layout Standard
2876 , the procedure is a bit different.
2885 , the aforementioned
2886 \begin_inset Flex Noun
2889 \begin_layout Plain Layout
2890 Subdivided bibliography
2895 option is disabled if you use
2904 provides its own means to generate subdivided bibliographies.
2905 You can either add keywords to bibliography entries via the
2906 \begin_inset Flex Code
2909 \begin_layout Plain Layout
2915 entry option and then filter bibliography sections by keyword (by adding
2917 \begin_inset Flex Code
2920 \begin_layout Plain Layout
2927 \begin_inset Flex Noun
2930 \begin_layout Plain Layout
2936 field of the dialog that opens if you left-click on the
2937 \begin_inset Flex Noun
2940 \begin_layout Plain Layout
2941 Biblatex Generated Bibliography
2946 button), or you can filter by entry types (such as
2955 \begin_inset space \thinspace{}
2960 \begin_inset Flex Code
2963 \begin_layout Plain Layout
2970 \begin_inset Flex Code
2973 \begin_layout Plain Layout
2980 \begin_inset Flex Noun
2983 \begin_layout Plain Layout
2989 field, or you can create so-called
2990 \begin_inset Quotes eld
2993 Bibliography Categories
2994 \begin_inset Quotes erd
2997 to which you can assign individual entries.
2998 Please refer to the Biblatex manual, section
3000 Subdivided Bibliographies
3005 \begin_layout Subsection
3006 Multiple Bibliographies
3007 \begin_inset CommandInset label
3009 name "subsec:Multiple-Bibliographies"
3016 \begin_layout Standard
3017 Multiple bibliographies, e.
3018 \begin_inset space \thinspace{}
3022 \begin_inset space \space{}
3025 a bibliography for each part, chapter, section, subsection or child (sub-documen
3026 t) of the document, are also supported by \SpecialChar LyX
3028 In order to enable it, go to
3029 \begin_inset Flex Noun
3032 \begin_layout Plain Layout
3033 Document\SpecialChar menuseparator
3034 Settings\SpecialChar menuseparator
3040 and select the relevant unit (e.
3041 \begin_inset space \thinspace{}
3045 \begin_inset Quotes eld
3049 \begin_inset Quotes erd
3053 \begin_inset Flex Noun
3056 \begin_layout Plain Layout
3057 Multiple Bibliographies
3063 Then add a Bib(la)\SpecialChar TeX
3064 bibliography to each unit (e.
3065 \begin_inset space \thinspace{}
3068 g., section) of your document.
3069 In the output, a separate bibliography, containing only the references
3070 done in the current unit is generated.
3073 \begin_layout Standard
3074 If you use Bib\SpecialChar TeX
3076 \begin_inset Flex Code
3079 \begin_layout Plain Layout
3086 \begin_inset Flex Code
3089 \begin_layout Plain Layout
3095 package is used to create multiple bibliographies.
3096 The former package is used if you select
3097 \begin_inset Quotes eld
3101 \begin_inset Quotes erd
3109 \begin_inset Flex Noun
3112 \begin_layout Plain Layout
3113 Sectioned Bibliography
3120 \begin_inset Flex Code
3123 \begin_layout Plain Layout
3133 \begin_layout Plain Layout
3134 An alternative approach, if you are willing to use some
3135 \begin_inset Flex Noun
3138 \begin_layout Plain Layout
3146 \begin_inset space ~
3150 \begin_inset CommandInset ref
3152 reference "sec:Inserting-TeX-Code"
3157 \begin_inset Flex Code
3160 \begin_layout Plain Layout
3172 \begin_inset Flex Code
3175 \begin_layout Plain Layout
3181 is used, \SpecialChar LyX
3182 encloses the specified units in
3183 \begin_inset Flex Code
3186 \begin_layout Plain Layout
3193 \begin_inset Flex Code
3196 \begin_layout Plain Layout
3205 \begin_inset Flex Code
3208 \begin_layout Plain Layout
3216 in order to create the units.
3217 Note that this approach has some limitations.
3218 First, every citation reference has to be inside some
3219 \begin_inset Flex Code
3222 \begin_layout Plain Layout
3229 So citations outside a defined unit (e.
3230 \begin_inset space \thinspace{}
3233 g., before the first section if you use
3234 \begin_inset Quotes eld
3238 \begin_inset Quotes erd
3242 \begin_inset Quotes eld
3246 \begin_inset Quotes erd
3250 You can also create your own units by entering
3251 \begin_inset Flex Code
3254 \begin_layout Plain Layout
3263 \begin_inset Flex Code
3266 \begin_layout Plain Layout
3275 code (for instance to work around the mentioned limitation).
3277 \begin_inset Flex Code
3280 \begin_layout Plain Layout
3287 A second limitation is that
3288 \begin_inset Flex Code
3291 \begin_layout Plain Layout
3297 always processes all references of a bibliography database, even if they
3299 This can result in odd labels (e.
3300 \begin_inset space \thinspace{}
3305 \begin_inset Quotes eld
3309 \begin_inset Quotes erd
3312 if two works of this author from 2014 are in the database, even if only
3316 \begin_layout Standard
3322 \begin_inset Flex Code
3325 \begin_layout Plain Layout
3331 option is used instead.
3332 If you need specific units, you can start them with the \SpecialChar TeX
3334 \begin_inset Flex Code
3337 \begin_layout Plain Layout
3346 \begin_inset Flex Code
3349 \begin_layout Plain Layout
3358 If you also want to control the end of the unit, use the environment
3359 \begin_inset Flex Code
3362 \begin_layout Plain Layout
3372 \begin_inset Flex Code
3375 \begin_layout Plain Layout
3385 \begin_inset Flex Code
3388 \begin_layout Plain Layout
3395 In addition to the individual bibliography of the current unit,
3399 also provides an easy way to output all bibliographies, subsequently, at
3401 \begin_inset space \thinspace{}
3404 g., at the end of the document).
3406 \begin_inset Quotes eld
3410 \begin_inset Quotes erd
3413 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
3419 manual for more information on this topic.
3422 \begin_layout Section
3426 \begin_layout Subsection
3430 \begin_layout Standard
3431 When you are working on a large file with many sections, it is often convenient
3432 to break up the document into several files, or perhaps you have something
3433 where a table may change from time to time, but the preceding text does
3435 In these cases, you should seriously consider using multipart documents.
3436 For example, scientific papers often have five major sections: the introduction
3437 , observations, results, discussion, and conclusion.
3438 Each of these could be its own separate \SpecialChar LyX
3440 \begin_inset Quotes eld
3444 \begin_inset Quotes erd
3447 file which contains the title, authors, abstract, references, etc., plus
3448 the five included files.
3449 It is important to note that each of these files is a full \SpecialChar LyX
3451 can be formatted and printed on its own, as well as included in a master
3453 Each of these files must have the same document class, however—don't attempt
3454 to mix book classes with article classes.
3455 You may also include \SpecialChar LaTeX
3456 files; however, these files must not have their own
3458 \begin_inset space \thinspace{}
3462 \begin_inset space \space{}
3465 everything up to and including the
3466 \begin_inset Flex Code
3469 \begin_layout Plain Layout
3478 \begin_inset Flex Code
3481 \begin_layout Plain Layout
3489 line must be deleted) or else errors will be generated when you try to
3493 \begin_layout Standard
3495 allows you to include files quite easily with
3496 \begin_inset Flex Noun
3499 \begin_layout Plain Layout
3500 Insert\SpecialChar menuseparator
3502 \begin_inset space ~
3511 When you click on this selection a small box is inserted into the file
3512 at the current cursor location.
3513 Clicking on the box raises a dialog which allows you to select the file
3514 to be included, and the method of its inclusion.
3518 \begin_layout Standard
3519 The file selection box should by now be obvious.
3520 The three inclusion methods are
3521 \begin_inset Quotes eld
3525 \begin_inset Quotes erd
3529 \begin_inset Quotes eld
3533 \begin_inset Quotes erd
3537 \begin_inset Quotes eld
3541 \begin_inset Quotes erd
3546 \begin_inset Quotes eld
3550 \begin_inset Quotes erd
3554 \begin_inset Quotes eld
3558 \begin_inset Quotes erd
3561 are similar in many ways, but there are also some notable differences:
3564 \begin_layout Enumerate
3566 \begin_inset Quotes eld
3570 \begin_inset Quotes erd
3573 are typeset beginning on a new page, while files that are
3574 \begin_inset Quotes eld
3578 \begin_inset Quotes erd
3581 are typeset starting on the current page.
3584 \begin_layout Enumerate
3585 \begin_inset Quotes eld
3589 \begin_inset Quotes erd
3592 files cannot themselves
3593 \begin_inset Quotes eld
3597 \begin_inset Quotes erd
3601 \begin_inset Quotes eld
3605 \begin_inset Quotes erd
3610 \begin_inset Quotes eld
3614 \begin_inset Quotes erd
3617 , on the other hand, infinite sub-inputting is possible.
3620 \begin_layout Enumerate
3621 \begin_inset Quotes eld
3625 \begin_inset Quotes erd
3628 allow for the output of only selected
3629 \begin_inset Quotes eld
3633 \begin_inset Quotes erd
3636 files, while maintaining the actual counters (pagination etc.) and references
3637 (please refer to the section
3640 \begin_inset space ~
3648 \begin_inset space ~
3653 manual for details).
3656 \begin_layout Standard
3658 \begin_inset Quotes eld
3662 \begin_inset Quotes erd
3665 is the preferred method for chapters that are outsourced to child documents,
3667 \begin_inset Quotes eld
3671 \begin_inset Quotes erd
3674 is more suitable for arbitrary file inheritance.
3677 \begin_layout Standard
3679 \begin_inset Quotes eld
3683 \begin_inset Quotes erd
3686 included file allows you to include a file typeset exactly as it appears
3688 \begin_inset space \thinspace{}
3692 \begin_inset space \space{}
3696 \begin_inset Flex Code
3699 \begin_layout Plain Layout
3705 mode, with the characters set in a fixed-width typewriter font.
3706 Normally, spaces in this file are invisible, though two consecutive spaces
3707 are conserved, unlike \SpecialChar LyX
3708 's normal treatment of spaces.
3709 However, setting the
3710 \begin_inset Flex Noun
3713 \begin_layout Plain Layout
3715 \begin_inset space ~
3719 \begin_inset space ~
3723 \begin_inset space ~
3731 checkbox typesets a mark to unambiguously define the presence of a space.
3735 \begin_layout Standard
3736 Generally, the master file is converted into a full \SpecialChar LaTeX
3737 file before typesetting,
3738 while the included files are converted to \SpecialChar LaTeX
3739 files that do not have all the
3740 preamble information.
3743 \begin_layout Subsection
3744 Cross-References Between Files
3747 \begin_layout Standard
3748 \begin_inset Box Shadowbox
3758 height_special "totalheight"
3763 backgroundcolor "none"
3766 \begin_layout Plain Layout
3767 This section is somewhat out of date.
3768 Need to describe default master documents and how children are opened when
3778 \begin_layout Standard
3779 It is possible to set up cross-references between the different files.
3780 First, open all the files in question: let's call them A and B in a two
3781 file example, where B is included in A.
3782 Let's say you insert a label in A, then want to reference it in B.
3783 Open the cross-reference dialog whilst in document B, and you can select
3785 \begin_inset Quotes eld
3789 \begin_inset Quotes erd
3795 \begin_layout Subsection
3796 Bibliography Lists in all Subdocuments
3799 \begin_layout Standard
3800 If you work with child documents, you might want to have only one main bibliogra
3801 phy at the end, but still be able to have a selected bibliography for the
3802 child if you output it on its own.
3803 Here is how to achieve this.
3806 \begin_layout Standard
3807 For the main document, you just insert a bibliography inset at the place
3808 where the main bibliography has to appear (within the master file or within
3810 If the bibliography inset is in the master file, the references will be
3811 inherited by all children, so they are available in the citation dialog
3815 \begin_layout Standard
3816 For child-specific bibliographies, insert bibliography insets within the
3817 child documents, at the place where the bibliography should appear when
3818 the child is compiled separately.
3819 However, the trick is to insert them into a branch (
3821 Insert\SpecialChar menuseparator
3822 Branch\SpecialChar menuseparator
3823 Insert New Branch...
3826 \begin_inset space \thinspace{}
3831 \begin_inset Quotes eld
3835 \begin_inset Quotes erd
3839 Within the children, activate the branch (
3841 Document\SpecialChar menuseparator
3842 Settings...\SpecialChar menuseparator
3846 Within the master, deactivate the branch (
3848 Document\SpecialChar menuseparator
3849 Settings...\SpecialChar menuseparator
3853 Now the child's bibliography will be ignored by the master, but considered
3857 \begin_layout Standard
3858 If you need multiple bibliographies (e.
3859 \begin_inset space \thinspace{}
3862 g., one per child in the
3866 ), please refer to sec.
3867 \begin_inset space ~
3871 \begin_inset CommandInset ref
3873 reference "subsec:Multiple-Bibliographies"
3880 \begin_layout Section
3885 \begin_layout Standard
3886 Users sometimes need to be able to
3887 \begin_inset Quotes eld
3891 \begin_inset Quotes erd
3895 file together with all the images (and other files) on which it depends,
3896 either for sending to a publisher or for sharing with a co-author.
3898 includes a Python script (
3899 \begin_inset Flex Code
3902 \begin_layout Plain Layout
3908 ) that automates this process.
3909 To use it, you must have either the
3910 \begin_inset Flex Code
3913 \begin_layout Plain Layout
3920 \begin_inset Flex Code
3923 \begin_layout Plain Layout
3929 python modules installed on your system.
3930 By default, the script prefers the
3931 \begin_inset Flex Code
3934 \begin_layout Plain Layout
3941 \begin_inset Flex Code
3944 \begin_layout Plain Layout
3950 format on Unix-like systems and the
3951 \begin_inset Flex Code
3954 \begin_layout Plain Layout
3963 \begin_layout Standard
3965 's configuration process will set the script up to export a `\SpecialChar LyX
3967 and this format will then be available under
3968 \begin_inset Flex Code
3971 \begin_layout Plain Layout
3972 File\SpecialChar menuseparator
3981 \begin_layout Standard
3982 Independently of the platform, the generation of a particular archive format
3983 can be forced by adding either the
3984 \begin_inset Flex Code
3987 \begin_layout Plain Layout
3994 \begin_inset Flex Code
3997 \begin_layout Plain Layout
4004 \begin_inset Flex Code
4007 \begin_layout Plain Layout
4014 \begin_inset Flex Code
4017 \begin_layout Plain Layout
4023 format) switch to the
4024 \begin_inset Flex Code
4027 \begin_layout Plain Layout
4029 \SpecialChar menuseparator
4037 \begin_inset Flex Code
4040 \begin_layout Plain Layout
4041 Tools\SpecialChar menuseparator
4042 Preferences\SpecialChar menuseparator
4043 File Handling\SpecialChar menuseparator
4050 (Make sure you add the switch after the script name, not before it.)
4053 \begin_layout Section
4054 Fancy Headers and Footers
4057 \begin_layout Standard
4058 The default page layout is rather plain; for an
4059 \begin_inset Flex Code
4062 \begin_layout Plain Layout
4068 document class, all you get is a centered page number at the bottom of
4070 This document uses KOMA-script's book class, so it appears to be a bit
4072 But to really put on a show, you need to set the document page style to
4074 \begin_inset Quotes eld
4078 \begin_inset Quotes erd
4081 , as mentioned in the
4086 This section describes the \SpecialChar LaTeX
4087 code you need to insert in your \SpecialChar LaTeX
4089 order to get the desired effects.
4092 \begin_layout Standard
4093 For more information on fancy headers, see the
4094 \begin_inset Flex Code
4097 \begin_layout Plain Layout
4103 package documentation.
4105 \begin_inset Flex URL
4108 \begin_layout Plain Layout
4110 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
4118 \begin_layout Standard
4119 The page header is divided into three fields, not surprisingly labeled
4120 \begin_inset Quotes eld
4124 \begin_inset Quotes erd
4128 \begin_inset Quotes eld
4132 \begin_inset Quotes erd
4136 \begin_inset Quotes eld
4140 \begin_inset Quotes erd
4144 The footer is also divided into these three fields.
4145 The \SpecialChar LaTeX
4146 commands to set these fields in the simplest manner are
4147 \begin_inset Flex Code
4150 \begin_layout Plain Layout
4159 \begin_inset Flex Code
4162 \begin_layout Plain Layout
4171 \begin_inset Flex Code
4174 \begin_layout Plain Layout
4183 \begin_inset Flex Code
4186 \begin_layout Plain Layout
4195 Suppose you wish to put your name in the upper left hand corner of each
4197 Simply insert the following command in the preamble:
4200 \begin_layout Standard
4209 \begin_layout Standard
4210 You will now see your name in the upper left.
4211 If a field has a default entry that you would like to get rid of (often
4212 the page number appears in the central footer) simply include a command
4213 with a blank argument, e.
4214 \begin_inset space \thinspace{}
4220 \begin_layout Standard
4228 \begin_layout Standard
4229 Let's get really fancy: lets put the section number with the word
4230 \begin_inset Quotes eld
4234 \begin_inset Quotes erd
4238 \begin_inset space \thinspace{}
4242 \begin_inset space \space{}
4245 Section 3) in the upper left, the page number (e.
4246 \begin_inset space \thinspace{}
4250 \begin_inset space \space{}
4253 Page 4) in the upper right, your name in the lower left, and the date in
4255 The following commands should now appear in the preamble:
4258 \begin_layout Standard
4268 \begin_layout Standard
4276 \begin_layout Standard
4286 \begin_layout Standard
4295 \begin_layout Standard
4303 \begin_layout Standard
4313 \begin_layout Standard
4315 \begin_inset Flex Code
4318 \begin_layout Plain Layout
4327 \begin_inset Flex Code
4330 \begin_layout Plain Layout
4338 access \SpecialChar LaTeX
4339 's section and page counters, and so print out the current section
4342 \begin_inset Flex Code
4345 \begin_layout Plain Layout
4353 simply prints out today's date.
4356 \begin_layout Standard
4357 The thicknesses of the horizontal rules drawn beneath the header and above
4358 the footer can also be modified.
4359 If you don't want one of the rules, set its thickness to 0.
4360 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
4366 \begin_inset Flex Code
4369 \begin_layout Plain Layout
4374 headrulewidth}{0.4pt}
4380 \begin_inset Flex Code
4383 \begin_layout Plain Layout
4388 footrulewidth}{0.4pt}
4393 to set the thicknesses.
4396 \begin_layout Standard
4397 You can switch the header/footer settings on and off for individual pages
4399 \begin_inset Flex Code
4402 \begin_layout Plain Layout
4405 thispagestyle{empty}
4411 \begin_inset Flex Code
4414 \begin_layout Plain Layout
4417 thispagestyle{plain}
4423 \begin_inset Flex Code
4426 \begin_layout Plain Layout
4429 thispagestyle{fancy}
4435 Simply insert them in the text on the page you want changed and mark them
4438 In fact, title pages are marked as plain by default, while following pages
4439 are marked fancy when using the global fancy setting.
4442 \begin_layout Standard
4443 As a final example, it is possible to include an image in the header or
4445 Suppose you want to put a company logo in the upper lefthand corner.
4446 You might try something like
4449 \begin_layout Standard
4458 includegraphics{logo.eps}}}
4461 \begin_layout Standard
4463 (you may need to preface this with
4464 \begin_inset Flex Code
4467 \begin_layout Plain Layout
4470 usepackage{graphics}
4475 if you don't include graphics elsewhere in your document).
4478 \begin_layout Section
4479 Itemize Bullet Selection
4480 \begin_inset CommandInset label
4489 \begin_layout Standard
4495 \begin_layout Subsection
4499 \begin_layout Standard
4501 provides 216 bullet shapes that can be accessed from a simple dialog.
4502 Using this dialog you can easily specify what bullet shape to use at each
4503 level of an itemized list.
4504 These settings are document-wide so you won't be able to specify different
4505 sets of bullets for different paragraphs.
4509 \begin_layout Plain Layout
4510 Well, actually you can but you'll have to do it by hand.
4518 \begin_layout Subsection
4522 \begin_layout Standard
4523 Open the dialog by selecting the
4524 \begin_inset Flex Noun
4527 \begin_layout Plain Layout
4528 Document\SpecialChar menuseparator
4534 menu item and then select the
4535 \begin_inset Flex Noun
4538 \begin_layout Plain Layout
4547 \begin_layout Standard
4548 The dialog provides you with a table of bullet shapes.
4549 A column of buttons on the left of the table provides access to the six
4550 different panels of bullet shapes.
4551 The row of buttons across the top is used to select which bullet depth
4554 \change_deleted 244031559 1603875981
4555 A text entry under the table shows the currently selected bullet shape's
4557 equivalent and this can be edited if desired.
4558 If you do modify the text you will also need to specify any needed packages
4559 in the \SpecialChar LaTeX
4565 \begin_layout Standard
4566 The six panels are divided up by the packages they require.
4567 The following table shows the mappings from button name to \SpecialChar LaTeX
4571 \begin_layout Standard
4573 \begin_inset Tabular
4574 <lyxtabular version="3" rows="7" columns="2">
4575 <features tabularvalignment="middle">
4576 <column alignment="center" valignment="top" width="0pt">
4577 <column alignment="center" valignment="top" width="0pt">
4579 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4582 \begin_layout Plain Layout
4597 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4600 \begin_layout Plain Layout
4617 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4620 \begin_layout Plain Layout
4635 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4638 \begin_layout Plain Layout
4647 base \SpecialChar LaTeX
4655 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4658 \begin_layout Plain Layout
4673 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4676 \begin_layout Plain Layout
4693 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4696 \begin_layout Plain Layout
4711 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4714 \begin_layout Plain Layout
4731 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4734 \begin_layout Plain Layout
4749 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4752 \begin_layout Plain Layout
4769 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
4772 \begin_layout Plain Layout
4787 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
4790 \begin_layout Plain Layout
4807 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
4810 \begin_layout Plain Layout
4825 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
4828 \begin_layout Plain Layout
4851 \begin_layout Standard
4853 doesn't stop you using bullets from packages you don't have.
4854 If you get errors from \SpecialChar LaTeX
4855 when you try to view or print the file, then it
4856 is likely you are missing a package.
4860 \begin_layout Plain Layout
4862 doesn't restrict your use since you may be editing locally and exporting
4871 \begin_layout Subsection
4875 \begin_layout Standard
4876 Select which bullet depth you want to change then select the bullet shape
4878 Any changes will not be visible in \SpecialChar LyX
4879 , but are visible when viewing the document.
4882 \begin_layout Standard
4883 You can reset a bullet shape to the default simply by clicking your right
4884 mouse button on the appropriate bullet depth button.
4888 \begin_layout Plain Layout
4893 want to have multiple sets of paragraphs with different sets of bullets
4894 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
4896 The bullet selection dialog can help though because it provides you with
4897 the \SpecialChar LaTeX
4898 code for a wide range of bullet shapes.
4899 To make your own custom paragraphs you have the following options:
4902 \begin_layout Plain Layout
4906 \begin_layout Plain Layout
4922 \begin_layout Plain Layout
4926 \begin_layout Plain Layout
4948 \begin_layout Itemize
4949 Use the \SpecialChar LaTeX
4951 \begin_inset Flex Code
4954 \begin_layout Plain Layout
4962 to specify a new bullet shape for a given depth.
4963 You'll also need to save the current bullet shape so you can restore it
4965 In this itemized list the following \SpecialChar LaTeX
4966 code was used to change the bullet
4967 used for the first depth.
4971 \begin_layout LyX-Code
4981 \begin_layout LyX-Code
4998 \begin_layout Itemize
4999 Note that the itemize depth is specified in Roman numerals as part of the
5009 \begin_layout Itemize
5010 \begin_inset Argument item:1
5013 \begin_layout Plain Layout
5017 \begin_layout Plain Layout
5035 Specify each individual entry by starting each item with the bullet shape
5037 \begin_inset Quotes eld
5041 \begin_inset Quotes erd
5046 Insert\SpecialChar menuseparator
5050 \begin_inset Flex Noun
5053 \begin_layout Plain Layout
5061 For example, this item was started with
5062 \begin_inset Flex Code
5065 \begin_layout Plain Layout
5080 \begin_layout Plain Layout
5084 \begin_layout Plain Layout
5100 \begin_layout Plain Layout
5101 You'll also need to revert the labelitem back to its previous setting for
5102 the global bullet shape settings to remain in effect.
5103 The way used here was:
5106 \begin_layout LyX-Code
5121 \begin_layout Chapter
5123 and the World Wide Web
5126 \begin_layout Standard
5128 has long supported the export of documents to various web-friendly formats,
5130 Before version 2.0, however, HTML export was always accomplished by the
5131 use of external converters.
5135 \begin_layout Plain Layout
5136 For details on the use of external converters with \SpecialChar LyX
5141 section of the Customization manual.
5146 These fall into two large groups: there are converters that use \SpecialChar LaTeX
5148 intermediate format, such as
5149 \begin_inset Flex Code
5152 \begin_layout Plain Layout
5159 \begin_inset Flex Code
5162 \begin_layout Plain Layout
5169 \begin_inset Flex Code
5172 \begin_layout Plain Layout
5178 , relying upon \SpecialChar LyX
5179 to produce the \SpecialChar LaTeX
5180 ; and there is a converter that works directly
5183 \begin_inset Flex Code
5186 \begin_layout Plain Layout
5194 All of these have different advantages and disadvantages.
5198 \begin_layout Standard
5199 The \SpecialChar LaTeX
5200 -based converters have the advantage that, in principle, they know everythin
5201 g about the exported document that \SpecialChar LaTeX
5203 Such converters do not care, for example, if a certain block of code was
5204 produced by \SpecialChar LyX
5205 or was Evil Red Text.
5206 These converters know about
5207 \begin_inset Flex Code
5210 \begin_layout Plain Layout
5216 files, counters, and references, and can often make use of the
5217 \begin_inset Flex Code
5220 \begin_layout Plain Layout
5226 files generated by Bib\SpecialChar TeX
5228 On the other hand, \SpecialChar LaTeX
5229 is a very hard language to parse—it is sometimes said
5230 that only \SpecialChar TeX
5231 itself understands \SpecialChar TeX
5232 —and \SpecialChar LaTeX
5233 -based converters will often choke on
5234 what seem to be quite simple constructs; complex ones can throw them completely
5235 , and as of this writing, for example, the
5239 manual will not export with
5240 \begin_inset Flex Code
5243 \begin_layout Plain Layout
5249 , though the others will.
5250 The other issue concerns how math is handled.
5251 These converters typically convert the formulae into little pictures that
5252 are then linked from the HTML document.
5253 Since these are actually generated by \SpecialChar LaTeX
5254 , they are accurate.
5255 But they do not scale well, and just getting them to look as if they are
5256 actually meant to be in your document—so that the font sizes seem to be
5257 roughly the same—can be a challenge.
5260 \begin_layout Standard
5262 \begin_inset Flex Code
5265 \begin_layout Plain Layout
5273 \begin_inset CommandInset href
5275 name "http://pinchito.es/elyxer/"
5276 target "http://pinchito.es/elyxer/"
5281 ) solves some of these problems.
5282 In particular, the formulae it produces scale perfectly, since it renders
5283 math using a combination of HTML and CSS rather than converting the formulae
5285 But even moderately complex formula are rendered less well than with
5286 \begin_inset Flex Code
5289 \begin_layout Plain Layout
5295 ; this reflects the limitations of HTML.
5299 \begin_layout Plain Layout
5301 \begin_inset Flex Code
5304 \begin_layout Plain Layout
5311 can also use jsMath and MathJax for equations, but this setting is only
5312 available globally and requires one to have access to a server that runs
5318 More importantly (as of version 1.1.1, at least),
5319 \begin_inset Flex Code
5322 \begin_layout Plain Layout
5329 has limited support for math macros and no support for user-defined paragraph
5330 or character styles.
5331 These limitations make
5332 \begin_inset Flex Code
5335 \begin_layout Plain Layout
5342 unsuitable for many of the documents \SpecialChar LyX
5344 In principle, of course, these problems could be solved, but the \SpecialChar LyX
5346 have decided to follow a different path and have made \SpecialChar LyX
5348 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
5349 , DocBook, and plaintext.
5352 \begin_layout Standard
5353 As of this writing, XHTML output remains under development and should probably
5355 \begin_inset Quotes eld
5359 \begin_inset Quotes erd
5366 \begin_layout Plain Layout
5368 \begin_inset Flex Code
5371 \begin_layout Plain Layout
5372 development/HTML/HTML.notes
5377 , which can be found in the \SpecialChar LyX
5379 \begin_inset CommandInset href
5381 name "accessed online"
5382 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
5387 , usually contains up-to-date information about the state of XHTML output.
5388 See also the list of XHTML bugs on
5389 \begin_inset CommandInset href
5391 name "the bug tracker"
5392 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"
5402 Still, the developers have chosen this approach because it has several
5403 potential advantages over the other two.
5406 \begin_layout Standard
5407 These advantages are primarily due to the fact that the XHTML output routines,
5408 since they are part of \SpecialChar LyX
5409 , know everything \SpecialChar LyX
5410 knows about the document being
5415 \begin_layout Plain Layout
5416 Another advantage is that, since these routines are internal to \SpecialChar LyX
5418 immune to changes in \SpecialChar LyX
5419 's file format, or to changes in the semantics of
5425 So they know about the table of contents (as displayed in the outline),
5426 about the counters associated with different paragraph styles, and about
5427 user-defined styles.
5428 The XHTML output routines know what \SpecialChar LyX
5429 knows about internationalization,
5430 too, so they will output
5431 \begin_inset Quotes eld
5435 \begin_inset Quotes erd
5439 \begin_inset Quotes eld
5447 \begin_inset Quotes erd
5450 , depending upon the language in effect at the time.
5454 \begin_layout Standard
5455 Quite generally, the output routines know what \SpecialChar LyX
5456 knows about document layout,
5457 that is, about how the document is to be rendered on screen.
5458 We use this information when we output the document as XHTML.
5459 In particular, \SpecialChar LyX
5464 generates CSS style information corresponding to the layout information
5465 it uses to render the document on screen: if section headings are supposed
5466 to be sans-serif and bold as seen in \SpecialChar LyX
5467 , then (by default) they will be sans-seri
5468 f and bold when viewed in a web browser, too.
5469 And this is true not just for pre-defined styles, like Section, but for
5470 any style, including user-defined styles.
5471 Indeed, the XHTML output routines make no distinction between user-defined
5473 \change_deleted 244031559 1603876931
5475 \change_inserted 244031559 1603876940
5478 styles and \SpecialChar LyX
5479 's own pre-defined styles: in each case, everything \SpecialChar LyX
5481 the styles is contained in the layout files.
5482 And much the same is true as regards pre-defined textual insets, such as
5483 footnotes, and various custom insets.
5487 \begin_layout Standard
5488 The result is that XHTML output can be customized and extended in exactly
5489 the same way \SpecialChar LaTeX
5490 output can be customized and extended: through layout files
5492 See chapter five of the
5496 manual for the details.
5499 \begin_layout Standard
5500 The remainder of this chapter contains more detailed information on XHTML
5501 output, its limitations, and ways to work around those limitations.
5504 \begin_layout Section
5505 Math Output in XHTML
5508 \begin_layout Standard
5510 offers four choices for how math is rendered.
5511 These have various advantages and disadvantages:
5514 \begin_layout Itemize
5516 \begin_inset Newline newline
5519 MathML is a dialect of XML designed specifically for mathematics on the
5520 web, and it typically renders very well in browsers that support it.
5521 The disadvantage is that not all browsers support MathML, and support is
5522 not complete even in the Gecko-based browsers, such as Firefox.
5523 \begin_inset Newline newline
5527 is unable to render a formula as MathML—for example, if the formula
5529 \begin_inset Flex Code
5532 \begin_layout Plain Layout
5538 package or ERT—then it will instead output the formula as an image.
5542 \begin_layout Itemize
5544 \begin_inset Newline newline
5548 \begin_inset Flex Code
5551 \begin_layout Plain Layout
5557 outputs math as HTML, styled by CSS.
5561 \begin_layout Plain Layout
5563 has borrowed some of the CSS for its HTML output from
5564 \begin_inset Flex Code
5567 \begin_layout Plain Layout
5578 For simple formulae, this can work quite well, though with more complicated
5579 formulae it tends to break down.
5580 Still, this method has the advantage that it is very widely supported and
5581 so it may be appropriate for documents that contain only a little, fairly
5583 \begin_inset Newline newline
5586 If Lyx is unable to render a formula as HTML—for example, if the formula
5588 \begin_inset Flex Code
5591 \begin_layout Plain Layout
5597 package or ERT—then it will instead output the formula as an image.
5601 \begin_layout Itemize
5603 \begin_inset Newline newline
5607 \begin_inset Flex Code
5610 \begin_layout Plain Layout
5617 will output formulae as images, the very same images, in fact, that are
5618 used for instant preview.
5622 \begin_layout Plain Layout
5623 Instant preview does
5627 have to be on for images to be output, however.
5632 The advantage to this method is that the images are simply generated by
5634 , so they are very accurate.
5635 The disadvantage, as mentioned earlier, is that these are bitmapped images,
5636 so they do not scale terribly well, and one cannot copy them, etc.
5637 \begin_inset Newline newline
5640 The size of the images can be controlled by setting the
5641 \begin_inset Quotes eld
5645 \begin_inset Quotes erd
5649 \begin_inset Flex Noun
5652 \begin_layout Plain Layout
5653 Document\SpecialChar menuseparator
5654 Settings\SpecialChar menuseparator
5664 \begin_layout Plain Layout
5665 For those who want to know, this controls the resolution of the image in
5666 dots per inch and is based upon a default of 75 dpi.
5672 \begin_inset Newline newline
5676 for some reason fails to create an image for a formula (e.g., if a required
5678 package is not installed), then it will fall back to outputing the raw
5683 \begin_layout Itemize
5686 \begin_inset Newline newline
5689 Finally, \SpecialChar LyX
5690 will happily output math as \SpecialChar LaTeX
5692 As well as being the output of last resort, this method can be used with
5694 \begin_inset CommandInset href
5697 target "http://www.math.union.edu/~dpvc/jsMath/"
5702 , which uses JavaScript to render \SpecialChar LaTeX
5703 embedded in HTML documents.
5705 wraps the \SpecialChar LaTeX
5707 \begin_inset Flex Code
5710 \begin_layout Plain Layout
5716 (for inline formulas) or
5717 \begin_inset Flex Code
5720 \begin_layout Plain Layout
5726 (for displayed formulas) with
5727 \begin_inset Flex Code
5730 \begin_layout Plain Layout
5736 , as is required for jsMath.
5739 \begin_layout Standard
5740 One of these output methods must be selected under
5741 \begin_inset Flex Noun
5744 \begin_layout Plain Layout
5745 Document\SpecialChar menuseparator
5746 Settings\SpecialChar menuseparator
5753 By default, \SpecialChar LyX
5755 This is a document-wide setting, therefore.
5758 \begin_layout Standard
5759 Eventually, \SpecialChar LyX
5760 will offer the user the option to select an alternate output
5761 method for a particular inset, say, one that isn't being rendered very
5766 \begin_layout Plain Layout
5767 That said, since \SpecialChar LyX
5768 falls back to images if the inset contains ERT, then one
5769 can force output as an image by putting some harmless ERT into the math,
5771 \begin_inset Formula $a=b\relax$
5782 \begin_layout Section
5783 Bibliography and Citations
5786 \begin_layout Standard
5787 XHTML output fully supports bibliographies and citations.
5791 \begin_layout Standard
5792 Citation labels are generated by the same machinery that generates \SpecialChar LyX
5794 labels, so the labels will look in the output much as they do in \SpecialChar LyX
5797 If you are using numerical citations, then \SpecialChar LyX
5798 will output numerical labels,
5799 such as [1] or [17], rather than simply showing the citation key in square
5800 brackets, as it does on-screen.
5801 If you are using author-year citations, then \SpecialChar LyX
5802 will add lowercase letters
5803 to the years, just as Bib\SpecialChar TeX
5804 does, if it finds more than one citation for
5805 a given author-year combination.
5806 The labels will be printed with the bibliography entries.
5807 Note that there is, at present, no way to customize the appearance of the
5808 labels, for example, to choose between square brackets and parentheses.
5811 \begin_layout Standard
5812 Bibliography output is handled by the same machinery that handles the presentati
5813 on of reference information in the citation dialog, so you will see in the
5814 XHTML output pretty much what you would see if you were to look at a given
5815 entry in the citation dialog.
5816 The formatting can be customized in your layout file or, preferably, in
5822 manual for the details.
5825 \begin_layout Standard
5826 The main defect at present is that cross-referenced information is printed
5827 with every entry with which it is associated.
5828 So you can see things like this:
5833 \begin_inset Quotes eld
5836 Context and Logical Form
5837 \begin_inset Quotes erd
5842 Language in Context: Selected Essays
5844 (Oxford: Oxford University Press, 2007), pp.
5850 \begin_inset Quotes eld
5853 Semantics in Context
5854 \begin_inset Quotes erd
5859 Language in Context: Selected Essays
5861 (Oxford: Oxford University Press, 2007), pp.
5865 \begin_layout Standard
5866 This should be fixed before long.
5869 \begin_layout Standard
5870 There is no support at present for sectioned bibliographies.
5871 If you have multiple bibliographies, then \SpecialChar LyX
5872 will print the same bibliography
5876 \begin_layout Section
5880 \begin_layout Standard
5882 will happily export indexes as XHTML, but with certain limitations at the
5886 \begin_layout Standard
5887 Index export will be most reliable when you do not attempt to use the fancy
5888 constructs that are described in the section on indexes in the
5896 \begin_layout Plain Layout
5897 The main issue here is that \SpecialChar LyX
5898 itself does not really handle these.
5899 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
5905 We'll describe how they are handled using the subsection headings from
5909 \begin_layout Itemize
5910 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
5911 makes an effort to support these,
5912 but the entries must be separated by
5913 \begin_inset Quotes eld
5917 \begin_inset Quotes erd
5920 , that is, there must be spaces around the exclamation point.
5921 This is because it is otherwise too difficult to check for escaped exclamation
5922 points, ones in math, and so forth.
5925 \begin_layout Itemize
5926 Page Ranges: There is no support at all for page ranges, since these make
5927 no sense with XHMTL.
5928 Instead, you will just get two index entries, one at either end.
5931 \begin_layout Itemize
5932 Cross-referencing: There is no support for cross-referencing.
5934 finds an entry containing the
5935 \begin_inset Quotes eld
5938 |see\SpecialChar ldots
5940 \begin_inset Quotes erd
5943 construct, it is just dropped, and the rest is treated as an ordinary index
5947 \begin_layout Itemize
5948 Index Entry Order: \SpecialChar LyX
5949 does support attempts to fix the sorting order.
5950 It will take what is before the first `@' it finds and use that for sorting,
5951 taking what follows the first `@' to be the actual entry.
5952 At present, \SpecialChar LyX
5953 does not check for escaped `@', so do not try to index email
5957 \begin_layout Itemize
5958 Index Entry Layout: You can format entries by using the text style dialog,
5959 or by using any other method available within \SpecialChar LyX
5961 There is no support for constructs like:
5962 \begin_inset Quotes eld
5966 \begin_inset Quotes erd
5970 Indeed, if \SpecialChar LyX
5971 finds a pipe symbol, `|', in an entry, it will delete it and
5972 everything that follows it.
5975 \begin_layout Itemize
5976 Multiple Indexes: There is no support for multiple indexes.
5977 Rather, all index entries will be printed as one large index.
5978 To avoid our printing several versions of the index, we print only the
5979 main index, so make sure you have one.
5982 \begin_layout Section
5983 Nomenclature and Glossary
5986 \begin_layout Standard
5987 There is at present no support for glossaries.
5988 Adding it would be fairly trivial, and welcome.
5991 \begin_layout Chapter
5993 \change_inserted 1075283030 1616534180
5997 \begin_layout Standard
5999 \change_inserted 1075283030 1616534386
6000 Apart from HTML, \SpecialChar LyX
6001 can generate documents in the DocBook XML vocabulary.
6002 With versions 2.3 and before, only select templates could be used to generate
6003 DocBook documents (only version 4).
6004 Starting with \SpecialChar LyX
6005 2.4, most \SpecialChar LyX
6006 layouts can generate valid DocBook documents (only
6008 This feature is built into \SpecialChar LyX
6009 and does not require the use of external tools.
6012 \begin_layout Standard
6014 \change_inserted 1075283030 1616534437
6015 The result is that the DocBook output can be customized and extended in
6016 exactly the same way \SpecialChar LaTeX
6017 output can be customized and extended: through layout
6019 See chapter five of the
6023 manual for the details.
6026 \begin_layout Standard
6028 \change_inserted 1075283030 1616534475
6029 Most \SpecialChar LyX
6030 features are supported with DocBook, like math output.
6033 \begin_layout Itemize
6035 \change_inserted 1075283030 1616534741
6036 Math output is performed mostly in MathML (the major exception being constructio
6037 ns not supported by \SpecialChar LyX
6040 All formulae are also available in raw \SpecialChar TeX
6041 in the DocBook output for further
6045 \begin_layout Itemize
6047 \change_inserted 1075283030 1616534852
6048 Bibliographies and citations are implemented, including with an external
6050 Bibliography entries are not prerendered when the detailed information
6051 are available, but rather output with the standard DocBook constructs.
6052 The external DocBook processor is expected to handle the rendering of entries.
6055 \begin_layout Itemize
6057 \change_inserted 1075283030 1616534863
6058 Indexes are supported, including multiple indices.
6063 ), page ranges, and cross-references (
6067 ) are supported, with the exception of the same symbols escaped.
6076 ) are not supported.
6077 There is no support for escaping of index entries.
6080 \begin_layout Itemize
6082 \change_inserted 1075283030 1616534884
6083 Glossaries are implemented.
6086 \begin_layout Standard
6088 \change_inserted 1075283030 1616534894
6089 Two major parameters can be set at the document level.
6092 \begin_layout Itemize
6094 \change_inserted 1075283030 1616534948
6095 Format for tables: \SpecialChar LyX
6096 can generate tables either as HTML (default value) or
6097 CALS, depending on the user's requirements.
6098 Most DocBook processors accept both formats.
6101 \begin_layout Itemize
6103 \change_inserted 1075283030 1616535006
6104 MathML prefix: in DocBook, MathML is included within its own name space,
6106 The implication is that there must be an indication of the tags belonging
6107 to the MathML standard.
6108 Three choices are offered:
6112 \begin_layout Itemize
6114 \change_inserted 1075283030 1616535044
6115 Inline: the MathML name space is defined for each formula (using the
6119 attribute on each formula)
6122 \begin_layout Itemize
6124 \change_inserted 1075283030 1616535090
6129 prefix (default): the MathML name space is defined at the document level
6134 attribute on the root element).
6135 Each MathML is prefixed with
6144 \begin_layout Itemize
6146 \change_inserted 1075283030 1616620405
6151 prefix: similar to the
6160 \begin_layout Standard
6162 \change_inserted 1075283030 1616620470
6163 This option is especially useful if you want \SpecialChar LyX
6164 to match your personal style
6165 or to work with buggy software that only accepts one prefix for MathML.
6171 \begin_layout Chapter
6172 The \SpecialChar LyX
6176 \begin_layout Section
6180 \begin_layout Standard
6181 The `\SpecialChar LyX
6182 server' allows other programs to talk to \SpecialChar LyX
6183 , invoke \SpecialChar LyX
6184 commands, and retrieve
6185 information about the \SpecialChar LyX
6187 This is only intended for advanced users, but they should find it useful.
6188 It is by writing to the \SpecialChar LyX
6189 server, for example, that bibliography managers,
6190 such as JabRef, are able to
6191 \begin_inset Quotes eld
6195 \begin_inset Quotes erd
6198 citations to \SpecialChar LyX
6202 \begin_layout Section
6203 Starting the \SpecialChar LyX
6205 \begin_inset CommandInset label
6207 name "sec:Starting-the-Server"
6214 \begin_layout Standard
6215 The \SpecialChar LyX
6216 server works through the use of a pair of named pipes.
6217 These are usually located in
6218 \begin_inset Flex Code
6221 \begin_layout Plain Layout
6227 , (except on Windows, where
6231 named pipes are special objects located in
6232 \begin_inset Flex Code
6235 \begin_layout Plain Layout
6247 ) and have the names
6248 \begin_inset Quotes eld
6252 \begin_inset Flex Code
6255 \begin_layout Plain Layout
6262 \begin_inset Quotes erd
6266 \begin_inset Quotes eld
6270 \begin_inset Flex Code
6273 \begin_layout Plain Layout
6280 \begin_inset Quotes erd
6284 External programs write into
6285 \begin_inset Flex Code
6288 \begin_layout Plain Layout
6294 and read back data from
6295 \begin_inset Flex Code
6298 \begin_layout Plain Layout
6305 The stem of the pipe names can be defined in the
6306 \begin_inset Flex Noun
6309 \begin_layout Plain Layout
6310 Tools\SpecialChar menuseparator
6317 \begin_inset Flex Code
6320 \begin_layout Plain Layout
6321 "/home/myhome/lyxpipe"
6327 \begin_inset Flex Code
6330 \begin_layout Plain Layout
6344 on Windows (where any working path instead of lyxpipe can be used, for
6346 \begin_inset Flex Code
6349 \begin_layout Plain Layout
6372 configure this manually in order for the server to start.
6375 \begin_layout Standard
6378 \begin_inset Flex Code
6381 \begin_layout Plain Layout
6388 \begin_inset Flex Code
6391 \begin_layout Plain Layout
6397 ' to create the pipes.
6398 If one of the pipes already exists, \SpecialChar LyX
6399 will assume that another \SpecialChar LyX
6401 is already running and will not start the server.
6402 On POSIX (Unix like) systems, if for some other reason, an unused
6403 \begin_inset Quotes eld
6407 \begin_inset Quotes erd
6410 pipe is left in existence when \SpecialChar LyX
6411 closes, then \SpecialChar LyX
6412 will try to delete it.
6413 If this fails for some reason, you will need to delete the pipes manually
6414 and then restart \SpecialChar LyX
6416 On Windows, pipes are deleted by the OS on program termination or crash,
6418 \begin_inset Quotes eld
6422 \begin_inset Quotes erd
6425 pipes should not be possible.
6428 \begin_layout Standard
6429 To have several \SpecialChar LyX
6430 processes with servers at the same time, you have to use
6431 different configurations, perhaps by using separate user directories, each
6433 \begin_inset Flex Code
6436 \begin_layout Plain Layout
6442 file, for each process.
6445 \begin_layout Standard
6446 If you are developing a client program, you might find it useful to enable
6447 debugging information from the \SpecialChar LyX
6449 Do this by starting \SpecialChar LyX
6451 \begin_inset Flex Code
6454 \begin_layout Plain Layout
6463 \begin_layout Standard
6464 You can find a complete example client written in C++ in the source distribution
6466 \begin_inset Flex Code
6469 \begin_layout Plain Layout
6470 development/lyxserver/server_monitor.cpp
6478 \begin_layout Standard
6479 Another useful tool is the command-line based client found in
6480 \begin_inset Flex Code
6483 \begin_layout Plain Layout
6484 src/client/lyxclient
6492 \begin_layout Section
6493 Normal communication
6496 \begin_layout Standard
6497 To issue a \SpecialChar LyX
6498 call, the client writes a line of ASCII text into the input
6500 This line has the following format:
6517 \begin_layout Description
6518 clientname is a name that the client can choose arbitrarily.
6519 Its only use is that \SpecialChar LyX
6520 will echo it if it sends an answer—so a client can
6521 dispatch results from different requesters.
6524 \begin_layout Description
6525 function is the function you want \SpecialChar LyX
6527 It is the same as the commands you'd use in the minibuffer.
6530 \begin_layout Description
6531 argument is an optional argument which is meaningful only to some functions
6533 \begin_inset Quotes eld
6537 \begin_inset Quotes erd
6540 LFUN will insert the argument as text at the cursor position).
6543 \begin_layout Standard
6544 The answer from \SpecialChar LyX
6545 will arrive in the output pipe and be of the form
6562 \begin_layout Standard
6571 are just echoed from the command request, while
6575 is more or less useful information filled according to how the command
6576 execution worked out.
6577 Some commands, such as
6578 \begin_inset Quotes eld
6582 \begin_inset Quotes erd
6585 , will return information about the internal state of \SpecialChar LyX
6587 return an empty data-response.
6588 This means that the command execution went fine.
6591 \begin_layout Standard
6592 In case of errors, the response from \SpecialChar LyX
6610 \begin_layout Standard
6615 should contain an explanation of why the command failed.
6618 \begin_layout Standard
6622 \begin_layout LyX-Code
6623 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
6624 \begin_inset Newline newline
6627 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
6628 \begin_inset Newline newline
6631 read a <~/.lyxpipe.out
6632 \begin_inset Newline newline
6638 \begin_layout Subsection
6639 AppleScript (Mac OS X)
6642 \begin_layout Standard
6643 Since \SpecialChar LyX
6644 2.1, \SpecialChar LyX
6645 supports basic interactions with AppleScript for normal communicatio
6646 n through the command run.
6647 This command takes a direct argument (the
6651 to perform) and an optional argument.
6652 It either returns the output of the function or triggers an error with
6653 the error message and code.
6656 \begin_layout Standard
6660 \begin_layout LyX-Code
6661 tell application "\SpecialChar LyX
6665 \begin_layout LyX-Code
6669 \begin_layout LyX-Code
6670 -- Stores the current file name into f
6673 \begin_layout LyX-Code
6674 set f to (run "server-get-filename" with argument "")
6677 \begin_layout LyX-Code
6678 on error the error_message number the error_number
6681 \begin_layout LyX-Code
6682 display dialog "Error: " & the error_number & ".
6686 \begin_layout LyX-Code
6687 & the error_message buttons {"OK"} default button 1
6690 \begin_layout LyX-Code
6694 \begin_layout LyX-Code
6698 \begin_layout Section
6702 \begin_layout Standard
6704 can notify clients of events going on asynchronously.
6705 Currently it will only do this if the user binds a key sequence with the
6707 \begin_inset Quotes eld
6711 \begin_inset Quotes erd
6715 The format of the string \SpecialChar LyX
6716 sends is as follows:
6720 \begin_inset Flex Code
6723 \begin_layout Plain Layout
6734 \begin_layout Standard
6739 is the printed representation of the key sequence that was actually typed
6743 \begin_layout Standard
6744 This mechanism can be used to extend \SpecialChar LyX
6745 's command set and implement macros.
6746 Bind some key sequence to
6747 \begin_inset Quotes eld
6751 \begin_inset Quotes erd
6755 Then start a client that listens on the output pipe, dispatches the command
6756 according to the sequence, and starts a function that may use \SpecialChar LyX
6759 requests to issue a command or a series of commands to \SpecialChar LyX
6763 \begin_layout Section
6764 The simple \SpecialChar LyX
6768 \begin_layout Standard
6770 implements a simple protocol that can be used for session management.
6771 All messages are of the form
6784 \begin_layout Standard
6790 \begin_inset Quotes eld
6794 \begin_inset Quotes erd
6798 \begin_inset Quotes eld
6802 \begin_inset Quotes erd
6807 \begin_inset Quotes eld
6811 \begin_inset Quotes erd
6814 is received from a client, \SpecialChar LyX
6815 will report back to inform the client that
6816 it's listening to it's messages, while
6817 \begin_inset Quotes eld
6821 \begin_inset Quotes erd
6824 sent from \SpecialChar LyX
6825 will inform clients that \SpecialChar LyX
6829 \begin_layout Section
6830 Reverse DVI/PDF search
6833 \begin_layout Standard
6834 Some DVI/PDF viewers
6838 \begin_layout Plain Layout
6839 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
6840 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
6849 facility (also called
6854 This means that you can tell \SpecialChar LyX
6855 to put the cursor to a specific line in the
6856 document by clicking at the respective position in the DVI/PDF output.
6857 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
6859 This is done via the \SpecialChar LyX
6860 server either by using the named pipe (
6864 ), or the UNIX domain socket (
6868 ) that \SpecialChar LyX
6869 creates in its temporary directory (this is the way the
6870 \begin_inset Flex Code
6873 \begin_layout Plain Layout
6879 program communicates with \SpecialChar LyX
6881 In some cases, you need a helper script that mediates between the viewer
6882 and \SpecialChar LyX
6883 , in others, the viewer can communicate with \SpecialChar LyX
6885 This depends on the selected viewer and on your operating system.
6886 The same applies to the way viewers need to be configured and the way the
6887 reverse search is actually performed.
6888 In what follows, we will thus describe how to setup reverse search for
6890 Before we turn to this, though, we will explain what needs to be done generally
6891 to enable reverse search in the DVI/PDF output.
6894 \begin_layout Subsection
6896 \begin_inset CommandInset label
6898 name "subsec:rev-search"
6905 \begin_layout Standard
6906 In most cases \SpecialChar LyX
6907 will do the work for you by pressing the following button
6911 arg "buffer-toggle-output-sync"
6915 Alternatively, you can also enable the feature by checking
6917 Synchronize with Output
6920 \begin_inset Flex Noun
6923 \begin_layout Plain Layout
6924 Document\SpecialChar menuseparator
6925 Settings\SpecialChar menuseparator
6932 In such a case \SpecialChar LyX
6933 will automatically insert the necessary Sync\SpecialChar TeX
6935 PDF) or load the srcltx package (for DVI) respectively.
6936 This option can be easily reached also on
6937 \begin_inset Flex Code
6940 \begin_layout Plain Layout
6949 \begin_layout Standard
6950 If you need a different setting, you can select or input a custom macro
6951 from the drop down box just below
6952 \begin_inset Flex Noun
6955 \begin_layout Plain Layout
6956 Document\SpecialChar menuseparator
6957 Settings\SpecialChar menuseparator
6958 Output\SpecialChar menuseparator
6959 Synchronize with Output
6967 \begin_layout Standard
6968 Note that the method
6969 \begin_inset Flex Code
6972 \begin_layout Plain Layout
6980 enables gzip compression.
6981 If your viewer does not support it, you should instead use
6982 \begin_inset Flex Code
6985 \begin_layout Plain Layout
6996 \begin_layout Standard
6997 Please also note that including the
6998 \begin_inset Flex Code
7001 \begin_layout Plain Layout
7008 \begin_inset Flex Code
7011 \begin_layout Plain Layout
7017 sometimes has an undesired impact on the typesetting.
7018 Thus, you should switch output synchronization off for the final typesetting
7020 \begin_inset Flex Code
7023 \begin_layout Plain Layout
7030 \begin_inset Flex Code
7033 \begin_layout Plain Layout
7043 \begin_layout Standard
7044 In case you need some more special settings that are not covered by the
7045 automatic settings, read the next section about how to set up output synchroniz
7047 If the automatic setup suits your needs, you can readily jump to section
7048 \begin_inset space ~
7052 \begin_inset CommandInset ref
7054 reference "subsec:configuring-viewers"
7058 , where the necessary configuration steps in your viewer – needed both with
7059 the automatic and the manual setup – are described.
7062 \begin_layout Subsection
7066 \begin_layout Standard
7068 provides several different methods for reverse search.
7069 Some are built-in in the
7070 \begin_inset Flex Code
7073 \begin_layout Plain Layout
7079 program, some are provided by external packages.
7080 Your choice depends on whether your \SpecialChar LaTeX
7081 distribution already provides a given
7082 method (the built-in methods are rather new) and whether your viewer can
7084 The available methods are described in the following.
7087 \begin_layout Subsubsection*
7088 Built-in DVI-search via src-specials (DVI only)
7091 \begin_layout Standard
7092 This method provides the DVI file with the necessary information for reverse
7094 It is available in \SpecialChar LaTeX
7095 since quite some time (any somewhat recent \SpecialChar LaTeX
7097 should include it), and it works reliably.
7098 To enable it, change the
7099 \begin_inset Flex Noun
7102 \begin_layout Plain Layout
7113 \begin_inset Flex Noun
7116 \begin_layout Plain Layout
7127 \begin_inset Flex Noun
7130 \begin_layout Plain Layout
7131 Preferences\SpecialChar menuseparator
7132 File Handling\SpecialChar menuseparator
7139 \begin_inset Flex Code
7142 \begin_layout Plain Layout
7143 latex -src-specials $$i
7149 If this doesn't work, check if your \SpecialChar TeX
7150 engine needs different options (the
7151 syntax might differ in some distributions).
7154 \begin_layout Subsubsection*
7155 External Packages (PDFSync and scrltx)
7158 \begin_layout Standard
7167 provide reverse search facility for PDF output (via pdflatex) and DVI output,
7169 In order to enable it, load the packages in the \SpecialChar LyX
7173 \begin_layout Itemize
7174 \begin_inset Flex Code
7177 \begin_layout Plain Layout
7185 for reverse PDF search,
7188 \begin_layout Itemize
7189 \begin_inset Flex Code
7192 \begin_layout Plain Layout
7195 usepackage[active]{srcltx}
7200 for reverse DVI search.
7203 \begin_layout Standard
7204 If you want to be able to perform both DVI and PDF reverse searches, you
7205 can also insert in the preamble the following lines
7208 \begin_layout LyX-Code
7212 \begin_inset Newline newline
7218 \begin_inset Newline newline
7224 \begin_inset Newline newline
7230 \begin_inset Newline newline
7235 usepackage[active]{srcltx}
7236 \begin_inset Newline newline
7244 \begin_layout Standard
7245 This way, you can preview the file as either DVI or PDF (pdflatex) and the
7246 right package will be used.
7249 \begin_layout Standard
7250 Note that PDFSync might affect the output layout of your document.
7251 It is therefore advised to disable PDFsync for final documents.
7254 \begin_layout Subsubsection*
7255 Built-in reverse search via Sync\SpecialChar TeX
7259 \begin_layout Standard
7261 \begin_inset Flex Code
7264 \begin_layout Plain Layout
7270 have built-in support for both PDF and DVI reverse search.
7273 Sync\SpecialChar TeX
7276 facility is basically the result of the integration of the PDFSync package
7277 to the pdftex program and its merge with the
7282 You need at least \SpecialChar TeX
7283 Live 2008 or a recent Mik\SpecialChar TeX
7284 distribution in order to use
7289 \begin_layout Plain Layout
7290 For some reason, Mik\SpecialChar TeX
7291 does not understand/obey the command \SpecialChar LyX
7293 the preamble when you check the "Enable Forward/Reverse Search" button
7294 in the toolbar and does not generate the necessary info.
7297 \begin_layout Plain Layout
7298 The generation of the required info can be forced by changing the converter
7300 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
7301 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
7302 the -synctex=1 switch).
7307 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
7308 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
7309 already provide Sync\SpecialChar TeX
7313 \begin_layout Standard
7314 To enable Sync\SpecialChar TeX
7315 for DVI output, change the
7316 \begin_inset Flex Noun
7319 \begin_layout Plain Layout
7330 \begin_inset Flex Noun
7333 \begin_layout Plain Layout
7344 \begin_inset Flex Noun
7347 \begin_layout Plain Layout
7348 Preferences\SpecialChar menuseparator
7349 File Handling\SpecialChar menuseparator
7356 \begin_inset Flex Code
7359 \begin_layout Plain Layout
7360 latex -synctex=1 $$i
7365 , and for PDF output, change the
7366 \begin_inset Flex Noun
7369 \begin_layout Plain Layout
7374 (pdflatex) -> PDF (pdflatex)
7380 \begin_inset Flex Code
7383 \begin_layout Plain Layout
7384 pdflatex -synctex=1 $$i
7390 Should your viewer not be considered in the following description, or in
7391 case of missing success, please check the documentation of your viewer
7392 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
7397 \begin_layout Plain Layout
7398 Note that the option
7399 \begin_inset Flex Code
7402 \begin_layout Plain Layout
7408 option enables gzip compression.
7409 If your viewer does not support it, you should instead use
7410 \begin_inset Flex Code
7413 \begin_layout Plain Layout
7427 \begin_layout Subsection
7428 Configuring and using specific viewers
7429 \begin_inset CommandInset label
7431 name "subsec:configuring-viewers"
7438 \begin_layout Subsubsection*
7439 Xdvi (all platforms)
7442 \begin_layout Standard
7444 \begin_inset Flex Code
7447 \begin_layout Plain Layout
7453 , you don't need to do anything else for performing a reverse DVI search,
7455 already provides the necessary hooks for automatically using the
7456 \begin_inset Flex Code
7459 \begin_layout Plain Layout
7466 Just setup your document as described above (reverse search is triggered
7467 by Ctrl-click or Alt-click on Mac OSX, respectively).
7470 \begin_layout Standard
7471 However, if for whatever reason you want to use the named pipe instead of
7472 the socket for communicating with \SpecialChar LyX
7473 , simply change the DVI viewer in
7474 \begin_inset Flex Noun
7477 \begin_layout Plain Layout
7478 Preferences\SpecialChar menuseparator
7479 File Handling\SpecialChar menuseparator
7489 \begin_layout Plain Layout
7490 On Mac OSX you have to use
7491 \begin_inset Flex Code
7494 \begin_layout Plain Layout
7495 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
7506 \begin_inset Flex Code
7509 \begin_layout Plain Layout
7510 xdvi -editor "lyxeditor.sh %f %l"
7516 \begin_inset Flex Code
7519 \begin_layout Plain Layout
7525 is a suitable script.
7526 For example, a minimal shell script is the following one:
7529 \begin_layout LyX-Code
7531 \begin_inset Newline newline
7534 LYXPIPE="/path/to/lyxpipe"
7535 \begin_inset Newline newline
7538 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
7539 \begin_inset Newline newline
7542 echo "$COMMAND" > "${LYXPIPE}".in || exit
7543 \begin_inset Newline newline
7546 read TMP < "${LYXPIPE}".out || exit
7549 \begin_layout Standard
7551 \begin_inset Flex Code
7554 \begin_layout Plain Layout
7560 is the LyXServer pipe path specified in
7561 \begin_inset Flex Noun
7564 \begin_layout Plain Layout
7565 Preferences\SpecialChar menuseparator
7575 \begin_layout Plain Layout
7577 \begin_inset Flex Code
7580 \begin_layout Plain Layout
7586 folder of a source distribution you can find a
7587 \begin_inset Flex Code
7590 \begin_layout Plain Layout
7596 script which is able to locate the
7600 based on your preferences.
7608 \begin_layout Subsubsection*
7612 \begin_layout Standard
7614 \begin_inset Flex Code
7617 \begin_layout Plain Layout
7618 /Applications/MacDviX_Folder/calleditor.script
7623 , add the following lines:
7626 \begin_layout LyX-Code
7627 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
7628 \begin_inset Newline newline
7634 \begin_layout Standard
7635 Modify the lines accordingly if you install \SpecialChar LyX
7636 somewhere else than in the
7637 Applications folder.
7640 \begin_layout Standard
7641 Reverse search is triggered by Alt-click (OPTION-click).
7644 \begin_layout Subsubsection*
7648 \begin_layout Standard
7650 \begin_inset Flex Code
7653 \begin_layout Plain Layout
7654 open -a Skim.app $$i
7659 to the viewer setting in
7660 \begin_inset Flex Noun
7663 \begin_layout Plain Layout
7664 Preferences\SpecialChar menuseparator
7665 File Handling\SpecialChar menuseparator
7666 File formats\SpecialChar menuseparator
7673 \begin_inset Flex Noun
7676 \begin_layout Plain Layout
7677 Skim\SpecialChar menuseparator
7678 Preferences\SpecialChar menuseparator
7685 \begin_inset Flex Noun
7688 \begin_layout Plain Layout
7694 preset and enter command
7695 \begin_inset Flex Noun
7698 \begin_layout Plain Layout
7699 /Applications/\SpecialChar LyX
7700 .app/Contents/MacOS/lyxeditor
7708 \begin_layout Standard
7709 Reverse search is triggered by COMMAND-SHIFT-click
7712 \begin_layout Subsubsection*
7716 \begin_layout Standard
7717 Reverse search with evince does not work out of the box, but it can be achieved
7718 by means of some third party helper scripts.
7720 \begin_inset CommandInset href
7722 target "https://wiki.lyx.org/LyX/SyncTeX"
7730 \begin_layout Subsubsection*
7734 \begin_layout Standard
7736 \begin_inset Flex Noun
7739 \begin_layout Plain Layout
7740 Settings\SpecialChar menuseparator
7741 Configure Okular\SpecialChar menuseparator
7748 \begin_inset Quotes erd
7752 This inserts the appropriate command (
7753 \begin_inset Flex Code
7756 \begin_layout Plain Layout
7765 \begin_layout Standard
7766 Reverse search is triggered by SHIFT-click.
7768 \change_inserted -712698321 1578211026
7769 Note that this only works if Okular is in
7770 \begin_inset Quotes eld
7774 \begin_inset Quotes erd
7778 \begin_inset space \thinspace{}
7781 e., the hand symbol is clicked).
7786 \begin_layout Subsubsection*
7790 \begin_layout Standard
7791 Qpdfview supports Sync\SpecialChar TeX
7792 since version 0.3.5.
7794 \begin_inset Flex Noun
7797 \begin_layout Plain Layout
7798 Edit\SpecialChar menuseparator
7799 Settings\SpecialChar menuseparator
7805 , click on the input field of the
7806 \begin_inset Quotes eld
7810 \begin_inset Quotes erd
7813 item and add the command
7814 \begin_inset Flex Code
7817 \begin_layout Plain Layout
7826 \begin_layout Standard
7827 Reverse search is triggered by double-click or, in more recent versions,
7831 \begin_layout Subsubsection*
7835 \begin_layout Standard
7836 Launch yap, choose its
7837 \begin_inset Flex Noun
7840 \begin_layout Plain Layout
7841 View\SpecialChar menuseparator
7848 \begin_inset Quotes eld
7852 \begin_inset Quotes erd
7857 \begin_inset Quotes eld
7860 New\SpecialChar ldots
7862 \begin_inset Quotes erd
7865 button and, in the window that opens, enter
7866 \begin_inset Quotes eld
7871 \begin_inset Quotes erd
7874 (or any other name you like) in the
7875 \begin_inset Quotes eld
7879 \begin_inset Quotes erd
7883 Now click on the button labeled
7884 \begin_inset Quotes eld
7889 \begin_inset Quotes erd
7892 to open a file dialog and navigate to the directory containing the batch
7894 \begin_inset Flex Code
7897 \begin_layout Plain Layout
7905 \begin_inset Flex Code
7908 \begin_layout Plain Layout
7914 and then specify the program arguments as
7915 \begin_inset Flex Code
7918 \begin_layout Plain Layout
7926 \begin_inset Flex Code
7929 \begin_layout Plain Layout
7935 wrapper is used for communicating with \SpecialChar LyX
7943 \begin_layout LyX-Code
7945 \begin_inset Newline newline
7948 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
7957 \begin_inset Newline newline
7971 \begin_layout Standard
7972 Make sure that the \SpecialChar LyX
7973 Server pipe path you specified in \SpecialChar LyX
7975 \begin_inset Flex Code
7978 \begin_layout Plain Layout
7992 , otherwise change the
7993 \begin_inset Flex Code
7996 \begin_layout Plain Layout
8002 wrapper accordingly.
8005 \begin_layout Standard
8006 In yap, reverse search is triggered by double-click.
8009 \begin_layout Subsubsection*
8010 SumatraPDF (Windows)
8013 \begin_layout Standard
8014 In order to use SumatraPDF for inverse search, enter
8015 \begin_inset Flex Code
8018 \begin_layout Plain Layout
8019 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
8024 in the viewer setting in
8025 \begin_inset Flex Noun
8028 \begin_layout Plain Layout
8029 Preferences\SpecialChar menuseparator
8030 File Handling\SpecialChar menuseparator
8031 File formats\SpecialChar menuseparator
8038 \begin_inset Flex Code
8041 \begin_layout Plain Layout
8047 is the previous wrapper.
8048 If SumatraPDF.exe is not in your command PATH, use its full file name.
8051 \begin_layout Standard
8052 Reverse search is triggered by double-click.
8055 \begin_layout Subsubsection*
8059 \begin_layout Standard
8060 First of all, make sure that yap is your default DVI viewer in the Windows
8061 environment, then launch it, choose its
8062 \begin_inset Flex Noun
8065 \begin_layout Plain Layout
8066 View\SpecialChar menuseparator
8073 \begin_inset Quotes eld
8077 \begin_inset Quotes erd
8082 \begin_inset Quotes eld
8085 New\SpecialChar ldots
8087 \begin_inset Quotes erd
8090 button and, in the window that opens, enter
8091 \begin_inset Quotes eld
8096 \begin_inset Quotes erd
8099 (or any other name you like) in the
8100 \begin_inset Quotes eld
8104 \begin_inset Quotes erd
8108 Now click on the button labeled
8109 \begin_inset Quotes eld
8114 \begin_inset Quotes erd
8117 to open a file dialog and navigate to the directory containing the
8118 \begin_inset Flex Code
8121 \begin_layout Plain Layout
8127 program (which is installed by default on Cygwin along with the \SpecialChar LyX
8130 \begin_inset Flex Code
8133 \begin_layout Plain Layout
8139 and then specify the program arguments as
8140 \begin_inset Flex Code
8143 \begin_layout Plain Layout
8150 In this way, you will be using the
8154 for communicating with \SpecialChar LyX
8156 If, for whatever reason, you want to use the
8161 \begin_inset Flex Code
8164 \begin_layout Plain Layout
8170 option and be sure to specify the \SpecialChar LyX
8171 Server pipe path in the \SpecialChar LyX
8175 \begin_layout Standard
8176 In yap, reverse search is triggered by double-click.
8179 \begin_layout Subsubsection*
8183 \begin_layout Standard
8184 In order to use SumatraPDF for inverse search, enter
8185 \begin_inset Flex Code
8188 \begin_layout Plain Layout
8189 SumatraPDF -inverse-search "lyxeditor -g %f %l"
8194 in the viewer setting in
8195 \begin_inset Flex Noun
8198 \begin_layout Plain Layout
8199 Preferences\SpecialChar menuseparator
8200 File Handling\SpecialChar menuseparator
8201 File formats\SpecialChar menuseparator
8208 If SumatraPDF.exe is not in your command PATH, use its full posix path.
8210 \begin_inset Flex Code
8213 \begin_layout Plain Layout
8219 enables communication via the
8225 \begin_inset Flex Code
8228 \begin_layout Plain Layout
8234 option if you want to use the
8238 , and be sure to specify the \SpecialChar LyX
8239 Server pipe path in the \SpecialChar LyX
8243 \begin_layout Standard
8244 Reverse search is triggered by double-click.
8247 \begin_layout Section
8251 \begin_layout Standard
8252 Forward search is, as the name implies, in a sense the
8253 \begin_inset Quotes eld
8257 \begin_inset Quotes erd
8261 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
8263 If forward search is set up (as described in what follows), you can put
8264 the cursor anywhere in your \SpecialChar LyX
8266 \begin_inset Flex Noun
8269 \begin_layout Plain Layout
8270 Navigate\SpecialChar menuseparator
8277 \begin_inset Flex Noun
8280 \begin_layout Plain Layout
8286 in the context menu via right mouse click), and then the viewer will jump
8287 to that position as well.
8288 This implies, of course, that your viewer supports this function.
8291 \begin_layout Standard
8292 To make forward search possible, you first need to provide the generated
8293 output PDF/DVI file with additional information about the \SpecialChar TeX
8295 This can be done via the methods described in the section
8296 \begin_inset CommandInset ref
8298 reference "subsec:rev-search"
8305 \begin_layout Standard
8306 Additionally, you need to configure \SpecialChar LyX
8307 for using your viewers in
8308 \begin_inset Flex Noun
8311 \begin_layout Plain Layout
8312 Tools\SpecialChar menuseparator
8313 Preferences\SpecialChar menuseparator
8314 Output\SpecialChar menuseparator
8321 We provide a range of tested configurations for some viewers, which you
8322 can select from the drop down list.
8323 If none of these configurations suits you, you have to find out and enter
8324 a suitable configuration yourself.
8325 The definition syntax uses the following placeholders:
8328 \begin_layout Itemize
8330 \begin_inset Flex Code
8333 \begin_layout Plain Layout
8342 \begin_layout Itemize
8344 \begin_inset Flex Code
8347 \begin_layout Plain Layout
8353 : name of the (temporary) exported .tex file (without path)
8356 \begin_layout Itemize
8358 \begin_inset Flex Code
8361 \begin_layout Plain Layout
8367 : name of the (temporary) exported .tex file (including path)
8370 \begin_layout Itemize
8372 \begin_inset Flex Code
8375 \begin_layout Plain Layout
8381 : name of the exported output file (either dvi or pdf, depending on which
8382 one exists in the temporary directory)
8385 \begin_layout Standard
8386 Note that only some of the viewers provide full and usable forward search
8387 functionality out of the box, among them yap, xdvi, okular
8391 \begin_layout Plain Layout
8392 You might want to set
8393 \begin_inset Flex Code
8396 \begin_layout Plain Layout
8403 \begin_inset Flex Noun
8406 \begin_layout Plain Layout
8407 Tools\SpecialChar menuseparator
8408 Preferences\SpecialChar menuseparator
8409 File Handling\SpecialChar menuseparator
8411 \begin_inset space ~
8424 , qpdfview, and SumatraPDF
8428 \begin_layout Plain Layout
8429 SumatraPDF can also use DDE commands through the external program CMCDDE
8431 \begin_inset CommandInset href
8433 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
8444 Others, such as evince
8448 \begin_layout Plain Layout
8449 Forward search with evince can be achieved by means of third party helper
8452 \begin_inset CommandInset href
8454 target "https://wiki.lyx.org/LyX/SyncTeX"
8464 , require some extra tools in order to use forward search.
8465 While many of the widespread PDF viewers (most notably Adobe Reader) do
8466 not support forward search at all, some other viewers – e.
8467 \begin_inset space \thinspace{}
8471 xpdf – allow at least to reload the document and jump to a specific page
8472 of the file, so you can at least navigate
8473 \begin_inset Quotes eld
8477 \begin_inset Quotes erd
8481 This latter functionality is provided by an external call of synctex (see
8482 the predefined example configurations).
8486 \begin_layout Standard
8487 Forward search works both with DVI and PDF output.
8489 simply checks which preview format you have used before (i.
8490 \begin_inset space \thinspace{}
8493 e., which format is already there in the temporary directory) and chooses
8494 the appropriate configuration for the respective format.
8497 \begin_layout Chapter
8498 Special Document Classes
8501 \begin_layout Section
8503 \change_deleted 564990737 1669742044
8507 \begin_layout Standard
8509 \change_deleted 564990737 1669742044
8515 \begin_layout Subsection
8517 \change_deleted 564990737 1669742044
8521 \begin_layout Standard
8523 \change_deleted 564990737 1669742044
8524 This section describes how \SpecialChar LyX
8525 can be used to write articles for submission
8526 to the scientific journal
8528 Astronomy and Astrophysics
8531 \begin_inset Flex URL
8534 \begin_layout Plain Layout
8536 https://www.aanda.org/
8541 ) using Version 5.01 of the document class
8546 This package can be downloaded from the ftp site
8549 \begin_layout Standard
8551 \change_deleted 564990737 1669742044
8552 \begin_inset VSpace medskip
8558 \begin_layout Standard
8561 \change_deleted 564990737 1669742044
8562 \begin_inset Flex URL
8565 \begin_layout Plain Layout
8567 ftp://ftp.edpsciences.org/pub/aa/readme.html
8575 \begin_layout Standard
8577 \change_deleted 564990737 1669742044
8578 \begin_inset VSpace medskip
8584 \begin_layout Standard
8586 \change_deleted 564990737 1669742044
8587 A manual comes together with that package, and this text is not meant to
8588 replace the original manual but is merely a short guide in how to realize
8589 the correct form of your paper.
8593 \begin_layout Standard
8595 \change_deleted 564990737 1669742044
8596 Please note that the publisher of the journal was changed from Springer
8597 to EDP Sciences starting January 1, 2001.
8598 That change involved also some slight changes to the style files, namely
8599 the removal of the thesaurus command.
8600 The \SpecialChar LyX
8601 class aa supports the newest version of these style files, V 5.01.
8602 If you have an older version installed, please upgrade.
8603 For compatibility, the old (version 4) layout has been kept as
8608 Please refer to the comments in
8611 Dir/layouts/aapaper.layout
8616 \begin_layout Subsection
8618 \change_deleted 564990737 1669742044
8622 \begin_layout Standard
8624 \change_deleted 564990737 1669742044
8625 It is recommended you start from the example template distributed with \SpecialChar LyX
8627 If you are not using a template, note the following settings:
8630 \begin_layout Itemize
8632 \change_deleted 564990737 1669742044
8639 Document\SpecialChar menuseparator
8642 dialog (OK, that one was obvious).
8645 \begin_layout Itemize
8647 \change_deleted 564990737 1669742044
8648 Don't change the option
8651 \begin_inset space ~
8661 The whole layout is done by the macros, you shouldn't change anything.
8664 \begin_layout Subsection
8666 \change_deleted 564990737 1669742044
8670 \begin_layout Standard
8672 \change_deleted 564990737 1669742044
8673 First thing to enter is the header information.
8674 It consists of seven entries, of which some are optional.
8678 \begin_layout Itemize
8680 \change_deleted 564990737 1669742044
8688 \begin_layout Itemize
8690 \change_deleted 564990737 1669742044
8698 \begin_layout Itemize
8700 \change_deleted 564990737 1669742044
8708 \begin_layout Itemize
8710 \change_deleted 564990737 1669742044
8718 \begin_layout Itemize
8720 \change_deleted 564990737 1669742044
8725 : [optional] if more than one author: whom to contact for offprint requests.
8728 \begin_layout Itemize
8730 \change_deleted 564990737 1669742044
8735 : [optional] mail address for contacts.
8738 \begin_layout Itemize
8740 \change_deleted 564990737 1669742044
8748 Received: <date>; Accepted <date>
8751 \begin_layout Standard
8753 \change_deleted 564990737 1669742044
8754 There is no need to issue the
8760 command, this is done automatically by \SpecialChar LyX
8761 when the header is finished.
8762 Although the order of the single header entries doesn't matter it is advised
8763 to keep the above sequence, just to get the best optics and meets the layout
8764 of the real document.
8767 \begin_layout Standard
8769 \change_deleted 564990737 1669742044
8770 If you want to place footnotes in the header block, e.
8771 \begin_inset space \thinspace{}
8775 \begin_inset space \space{}
8778 to state your present address, just use the standard footnote via the menu
8781 Insert\SpecialChar menuseparator
8786 will automagically use the term
8795 \begin_layout Standard
8797 \change_deleted 564990737 1669742044
8800 Edit\SpecialChar menuseparator
8803 , you'll find two insets which are relevant for the titling:
8806 \begin_layout Itemize
8808 \change_deleted 564990737 1669742044
8815 to mark corresponding author\SpecialChar breakableslash
8817 The institutes are numbered sequentially as they appear in the
8821 field, so you have to put a marker to each author.
8824 \begin_layout Itemize
8826 \change_deleted 564990737 1669742044
8831 to supply an email address for fast contact.
8834 \begin_layout Standard
8836 \change_deleted 564990737 1669742044
8837 In addition to these topics, the macros use one additional \SpecialChar LaTeX
8839 has no counterpart in \SpecialChar LyX
8843 \begin_layout Itemize
8845 \change_deleted 564990737 1669742044
8852 to separate different names for more than one author and institute, respectivel
8856 \begin_layout Standard
8858 \change_deleted 564990737 1669742044
8859 The appropriate command has to be entered in \SpecialChar LyX
8860 and marked as \SpecialChar LaTeX
8866 \begin_layout Subsection
8868 \change_deleted 564990737 1669742044
8872 \begin_layout Standard
8874 \change_deleted 564990737 1669742044
8875 The abstract should immediately follow the header block.
8876 With version 5 the abstract environment was changed to a command, and there
8877 is now a restriction to only one paragraph.
8878 In addition, it should contain an entry with the keywords.
8879 This is done via the paragraph style
8884 Refer to the example paper.
8887 \begin_layout Subsection
8889 \change_deleted 564990737 1669742044
8890 Supported environments
8893 \begin_layout Standard
8895 \change_deleted 564990737 1669742044
8896 The A&A paper layout supports the following environments for structuring
8900 \begin_layout Itemize
8902 \change_deleted 564990737 1669742044
8908 \begin_layout Itemize
8910 \change_deleted 564990737 1669742044
8916 \begin_layout Itemize
8918 \change_deleted 564990737 1669742044
8924 \begin_layout Itemize
8926 \change_deleted 564990737 1669742044
8932 \begin_layout Itemize
8934 \change_deleted 564990737 1669742044
8940 \begin_layout Itemize
8942 \change_deleted 564990737 1669742044
8948 \begin_layout Itemize
8950 \change_deleted 564990737 1669742044
8956 \begin_layout Itemize
8958 \change_deleted 564990737 1669742044
8964 \begin_layout Itemize
8966 \change_deleted 564990737 1669742044
8972 \begin_layout Itemize
8974 \change_deleted 564990737 1669742044
8980 \begin_layout Itemize
8982 \change_deleted 564990737 1669742044
8988 \begin_layout Itemize
8990 \change_deleted 564990737 1669742044
8997 \begin_layout Subsection
8999 \change_deleted 564990737 1669742044
9000 Commands not supported by \SpecialChar LyX
9004 \begin_layout Standard
9006 \change_deleted 564990737 1669742044
9007 Some commands are not yet supported by the
9011 layout for \SpecialChar LyX
9013 Some have already been mentioned.
9014 For the sake of completeness, they are listed all together here:
9017 \begin_layout Itemize
9019 \change_deleted 564990737 1669742044
9027 \begin_layout Itemize
9029 \change_deleted 564990737 1669742044
9037 \begin_layout Itemize
9039 \change_deleted 564990737 1669742044
9047 \begin_layout Itemize
9049 \change_deleted 564990737 1669742044
9057 \begin_layout Standard
9059 \change_deleted 564990737 1669742044
9060 If you want to use any of these commands, you have to enter them yourself.
9063 Do not forget to mark them as \SpecialChar LaTeX
9067 \begin_layout Subsection
9069 \change_deleted 564990737 1669742044
9070 Figure and Table Floats
9073 \begin_layout Standard
9075 \change_deleted 564990737 1669742044
9077 provides support for the necessary float environments
9079 figure, figure*, table
9085 , therefore we won't tell much about it here.
9089 \begin_inset space ~
9095 Just remember that tables should be left-aligned.
9096 For that, select the table and change the alignment in
9098 Edit\SpecialChar menuseparator
9100 \begin_inset space ~
9106 \begin_layout Standard
9108 \change_deleted 564990737 1669742044
9109 There is only one special thing: the figures with caption besides the figure.
9110 To create such a figure, you have to do the following:
9113 \begin_layout Enumerate
9115 \change_deleted 564990737 1669742044
9116 Create a wide figure float:
9118 Insert\SpecialChar menuseparator
9119 Float\SpecialChar menuseparator
9122 , then right click in the figure and select
9125 \begin_inset space ~
9133 \begin_layout Enumerate
9135 \change_deleted 564990737 1669742044
9136 Enter your caption text.
9139 \begin_layout Enumerate
9141 \change_deleted 564990737 1669742044
9146 to move the cursor above the caption.
9149 \begin_layout Enumerate
9151 \change_deleted 564990737 1669742044
9155 \begin_layout Enumerate
9157 \change_deleted 564990737 1669742044
9158 Position the cursor behind the figure and insert a horizontal fill:
9160 Insert\SpecialChar menuseparator
9162 \begin_inset space ~
9165 Character\SpecialChar menuseparator
9167 \begin_inset space ~
9175 \begin_layout Enumerate
9177 \change_deleted 564990737 1669742044
9178 Switch to \SpecialChar LaTeX
9182 \begin_inset space ~
9190 \begin_layout Enumerate
9192 \change_deleted 564990737 1669742044
9202 Do not close the brace!
9205 \begin_layout Enumerate
9207 \change_deleted 564990737 1669742044
9208 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
9213 \begin_inset space ~
9225 \begin_layout Standard
9227 \change_deleted 564990737 1669742044
9228 Also, refer to the figures in the example paper.
9231 \begin_layout Subsection
9233 \change_deleted 564990737 1669742044
9237 \begin_layout Standard
9239 \change_deleted 564990737 1669742044
9240 For submission, the paper has to be formated in a special double-spacing
9242 For this purpose, you have to give the option
9246 to the document class.
9247 This must be done using the custom class options field in the
9249 Document\SpecialChar menuseparator
9253 Just enter the string
9260 \begin_layout Subsection
9262 \change_deleted 564990737 1669742044
9266 \begin_layout Standard
9268 \change_deleted 564990737 1669742044
9273 directory contains an example paper written with \SpecialChar LyX
9275 It is the example paper from the original macro package, translated to
9278 Use it for inspiration, and compare the original \SpecialChar LaTeX
9279 code with \SpecialChar LyX
9283 \begin_layout Section
9288 \begin_layout Standard
9294 \begin_layout Subsection
9298 \begin_layout Standard
9300 is a set of macros produced by the American Astronomical Society to
9301 facilitate electronic manuscript submission to the three journals they
9302 publish: the Astrophysical Journal (including the Letters and Supplement),
9303 the Astronomical Journal, and the Publications of the Astronomical Society
9306 has proven to be an excellent tool for generating these documents, especially
9307 given its equation, citation, and figure handling capabilities.
9309 requires version 5.0 (or higher) of these macros; preferably 6.0, which
9310 is the version described here, or higher.
9311 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
9312 2.09 and are fundamentally
9313 incompatible with \SpecialChar LyX
9315 The AAS\SpecialChar TeX
9316 package may be downloaded from the AAS\SpecialChar TeX
9320 \begin_layout Standard
9321 \begin_inset VSpace medskip
9327 \begin_layout Standard
9329 \begin_inset Flex URL
9332 \begin_layout Plain Layout
9334 https://aas.org/aastex/aastex-downloads
9342 \begin_layout Standard
9343 \begin_inset VSpace medskip
9349 \begin_layout Standard
9350 A complete user guide is contained in that package and you should familiarize
9351 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
9354 will not reduce the need to figure out all the AAS\SpecialChar TeX
9355 commands, it will only
9356 reduce the drudgery of typing everything in.
9357 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
9359 completely to the requirements of the journal to which you are submitting
9363 \begin_layout Subsection
9364 Starting a New Paper
9367 \begin_layout Standard
9368 I strongly suggest that you start with the AAS\SpecialChar TeX
9372 File\SpecialChar menuseparator
9379 , enter the new file name, then choose the
9384 This will show the most common fields found in a manuscript.
9385 Simply overwrite the existing text (including the brackets,
9389 ) with the correct information.
9390 Many of the AAS\SpecialChar TeX
9391 commands and environments can be implemented directly in
9394 For commands such as these, the \SpecialChar LaTeX
9395 code must be entered directly and marked
9397 Such commands are referred to as \SpecialChar TeX
9398 code, or Evil Red Text.
9399 I tried to minimize the amount of \SpecialChar TeX
9400 code needed in an AAS\SpecialChar TeX
9404 \begin_layout Subsection
9405 Finishing Your Paper
9408 \begin_layout Standard
9409 When the paper is finished to your satisfaction and previews/prints correctly,
9411 \begin_inset Quotes eld
9415 \begin_inset Quotes erd
9418 actions which need to be done before you submit it to the journals.
9422 \begin_layout Enumerate
9423 Export your paper as a \SpecialChar LaTeX
9426 File\SpecialChar menuseparator
9427 Export\SpecialChar menuseparator
9435 \begin_layout Enumerate
9440 file with your favorite text editor
9444 \begin_layout Enumerate
9445 remove the comment lines before the
9454 \begin_layout Enumerate
9459 usepackage...{fontenc}
9461 line if it appears (usually just after
9476 \begin_layout Enumerate
9477 remove everything between (and including) the
9489 commands, except for any commands you specifically put into the \SpecialChar LaTeX
9491 (which should appear immediately after the
9492 \begin_inset Quotes eld
9495 User specified \SpecialChar LaTeX
9497 \begin_inset Quotes erd
9508 \begin_layout Enumerate
9509 Run the resulting file through \SpecialChar LaTeX
9510 to make sure it still processes correctly.
9513 \begin_layout Enumerate
9514 Reread the journal requirements to make sure your filenames and formats
9518 \begin_layout Enumerate
9522 \begin_layout Subsection
9523 Comments On Specific Commands
9526 \begin_layout Standard
9527 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
9534 ) gives a good description of each.
9535 Thus it's probably easiest for me to go down the list as found in the guide
9536 and offer comments where necessary.
9537 So let's begin \SpecialChar ldots
9541 \begin_layout Subsubsection
9542 Things that work as expected
9545 \begin_layout Standard
9546 Because they work as you might expect, I simply list them and the section
9647 begin{thebibliography}
9655 (2.13.2), all the cite commands and their variations (2.13.2), the generic
9656 graphicx figure commands (2.14.1),
9680 (2.15.4, amongst other places),
9707 \begin_layout Standard
9708 The following style options also work correctly:
9729 Simply put them in the
9735 Layout\SpecialChar menuseparator
9741 \begin_layout Subsubsection
9742 Things that work, but require more comment
9745 \begin_layout Standard
9746 The following items work, but require a little more discussion:
9749 \begin_layout Itemize
9750 These items are reserved for use by the journal editors, but you can put
9751 them into the \SpecialChar LaTeX
9752 preamble if you feel compelled to do so:
9785 \begin_layout Itemize
9786 These items may be placed in the \SpecialChar LaTeX
9787 preamble, and are included as blanks in
9809 \begin_layout Itemize
9816 (2.3) – can only be used
9817 \begin_inset Quotes eld
9821 \begin_inset Quotes erd
9824 , not in the middle of a paragraph.
9825 Use \SpecialChar TeX
9826 code if you need to embed it.
9829 \begin_layout Itemize
9836 (2.3) – will have extra {} after it.
9837 This should not cause an error.
9840 \begin_layout Itemize
9847 (2.6) – can only be used
9848 \begin_inset Quotes eld
9852 \begin_inset Quotes erd
9855 , not in the middle of a paragraph.
9856 Use \SpecialChar TeX
9857 code if you need to embed it.
9860 \begin_layout Itemize
9867 (2.8) – can't insert a cross-reference tag, you must type the tag name by
9871 \begin_layout Itemize
9885 \begin_layout Itemize
9892 (2.9) – will have extra {} after it.
9893 This should not cause an error.
9896 \begin_layout Itemize
9903 (2.11) – will have extra {} after it.
9904 This should not cause an error.
9907 \begin_layout Itemize
9914 (2.14.2) – you can insert an optional filename argument by placing the cursor
9915 at the beginning of the text and selecting
9917 Insert\SpecialChar menuseparator
9922 \begin_inset Quotes eld
9926 \begin_inset Quotes erd
9929 inserts an optional argument of the type needed by
9936 Hopefully it will be renamed someday.
9939 \begin_layout Itemize
9952 for the catalog ID optional parameter
9955 \begin_layout Itemize
9968 for the catalog ID optional parameter
9971 \begin_layout Subsubsection
9972 Things not implemented, use \SpecialChar TeX
9976 \begin_layout Standard
9987 setcounter{equation}
9989 (2.12), Journal name abbreviations (2.13.4),
10025 (2.15.4, insert it as the first element in the lefthand cell after where
10027 Don't use any of \SpecialChar LyX
10028 's rules in the table),
10040 (2.15.5), much of Misc (2.17, except
10091 \begin_layout Subsubsection
10092 Things that cannot be implemented
10095 \begin_layout Standard
10097 at least in any meaningful sort of way, so I suggest ignoring them.
10098 They are the references environment (2.13.3), and the deluxetable environment
10100 If you really, really need to use deluxetable, I suggest editing it in
10101 a separate file with a text editor, then using
10103 Insert\SpecialChar menuseparator
10105 \begin_inset space ~
10110 to include it in your \SpecialChar LyX
10116 file to see an example of this.
10119 \begin_layout Subsection
10120 FAQs, Tips, Tricks, and Other Ruminations
10123 \begin_layout Subsubsection
10124 Getting \SpecialChar LyX
10125 and AAS\SpecialChar TeX
10129 \begin_layout Standard
10130 It can be a bit tricky to get \SpecialChar LyX
10131 to recognize a new layout and document class.
10132 When all else fails, do this:
10135 \begin_layout Enumerate
10136 Make certain that \SpecialChar LaTeX
10137 can find AAS\SpecialChar TeX
10139 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
10140 distribution into a
10141 directory completely unrelated to \SpecialChar LaTeX
10142 or AAS\SpecialChar TeX
10143 and run \SpecialChar LaTeX
10151 \begin_layout Enumerate
10156 appears in \SpecialChar LyX
10164 \begin_layout Enumerate
10167 Tools\SpecialChar menuseparator
10170 in \SpecialChar LyX
10171 , then restart \SpecialChar LyX
10175 \begin_layout Enumerate
10176 Open a regular new file, not from a template.
10177 Does AAS\SpecialChar TeX
10178 appear in the class list in
10180 Document\SpecialChar menuseparator
10186 \begin_layout Standard
10187 If you get a warning from an existing AAS\SpecialChar TeX
10188 document about not being able
10189 to find the AAS\SpecialChar TeX
10190 layout or a message about
10191 \begin_inset Quotes eld
10194 You should not mix title layouts with normal ones
10195 \begin_inset Quotes erd
10198 , things haven't been installed correctly.
10201 \begin_layout Subsubsection
10203 error processing a table
10206 \begin_layout Standard
10208 , by default, attempts to center the table caption/title.
10209 This seems to produce a bad interaction in AAS\SpecialChar TeX
10210 so you should click somewhere
10211 in the caption/title, then select
10213 Edit\SpecialChar menuseparator
10215 \begin_inset space ~
10229 This took care of it for me.
10232 \begin_layout Subsubsection
10236 \begin_layout Standard
10237 A couple of things: 1) I have noticed some funny spacing in the reference
10238 entries in the text.
10239 When you enter the bibliography item data, make sure their is
10243 space between the last author and the parenthesis setting off the year;
10247 \begin_inset space \thinspace{}
10251 \begin_inset space \space{}
10265 2) Entering the references at all is not obvious.
10266 The easiest thing is to start typing your first reference at the end of
10267 the document, then mark it as type
10272 That will put a small gray box in front of what you just typed.
10273 Click on the box to fill in the rest of the information.
10274 For new references, go to the end of an existing reference and press return.
10275 That will create a new line with its own box, etc.
10278 \begin_layout Subsubsection
10279 Including EPS files
10282 \begin_layout Standard
10283 Even though AAS\SpecialChar TeX
10284 provides its own figure commands (
10290 , for example), I much prefer \SpecialChar LaTeX
10291 's standard figure commands (with the default
10300 \begin_inset space ~
10303 commands as \SpecialChar TeX
10304 code into a Figure Float box if you desire, but I never have
10305 much luck getting the layout right.
10306 With the standard graphics, \SpecialChar LyX
10311 usepackage{graphicx}
10313 command into the \SpecialChar LaTeX
10314 preamble and handle the figures in the standard \SpecialChar LaTeX2e
10316 interspersing the figures in the text.
10317 I believe ApJ accepts figures exactly this way now; AJ might still use
10319 \begin_inset Quotes eld
10322 stack everything at the end
10323 \begin_inset Quotes erd
10329 \begin_layout Subsubsection
10330 Things I could have done, but didn't
10333 \begin_layout Standard
10335 \begin_inset Quotes eld
10339 \begin_inset Quotes erd
10342 things I could have implemented, but chose not to.
10343 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
10345 even though it is double-spaced in the paper manuscript.
10346 Also, I chose not to make separate layouts for the preprint and preprint2
10348 Since I assume you will spend most of your time in the plain manuscript
10349 mode anyway, I decided not to chew up more disk space with this.
10353 \begin_layout Subsection
10357 \begin_layout Standard
10358 Your mileage may vary.
10359 I've now had papers published by both ApJ and AJ that have had 98% of the
10360 effort done in \SpecialChar LyX
10361 ; the last 2% was the \SpecialChar LaTeX
10362 post-processing and a few cleanups.
10363 I have had no trouble with the submission process, and I'm sure the journals
10364 were never aware that there might be a difference.
10365 So, go forth and publish!
10368 \begin_layout Section
10369 AMS \SpecialChar LaTeX
10373 \begin_layout Standard
10380 Richard Kimberly Heck
10383 \begin_layout Standard
10384 \begin_inset VSpace bigskip
10390 \begin_layout Standard
10392 The AMS \SpecialChar LaTeX
10393 layouts are set up to conform to suggested styles for mathematical
10394 papers to be submitted to American Mathematical Society publications.
10395 The layouts are not tailored to a specific journal, but easily can be.
10396 You should refer to the AMS documentation for specific instructions for
10397 each journal (usually it will entail only changing a single line in the
10400 That documentation is available on the Web at
10401 \begin_inset Flex URL
10404 \begin_layout Plain Layout
10412 \begin_inset Flex URL
10415 \begin_layout Plain Layout
10417 ftp://ftp.ams.org/pub/tex/amslatex/
10423 These layouts are appropriate, and useful, for any mathematical writing.
10427 \begin_layout Standard
10428 There are two basic AMS \SpecialChar LaTeX
10432 \begin_layout Itemize
10433 amsart: The standard AMS article format.
10436 \begin_layout Itemize
10437 amsbook: the standard AMS book (really, monograph) format.
10441 \begin_layout Standard
10442 The layouts themselves contain only the minimum necessary to use the AMS
10444 They do not, in particular, contain any of the `theorem' environments used
10445 for setting theorems, lemmas, and the like.
10446 These are contained, instead, in the
10447 \begin_inset Flex Code
10450 \begin_layout Plain Layout
10456 module, which is loaded by default when you select one of the AMS classes.
10457 (It can also be used with other classes and can be removed, if you would
10458 rather use something else.) Less commonly used environments are in the
10459 \begin_inset Flex Code
10462 \begin_layout Plain Layout
10463 Theorems (AMS-Extended)
10468 module, which must be loaded manually.
10471 \begin_layout Standard
10472 By default, theorems and the like are numbered consecutively throughout
10473 the document, but this may be modified by loading the module
10474 \begin_inset Flex Code
10477 \begin_layout Plain Layout
10478 Theorems (Order by Section)
10483 or, if you are using
10484 \begin_inset Flex Code
10487 \begin_layout Plain Layout
10494 \begin_inset Flex Code
10497 \begin_layout Plain Layout
10498 Theorems (Order by Chapter)
10504 These will number the results as
10505 \begin_inset Formula $n.m$
10508 , where the first number refers to the section (or chapter) and the second
10509 refers to the total number of results so far in that section (or chapter).
10510 Many environments are also available unnumbered.
10511 These are indicated by an asterisk at the end.
10512 If you happen to want
10516 unnumbered results, the module
10517 \begin_inset Flex Code
10520 \begin_layout Plain Layout
10526 provides that option.
10529 \begin_layout Standard
10530 Note that these modules do not
10534 to be used with the AMS classes.
10535 It is perfectly possible to use the
10536 \begin_inset Flex Code
10539 \begin_layout Plain Layout
10545 module, and the others mentioned, with other classes, such as
10546 \begin_inset Flex Code
10549 \begin_layout Plain Layout
10556 \begin_inset Flex Code
10559 \begin_layout Plain Layout
10566 \begin_inset Flex Code
10569 \begin_layout Plain Layout
10578 \begin_layout Subsection
10579 What these layouts provide
10582 \begin_layout Standard
10583 There is a long list of included environments provided by these layouts.
10584 In AMS-\SpecialChar LaTeX
10585 , there is, in fact, an opportunity to define an unlimited variety
10586 of `theorem' environments.
10587 However, the AMS recommends the environments that are available in \SpecialChar LyX
10592 \begin_layout Standard
10593 The following environments—as well as the standard environments, such as
10595 \begin_inset Flex Noun
10598 \begin_layout Plain Layout
10605 \begin_inset Flex Noun
10608 \begin_layout Plain Layout
10615 \begin_inset Flex Noun
10618 \begin_layout Plain Layout
10625 \begin_inset Flex Noun
10628 \begin_layout Plain Layout
10635 \begin_inset Flex Noun
10638 \begin_layout Plain Layout
10645 \begin_inset Flex Code
10648 \begin_layout Plain Layout
10655 \begin_inset Flex Code
10658 \begin_layout Plain Layout
10667 \begin_layout Description
10668 Address This should be the author's permanent address.
10671 \begin_layout Description
10673 \begin_inset space ~
10676 Address This should be the author's temporary address at the time of submission,
10677 if different from the Address.
10680 \begin_layout Description
10681 Email Author's e-mail address
10684 \begin_layout Description
10685 URL Author's Web address, if desired.
10688 \begin_layout Description
10689 Keywords Key words or phrases used to identify specific topics discussed
10693 \begin_layout Description
10694 Subjectclass These refer to the AMS Subject Classifications, published and
10697 Mathematical Reviews
10700 These are also available online at the AMS cites listed above.
10703 \begin_layout Description
10707 \begin_layout Description
10711 \begin_layout Description
10715 \begin_layout Standard
10716 The following environments are provided by both the
10717 \begin_inset Flex Code
10720 \begin_layout Plain Layout
10727 \begin_inset Flex Code
10730 \begin_layout Plain Layout
10736 modules, in the latter case in both starred (unnumbered) and unstarred
10737 (numbered) versions.
10738 These same environments are provided only in the starred versions by the
10740 \begin_inset Flex Code
10743 \begin_layout Plain Layout
10752 \begin_layout Theorem
10753 This is typically used for the statements of major results.
10757 \begin_layout Corollary*
10758 This is used for statements which follow fairly directly from previous statement
10760 Again, these can be major results.
10764 \begin_layout Lemma
10765 These are smaller results needed to prove other statements.
10768 \begin_layout Proposition
10769 These are less major results which (hopefully) add to the general theory
10773 \begin_layout Conjecture
10774 These are statements provided without justification, which the author does
10775 not know how to prove, but which seem to be true (to the author, at least).
10778 \begin_layout Definition*
10779 Guess what this is for.
10780 The font is different for this environment than for the previous ones.
10784 \begin_layout Example*
10785 Used for examples illustrating proven results.
10788 \begin_layout Problem
10789 It's not really known what this is for.
10790 You should figure it out.
10793 \begin_layout Exercise*
10794 Write a description for this one.
10797 \begin_layout Remark
10798 This environment is also a type of theorem, usually a lesser sort of observation.
10801 \begin_layout Claim*
10802 Often used in the course of giving a proof of a larger result.
10806 Generally, these are used to break up long arguments, using specific instances
10812 The numbering scheme for cases is on its own, not together with other numbered
10817 \begin_layout Proof
10818 At the end of this environment, a QED symbol (usually a square, but it can
10819 vary with different styles) is placed.
10820 If you want to have other environments within this one—for example, Case
10821 environments—and have the QED symbol appear only after them, then the other
10822 environments need to be nested within the proof environment.
10825 Nesting Environments
10831 for information on nesting.
10834 \begin_layout Standard
10835 And these environments are provided by
10836 \begin_inset Flex Code
10839 \begin_layout Plain Layout
10840 Theorems (AMS-Extended)
10848 \begin_layout Criterion*
10849 A required condition.
10852 \begin_layout Algorithm*
10853 A general procedure to be used.
10856 \begin_layout Axiom*
10857 This is a property or statement taken as true within the system being discussed.
10860 \begin_layout Condition*
10861 Sometimes used to state a condition assumed within the present context of
10865 \begin_layout Note*
10866 Similar to a Remark.
10869 \begin_layout Notation*
10870 Used for the explanation of, yes, notation.
10873 \begin_layout Summary
10874 Do we really need to tell you?
10877 \begin_layout Acknowledgement*
10881 \begin_layout Conclusion*
10882 Sometimes used at the end of a long train of argument.
10886 Used in a way similar to Proposition, though perhaps lower on the scale.
10889 \begin_layout Standard
10890 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
10893 They need to be available on your system in order to use these environments.
10896 \begin_layout Section
10900 \begin_layout Standard
10906 \begin_layout Subsection
10910 \begin_layout Standard
10911 Broadway is for writing plays.
10912 The format is more decorative than Hollywood, and much less standardized.
10913 This format should be suitable for workshops.
10916 \begin_layout Subsection
10920 \begin_layout Standard
10921 The same as in Hollywood.
10924 \begin_layout Subsection
10928 \begin_layout Standard
10933 names as labels then cross-reference the label to insert the name.
10934 The cross-reference dialog will show the current cast of characters.
10937 \begin_layout Subsection
10938 Paper size and Margins
10941 \begin_layout Standard
10942 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
10945 \begin_layout Subsection
10949 \begin_layout Standard
10950 The following environments are available.
10951 You can use broadway.bind to get the bind keys shown at the right.
10954 \begin_layout Itemize
10958 \begin_inset Newline newline
10963 You should not have to use this, but it is here for anything that does not
10967 \begin_layout Itemize
10971 \begin_inset space \hfill{}
10975 \begin_inset Newline newline
10980 Used to describe stage setting and the action.
10981 First use of speaker names in all CAPs.
10984 \begin_layout Itemize
10988 \begin_inset space \hfill{}
10992 \begin_inset Newline newline
10997 Automatically numbered.
10998 On screen it will be arabic, but will print as Roman.
11001 \begin_layout Itemize
11005 \begin_inset space \hfill{}
11009 \begin_inset Newline newline
11019 It is just centered text.
11022 \begin_layout Itemize
11026 \begin_inset space \hfill{}
11030 \begin_inset Newline newline
11035 Not automatically numbered.
11036 You supply the number.
11037 This is because I couldn't figure out how.
11040 \begin_layout Itemize
11044 \begin_inset space \hfill{}
11048 \begin_inset Newline newline
11053 A special case of Narrative to describe the setting and action as the curtain
11057 \begin_layout Itemize
11061 \begin_inset space \hfill{}
11065 \begin_inset Newline newline
11070 The speaker's (actor's) title, centered in all CAPS.
11073 \begin_layout Itemize
11077 \begin_inset space \hfill{}
11081 \begin_inset Newline newline
11086 Instructions to the speaker.
11087 The parentheses are automatically inserted.
11088 The ( will appear on screen, but both will be in the printed play.
11089 This environment is only used within
11096 \begin_layout Itemize
11100 \begin_inset space \hfill{}
11104 \begin_inset Newline newline
11109 What the Speaker says.
11112 \begin_layout Itemize
11116 \begin_inset space \hfill{}
11120 \begin_inset Newline newline
11125 The curtain comes down.
11128 \begin_layout Itemize
11132 \begin_inset space \hfill{}
11138 \begin_layout Itemize
11142 \begin_inset space \hfill{}
11148 \begin_layout Itemize
11152 \begin_inset space \hfill{}
11158 \begin_layout Standard
11162 \begin_layout Section
11166 \begin_layout Standard
11171 can be used to type letters according to German conventions.
11172 A template file is included in
11174 .../lyx/share/templates
11176 for you to use as a starting point.
11179 \begin_layout Section
11183 \begin_layout Standard
11184 See the \SpecialChar LyX
11190 It contains all infos you need.
11193 \begin_layout Section
11196 Foil\SpecialChar TeX
11200 \begin_inset CommandInset label
11209 \begin_layout Standard
11215 \begin_layout Subsection
11219 \begin_layout Standard
11220 This section describes how to use \SpecialChar LyX
11221 to make slides for overhead projectors.
11222 There are two document classes that can do this: the default slides class
11225 Foil\SpecialChar TeX
11229 This section documents the latter.
11232 \begin_layout Standard
11233 I'm going to say this again, nice and clear, so that there's no misunderstanding
11237 \begin_layout Standard
11238 \begin_inset VSpace bigskip
11244 \begin_layout Standard
11248 This section documents the class
11249 \begin_inset Quotes eld
11257 \begin_inset Quotes erd
11265 \begin_layout Standard
11266 \begin_inset VSpace bigskip
11272 \begin_layout Standard
11273 If you're looking for the documentation for
11274 \begin_inset Quotes eld
11282 \begin_inset Quotes erd
11285 , check out section
11286 \begin_inset space ~
11290 \begin_inset CommandInset ref
11292 reference "sec:slitex"
11297 If your machine doesn't have the
11305 installed, you'll probably have to use the default
11309 class, which isn't quite as good as
11314 \begin_layout Standard
11319 class is designed for use with version
11320 \begin_inset space ~
11328 class file which is now an integral part of \SpecialChar LaTeX2e
11332 \begin_layout Subsection
11336 \begin_layout Standard
11337 Obviously, to use this document class, you need to select
11348 \begin_inset space ~
11354 There are some settings in the
11357 \begin_inset space ~
11362 dialog that you should know about that are specific to this class:
11365 \begin_layout Itemize
11366 Don't change the options
11377 \begin_inset space ~
11383 They're ignored by the
11390 \begin_layout Itemize
11391 The default font size is 20
11392 \begin_inset space \thinspace{}
11395 pt with the other options being 17
11396 \begin_inset space \thinspace{}
11400 \begin_inset space \thinspace{}
11404 \begin_inset space \thinspace{}
11410 \begin_layout Itemize
11411 The default font is
11419 but all math equations are still typeset in the usual roman font.
11422 \begin_layout Itemize
11425 Foil\SpecialChar TeX
11428 supports A4 and Letter paper sizes as well as a special size for working
11430 \begin_inset space \thinspace{}
11434 It doesn't support A5, B5, legal or executive paper sizes.
11437 \begin_layout Itemize
11438 Don't bother changing the
11442 settings because they are ignored anyway.
11443 All floats appear where they are defined in the text.
11446 \begin_layout Itemize
11451 setting behaves a bit differently for this class.
11454 Foil\SpecialChar TeX
11457 provides extensive footer and header capabilities including a user-defined
11460 \begin_inset space ~
11464 \begin_inset CommandInset ref
11466 reference "sec:foilfoot"
11471 The title page is treated differently to all other pages in the document
11480 has the logo centered at the bottom of the page (if one is defined).
11481 The possible page style choices and what they do are as follows:
11485 \begin_layout Labeling
11486 \labelwidthstring MMMMMMM
11493 The final output contains no page numbers, or other headers or footers
11494 (except footnotes of course).
11498 \begin_layout Labeling
11499 \labelwidthstring MMMMMMM
11506 The final output contains page numbers centered at the bottom of the page.
11507 No other headings or footers (other than footnotes).
11510 \begin_layout Labeling
11511 \labelwidthstring MMMMMMM
11516 Page numbers in lower right corner.
11517 Additional headers and footers are also shown.
11518 This is also the default.
11521 \begin_layout Labeling
11522 \labelwidthstring MMMMMMM
11527 Gives you access to the
11531 package although its use with
11533 Foil\SpecialChar TeX
11536 is discouraged by the writer of the
11538 Foil\SpecialChar TeX
11541 package because of some potential page layout clashes.
11545 \begin_layout Subsubsection
11549 \begin_layout Standard
11550 The following options may be used in the extra class options in the
11552 Document\SpecialChar menuseparator
11558 \begin_layout Labeling
11559 \labelwidthstring MMMMMMx
11564 This sets up the page layout for 7.33
11565 \begin_inset space \thinspace{}
11569 \begin_inset space \thinspace{}
11572 in paper, which is about the same aspect ratio as a 35
11573 \begin_inset space \thinspace{}
11576 mm slide, making it a bit easier to work with this medium.
11579 \begin_layout Labeling
11580 \labelwidthstring MMMMMMx
11585 Places a rule across the page below the header on every page except the
11589 \begin_layout Labeling
11590 \labelwidthstring MMMMMMx
11595 Places a rule across the page above the footer on every page except the
11599 \begin_layout Labeling
11600 \labelwidthstring MMMMMMx
11605 This is automatically set each time you create a new
11612 Foil\SpecialChar TeX
11615 to use the dvips driver to rotate those pages that are set as landscape
11619 \begin_layout Labeling
11620 \labelwidthstring MMMMMMx
11625 Simply changes the page dimensions to those of a landscape page but doesn't
11627 Thus if you use this option you need to use an external program to rotate
11628 each page or feed your paper through your printer as landscape.
11629 Note that this option effectively reverses the roles of the
11637 environments (don't worry these are described in the next section).
11640 \begin_layout Labeling
11641 \labelwidthstring MMMMMMx
11646 Equation numbers on the left.
11649 \begin_layout Labeling
11650 \labelwidthstring MMMMMMx
11655 Flush-left equations.
11658 \begin_layout Subsection
11659 Supported Environments
11662 \begin_layout Standard
11663 Most of the environments commonly supported in other classes are also supported
11669 There are several additional environments provided by
11671 Foil\SpecialChar TeX
11674 as well as a couple added by \SpecialChar LyX
11676 The following environments are shared with other classes:
11679 \begin_layout Standard
11680 \begin_inset Flex Multiple Columns
11683 \begin_layout Itemize
11689 \begin_layout Itemize
11695 \begin_layout Itemize
11701 \begin_layout Itemize
11707 \begin_layout Itemize
11713 \begin_layout Itemize
11720 \begin_layout Itemize
11726 \begin_layout Itemize
11732 \begin_layout Itemize
11738 \begin_layout Itemize
11744 \begin_layout Itemize
11750 \begin_layout Itemize
11756 \begin_layout Itemize
11762 \begin_layout Itemize
11768 \begin_layout Itemize
11779 \begin_layout Standard
11780 That is, all the major environments apart from the sectioning environments.
11781 Since foils are essentially self-contained sections, with a title and body,
11784 Foil\SpecialChar TeX
11787 provides specific commands for starting new foils and these are:
11790 \begin_layout Itemize
11796 \begin_layout Itemize
11802 \begin_layout Standard
11804 also provides slightly modified versions of these two environments called:
11807 \begin_layout Itemize
11813 \begin_layout Itemize
11816 ShortRotatefoilhead
11819 \begin_layout Standard
11820 and the differences will be explained in the next section.
11823 \begin_layout Standard
11824 Since foils are often used in presenting ideas or new theorems and such
11827 Foil\SpecialChar TeX
11830 also provides a comprehensive box of goodies for presenting them:
11833 \begin_layout Standard
11834 \begin_inset Flex Multiple Columns
11837 \begin_layout Itemize
11843 \begin_layout Itemize
11849 \begin_layout Itemize
11855 \begin_layout Itemize
11861 \begin_layout Itemize
11867 \begin_layout Itemize
11873 \begin_layout Itemize
11879 \begin_layout Itemize
11885 \begin_layout Itemize
11891 \begin_layout Itemize
11897 \begin_layout Itemize
11908 \begin_layout Standard
11909 The starred versions are unnumbered while the unstarred versions are numbered.
11910 There are also two list environments added by \SpecialChar LyX
11914 \begin_layout Itemize
11920 \begin_layout Itemize
11926 \begin_layout Standard
11929 Foil\SpecialChar TeX
11932 provides some powerful header and footer capabilities that are best set
11933 in the preamble although they may be set at any point in a document.
11934 If you want to change these settings in your document the best place to
11935 do so is at the very top of a foil, i.
11936 \begin_inset space \thinspace{}
11942 \begin_inset space \space{}
11947 straight after the foilhead.
11950 \begin_layout Standard
11951 For this purpose, the following command styles are provided [
11958 \begin_layout Standard
11959 \begin_inset Flex Multiple Columns
11962 \begin_layout Itemize
11966 \begin_inset space ~
11972 \begin_layout Itemize
11978 \begin_layout Itemize
11982 \begin_inset space ~
11988 \begin_layout Itemize
11992 \begin_inset space ~
11998 \begin_layout Itemize
12002 \begin_inset space ~
12009 \begin_layout Plain Layout
12010 \begin_inset space ~
12022 \begin_layout Standard
12023 There are also a few commands provided by
12025 Foil\SpecialChar TeX
12028 that aren't directly supported by \SpecialChar LyX
12029 but I'll tell you what they do and how
12030 to use them in section
12031 \begin_inset space ~
12035 \begin_inset CommandInset ref
12037 reference "sec:unsuppfoils"
12044 \begin_layout Subsection
12045 Building a Set of Foils
12048 \begin_layout Standard
12049 This section will give a simple introduction to using the different environments
12050 to build a set of foils.
12051 If you want to see an example set of foils, take a look at the
12055 file you find in \SpecialChar LyX
12063 \begin_layout Subsubsection
12064 Give It a Title Page
12067 \begin_layout Standard
12068 Unlike other classes that provide
12088 creates the title on a page of its own.
12089 If you leave out the
12093 environment \SpecialChar LaTeX
12094 will substitute the current date (every time you regenerate
12098 \begin_layout Subsubsection
12102 \begin_layout Standard
12103 As I mentioned earlier, there are four ways of starting a new foil.
12104 For portrait foils you should use
12113 The difference between these two environments is the amount of space between
12114 the title of the foil (the foilhead) and the body of the foil.
12117 \begin_layout Standard
12118 Landscape foils are generated using the
12124 ShortRotatefoilhead
12127 Again the only difference is the spacing between foilhead and body.
12128 Both of the short versions have 0.5
12129 \begin_inset space ~
12132 inches less separation between the foilhead and the body.
12136 \begin_layout Standard
12137 One problem with the support for landscape foils is the requirement that
12138 you have to use the
12142 driver to generate the PostScript output otherwise the foils won't be rotated.
12143 It is possible to get landscape foils even if you haven't got the
12147 driver provided you can feed your foils sideways through your printer ;-)
12150 \begin_layout Subsubsection
12151 Theorems, Lemmas, Proofs and more
12154 \begin_layout Standard
12155 You can't have two of the same type of these environments directly following
12157 If you use a normal paragraph break, , you will just be extending the previous
12158 environment as if you had merged the two environments together.
12159 Rather than that, you need to insert a so-called separator.
12160 Please refer to the section entitled
12171 \begin_layout Subsubsection
12175 \begin_layout Standard
12176 You get all the commonly supported list styles found in other classes as
12177 well as two new ones.
12178 I'll only describe the new ones here.
12179 If you want to find out more about the other list environments check out
12185 If you intend to use itemized lists you might also want to read about the
12189 \begin_inset space ~
12193 \begin_inset space ~
12198 dialog described above in section
12199 \begin_inset space ~
12203 \begin_inset CommandInset ref
12205 reference "sec:bullet"
12212 \begin_layout Standard
12213 The two new list styles,
12221 , are designed to make it easier for you to create lists of do's and don'ts
12222 or right and wrong by providing dedicated environments that use a tick
12223 or a cross as the label of the list.
12224 These lists are in fact dedicated variants of the
12229 They do however require that you have the
12233 packages installed.
12236 \begin_layout Subsubsection
12240 \begin_layout Standard
12243 Foil\SpecialChar TeX
12246 redefines the floating tables and figures so that they appear exactly where
12247 they are in the text rather than pushing them to the top of the page or
12248 to some user specified location.
12249 In fact if you change the float placement settings they are simply ignored.
12252 \begin_layout Subsubsection
12253 Page Headers and Footers
12254 \begin_inset CommandInset label
12256 name "sec:foilfoot"
12263 \begin_layout Standard
12267 \begin_inset space ~
12276 are two commands used to control the left-footer text string.
12277 The first is meant to allow you to include a graphic logo on your foils
12279 \begin_inset Quotes eld
12284 Foil\SpecialChar TeX
12288 \begin_inset Quotes erd
12292 While the second is meant to provide a classification for the audience,
12296 \begin_inset space \thinspace{}
12302 \begin_inset space \space{}
12306 It is empty by default.
12309 \begin_layout Standard
12310 The remaining page corners can be filled by
12313 \begin_inset space ~
12318 (which defaults to page numbers),
12321 \begin_inset space ~
12329 \begin_inset space ~
12337 \begin_layout Subsection
12340 Foil\SpecialChar TeX
12344 \begin_inset CommandInset label
12346 name "sec:unsuppfoils"
12353 \begin_layout Standard
12354 All the commands mentioned below need to be set in a
12364 within another environment.
12367 \begin_layout Subsubsection
12371 \begin_layout Standard
12372 All lengths are adjusted using the
12395 should be replaced by the name given to the length you want to change and
12400 is the length value.
12401 All lengths should be specified in units of length such as inches (
12413 ) or relative to some document or font-based length such as
12423 \begin_layout Standard
12424 It's possible to change the spacing between a foilhead and the body of the
12425 foil by adjusting the length specified by
12432 For example, to make
12437 \begin_inset space \space{}
12440 in closer to their bodies put the following in the preamble:
12446 foilheadskip}{-0.5in}
12449 \begin_layout Standard
12450 The spacings around floats can be adjusted by setting these lengths:
12453 \begin_layout Labeling
12454 \labelwidthstring MMMMMMMMMMM
12461 Separation between the text and the top of the float
12464 \begin_layout Labeling
12465 \labelwidthstring MMMMMMMMMMM
12472 Separation between the float and the caption
12475 \begin_layout Labeling
12476 \labelwidthstring MMMMMMMMMMM
12483 Separation between the caption and the following text
12486 \begin_layout Labeling
12487 \labelwidthstring MMMMMMMMMMM
12494 You can make the captions narrower than the surrounding text by adjusting
12496 Best done relative to
12505 \begin_layout Standard
12506 There are also several title page related lengths that you may find useful
12507 if you have a long title or several authors:
12510 \begin_layout Labeling
12511 \labelwidthstring MMMMMMMMMMM
12518 Separation from headers to
12523 \begin_layout Labeling
12524 \labelwidthstring MMMMMMMMMMM
12542 \begin_layout Labeling
12543 \labelwidthstring MMMMMMMMMMM
12557 \begin_layout Labeling
12558 \labelwidthstring MMMMMMMMMMM
12574 \begin_layout Labeling
12575 \labelwidthstring MMMMMMMMMMM
12591 \begin_layout Standard
12592 The last length related command affects all the list environments.
12603 a list environment then all the vertical spacing between the list items
12605 Note that this is a command not a length so it doesn't require
12611 like the stuff mentioned above.
12614 \begin_layout Subsubsection
12615 Headers and Footers
12618 \begin_layout Standard
12631 commands control whether the logo in the
12635 definition appear on a given page.
12642 in the preamble then none of the foils will have the logo on them.
12643 If you don't want the logo on a particular page place the
12649 directly after the foilhead of that page and the
12655 directly after the next foilhead.
12658 \begin_layout Standard
12659 If you decide to use the
12663 page style setting in the
12666 \begin_inset space ~
12671 dialog you should probably add
12681 to your preamble so headers and footers on landscape pages are correctly
12682 placed when rotated.
12683 This is due to some clashes between the page layouts provided by the
12694 \begin_layout Section
12695 Hollywood (Hollywood spec scripts)
12698 \begin_layout Standard
12704 \begin_layout Subsection
12708 \begin_layout Standard
12709 Getting the format of a Hollywood script right is a
12710 \begin_inset Quotes eld
12714 \begin_inset Quotes erd
12717 It is designed to make the readers focus on content and to be easy and
12718 familiar for the actors to read.
12719 Each page of a script should be one minute of film.
12720 Nothing goes in a script that you cannot see or hear on screen.
12721 The courier 12 pt font should be used throughout.
12725 \begin_layout Subsection
12729 \begin_layout Standard
12730 Speakers' lines should NEVER break in mid-sentence.
12731 If a speaker's lines continue over a page break, repeat the
12735 title followed by (Cont'd).
12738 \begin_layout Subsection
12742 \begin_layout Standard
12747 names as labels then cross-reference the label to insert the name.
12748 The cross-reference dialog will show the current cast of characters.
12749 You can use this to insert the speaker name in narratives also.
12752 \begin_layout Subsection
12753 Paper size and Margins
12756 \begin_layout Standard
12757 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
12760 \begin_layout Subsection
12764 \begin_layout Standard
12765 The following environments are available.
12766 You can use hollywood.bind to get the bind keys shown at the right.
12769 \begin_layout Itemize
12773 \begin_inset Newline newline
12778 Used where nothing else works.
12782 \begin_layout Itemize
12788 \begin_inset space \hfill{}
12796 \begin_inset Newline newline
12799 Usually followed by something like
12800 \begin_inset Quotes eld
12803 on Sally waking up.
12804 \begin_inset Quotes erd
12810 \begin_layout Itemize
12814 \begin_inset space \hfill{}
12818 \begin_inset Newline newline
12823 Introduces a new INTERIOR camera set-up.
12824 Always followed by DAY or NIGHT, or something similar to define the lighting
12826 Everthing on this line in CAPS.
12829 \begin_layout Itemize
12833 \begin_inset space \hfill{}
12837 \begin_inset Newline newline
12842 Introduces a new EXTERIOR camera set-up.
12843 Everthing on this line in CAPS.
12846 \begin_layout Itemize
12850 \begin_inset space \hfill{}
12854 \begin_inset Newline newline
12859 The character speaking.
12862 \begin_layout Itemize
12866 \begin_inset space \hfill{}
12870 \begin_inset Newline newline
12875 Instructions to the speaker.
12876 The () are automatically inserted.
12879 \begin_layout Itemize
12883 \begin_inset space \hfill{}
12887 \begin_inset Newline newline
12899 \begin_layout Itemize
12903 \begin_inset space \hfill{}
12907 \begin_inset Newline newline
12912 Camera movement instruction.
12914 \begin_inset space \thinspace{}
12918 \begin_inset space \space{}
12924 \begin_layout Itemize
12928 \begin_inset space \hfill{}
12934 \begin_layout Itemize
12938 \begin_inset space \hfill{}
12944 \begin_layout Itemize
12948 \begin_inset space \hfill{}
12954 \begin_layout Itemize
12958 \begin_inset space \hfill{}
12964 \begin_layout Subsection
12968 \begin_layout Itemize
12972 \begin_layout Itemize
12976 \begin_layout Itemize
12978 \begin_inset space \thinspace{}
12985 \begin_layout Itemize
12990 \begin_layout Itemize
12991 PAN — camera movement
12994 \begin_layout Itemize
12995 INSERT — cut to close-up of
12998 \begin_layout Section
13002 \begin_layout Standard
13005 Panayotis Papasotiriou
13008 \begin_layout Subsection
13012 \begin_layout Standard
13013 The ijmpc package is a set of macros that facilitates electronic manuscript
13016 International Journal of Modern Physics C
13019 Similarly, the ijmpd package is for creating manuscripts to be submitted
13022 International Journal of Modern Physics D
13025 Both journals are published by World Scientific.
13026 The corresponding document classes are named
13035 These files, together with instructions for the authors, can be downloaded
13037 \begin_inset Flex URL
13040 \begin_layout Plain Layout
13042 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
13048 \begin_inset Flex URL
13051 \begin_layout Plain Layout
13053 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
13059 Both packages are modified versions of the standard
13060 \begin_inset Quotes eld
13064 \begin_inset Quotes erd
13067 package, and they are almost (but not exactly) identical.
13068 Most of their features are supported by \SpecialChar LyX
13070 I have used \SpecialChar LyX
13071 successfully to write articles submitted to both journals
13072 without any problem.
13075 \begin_layout Subsection
13079 \begin_layout Standard
13080 As usual, the easiest way to write a paper is to start with a template.
13083 File\SpecialChar menuseparator
13099 This will give an (almost) empty document that includes the most common
13100 fields found in a manuscript.
13101 Simply overwrite the existing text (including the brackets,
13106 You should keep in mind the following remarks.
13109 \begin_layout Enumerate
13111 won't let you change the font size and the page style of the document,
13112 because such modifications are not allowed by both packages.
13115 \begin_layout Enumerate
13116 The language of the document should not be changed.
13117 Before previewing your paper, be sure that the babel package is not used.
13118 To do this, click on
13121 arg "dialog-show document"
13126 \SpecialChar menuseparator
13130 \begin_inset Quotes eld
13134 \begin_inset Quotes erd
13144 \begin_layout Enumerate
13146 \begin_inset Quotes eld
13150 \begin_inset Quotes erd
13153 style must be used to define keywords.
13156 \begin_layout Enumerate
13157 The ijmpc package provides a style named
13158 \begin_inset Quotes eld
13161 Classification Codes
13162 \begin_inset Quotes erd
13165 , which can be used to define classification codes, such as PACS numbers.
13166 Note that this facility is not supported by the ijmpd package.
13169 \begin_layout Enumerate
13170 Several new environments are available:
13171 \begin_inset Quotes eld
13175 \begin_inset Quotes erd
13179 \begin_inset Quotes eld
13183 \begin_inset Quotes erd
13187 \begin_inset Quotes eld
13191 \begin_inset Quotes erd
13195 \begin_inset Quotes eld
13199 \begin_inset Quotes erd
13203 \begin_inset Quotes eld
13207 \begin_inset Quotes erd
13211 \begin_inset Quotes eld
13215 \begin_inset Quotes erd
13219 \begin_inset Quotes eld
13223 \begin_inset Quotes erd
13227 \begin_inset Quotes eld
13231 \begin_inset Quotes erd
13235 \begin_inset Quotes eld
13239 \begin_inset Quotes erd
13243 \begin_inset Quotes eld
13247 \begin_inset Quotes erd
13251 \begin_inset Quotes eld
13255 \begin_inset Quotes erd
13259 \begin_inset Quotes eld
13263 \begin_inset Quotes erd
13267 \begin_inset Quotes eld
13271 \begin_inset Quotes erd
13275 \begin_inset Quotes eld
13279 \begin_inset Quotes erd
13283 Their use is more or less obvious.
13285 supports all these environments; it will use the proper label, text style,
13286 and numbering scheme for each of them.
13289 \begin_layout Enumerate
13290 Both packages use basic citations; the natbib package should not be used.
13291 In \SpecialChar LyX
13292 , citation references are shown as usual; in the output, citations are
13293 shown as superscripts.
13294 If you want to use a citation as normal text, you should use the
13299 \begin_inset space \thinspace{}
13303 \begin_inset space \space{}
13307 \begin_inset Quotes eld
13311 \begin_inset space \space{}
13321 \begin_inset Quotes erd
13327 \begin_layout Enumerate
13329 \begin_inset Quotes eld
13333 \begin_inset Quotes erd
13336 section in both packages.
13337 To put acknowledgments, just use the
13338 \begin_inset Quotes eld
13342 \begin_inset Quotes erd
13348 \begin_layout Enumerate
13349 Appendices may be added to the paper,
13353 the Acknowledgments and
13359 provides a special environment, called
13360 \begin_inset Quotes eld
13364 \begin_inset Quotes erd
13367 which marks the beginning of the appendices.
13368 This environment should be left blank; it just sends a \SpecialChar LaTeX
13369 command, but nothing
13371 In \SpecialChar LyX
13373 \begin_inset Quotes eld
13377 \begin_inset Quotes erd
13380 is printed with blue letters, as a signal that all sections after that
13381 point are appendices.
13382 To write an appendix, use the
13383 \begin_inset Quotes eld
13387 \begin_inset Quotes erd
13392 will number each appendix with capital letters, as required by both journals.
13394 \begin_inset Quotes eld
13398 \begin_inset Quotes erd
13405 be present before the first appendix; if not, all appendices will be numbered
13406 as normal sections in the output.
13409 \begin_layout Enumerate
13410 The ijmpc and the ijmpd packages use the
13414 command to implement table captions.
13415 As a result, a table created by \SpecialChar LyX
13416 is printed correctly, but its caption
13418 However, you can use some \SpecialChar TeX
13419 code to overcome this problem, so that captions
13420 are printed as expected.
13421 To do so, create a float table as usual, remove the caption, and replace
13422 it with the \SpecialChar TeX
13433 (sic); you must also the \SpecialChar TeX
13438 immediately after the tabular material.
13439 Study the example table included in the template files to see how this
13440 trick is implemented.
13441 Alternatively, If you need table captions, you should implement the whole
13446 file, then include this file to the \SpecialChar LyX
13449 Insert\SpecialChar menuseparator
13450 File\SpecialChar menuseparator
13452 \begin_inset space ~
13458 Details on how to create a table float can be found in the files
13466 , included in the corresponding packages.
13469 \begin_layout Subsection
13470 Preparing a paper for submission
13473 \begin_layout Standard
13474 Before you submit your paper you must export the \SpecialChar LyX
13475 document as a \SpecialChar LaTeX
13478 File\SpecialChar menuseparator
13479 Export\SpecialChar menuseparator
13487 \begin_layout Plain Layout
13488 Actually you have the choice between \SpecialChar LaTeX
13489 (plain) and pdflatex.
13490 If you intend to use pdflatex to prepare the paper, you should use the
13491 pdflatex option so that included graphics are converted to PDF format,
13492 ready for use by pdflatex.
13497 , then make the following changes to the resulting
13504 \begin_layout Enumerate
13505 Remove the comment lines before the
13514 \begin_layout Enumerate
13515 Remove everything between (and including) the
13527 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13531 \begin_layout Standard
13536 file should be saved and processed through \SpecialChar LaTeX
13537 as many times as necessary.
13538 You may also want to check the resulting
13545 \begin_layout Section
13549 \begin_layout Standard
13555 \begin_layout Subsection
13559 \begin_layout Standard
13560 The iopart package provides a document class to create electronic manuscript
13561 submission to the journals published by the Institute of Physics.
13562 Instructions for the authors how to create a paper using the iopart class
13563 can be downloaded together with the iopart package from the site
13564 \begin_inset Flex URL
13567 \begin_layout Plain Layout
13569 ftp://ftp.iop.org/pub/journals/latex2e
13577 \begin_layout Subsection
13581 \begin_layout Standard
13582 The easiest way to write a paper is to start with the template
13586 that is available via
13588 File\SpecialChar menuseparator
13591 The template explains how to use the special text environments.
13592 Here are the most important advices:
13595 \begin_layout Itemize
13596 To be able to compile your document to a PDF, PS, or DVI, ensure that the
13597 no AMS packages are loaded in
13599 Document\SpecialChar menuseparator
13600 Settings\SpecialChar menuseparator
13606 \begin_layout Itemize
13609 The title environment defines the kind of your paper.
13610 So use one of the following environments for the title:
13614 \begin_layout Itemize
13623 \begin_layout Itemize
13632 \begin_layout Itemize
13638 for a Topical review
13641 \begin_layout Itemize
13650 \begin_layout Itemize
13659 \begin_layout Itemize
13665 for a Paper (same as Title)
13668 \begin_layout Itemize
13674 for a Preliminary communication
13677 \begin_layout Itemize
13683 for a Rapid communication
13686 \begin_layout Itemize
13692 for a Letter to the editor
13696 \begin_layout Itemize
13699 All title environments except of
13703 can have an optional short title.
13706 \begin_layout Itemize
13707 There is a general title environment
13711 which is not directly supported by \SpecialChar LyX
13713 This can be used as \SpecialChar TeX
13714 code when your document doesn't fit into one of the
13718 \begin_layout Standard
13719 For more informations like hints for special table and formula formatting,
13720 look at the IOP author guidelines.
13723 \begin_layout Section
13727 \begin_layout Standard
13730 Panayotis Papasotiriou
13733 \begin_layout Subsection
13737 \begin_layout Standard
13738 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
13739 that facilitates electronic manuscript submission to the journals they
13741 Most known of them (at least in my domain of interest) are
13743 Astrophysics and Space Science
13749 , but there are many others (see a complete list at
13750 \begin_inset Flex URL
13753 \begin_layout Plain Layout
13755 http://www.wkap.nl/jrnllist.htm/JRNLHOME
13761 The Kluwer package may be downloaded from the site
13762 \begin_inset Flex URL
13765 \begin_layout Plain Layout
13767 http://www.wkap.nl/kaphtml.htm/STYLEFILES
13773 A complete user guide is contained in that package (but it can also be
13774 downloaded separately).
13777 \begin_layout Standard
13779 supports many features of the package but not everything.
13780 However, the \SpecialChar TeX
13781 code needed is reduced to some
13782 \begin_inset Quotes eld
13786 \begin_inset Quotes erd
13789 commands of the package (see
13790 \begin_inset space ~
13794 \begin_inset CommandInset ref
13796 reference "subsec:kluwer_peculiarities"
13801 I have recently used \SpecialChar LyX
13802 to write an article submitted to the
13804 Astrophysics and Space Science
13806 without any problem.
13809 \begin_layout Subsection
13813 \begin_layout Standard
13814 The easiest way to write a paper is to start with the Kluwer template file.
13817 File\SpecialChar menuseparator
13829 This will give an (almost) empty document that includes the most common
13830 fields found in a manuscript and a short description of their use.
13831 As in most templates, simply overwrite the existing text (including the
13836 ) with the correct information.
13839 \begin_layout Subsection
13840 Preparing a paper for submission
13843 \begin_layout Standard
13844 As in the AAS\SpecialChar TeX
13845 package, before you submit your paper to a journal you must
13847 \begin_inset Quotes eld
13851 \begin_inset Quotes erd
13857 \begin_layout Enumerate
13858 Export your paper as a \SpecialChar LaTeX
13860 To do this, click on
13862 File\SpecialChar menuseparator
13863 Export\SpecialChar menuseparator
13871 \begin_layout Enumerate
13876 file with a text editor and make the following changes
13880 \begin_layout Enumerate
13881 remove the comment lines before the
13890 \begin_layout Enumerate
13891 remove everything between (and including) the
13903 commands, except for any commands you specifically put into the \SpecialChar LaTeX
13907 \begin_layout Standard
13916 \begin_layout Enumerate
13921 file through \SpecialChar LaTeX
13922 as many times as necessary (usually up to three).
13925 \begin_layout Enumerate
13931 \begin_inset space \thinspace{}
13935 \begin_inset space \space{}
13942 , and check if everything is OK (it should, if you didn't make any mistake).
13945 \begin_layout Subsection
13946 \begin_inset Quotes eld
13950 \begin_inset Quotes erd
13953 of the Kluwer package
13954 \begin_inset CommandInset label
13956 name "subsec:kluwer_peculiarities"
13963 \begin_layout Standard
13964 The Kluwer package has the following
13965 \begin_inset Quotes eld
13969 \begin_inset Quotes erd
13975 \begin_layout Enumerate
13976 It is possible to write multiple articles in the same \SpecialChar LaTeX
13981 \begin_layout Plain Layout
13982 I can't imagine any good reason to do this.
13988 Each article must be included in the environment
13989 \begin_inset Quotes eld
13993 \begin_inset Quotes erd
13997 Unfortunately, this environment cannot be omitted, even if you write just
13999 Therefore, each article starts with the command
14005 and, obviously, ends with the command
14012 Although this can be implemented in \SpecialChar LyX
14013 , I didn't included it, since it looks
14014 ugly and can confuse the novice user.
14015 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
14018 \begin_inset Quotes eld
14023 \begin_inset Quotes erd
14029 \begin_layout Enumerate
14030 Information given at the beginning of the article (i.
14031 \begin_inset space \thinspace{}
14035 \begin_inset space \space{}
14038 title, subtitle, author, institution, running title, running author, abstract
14039 and keywords) must be included in an environment called
14040 \begin_inset Quotes eld
14044 \begin_inset Quotes erd
14048 This is not implemented in \SpecialChar LyX
14049 , so you must enter title, subtitle etc.
14050 \begin_inset space ~
14053 between two \SpecialChar TeX
14069 \begin_layout Enumerate
14070 According to the user manual, the label of each bibliography item must be
14094 \begin_layout Standard
14099 template takes care of all these
14100 \begin_inset Quotes eld
14104 \begin_inset Quotes erd
14108 If you start a new paper using this template you don't need to do anything
14113 \begin_layout Enumerate
14114 don't delete the \SpecialChar TeX
14115 code included in the template, and
14118 \begin_layout Enumerate
14119 copy the example bibliography item included in the template and modify it
14120 as necessary to enter new bibliography items.
14123 \begin_layout Section
14127 \begin_layout Standard
14133 \begin_layout Subsection
14137 \begin_layout Standard
14138 The \SpecialChar LyX
14141 article (koma-script)
14145 report (koma-script)
14163 correspond to the \SpecialChar LaTeX
14181 \begin_inset space ~
14184 of the Koma-Script family.
14185 They are replacements for the standard document classes
14201 , resp., and fit better to European typography conventions in a number of
14205 \begin_layout Itemize
14206 Standard character size is 11pt in
14208 article (koma-script)
14212 report (koma-script)
14220 letter (koma-script)
14225 \begin_layout Itemize
14226 Headings, labels of the description environment, and a number of elements
14229 letter (koma-script)
14231 document class are set in a bold sans serif font.
14235 \begin_layout Plain Layout
14236 There is a big difference between the bold sans serif old cm fonts and new
14237 ec fonts, especially in the appearance of headings.
14238 In comparison, the ec bold sans serif fonts look a bit thin.
14239 Here the \SpecialChar LaTeX
14248 helps to produce the
14249 \begin_inset Quotes eld
14253 \begin_inset Quotes erd
14256 appearance when using the ec fonts.
14261 The numbering of chapter headings is made in the same way as the numbering
14262 of section headings, that is without the extra line
14263 \begin_inset Quotes eld
14266 Chapter\SpecialChar ldots
14268 \begin_inset Quotes erd
14272 In addition, the appearance of the headings can be modified by using a
14273 number of options (in \SpecialChar LyX
14274 to be entered in the field
14277 \begin_inset space ~
14284 Layout\SpecialChar menuseparator
14291 \begin_layout Itemize
14292 The main means in the Koma-Script document classes to design the type area
14301 (in \SpecialChar LyX
14302 to be entered in the extra class options field in the dialog
14304 Document\SpecialChar menuseparator
14308 They make a clearer modification of page margins possible as do the options
14311 Document\SpecialChar menuseparator
14318 \begin_layout Itemize
14319 The \SpecialChar LaTeX
14320 document classes of the Koma-Script family define a number of additional
14322 Those part of it which makes sense in \SpecialChar LyX
14323 is implemented in corresponding
14327 \begin_layout Standard
14328 Detailed descriptions of the \SpecialChar LaTeX
14329 document classes of the Koma-Script family
14330 can be found in the Koma-Script documentation
14341 \begin_layout Subsection
14342 article (koma-script), report (koma-script), and book (koma-script)
14345 \begin_layout Standard
14346 The document classes
14348 article (koma-script)
14352 report (koma-script)
14362 are implemented in the layout files
14375 They contain all the paragraph types of the corresponding standard document
14388 , resp., partly modified, with the exception of the \SpecialChar LyX
14393 -type, which is replaced by the new
14397 -type having the same functionality.
14402 -Type there is a number of new paragraph types added.
14409 letter (koma-script)
14414 \begin_layout Itemize
14423 : are equivalents to
14431 , resp., additionally inserting an entry in the table of contents.
14440 are not contained in
14442 article (koma-script)
14447 \begin_layout Itemize
14456 : behave exactly as
14464 , resp., additionally clearing running heads.
14469 is not contained in
14471 article (koma-script)
14477 \begin_layout Plain Layout
14490 report (koma-script)
14492 , but since this is identical to
14496 , is has not been implemented in \SpecialChar LyX
14505 \begin_layout Itemize
14510 : generates a heading directly above the following paragraph in the standard
14511 character size without affecting the structure of the document.
14514 \begin_layout Itemize
14523 are special captions which respect the different space settings needed
14524 for captions placed above or below an element (if you follow strict typographic
14525 rules, you might want to place table captions always above the table).
14526 You can also use the class option
14530 , which will switch
14543 You need at least Koma-Script version 2.8q to use this.
14546 \begin_layout Itemize
14551 : can be used to set a bonmot, e.
14552 \begin_inset space \thinspace{}
14556 \begin_inset space \space{}
14559 at the beginning of a chapter.
14560 If you use the optional argument (
14562 Insert\SpecialChar menuseparator
14564 \begin_inset space ~
14569 ), you can insert the dictum's author there.
14570 Dictum and author are separated by a line.
14571 You need at least Koma-Script version 2.8q to use this.
14576 is not contained in
14578 article (koma-script)
14583 \begin_layout Standard
14584 The following types, together with the standard types
14596 , form the title area of the document.
14597 They must be entered ahead of the first
14598 \begin_inset Quotes eld
14602 \begin_inset Quotes erd
14609 \begin_layout Plain Layout
14610 The corresponding \SpecialChar LaTeX
14611 commands must appear before the
14622 When such a type is used more than once, the latter usage overwrites the
14623 former one, that means, for every type only the latest usage is valid.
14624 The order of the different types however has, like
14636 , no effect on the appearance of the produced document.
14639 \begin_layout Itemize
14644 : produces a centered paragraph above the ordinary title (
14656 ) for the subject of the document.
14659 \begin_layout Itemize
14664 : produces a centered paragraph below the ordinary title (
14676 ) for the publishers' name.
14679 \begin_layout Itemize
14686 report (koma-script)
14692 produces a centered paragraph on its own page behind the title page, or
14695 article (koma-script)
14697 produces a centered paragraph below the ordinary title (
14713 ) for a dedication.
14716 \begin_layout Itemize
14721 : produces a left aligned paragraph above the ordinary title (
14737 ) for a document`s head.
14740 \begin_layout Itemize
14745 : produces in a double-sided print in
14747 report (koma-script)
14753 a left-aligned paragraph at the top of the title page`s back or has no
14754 effect in a single-sided print or in
14756 article (koma-script)
14761 \begin_layout Itemize
14766 : produces in a double-sided print in
14768 report (koma-script)
14774 a left-aligned paragraph at the bottom of the title page`s back or has
14775 no effect in a single-sided print or in
14777 article (koma-script)
14782 \begin_layout Itemize
14787 : produces a special
14788 \begin_inset Quotes eld
14792 \begin_inset Quotes erd
14795 page ahead of the actual document containing a paragraph without special
14799 \begin_layout Standard
14800 The layout files for the document classes
14802 article (koma-script)
14806 report (koma-script)
14812 do include the file
14817 This is thought of as a place to define your own types.
14822 in your personal layout directory and edit the file!
14825 \begin_layout Subsection
14826 letter (koma-script)
14829 \begin_layout Description
14830 Note: This section discusses the obsolete
14832 KOMA-Script-Letter (v.
14833 \begin_inset space ~
14838 , which is not even included anymore in recent KOMA releases.
14839 Please refer to the next section for the current KOMA-Script-Letter class
14841 \begin_inset space ~
14847 \begin_layout Standard
14851 letter (koma-script)
14853 is implemented in the layout file
14858 It contains all the paragraph types of the corresponding standard document
14863 , partly modified, with the exception of the \SpecialChar LyX
14877 type, which is replaced by the new
14882 In addition, it contains, in contrast to the standard document class, the
14901 Furthermore, there are a number of new letter specific types.
14904 \begin_layout Standard
14905 The appearance of the letter produced by this document class can be controlled
14906 by a number of \SpecialChar LaTeX
14907 commands, which you can put in the \SpecialChar LaTeX
14912 \begin_layout Plain Layout
14913 For example, the standard appearance of the letter`s heading, consisting
14914 of name and address, is quite self-willed.
14916 \begin_inset Quotes eld
14920 \begin_inset Quotes erd
14923 heading is produced by the following \SpecialChar LaTeX
14924 commands in the preamble:
14927 \begin_layout LyX-Code
14937 \begin_layout LyX-Code
14953 \begin_layout LyX-Code
14963 \begin_layout LyX-Code
14983 A detailed German description of such \SpecialChar LaTeX
14984 commands can be found in the Koma-Script
14990 With it, the letter's author can produce his personal letter layout.
14993 \begin_layout Standard
15002 define the beginning of the letter and must be used in every letter.
15003 To emphasize them in the \SpecialChar LyX
15004 document class, they are marked with the letter
15014 \begin_inset space ~
15017 in the left margin.
15018 It is possible to write any number of letters in one file.
15023 type produces a new letter using the same addressee and a
15027 type produces a new addressee.
15044 are ordinary paragraph types and can also be used several times in one
15045 and the same letter.
15048 \begin_layout Itemize
15053 : produces a paragraph for the addressee and implicitly defines the beginning
15057 \begin_layout Itemize
15062 : produces a paragraph for the form of address and implicitly produces a
15066 \begin_layout Itemize
15071 : produces a paragraph for a close.
15074 \begin_layout Itemize
15079 : produces a paragraph for a postscript.
15082 \begin_layout Itemize
15087 : produces a paragraph for a distribution list.
15090 \begin_layout Itemize
15095 : produces a paragraph for enclosures.
15098 \begin_layout Standard
15139 are input types provided with a label to enter information, which will
15140 be processed by the document class.
15144 \begin_layout Plain Layout
15145 It could be seen as a matter of inconsequence, that the types
15153 described above are not such input types as well.
15154 Because of the special meaning of those types, however, I have implemented
15155 them as ordinary paragraph types with a one letter mark in the left margin.
15156 Moreover, it would affect my feeling of symmetry, if the
15164 type had such a serious different appearance.
15169 The types must be used ahead of the corresponding
15176 \begin_layout Standard
15177 An implementation of these types in a WYSIWYG fashion does not seem to make
15178 sense, because the real appearance of the produced letter does not only
15179 depend on the usage of the particular type, but also on other factors.
15180 For example, a signature entered in the
15184 type will in the standard behavior appear in the produced letter only,
15185 when in the same letter also a
15190 The entered value of the
15194 type will in the standard behavior not appear in the produced letter at
15196 The possibility to design the letter`s heading freely is already indicated
15197 in a footnote above.
15200 \begin_layout Standard
15201 The input types can also be used as empty paragraphs.
15202 This makes sense e.
15203 \begin_inset space \thinspace{}
15207 \begin_inset space \space{}
15219 type is not used at all, in the standard behavior the value of the
15223 type is used as signature, whereas if an empty
15227 type is used, no signature value is defined.
15230 \begin_layout Standard
15231 By using the input types it is possible to write a letter template, containing
15232 filled input types with your personal dates (name, address, etc.) and empty
15233 input types for other dates you want to enter.
15236 \begin_layout Itemize
15241 : sender's name, in the standard behavior appears as a centered paragraph
15242 in small caps in the letter`s heading.
15245 \begin_layout Itemize
15250 : sender's signature, in the standard behavior appears below the
15259 type is used, the value of the
15263 type appears instead.
15266 \begin_layout Itemize
15271 : sender's address, in the standard behavior appears in a centered paragraph
15272 in the letter`s heading below the sender's name.
15275 \begin_layout Itemize
15280 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
15291 \begin_layout Itemize
15296 : place of the letter`s making.
15299 \begin_layout Itemize
15304 : date of the letter`s making.
15313 , in the standard behavior, produce the place and the date in a right-aligned
15314 line below the addressee's field.
15319 type is used, neither place nor date appear, independent of the value of
15329 type is used, the date of the letter `s production is used.
15332 \begin_layout Itemize
15337 : sender`s back address, in the standard behavior appears above the addressee's
15338 field in a small sans serif font.
15341 \begin_layout Itemize
15346 : special mail information, in the standard behavior appears underlined
15347 above the addressee's field below the back address.
15350 \begin_layout Itemize
15355 : additional information, in the standard behavior appears on right side
15356 below the addressee`s field.
15359 \begin_layout Itemize
15364 : the letter's title, in the standard behavior appears in a big, bold, sans
15365 serif font above the subject.
15368 \begin_layout Itemize
15373 : the letter's subject, in the standard behavior appears in a bold font
15381 \begin_layout Standard
15402 produce a business letter like line above the
15406 line containing the fields
15407 \begin_inset Quotes eld
15411 \begin_inset Quotes erd
15415 \begin_inset Quotes eld
15419 \begin_inset Quotes erd
15423 \begin_inset Quotes eld
15427 \begin_inset Quotes erd
15431 \begin_inset Quotes eld
15435 \begin_inset Quotes erd
15439 \begin_inset Quotes eld
15443 \begin_inset Quotes erd
15447 \begin_inset Quotes eld
15451 \begin_inset Quotes erd
15455 For the date field, the value of the
15461 \begin_inset Quotes eld
15464 business letter types
15465 \begin_inset Quotes erd
15468 is used, the value of the
15472 type however does not appear, but only the \SpecialChar LaTeX
15480 The ordinary output of place and date in a right-aligned line below the
15481 addressee`s field is suppressed.
15482 The types are implemented as input types provided with a label and must
15483 be used ahead of the corresponding
15490 \begin_layout Itemize
15498 \begin_layout Itemize
15506 \begin_layout Itemize
15514 \begin_layout Itemize
15522 \begin_layout Itemize
15530 \begin_layout Subsection
15531 The new letter class: letter (koma-script v.2)
15534 \begin_layout Standard
15540 \begin_layout Standard
15541 \begin_inset VSpace medskip
15547 \begin_layout Standard
15549 Koma-Script version 2.8 has introduced a new letter class
15553 which supersedes the now unsupported
15558 It has — on the \SpecialChar LaTeX
15559 side — a completely new interface and is not compatible
15560 with the old class.
15561 Therefore, \SpecialChar LyX
15562 supports both, though it is recommended you use the new class.
15565 \begin_layout Standard
15566 This class covers the same functionality as
15568 letter (koma-script),
15571 The basic items are
15575 (receiver's address, same as
15579 in the old layout),
15592 will start a new letter (i.
15593 \begin_inset space \thinspace{}
15597 \begin_inset space \space{}
15600 you can write several letters per document).
15601 New elements are sender's
15617 and the possibility to use a
15623 Insert\SpecialChar menuseparator
15629 \begin_layout Standard
15630 The biggest improvement is, though, that the letter's layout is configurable
15631 to meet almost any needs.
15632 This can be done via the preamble or with a special style file (Letter
15633 Class Option, extension
15637 ), that will be read in as a class option.
15641 \begin_layout Plain Layout
15642 The KOMA package comes with some default
15647 There is, for instance, a
15651 file that follows german typesetting rules, or a
15655 that provides the default layout of the old
15660 The latter can be loaded with the class option
15666 Layout\SpecialChar menuseparator
15667 Document\SpecialChar menuseparator
15679 template that is included in \SpecialChar LyX
15681 A detailed description is to be found in the Koma-Script documentation
15689 \begin_layout Subsection
15693 \begin_layout Standard
15694 Visualizing the Koma-Script document classes in \SpecialChar LyX
15695 , the \SpecialChar LyX
15696 internals cause some
15700 \begin_layout Itemize
15701 The chapter number of a
15705 type appears on a line of its own above the chapter heading instead of
15706 appearing in the same line ahead of it.
15707 The cause for that is the \SpecialChar LyX
15708 internal behavior for the labeltype
15712 in the layout file.
15715 \begin_layout Itemize
15716 The headings of the types
15724 are only put in the
15725 \begin_inset Quotes eld
15729 \begin_inset Quotes erd
15733 table of contents, but not in the \SpecialChar LyX
15734 table of contents (
15736 Document\SpecialChar menuseparator
15738 \begin_inset space ~
15742 \begin_inset space ~
15750 \begin_layout Itemize
15751 The paragraphs in a
15755 document class appear in a skip separation mode, not indented.
15756 This is the standard behavior, no special \SpecialChar LaTeX
15757 commands are needed for that.
15760 Document\SpecialChar menuseparator
15763 dialog the corresponding radio button indicates
15772 value always has the effect that extra \SpecialChar LaTeX
15773 commands are inserted in the document
15774 to produce the gap, which is not what is wanted in this case.
15777 \begin_layout Section
15781 \begin_layout Standard
15787 \begin_layout Subsection
15791 \begin_layout Standard
15792 Memoir is a very powerful and constantly evolving class.
15793 It has been designed with regard to fictional and non-fictional literature.
15794 Its aim is to let the user have maximum control over the typesetting of
15796 Memoir is based on the standard book class, but it can also emulate the
15797 article class (see below).
15800 \begin_layout Standard
15801 Peter Wilson, the developer of Memoir, is known as the author of lots of
15802 useful packages in the \SpecialChar LaTeX
15804 Most of them have been merged with Memoir.
15805 Therefore, it is much easier to layout the table of contents, appendices,
15806 chapter designs and such.
15808 , though, does not support all of these goodies natively.
15809 Some of them might be added to forthcoming releases
15813 \begin_layout Plain Layout
15814 You are invited to send suggestions to
15815 \begin_inset Flex URL
15818 \begin_layout Plain Layout
15820 lyx-devel@lists.lyx.org
15830 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
15832 Of course you can still use all features with the help of some native \SpecialChar LaTeX
15834 commands (\SpecialChar TeX
15839 \begin_layout Plain Layout
15844 \begin_layout Plain Layout
15854 \begin_inset space ~
15858 \begin_inset CommandInset ref
15860 reference "sec:Inserting-TeX-Code"
15870 In this section, we can only list those features that are natively supported
15871 by \SpecialChar LyX
15873 For detailed descriptions (and for the rest of features) we recommend you
15874 have a look at the detailed manual of the Memoir class
15878 \begin_layout Plain Layout
15883 \begin_layout Plain Layout
15893 \begin_inset Flex URL
15896 \begin_layout Plain Layout
15898 CTAN:/macros/latex/memoir/memman.pdf
15908 , which is not only a user guide for the class, but also both a comprehensive
15909 description on good typesetting and a superb example for good typesetting
15913 \begin_layout Subsection
15914 Basic features and restrictions
15917 \begin_layout Standard
15918 Memoir supports basically all features of the standard book classes.
15919 There are, however, some differences, as follows:
15922 \begin_layout Description
15924 \begin_inset space ~
15927 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
15930 \begin_layout Description
15932 \begin_inset space ~
15935 style: The fancy page style is not supported, due to a command clash between
15936 Memoir and the fancyhdr package (they both define a command with the same
15937 name, which confuses \SpecialChar LaTeX
15939 Instead, Memoir comes with a number of its own page styles (see
15941 Document\SpecialChar menuseparator
15942 Settings\SpecialChar menuseparator
15944 \begin_inset space ~
15950 If you want to use these for the chapter pages, you have to use the command
15957 in the main text or in preamble (e.
15958 \begin_inset space \thinspace{}
15962 \begin_inset space \space{}
15969 chapterstyle{companion}
15974 \begin_layout Description
15975 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
15976 optional argument in the standard classes.
15977 With this, you can specify an alternative version of the title for the
15978 table of contents and the headers (for instance, if the title is too long).
15979 In \SpecialChar LyX
15980 , you can do this via
15982 Insert\SpecialChar menuseparator
15984 \begin_inset space ~
15989 at the beginning of a chapter/section.
15990 Memoir features a second optional argument and thus separates the table
15991 of contents from the header.
15992 You can define three variants of a title with this: one for the main text,
15993 one for the table of contents, and one for the headers.
15995 makes these available in form of specific
16006 \begin_layout Description
16007 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
16008 of contents, the list of figures and the list of table start a new page
16010 Memoir does not follow this route.
16011 You have to insert a page break yourself, if you want to have one.
16014 \begin_layout Description
16015 Titlepage: For some unknown reason, Memoir uses pagination on the title
16016 page (in the standard classes, title pages are
16017 \begin_inset Quotes eld
16021 \begin_inset Quotes erd
16025 If you want an empty title page, type
16029 aliaspagestyle{title}{empty}
16034 \begin_layout Description
16035 Article: With the class option
16041 Document\SpecialChar menuseparator
16042 Settings\SpecialChar menuseparator
16043 Class Settings\SpecialChar menuseparator
16045 \begin_inset space ~
16050 ), you can emulate article style.
16051 That is, counters (footnotes, figures, tables etc.) will not be reset on
16052 new chapters, chapters don't start a new page (but are—in contrary to
16053 \begin_inset Quotes eld
16057 \begin_inset Quotes erd
16060 article classes—still allowed), parts, though, use their own page, as in
16064 \begin_layout Description
16065 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
16066 font commands, which have been used in the old \SpecialChar LaTeX
16068 \begin_inset space \thinspace{}
16072 \begin_inset space \space{}
16088 It produces an error and stops \SpecialChar LaTeX
16089 whenever such a command appears.
16094 reallows the commands and spits out warnings instead (which does at least
16095 not stop \SpecialChar LaTeX
16097 Since a lot of packages and particularly Bib\SpecialChar TeX
16098 style files are still using
16099 those commands, we have decided to use this option by default.
16102 \begin_layout Subsection
16106 \begin_layout Standard
16107 We will only describe the features supported by \SpecialChar LyX
16108 (which is not much currently).
16109 Please consult the Memoir manual
16113 \begin_layout Plain Layout
16118 \begin_layout Plain Layout
16128 \begin_inset Flex URL
16131 \begin_layout Plain Layout
16133 CTAN:/macros/latex/memoir/memman.pdf
16146 \begin_layout Description
16147 Abstract: You may wonder why an abstract is an extra feature.
16148 Well, it is in book class.
16149 Usually books don't have abstracts.
16150 Memoir, however, has.
16151 You can use it wherever and how often you like.
16154 \begin_layout Description
16155 Chapterprecis: You may know this older typesetting style: The contents of
16156 a chapter are summarized below the title and also in the table of contents
16158 \begin_inset space \thinspace{}
16162 \begin_inset space \space{}
16167 Our hero arrives in Troia; he loses some friends; he finds others
16170 Chapterprecis does exactly this.
16171 It is therefore only sensible below a chapter.
16174 \begin_layout Description
16175 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
16176 The epigraph environment provides an elegant way of typesetting such a
16178 The motto itself (text) and its (optional) author (source) are divided
16180 The author (source) can be inserted via
16182 Insert\SpecialChar menuseparator
16189 \begin_layout Description
16190 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
16191 complex figurative poems).
16193 can only support a few of them.
16194 One is poemtitle, which is a centered title for poems, which will also
16195 be added to the table of contents (verse is the standard environment for
16197 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
16199 because they have to be nested inside regular verse environments, which
16200 is not possible with \SpecialChar LyX
16204 \begin_layout Description
16205 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
16208 \begin_layout Section
16209 Article (mwart), book (mwbk) and report (mwrep)
16210 \begin_inset Argument status
16213 \begin_layout Plain Layout
16226 \begin_layout Standard
16232 \begin_layout Standard
16233 The \SpecialChar LyX
16250 correspond to the \SpecialChar LaTeX
16264 They are replacements for the standard document classes
16276 , resp., and fit better to Polish typography conventions in a number of points.
16280 \begin_layout Standard
16284 \begin_layout Itemize
16285 Unnumbered titles (with star, e.
16286 \begin_inset space \thinspace{}
16290 \begin_inset space \space{}
16297 ) are added into table of contents,
16300 \begin_layout Itemize
16301 Additional page styles:
16305 \begin_layout Description
16306 uheadings header with separated lines,
16309 \begin_layout Description
16310 myheadings custom header, contents headers via commands:
16325 \begin_layout Description
16326 myuheadings custom header with separated lines,
16329 \begin_layout Description
16330 outer page number is placed on outer side of page
16334 \begin_layout Itemize
16339 \begin_layout Description
16340 rmheadings serif titles — default,
16343 \begin_layout Description
16344 sfheadings sansserif titles,
16347 \begin_layout Description
16348 authortitle on title page first placed is author next title — default,
16351 \begin_layout Description
16352 titleauthor on title page first placed is title next author,
16355 \begin_layout Description
16356 withmarginpar reserve place on page for margins.
16360 \begin_layout Section
16364 \begin_layout Standard
16369 provides an alternative to the standard
16374 It provides similar functionality, but you might prefer this layout with
16375 sans serif sections, headings, and more.
16378 \begin_layout Section
16379 Rev\SpecialChar TeX
16383 \begin_layout Standard
16389 \begin_layout Standard
16390 \begin_inset VSpace bigskip
16396 \begin_layout Standard
16401 \begin_inset space ~
16406 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
16408 \begin_inset Formula $\beta$
16411 release of May, 1999) class.
16414 \begin_layout Standard
16420 textclass, which works with Rev\SpecialChar TeX
16422 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
16424 That means that it doesn't interact very well with \SpecialChar LyX
16425 , which requires \SpecialChar LaTeX2e
16427 it has been kludged to work.
16428 Since Rev\SpecialChar TeX
16429 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
16434 Rev\SpecialChar TeX
16436 \begin_inset space ~
16441 textclass should also be pretty easy to use.
16444 \begin_layout Standard
16445 These documents are supposed to be used in
16449 to the Rev\SpecialChar TeX
16450 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
16452 and assume you'll know what to put in the preamble if necessary.
16455 \begin_layout Subsection
16459 \begin_layout Standard
16460 All you need to do is install Rev\SpecialChar TeX
16461 4, as described in the package's README
16463 The package can be found at The Rev\SpecialChar TeX
16465 \begin_inset Flex URL
16468 \begin_layout Plain Layout
16470 http://publish.aps.org/revtex4/
16476 Install it somewhere that \SpecialChar LaTeX
16478 Test it by trying to \SpecialChar LaTeX
16479 a short Rev\SpecialChar TeX
16480 4 document in some random directory (i.
16481 \begin_inset space \thinspace{}
16485 \begin_inset space \space{}
16488 not the directory where you installed the class file.) Then, if you reconfigure
16490 , it will find the class file and let you use the Rev\SpecialChar TeX
16494 \begin_layout Standard
16495 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
16504 \begin_inset space ~
16509 template, found in the templates directory.
16512 \begin_layout Subsection
16516 \begin_layout Standard
16517 Optional arguments to
16524 \begin_inset Quotes eld
16528 \begin_inset Quotes erd
16532 \begin_inset Quotes eld
16536 \begin_inset Quotes erd
16542 \begin_inset space ~
16550 \begin_inset space ~
16556 Remember that in Rev\SpecialChar TeX
16557 , at least one optional argument is required!
16560 \begin_layout Standard
16561 Other preamble matter, like
16568 \begin_inset space ~
16575 \begin_inset space ~
16580 dialog, also as usual.
16583 \begin_layout Subsection
16587 \begin_layout Standard
16588 The layouts basically correspond to the commands in Rev\SpecialChar TeX
16590 For example, the Email layout corresponds to
16597 Note that (at least as of Rev\SpecialChar TeX
16606 layouts are exactly equivalent, so you shouldn't need to use both.
16610 \begin_layout Plain Layout
16611 In case you're curious, both were included so that
16615 would be able to translate both
16635 \begin_layout Subsection
16639 \begin_layout Standard
16640 There are a couple of important unique aspects of Rev\SpecialChar TeX
16641 4 which might cause
16642 bugs that will be even more confusing in \SpecialChar LyX
16646 \begin_layout Standard
16647 In Rev\SpecialChar TeX
16665 The \SpecialChar LyX
16666 equivalent is that there is a separate Thanks layout.
16671 write footnotes in the
16675 layout, or weird things may happen.
16676 See the Rev\SpecialChar TeX
16677 4 documentation for more details.
16680 \begin_layout Standard
16684 \begin_inset space ~
16692 \begin_inset space ~
16701 layouts must be placed
16709 layout and the corresponding
16726 , the \SpecialChar LaTeX
16730 \begin_layout Section
16731 Springer Journals (
16738 \begin_layout Standard
16744 \begin_layout Subsection
16748 \begin_layout Standard
16749 These are the layout files for some of the journal formats used by Springer
16750 Verlag and listed on
16751 \begin_inset Flex URL
16754 \begin_layout Plain Layout
16756 http://www.springer.de/author/tex/help-journals.html
16761 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
16763 It is a modular system: the things common to all journals are implemented
16768 , which journal-specific layout files (such as, e.
16769 \begin_inset space \thinspace{}
16773 \begin_inset space \space{}
16780 for Journal of Geodesy) can include.
16783 \begin_layout Standard
16784 This means that implementing support for any other Springer journal on this
16785 list is as simple as writing your own
16793 file following the outline given in
16801 \begin_layout Standard
16802 It is reasonably well tested only for the Journal of Geodesy.
16811 come with the standard \SpecialChar LyX
16813 Install the relevant class file (downloaded from Springer) in a proper
16814 directory, reconfigure \SpecialChar LaTeX
16815 (in the te\SpecialChar TeX
16820 , as root if necessary — doesn't \SpecialChar LyX
16821 take care of this?), reconfigure \SpecialChar LyX
16826 \begin_layout Subsection
16830 \begin_layout Standard
16831 A large number of theorem-like styles —
16843 \begin_layout Standard
16846 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
16847 _Title, Author_Running, Institute,
16848 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
16851 See the Springer class file documentation for details.
16854 \begin_layout Subsection
16858 \begin_layout Itemize
16870 \begin_layout Itemize
16873 Probability Theory and Related Fields
16879 — Jean-Marc Lasgouttes
16882 \begin_layout Standard
16883 Add your own, it isn't so hard!
16886 \begin_layout Subsection
16890 \begin_layout Standard
16891 These files are partly based on the older
16895 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
16897 file from Springer.
16902 layout, are now defunct.
16903 Jean-Marc Lasgouttes helped out big in making me find my way around the
16905 layout file mechanism.
16908 \begin_layout Subsection
16912 \begin_layout Standard
16914 But probably less than in the old hacked-\SpecialChar LaTeX
16922 \begin_layout Section
16925 Sli\SpecialChar TeX
16929 \begin_inset CommandInset label
16938 \begin_layout Standard
16946 \begin_layout Subsection
16950 \begin_layout Standard
16951 This section describes how to use \SpecialChar LyX
16952 to make slides for overhead projectors.
16953 There are two document classes that can do this: the default slides class
16956 Foil\SpecialChar TeX
16960 This section documents the former.
16963 \begin_layout Standard
16964 I'm going to say this again, nice and clear, so that there's no misunderstanding
16968 \begin_layout Standard
16969 \begin_inset VSpace bigskip
16975 \begin_layout Standard
16979 This section documents the class
16980 \begin_inset Quotes eld
16988 \begin_inset Quotes erd
16996 \begin_layout Standard
16997 \begin_inset VSpace bigskip
17003 \begin_layout Standard
17004 If you're looking for the documentation for
17005 \begin_inset Quotes eld
17010 slides (Foil\SpecialChar TeX
17014 \begin_inset Quotes erd
17017 , check out section
17018 \begin_inset space ~
17022 \begin_inset CommandInset ref
17024 reference "sec:foiltex"
17034 \begin_inset Quotes eld
17039 slides (Foil\SpecialChar TeX
17043 \begin_inset Quotes erd
17046 ] is actually somewhat better than the default
17054 \begin_layout Plain Layout
17056 or so I've been told repeatedly by its advocates.
17057 Having never used it, I have no idea if this claim is true or not.
17062 which this section documents.
17065 \begin_layout Standard
17066 This class is the \SpecialChar LaTeX2e
17067 improvement of the old
17069 Sli\SpecialChar TeX
17073 Every \SpecialChar LaTeX2e
17074 distribution includes this class [which I'll just refer to as
17075 \begin_inset Quotes eld
17083 \begin_inset Quotes erd
17086 from now on], so you're bound to have it.
17087 As I noted earlier, there are other classes, such as
17091 , which also produce slides for overhead projectors and do a better job
17093 However, there are some things which
17097 can do which the others can't, such as generate overlays.
17098 Read on to learn more!
17101 \begin_layout Subsection
17103 \begin_inset CommandInset label
17105 name "sec:slidesetup"
17112 \begin_layout Standard
17113 Obviously, to use this document class, you need to select
17114 \begin_inset Quotes eld
17122 \begin_inset Quotes erd
17125 from the class list in the
17127 Document\SpecialChar menuseparator
17131 There are some other special things you should know about this class:
17134 \begin_layout Itemize
17135 Don't bother changing the options
17140 They're not supported by the
17147 \begin_layout Itemize
17151 \begin_inset space ~
17156 behaves a bit differently for this class.
17157 The possible choices and what they do are as follows:
17161 \begin_layout Description
17166 The final output contains page numbers in the lower right corner.
17169 \begin_layout Description
17178 , but also prints out any time markers you've put in.
17179 This is the default.
17182 \begin_layout Description
17187 The final output contains no page numbers, time markers, or alignment markers.
17191 \begin_layout Itemize
17196 class has an extra option:
17202 \begin_inset Quotes eld
17210 \begin_inset Quotes erd
17213 in the extra class options.
17217 \begin_layout Standard
17218 Using this options allows you to add time markers to
17224 \begin_inset space ~
17228 \begin_inset CommandInset ref
17230 reference "sec:slideNote"
17238 \begin_layout Standard
17239 You can also use the template file
17240 \begin_inset Quotes eld
17248 \begin_inset Quotes erd
17251 to automatically set up a document to use the
17257 File\SpecialChar menuseparator
17259 \begin_inset space ~
17263 \begin_inset space ~
17268 to open your new document].
17269 The template file also contains some examples of the special paragraph
17270 environments used by this class.
17271 I'll describe those next.
17274 \begin_layout Subsection
17275 Paragraph Environments
17278 \begin_layout Subsubsection
17279 Supported Environments
17282 \begin_layout Standard
17283 The first thing you'll notice when you start up a new
17287 document is the font size and type: it's the equivalent of the size
17288 \begin_inset Quotes eld
17296 \begin_inset Quotes erd
17302 \begin_inset space ~
17308 This is also what's used in the output.
17310 \begin_inset Quotes eld
17314 \begin_inset Quotes erd
17317 to remind you that this is a slide.
17318 Your final slides will use a larger font; ergo, you'll have less space.
17319 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
17322 \begin_layout Standard
17323 The next thing that becomes obvious is the changes to the paragraph environment
17324 pull-down box [at the far-left end of the toolbar].
17325 Most of the paragraph environments you're used to seeing are missing.
17326 There are also five new ones.
17331 class itself only supports certain paragraph environments:
17334 \begin_layout Itemize
17340 \begin_layout Itemize
17346 \begin_layout Itemize
17352 \begin_layout Itemize
17358 \begin_layout Itemize
17364 \begin_layout Itemize
17370 \begin_layout Itemize
17376 \begin_layout Itemize
17382 \begin_layout Itemize
17388 \begin_layout Itemize
17395 \begin_layout Standard
17396 All of the other standard environments, including the section-heading environmen
17397 ts, aren't used in the
17404 \begin_layout Standard
17405 On the other hand, you'll notice the following new environments:
17408 \begin_layout Itemize
17414 \begin_layout Itemize
17420 \begin_layout Itemize
17426 \begin_layout Itemize
17432 \begin_layout Itemize
17438 \begin_layout Standard
17439 These five are kind of quirky, due to a
17440 \begin_inset Quotes eld
17444 \begin_inset Quotes erd
17447 in \SpecialChar LyX
17449 You see, \SpecialChar LyX
17450 doesn't permit you to nest any other paragraph environment into
17451 an empty environment.
17452 Now, that's fine and dandy, but it means that you wouldn't be able to start
17453 a slide with anything except plain text.
17454 To deal with this, I've performed a little
17455 \begin_inset Quotes eld
17460 \begin_inset Quotes erd
17466 \begin_layout Subsubsection
17467 Quirks of the New Environments
17468 \begin_inset CommandInset label
17470 name "sec:slideQuirk"
17477 \begin_layout Standard
17478 All five of the new paragraph environments are somewhat quirky due to inherent
17479 limitiations in the current version of \SpecialChar LyX
17481 As I just mentioned, \SpecialChar LyX
17482 forbids environments that begin with another environment.
17483 To get around this, the
17487 environment isn't a paragraph environment as described in the
17495 \begin_layout Standard
17496 You should consider
17509 \begin_inset Quotes eld
17512 pseudo-environments.
17513 \begin_inset Quotes erd
17516 They look like a section heading or a
17517 \begin_inset Quotes eld
17525 \begin_inset Quotes erd
17528 but really begin a [and, if necessary, end the previous] paragraph environment.
17538 \begin_inset Quotes eld
17542 \begin_inset Quotes erd
17545 These two perform some action.
17548 \begin_layout Standard
17549 A common feature of all five environments,
17569 , is a rather long-ish label.
17570 The text following this label — ordinarily the contents of the paragraph
17571 environment — is utterly irrelevant for
17593 completely ignores it.
17594 In fact, you can leave these five environments completely empty.
17598 \begin_layout Standard
17603 to put any text after the rather long-ish label, you might want to.
17604 This could be a short description of the contents of the
17609 In that case, enter your descriptive comment and hit
17613 as you normally would.
17616 \begin_layout Standard
17617 If, on the other hand, you don't want to enter any descriptive text, you'll
17618 hit another \SpecialChar LyX
17621 , like nature, abhors a vacuum, and will not let you start a new paragraph
17622 environment until you put something in the old one.
17626 \begin_layout Itemize
17627 Start entering the text that will
17655 \begin_layout Itemize
17656 Now move to the beginning of that paragraph.
17660 \begin_layout Itemize
17669 \begin_layout Itemize
17670 Finally, change this new, empty paragraph to a
17694 \begin_layout Standard
17695 Some future version of \SpecialChar LyX
17696 will, hopefully, resolve this quirkiness\SpecialChar ldots
17700 \begin_layout Subsection
17701 Making a Presentation with
17714 \begin_layout Subsubsection
17722 \begin_layout Standard
17723 If you're expecting this section to teach you how to actually make a presentatio
17724 n, you'll be sorely disappointed.
17725 Naturally, I'll describe all of the ways the
17729 class can assist you in preparing the materials for a presentation.
17730 Filling in the contents, however, is up to you.
17735 the \SpecialChar LyX
17739 \begin_layout Standard
17744 environment [in the manner described in section
17745 \begin_inset space ~
17749 \begin_inset CommandInset ref
17751 reference "sec:slideQuirk"
17755 ] tells \SpecialChar LyX
17756 to begin a new slide [duh].
17757 The label for this environment/
17758 \begin_inset Quotes erd
17762 \begin_inset Quotes erd
17766 \begin_inset Quotes eld
17770 \begin_inset Quotes erd
17773 in cool blue, followed by the label,
17774 \begin_inset Quotes eld
17778 \begin_inset Quotes erd
17782 Any text or paragraph environments that follow this one go on the new slide.
17786 \begin_layout Standard
17787 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
17789 (this can be specified in the
17794 In fact, you'll want to, once you finish entering the contents of one slide.
17795 If you've entered more text than can physically fit on a slide, the extra
17796 overflows onto a new slide.
17797 I don't recommend doing this, however, since the overflow slide won't have
17798 any page number on it.
17799 Furthermore, it may interfere with any
17803 you've made to accompany the oversized
17810 \begin_layout Standard
17819 environments work the same way as the
17824 They both create an
17825 \begin_inset Quotes eld
17829 \begin_inset Quotes erd
17832 followed by a label [
17833 \begin_inset Quotes eld
17837 \begin_inset Quotes erd
17841 \begin_inset Quotes eld
17845 \begin_inset Quotes erd
17849 The color is a stunning magenta instead of blue, and the
17850 \begin_inset Quotes eld
17854 \begin_inset Quotes erd
17857 will look different, in style and in length.
17858 The label fonts of all three also differ from one another.
17861 \begin_layout Standard
17866 , if the contents of a
17874 exceed the physical size of a slide or sheet of paper, the extra will overflow
17876 Again, you should avoid this.
17877 It defeats the whole purpose of
17888 \begin_layout Subsubsection
17898 \begin_layout Standard
17903 is a slide that sits atop another slide.
17904 Perhaps you wish to discuss a figure on the main
17908 before displaying the text associated with it.
17909 One way to accomplish this is tape a flap of dark paper over the part of
17914 you want to display later.
17915 This method fails, however, if you wish to overlap one graph with another,
17917 You would then have to fumble while speaking to align the two separate,
17922 s to align the two graphs.
17927 environment in both cases makes life much easier.
17930 \begin_layout Standard
17935 receives the page number of its
17936 \begin_inset Quotes eld
17940 \begin_inset Quotes erd
17948 \begin_inset Quotes eld
17956 \begin_inset Quotes erd
17963 \begin_layout Plain Layout
17964 Presumably, mutliple
17969 \begin_inset Quotes eld
17977 \begin_inset Quotes erd
17981 \begin_inset Quotes eld
17989 \begin_inset Quotes erd
17993 \begin_inset Quotes eld
18001 \begin_inset Quotes erd
18005 \begin_inset space ~
18008 appended to the page number of the parent
18018 Clearly, you want the contents of both the
18026 to each fit on a single physical slide! You should probably consider an
18032 \begin_inset Quotes eld
18036 \begin_inset Quotes erd
18044 Indeed, the \SpecialChar LyX
18049 class provides a visual cue for this: the label at the start of an
18053 is shorter than that at the start of a
18058 Lastly, when you generate printable output, you'll find alignment markers
18059 in all four corners of both the
18063 page and its parent
18068 These will assist you in lining up the two physical slides.
18071 \begin_layout Standard
18072 The major problem in overlaying two slides is aligning the contents of the
18073 two transparencies.
18074 How much space should you leave for that graph on the second slide? Worse
18075 still, what if you want a graph and a sentence on second slide, but there
18076 is text on the main transparency that goes in between them? You could try
18077 and insert vertical space of the right size.
18078 The better way is to use
18089 \begin_layout Standard
18090 As their names imply,
18098 are two command-like paragraph environments that make all subsequent text
18099 invisible and visible, respectively.
18101 \begin_inset space ~
18105 \begin_inset CommandInset ref
18107 reference "sec:slideQuirk"
18111 that you don't place anything
18115 these two environments, however.
18120 , it inserts a centered, sky-blue label into the page reading
18121 \begin_inset Quotes eld
18124 <Invisible Text Follows>
18125 \begin_inset Quotes erd
18129 For paragraphs following this label, the parts of the
18137 ; it doesn't matter which] where they would be contain instead blank space.
18141 \begin_layout Standard
18146 , the corresponding centered label is
18147 \begin_inset Quotes eld
18150 <Visible Text Follows>
18151 \begin_inset Quotes erd
18155 Paragraphs following this label behave normally.
18156 Note that the beginning of a new
18168 automatically shuts off an
18173 It's therefore not necessary to use
18184 \begin_layout Standard
18185 By now, it should be obvious how to create overlay transparencies using
18186 the proper combination of
18205 \begin_layout Enumerate
18210 , including everything that will appear on it, whether on the main slide
18218 \begin_layout Enumerate
18219 Before each figure or paragraph that will appear only on the
18228 If necessary, insert a
18232 environment after the
18239 \begin_layout Enumerate
18244 immediately following the
18251 \begin_layout Enumerate
18252 Copy the contents of this
18263 \begin_layout Enumerate
18268 , change all of the
18279 \begin_layout Standard
18281 You've just made an
18288 \begin_layout Standard
18289 There's one problem with the way I've designed the \SpecialChar LyX
18294 class: you can't make text in the middle of a paragraph invisible, nor
18295 make text in the middle of an invisible paragraph visible again.
18296 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
18301 \begin_layout Plain Layout
18302 The commands of interest are:
18305 \begin_layout Itemize
18310 invisible \SpecialChar ldots
18314 \begin_layout Itemize
18319 visible \SpecialChar ldots
18323 \begin_layout Plain Layout
18325 and need to be marked as \SpecialChar TeX
18328 \begin_inset Quotes eld
18332 \begin_inset Quotes erd
18335 you wish to change goes in between the brackets [and after the
18348 If you don't know how to mark text as \SpecialChar TeX
18349 , see the appropriate section of
18362 \begin_layout Subsubsection
18372 \begin_inset CommandInset label
18374 name "sec:slideNote"
18381 \begin_layout Standard
18390 is associated with a
18391 \begin_inset Quotes eld
18395 \begin_inset Quotes erd
18403 Here, too, the \SpecialChar LyX
18408 class provides visual cues.
18413 is shorter than that of a
18417 [yet longer than that of an
18421 ] and, like the label of an
18425 is shockingly magenta.
18426 Additionally, the printed
18430 has the page number of its
18431 \begin_inset Quotes eld
18435 \begin_inset Quotes erd
18443 \begin_inset Quotes eld
18451 \begin_inset Quotes erd
18455 \begin_inset Quotes eld
18463 \begin_inset Quotes erd
18467 \begin_inset Quotes eld
18475 \begin_inset Quotes erd
18479 You can have multiple
18483 s associated with a single
18495 , you'll probably want to break up long
18499 s so that they fit on a single sheet of paper.
18502 \begin_layout Standard
18507 is obvious: it contains anything additional you might want to say about
18513 It could also be used as a sheet of reminders for a particular
18518 In the case of the latter, you might want to make use of time markers.
18519 Currently, the \SpecialChar LyX
18525 \begin_inset Quotes eld
18529 \begin_inset Quotes erd
18532 support for time markers, a
18534 Sli\SpecialChar TeX
18538 So, you'll have to resort to using the \SpecialChar LaTeX
18542 \begin_layout Standard
18543 To use time markers, you'll need to specify the extra class option
18544 \begin_inset Quotes eld
18552 \begin_inset Quotes erd
18556 \begin_inset space ~
18560 \begin_inset CommandInset ref
18562 reference "sec:slidesetup"
18567 This option turns on timing marks, which will appear in the lower-left-hand
18573 To set what appears in the time marker, you use the \SpecialChar LaTeX
18575 \begin_inset Quotes eld
18585 \begin_inset Quotes erd
18589 \begin_inset Quotes eld
18599 \begin_inset Quotes erd
18603 The arguments of both commands are time measured in seconds.
18605 \begin_inset Quotes eld
18615 \begin_inset Quotes erd
18618 sets the time marker to a given time.
18620 \begin_inset Quotes eld
18630 \begin_inset Quotes erd
18633 increments the time marker by the specified amount.
18634 Using time markers and
18638 s in this fashion, you can remind yourself how much time to spend on a particula
18646 \begin_layout Standard
18647 There's one last feature to describe.
18648 Clearly, you'd like to print out all of your
18656 s on transparencies while printing all of your
18673 with which it is associated.
18674 What's a person to do?
18677 \begin_layout Standard
18678 Luckily, there are two \SpecialChar LaTeX
18679 commands that allow you to select what to print
18681 Both must be placed into the preamble of your document.
18683 \begin_inset Quotes eld
18695 \begin_inset Quotes erd
18698 will cause the output to contain only the
18707 Correspondingly, the command
18708 \begin_inset Quotes eld
18720 \begin_inset Quotes erd
18723 prevents the output of anything but
18728 I'd advise placing both commands in the preamble and initially comment
18730 You can then preview your entire presentation as you write.
18731 When you're done writing, you can then uncomment one of the two to select
18732 what you want to print.
18733 I like to uncomment
18734 \begin_inset Quotes eld
18746 \begin_inset Quotes erd
18749 , print to a file with
18750 \begin_inset Quotes eld
18758 \begin_inset Quotes erd
18761 in its name, comment it back out, then uncomment
18762 \begin_inset Quotes eld
18774 \begin_inset Quotes erd
18778 \begin_inset Quotes eld
18786 \begin_inset Quotes erd
18790 I can then send either file to a printer, loading transparencies or plain
18791 paper as appropriate.
18794 \begin_layout Standard
18795 You can also provide other arguments to the
18796 \begin_inset Quotes eld
18806 \begin_inset Quotes erd
18810 \begin_inset Quotes eld
18820 \begin_inset Quotes erd
18824 See a good \SpecialChar LaTeX
18828 \begin_layout Subsection
18833 Class Template File
18836 \begin_layout Standard
18837 I have also provided a template file,
18838 \begin_inset Quotes eld
18846 \begin_inset Quotes erd
18854 To use it, begin your new presentation with
18856 File\SpecialChar menuseparator
18858 \begin_inset space ~
18862 \begin_inset space ~
18868 Your new \SpecialChar LyX
18869 presentation file will contain an example
18890 additionally contain an example of the use of
18899 Lastly, the preamble will contain:
18902 \begin_layout LyX-Code
18903 % Uncomment to print out only slides and overlays
18906 \begin_layout LyX-Code
18910 \begin_layout LyX-Code
18916 \begin_inset Newline newline
18922 \begin_layout LyX-Code
18923 % Uncomment to print out only notes
18926 \begin_layout LyX-Code
18930 \begin_layout LyX-Code
18938 \begin_layout Standard
18939 One final thing: I created this class to support the \SpecialChar LaTeX2e
18941 \begin_inset Quotes eld
18946 Sli\SpecialChar TeX
18950 \begin_inset Quotes erd
18953 class, one of the built-in \SpecialChar LaTeX2e
18955 Neither I nor the rest of the \SpecialChar LyX
18956 Team endorse or oppose the use of this built-in
18958 It's here if you want it or need it.
18959 There exist other \SpecialChar LaTeX2e
18960 classes for creating presentations, such as the
18965 \begin_inset space ~
18969 \begin_inset CommandInset ref
18971 reference "sec:foiltex"
18976 \begin_inset Quotes eld
18984 \begin_inset Quotes erd
18987 package [present on some \SpecialChar TeX
18989 The latter is not yet supported under \SpecialChar LyX
18994 \begin_layout Plain Layout
18995 Perhaps you can take on the task\SpecialChar ldots
19001 I know nothing about these other classes.
19002 Try them out to see what sort of alternative they provide.
19005 \begin_layout Chapter
19007 Features needing Extra Software
19010 \begin_layout Section
19011 Checking \SpecialChar TeX
19015 \begin_layout Standard
19021 \begin_layout Subsection
19025 \begin_layout Standard
19034 \begin_layout Plain Layout
19039 is not yet available when you are using the \SpecialChar LaTeX
19040 distribution MiK\SpecialChar TeX
19046 , you'll find in the
19053 \begin_inset space ~
19064 \begin_inset Newline newline
19068 \begin_inset CommandInset href
19070 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
19078 \begin_layout Standard
19081 Chk\SpecialChar TeX
19084 package is a program that was written by
19085 \begin_inset Flex Noun
19088 \begin_layout Plain Layout
19090 \begin_inset space ~
19098 in frustration because some constructs in \SpecialChar LaTeX
19099 are sometimes non-intuitive,
19100 and easy to forget.
19101 The program runs over your \SpecialChar LaTeX
19102 file, checks the integrity of the file, and
19103 flags some common errors.
19104 In other technical words, it is
19108 for \SpecialChar LaTeX
19112 \begin_layout Standard
19113 Well, what is a syntax checker doing in \SpecialChar LyX
19114 which is supposed to produce correct
19116 anyways? The answer is simple: Just as
19120 not only checks the
19124 of C programs, but also does
19128 checks for type-errors,
19130 Chk\SpecialChar TeX
19133 catches some common
19137 errors, in addition to the syntactical ones.
19140 Chk\SpecialChar TeX
19143 is capable of detecting several common errors, such as
19146 \begin_layout Itemize
19147 Ellipsis detection:
19148 \begin_inset Newline newline
19151 Use \SpecialChar ldots
19155 \begin_layout Itemize
19156 No space in front of/after parenthesis:
19157 \begin_inset Newline newline
19163 \begin_layout Itemize
19164 Enforcement of normal space after common abbreviations:
19165 \begin_inset Newline newline
19169 \begin_inset space \thinspace{}
19173 \begin_inset space \space{}
19176 is too wide spacing.
19179 \begin_layout Itemize
19180 Enforcement of end-of-sentence space when the last sentence ends with a
19182 \begin_inset Newline newline
19186 And this is wrong spacing.
19189 \begin_layout Itemize
19190 Space in front of labels and similar commands:
19191 \begin_inset Newline newline
19194 The label should stick right up to the text to avoid falling to a wrong
19197 \begin_inset CommandInset label
19207 \begin_layout Plain Layout
19208 This footnote is in danger of falling off to a wrong page
19213 The label is separated too much.
19216 \begin_layout Itemize
19217 Space in front of references, instead of hard spaces:
19218 \begin_inset Newline newline
19221 If you have bad luck, the text will break right between the referenced text
19222 and reference number, and that's a pity.
19224 \begin_inset CommandInset ref
19226 reference "sec:chktex"
19233 \begin_layout Itemize
19235 \begin_inset Quotes eld
19239 \begin_inset Quotes erd
19243 \begin_inset Formula $\times$
19247 \begin_inset Newline newline
19250 2x2 looks cheap compared to
19251 \begin_inset Formula $2\times2$
19257 \begin_layout Standard
19258 and more \SpecialChar ldots
19259 It is an invaluable tool when you are
19260 \begin_inset Quotes eld
19264 \begin_inset Quotes erd
19267 your document before printing, and you should run it right after the obligatory
19268 spelling check, and before you go fine tuning the typesetting.
19271 \begin_layout Subsection
19275 \begin_layout Standard
19276 If you have the program installed, usage is as simple as choosing
19278 Tools\SpecialChar menuseparator
19280 \begin_inset space ~
19286 This will make \SpecialChar LyX
19287 generate a \SpecialChar LaTeX
19288 file of your document, start
19290 Chk\SpecialChar TeX
19293 to check it, and then make \SpecialChar LyX
19295 \begin_inset Quotes eld
19299 \begin_inset Quotes erd
19302 with the warnings from
19304 Chk\SpecialChar TeX
19307 , if there were any.
19308 The warnings will be placed close to the point of the mistake, and you
19309 can quickly find them by using the
19311 Navigate\SpecialChar menuseparator
19314 menu item, or the shortcut key
19323 Open the error boxes by clicking on them with the mouse, or use the shortcut
19332 bindings, or the corresponding
19341 Read the warning and correct the mistake, if it is a mistake.
19342 If you have trouble understanding what the warning is about, you can safely
19344 Remember that there is a hidden layer between the document on screen and
19345 the technical details in invoking
19347 Chk\SpecialChar TeX
19350 , and this gap can make some warnings seem arcane or just plain silly.
19353 \begin_layout Standard
19354 This document is an excellent testing bed for the feature, and it should
19355 provide quite a few warnings for you to fiddle with.
19356 Since computers are only so smart, expect most of the warnings to be false
19360 \begin_layout Subsection
19361 How to fine tune it
19364 \begin_layout Standard
19365 Sometimes, you'll find that
19367 Chk\SpecialChar TeX
19370 makes more noise than suits your mood.
19371 Then you can choose not to use it, wait until your mood changes, or try
19374 Chk\SpecialChar TeX
19377 to get better along with you.
19380 \begin_layout Standard
19383 Chk\SpecialChar TeX
19390 very configurable and extensible, you should not expect to solve all problems
19393 Chk\SpecialChar TeX
19396 in \SpecialChar LyX
19398 Since \SpecialChar LyX
19399 has to generate a somewhat special \SpecialChar LaTeX
19400 file to be able to match the
19401 line numbers from the
19403 Chk\SpecialChar TeX
19410 \begin_layout Plain Layout
19411 You can inspect the specific output from
19417 Document\SpecialChar menuseparator
19420 \begin_inset space ~
19434 to the internal document structure, some of the warnings will not appear
19436 There are two things you can do about this:
19439 \begin_layout Itemize
19442 Chk\SpecialChar TeX
19445 invocation command line in
19446 \begin_inset Flex Noun
19449 \begin_layout Plain Layout
19450 Tools\SpecialChar menuseparator
19451 Preferences\SpecialChar menuseparator
19452 Output\SpecialChar menuseparator
19453 LaTeX\SpecialChar menuseparator
19461 Chk\SpecialChar TeX
19464 installation configuration file (usually with the file
19469 See below to learn what warnings can be enabled and disabled on the command
19473 \begin_layout Itemize
19474 Export your document as a raw \SpecialChar LaTeX
19477 File\SpecialChar menuseparator
19478 Export\SpecialChar menuseparator
19487 Invoked in this way, it can be a hassle to find the corresponding place
19488 in the document inside \SpecialChar LyX
19489 , but with a little patience, you should be able
19493 \begin_layout Standard
19494 Here follows the warning messages that can be enabled and disabled in
19503 to disable a warning, and
19507 to enable a warning.
19508 The emphasized entries are disabled by default, because the default is
19511 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
19516 \begin_layout Standard
19517 Notice that you should only use the options that enable and disable warnings,
19518 because \SpecialChar LyX
19519 relies on some of the other command line parameters to be set
19520 in a specific way to have a chance to communicate with
19527 \begin_layout Enumerate
19531 Command terminated with space.
19534 \begin_layout Enumerate
19537 Non-breaking space (
19538 \begin_inset Quotes eld
19546 \begin_inset Quotes erd
19549 ) should have been used.
19552 \begin_layout Enumerate
19556 You should enclose the previous parenthesis with
19557 \begin_inset Quotes eld
19565 \begin_inset Quotes erd
19571 \begin_layout Enumerate
19574 Italic correction (
19575 \begin_inset Quotes eld
19585 \begin_inset Quotes erd
19588 ) found in non-italic buffer.
19591 \begin_layout Enumerate
19594 Italic correction (
19595 \begin_inset Quotes eld
19605 \begin_inset Quotes erd
19608 ) found more than once.
19611 \begin_layout Enumerate
19615 No italic correction (
19616 \begin_inset Quotes eld
19626 \begin_inset Quotes erd
19632 \begin_layout Enumerate
19636 \begin_inset Quotes eld
19644 \begin_inset Quotes erd
19648 \begin_inset Quotes eld
19656 \begin_inset Quotes erd
19662 \begin_layout Enumerate
19665 Wrong length of dash may have been used.
19668 \begin_layout Enumerate
19672 \begin_inset Quotes eld
19680 \begin_inset Quotes erd
19684 \begin_inset Quotes eld
19692 \begin_inset Quotes erd
19698 \begin_layout Enumerate
19702 \begin_inset Quotes eld
19710 \begin_inset Quotes erd
19716 \begin_layout Enumerate
19720 \begin_inset Quotes eld
19728 \begin_inset Quotes erd
19731 to achieve an ellipsis.
19734 \begin_layout Enumerate
19737 Inter-word spacing (
19738 \begin_inset Quotes eld
19748 \begin_inset Quotes eld
19751 ) should perhaps be used.
19754 \begin_layout Enumerate
19757 Inter-sentence spacing (
19758 \begin_inset Quotes eld
19768 \begin_inset Quotes erd
19771 ) should perhaps be used.
19774 \begin_layout Enumerate
19777 Could not find argument for command.
19780 \begin_layout Enumerate
19784 \begin_inset Quotes eld
19792 \begin_inset Quotes erd
19798 \begin_layout Enumerate
19801 Math mode still on at end of \SpecialChar LaTeX
19805 \begin_layout Enumerate
19809 \begin_inset Quotes eld
19817 \begin_inset Quotes erd
19820 doesn't match the number of
19821 \begin_inset Quotes eld
19829 \begin_inset Quotes erd
19835 \begin_layout Enumerate
19838 You should use either
19841 \begin_inset Quotes eld
19849 \begin_inset Quotes erd
19854 as an alternative to
19855 \begin_inset Quotes eld
19863 \begin_inset Quotes erd
19869 \begin_layout Enumerate
19876 " (ASCII 39) instead of "
19883 \begin_layout Enumerate
19886 User-specified pattern found.
19889 \begin_layout Enumerate
19892 This command might not be intended.
19895 \begin_layout Enumerate
19902 \begin_layout Enumerate
19920 \begin_layout Enumerate
19923 Delete this space to maintain correct page references.
19926 \begin_layout Enumerate
19930 You might wish to put this between a pair of
19931 \begin_inset Quotes eld
19939 \begin_inset Quotes erd
19945 \begin_layout Enumerate
19948 You ought to remove spaces in front of punctuation.
19951 \begin_layout Enumerate
19954 Could not execute \SpecialChar LaTeX
19958 \begin_layout Enumerate
19967 in front of small punctuation.
19970 \begin_layout Enumerate
19978 may look prettier here.
19981 \begin_layout Enumerate
19985 Multiple spaces detected in output.
19988 \begin_layout Enumerate
19991 This text may be ignored.
19994 \begin_layout Enumerate
20000 \begin_inset Quotes eld
20005 to begin quotation, not
20012 \begin_layout Enumerate
20019 to end quotation, not
20022 \begin_inset Quotes eld
20030 \begin_layout Enumerate
20036 \begin_layout Enumerate
20039 You should perhaps use
20040 \begin_inset Quotes eld
20048 \begin_inset Quotes erd
20054 \begin_layout Enumerate
20057 You should put a space in front of/after parenthesis.
20060 \begin_layout Enumerate
20063 You should avoid spaces in front of/after parenthesis.
20066 \begin_layout Enumerate
20070 You should not use punctuation in front of/after quotes.
20073 \begin_layout Enumerate
20076 Double space found.
20079 \begin_layout Enumerate
20082 You should put punctuation outside inner/inside display math mode.
20085 \begin_layout Enumerate
20088 You ought to not use primitive \SpecialChar TeX
20089 in \SpecialChar LaTeX
20093 \begin_layout Enumerate
20096 You should remove spaces in front of
20097 \begin_inset Quotes eld
20105 \begin_inset Quotes erd
20111 \begin_layout Enumerate
20114 \begin_inset Quotes eld
20122 \begin_inset Quotes erd
20125 is normally not followed by
20126 \begin_inset Quotes eld
20134 \begin_inset Quotes erd
20140 \begin_layout Standard
20141 In later versions of \SpecialChar LyX
20142 , we hope to provide a more complete interface to this
20143 tool (and it's smaller cousin
20147 ) to exploit the full power of it.
20148 But it's not exactly useless as it is now: go try it on one of your existing
20149 documents of a certain length and be surprised.
20152 \begin_layout Section
20153 Version Control in \SpecialChar LyX
20157 \begin_layout Standard
20160 Lars Gullik Bjønnes
20167 \begin_layout Subsection
20171 \begin_layout Standard
20173 supports some of the most basic RCS/CVS/SVN/GIT commands.
20174 If you need something a bit more sophisticated you will have to do that
20175 manually in a terminal.
20178 \begin_layout Standard
20179 Also note that CVS support is not as good as subversion support, so we advise
20181 A good place to start learning Subversion is the SVN Book
20185 \begin_layout Plain Layout
20186 \begin_inset CommandInset href
20188 target "http://svnbook.red-bean.com/"
20199 In the case of RCS you should read
20200 \begin_inset Quotes eld
20204 \begin_inset Quotes erd
20207 (a man file, read it with
20212 This file describes all the basic features of RCS.
20213 You should especially notice the comment about a RCS directory, and the
20214 notion of a master RCS file (the file ending in
20221 \begin_layout Standard
20222 Before you begin to use the version control features in \SpecialChar LyX
20224 familiar with RCS/CVS/SVN/GIT usage.
20225 The implementation in \SpecialChar LyX
20226 assumes a recent version of the GNU RCS or CVS/SVN
20227 package — no guarantees are made for older versions.
20228 Most of the log messages are not currently displayed after operations —
20229 you can check them in the Messages pane if you are unsure.
20230 Regular users of version control will appreciate the VC toolbar, which
20233 View\SpecialChar menuseparator
20234 Toolbars\SpecialChar menuseparator
20236 \begin_inset space ~
20244 \begin_layout Standard
20245 For introducing your own external commands consult
20246 \begin_inset Flex Code
20249 \begin_layout Plain Layout
20263 \begin_layout Standard
20264 It is strongly recommended to store documents in uncompressed format if
20265 using version control (uncheck
20267 Document\SpecialChar menuseparator
20270 if it is checked): Uncompressed LyX documents are text files and therefore
20271 for merging two different versions by version control systems.
20272 Compressed LyX documents are binary files, which cannot be merged by version
20276 \begin_layout Subsection
20277 RCS commands in \SpecialChar LyX
20281 \begin_layout Standard
20282 The following sections describe the RCS commands supported by \SpecialChar LyX
20284 You can find them in the
20286 File\SpecialChar menuseparator
20288 \begin_inset space ~
20295 was tested against RCS 5.7/5.8.
20298 \begin_layout Subsubsection
20304 \begin_layout Standard
20305 If your document is not under revision control, this is the only item shown
20307 And if it is under revision control, the
20311 item is not visible.
20315 \begin_layout Standard
20316 This command registers your document with RCS (unless you are under the
20317 directory managed by CVS)\SpecialChar endofsentence
20318 You are asked interactively to supply an initial
20319 description of the document.
20320 The document is now set in Read-Only mode and you have to
20323 \begin_inset space ~
20327 \begin_inset space ~
20331 \begin_inset space ~
20336 , before making any changes to it.
20337 A document under revision control has a
20338 \begin_inset Quotes eld
20341 [RCS:<version> <locker>]
20342 \begin_inset Quotes erd
20345 item tagged to the filename in the minibuffer.
20348 \begin_layout Standard
20349 RCS command that is run:
20352 \begin_layout LyX-Code
20355 ci -q -u -i -t-"<initial description>" <file-name>
20358 \begin_layout Standard
20363 to understand the switches.
20367 \begin_layout Subsubsection
20373 \begin_layout Standard
20374 When you are finished editing a file, you check in your changes.
20375 When you do this, you are asked for a description of the changes.
20376 This is stored in the history log.
20377 The version number is bumped, your changes are applied to the master RCS
20378 file, the document is unlocked and set to Read-Only mode.
20381 \begin_layout Itemize
20384 ci -q -u -m"<description>" <file-name>
20387 \begin_layout Subsubsection
20393 \begin_layout Standard
20394 By doing this you lock the document so that only you can edit it.
20395 This will also make the document Read-Write only for you.
20396 You will usually continue editing for a while and when you are finished
20397 you check in your changes.
20398 The status line is changed to reflect that you have locked the file.
20401 \begin_layout Itemize
20404 co -q -l <file-name>
20407 \begin_layout Subsubsection
20410 Revert To Repository Version
20413 \begin_layout Standard
20414 This will discard all changes made to the document since the last check
20416 You get a warning before changes are discarded.
20419 \begin_layout Itemize
20422 co -f -u<version> <file-name>
20425 \begin_layout Subsubsection
20431 \begin_layout Standard
20432 This will create a copy of the current document.
20433 Since RCS does not support copy operations natively, the version history
20434 is not preserved, and the copy is added as a new file.
20435 It requires a clean document without any changes since the last checkin.
20436 You are asked for a file name and a description of the copy operation.
20437 After that the copy is created, both locally and in the repository.
20438 If the parent directories of the copied and original document differ, all
20439 relative paths of included files of the copy are adjusted (like in
20441 File\SpecialChar menuseparator
20446 Finally, the copy is loaded instead of the original document.
20449 \begin_layout Labeling
20450 \labelwidthstring 00.00.0000
20452 \begin_inset space ~
20456 \begin_inset space ~
20460 \begin_inset Newline newline
20464 \begin_inset Flex Code
20467 \begin_layout Plain Layout
20470 \begin_inset Quotes qld
20474 \begin_inset Quotes qld
20483 \begin_inset Flex Code
20486 \begin_layout Plain Layout
20489 \begin_inset Quotes qld
20493 \begin_inset Quotes qld
20502 \begin_inset Newline newline
20506 \begin_inset Flex Code
20509 \begin_layout Plain Layout
20513 \begin_inset Quotes qld
20517 \begin_inset Quotes qld
20528 \begin_layout Subsubsection
20534 \begin_layout Standard
20535 This makes as if the last check in never happened.
20536 No changes are made to the document loaded into \SpecialChar LyX
20537 , but the last version
20538 is removed from the master RCS file.
20541 \begin_layout Itemize
20544 rcs -o<version> <file-name>
20547 \begin_layout Subsubsection
20553 \begin_layout Standard
20554 This shows the complete history of the RCS document.
20559 is shown in a browser.
20567 \begin_layout Subsubsection
20571 \begin_layout Standard
20573 supports RCS version number, author name, date and time of last commit.
20574 All those are extracted from
20576 rlog -r <file-name>
20580 \begin_inset CommandInset ref
20582 reference "subsec:VCS-Revision-Information"
20589 \begin_layout Subsection
20590 CVS commands in \SpecialChar LyX
20594 \begin_layout Standard
20595 A subset of CVS operations is supported by \SpecialChar LyX
20597 You can find the commands in the
20599 File\SpecialChar menuseparator
20601 \begin_inset space ~
20607 The version control system SVN is more powerful, so please use it instead
20608 of CVS if possible.
20611 \begin_layout Subsubsection
20617 \begin_layout Standard
20618 If you start from scratch with CVS you have to create your repository and
20619 checkout the working copy with external tools.
20620 If you're using a client-server setup you may need to login before doing
20621 the first repository checkout.
20624 \begin_layout Standard
20625 If your documents are under revision control and others are using the same
20626 repository problems arise when different changes to the same document at
20627 the same location happen.
20628 Standard CVS repositories don't operate with a file locking mechanism.
20629 This may be surprising, but conflicts only occur if people disagree on
20630 the proper content of the same part of a document.
20631 So, if co-workers are used to communicate regularly, these conflicts occur
20633 If they don't communicate they have a fundamental problem anyway.
20634 Nevertheless some people like to work with so called
20635 \begin_inset Quotes eld
20639 \begin_inset Quotes erd
20643 If they do so the working copy of all files is readonly when checked out
20644 first and the user starts editing after using a special command to make
20645 the working copy writable.
20646 When the changes are checked in the working copy returns to readonly state.
20647 With \SpecialChar LyX
20648 one has to edit the
20649 \begin_inset Flex Code
20652 \begin_layout Plain Layout
20658 file and add the line
20659 \begin_inset Flex Code
20662 \begin_layout Plain Layout
20668 to work with reserved checkouts.
20669 The benefit is the possibility to see who is using a writable copy of some
20671 It's not guaranteed only one user makes a copy writable.
20674 \begin_layout Standard
20676 tries to guess if you're using reserved or non-reserved checkouts.
20677 If your working copy is readonly or it is writable and an additional copy
20678 of your document exists in the CVS/Base sub-directory a reserved otherwise
20679 a non-reserved checkout is assumed.
20680 When a reserved checkout is detected you have to use
20681 \begin_inset Flex Noun
20684 \begin_layout Plain Layout
20690 to make your working copy writable if it's readonly.
20692 \begin_inset Flex Noun
20695 \begin_layout Plain Layout
20701 operation is possible and that makes your working copy readonly again after
20702 transferring your changes to the repository.
20705 \begin_layout Standard
20706 More information about CVS can be found here
20707 \begin_inset Flex URL
20710 \begin_layout Plain Layout
20712 http://www.nongnu.org/cvs
20718 \begin_inset Flex URL
20721 \begin_layout Plain Layout
20723 http://ximbiot.com/cvs
20731 \begin_layout Standard
20736 to understand the sub-commands and the switches mentioned below.
20739 \begin_layout Subsubsection
20745 \begin_layout Standard
20746 If your document is not under revision control, this is the only item shown
20748 And if it is under revision control, the
20752 item is not visible.
20756 \begin_layout Standard
20757 This command registers in CVS your document
20758 \begin_inset Flex Strong
20761 \begin_layout Plain Layout
20769 in the case you have already the documents directory under CVS control
20775 This means you have to create or checkout the archive by yourself using
20777 (In case you forget that step \SpecialChar LyX
20778 registers the document with RCS.)
20781 \begin_layout Standard
20782 Then you are asked interactively to supply an initial description of the
20784 Don't forget that registered file is not yet checked in.
20787 \begin_layout Standard
20788 CVS command that is run:
20790 cvs -q add -m"<entered message>" "<file-name>"
20793 \begin_layout Standard
20798 above and for all other CVS commands is an abbreviation for
20799 \begin_inset Quotes eld
20802 change the current working directory to file location and use the file name
20803 without path component as argument
20804 \begin_inset Quotes erd
20810 \begin_layout Subsubsection
20816 \begin_layout Standard
20817 When you are finished editing a file, you commit your changes.
20818 When you do this and you had changed the document, you are asked for a
20819 description of the changes.
20820 After that changes are written to the repository.
20821 In case you didn't change the document and a reserved checkout is detected
20822 the reservation made on
20823 \begin_inset Flex Noun
20826 \begin_layout Plain Layout
20835 \begin_layout Labeling
20836 \labelwidthstring 00.00.0000
20838 \begin_inset space ~
20842 \begin_inset space ~
20846 \begin_inset Newline newline
20850 \begin_inset Flex Code
20853 \begin_layout Plain Layout
20856 -q commit -m"<description>" "<file-name>"
20862 \begin_inset Newline newline
20866 \begin_inset Flex Code
20869 \begin_layout Plain Layout
20880 \begin_layout Subsubsection
20886 \begin_layout Standard
20887 When you are sharing a repository with others, you may have to incorporate
20888 their changes into your working copy.
20891 \begin_layout Standard
20894 cvs -q update "<file-name>"
20897 \begin_layout Standard
20898 If a readonly checkout is detected the working copy is made writable and
20902 \begin_layout Standard
20905 cvs -q edit "<file-name>"
20908 \begin_layout Subsubsection
20911 Revert To Repository Version
20914 \begin_layout Standard
20915 This will discard all changes made to the document since the last check
20917 You get a warning before changes are discarded.
20918 Firstly the file is deleted, secondly CVS update command is run.
20921 \begin_layout Standard
20924 cvs -q update "<file-name>"
20927 \begin_layout Standard
20928 If a reserved checkout is detected and the working copy has no changes only
20929 the reservation is undone.
20932 \begin_layout Standard
20935 cvs -q unedit "<file-name>"
20938 \begin_layout Subsubsection
20944 \begin_layout Standard
20945 This will create a copy of the current document.
20946 Since CVS does not support copy operations natively, the version history
20947 is not preserved, and the copy is added as a new file.
20948 It requires a clean document without any changes since the last checkin.
20949 You are asked for a file name and a description of the copy operation.
20950 After that the copy is created, both locally and in the repository.
20951 If the parent directories of the copied and original document differ, all
20952 relative paths of included files of the copy are adjusted (like in
20954 File\SpecialChar menuseparator
20959 Finally, the copy is loaded instead of the original document.
20962 \begin_layout Labeling
20963 \labelwidthstring 00.00.0000
20965 \begin_inset space ~
20969 \begin_inset space ~
20973 \begin_inset Newline newline
20977 \begin_inset Flex Code
20980 \begin_layout Plain Layout
20987 \begin_inset Flex Code
20990 \begin_layout Plain Layout
20997 \begin_inset Newline newline
21001 \begin_inset Flex Code
21004 \begin_layout Plain Layout
21005 cvs -q add "<new-file-name>"
21013 \begin_layout Subsubsection
21019 \begin_layout Standard
21020 This will rename the current document.
21021 Since CVS does not support rename operations natively, the version history
21022 is not preserved, the renamed document is added as a new file, and the
21023 original document is deleted.
21024 It requires a clean document without any changes since the last checkin.
21025 You are asked for a file name and a description of the rename operation.
21026 After that the document is renamed, both locally and in the repository.
21027 If the parent directories of the new and old file names differ, all relative
21028 paths of included files are adjusted (like in
21030 File\SpecialChar menuseparator
21035 Finally, the document is reloaded using the new name.
21038 \begin_layout Labeling
21039 \labelwidthstring 00.00.0000
21041 \begin_inset space ~
21045 \begin_inset space ~
21049 \begin_inset Newline newline
21053 \begin_inset Flex Code
21056 \begin_layout Plain Layout
21063 \begin_inset Flex Code
21066 \begin_layout Plain Layout
21073 \begin_inset Newline newline
21077 \begin_inset Flex Code
21080 \begin_layout Plain Layout
21081 cvs -q add "<new-file-name>"
21087 \begin_inset Newline newline
21091 \begin_inset Flex Code
21094 \begin_layout Plain Layout
21095 cvs -q remove "<file-name>"
21103 \begin_layout Subsubsection
21104 Update of the local directory checkout from repository
21107 \begin_layout Standard
21108 Once your documents gets more complex, containing sub-documents and pictures,
21110 \begin_inset Flex Code
21113 \begin_layout Plain Layout
21119 files and so on using version control becomes more complicated.
21121 supports updating the whole tree in which resides the document.
21122 This become especially useful once you cooperate with people which neither
21123 have detailed knowledge about CVS usage nor they have ambition to commit
21124 additional material to the repository.
21125 You have to organize the files structure so that all external files are
21126 in the same directory or subdirectories of the document.
21127 It's good practice anyway to store multipart documents in an extra directory.
21130 \begin_layout Standard
21132 \begin_inset Flex Code
21135 \begin_layout Plain Layout
21136 Update local directory from repository
21141 command updates the whole directory.
21142 If local changes are detected user is warned before update starts.
21143 In case of merge conflicts both versions of the conflicting document parts
21144 are placed in the final document.
21145 You have to review and correct the result of the merge.
21146 You'll find the conflicts enclosed in pairs of
21147 \begin_inset Flex Code
21150 \begin_layout Plain Layout
21157 \begin_inset Flex Code
21160 \begin_layout Plain Layout
21167 \begin_inset Flex Code
21170 \begin_layout Plain Layout
21177 The first part is your version as before the update operation with the
21178 document name prepended.
21179 The second one is the repository version with the version number after
21181 \begin_inset Flex Code
21184 \begin_layout Plain Layout
21193 \begin_layout Labeling
21194 \labelwidthstring 00.00.0000
21196 \begin_inset space ~
21200 \begin_inset space ~
21204 \begin_inset Newline newline
21208 \begin_inset Flex Code
21211 \begin_layout Plain Layout
21219 (Ask if changes are detected.)
21220 \begin_inset Newline newline
21224 \begin_inset Flex Code
21227 \begin_layout Plain Layout
21228 cd $path; cvs -q update
21238 \begin_layout Standard
21240 \begin_inset Flex Code
21243 \begin_layout Plain Layout
21249 stands for the path to the document.
21252 \begin_layout Subsubsection
21258 \begin_layout Standard
21259 This shows the complete history of the CVS document.
21262 cvs log "<file-name>"
21264 is shown in a browser.
21267 \begin_layout Subsubsection
21271 \begin_layout Standard
21273 supports CVS version number, author name, date and time of last commit.
21274 All those are extracted from
21276 cvs log -r <file-name>
21280 \begin_inset CommandInset ref
21282 reference "subsec:VCS-Revision-Information"
21289 \begin_layout Subsection
21290 SVN commands in \SpecialChar LyX
21294 \begin_layout Standard
21295 SVN is now partially supported by \SpecialChar LyX
21297 You can find the commands in the
21299 File\SpecialChar menuseparator
21301 \begin_inset space ~
21307 Please note that if you use password protected access to repository via
21308 ssh, you will be asked in terminal window.
21310 was tested against SVN 1.5, 1.6, 1.7 and 1.8
21314 \begin_layout Plain Layout
21315 Most of the commands will work with 1.4 too, see
21316 \begin_inset CommandInset ref
21318 reference "subsec:SVN-Repo-Update"
21323 There seems to be currently unresolved permissions problem under SVN 1.8
21324 with reverting changes when file is locked.
21332 \begin_layout Subsubsection
21338 \begin_layout Standard
21339 If your document is not under revision control, this is the only item shown
21341 And if it is under revision control, the
21345 item is not visible.
21348 \begin_layout Standard
21349 This command registers in SVN your document ONLY in case you have already
21350 the documents directory under SVN control (in particular
21355 This means you have to checkout the archive by yourself.
21358 \begin_layout Standard
21359 Then you are asked interactively to supply an initial description of the
21361 Don't forget that registered file is not yet commited.
21364 \begin_layout Standard
21365 SVN command that is run:
21368 \begin_inset Quotes qld
21372 \begin_inset Quotes qld
21378 \begin_layout Standard
21383 to understand the switches.
21386 \begin_layout Subsubsection
21392 \begin_layout Standard
21393 When you are finished editing a file, you commit your changes.
21394 When you do this, you are asked for a description of the changes.
21395 After that changes are commited.
21398 \begin_layout Standard
21403 \begin_layout Plain Layout
21404 In case locking is not enabled.
21406 \begin_inset CommandInset ref
21408 reference "subsec:SVN-File-Locking"
21419 svn commit -q -m"<description>" <file-name>
21422 \begin_layout Subsubsection
21428 \begin_layout Standard
21429 Updates the changes of this file from the repository.
21430 Be sure you understand SVN merging and conflicts resolving before using
21431 this function, because all conflicts has to be resolved manually by you!
21434 \begin_layout Standard
21439 \begin_layout Plain Layout
21447 svn update --non-interactive
21448 \begin_inset Quotes qld
21452 \begin_inset Quotes qld
21458 \begin_layout Subsubsection
21461 Revert To Repository Version
21464 \begin_layout Standard
21465 This will discard all changes made to the document since the last check
21467 You get a warning before changes are discarded.
21470 \begin_layout Standard
21474 \begin_inset Quotes qld
21478 \begin_inset Quotes qld
21484 \begin_layout Subsubsection
21490 \begin_layout Standard
21491 This will create a copy of the current document including the version history.
21492 It requires a clean document without any changes since the last checkin.
21493 You are asked for a file name and a description of the copy operation.
21494 After that the copy is created, both locally and in the repository.
21495 If the parent directories of the copied and original document differ, all
21496 relative paths of included files of the copy are adjusted (like in
21498 File\SpecialChar menuseparator
21503 Finally, the copy is loaded instead of the original document.
21506 \begin_layout Labeling
21507 \labelwidthstring 00.00.0000
21509 \begin_inset space ~
21513 \begin_inset space ~
21517 \begin_inset Newline newline
21521 \begin_inset Flex Code
21524 \begin_layout Plain Layout
21528 \begin_inset Quotes qld
21532 \begin_inset Quotes qld
21536 \begin_inset Quotes qld
21540 \begin_inset Quotes qld
21549 \begin_inset Newline newline
21553 \begin_inset Flex Code
21556 \begin_layout Plain Layout
21565 \begin_layout Subsubsection
21571 \begin_layout Standard
21572 This will rename the current document including the version history.
21573 It requires a clean document without any changes since the last checkin.
21574 You are asked for a file name and a description of the rename operation.
21575 After that the document is renamed, both locally and in the repository.
21576 If the parent directories of the new and old file names differ, all relative
21577 paths of included files are adjusted (like in
21579 File\SpecialChar menuseparator
21584 Finally, the document is reloaded using the new name.
21587 \begin_layout Labeling
21588 \labelwidthstring 00.00.0000
21590 \begin_inset space ~
21594 \begin_inset space ~
21598 \begin_inset Newline newline
21602 \begin_inset Flex Code
21605 \begin_layout Plain Layout
21609 \begin_inset Quotes qld
21613 \begin_inset Quotes qld
21617 \begin_inset Quotes qld
21621 \begin_inset Quotes qld
21630 \begin_inset Newline newline
21634 \begin_inset Flex Code
21637 \begin_layout Plain Layout
21646 \begin_layout Subsubsection
21647 \begin_inset CommandInset label
21649 name "subsec:SVN-Repo-Update"
21653 Update of the local directory checkout from repository
21657 \begin_layout Plain Layout
21658 Note that this command will work only with subversion
21659 \begin_inset Formula $\geqq1.5$
21670 \begin_layout Standard
21671 All the commands above have one shortcoming – they deal with the current
21673 Once your document contains pictures, includes external
21674 \begin_inset Flex Code
21677 \begin_layout Plain Layout
21683 files and so on administration becomes more complicated.
21685 now supports updating the whole tree in which resides the document
21689 \begin_layout Plain Layout
21690 One need to organize the files structure so that all external files are
21691 in the same directory or subdirectories of the document.
21698 This become especially useful once you cooperate with people which neither
21699 know about subversion management nor they have ambition to commit additional
21700 material to the repository.
21704 \begin_layout Standard
21705 \begin_inset Flex Code
21708 \begin_layout Plain Layout
21709 Update local directory from repository
21714 command updates the whole directory and in case of merge conflicts local
21715 version of the files are left, so no unintended data loss occurs.
21716 If local changes are detected user is warned before update starts.
21719 \begin_layout Labeling
21720 \labelwidthstring 00.00.0000
21722 \begin_inset space ~
21726 \begin_inset space ~
21730 \begin_inset Newline newline
21734 \begin_inset Flex Code
21737 \begin_layout Plain Layout
21743 (Ask if changes are detected.)
21744 \begin_inset Newline newline
21748 \begin_inset Flex Code
21751 \begin_layout Plain Layout
21752 svn update --accept mine-full $path
21760 \begin_layout Standard
21762 \begin_inset Flex Code
21765 \begin_layout Plain Layout
21771 stands for the path to the document.
21774 \begin_layout Subsubsection
21780 \begin_layout Standard
21781 This shows the complete history of the SVN document.
21785 \begin_inset Quotes qld
21789 \begin_inset Quotes qld
21794 is shown in a browser.
21797 \begin_layout Subsubsection
21799 \begin_inset CommandInset label
21801 name "subsec:SVN-File-Locking"
21808 \begin_layout Standard
21809 The file exchange through various revision control systems brings the problem
21810 of merge conflicts in case two different users try to edit the same (parts
21812 When such a conflict happens it needs manual resolving and one reasonable
21813 alternative is to provide some kind of locking mechanism, which guarantees
21814 that only one user is allowed to edit file at the given time.
21817 \begin_layout Standard
21818 SVN has two such mechanisms to provide mutual exclusivity for file access
21819 – locks and automatic setting of write permissions (see sec.
21821 \begin_inset CommandInset ref
21823 reference "subsec:Automatical-Locking-Property"
21828 \begin_inset Flex Code
21831 \begin_layout Plain Layout
21841 \begin_layout Plain Layout
21842 \begin_inset Flex URL
21845 \begin_layout Plain Layout
21847 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
21858 If this property is detected for a given document \SpecialChar LyX
21859 starts to use SVN locks
21860 for document editing automatically and the whole check-in/out mechanism
21861 switches to the same regimen as for RCS.
21862 This in particular means there are two different modes of file use in \SpecialChar LyX
21866 \begin_layout Itemize
21868 The loaded file is in the read-only mode.
21869 For editing on needs to check-out.
21874 consists of updating from the repository and gaining write lock.
21875 If the lock is not possible to obtain, we remain in unlocked state.
21878 \begin_layout Itemize
21880 The loaded file is in the
21881 \begin_inset Quotes els
21885 \begin_inset Quotes ers
21889 No other user is allowed to edit the file.
21894 consists of commiting changes and releasing write-lock.
21895 If no changes have been made to the document, no commit will be produced
21899 \begin_layout Plain Layout
21900 Don't be puzzled by the fact that you will be asked for commit message anyway.
21905 and only the write-lock will be released.
21908 \begin_layout Standard
21912 \begin_layout Labeling
21913 \labelwidthstring 00.00.0000
21916 svn commit -q -m"<description>" "<file-name>"
21917 \begin_inset Newline newline
21920 svn unlock "<file-name>"
21923 \begin_layout Labeling
21924 \labelwidthstring 00.00.0000
21927 svn update "<file-name>"
21928 \begin_inset Newline newline
21931 svn lock "<file-name>"
21934 \begin_layout Subsubsection
21937 \begin_inset CommandInset label
21939 name "subsec:Automatical-Locking-Property"
21945 Automatic Locking Property
21948 \begin_layout Standard
21949 The above mentioned automatic setting of write permissions of the .lyx file
21952 File\SpecialChar menuseparator
21954 \begin_inset space ~
21957 Control\SpecialChar menuseparator
21958 Use Locking Property
21961 This command is active only when the file is not locked on the svn server
21963 you need to check-out before proceeding).
21966 \begin_layout Labeling
21967 \labelwidthstring 00.00.0000
21969 \begin_inset space ~
21975 \begin_layout Labeling
21976 \labelwidthstring 00.00.0000
21979 svn propset svn:needs-lock ON "<file-name>"
21982 \begin_layout Labeling
21983 \labelwidthstring 00.00.0000
21986 svn propdel svn:needs-lock "<file-name>"
21989 \begin_layout Subsubsection
21990 \begin_inset CommandInset label
21992 name "subsec:VCS-Revision-Information"
21996 Revision Information in Documents
21999 \begin_layout Standard
22000 There are more possibilities how to activate revision information in our
22004 \begin_layout Itemize
22010 \begin_layout Itemize
22011 tree revision information (
22012 \begin_inset Flex Code
22015 \begin_layout Plain Layout
22022 The result is the output of the
22023 \begin_inset Flex Code
22026 \begin_layout Plain Layout
22032 command, the following table gives you an idea, how to read the results.
22035 \begin_layout Standard
22037 \begin_inset Tabular
22038 <lyxtabular version="3" rows="6" columns="2">
22039 <features tabularvalignment="middle">
22040 <column alignment="left" valignment="top">
22041 <column alignment="left" valignment="top">
22043 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22046 \begin_layout Plain Layout
22054 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22057 \begin_layout Plain Layout
22067 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22070 \begin_layout Plain Layout
22076 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22079 \begin_layout Plain Layout
22080 mixed revision working copy
22087 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22090 \begin_layout Plain Layout
22096 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22099 \begin_layout Plain Layout
22100 modified working copy
22107 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22110 \begin_layout Plain Layout
22116 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22119 \begin_layout Plain Layout
22120 switched working copy
22127 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
22130 \begin_layout Plain Layout
22136 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
22139 \begin_layout Plain Layout
22140 partial working copy, from a sparse checkout
22147 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
22150 \begin_layout Plain Layout
22156 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
22159 \begin_layout Plain Layout
22160 mixed revision, modified, switched working copy
22173 \begin_layout Itemize
22174 file revision information.
22175 The result comes from parsing the output of
22176 \begin_inset Flex Code
22179 \begin_layout Plain Layout
22181 \begin_inset space ~
22185 \begin_inset space ~
22189 \begin_inset space ~
22198 Supported flags are:
22202 \begin_layout Itemize
22203 version number of the last commit (
22204 \begin_inset Flex Code
22207 \begin_layout Plain Layout
22216 \begin_layout Itemize
22217 author of the last commit (
22218 \begin_inset Flex Code
22221 \begin_layout Plain Layout
22230 \begin_layout Itemize
22231 date of the last commit (
22232 \begin_inset Flex Code
22235 \begin_layout Plain Layout
22244 \begin_layout Itemize
22245 time of the last commit (
22246 \begin_inset Flex Code
22249 \begin_layout Plain Layout
22259 \begin_layout Standard
22260 You can obtain this info via InsetInfo (
22261 \change_inserted 5863208 1564400022
22264 Insert\SpecialChar menuseparator
22265 Field\SpecialChar menuseparator
22266 Version Control Revision
22267 \change_deleted 5863208 1564399852
22272 \begin_inset Flex Code
22275 \begin_layout Plain Layout
22276 info-insert buffer vcs-date
22284 The information will be available only when you have the file stored under
22285 svn managment (i.e.
22287 \begin_inset Flex Code
22290 \begin_layout Plain Layout
22296 directory is available with your document).
22300 \begin_layout Itemize
22301 Another—a hacking one—possibility is to use svn keywords
22305 \begin_layout Plain Layout
22306 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
22312 In short – you set file keywords property (e.g.
22315 svn propset svn:keywords 'Rev' file.lyx
22317 ) and then paste keyword \SpecialChar TeX
22322 \begin_layout Plain Layout
22323 This is an easy way how to ensure that \SpecialChar LyX
22324 won't break the line in the middle
22330 tag in your document (e.g.
22332 \begin_inset Flex Code
22335 \begin_layout Plain Layout
22342 This way svn client will automatically substitute revision number (e.g.
22344 \begin_inset Flex Code
22347 \begin_layout Plain Layout
22353 ) after each update and commit.
22354 There are more problems with this approach.
22355 Firstly, the '$' character is used in \SpecialChar TeX
22356 world for math equations, so any
22357 occurence of math formula
22358 \begin_inset Formula $Rev$
22362 \begin_inset Formula $Rev:59$
22365 in your \SpecialChar LyX
22367 Similarly for other keywords like Id, Date, Author, etc.
22368 Secondly svn output is dependent on your locales, so its very easy that
22369 svn would produce some problematic strings once Date is used.
22370 Thirdly you get the whole 'Rev: 59' string in your document instead of
22372 Until subversion implements user's custom keywords it will be hard to use
22373 this approach reliably or let \SpecialChar LyX
22374 to support it directly.
22377 \begin_layout Subsection
22378 SVN and Windows Environment
22381 \begin_layout Quote
22382 My inclination is to say that if the user cannot figure out the command
22383 line operations on their own fairly quickly, they would be well advised
22384 to use TortoiseSVN.
22390 \begin_layout Subsubsection
22394 \begin_layout Standard
22395 In addition to installing \SpecialChar LyX
22396 , and having access to a Subversion repository,
22397 the user will need to install the Subversion client program.
22398 A Windows installer for the client program is available from
22399 \begin_inset CommandInset href
22402 target "http://www.collab.net/nonav/downloads/subversion/"
22408 The user may also want to install
22409 \begin_inset CommandInset href
22412 target "http://tortoisesvn.tigris.org/"
22417 , which integrates Subversion operations into the context (rightclick) menu
22418 of Windows Explorer.
22419 Operations done outside \SpecialChar LyX
22420 will typically be more convenient using the Explorer
22422 Note that TortoiseSVN is not a replacement for the client program, which
22423 is what \SpecialChar LyX
22427 \begin_layout Subsubsection
22428 Bringing a document under Subversion control
22431 \begin_layout Standard
22432 Before a \SpecialChar LyX
22433 document can be brought under version control in Subversion, its
22434 parent directory needs to be under version control.
22435 If the document is being added to a project already in the repository,
22436 this is accomplished by checking the project out to the directory where
22437 the new document will be placed.
22438 If the project itself is not yet under version control (for instance, if
22439 this document starts a new project), the directory must be imported into
22441 This is done outside \SpecialChar LyX
22443 Both import and checkout are easily accomplished from the Explorer context
22444 menu using TortoiseSVN, or alternatively can be done using the command
22445 line client at a DOS prompt.
22446 The procedure for importing the project using TortoiseSVN is described
22447 below, assuming an existing repository and a new project being started
22455 For information on using the Subversion client program, run
22462 \begin_layout Enumerate
22469 in Windows Explorer, right click it, and select
22471 TortoiseSVN\SpecialChar menuseparator
22475 If necessary, adjust the URL for the repository, then click OK.
22478 \begin_layout Enumerate
22479 Right click the level of the repository under which you want to place the
22480 new project folder (typically the top level) and click
22484 Supply a name for the project folder and click OK.
22485 Add a message for the log file if desired, then click OK again.
22486 The new project folder should appear in the repository.
22487 Finally, click OK again to exit the repository browser.
22490 \begin_layout Enumerate
22491 Once again right click
22497 , this time selecting SVN Checkout\SpecialChar ldots
22498 Select the URL of the project folder
22499 you just created in the repository, and set the checkout directory to
22507 You will be warned about a non-empty folder; click OK to proceed.
22508 You should now have a
22519 \begin_layout Enumerate
22520 Create or open your document in \SpecialChar LyX
22523 File\SpecialChar menuseparator
22525 \begin_inset space ~
22528 Control\SpecialChar menuseparator
22532 Add a log message and click OK to commit the document to version control.
22535 \begin_layout Standard
22536 From this point onward, you should have full functionality in the
22538 File\SpecialChar menuseparator
22540 \begin_inset space ~
22546 You also have the option of checking the document in and out, viewing its
22548 using the TortoiseSVN context menu in Windows Explorer or the Subversion
22549 client program from a command prompt.
22552 \begin_layout Subsubsection
22553 SSH tunnel used with SVN under Windows
22556 \begin_layout Standard
22557 Compared with Linux setting up an svn client to communicate over ssh under
22558 Windows is a rather troublesome task.
22559 We will at least offer some hints how to setup the client side but prior
22560 knowledge about ssh and the Windows command line is needed, also be prepared
22561 for a great deal of frustration\SpecialChar ldots
22565 \begin_layout Enumerate
22566 Get an svn client for windows, as described in the previous sections.
22567 When it is a fresh install run some svn command (e.g.
22569 \begin_inset Flex Code
22572 \begin_layout Plain Layout
22578 ) to create config files, which you will need to change later on.
22581 \begin_layout Enumerate
22582 Choose an ssh client for Windows.
22583 There are several possibilities, we will use the one from Putty tools
22587 \begin_layout Plain Layout
22588 \begin_inset Flex URL
22591 \begin_layout Plain Layout
22593 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
22604 You will need to set the connection up so that the client doesn't ask for
22605 any password from you.
22606 To keep things easy we will use only keys without any additional password
22611 \begin_layout Enumerate
22613 \begin_inset Flex Code
22616 \begin_layout Plain Layout
22623 Save your private .ppk key file and put the public one on the server side.
22624 If the SVN server runs on Linux, note that the format of the public key
22625 is not compatible with Linux openssh and you will need to direcly copy-paste
22627 \begin_inset Quotes eld
22632 Public key for pasting into OpenSSH authorized_keys file
22635 \begin_inset Quotes erd
22638 edit field into the server's
22639 \begin_inset Flex Code
22642 \begin_layout Plain Layout
22643 ~/.ssh/authorized_keys
22649 \begin_inset Flex Code
22652 \begin_layout Plain Layout
22661 \begin_layout Enumerate
22663 \begin_inset Flex Code
22666 \begin_layout Plain Layout
22673 In the SVN config file
22677 \begin_layout Plain Layout
22678 Exact path depends on Windows version, usually somewhere around
22679 \begin_inset Flex Code
22682 \begin_layout Plain Layout
22685 Documents and Settings
22699 \begin_inset Flex Code
22702 \begin_layout Plain Layout
22717 , section [tunnels], setup ssh command, e.g.
22719 \begin_inset Flex Code
22722 \begin_layout Plain Layout
22723 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
22732 \begin_layout Plain Layout
22733 It will usually take a lot of time to get exact command right and it depends
22735 For example do not have some remote server saved as a default session in
22737 If things fail, try to connect via plink without SVN first.
22746 \begin_layout Enumerate
22747 Checkout the SVN archive, e.
22748 \begin_inset space \thinspace{}
22752 \begin_inset Newline newline
22756 \begin_inset Flex Code
22759 \begin_layout Plain Layout
22760 svn co svn+ssh://user@server/repository_path
22768 \begin_layout Subsubsection
22769 End-of-Line Conversions
22772 \begin_layout Standard
22773 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
22775 use different line endings inside the .lyx files.
22776 This is not a problem as far as \SpecialChar LyX
22777 functionality is concerned, but the commit
22778 diffs will be huge and merge-conflicts prone.
22779 Fortunately SVN itself knows
22783 \begin_layout Plain Layout
22784 \begin_inset Flex URL
22787 \begin_layout Plain Layout
22789 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
22799 how to deal with CR/LF problems when switching .lyx files to the
22800 \begin_inset Flex Code
22803 \begin_layout Plain Layout
22813 \begin_layout Plain Layout
22815 \begin_inset Flex Code
22818 \begin_layout Plain Layout
22819 svn propset svn:eol-style native FILE_NAME
22832 \begin_layout Subsection
22833 GIT commands in \SpecialChar LyX
22837 \begin_layout Standard
22838 A minimal subset of GIT commands is now supported by \SpecialChar LyX
22840 You can find the commands in the
22842 File\SpecialChar menuseparator
22844 \begin_inset space ~
22850 Please note that if you use password protected access to repository via
22851 ssh, you will be asked in terminal window.
22853 was tested against GIT 1.7.
22857 \begin_layout Plain Layout
22858 Windows users please note that you need to ensure that git is on the path.
22859 This can be set from within \SpecialChar LyX
22862 Tools\SpecialChar menuseparator
22863 Preferences\SpecialChar menuseparator
22864 Paths\SpecialChar menuseparator
22875 \begin_layout Standard
22876 One big difference of GIT and the other supported version control systems
22877 is the distributed nature of GIT: With traditional version control systems
22878 there is one central server which hosts the repository.
22879 Users commit their changes to the server, and get updates made by other
22881 With GIT, users commit to a local repository.
22882 The local repository can be synchronized with one or more remote repositories
22884 \begin_inset Flex Code
22887 \begin_layout Plain Layout
22894 \begin_inset Flex Code
22897 \begin_layout Plain Layout
22905 does not interact in any way with remote GIT repositories.
22906 It works exclusively with the local repository in a very similar way as
22907 with a central CVS or SVN repository.
22908 If you use remote GIT repositories you need to do the
22909 \begin_inset Flex Code
22912 \begin_layout Plain Layout
22919 \begin_inset Flex Code
22922 \begin_layout Plain Layout
22928 operations with your favourite GIT client.
22931 \begin_layout Subsubsection
22937 \begin_layout Standard
22938 If your document is not under revision control, this is the only item shown
22940 And if it is under revision control, the
22944 item is not visible.
22947 \begin_layout Standard
22948 This command registers in GIT your document ONLY in case you have already
22949 the documents directory under GIT control (in particular
22954 This means you have to checkout the archive by yourself.
22957 \begin_layout Standard
22958 Then you are asked interactively to supply an initial description of the
22960 Don't forget that registered file is not yet committed.
22963 \begin_layout Standard
22964 GIT command that is run:
22967 \begin_inset Quotes qld
22971 \begin_inset Quotes qld
22977 \begin_layout Standard
22982 to understand the switches.
22985 \begin_layout Subsubsection
22991 \begin_layout Standard
22992 When you are finished editing a file, you commit your changes.
22993 When you do this, you are asked for a description of the changes.
22994 After that changes are committed.
22997 \begin_layout Standard
23000 git commit -q -m"<description>" <file-name>
23003 \begin_layout Subsubsection
23006 Revert To Repository Version
23009 \begin_layout Standard
23010 This will discard all changes made to the document since the last check
23012 You get a warning before changes are discarded.
23015 \begin_layout Standard
23019 \begin_inset Quotes qld
23023 \begin_inset Quotes qld
23029 \begin_layout Subsubsection
23035 \begin_layout Standard
23036 This will rename the current document including the version history.
23037 It requires a clean document without any changes since the last checkin.
23038 You are asked for a file name and a description of the rename operation.
23039 After that the document is renamed, both locally and in the repository.
23040 If the parent directories of the new and old file names differ, all relative
23041 paths of included files are adjusted (like in
23043 File\SpecialChar menuseparator
23048 Finally, the document is reloaded using the new name.
23051 \begin_layout Labeling
23052 \labelwidthstring 00.00.0000
23054 \begin_inset space ~
23058 \begin_inset space ~
23062 \begin_inset Newline newline
23066 \begin_inset Flex Code
23069 \begin_layout Plain Layout
23073 \begin_inset Quotes qld
23077 \begin_inset Quotes qld
23081 \begin_inset Quotes qld
23085 \begin_inset Quotes qld
23094 \begin_inset Newline newline
23098 \begin_inset Flex Code
23101 \begin_layout Plain Layout
23110 \begin_layout Subsubsection
23116 \begin_layout Standard
23117 This shows the complete history of the GIT document.
23121 \begin_inset Quotes qld
23125 \begin_inset Quotes qld
23130 is shown in a browser.
23133 \begin_layout Subsubsection
23137 \begin_layout Standard
23139 supports GIT hash number of the last commit to the file,
23140 \change_inserted 1119979965 1564297456
23141 its abbreviated form,
23143 author name, date and time of last commit.
23144 All those are extracted from
23146 git log -n 1 --pretty=format:%H%n
23147 \change_inserted 1119979965 1564297427
23153 Tree version information is obtained via
23155 git describe --abbrev --dirty --long
23159 \begin_inset CommandInset ref
23161 reference "subsec:VCS-Revision-Information"
23168 \begin_layout Subsection
23172 \begin_layout Standard
23173 With the recent addition of the
23174 \begin_inset Flex Code
23177 \begin_layout Plain Layout
23183 function \SpecialChar LyX
23184 power users are allowed to create their own commands for revision
23188 \begin_layout Standard
23189 As an example you can see how two TortoiseSVN commands could be integrated
23193 \begin_layout Description
23195 \begin_inset Flex Code
23198 \begin_layout Plain Layout
23199 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
23207 \begin_layout Description
23209 \begin_inset Flex Code
23212 \begin_layout Plain Layout
23213 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
23221 \begin_layout Subsection
23222 Version control and Document comparison
23225 \begin_layout Standard
23226 One of the typical uses of version control is to inspect the changes between
23227 revisions, usually by creating
23228 \begin_inset Flex Code
23231 \begin_layout Plain Layout
23238 While this is useful for plain text files, it is much less useful in the
23239 case of \SpecialChar LyX
23240 files, which have more a complicated structure.
23241 Hence we provide binding to the Document comparison feature.
23242 There are two ways of calling this feature – either by direct call of
23243 \begin_inset Flex Code
23246 \begin_layout Plain Layout
23253 function (for details see \SpecialChar LyX
23254 functions manual) or by the toolbar icon
23267 One can either compare two chosen revisions of the document or he can simply
23268 compare the current version of edited text with older revisions (where
23270 \begin_inset Flex Noun
23273 \begin_layout Plain Layout
23279 ' revisions back means comparison of the edited file with last commited
23284 \begin_layout Standard
23285 This feature is supported for SVN and RCS though due to the more complicated
23286 versioning scheme of RCS there is a constraint – when addressing the revisions
23287 in dialog, numbers always point to the last number in RCS revision number,
23290 We don't currently support GIT addressing of revisions, one can just compare
23291 edited document with its revision X steps backs, where X is addressed as
23293 \begin_inset Flex Code
23296 \begin_layout Plain Layout
23305 \begin_layout Section
23306 Literate Programming
23309 \begin_layout Standard
23314 (kayvan@sylvan.com)
23318 original documentation written by
23320 Edmar Wienskoski Jr.
23323 (edmar-w-jr@technologist.com)
23326 \begin_layout Subsection
23330 \begin_layout Standard
23331 The main purpose of this documentation is to show you how to use \SpecialChar LyX
23333 programming, where it is assumed that you are familiar with this programming
23334 technique, and know what
23335 \begin_inset Quotes eld
23339 \begin_inset Quotes erd
23343 \begin_inset Quotes eld
23347 \begin_inset Quotes erd
23351 If that is not the case, please follow the web links provided in the following
23353 There is a lot of good documentation out there covering old development
23354 history to the latest tools tips.
23357 \begin_layout Standard
23358 It is also assumed that you are familiar with \SpecialChar LyX
23359 itself to a point that you
23360 are comfortable changing your \SpecialChar LyX
23361 preferences, and X resources file.
23362 If that is not the case please refer to other \SpecialChar LyX
23363 documentation to cover your
23367 \begin_layout Subsection
23368 Literate Programming
23371 \begin_layout Standard
23372 From the Literate Programming FAQ:
23375 \begin_layout Quotation
23376 Literate programming is the combination of documentation and source together
23377 in a fashion suited for reading by human beings.
23378 In fact, literate programs should be enjoyable reading, even inviting!
23379 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
23380 and documentation in a single file.
23381 Literate programming tools then parse the file to produce either readable
23382 documentation or compilable source.
23383 The WEB style of literate programming was created by D.
23384 \begin_inset space \thinspace{}
23388 Knuth during the development of his \SpecialChar TeX
23389 typesetting software.
23393 \begin_layout Standard
23394 Another excerpt says:
23397 \begin_layout Quotation
23400 How is literate programming different from verbose commenting?
23403 \begin_layout Quotation
23404 There are three distinguishing characteristics.
23405 In order of importance, they are:
23409 \begin_layout Itemize
23410 flexible order of elaboration
23413 \begin_layout Itemize
23414 automatic support for browsing
23417 \begin_layout Itemize
23418 typeset documentation, especially diagrams and mathematics
23422 \begin_layout Standard
23423 Now that I sparked your curiosity, take a look in the references.
23426 \begin_layout Subsubsection
23430 \begin_layout Standard
23431 The complete Literate Programming FAQ can be found at:
23434 \begin_layout Quote
23435 Literate Programming FAQ
23436 \begin_inset Flex URL
23439 \begin_layout Plain Layout
23441 http://www.literateprogramming.com/lpfaq.pdf
23449 \begin_layout Standard
23450 The FAQ lists 23 (twenty three!) different literate programming tools.
23451 Where some are specialized or
23452 \begin_inset Quotes eld
23456 \begin_inset Quotes erd
23459 for particular programming languages, while other have general scope.
23464 for my own use for several reasons:
23467 \begin_layout Itemize
23468 It can generate the documentation either in \SpecialChar LaTeX
23472 \begin_layout Itemize
23473 It has a open architecture, i.
23474 \begin_inset space \thinspace{}
23478 \begin_inset space \space{}
23481 it is easy to plug in new filters
23485 \begin_layout Plain Layout
23490 are programs that read a given data stream and output a manipulated data
23492 That way, a WEB file (consisting of literate code) can be turned into a
23493 file consisting only of C program code or \SpecialChar LaTeX
23499 and to perform special processing that you may need.
23503 \begin_layout Itemize
23504 There is a good selection of filters available already (the HTML is one
23508 \begin_layout Itemize
23512 \begin_layout Standard
23513 The Noweb web page can be found at:
23516 \begin_layout Quote
23518 \begin_inset Flex URL
23521 \begin_layout Plain Layout
23523 https://www.cs.tufts.edu/~nr/noweb/
23531 \begin_layout Standard
23532 Starting from there you can reach many other interesting links and even
23533 some literate program examples.
23536 \begin_layout Subsection
23538 and Literate Programming with Noweb
23541 \begin_layout Standard
23542 The \SpecialChar LyX
23543 support for Literate Programming is provided by using the generic \SpecialChar LyX
23545 converters mechanism.
23546 This support is provided in a
23547 \begin_inset Quotes eld
23551 \begin_inset Quotes erd
23555 \begin_inset space \thinspace{}
23559 \begin_inset space \space{}
23562 you will be able to use this new \SpecialChar LyX
23563 feature with some other literate programming
23564 tool of your choice by just changing your \SpecialChar LyX
23568 \begin_layout Subsubsection
23569 Generating documents and code (weaving and tangling)
23572 \begin_layout Paragraph
23573 Using the noweb module
23576 \begin_layout Standard
23577 If you have installed Noweb and \SpecialChar LyX
23578 successfully, whenever you open a new document,
23579 after you have chosen its document class, use the
23581 Document\SpecialChar menuseparator
23585 \begin_inset Quotes eld
23589 \begin_inset Quotes erd
23593 If Noweb is correctly installed, when you click on the
23594 \begin_inset Quotes eld
23598 \begin_inset Quotes erd
23601 link, you will see the
23602 \begin_inset Quotes eld
23606 \begin_inset Quotes erd
23609 module in the available list and you can add it to your document.
23612 \begin_layout Paragraph
23616 \begin_layout Standard
23618 enables you to write code with a custom inset named
23619 \begin_inset Flex Noun
23622 \begin_layout Plain Layout
23629 Noweb delimits chunks like this:
23632 \begin_layout LyX-Code
23636 \begin_layout LyX-Code
23640 \begin_layout LyX-Code
23644 \begin_layout LyX-Code
23648 \begin_layout LyX-Code
23652 \begin_layout Standard
23653 The problem is that whatever is written in between the << and the
23657 must be taken literally, i.
23658 \begin_inset space \thinspace{}
23662 \begin_inset space \space{}
23666 should be prevented from making any special interpretation of what has
23668 This is also handled by
23669 \begin_inset Flex Noun
23672 \begin_layout Plain Layout
23678 , that works like a normal text inset but has a free spacing capability.
23681 \begin_layout Standard
23682 As a special note, you can also use the
23683 \begin_inset Quotes eld
23687 \begin_inset Quotes erd
23690 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
23694 \begin_layout LyX-Code
23698 \begin_layout LyX-Code
23699 def some_function(args):
23702 \begin_layout LyX-Code
23703 "This is the doc string for this function."
23706 \begin_layout LyX-Code
23707 print "My args: ", args
23710 \begin_layout LyX-Code
23711 @ %def some_function
23714 \begin_layout Standard
23715 For an example of this usage and the resulting cross-reference output, look
23716 at the Literate python program in
23718 LIBDIR/examples/listerrors.lyx
23720 which should make this all clear.
23723 \begin_layout Paragraph
23724 Generating the documentation
23727 \begin_layout Standard
23728 At this point you already have a new document file with a proper document
23729 class, and with some code and text on it.
23730 How do I print it? The answer is simple, you select
23732 View\SpecialChar menuseparator
23736 Just like you would do for a plain document.
23737 No special procedure is required.
23740 \begin_layout Standard
23741 To help orientate you, I will now explain what happens inside \SpecialChar LyX
23745 \begin_layout Enumerate
23748 Update\SpecialChar menuseparator
23751 menu option is chosen, a \SpecialChar LaTeX
23757 \begin_layout Standard
23758 If the document is of any literate class the generated file will be named
23759 with an extension name defined by the
23760 \begin_inset Quotes eld
23764 \begin_inset Quotes erd
23767 format (defined in the Preferences panel), otherwise the file will have
23776 \begin_layout Enumerate
23777 Note that the only difference so far is in the name of the file, no special
23778 processing is required by \SpecialChar LyX
23780 Given that you formatted the code using the
23781 \begin_inset Flex Noun
23784 \begin_layout Plain Layout
23790 inset that, by itself, takes care of the business.
23793 \begin_layout Enumerate
23794 If the document is of any literate class \SpecialChar LyX
23795 will then use the internal \SpecialChar LyX
23797 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
23802 \begin_layout Plain Layout
23803 The converters are defined in the
23805 Tools\SpecialChar menuseparator
23809 \begin_inset Quotes eld
23813 \begin_inset Quotes erd
23825 manual for general information about converters.
23830 to generate the \SpecialChar LaTeX
23835 \begin_layout Standard
23836 Otherwise it will just skip this step.
23840 \begin_layout Enumerate
23841 Finally, \SpecialChar LaTeX
23842 is invoked and the regular post processing continues as in a plain
23846 \begin_layout Standard
23847 Independence from a particular
23848 \begin_inset Quotes eld
23852 \begin_inset Quotes erd
23855 is easily achieved by changing the commands that are run by the various
23859 \begin_layout Paragraph
23860 Generating the code
23863 \begin_layout Standard
23864 When the build menu option is chosen or the corresponding button in the
23865 toolbar is pressed, a \SpecialChar LaTeX
23866 file is generated just like step 1 above.
23867 Next, \SpecialChar LyX
23873 This converter needs to be defined by the user and is not installed by
23874 default, though the Program format is.
23875 This converter (like any other converter) will have two parts:
23878 \begin_layout Enumerate
23879 The converter program itself.
23880 This program performs the conversion from the one format to the other (in
23881 this case, from the Noweb format to the Program pseudo-format).
23884 \begin_layout Enumerate
23885 The error log parser.
23886 This is a program whose sole purpose is to rewrite error messages in a
23887 format that \SpecialChar LyX
23889 This makes it possible for \SpecialChar LyX
23890 to place error boxes in the right places in
23894 \begin_layout Standard
23895 The first part, the
23896 \begin_inset Quotes eld
23900 \begin_inset Quotes erd
23903 setting, should be set to
23906 \begin_layout LyX-Code
23914 \begin_layout Standard
23915 This basically means that \SpecialChar LyX
23917 \begin_inset Quotes eld
23921 \begin_inset Quotes erd
23924 (a program or script) with the name of the Noweb file (normally a file
23925 in the \SpecialChar LyX
23926 temp directory) and the directory path of the original \SpecialChar LyX
23931 \begin_layout Standard
23932 This is an implementation of
23933 \begin_inset Quotes eld
23937 \begin_inset Quotes erd
23940 that you can place in a directory on your path:
23943 \begin_layout LyX-Code
23949 \begin_layout LyX-Code
23955 \begin_layout LyX-Code
23958 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
23961 \begin_layout Standard
23962 The next part of the converter setting is the
23963 \begin_inset Quotes eld
23967 \begin_inset Quotes erd
23970 which is to be set to
23973 \begin_layout LyX-Code
23976 parselog=$$s/scripts/listerrors
23979 \begin_layout Standard
23980 This will run any errors that are generated by the
23981 \begin_inset Quotes eld
23985 \begin_inset Quotes erd
23988 process through the
23989 \begin_inset Quotes eld
23993 \begin_inset Quotes erd
23999 \begin_layout Standard
24000 The build will normally take place in \SpecialChar LyX
24001 's temporary directory, so the files
24002 produced by the conversion will be in that directory.
24004 will copy out what it regards as the `main' file, but the
24008 conversion may produce several files, and so most of these would then be
24009 deleted when \SpecialChar LyX
24011 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
24012 the build-script chunk can place the generated files in that location.
24015 \begin_layout Paragraph
24016 Build instructions in the document
24019 \begin_layout Standard
24020 The last piece of the integration between \SpecialChar LyX
24022 \begin_inset Quotes eld
24026 \begin_inset Quotes erd
24030 Generally, the instructions for building your program should be embedded
24031 in a chunk of its own.
24033 \begin_inset Quotes eld
24037 \begin_inset Quotes erd
24040 above uses the notangle command to look for this chunk (called
24041 \begin_inset Quotes eld
24045 \begin_inset Quotes erd
24048 ) and runs its contents through
24049 \begin_inset Quotes eld
24053 \begin_inset Quotes erd
24059 \begin_layout Standard
24060 Typically, such a chunk would look something like this:
24063 \begin_layout LyX-Code
24067 \begin_layout LyX-Code
24069 \begin_inset Newline newline
24072 if [ -z "${NOWEB_SOURCE}" ]
24073 \begin_inset Newline newline
24079 \begin_layout LyX-Code
24080 NOWEB_SOURCE=myfile.nw
24081 \begin_inset Newline newline
24085 \begin_inset Newline newline
24089 code to extract files ...
24090 use NOWEB_OUTPUT_DIR here ...]
24091 \begin_inset Newline newline
24095 code to compile files ...]
24096 \begin_inset Newline newline
24102 \begin_layout Standard
24105 LIBDIR/examples/listerrors.lyx
24109 LIBDIR/examples/Literate.lyx
24111 which implement two versions of the
24112 \begin_inset Quotes eld
24116 \begin_inset Quotes erd
24119 program for some illustrations of how all of these pieces go together or
24122 LIBDIR/examples/noweb2lyx.lyx.
24125 Interestingly, these three files show off the language-indepence of the
24127 literate programming support since they are written in Python, C and Perl
24131 \begin_layout Subsubsection
24132 Configuring \SpecialChar LyX
24136 \begin_layout Standard
24137 All the Literate Programming support is configured by the
24139 Tools\SpecialChar menuseparator
24143 \begin_inset Quotes eld
24147 \begin_inset Quotes erd
24151 The important parts are:
24154 \begin_layout Description
24156 \begin_inset space ~
24160 \begin_inset Quotes eld
24164 \begin_inset Quotes erd
24168 \begin_inset space ~
24171 format Set up via the File Formats tab, this is where the Noweb-specific
24181 , the file extension is set to
24186 This tells \SpecialChar LyX
24187 to create a file with a
24191 extension in the first step of the conversion process.
24194 \begin_layout Description
24196 \begin_inset space ~
24204 \begin_inset space ~
24207 format This is an empty format whose sole purpose is to be the endpoint
24208 of a conversion (which then allows us to set up a converter for it).
24211 \begin_layout Description
24221 This converter performs the
24222 \begin_inset Quotes eld
24226 \begin_inset Quotes erd
24229 of the literate document.
24230 For Noweb, it is set to
24231 \begin_inset Quotes eld
24236 noweave -delay -index $$i > $$o
24239 \begin_inset Quotes erd
24245 \begin_layout Description
24255 \begin_inset Quotes eld
24259 \begin_inset Quotes erd
24263 As stated above, the Converter is set to
24264 \begin_inset Quotes eld
24272 \begin_inset Quotes erd
24275 , with Flags set to
24276 \begin_inset Newline newline
24280 \begin_inset Quotes eld
24285 parselog=$$s/scripts/listerrors
24288 \begin_inset Quotes erd
24294 \begin_layout Subsubsection
24298 \begin_layout Standard
24299 There is also a new function implemented in the \SpecialChar LyX
24301 \begin_inset Quotes eld
24304 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
24308 \begin_layout Standard
24309 When debugging code with ddd/gdb, it is possible to invoke a text editor
24310 at the current execution position with a single key stroke.
24311 The default ddd configuration for that is shift-ctrl-V.
24312 It happens that you can define the editor command line invocation in ddd
24315 Edit\SpecialChar menuseparator
24316 Preferences\SpecialChar menuseparator
24319 dialog and changing the "Edit Sources" entry.
24322 \begin_layout Standard
24323 I take advantage of the newly created \SpecialChar LyX
24324 server function and this ddd feature,
24326 \begin_inset Quotes eld
24330 \begin_inset Quotes erd
24336 \begin_layout LyX-Code
24337 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
24340 \begin_layout Standard
24341 With this, whenever you are using ddd and find a point in the program that
24342 you want to edit, you just press shift-ctrl-V (in the ddd window), and
24343 ddd will forward this information to \SpecialChar LyX
24344 through the \SpecialChar LyX
24345 server and then the
24347 window will show the same file with the cursor at the same position ddd
24349 No more guessing or long scrolling to locate a point in the program back
24353 \begin_layout Standard
24354 Note however that you must enable the \SpecialChar LyX
24355 server to get this feature working
24356 (it is disabled by default).
24358 \begin_inset space ~
24362 \begin_inset CommandInset ref
24364 reference "sec:Starting-the-Server"
24368 explains how to do that.
24371 \begin_layout Subsubsection
24375 \begin_layout Standard
24376 There are six new buttons that can be added to your \SpecialChar LyX
24378 Four of these buttons are short cuts to layout styles:
24396 , one for the custom inset
24401 The last one is a short cut to the
24402 \begin_inset Quotes eld
24406 \begin_inset Quotes erd
24413 \begin_layout Standard
24415 has a range of buttons that are available for tool bar customization.
24416 In my toolbar I like to combine the six short cuts above with two more:
24421 \SpecialChar menuseparator
24426 \SpecialChar menuseparator
24433 Document\SpecialChar menuseparator
24434 View\SpecialChar menuseparator
24438 Here is how it looks like:
24441 \begin_layout LyX-Code
24445 \begin_layout LyX-Code
24449 \begin_layout LyX-Code
24450 Icon "layout Standard"
24453 \begin_layout LyX-Code
24454 Icon "layout Section"
24457 \begin_layout LyX-Code
24458 Icon "layout \SpecialChar LaTeX
24462 \begin_layout LyX-Code
24463 Icon "layout \SpecialChar LyX
24467 \begin_layout LyX-Code
24468 Icon "flex.insert Chunk"
24471 \begin_layout LyX-Code
24475 \begin_layout LyX-Code
24479 \begin_layout LyX-Code
24480 Icon "buffer-typeset"
24483 \begin_layout LyX-Code
24484 Icon "build-program"
24487 \begin_layout LyX-Code
24491 \begin_layout LyX-Code
24495 \begin_layout LyX-Code
24499 \begin_layout LyX-Code
24503 \begin_layout LyX-Code
24507 \begin_layout Subsubsection
24508 Colors customization
24511 \begin_layout Standard
24512 There are a number of colors in \SpecialChar LyX
24513 that can be customized in
24518 One of the things that bothers people is the \SpecialChar LaTeX
24520 The default color is red, since the chunks uses \SpecialChar LaTeX
24521 font, and there is a lot
24522 of chunks in literate documents, you may get tired of seeing everything
24524 You can change it by going to the tabs
24533 \begin_layout Standard
24534 The next thing is the visible presence of the newline character in the screen.
24535 You can choose the color of this particular character and make it blend
24537 I recommend you choosing a color that is close to the background but not
24538 equal, that way you still can see it is there, but it is not bothering
24542 \begin_layout Subsection
24547 \begin_layout Standard
24556 is documented in the
24560 example file and in the Sweave manual (menu
24562 Help\SpecialChar menuseparator
24568 \begin_layout Chapter
24572 \begin_layout Standard
24573 You can do everything with \SpecialChar LyX
24574 that you can do with \SpecialChar LaTeX
24576 However, \SpecialChar LyX
24577 cannot support every \SpecialChar LaTeX
24579 But you can always use \SpecialChar TeX
24581 This chapter shows you some more special things you might want to use.
24582 For other special things you can do with figures, tables, floats, boxes
24583 and notes, have a look at the
24586 \begin_inset space ~
24594 \begin_layout Section
24595 Multiple Text Columns
24598 \begin_layout Standard
24599 This feature is independent of the option
24601 Two-column document
24603 in the document settings under
24608 If you want to have 2
24609 \begin_inset space ~
24612 columns for the whole document, it is recommended to use the
24614 Two-column document
24617 For all other cases use this feature.
24620 \begin_layout Standard
24621 To use multiple text columns in your document, you have to load the module
24628 Document\SpecialChar menuseparator
24629 Settings\SpecialChar menuseparator
24632 ) and must have the \SpecialChar LaTeX
24634 \begin_inset Flex Code
24637 \begin_layout Plain Layout
24646 \begin_layout Standard
24647 Footnotes within multiple columns will be placed at the bottom of the page
24648 and not under each column.
24649 Within the different columns you can use everything, with the limitation
24650 that for floats you need to use the float option
24657 \begin_layout Subsection
24661 \begin_layout Standard
24662 If you want to have 2
24663 \begin_inset space ~
24666 columns in your text, insert a multicolumn inset via the menu
24668 Insert\SpecialChar menuseparator
24670 \begin_inset space ~
24673 Insets\SpecialChar menuseparator
24675 \begin_inset space ~
24680 where the columns should start.
24681 Write all text that should be printed in 2
24682 \begin_inset space ~
24685 columns into this inset.
24688 \begin_layout Standard
24689 Here is an example:
24692 \begin_layout Standard
24694 \begin_inset Flex Multiple Columns
24697 \begin_layout Plain Layout
24702 The Adventure of the Empty House
24705 \begin_inset Newline newline
24708 by Sir Arthur Conan Doyle
24711 \begin_layout Plain Layout
24714 It was in the spring of the year 1894 that all London was interested, and
24715 the fashionable world dismayed, by the murder of the Honourable Ronald
24716 Adair under most unusual and inexplicable circumstances.
24717 The public has already learned those particulars of the crime which came
24718 out in the police investigation, but a good deal was suppressed upon that
24719 occasion, since the case for the prosecution was so overwhelmingly strong
24720 that it was not necessary to bring forward all the facts.
24721 Only now, at the end of nearly ten years, am I allowed to supply those
24722 missing links which make up the whole of that remarkable chain.
24723 The crime was of interest in itself, but that interest was as nothing to
24724 me compared to the inconceivable sequel, which afforded me the greatest
24725 shock and surprise of any event in my adventurous life.
24726 Even now, after this long interval, I find myself thrilling as I think
24727 of it, and feeling once more that sudden flood of joy, amazement, and increduli
24728 ty which utterly submerged my mind.
24729 Let me say to that public, which has shown some interest in those glimpses
24730 which I have occasionally given them of the thoughts and actions of a very
24731 remarkable man, that they are not to blame me if I have not shared my knowledge
24732 with them, for I should have considered it my first duty to do so, had
24733 I not been barred by a positive prohibition from his own lips, which was
24734 only withdrawn upon the third of last month.
24742 \begin_layout Standard
24743 To get 3 or more columns, set the cursor into the multicolumn inset and
24746 Insert\SpecialChar menuseparator
24748 \begin_inset space ~
24752 \begin_inset space ~
24758 The number of the desired columns is written into that inset (for 3
24759 \begin_inset space ~
24763 \begin_inset Quotes eld
24767 \begin_inset Quotes erd
24771 \begin_inset Newline newline
24774 Here is an example with 3
24775 \begin_inset space ~
24781 \begin_layout Standard
24782 \begin_inset Flex Multiple Columns
24785 \begin_layout Plain Layout
24788 \begin_inset Argument 1
24791 \begin_layout Plain Layout
24798 It can be imagined that my close intimacy with Sherlock Holmes had interested
24799 me deeply in crime, and that after his disappearance I never failed to
24800 read with care the various problems which came before the public.
24801 And I even attempted, more than once, for my own private satisfaction,
24802 to employ his methods in their solution, though with indifferent success.
24803 There was none, however, which appealed to me like this tragedy of Ronald
24805 As I read the evidence at the inquest, which led up to a verdict of willful
24806 murder against some person or persons unknown, I realized more clearly
24807 than I had ever done the loss which the community had sustained by the
24808 death of Sherlock Holmes.
24809 There were points about this strange business which would, I was sure,
24810 have specially appealed to him, and the efforts of the police would have
24811 been supplemented, or more probably anticipated, by the trained observation
24812 and the alert mind of the first criminal agent in Europe.
24813 All day, as I drove upon my round, I turned over the case in my mind and
24814 found no explanation which appeared to me to be adequate.
24815 At the risk of telling a twice-told tale, I will recapitulate the facts
24816 as they were known to the public at the conclusion of the inquest.
24824 \begin_layout Standard
24825 You can have up to 10
24826 \begin_inset space ~
24829 columns if you want to, but that might not be very pleasant for the readers
24833 \begin_layout Standard
24834 \begin_inset Newpage newpage
24840 \begin_layout Subsection
24841 Columns inside Columns
24844 \begin_layout Standard
24845 You can also have columns inside columns:
24848 \begin_layout Standard
24849 \begin_inset Flex Multiple Columns
24852 \begin_layout Plain Layout
24855 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
24856 at that time governor of one of the Australian colonies.
24857 Adair's mother had returned from Australia to undergo the operation for
24858 cataract, and she, her son Ronald, and her daughter Hilda were living together
24862 \begin_layout Plain Layout
24863 \begin_inset Flex Multiple Columns
24866 \begin_layout Plain Layout
24869 The youth moved in the best society
24870 \begin_inset space ~
24873 – had, so far as was known, no enemies and no particular vices.
24874 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
24875 had been broken off by mutual consent some months before, and there was
24876 no sign that it had left any very profound feeling behind it.
24877 For the rest {sic} the man's life moved in a narrow and conventional circle,
24878 for his habits were quiet and his nature unemotional.
24879 Yet it was upon this easy-going young aristocrat that death came, in most
24880 strange and unexpected form, between the hours of ten and eleven-twenty
24881 on the night of March 30, 1894.
24889 \begin_layout Plain Layout
24892 Ronald Adair was fond of cards
24893 \begin_inset space ~
24896 – playing continually, but never for such stakes as would hurt him.
24897 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
24898 It was shown that, after dinner on the day of his death, he had played
24899 a rubber of whist at the latter club.
24900 He had also played there in the afternoon.
24905 The evidence of those who had played with him
24906 \begin_inset space ~
24910 Murray, Sir John Hardy, and Colonel Moran
24911 \begin_inset space ~
24914 – showed that the game was whist, and that there was a fairly equal fall
24916 Adair might have lost five pounds, but not more.
24917 His fortune was a considerable one, and such a loss could not in any way
24919 He had played nearly every day at one club or other, but he was a cautious
24920 player, and usually rose a winner.
24921 It came out in evidence that, in partnership with Colonel Moran, he had
24922 actually won as much as four hundred and twenty pounds in a sitting, some
24923 weeks before, from Godfrey Milner and Lord Balmoral.
24924 So much for his recent history as it came out at the inquest.
24932 \begin_layout Subsection
24936 \begin_layout Standard
24937 The examples in this section show some more special features of multiple
24941 \begin_layout Standard
24942 For more features of multiple columns, have a look at the
24943 \begin_inset CommandInset href
24945 name "documentation"
24946 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
24951 of the \SpecialChar LaTeX
24953 \begin_inset Flex Code
24956 \begin_layout Plain Layout
24965 \begin_layout Subsubsection
24969 \begin_layout Standard
24970 To add a preface text for multiple columns, set the cursor into the multicolumn
24971 inset and use the menu
24973 Insert\SpecialChar menuseparator
24977 Write your preface text into that inset.
24978 \begin_inset Newline newline
24981 This is an example with some preface text:
24984 \begin_layout Standard
24985 \begin_inset VSpace bigskip
24991 \begin_layout Standard
24992 \begin_inset Flex Multiple Columns
24995 \begin_layout Plain Layout
24996 \begin_inset Argument 2
24999 \begin_layout Plain Layout
25000 And the story continues and continues and continues and continues\SpecialChar ldots
25008 On the evening of the crime, he returned from the club exactly at ten.
25009 His mother and sister were out spending the evening with a relation.
25010 The servant deposed that she heard him enter the front room on the second
25011 floor, generally used as his sitting-room.
25012 She had lit a fire there, and as it smoked she had opened the window.
25013 No sound was heard from the room until eleven-twenty, the hour of the return
25014 of Lady Maynooth and her daughter.
25015 Desiring to say good-night, she attempted to enter her son's room.
25016 The door was locked on the inside, and no answer could be got to their
25017 cries and knocking.
25018 Help was obtained, and the door forced.
25019 The unfortunate young man was found lying near the table.
25020 His head had been horribly mutilated by an expanding revolver bullet, but
25021 no weapon of any sort was to be found in the room.
25029 \begin_layout Standard
25030 You can also use a section heading as the preface if you use a section command
25031 as \SpecialChar TeX
25033 For example the command
25036 \begin_layout LyX-Code
25039 subsection{subsection title}
25042 \begin_layout Standard
25043 creates a subsection.
25044 In this example the preface is a subsubsection:
25047 \begin_layout Standard
25048 \begin_inset Flex Multiple Columns
25051 \begin_layout Plain Layout
25052 \begin_inset Argument 2
25055 \begin_layout Plain Layout
25059 \begin_layout Plain Layout
25068 This is a subsubsection heading as a preface
25072 \begin_layout Plain Layout
25086 A minute examination of the circumstances served only to make the case more
25088 In the first place, no reason could be given why the young man should have
25089 fastened the door upon the inside.
25090 There was the possibility that the murderer had done this, and had afterwards
25091 escaped by the window.
25092 The drop was at least twenty feet, however, and a bed of crocuses in full
25094 Neither the flowers nor the earth showed any sign of having been disturbed,
25095 nor were there any marks upon the narrow strip of grass which separated
25096 the house from the road.
25097 Apparently, therefore, it was the young man himself who had fastened the
25099 But how did he come by his death? No one could have climbed up to the window
25100 without leaving traces.
25101 Suppose a man had fired through the window, he would indeed be a remarkable
25102 shot who could with a revolver inflict so deadly a wound.
25103 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
25104 a hundred yards of the house.
25105 No one had heard a shot.
25113 \begin_layout Standard
25114 If there is less vertical space than 6
25115 \begin_inset space ~
25118 text lines is left on the page at the beginning of the multiple columns,
25119 a page break will be inserted before the multiple columns.
25120 Depending on the number of lines of the preface text, you might want to
25122 This is done by setting the cursor into the mulitcolumn inset behind the
25123 preface (if there is any) and using the menu
25125 Insert\SpecialChar menuseparator
25127 \begin_inset space ~
25131 \begin_inset space ~
25135 \begin_inset space ~
25141 Insert into that inset the amount of space like e.
25142 \begin_inset space \thinspace{}
25146 \begin_inset space \space{}
25150 \begin_inset Quotes eld
25154 \begin_inset Quotes erd
25158 \begin_inset Newline newline
25161 In this example the space is set to 7
25162 \begin_inset space ~
25165 text lines by using
25166 \begin_inset Flex Code
25169 \begin_layout Plain Layout
25178 \begin_inset Flex Code
25181 \begin_layout Plain Layout
25189 needs to be inserted as \SpecialChar TeX
25193 \begin_layout Standard
25194 \begin_inset Flex Multiple Columns
25197 \begin_layout Plain Layout
25198 \begin_inset Argument 3
25201 \begin_layout Plain Layout
25206 \begin_layout Plain Layout
25222 On the evening of the crime, he returned from the club exactly at ten.
25223 His mother and sister were out spending the evening with a relation.
25224 The servant deposed that she heard him enter the front room on the second
25225 floor, generally used as his sitting-room.
25226 She had lit a fire there, and as it smoked she had opened the window.
25227 No sound was heard from the room until eleven-twenty, the hour of the return
25228 of Lady Maynooth and her daughter.
25229 Desiring to say good-night, she attempted to enter her son's room.
25230 The door was locked on the inside, and no answer could be got to their
25231 cries and knocking.
25232 Help was obtained, and the door forced.
25233 The unfortunate young man was found lying near the table.
25234 His head had been horribly mutilated by an expanding revolver bullet, but
25235 no weapon of any sort was to be found in the room.
25243 \begin_layout Subsubsection
25247 \begin_layout Standard
25248 The amount of space before and after multiple columns can be changed by
25249 changing the length
25250 \begin_inset Flex Code
25253 \begin_layout Plain Layout
25262 For example the command
25265 \begin_layout LyX-Code
25273 \begin_layout Standard
25274 in \SpecialChar TeX
25275 Code changes its value to 3
25276 \begin_inset space \thinspace{}
25280 The change must be made before the multiple columns' start.
25281 The predefined value is 13
25282 \begin_inset space \thinspace{}
25288 \begin_layout Standard
25290 \begin_inset Flex Code
25293 \begin_layout Plain Layout
25302 \begin_inset space \thinspace{}
25308 \begin_layout Standard
25312 \begin_layout Plain Layout
25318 multicolsep}{2.5cm}
25326 \begin_layout Standard
25327 \begin_inset Flex Multiple Columns
25330 \begin_layout Plain Layout
25333 All day I turned these facts over in my mind, endeavouring to hit upon some
25334 theory which could reconcile them all, and to find that line of least resistanc
25335 e which my poor friend had declared to be the starting-point of every investigat
25337 I confess that I made little progress.
25338 In the evening I strolled across the Park, and found myself about six o'clock
25339 at the Oxford Street end of Park Lane.
25340 A group of loafers upon the pavements, all staring up at a particular window,
25341 directed me to the house which I had come to see.
25342 A tall, thin man with coloured glasses, whom I strongly suspected of being
25343 a plain-clothes detective, was pointing out some theory of his own, while
25344 the others crowded round to listen to what he said.
25345 I got as near him as I could, but his observations seemed to me to be absurd,
25346 so I withdrew again in some disgust.
25347 As I did so I struck against an elderly, deformed man, who had been behind
25348 me, and I knocked down several books which he was carrying.
25356 \begin_layout Standard
25357 \begin_inset Note Greyedout
25360 \begin_layout Plain Layout
25365 The values you set with
25366 \begin_inset Flex Code
25369 \begin_layout Plain Layout
25377 will be used for all following multiple columns until you change them again.
25385 \begin_layout Standard
25389 \begin_layout Plain Layout
25401 \begin_inset Note Note
25404 \begin_layout Plain Layout
25405 go back to the default
25413 \begin_layout Standard
25414 \begin_inset Newpage newpage
25420 \begin_layout Subsubsection
25424 \begin_layout Standard
25425 A column break can be forced by inserting the command
25426 \begin_inset Flex Code
25429 \begin_layout Plain Layout
25437 as \SpecialChar TeX
25438 Code to that position in the text where the column should be broken.
25439 Note that this leads in most cases to whitespace in the text.
25440 \begin_inset Newline newline
25443 Here is an example:
25446 \begin_layout Standard
25447 \begin_inset Flex Multiple Columns
25450 \begin_layout Plain Layout
25453 \begin_inset Quotes eld
25456 You're surprised to see me, sir,
25457 \begin_inset Quotes erd
25460 said he, in a strange, croaking voice.
25463 \begin_layout Plain Layout
25466 I acknowledged that I was.
25469 \begin_layout Plain Layout
25472 \begin_inset Quotes eld
25475 Well, I've a conscience, sir, and when I chanced to see you go into this
25476 house, as I came hobbling after you, I thought to myself, I'll just step
25477 in and see that kind gentleman, and tell him that if I was a bit gruff
25478 in my manner there was not any harm meant, and that I am much obliged to
25479 him for picking up my books.
25480 \begin_inset Quotes erd
25486 \begin_layout Plain Layout
25489 \begin_inset Quotes eld
25492 You make too much of a trifle,
25493 \begin_inset Quotes erd
25498 \begin_inset Quotes eld
25501 May I ask how you knew who I was?
25502 \begin_inset Quotes erd
25505 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
25509 \begin_layout Plain Layout
25521 \begin_layout Plain Layout
25524 \begin_inset Quotes eld
25527 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25528 you'll find my little bookshop at the corner of Church Street, and very
25529 happy to see you, I am sure.
25530 Maybe you collect yourself, sir.
25534 \begin_inset space ~
25548 \begin_inset space ~
25551 – a bargain, every one of them.
25552 With five volumes you could just fill that gap on that second shelf.
25553 It looks untidy, does it not, sir?
25554 \begin_inset Quotes erd
25565 \begin_layout Subsubsection
25569 \begin_layout Standard
25570 The width of the columns is automatically calculated, but you can modify
25571 the space between the columns.
25572 This is done by changing the length
25573 \begin_inset Flex Code
25576 \begin_layout Plain Layout
25585 Its predefined value is 10
25586 \begin_inset space \thinspace{}
25590 Here is an example where
25591 \begin_inset Flex Code
25594 \begin_layout Plain Layout
25603 \begin_inset space \thinspace{}
25609 \begin_layout Standard
25613 \begin_layout Plain Layout
25627 \begin_layout Standard
25628 \begin_inset Flex Multiple Columns
25631 \begin_layout Plain Layout
25634 My observations of No.
25635 \begin_inset space \space{}
25638 427 Park Lane did little to clear up the problem in which I was interested.
25639 The house was separated from the street by a low wall and railing, the
25640 whole not more than five feet high.
25641 It was perfectly easy, therefore, for anyone to get into the garden, but
25642 the window was entirely inaccessible, since there was no water pipe or
25643 anything which could help the most active man to climb it.
25644 More puzzled than ever, I retraced my steps to Kensington.
25645 I had not been in my study five minutes when the maid entered to say that
25646 a person desired to see me.
25647 To my astonishment it was none other than my strange old book collector,
25648 his sharp, wizened face peering out from a frame of white hair, and his
25649 precious volumes, a dozen of them at least, wedged under his right arm.
25657 \begin_layout Standard
25661 \begin_layout Plain Layout
25673 \begin_inset Note Note
25676 \begin_layout Plain Layout
25677 go back to the default
25685 \begin_layout Subsubsection
25689 \begin_layout Standard
25690 Between the columns a rule with a width of the length
25691 \begin_inset Flex Code
25694 \begin_layout Plain Layout
25703 If this rule width is set to 0
25704 \begin_inset space \thinspace{}
25707 pt (this is the default), the rule is suppressed.
25708 In the following example the rule is 2
25709 \begin_inset space \thinspace{}
25715 \begin_layout Standard
25719 \begin_layout Plain Layout
25725 columnseprule}{2pt}
25733 \begin_layout Standard
25734 \begin_inset Flex Multiple Columns
25737 \begin_layout Plain Layout
25740 \begin_inset Quotes eld
25743 You're surprised to see me, sir,
25744 \begin_inset Quotes erd
25747 said he, in a strange, croaking voice.
25750 \begin_layout Plain Layout
25753 I acknowledged that I was.
25756 \begin_layout Plain Layout
25759 \begin_inset Quotes eld
25762 Well, I've a conscience, sir, and when I chanced to see you go into this
25763 house, as I came hobbling after you, I thought to myself, I'll just step
25764 in and see that kind gentleman, and tell him that if I was a bit gruff
25765 in my manner there was not any harm meant, and that I am much obliged to
25766 him for picking up my books.
25767 \begin_inset Quotes erd
25773 \begin_layout Plain Layout
25776 \begin_inset Quotes eld
25779 You make too much of a trifle,
25780 \begin_inset Quotes erd
25785 \begin_inset Quotes eld
25788 May I ask how you knew who I was?
25789 \begin_inset Quotes erd
25795 \begin_layout Plain Layout
25798 \begin_inset Quotes eld
25801 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
25802 you'll find my little bookshop at the corner of Church Street, and very
25803 happy to see you, I am sure.
25804 Maybe you collect yourself, sir.
25808 \begin_inset space ~
25822 \begin_inset space ~
25825 – a bargain, every one of them.
25826 With five volumes you could just fill that gap on that second shelf.
25827 It looks untidy, does it not, sir?
25828 \begin_inset Quotes erd
25839 \begin_layout Standard
25840 \begin_inset VSpace defskip
25846 \begin_layout Standard
25847 The rule can be colored by redefining the command
25848 \begin_inset Flex Code
25851 \begin_layout Plain Layout
25860 This is done by inserting the command
25863 \begin_layout LyX-Code
25868 columnseprulecolor}{
25873 \begin_layout Standard
25874 as \SpecialChar TeX
25875 Code before the multicolumn inset.
25877 \begin_inset Flex Code
25880 \begin_layout Plain Layout
25886 in this command by a color of your choice.
25887 You can use all pre- and self-defined colors.
25895 \begin_inset space ~
25900 for more information about pre- and self-defined colors.
25901 To go back to the default color insert the command
25904 \begin_layout LyX-Code
25909 columnseprulecolor}{
25914 \begin_layout Standard
25915 Here is the example with a cyan rule and 1
25916 \begin_inset space \thinspace{}
25919 cm column separation:
25922 \begin_layout Standard
25926 \begin_layout Plain Layout
25935 \begin_layout Plain Layout
25941 columnseprulecolor}{
25951 \begin_layout Standard
25952 \begin_inset Flex Multiple Columns
25955 \begin_layout Plain Layout
25958 \begin_inset Quotes eld
25961 You're surprised to see me, sir,
25962 \begin_inset Quotes erd
25965 said he, in a strange, croaking voice.
25968 \begin_layout Plain Layout
25971 I acknowledged that I was.
25974 \begin_layout Plain Layout
25977 \begin_inset Quotes eld
25980 Well, I've a conscience, sir, and when I chanced to see you go into this
25981 house, as I came hobbling after you, I thought to myself, I'll just step
25982 in and see that kind gentleman, and tell him that if I was a bit gruff
25983 in my manner there was not any harm meant, and that I am much obliged to
25984 him for picking up my books.
25985 \begin_inset Quotes erd
25991 \begin_layout Plain Layout
25994 \begin_inset Quotes eld
25997 You make too much of a trifle,
25998 \begin_inset Quotes erd
26003 \begin_inset Quotes eld
26006 May I ask how you knew who I was?
26007 \begin_inset Quotes erd
26013 \begin_layout Plain Layout
26016 \begin_inset Quotes eld
26019 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
26020 you'll find my little bookshop at the corner of Church Street, and very
26021 happy to see you, I am sure.
26022 Maybe you collect yourself, sir.
26026 \begin_inset space ~
26040 \begin_inset space ~
26043 – a bargain, every one of them.
26044 With five volumes you could just fill that gap on that second shelf.
26045 It looks untidy, does it not, sir?
26046 \begin_inset Quotes erd
26057 \begin_layout Standard
26061 \begin_layout Plain Layout
26067 columnseprule}{0pt}
26070 \begin_layout Plain Layout
26076 columnseprulecolor}{
26084 \begin_inset Note Note
26087 \begin_layout Plain Layout
26088 go back to the default
26096 \begin_layout Section
26097 Non-standard Paragraph Shapes
26100 \begin_layout Standard
26103 as well as any other text processor uses by default rectangular paragraphs.
26104 For special cases like for example posters, invitation cards or poems you
26105 can modify the paragraph shape to one of your choice.
26106 This can be done by using the \SpecialChar LaTeX
26108 \begin_inset Flex Code
26111 \begin_layout Plain Layout
26117 which is loaded by using in the document settings the module
26119 Custom paragraph shapes
26124 \begin_layout Subsection
26128 \begin_layout Standard
26133 provides the following shapes:
26136 \begin_layout Standard
26137 \begin_inset Tabular
26138 <lyxtabular version="3" rows="13" columns="3">
26139 <features booktabs="true" islongtable="true" longtabularalignment="center">
26140 <column alignment="left" valignment="middle" width="16col%">
26141 <column alignment="left" valignment="middle" width="40col%">
26142 <column alignment="left" valignment="middle" width="35col%">
26143 <row endhead="true">
26144 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26147 \begin_layout Plain Layout
26156 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
26159 \begin_layout Plain Layout
26168 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
26171 \begin_layout Plain Layout
26181 <row interlinespace="default">
26182 <cell alignment="left" valignment="top" usebox="none">
26185 \begin_layout Plain Layout
26193 <cell alignment="left" valignment="top" usebox="none">
26196 \begin_layout Plain Layout
26199 Circle with circular hole (in the size of a CD/DVD)
26204 <cell alignment="left" valignment="top" usebox="none">
26207 \begin_layout Plain Layout
26210 Cannot be scaled, take care there is not too much text
26216 <row interlinespace="default">
26217 <cell alignment="left" valignment="top" usebox="none">
26220 \begin_layout Plain Layout
26228 <cell alignment="left" valignment="top" usebox="none">
26231 \begin_layout Plain Layout
26239 <cell alignment="left" valignment="top" usebox="none">
26242 \begin_layout Plain Layout
26245 Fragile, calculation might fail
26251 <row interlinespace="default">
26252 <cell alignment="left" valignment="top" usebox="none">
26255 \begin_layout Plain Layout
26263 <cell alignment="left" valignment="top" usebox="none">
26266 \begin_layout Plain Layout
26269 Rhomboid (symbolizing a
26270 \begin_inset Quotes eld
26274 \begin_inset Quotes erd
26282 <cell alignment="left" valignment="top" usebox="none">
26285 \begin_layout Plain Layout
26294 <row interlinespace="default">
26295 <cell alignment="left" valignment="top" usebox="none">
26298 \begin_layout Plain Layout
26306 <cell alignment="left" valignment="top" usebox="none">
26309 \begin_layout Plain Layout
26317 <cell alignment="left" valignment="top" usebox="none">
26320 \begin_layout Plain Layout
26329 <row interlinespace="default">
26330 <cell alignment="left" valignment="top" usebox="none">
26333 \begin_layout Plain Layout
26341 <cell alignment="left" valignment="top" usebox="none">
26344 \begin_layout Plain Layout
26352 <cell alignment="left" valignment="top" usebox="none">
26355 \begin_layout Plain Layout
26364 <row interlinespace="default">
26365 <cell alignment="left" valignment="top" usebox="none">
26368 \begin_layout Plain Layout
26376 <cell alignment="left" valignment="top" usebox="none">
26379 \begin_layout Plain Layout
26382 Nut for bolt (hexagon with circular hole)
26387 <cell alignment="left" valignment="top" usebox="none">
26390 \begin_layout Plain Layout
26399 <row interlinespace="default">
26400 <cell alignment="left" valignment="top" usebox="none">
26403 \begin_layout Plain Layout
26411 <cell alignment="left" valignment="top" usebox="none">
26414 \begin_layout Plain Layout
26422 <cell alignment="left" valignment="top" usebox="none">
26425 \begin_layout Plain Layout
26434 <row interlinespace="default">
26435 <cell alignment="left" valignment="top" usebox="none">
26438 \begin_layout Plain Layout
26446 <cell alignment="left" valignment="top" usebox="none">
26449 \begin_layout Plain Layout
26457 <cell alignment="left" valignment="top" usebox="none">
26460 \begin_layout Plain Layout
26469 <row interlinespace="default">
26470 <cell alignment="left" valignment="top" usebox="none">
26473 \begin_layout Plain Layout
26481 <cell alignment="left" valignment="top" usebox="none">
26484 \begin_layout Plain Layout
26492 <cell alignment="left" valignment="top" usebox="none">
26495 \begin_layout Plain Layout
26504 <row interlinespace="default">
26505 <cell alignment="left" valignment="top" usebox="none">
26508 \begin_layout Plain Layout
26516 <cell alignment="left" valignment="top" usebox="none">
26519 \begin_layout Plain Layout
26522 Normal/reversed rain drop
26527 <cell alignment="left" valignment="top" usebox="none">
26530 \begin_layout Plain Layout
26533 Fragile, calculation might fail
26539 <row interlinespace="default">
26540 <cell alignment="left" valignment="top" usebox="none">
26543 \begin_layout Plain Layout
26552 <cell alignment="left" valignment="top" usebox="none">
26555 \begin_layout Plain Layout
26558 The \SpecialChar TeX
26564 <cell alignment="left" valignment="top" usebox="none">
26567 \begin_layout Plain Layout
26576 <row interlinespace="default">
26577 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26580 \begin_layout Plain Layout
26584 \begin_inset Newline newline
26592 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26595 \begin_layout Plain Layout
26598 Triangles in different orientations
26603 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
26606 \begin_layout Plain Layout
26622 \begin_layout Standard
26623 To use a shape for your paragraph, simply select it in \SpecialChar LyX
26625 for environments in the toolbar.
26628 \begin_layout Standard
26629 \begin_inset Newpage newpage
26635 \begin_layout Standard
26636 Here is an example paragraph in the shape of a nut:
26639 \begin_layout Standard
26640 \begin_inset VSpace bigskip
26649 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26650 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26652 At vero eos et accusam et justo duo dolores et ea rebum.
26653 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26655 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26656 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26660 \begin_layout Standard
26661 \begin_inset VSpace bigskip
26667 \begin_layout Standard
26668 \begin_inset Note Greyedout
26671 \begin_layout Plain Layout
26680 paragraphs cannot run over a page break.
26688 \begin_layout Standard
26689 \begin_inset VSpace bigskip
26695 \begin_layout Standard
26697 \begin_inset Flex Code
26700 \begin_layout Plain Layout
26706 takes care that the shape will always be preserved, no matter how much
26707 text is in the paragraph.
26708 Therefore the paragraph size changes with the amount of contained text.
26709 This can lead to paragraph sizes exceeding the page margins.
26710 To demonstrate the size scaling, here is the same example paragraph but
26711 with twice as much text:
26714 \begin_layout Standard
26715 \begin_inset Newpage newpage
26724 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26725 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26727 At vero eos et accusam et justo duo dolores et ea rebum.
26728 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26730 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26731 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26733 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26734 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26736 At vero eos et accusam et justo duo dolores et ea rebum.
26737 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26739 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26740 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26744 \begin_layout Standard
26745 \begin_inset VSpace bigskip
26751 \begin_layout Standard
26752 An exception is the shape
26757 It cannot be scaled because it must fit the size of a CD/DVD.
26758 Therefore the amount of text that fits into the shape is limited.
26759 \begin_inset Newline newline
26770 shape are fragile, meaning that the calculation of their size can fail,
26771 depending on the amount of text.
26772 You will then get the \SpecialChar LaTeX
26774 \begin_inset Quotes eld
26777 Arithmetic overflow
26778 \begin_inset Quotes erd
26782 In this case one can try to remove or add some text; if nothing works one
26783 has to use another shape.
26786 \begin_layout Standard
26787 \begin_inset VSpace bigskip
26793 \begin_layout Standard
26794 For shapes with tips you will maybe see that \SpecialChar LaTeX
26795 's hyphenation routine fails
26796 for text in the tips.
26797 Therefore it is often necessary to add hyphenation points
26802 arg "specialchar-insert hyphenation"
26807 ) to the corresponding text parts.
26810 \begin_layout Standard
26811 \begin_inset VSpace bigskip
26817 \begin_layout Standard
26818 Shapepar paragraphs are either always centered or placed on the page so
26819 that their left border touches the left page margin.
26820 You can therefore not use the paragraph dialog to align such paragraphs.
26821 A solution is to put the paragraph into a minipage or parbox and align
26823 The problem is hereby to find the right width for the box.
26824 Because if it is too wide and you center the box, the paragraph is not
26825 centered too because it sticks at the left side of the box.
26826 So you might have to play a bit with the width until it fits.
26827 Here are two heart-shaped paragraphs, the first one is not aligned, the
26828 second one is right-aligned:
26831 \begin_layout Standard
26832 \begin_inset Newpage newpage
26838 \begin_layout Heart
26842 Lo\SpecialChar softhyphen
26843 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26844 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26846 At vero eos et accusam et justo duo dolores et ea rebum.
26847 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26851 \begin_layout Standard
26852 \begin_inset VSpace bigskip
26858 \begin_layout Standard
26861 \begin_inset Box Frameless
26871 height_special "totalheight"
26876 backgroundcolor "none"
26879 \begin_layout Heart
26883 Lo\SpecialChar softhyphen
26884 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
26885 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
26887 At vero eos et accusam et justo duo dolores et ea rebum.
26888 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
26897 \begin_layout Subsection
26901 \begin_layout Standard
26902 You can define any shape you want.
26903 Doing this manually is a lot of work because every coordinate must be specified.
26904 But there is a way to let the computer calculate the coordinates:
26907 \begin_layout Enumerate
26908 Install the program
26909 \begin_inset CommandInset href
26912 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
26920 \begin_layout Enumerate
26927 TeX/LaTeX\SpecialChar menuseparator
26928 Settings\SpecialChar menuseparator
26931 and select the font size you are using in your document.
26932 For example this document uses the size 12
26933 \begin_inset space \thinspace{}
26939 \begin_layout Enumerate
26943 \begin_layout Enumerate
26946 TeX/LaTeX\SpecialChar menuseparator
26949 to export the shape to coordinates.
26950 In the appearing dialog use either the outline of your shape for the coordinate
26951 s or the path itself.
26955 \begin_layout Plain Layout
26956 For more information see
26957 \begin_inset CommandInset href
26959 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
26972 \begin_layout Standard
26973 The coordinates are written into a \SpecialChar TeX
26975 To use it for your \SpecialChar LyX
26979 \begin_layout Enumerate
26980 Place the cursor before the first character of your paragraph (or into a
26984 \begin_layout Enumerate
26985 Open in \SpecialChar LyX
26988 Insert\SpecialChar menuseparator
26989 File\SpecialChar menuseparator
26991 \begin_inset space ~
26996 , select the file and use
27005 \begin_layout Standard
27006 \begin_inset VSpace defskip
27012 \begin_layout Standard
27013 \begin_inset Note Greyedout
27016 \begin_layout Plain Layout
27021 : The changed shape only applies to the current paragraph; everything is
27022 reset to normal for the next paragraph.
27023 Therefore the shape definition file must be input into every paragraph
27024 with the desired shape.
27032 \begin_layout Standard
27033 \begin_inset VSpace bigskip
27039 \begin_layout Standard
27040 Here is an example:
27043 \begin_layout Standard
27044 \begin_inset VSpace bigskip
27050 \begin_layout Standard
27051 \begin_inset CommandInset include
27053 filename "SpecialParagraphShape.tex"
27060 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27061 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27063 At vero eos et accusam et justo duo dolores et ea rebum.
27064 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
27066 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
27067 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
27071 \begin_layout Standard
27072 \begin_inset VSpace bigskip
27078 \begin_layout Standard
27083 to draw complexer shapes in
27087 you can draw the shape in a program of your choice and import the resulting
27093 Then you only need to draw a line or spline along the outline of the image.
27096 \begin_layout Standard
27097 \begin_inset VSpace bigskip
27103 \begin_layout Standard
27106 Custom paragraph shapes
27108 also provides the two commands
27116 which can be used to define custom shapes coordinate by coordinate.
27120 \begin_layout Plain Layout
27121 These commands are internally used for all shapes described here.
27126 For information how these styles are used and about further customization
27127 possibilities, have a look at the
27128 \begin_inset CommandInset href
27130 name "documentation"
27131 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
27137 \begin_inset Flex Code
27140 \begin_layout Plain Layout