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
44 \maintain_unincluded_children no
46 \language_package default
49 \font_roman "lmodern" "default"
50 \font_sans "lmss" "default"
51 \font_typewriter "lmtt" "default"
52 \font_math "auto" "auto"
53 \font_default_family default
54 \use_non_tex_fonts false
58 \font_typewriter_osf false
59 \font_sf_scale 100 100
60 \font_tt_scale 100 100
62 \use_dash_ligatures true
64 \default_output_format pdf2
66 \bibtex_command default
67 \index_command default
68 \float_placement class
69 \float_alignment class
73 \pdf_title "LyX's Additional Features manual"
74 \pdf_author "LyX Team"
75 \pdf_subject "LyX's additional features documentation"
76 \pdf_keywords "LyX, Documentation, Additional"
78 \pdf_bookmarksnumbered true
79 \pdf_bookmarksopen false
80 \pdf_bookmarksopenlevel 1
85 \pdf_pdfusetitle false
86 \pdf_quoted_options "linkcolor=black, citecolor=black, urlcolor=blue, filecolor=blue, pdfpagelayout=OneColumn, pdfnewwindow=true, pdfstartview=XYZ, plainpages=false"
89 \use_package amsmath 1
90 \use_package amssymb 1
93 \use_package mathdots 1
94 \use_package mathtools 1
96 \use_package stackrel 1
97 \use_package stmaryrd 1
98 \use_package undertilde 1
100 \cite_engine_type default
104 \paperorientation portrait
110 \notefontcolor #0000ff
117 \paragraph_separation indent
118 \paragraph_indentation default
120 \math_indentation default
121 \math_numbering_side default
122 \quotes_style english
126 \paperpagestyle headings
128 \tracking_changes true
129 \output_changes false
131 \postpone_fragile_content false
135 \docbook_table_output 0
136 \docbook_mathml_prefix 1
137 \author -712698321 "Jürgen Spitzmüller"
140 \author 244031559 "Yuriy"
141 \author 564990737 "John Lyx"
142 \author 630872221 "Jean-Pierre Chrétien" jeanpierre.chretien@free.fr
143 \author 1075283030 "Thibaut"
144 \author 1119979965 "Joel A. Kulesza"
150 Additional \SpecialChar LyX
154 \begin_layout Subtitle
156 \change_deleted 630872221 1622909155
158 \change_inserted 630872221 1622909155
165 by the \SpecialChar LyX
170 \begin_layout Plain Layout
172 Principal maintainer of this file is
174 Richard Kimberly Heck
177 If you have comments or error corrections, please send them to the \SpecialChar LyX
180 \begin_inset Flex Code
183 \begin_layout Plain Layout
184 <lyx-docs@lists.lyx.org>
197 \begin_layout Standard
198 \begin_inset CommandInset toc
199 LatexCommand tableofcontents
206 \begin_layout Chapter
210 \begin_layout Standard
211 This manual is essentially Part II of the
213 User's Guide\SpecialChar endofsentence
216 The reason for separating the two documents is simple: the
220 is already quite lengthy, and it contains information on all of the basic
221 features one needs to know in order to prepare most documents.
222 However, the \SpecialChar LyX
223 Team has worked to make \SpecialChar LyX
224 extensible through various configuration
225 files and external packages.
226 That means that if you want to support the Fizzwizzle \SpecialChar LaTeX
228 create a layout file (or module) for it without having to alter \SpecialChar LyX
230 We've already had contributions of several new features this way, and some
231 of them are documented here.
232 There are also some more `advanced' features, such as how to control the
233 presentation of bibliographies and how to work with multi-part documents,
234 that are not covered in the
238 and are discussed here.
241 \begin_layout Standard
242 This manual also documents some special features, like fax support
243 \change_deleted 244031559 1603802929
245 \change_inserted 244031559 1603802931
249 \change_deleted 244031559 1603802954
252 , which require additional software to work properly.
253 There is also a chapter on \SpecialChar LyX
255 And lastly, there's a chapter of \SpecialChar LaTeX
256 tools and tips, things you can use to
257 spruce up your documents by directly using the powerful features of \SpecialChar LaTeX
259 After all, \SpecialChar LyX
264 only WYSIWYM and will only ever interface to some, not all, \SpecialChar LaTeX
268 \begin_layout Standard
269 If you haven't read the
273 yet, you are definitely in the wrong manual.
278 is the first place to go, since it describes the notation and format of
280 You should also be thoroughly familiar with the
284 and all of the basic features of \SpecialChar LyX
285 before attempting to read this one.
288 \begin_layout Standard
289 Since many of the topics in this manual depend heavily on \SpecialChar LyX
291 with \SpecialChar LaTeX
292 , this first chapter covers the inner workings of \SpecialChar LyX
295 to generate exactly the \SpecialChar LaTeX
297 It is obviously for more seasoned \SpecialChar LyX
301 \begin_layout Chapter
303 and \SpecialChar LaTeX
307 \begin_layout Section
309 Uses \SpecialChar LaTeX
313 \begin_layout Standard
314 This chapter is for both \SpecialChar TeX
315 -nicians and the \SpecialChar LaTeX
317 In it, we'll explain how \SpecialChar LyX
318 and \SpecialChar LaTeX
319 work together to produce printable output.
320 This is the only place in any of the manuals where we assume you know something
321 about \SpecialChar LaTeX
325 \begin_layout Standard
326 At one time, \SpecialChar LyX
328 \begin_inset Quotes eld
331 WYSIWYM frontend to \SpecialChar LaTeX
333 \begin_inset Quotes erd
336 but that's no longer true.
337 There are frontends to \SpecialChar LaTeX
342 \begin_layout Plain Layout
343 Some familar ones are \SpecialChar TeX
344 maker and kile, on Linux, and \SpecialChar TeX
346 There are also the \SpecialChar LaTeX
347 modes for vi and emacs, of course.
352 These are basically text editors with the ability to run \SpecialChar LaTeX
354 errors in the file you're editing.
355 Although \SpecialChar LyX
364 run \SpecialChar LaTeX
365 , and it also indicates errors in the file, it also does much, much
367 For one thing, you don't need to know \SpecialChar LaTeX
368 to use \SpecialChar LyX
371 has added its own extensions to \SpecialChar LaTeX
373 Try the following sometime: select
374 \begin_inset Flex Noun
377 \begin_layout Plain Layout
378 Export\SpecialChar menuseparator
385 \begin_inset Flex Noun
388 \begin_layout Plain Layout
395 \begin_inset Flex Noun
398 \begin_layout Plain Layout
399 View\SpecialChar menuseparator
409 ), then look at the preamble of the resulting
410 \begin_inset Flex Code
413 \begin_layout Plain Layout
420 You'll notice a variety of new macros defined specifically by \SpecialChar LyX
422 These macros are defined automatically, according to the features you use
426 \begin_layout Standard
427 There are several commands that automatically invoke \SpecialChar LaTeX
432 \begin_layout Itemize
433 \begin_inset Flex Noun
436 \begin_layout Plain Layout
437 Document\SpecialChar menuseparator
446 \begin_layout Itemize
447 \begin_inset Flex Noun
450 \begin_layout Plain Layout
451 Document\SpecialChar menuseparator
460 \begin_layout Standard
461 They will only invoke \SpecialChar LaTeX
462 if the file has changed since the last time \SpecialChar LaTeX
468 \begin_layout Standard
469 When \SpecialChar LyX
470 runs \SpecialChar LaTeX
471 on the file you're editing, it performs these steps:
474 \begin_layout Enumerate
475 Convert the document to \SpecialChar LaTeX
476 and save to a file with the extension
477 \begin_inset Flex Code
480 \begin_layout Plain Layout
487 \begin_inset Flex Code
490 \begin_layout Plain Layout
499 \begin_layout Enumerate
500 Run \SpecialChar LaTeX
502 \begin_inset Flex Code
505 \begin_layout Plain Layout
511 file (maybe several times), and run any other commands (such as
512 \begin_inset Flex Code
515 \begin_layout Plain Layout
522 \begin_inset Flex Code
525 \begin_layout Plain Layout
531 ) needed to compile the \SpecialChar LaTeX
535 \begin_layout Enumerate
536 If there are any errors, show the error log.
539 \begin_layout Standard
540 If you have run \SpecialChar LaTeX
542 \begin_inset Flex Noun
545 \begin_layout Plain Layout
546 View\SpecialChar menuseparator
553 then runs a DVI viewer to display the DVI-file.
555 \begin_inset Flex Noun
558 \begin_layout Plain Layout
559 View\SpecialChar menuseparator
566 performs further steps:
569 \begin_layout Enumerate
571 \begin_inset Flex Code
574 \begin_layout Plain Layout
580 to convert the DVI file to PostScript.
583 \begin_layout Enumerate
584 Run a PostScript viewer, such as
585 \begin_inset Flex Code
588 \begin_layout Plain Layout
594 , to display the PostScript file.
597 \begin_layout Standard
599 does similar things when viewing, or exporting, other formats.
602 \begin_layout Section
603 Translating \SpecialChar LaTeX
604 files into \SpecialChar LyX
608 \begin_layout Standard
609 You can import a \SpecialChar LaTeX
610 file into \SpecialChar LyX
612 \begin_inset Flex Noun
615 \begin_layout Plain Layout
616 File\SpecialChar menuseparator
617 Import\SpecialChar menuseparator
623 command in \SpecialChar LyX
625 This will call a program named
626 \begin_inset Flex Code
629 \begin_layout Plain Layout
635 which will create a file
636 \begin_inset Flex Code
639 \begin_layout Plain Layout
646 \begin_inset Flex Code
649 \begin_layout Plain Layout
657 will then open that file.
661 \begin_layout Plain Layout
662 \begin_inset Flex Code
665 \begin_layout Plain Layout
671 can also be run from the command line, of course.
679 \begin_layout Standard
680 \begin_inset Flex Code
683 \begin_layout Plain Layout
689 will translate most legal \SpecialChar LaTeX
690 , but not everything.
691 It will put things it doesn't understand into \SpecialChar TeX
692 code, so after translating
694 \begin_inset Flex Code
697 \begin_layout Plain Layout
703 , you can look for \SpecialChar TeX
704 code and hand-edit it until it looks right.
707 \begin_layout Standard
708 If you don't know what \SpecialChar TeX
709 code is, read the next section.
712 \begin_layout Section
713 \begin_inset CommandInset label
715 name "sec:Inserting-TeX-Code"
719 Inserting \SpecialChar TeX
720 Code into \SpecialChar LyX
724 \begin_layout Standard
725 Anything you can do in \SpecialChar LaTeX
726 you can do in \SpecialChar LyX
727 , for a very simple reason: You can
728 always insert \SpecialChar TeX
729 code into any \SpecialChar LyX
732 cannot, and will never be able to, display every possible \SpecialChar LaTeX
734 If ever you need to insert \SpecialChar LaTeX
735 commands into your \SpecialChar LyX
736 document, you can use the
738 \begin_inset Flex Code
741 \begin_layout Plain Layout
748 box, which you can insert into your document with
749 \begin_inset Flex Noun
752 \begin_layout Plain Layout
753 Insert\SpecialChar menuseparator
763 or the keyboard shortcut
772 \begin_layout Standard
773 Here's an example of inserting \SpecialChar LaTeX
774 commands in a \SpecialChar LyX
776 The code looks like this:
779 \begin_layout LyX-Code
783 \begin_inset Newline newline
789 \begin_inset Newline newline
792 This is an example of a minipage environment.
794 \begin_inset Newline newline
797 can put nearly everything in it, even (non-floating)
798 \begin_inset Newline newline
803 \begin_inset Newline newline
809 \begin_inset Newline newline
813 \begin_inset Newline newline
819 \begin_inset Newline newline
825 \begin_inset Newline newline
831 \begin_inset Newline newline
836 \begin_inset Newline newline
842 \begin_inset Newline newline
848 \begin_inset Newline newline
854 \begin_inset Newline newline
862 \begin_layout LyX-Code
866 \begin_layout Standard
868 \begin_inset Flex Code
871 \begin_layout Plain Layout
878 box containing this text is directly after this paragraph.
879 Those of you reading the manual in \SpecialChar LyX
880 will only see the \SpecialChar TeX
882 Those reading a printed version of the manuals will see the actual results:
883 \begin_inset VSpace bigskip
889 \begin_layout Standard
893 \begin_layout Plain Layout
900 \begin_layout Plain Layout
907 \begin_layout Plain Layout
909 This is an example of a minipage environment.
910 You can put nearly everything in it, even (non-floating) figures and tables.
914 \begin_layout Plain Layout
921 \begin_layout Plain Layout
926 \begin_layout Plain Layout
933 \begin_layout Plain Layout
940 \begin_layout Plain Layout
947 \begin_layout Plain Layout
953 \begin_layout Plain Layout
960 \begin_layout Plain Layout
967 \begin_layout Plain Layout
974 \begin_layout Plain Layout
984 \begin_inset VSpace bigskip
990 \begin_layout Standard
991 In addition to using \SpecialChar TeX
992 code, you can also create a separate file containing
993 some complex \SpecialChar LaTeX
994 structure and then use
995 \begin_inset Flex Noun
998 \begin_layout Plain Layout
999 Insert\SpecialChar menuseparator
1001 \begin_inset space ~
1009 to include your file (you should select the type
1010 \begin_inset Flex Code
1013 \begin_layout Plain Layout
1020 We recommend that you only do this if you have a
1021 \begin_inset Flex Code
1024 \begin_layout Plain Layout
1035 Otherwise, you'll have a big job tracking down \SpecialChar LaTeX
1039 \begin_layout Standard
1040 There are a few last points to emphasize:
1043 \begin_layout Itemize
1049 check if your \SpecialChar LaTeX
1053 \begin_layout Itemize
1054 Beware of reinventing the wheel.
1057 \begin_layout Standard
1058 On that last point, \SpecialChar LyX
1059 does have quite a few features tucked into it, and
1061 Be sure to check the manuals to make sure that \SpecialChar LyX
1062 doesn't have such-and-such
1063 feature before you decide you have to do it by hand.
1064 Moreover, there are numerous \SpecialChar LaTeX
1065 packages out there to do all sorts of things,
1066 from labels to envelopes to fancy multipage tables.
1068 \change_inserted 244031559 1603815732
1070 \begin_inset CommandInset href
1073 target "https://www.ctan.org/"
1079 \change_deleted 244031559 1603815732
1081 \begin_inset CommandInset href
1084 target "http://www.ctan.org/"
1094 \begin_layout Standard
1095 If you do need to do some wild and fancy things within your document, be
1096 sure to check out a good \SpecialChar LaTeX
1097 book for assistance.
1098 There are a number of them listed in the bibliography of the
1105 \begin_layout Section
1107 and the \SpecialChar LaTeX
1111 \begin_layout Subsection
1112 About the \SpecialChar LaTeX
1116 \begin_layout Standard
1117 If you already know \SpecialChar LaTeX
1118 , there is no need to explain here what the preamble
1120 If you don't, the following will give you some ideas—we recommend again
1121 that you consult a \SpecialChar LaTeX
1122 book for further information.
1123 In any case, you should read the points below, because they explain what
1124 you can do and what you don't need to do in the \SpecialChar LaTeX
1125 preamble of a \SpecialChar LyX
1129 \begin_layout Standard
1130 The \SpecialChar LaTeX
1131 preamble comes at the very beginning of a document,
1139 \begin_layout Itemize
1140 Declare the document class.
1142 \begin_inset Newline newline
1146 already does this for you.
1147 If you're a seasoned \SpecialChar LaTeX
1148 -nician, and you have a custom document class you
1149 want to use, check out the
1151 Customization Manual
1153 for information on how to make \SpecialChar LyX
1157 \begin_layout Itemize
1158 Declare the usage of packages.
1160 \begin_inset Newline newline
1164 packages provide special commands, which are only available within a document
1165 when the package has been declared in the preamble.
1166 In addition to providing special commands, the inclusion of a package can
1167 change the document.
1168 For example, the package
1169 \begin_inset Flex Code
1172 \begin_layout Plain Layout
1178 forces all paragraphs to be indented.
1179 There are other packages for labels, envelopes, margins, etc.
1183 \begin_layout Itemize
1184 Set counters, variables, lengths and widths.
1186 \begin_inset Newline newline
1189 There are several \SpecialChar LaTeX
1190 counters and variables that
1194 be set globally from within the preamble in order to have the desired effect.
1195 (There are variables that you can set and reset inside the document, too.)
1196 Margins are a good example of something that must be set in the preamble.
1197 Another example is the label format for lists.
1198 You can actually set these just about anywhere, but it's best to do it
1199 just once, inside the preamble.
1202 \begin_layout Itemize
1203 Declare user defined commands (with
1204 \begin_inset Flex Code
1207 \begin_layout Plain Layout
1216 \begin_inset Flex Code
1219 \begin_layout Plain Layout
1228 \begin_inset Newline newline
1231 These are abbreviations for \SpecialChar LaTeX
1232 commands which appear very often inside a document.
1233 Although the preamble is a good place to declare such commands, they
1237 be declared anywhere (before they are used for the first time, of course).
1238 This can be useful if there is a lot of raw \SpecialChar LaTeX
1239 code in your document, which
1240 normally should not be the case.
1243 \begin_layout Standard
1245 adds its own set of definitions to the preamble of the
1246 \begin_inset Flex Code
1249 \begin_layout Plain Layout
1256 This makes \SpecialChar LaTeX
1257 files generated by \SpecialChar LyX
1261 \begin_layout Subsection
1262 Changing the Preamble
1265 \begin_layout Standard
1266 The commands which \SpecialChar LyX
1267 adds to the preamble of a \SpecialChar LaTeX
1268 file are fixed; you can't
1269 change them without patching \SpecialChar LyX
1271 You can, however, add your own stuff to the preamble by selecting
1272 \begin_inset Flex Noun
1275 \begin_layout Plain Layout
1278 \begin_inset space ~
1287 \begin_inset Flex Noun
1290 \begin_layout Plain Layout
1291 Document\SpecialChar menuseparator
1299 adds anything in the
1300 \begin_inset Flex Noun
1303 \begin_layout Plain Layout
1309 dialog to its own built-in preamble.
1310 Before adding your own declarations in the preamble, you should make sure
1311 that \SpecialChar LyX
1312 doesn't already support what you want to do.
1313 (Remember what we said about reinventing the wheel?) Also,
1315 make sure your preamble code is correct
1319 doesn't check it for you.
1320 If there is an error, you're likely to get an error like
1321 \begin_inset Quotes eld
1325 \begin_inset Flex Code
1328 \begin_layout Plain Layout
1337 \begin_inset Quotes erd
1341 If you see this error, check your preamble.
1344 \begin_layout Subsection
1348 \begin_layout Standard
1349 Here are some examples of what you can add to a preamble, and what they
1353 \begin_layout Subsubsection
1357 \begin_layout Standard
1358 There are two variables under \SpecialChar LaTeX
1359 that control page position:
1360 \begin_inset Flex Code
1363 \begin_layout Plain Layout
1372 \begin_inset Flex Code
1375 \begin_layout Plain Layout
1384 Their names should be self-explanatory.
1385 These variables are useful if you think for a moment about computer labels.
1386 Sometimes, the size of a print medium and the area of the medium that you
1387 can actually print on aren't the same.
1389 \begin_inset Flex Code
1392 \begin_layout Plain Layout
1401 \begin_inset Flex Code
1404 \begin_layout Plain Layout
1415 \begin_layout Standard
1416 The default values for
1417 \begin_inset Flex Code
1420 \begin_layout Plain Layout
1429 \begin_inset Flex Code
1432 \begin_layout Plain Layout
1441 \begin_inset space \thinspace{}
1445 \begin_inset space \thinspace{}
1449 \begin_inset space \space{}
1452 the page isn't shifted.
1453 Unfortunately, some DVI drivers always seem to shift the page.
1454 We have no idea why, or why the sysadmin hasn't fixed such behavior.
1455 If you're using \SpecialChar LyX
1456 on a system that you don't personally maintain, and your
1457 sysadmin is a doofus,
1458 \begin_inset Flex Code
1461 \begin_layout Plain Layout
1470 \begin_inset Flex Code
1473 \begin_layout Plain Layout
1482 Suppose your left and top margins are always 0.5
1483 \begin_inset space \thinspace{}
1487 You can add this to the preamble:
1490 \begin_layout LyX-Code
1498 \begin_layout LyX-Code
1506 \begin_layout Standard
1507 and your margins should now be correct.
1510 \begin_layout Subsubsection
1514 \begin_layout Standard
1515 Speaking of labels, suppose you wanted to print out a bunch of address labels.
1516 There's a rather nice package, available at your nearest CTAN archive,
1517 for printing sheets of labels:
1518 \begin_inset Flex Code
1521 \begin_layout Plain Layout
1528 Now, your system may not have this package installed by default.
1529 We leave that up to you to check.
1530 You'll also want to read the documentation for it; we're not going to do
1532 Since this is an example, however, we'll give you an example of how you
1536 \begin_layout Standard
1537 First, make sure you're using the
1538 \begin_inset Flex Code
1541 \begin_layout Plain Layout
1548 Next, you need to put the following in your preamble:
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 LyX-Code
1593 \begin_layout Standard
1594 This sets things up for Avery label sheets, stock #5360.
1595 You're now ready to print labels, but you'll need to insert \SpecialChar LaTeX
1598 \begin_inset Flex Code
1601 \begin_layout Plain Layout
1610 \begin_inset Flex Code
1613 \begin_layout Plain Layout
1621 around each label text.
1622 This and other special features of
1623 \begin_inset Flex Code
1626 \begin_layout Plain Layout
1632 are explained in its documentation.
1635 \begin_layout Standard
1636 Someday, someone may write a \SpecialChar LyX
1637 layout file to support this package directly.
1638 Maybe that someone is you.
1641 \begin_layout Subsubsection
1642 Example #3: Paragraph Indentation
1645 \begin_layout Standard
1646 Americans are trained to indent the first line of
1651 As with all of their other weird quirks, most Americans will whine and
1652 moan until they can have their way and indent the first line of all paragraphs.
1661 \begin_layout Standard
1662 Of course, this behavior isn't standard typography.
1663 In books, you typically only indent the first line of a paragraph
1667 it follows another one.
1668 The idea behind indenting the first line of a paragraph is to distinguish
1669 neighboring paragraphs from one another.
1670 If there is no previous paragraph—for example, if it follows a figure or
1671 is the first paragraph in a section—then there is no need for indentation.
1675 \begin_layout Standard
1676 If you're a typical American (we're still joking!), though, you don't care
1677 about such esoteric things; you want your indentation! Add this to the
1681 \begin_layout LyX-Code
1684 usepackage{indentfirst}
1687 \begin_layout Standard
1688 If your \SpecialChar TeX
1689 distribution isn't braindead, you'll have this package, and all
1690 of your paragraphs will get the indentation the Founding Fathers intended
1694 \begin_layout Subsubsection
1695 Example #4: This Document
1698 \begin_layout Standard
1699 You can also check out the preamble of this document to get an idea of some
1700 of the advanced things you can do.
1703 \begin_layout Section
1705 and \SpecialChar LaTeX
1709 \begin_layout Standard
1710 When \SpecialChar LyX
1711 calls \SpecialChar LaTeX
1712 , it tells \SpecialChar LaTeX
1713 to blithely ignore any errors and keep going.
1714 It then uses the logfile from the \SpecialChar LaTeX
1715 run to do a post-mortem.
1716 After analyzing the logfile, \SpecialChar LyX
1717 displays a dialog listing the errors.
1718 Clicking on any one of them will take you to the position in your \SpecialChar LyX
1720 where the error occurred.
1724 \begin_layout Plain Layout
1726 Analyzing the logfile is a tough job, and \SpecialChar LyX
1727 doesn't always go to the right
1729 There are also cases where \SpecialChar LaTeX
1730 reports the error on one line, but the actual
1732 This is not unlike forgetting a closing brace in a program: You'll get
1733 an error, but only later.
1741 \begin_layout Standard
1742 Some folks also like to look at the log file directly: It is available from
1744 \begin_inset Flex Noun
1747 \begin_layout Plain Layout
1748 Document\SpecialChar menuseparator
1750 \begin_inset space ~
1759 There are some fairly common error messages and warnings.
1760 We'll cover those here.
1761 You should look at a good \SpecialChar LaTeX
1762 book for a complete listing.
1765 \begin_layout Itemize
1766 \begin_inset Flex Code
1769 \begin_layout Plain Layout
1776 \begin_inset Newline newline
1779 Anything beginning with these words is a warning message for the purpose
1781 \begin_inset Quotes eld
1785 \begin_inset Quotes erd
1788 the \SpecialChar LaTeX
1790 You'll get messages like this if you added or changed cross-references
1791 or bibliography entries, in which case, \SpecialChar LaTeX
1792 is trying to tell you that you
1793 need to make another run.
1794 You can by-and-large ignore these.
1797 \begin_layout Itemize
1798 \begin_inset Flex Code
1801 \begin_layout Plain Layout
1808 \begin_inset Newline newline
1811 Another warning message, this time about fonts which \SpecialChar LaTeX
1813 The rest of the message will often say something about a replacement font
1814 that \SpecialChar LaTeX
1816 You can safely ignore these, too.
1819 \begin_layout Itemize
1820 \begin_inset Flex Code
1823 \begin_layout Plain Layout
1832 \begin_inset Newline newline
1841 It seems to generate at least one of these messages for just about any
1843 They are warnings about lines that were too long and run past the right
1845 This happens if \SpecialChar LaTeX
1846 does not find a reasonable way to break the lines (notoriously
1847 often with typewriter font, since this does not allow for automatic break
1849 In many cases, this is unnoticeable in the final output.
1850 (It can be just a point or two.) Sometimes, however, the lines run rather
1851 visibly into the margin; something you will not want to have in your final
1854 \begin_inset Newline newline
1857 There are several global ways to try to minimize the overfull lines.
1860 Enable micro-typographic extensions
1864 Document\SpecialChar menuseparator
1865 Settings\SpecialChar menuseparator
1868 might already improve things a lot.
1869 Furthermore, \SpecialChar LaTeX
1870 code such as the following in
1872 Document\SpecialChar menuseparator
1873 Settings\SpecialChar menuseparator
1876 usually reduces the overfull lines drastically (we use this in the preamble
1881 \begin_layout LyX-Code
1885 \begin_inset Newline newline
1891 \begin_inset Newline newline
1896 emergencystretch 1.5em
1897 \begin_inset Newline newline
1905 \begin_layout Standard
1906 In some cases, however, you eventually have to rewrite the text to get the
1907 line breaking right.
1911 \begin_layout Plain Layout
1912 For more information, see
1913 \begin_inset Flex URL
1916 \begin_layout Plain Layout
1918 http://www.tex.ac.uk/FAQ-overfull.html
1931 \begin_layout Standard
1932 In any case, you should check the respective lines, at least for the final
1933 version of your document.
1934 Your eyes will tell you if there's a problem with something that's too
1939 \begin_layout Plain Layout
1940 You can also enable the `draft' option in
1941 \begin_inset Flex Noun
1944 \begin_layout Plain Layout
1945 Document\SpecialChar menuseparator
1951 , and then \SpecialChar LaTeX
1952 will draw a black box in the margin of lines that are overfull.
1961 \begin_layout Itemize
1962 \begin_inset Flex Code
1965 \begin_layout Plain Layout
1974 \begin_inset Newline newline
1977 Not quite as common as its cousin.
1978 This happens again if \SpecialChar LaTeX
1979 does not find a reasonable break point and consequently
1980 generates too loose lines.
1981 As with the overfull lines, you should check if this is a visible problem.
1984 \begin_layout Itemize
1985 \begin_inset Flex Code
1988 \begin_layout Plain Layout
1997 \begin_inset Flex Code
2000 \begin_layout Plain Layout
2009 \begin_inset Newline newline
2012 Warnings about troubles breaking the page.
2013 Once again, just look at the output.
2014 Your eyes will tell you where something has gone wrong.
2017 \begin_layout Itemize
2018 \begin_inset Flex Code
2021 \begin_layout Plain Layout
2023 \begin_inset Quotes els
2027 \begin_inset Quotes ers
2036 \begin_inset Newline newline
2040 \begin_inset Quotes eld
2044 \begin_inset Quotes erd
2047 isn't installed on this system.
2048 This usually appears because some package your document needs isn't installed.
2049 If you didn't touch the preamble or didn't use the
2050 \begin_inset Flex Code
2053 \begin_layout Plain Layout
2061 command, then one of the packages \SpecialChar LyX
2062 tried to load is missing.
2064 \begin_inset Flex Noun
2067 \begin_layout Plain Layout
2068 Help\SpecialChar menuseparator
2075 to get a list of packages that \SpecialChar LyX
2077 This file is updated whenever you reconfigure \SpecialChar LyX
2079 \begin_inset Flex Noun
2082 \begin_layout Plain Layout
2083 Tools\SpecialChar menuseparator
2089 ) and tells you which packages have been detected and what they do.
2090 \begin_inset Newline newline
2094 \begin_inset Flex Code
2097 \begin_layout Plain Layout
2105 command and the package in question isn't installed, then you'll need to
2106 install it yourself.
2109 \begin_layout Itemize
2110 \begin_inset Flex Code
2113 \begin_layout Plain Layout
2114 LaTeX Error: Unknown option
2120 \begin_inset Newline newline
2123 Error messages beginning with this are trying to tell you that you specified
2124 a bad or undefined option to a package.
2125 Check the package's documentation.
2128 \begin_layout Itemize
2129 \begin_inset Flex Code
2132 \begin_layout Plain Layout
2133 Undefined control sequence
2139 \begin_inset Newline newline
2142 If you've inserted \SpecialChar LaTeX
2143 code into your document, but made a typo, you'll get
2145 You may have forgotten to load a package.
2146 In any case, this error message usually means that you used an undefined
2151 \begin_layout Standard
2152 There are other error and warning messages.
2153 Some are self-explanatory.
2154 These are usually \SpecialChar LaTeX
2156 Others are downright cryptic.
2157 These are usually \SpecialChar TeX
2158 error messages, and we really have
2162 what they mean or how to decipher them.
2166 \begin_layout Standard
2167 There's a general sequence you should follow if you get error messages:
2170 \begin_layout Enumerate
2171 Look at the \SpecialChar LaTeX
2172 code you inserted for typos.
2175 \begin_layout Enumerate
2176 If there are no typos, check that you used the command(s) correctly.
2179 \begin_layout Enumerate
2180 If you get a bunch of error boxes piled up at the very top of the document—and
2181 especially if you see a
2182 \begin_inset Quotes eld
2186 \begin_inset Flex Code
2189 \begin_layout Plain Layout
2198 \begin_inset Quotes erd
2201 error—it means that there are errors in the preamble.
2202 Start debugging your preamble.
2205 \begin_layout Enumerate
2206 If you didn't add anything to the preamble and didn't add any \SpecialChar LaTeX
2208 document, the first suspect is your \SpecialChar LaTeX
2209 distribution itself.
2210 Check for missing packages and install them.
2213 \begin_layout Enumerate
2214 Okay, so there are no missing packages.
2215 Did you use any of the fine-tuning options in \SpecialChar LyX
2216 ? Specifically, did you
2220 any of them, like trying to manually insert lots of
2221 \begin_inset Flex Code
2224 \begin_layout Plain Layout
2226 \change_deleted 177693 1654669036
2228 \change_inserted 177693 1654669038
2232 \begin_inset space ~
2236 \change_deleted 177693 1654669040
2238 \change_inserted 177693 1654669041
2247 \begin_inset Flex Code
2250 \begin_layout Plain Layout
2257 \begin_inset Flex Code
2260 \begin_layout Plain Layout
2266 ? Did you try to kludge something together with these instead of using the
2267 appropriate paragraph environment?
2270 \begin_layout Enumerate
2271 All right, you didn't use any of the fine-tuning options, you played by
2273 Did you try to pull a fancy maneuver? Did you do something funky inside
2274 a table or an equation, like inserting a graphic into a table cell?
2277 \begin_layout Enumerate
2278 Do you have long sections of text where \SpecialChar LaTeX
2279 cannot find a place to break a
2280 line? By default, \SpecialChar LaTeX
2281 is rather strict about how much extra inter-word spacing
2282 it will add in order to break a line.
2283 Preferably, you should rework the paragraph to avoid the problem.
2286 \begin_layout Enumerate
2287 Did you go overboard with the nesting? \SpecialChar LyX
2288 (currently) doesn't check to make
2289 sure you're in the limits for nesting environments.
2290 If you nested a bunch of environments to the
2291 \begin_inset Formula $17^{\mathrm{th}}$
2294 level, that's the problem.
2295 (The limit in \SpecialChar LaTeX
2299 \begin_layout Enumerate
2300 Okay, you didn't get any error messages, but your output looks awful.
2301 If you have a table or figure that's too wide or long for the page, you
2306 \begin_layout Enumerate
2307 rescale the figure so it fits.
2310 \begin_layout Enumerate
2311 trim down the table so it fits.
2315 \begin_layout Enumerate
2316 If something else is wrong with the output, and you didn't try to pull anything
2317 fancy or kludge the fine-tuning options, we're not sure what's wrong.
2320 \begin_layout Standard
2321 If all this doesn't help—well, then
2325 you might have found a bug in \SpecialChar LyX
2330 \begin_layout Chapter
2332 \change_inserted 564990737 1672345271
2336 \begin_layout Standard
2338 \change_inserted 564990737 1672345272
2345 , \SpecialChar LaTeX
2346 originally offered four standard document classes, article, report, book
2347 and letter, but individuals and organizations, most notably the American
2348 Mathematical Society in the early days, have made many contributions to
2349 extending the range of document classes.
2350 In this chapter we summarize the main externally maintained classes, some
2351 of which are marked “Unavailable:” in the pull-down
2354 \begin_inset space ~
2368 ocument\SpecialChar menuseparator
2373 ettings\SpecialChar menuseparator
2375 \begin_inset space ~
2380 dialog and which you will need to install as described in the
2382 Installing New Document Classes
2388 manual if you want to use them.
2392 \begin_layout Section
2394 \change_inserted 564990737 1670439533
2395 \begin_inset CommandInset label
2397 name "sec:Collections"
2404 \begin_layout Subsection
2406 \change_inserted 564990737 1672345298
2409 \begin_inset CommandInset label
2411 name "subsec:AMS-LaTeX-(American-Mathematical"
2415 AMS-\SpecialChar LaTeX
2416 (American Mathematical Society)
2419 \begin_layout Standard
2421 \change_inserted 564990737 1672345298
2424 The \SpecialChar LyX
2425 supported document classes
2433 are maintained by the Society; use of their features is described in the
2434 Math manual and on their website
2435 \begin_inset Flex URL
2438 \begin_layout Plain Layout
2440 \change_inserted 564990737 1672345298
2442 http://www.ams.org/publications/authors/tex/amslatex
2450 The following summary was originally provided by
2458 and the \SpecialChar LyX
2462 \change_deleted 564990737 1672345297
2466 AMS \SpecialChar LaTeX
2470 \begin_layout Standard
2472 \change_deleted 564990737 1672345297
2479 Richard Kimberly Heck
2484 \begin_layout Standard
2485 \begin_inset VSpace bigskip
2491 \begin_layout Standard
2493 The AMS \SpecialChar LaTeX
2494 layouts are set up to conform to suggested styles for mathematical
2495 papers to be submitted to American Mathematical Society publications.
2496 The layouts are not tailored to a specific journal, but easily can be.
2497 You should refer to the AMS documentation for specific instructions for
2498 each journal (usually it will entail only changing a single line in the
2501 That documentation is available on the Web at
2502 \begin_inset Flex URL
2505 \begin_layout Plain Layout
2513 \begin_inset Flex URL
2516 \begin_layout Plain Layout
2518 ftp://ftp.ams.org/pub/tex/amslatex/
2524 These layouts are appropriate, and useful, for any mathematical writing.
2528 \begin_layout Standard
2529 There are two basic AMS \SpecialChar LaTeX
2533 \begin_layout Itemize
2534 amsart: The standard AMS article format
2535 \change_inserted 564990737 1672345333
2540 File\SpecialChar menuseparator
2541 Open Example\SpecialChar menuseparator
2542 Articles\SpecialChar menuseparator
2543 American Mathematical Society (AMS)
2551 \begin_layout Itemize
2552 amsbook: the standard AMS book (really, monograph) format
2553 \change_inserted 564990737 1672345366
2558 File\SpecialChar menuseparator
2559 Open Example\SpecialChar menuseparator
2560 Books\SpecialChar menuseparator
2561 American Mathematical Society (AMS)
2567 \change_inserted 564990737 1672345369
2571 \begin_layout Itemize
2573 \change_inserted 564990737 1672345383
2579 : the standard AMS proceedings format.
2582 \begin_layout Standard
2584 \change_inserted 564990737 1672345383
2588 only supports the first two natively; see the
2590 Installing New Document Classes
2596 manual if you want to use
2603 \begin_layout Standard
2604 The layouts themselves contain only the minimum necessary to use the AMS
2606 They do not, in particular, contain any of the `theorem' environments used
2607 for setting theorems, lemmas, and the like.
2608 These are contained, instead, in the
2609 \change_deleted 564990737 1672345416
2611 \begin_inset Flex Code
2614 \begin_layout Plain Layout
2621 \change_inserted 564990737 1672345416
2630 module, which is loaded by default when you select one of the AMS classes.
2631 (It can also be used with other classes and can be removed, if you would
2632 rather use something else.) Less commonly used environments are in the
2633 \change_deleted 564990737 1672345436
2635 \begin_inset Flex Code
2638 \begin_layout Plain Layout
2639 Theorems (AMS-Extended)
2645 \change_inserted 564990737 1672345436
2650 AMS Theorems (Extended)
2655 module, which must be loaded manually.
2658 \begin_layout Standard
2659 By default, theorems and the like are numbered consecutively throughout
2660 the document, but this may be modified by loading the module
2661 \change_deleted 564990737 1672345461
2663 \begin_inset Flex Code
2666 \begin_layout Plain Layout
2667 Theorems (Order by Section)
2673 \change_inserted 564990737 1672345461
2677 Standard Theorems (Numbered by Section)
2682 or, if you are using
2683 \begin_inset Flex Code
2686 \begin_layout Plain Layout
2693 \change_deleted 564990737 1672345479
2695 \begin_inset Flex Code
2698 \begin_layout Plain Layout
2699 Theorems (Order by Chapter)
2705 \change_inserted 564990737 1672345480
2709 Standard Theorems (Numbered by Chapter)
2715 These will number the results as
2716 \begin_inset Formula $n.m$
2719 , where the first number refers to the section (or chapter) and the second
2720 refers to the total number of results so far in that section (or chapter).
2721 Many environments are also available unnumbered.
2722 These are indicated by an asterisk at the end.
2723 If you happen to want
2727 unnumbered results, the module
2728 \change_deleted 564990737 1672345498
2730 \begin_inset Flex Code
2733 \begin_layout Plain Layout
2740 \change_inserted 564990737 1672345498
2744 Standard Theorems (Unnumbered)
2749 provides that option.
2752 \begin_layout Standard
2753 Note that these modules do not
2757 to be used with the AMS classes.
2758 It is perfectly possible to use the
2759 \change_deleted 564990737 1672345520
2761 \begin_inset Flex Code
2764 \begin_layout Plain Layout
2771 \change_inserted 564990737 1672345520
2780 module, and the others mentioned, with other classes, such as
2781 \begin_inset Flex Code
2784 \begin_layout Plain Layout
2791 \begin_inset Flex Code
2794 \begin_layout Plain Layout
2801 \begin_inset Flex Code
2804 \begin_layout Plain Layout
2813 \begin_layout Subsubsection
2814 What these layouts provide
2817 \begin_layout Standard
2818 There is a long list of included environments provided by these layouts.
2819 In AMS-\SpecialChar LaTeX
2820 , there is, in fact, an opportunity to define an unlimited variety
2821 of `theorem' environments.
2822 However, the AMS recommends the environments that are available in \SpecialChar LyX
2827 \begin_layout Standard
2828 The following environments—as well as the standard environments, such as
2830 \begin_inset Flex Noun
2833 \begin_layout Plain Layout
2840 \begin_inset Flex Noun
2843 \begin_layout Plain Layout
2850 \begin_inset Flex Noun
2853 \begin_layout Plain Layout
2860 \begin_inset Flex Noun
2863 \begin_layout Plain Layout
2870 \begin_inset Flex Noun
2873 \begin_layout Plain Layout
2880 \begin_inset Flex Code
2883 \begin_layout Plain Layout
2890 \begin_inset Flex Code
2893 \begin_layout Plain Layout
2902 \begin_layout Description
2903 Address This should be the author's permanent address.
2906 \begin_layout Description
2908 \begin_inset space ~
2911 Address This should be the author's temporary address at the time of submission,
2912 if different from the Address.
2915 \begin_layout Description
2916 Email Author's e-mail address
2919 \begin_layout Description
2920 URL Author's Web address, if desired.
2923 \begin_layout Description
2924 Keywords Key words or phrases used to identify specific topics discussed
2928 \begin_layout Description
2929 Subjectclass These refer to the AMS Subject Classifications, published and
2932 Mathematical Reviews
2935 These are also available online at the AMS cites listed above.
2938 \begin_layout Description
2942 \begin_layout Description
2946 \begin_layout Description
2950 \begin_layout Standard
2951 The following environments are provided by both the
2952 \change_deleted 564990737 1672345566
2954 \begin_inset Flex Code
2957 \begin_layout Plain Layout
2964 \change_inserted 564990737 1672345566
2974 \change_deleted 564990737 1672345580
2976 \begin_inset Flex Code
2979 \begin_layout Plain Layout
2986 \change_inserted 564990737 1672345580
2995 modules, in the latter case in both starred (unnumbered) and unstarred
2996 (numbered) versions.
2997 These same environments are provided only in the starred versions by the
2999 \change_deleted 564990737 1672345596
3001 \begin_inset Flex Code
3004 \begin_layout Plain Layout
3011 \change_inserted 564990737 1672345596
3023 \begin_layout Theorem
3024 This is typically used for the statements of major results.
3028 \begin_layout Corollary*
3029 This is used for statements which follow fairly directly from previous statement
3031 Again, these can be major results.
3036 These are smaller results needed to prove other statements.
3039 \begin_layout Proposition
3040 These are less major results which (hopefully) add to the general theory
3044 \begin_layout Conjecture
3045 These are statements provided without justification, which the author does
3046 not know how to prove, but which seem to be true (to the author, at least).
3049 \begin_layout Definition*
3050 Guess what this is for.
3051 The font is different for this environment than for the previous ones.
3055 \begin_layout Example*
3056 Used for examples illustrating proven results.
3059 \begin_layout Problem
3060 It's not really known what this is for.
3061 You should figure it out.
3064 \begin_layout Exercise*
3065 Write a description for this one.
3068 \begin_layout Remark
3069 This environment is also a type of theorem, usually a lesser sort of observation.
3072 \begin_layout Claim*
3073 Often used in the course of giving a proof of a larger result.
3077 Generally, these are used to break up long arguments, using specific instances
3083 The numbering scheme for cases is on its own, not together with other numbered
3089 At the end of this environment, a QED symbol (usually a square, but it can
3090 vary with different styles) is placed.
3091 If you want to have other environments within this one—for example, Case
3092 environments—and have the QED symbol appear only after them, then the other
3093 environments need to be nested within the proof environment.
3096 Nesting Environments
3102 for information on nesting.
3107 \change_inserted 564990737 1672345651
3108 Used in a way similar to Proposition, though perhaps lower on the scale.
3111 \begin_layout Standard
3112 And these environments are provided by
3113 \change_deleted 564990737 1672345684
3115 \begin_inset Flex Code
3118 \begin_layout Plain Layout
3119 Theorems (AMS-Extended)
3125 \change_inserted 564990737 1672345689
3129 AMS Theorems (Extended
3137 \begin_layout Criterion*
3138 A required condition.
3141 \begin_layout Algorithm*
3142 A general procedure to be used.
3145 \begin_layout Axiom*
3146 This is a property or statement taken as true within the system being discussed.
3149 \begin_layout Condition*
3150 Sometimes used to state a condition assumed within the present context of
3155 Similar to a Remark.
3158 \begin_layout Notation*
3159 Used for the explanation of, yes, notation.
3162 \begin_layout Summary
3163 Do we really need to tell you?
3166 \begin_layout Acknowledgement*
3170 \begin_layout Conclusion*
3171 Sometimes used at the end of a long train of argument.
3172 \change_deleted 564990737 1672345729
3178 \change_deleted 564990737 1672345638
3179 Used in a way similar to Proposition, though perhaps lower on the scale.
3180 \change_inserted 564990737 1672345720
3184 \begin_layout Assumption*
3186 \change_inserted 564990737 1672345721
3192 \begin_layout Question*
3194 \change_inserted 564990737 1672345721
3200 \begin_layout Standard
3202 \change_inserted 564990737 1672345721
3205 There are ten more Maths modules available including several offering options
3208 (Numbered by Type \SpecialChar ldots
3216 \begin_layout Standard
3217 In addition, the AMS classes automatically provide the AMS \SpecialChar LaTeX
3220 They need to be available on your system in order to use these environments.
3223 \begin_layout Subsection
3225 \change_inserted 564990737 1671383236
3228 \begin_inset CommandInset label
3230 name "subsec:Extra-font-sizes"
3237 \begin_layout Standard
3239 \change_inserted 564990737 1671383236
3242 The “Extra font sizes” collection provides the document classes
3245 \begin_inset space \thinspace{}
3248 (with extra font sizes)
3253 \begin_inset space \thinspace{}
3256 (with extra font sizes)
3261 \begin_inset space \thinspace{}
3264 (with extra font sizes)
3269 \begin_inset space \thinspace{}
3272 (with extra font sizes)
3290 document classes respectively but offer the additional
3296 \begin_inset space ~
3301 options 8, 9, 14, 17 and 20 in the
3306 ocument\SpecialChar menuseparator
3311 ettings\SpecialChar menuseparator
3317 \begin_layout Subsection
3319 \change_inserted 564990737 1671383236
3325 \begin_layout Standard
3327 \change_inserted 564990737 1671383236
3330 The document classes
3333 \begin_inset space \thinspace{}
3341 \begin_inset space \thinspace{}
3356 document classes to facilitate the use of Hebrew in \SpecialChar LyX
3360 \begin_layout Subsection
3362 \change_inserted 564990737 1671383236
3365 \begin_inset CommandInset label
3367 name "subsec:Japanese"
3374 \begin_layout Standard
3376 \change_inserted 564990737 1671383236
3379 The document classes
3382 \begin_inset space \thinspace{}
3390 \begin_inset space \thinspace{}
3393 (Japanese Standard Class Vertical Writing)
3398 \begin_inset space \thinspace{}
3401 (Japanese Standard Class)
3406 \begin_inset space \thinspace{}
3414 \begin_inset space \thinspace{}
3417 (Japanese Standard Class Vertical Writing)
3422 \begin_inset space \thinspace{}
3425 (Japanese Standard Class)
3430 \begin_inset space \thinspace{}
3433 (Japanese Vertical Writing)
3438 \begin_inset space \thinspace{}
3441 (Japanese Standard Class)
3443 provide document classes for the Japanese language.
3446 \begin_layout Subsection
3448 \change_inserted 564990737 1672429136
3451 \begin_inset CommandInset label
3453 name "subsec:KOMA-Script"
3460 \begin_layout Standard
3462 \change_inserted 564990737 1672429136
3473 and the \SpecialChar LyX
3475 \change_deleted 564990737 1672429136
3481 \begin_layout Standard
3483 \change_deleted 564990737 1672429136
3491 \begin_layout Subsubsection
3493 \change_inserted 564990737 1672429161
3497 \begin_layout Standard
3499 \change_inserted 564990737 1672429162
3502 The KOMA-Script collection of document classes is a development of the Script
3503 classes created by Frank Neukam in the early 1990s; it was formally launched
3504 with the addition of a letter class in 1994.
3505 Since then, a second letter class has been added.
3506 Frank Neukam's classes were inspired by the principles of typography and
3507 this has been fully integrated into the design of the KOMA-Script classes.
3513 \begin_layout Standard
3514 The \SpecialChar LyX
3517 article (koma-script)
3521 report (koma-script)
3539 correspond to the \SpecialChar LaTeX
3557 \begin_inset space ~
3560 of the Koma-Script family.
3561 They are replacements for the standard document classes
3577 , resp., and fit better to European typography conventions in a number of
3581 \begin_layout Itemize
3583 \change_deleted 564990737 1672429262
3584 Standard character size is
3585 \change_inserted 564990737 1672429263
3588 The base character sizes when you select a KOMA-Script class are
3594 article (koma-script)
3598 report (koma-script)
3603 \change_deleted 564990737 1672429267
3610 letter (koma-script)
3615 \begin_layout Itemize
3616 Headings, labels of the description environment, and a number of elements
3619 letter (koma-script)
3621 document class are set in a bold sans serif font.
3625 \begin_layout Plain Layout
3626 There is a big difference between the bold sans serif old cm fonts and new
3627 ec fonts, especially in the appearance of headings.
3628 In comparison, the ec bold sans serif fonts look a bit thin.
3629 Here the \SpecialChar LaTeX
3638 helps to produce the
3639 \begin_inset Quotes eld
3643 \begin_inset Quotes erd
3646 appearance when using the ec fonts.
3651 The numbering of chapter headings is made in the same way as the numbering
3652 of section headings, that is without the extra line
3653 \begin_inset Quotes eld
3656 Chapter\SpecialChar ldots
3658 \begin_inset Quotes erd
3662 In addition, the appearance of the headings can be modified by using a
3663 number of options (in \SpecialChar LyX
3664 to be entered in the field
3667 \begin_inset space ~
3674 Layout\SpecialChar menuseparator
3681 \begin_layout Itemize
3683 \change_deleted 564990737 1672429310
3684 The main means in the Koma-Script document classes to design the type area
3693 (in \SpecialChar LyX
3694 to be entered in the extra class options field in the dialog
3696 Document\SpecialChar menuseparator
3700 They make a clearer modification of page margins possible as do the options
3703 Document\SpecialChar menuseparator
3708 \change_inserted 564990737 1672429310
3711 The layout of a KOMA-Script page follows one of two traditional typesetting
3712 conventions based on dividing the page into strips or drawing a circle.
3713 The default is to imagine that a page is divided horizontally and vertically
3714 into strips and allocate strips to the margins leaving the unused strips
3716 You can change the sizes of the margins by changing the factor by which
3717 the page is divided into strips; the default for an A4 page is 9 and increasing
3718 this factor will produce increasingly narrower strips and therefore narrower
3724 \begin_layout Standard
3726 \change_inserted 564990737 1672429310
3729 Whatever the factor, two strips are allocated to the outer and bottom margins
3730 of a two-sided document and one strip to the inner and top margins, leaving
3731 a text area occupying around half the page.
3732 Since most two-sided documents have a binding, this can make the inner
3733 margins appear too narrow; so you can apply a binding correction to the
3734 page which is deducted before the size of the strips is calculated.
3738 \begin_layout Standard
3740 \change_inserted 564990737 1672429310
3743 The main means in the Koma-Script document classes to design the type area
3754 Document\SpecialChar menuseparator
3755 Settings\SpecialChar menuseparator
3756 Document Class\SpecialChar menuseparator
3757 Class Options\SpecialChar menuseparator
3764 \begin_layout Standard
3766 \change_inserted 564990737 1672429310
3769 In this document, the binding correction is 7.5mm which is added in the form
3777 \begin_inset space ~
3780 options\SpecialChar menuseparator
3788 To change the factor to 11, for example, add the entry
3792 to the comma separated list of entries in the
3803 \begin_inset space ~
3809 If you want the default value of this factor for a page size other than
3817 \begin_layout Standard
3819 \change_inserted 564990737 1672429310
3822 To use the circle method of calculating the page layout, use
3832 \begin_layout Itemize
3833 The \SpecialChar LaTeX
3834 document classes of the Koma-Script family define a number of additional
3836 Those part of it which makes sense in \SpecialChar LyX
3837 is implemented in corresponding
3841 \begin_layout Standard
3842 Detailed descriptions of the \SpecialChar LaTeX
3843 document classes of the Koma-Script family
3844 can be found in the Koma-Script documentation
3855 \begin_layout Subsubsection
3857 \change_inserted 564990737 1672429358
3861 \begin_inset CommandInset label
3863 name "subsec:article-(KOMA-Script),-report"
3869 article (KOMA-Script), report (KOMA-Script), and book (KOMA-Script)
3870 \change_deleted 564990737 1672429367
3873 article (koma-script), report (koma-script), and book (koma-script)
3878 \begin_layout Standard
3879 The document classes
3881 article (koma-script)
3885 report (koma-script)
3895 are implemented in the layout files
3908 They contain all the paragraph types of the corresponding standard document
3921 , resp., partly modified, with the exception of the \SpecialChar LyX
3926 -type, which is replaced by the new
3930 -type having the same functionality.
3935 -Type there is a number of new paragraph types added.
3942 letter (koma-script)
3947 \begin_layout Itemize
3956 : are equivalents to
3964 , resp., additionally inserting an entry in the table of contents.
3973 are not contained in
3975 article (koma-script)
3980 \begin_layout Itemize
3997 , resp., additionally clearing running heads.
4004 article (koma-script)
4010 \begin_layout Plain Layout
4023 report (koma-script)
4025 , but since this is identical to
4029 , is has not been implemented in \SpecialChar LyX
4038 \begin_layout Itemize
4043 : generates a heading directly above the following paragraph in the standard
4044 character size without affecting the structure of the document.
4047 \begin_layout Itemize
4056 are special captions which respect the different space settings needed
4057 for captions placed above or below an element (if you follow strict typographic
4058 rules, you might want to place table captions always above the table).
4059 You can also use the class option
4076 You need at least Koma-Script version 2.8q to use this.
4079 \begin_layout Itemize
4084 : can be used to set a bonmot, e.
4085 \begin_inset space \thinspace{}
4089 \begin_inset space \space{}
4092 at the beginning of a chapter.
4093 If you use the optional argument (
4095 Insert\SpecialChar menuseparator
4097 \begin_inset space ~
4102 ), you can insert the dictum's author there.
4103 Dictum and author are separated by a line.
4104 You need at least Koma-Script version 2.8q to use this.
4111 article (koma-script)
4116 \begin_layout Standard
4117 The following types, together with the standard types
4129 , form the title area of the document.
4130 They must be entered ahead of the first
4131 \begin_inset Quotes eld
4135 \begin_inset Quotes erd
4142 \begin_layout Plain Layout
4143 The corresponding \SpecialChar LaTeX
4144 commands must appear before the
4155 When such a type is used more than once, the latter usage overwrites the
4156 former one, that means, for every type only the latest usage is valid.
4157 The order of the different types however has, like
4169 , no effect on the appearance of the produced document.
4172 \begin_layout Itemize
4177 : produces a centered paragraph above the ordinary title (
4189 ) for the subject of the document.
4192 \begin_layout Itemize
4197 : produces a centered paragraph below the ordinary title (
4209 ) for the publishers' name.
4212 \begin_layout Itemize
4219 report (koma-script)
4225 produces a centered paragraph on its own page behind the title page, or
4228 article (koma-script)
4230 produces a centered paragraph below the ordinary title (
4249 \begin_layout Itemize
4254 : produces a left aligned paragraph above the ordinary title (
4270 ) for a document`s head.
4273 \begin_layout Itemize
4278 : produces in a double-sided print in
4280 report (koma-script)
4286 a left-aligned paragraph at the top of the title page`s back or has no
4287 effect in a single-sided print or in
4289 article (koma-script)
4294 \begin_layout Itemize
4299 : produces in a double-sided print in
4301 report (koma-script)
4307 a left-aligned paragraph at the bottom of the title page`s back or has
4308 no effect in a single-sided print or in
4310 article (koma-script)
4315 \begin_layout Itemize
4320 : produces a special
4321 \begin_inset Quotes eld
4325 \begin_inset Quotes erd
4328 page ahead of the actual document containing a paragraph without special
4332 \begin_layout Standard
4334 \change_inserted 564990737 1672429680
4337 KOMA-Script offers a wide range of
4344 \begin_inset space ~
4354 ocument\SpecialChar menuseparator
4359 ettings\SpecialChar menuseparator
4361 \begin_inset space ~
4366 dialog which you can apply to the whole document, among them
4369 \begin_layout Description
4371 \change_inserted 564990737 1672429680
4379 which produces a PDF with a small black box at the end any line in which
4380 a formatting error occurs; the default setting is
4385 \begin_layout Description
4387 \change_inserted 564990737 1672429680
4395 which may take the values
4407 ; the first and last adjust the sizes of the headings to take account of
4408 page sizes where the default values may not be suitable
4411 \begin_layout Description
4413 \change_inserted 564990737 1672429680
4421 which may take the values
4433 ; the first leaves it up to KOMA-Script to add periods after chapter, section
4434 numbers, etc.; the second forces the addition of periods and third suppresses
4438 \begin_layout Standard
4440 \change_inserted 564990737 1672429680
4443 and the math options:
4446 \begin_layout Description
4448 \change_inserted 564990737 1672429680
4456 which causes equations to be numbered on the left rather than on the right,
4460 \begin_layout Description
4462 \change_inserted 564990737 1672429680
4470 which causes equations to be left justified rather than centered.
4473 \begin_layout Standard
4475 \change_inserted 564990737 1672429680
4478 It also provides commands to affect the output of the document independently
4479 of the standard \SpecialChar LaTeX
4480 commands and packages; for example, if you want your captions
4484 \begin_layout Standard
4486 \change_inserted 564990737 1672429680
4492 setkomafont{captionlabel}{
4497 \begin_layout Standard
4499 \change_inserted 564990737 1672429680
4507 ocument\SpecialChar menuseparator
4514 \SpecialChar menuseparator
4519 \begin_inset space ~
4524 ) and the problem is solved.
4527 \begin_layout Standard
4529 \change_inserted 564990737 1672429680
4532 If you are writing a book, it is normal to have the preliminary pages numbered
4533 in Roman numerals and the Chapters in this part unnumbered.
4534 If you use the Chapter* environment, your Foreword and Preface will not
4535 appear in the Table of Contents; to make them to appear in the Table of
4536 contents, you need to use Chapter environments and add the \SpecialChar TeX
4540 \begin_layout Standard
4542 \change_inserted 564990737 1672429680
4551 \begin_layout Standard
4553 \change_inserted 564990737 1672429680
4556 at the very start of the book (not in the \SpecialChar LaTeX
4560 \begin_layout Standard
4562 \change_inserted 564990737 1672429680
4571 \begin_layout Standard
4573 \change_inserted 564990737 1672429680
4576 before the first chapter of the body of the text.
4577 You may also want to have some unnumbered Chapter environments at the end
4578 of the book after the Appendices, if any.
4582 \begin_layout Plain Layout
4584 \change_inserted 564990737 1672429680
4587 Appendices are normally “numbered” with letters.
4592 If you use the Chapter* environment, they will not appear in the Table
4593 of Contents; so add the \SpecialChar TeX
4597 \begin_layout Standard
4599 \change_inserted 564990737 1672429680
4608 \begin_layout Standard
4610 \change_inserted 564990737 1672429682
4613 before the first of these headings and use the Chapter environment.
4614 These commands will have no effect on the numbering in \SpecialChar LyX
4616 output where the headings will be unnumbered and appear in the Table of
4620 \begin_layout Standard
4621 The layout files for the document classes
4623 article (koma-script)
4627 report (koma-script)
4638 This is thought of as a place to define your own types.
4643 in your personal layout directory and edit the file!
4644 \change_deleted 564990737 1672430255
4648 \begin_layout Standard
4650 \change_deleted 564990737 1672430255
4651 letter (koma-script)
4654 \begin_layout Description
4656 \change_deleted 564990737 1672429749
4657 Note: This section discusses the obsolete
4659 KOMA-Script-Letter (v.
4660 \begin_inset space ~
4665 , which is not even included anymore in recent KOMA releases.
4666 Please refer to the next section for the current KOMA-Script-Letter class
4668 \begin_inset space ~
4674 \begin_layout Standard
4677 \change_deleted 564990737 1672429749
4680 letter (koma-script)
4682 is implemented in the layout file
4687 It contains all the paragraph types of the corresponding standard document
4692 , partly modified, with the exception of the \SpecialChar LyX
4706 type, which is replaced by the new
4711 In addition, it contains, in contrast to the standard document class, the
4730 Furthermore, there are a number of new letter specific types.
4733 \begin_layout Standard
4735 \change_deleted 564990737 1672429749
4736 The appearance of the letter produced by this document class can be controlled
4737 by a number of \SpecialChar LaTeX
4738 commands, which you can put in the \SpecialChar LaTeX
4743 \begin_layout Plain Layout
4744 For example, the standard appearance of the letter`s heading, consisting
4745 of name and address, is quite self-willed.
4747 \begin_inset Quotes eld
4751 \begin_inset Quotes erd
4754 heading is produced by the following \SpecialChar LaTeX
4755 commands in the preamble:
4758 \begin_layout LyX-Code
4768 \begin_layout LyX-Code
4784 \begin_layout LyX-Code
4794 \begin_layout LyX-Code
4814 A detailed German description of such \SpecialChar LaTeX
4815 commands can be found in the Koma-Script
4821 With it, the letter's author can produce his personal letter layout.
4824 \begin_layout Standard
4826 \change_deleted 564990737 1672429749
4835 define the beginning of the letter and must be used in every letter.
4836 To emphasize them in the \SpecialChar LyX
4837 document class, they are marked with the letter
4847 \begin_inset space ~
4851 It is possible to write any number of letters in one file.
4856 type produces a new letter using the same addressee and a
4860 type produces a new addressee.
4877 are ordinary paragraph types and can also be used several times in one
4878 and the same letter.
4881 \begin_layout Itemize
4883 \change_deleted 564990737 1672429749
4888 : produces a paragraph for the addressee and implicitly defines the beginning
4892 \begin_layout Itemize
4894 \change_deleted 564990737 1672429749
4899 : produces a paragraph for the form of address and implicitly produces a
4903 \begin_layout Itemize
4905 \change_deleted 564990737 1672429749
4910 : produces a paragraph for a close.
4913 \begin_layout Itemize
4915 \change_deleted 564990737 1672429749
4920 : produces a paragraph for a postscript.
4923 \begin_layout Itemize
4925 \change_deleted 564990737 1672429749
4930 : produces a paragraph for a distribution list.
4933 \begin_layout Itemize
4935 \change_deleted 564990737 1672429749
4940 : produces a paragraph for enclosures.
4943 \begin_layout Standard
4945 \change_deleted 564990737 1672429749
4986 are input types provided with a label to enter information, which will
4987 be processed by the document class.
4991 \begin_layout Plain Layout
4992 It could be seen as a matter of inconsequence, that the types
5000 described above are not such input types as well.
5001 Because of the special meaning of those types, however, I have implemented
5002 them as ordinary paragraph types with a one letter mark in the left margin.
5003 Moreover, it would affect my feeling of symmetry, if the
5011 type had such a serious different appearance.
5016 The types must be used ahead of the corresponding
5023 \begin_layout Standard
5025 \change_deleted 564990737 1672429749
5026 An implementation of these types in a WYSIWYG fashion does not seem to make
5027 sense, because the real appearance of the produced letter does not only
5028 depend on the usage of the particular type, but also on other factors.
5029 For example, a signature entered in the
5033 type will in the standard behavior appear in the produced letter only,
5034 when in the same letter also a
5039 The entered value of the
5043 type will in the standard behavior not appear in the produced letter at
5045 The possibility to design the letter`s heading freely is already indicated
5046 in a footnote above.
5049 \begin_layout Standard
5051 \change_deleted 564990737 1672429749
5052 The input types can also be used as empty paragraphs.
5054 \begin_inset space \thinspace{}
5058 \begin_inset space \space{}
5070 type is not used at all, in the standard behavior the value of the
5074 type is used as signature, whereas if an empty
5078 type is used, no signature value is defined.
5081 \begin_layout Standard
5083 \change_deleted 564990737 1672429749
5084 By using the input types it is possible to write a letter template, containing
5085 filled input types with your personal dates (name, address, etc.) and empty
5086 input types for other dates you want to enter.
5089 \begin_layout Itemize
5091 \change_deleted 564990737 1672429749
5096 : sender's name, in the standard behavior appears as a centered paragraph
5097 in small caps in the letter`s heading.
5100 \begin_layout Itemize
5102 \change_deleted 564990737 1672429749
5107 : sender's signature, in the standard behavior appears below the
5116 type is used, the value of the
5120 type appears instead.
5123 \begin_layout Itemize
5125 \change_deleted 564990737 1672429749
5130 : sender's address, in the standard behavior appears in a centered paragraph
5131 in the letter`s heading below the sender's name.
5134 \begin_layout Itemize
5136 \change_deleted 564990737 1672429749
5141 : sender's telephone number, in the standard behavior only sets the \SpecialChar LaTeX
5152 \begin_layout Itemize
5154 \change_deleted 564990737 1672429749
5159 : place of the letter`s making.
5162 \begin_layout Itemize
5164 \change_deleted 564990737 1672429749
5169 : date of the letter`s making.
5178 , in the standard behavior, produce the place and the date in a right-aligned
5179 line below the addressee's field.
5184 type is used, neither place nor date appear, independent of the value of
5194 type is used, the date of the letter `s production is used.
5197 \begin_layout Itemize
5199 \change_deleted 564990737 1672429749
5204 : sender`s back address, in the standard behavior appears above the addressee's
5205 field in a small sans serif font.
5208 \begin_layout Itemize
5210 \change_deleted 564990737 1672429749
5215 : special mail information, in the standard behavior appears underlined
5216 above the addressee's field below the back address.
5219 \begin_layout Itemize
5221 \change_deleted 564990737 1672429749
5226 : additional information, in the standard behavior appears on right side
5227 below the addressee`s field.
5230 \begin_layout Itemize
5232 \change_deleted 564990737 1672429749
5237 : the letter's title, in the standard behavior appears in a big, bold, sans
5238 serif font above the subject.
5241 \begin_layout Itemize
5243 \change_deleted 564990737 1672429749
5248 : the letter's subject, in the standard behavior appears in a bold font
5256 \begin_layout Standard
5258 \change_deleted 564990737 1672429749
5279 produce a business letter like line above the
5283 line containing the fields
5284 \begin_inset Quotes eld
5288 \begin_inset Quotes erd
5292 \begin_inset Quotes eld
5296 \begin_inset Quotes erd
5300 \begin_inset Quotes eld
5304 \begin_inset Quotes erd
5308 \begin_inset Quotes eld
5312 \begin_inset Quotes erd
5316 \begin_inset Quotes eld
5320 \begin_inset Quotes erd
5324 \begin_inset Quotes eld
5328 \begin_inset Quotes erd
5332 For the date field, the value of the
5338 \begin_inset Quotes eld
5341 business letter types
5342 \begin_inset Quotes erd
5345 is used, the value of the
5349 type however does not appear, but only the \SpecialChar LaTeX
5357 The ordinary output of place and date in a right-aligned line below the
5358 addressee`s field is suppressed.
5359 The types are implemented as input types provided with a label and must
5360 be used ahead of the corresponding
5367 \begin_layout Itemize
5369 \change_deleted 564990737 1672429749
5377 \begin_layout Itemize
5379 \change_deleted 564990737 1672429749
5387 \begin_layout Itemize
5389 \change_deleted 564990737 1672429749
5397 \begin_layout Itemize
5399 \change_deleted 564990737 1672429749
5407 \begin_layout Itemize
5409 \change_deleted 564990737 1672429749
5419 \begin_layout Subsubsection
5421 \change_deleted 564990737 1672429773
5422 The new letter class: letter (koma-script v.2)
5423 \change_inserted 564990737 1672429774
5427 \begin_inset CommandInset label
5429 name "subsec:The-new-letter"
5433 The new letter class: letter (KOMA-Script v.2)
5438 \begin_layout Standard
5444 \begin_layout Standard
5445 \begin_inset VSpace medskip
5451 \begin_layout Standard
5453 Koma-Script version 2.8 has introduced a new letter class
5457 which supersedes the now unsupported
5462 It has — on the \SpecialChar LaTeX
5463 side — a completely new interface and is not compatible
5465 Therefore, \SpecialChar LyX
5466 supports both, though it is recommended you use the new class.
5469 \begin_layout Standard
5470 This class covers the same functionality as
5472 letter (koma-script),
5479 (receiver's address, same as
5496 will start a new letter (i.
5497 \begin_inset space \thinspace{}
5501 \begin_inset space \space{}
5504 you can write several letters per document).
5505 New elements are sender's
5521 and the possibility to use a
5527 Insert\SpecialChar menuseparator
5533 \begin_layout Standard
5534 The biggest improvement is, though, that the letter's layout is configurable
5535 to meet almost any needs.
5536 This can be done via the preamble or with a special style file (Letter
5537 Class Option, extension
5541 ), that will be read in as a class option.
5545 \begin_layout Plain Layout
5546 The KOMA package comes with some default
5551 There is, for instance, a
5555 file that follows german typesetting rules, or a
5559 that provides the default layout of the old
5564 The latter can be loaded with the class option
5570 Layout\SpecialChar menuseparator
5571 Document\SpecialChar menuseparator
5580 \change_deleted 564990737 1671617922
5588 \change_deleted 564990737 1671617938
5589 that is included in \SpecialChar LyX
5591 \change_inserted 564990737 1671617997
5598 ile\SpecialChar menuseparator
5600 \begin_inset space ~
5608 \begin_inset space ~
5611 Template\SpecialChar menuseparator
5614 \SpecialChar menuseparator
5615 KOMA-Script Letter (V.2)
5620 A detailed description is to be found in the Koma-Script documentation
5628 \begin_layout Subsubsection
5632 \begin_layout Standard
5633 Visualizing the Koma-Script document classes in \SpecialChar LyX
5634 , the \SpecialChar LyX
5635 internals cause some
5639 \begin_layout Itemize
5640 The chapter number of a
5644 type appears on a line of its own above the chapter heading instead of
5645 appearing in the same line ahead of it.
5646 The cause for that is the \SpecialChar LyX
5647 internal behavior for the labeltype
5654 \begin_layout Itemize
5655 The headings of the types
5664 \begin_inset Quotes eld
5668 \begin_inset Quotes erd
5672 table of contents, but not in the \SpecialChar LyX
5675 Document\SpecialChar menuseparator
5677 \begin_inset space ~
5681 \begin_inset space ~
5689 \begin_layout Itemize
5694 document class appear in a skip separation mode, not indented.
5695 This is the standard behavior, no special \SpecialChar LaTeX
5696 commands are needed for that.
5699 Document\SpecialChar menuseparator
5702 dialog the corresponding radio button indicates
5711 value always has the effect that extra \SpecialChar LaTeX
5712 commands are inserted in the document
5713 to produce the gap, which is not what is wanted in this case.
5716 \begin_layout Subsection
5718 \change_inserted 564990737 1672743555
5719 \begin_inset CommandInset label
5721 name "subsec:Polish-M.W.collection"
5726 \begin_inset space \thinspace{}
5730 \begin_inset space \space{}
5734 \change_deleted 564990737 1670924933
5735 Article (mwart), book (mwbk) and report (mwrep)
5736 \begin_inset Argument status
5739 \begin_layout Plain Layout
5754 \begin_layout Standard
5760 \begin_layout Standard
5761 The \SpecialChar LyX
5778 correspond to the \SpecialChar LaTeX
5792 They are replacements for the standard document classes
5804 , resp., and fit better to Polish typography conventions in a number of points.
5808 \begin_layout Standard
5812 \begin_layout Itemize
5813 Unnumbered titles (with star, e.
5814 \begin_inset space \thinspace{}
5818 \begin_inset space \space{}
5825 ) are added into table of contents,
5828 \begin_layout Itemize
5829 Additional page styles:
5833 \begin_layout Description
5834 uheadings header with separated lines,
5837 \begin_layout Description
5838 myheadings custom header, contents headers via commands:
5853 \begin_layout Description
5854 myuheadings custom header with separated lines,
5857 \begin_layout Description
5858 outer page number is placed on outer side of page
5862 \begin_layout Itemize
5867 \begin_layout Description
5868 rmheadings serif titles — default,
5871 \begin_layout Description
5872 sfheadings sansserif titles,
5875 \begin_layout Description
5876 authortitle on title page first placed is author next title — default,
5879 \begin_layout Description
5880 titleauthor on title page first placed is title next author,
5883 \begin_layout Description
5884 withmarginpar reserve place on page for margins.
5888 \begin_layout Subsection
5890 \change_inserted 564990737 1672652245
5896 \begin_layout Standard
5898 \change_inserted 564990737 1672652245
5901 The document classes
5904 \begin_inset space \thinspace{}
5912 \begin_inset space \thinspace{}
5926 Detailed information about these document classes can be found in
5928 File\SpecialChar menuseparator
5929 Open Example\SpecialChar menuseparator
5930 Books\SpecialChar menuseparator
5935 File\SpecialChar menuseparator
5936 Open Example\SpecialChar menuseparator
5937 Handouts\SpecialChar menuseparator
5943 \begin_layout Section
5945 \change_inserted 564990737 1670439534
5949 \begin_layout Standard
5951 \change_inserted 564990737 1670794710
5952 See also the document classes in the Collections (section
5953 \begin_inset space ~
5957 \begin_inset CommandInset ref
5959 reference "sec:Collections"
5966 \begin_layout Subsection
5968 \change_inserted 564990737 1670794716
5974 \begin_layout Standard
5976 \change_inserted 564990737 1670794716
5983 ; updated by the \SpecialChar LyX
5987 \begin_layout Subsubsection
5989 \change_inserted 564990737 1670794716
5995 \begin_layout Standard
5997 \change_inserted 564990737 1670794716
6000 This section describes how \SpecialChar LyX
6001 can be used to write articles for submission
6002 to the scientific journal
6004 Astronomy and Astrophysics
6007 \begin_inset CommandInset href
6010 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
6015 ) using Version 9.1 of the document class
6019 ; information about it is available at
6020 \begin_inset Flex URL
6023 \begin_layout Plain Layout
6025 \change_inserted 564990737 1670794716
6027 https://www.aanda.org/for-authors/latex-issues/texnical-background-information
6037 \begin_layout Standard
6039 \change_inserted 564990737 1670794716
6042 A manual comes together with the package and should be consulted before
6043 installing this document class as described in the
6045 Installing New Document Classe
6055 \begin_layout Standard
6057 \change_inserted 564990737 1670794716
6060 \begin_inset Note Greyedout
6063 \begin_layout Plain Layout
6065 \change_inserted 564990737 1670794716
6068 Please note that the publisher of the journal was changed from Springer
6069 to EDP Sciences starting January 1, 2001.
6070 That change also involved some slight changes to the style files, namely
6071 the removal of the thesaurus command.
6072 If you have an older version installed, please upgrade.
6073 For information about compatibility with the old (version 4) layout, please
6074 refer to the comments in
6077 Dir/layouts/aapaper.layout
6087 \begin_layout Subsubsection
6089 \change_inserted 564990737 1670794716
6095 \begin_layout Standard
6097 \change_inserted 564990737 1671617129
6100 It is recommended you start from the template in the menu
6105 ile\SpecialChar menuseparator
6107 \begin_inset space ~
6115 \begin_inset space ~
6120 \SpecialChar menuseparator
6121 Articles\SpecialChar menuseparator
6122 Astronomy & Astrophysics
6126 If you are not using the template, note the following settings:
6129 \begin_layout Itemize
6131 \change_inserted 564990737 1670794716
6143 ocument\SpecialChar menuseparator
6148 ettings\SpecialChar menuseparator
6150 \begin_inset space ~
6155 dialog (OK, that one was obvious).
6158 \begin_layout Itemize
6160 \change_inserted 564990737 1670794716
6166 \begin_inset space ~
6178 \begin_inset space ~
6183 dialog: leave it set to
6188 The whole layout is done by the macros, you shouldn't change anything.
6191 \begin_layout Subsubsection
6193 \change_inserted 564990737 1670794716
6199 \begin_layout Standard
6201 \change_inserted 564990737 1670794716
6204 First thing to enter is the header information.
6205 It consists of five entries, of which one is optional.
6209 \begin_layout Itemize
6211 \change_inserted 564990737 1670794716
6220 \begin_layout Itemize
6222 \change_inserted 564990737 1670794716
6231 \begin_layout Itemize
6233 \change_inserted 564990737 1670794716
6242 \begin_layout Itemize
6244 \change_inserted 564990737 1670794716
6253 \begin_layout Itemize
6255 \change_inserted 564990737 1670794716
6264 Received: <date>; Accepted <date>
6267 \begin_layout Standard
6269 \change_inserted 564990737 1670794716
6272 Although the order of the single header entries doesn't matter it is advised
6273 to keep the above sequence, just to get the best optics and meets the layout
6274 of the real document.
6277 \begin_layout Standard
6279 \change_inserted 564990737 1670794716
6282 If you want to place footnotes in the header block, e.
6283 \begin_inset space \thinspace{}
6287 \begin_inset space \space{}
6290 to state your present address, just use the standard footnote via the menu
6296 nsert\SpecialChar menuseparator
6305 will automagically use the term
6314 \begin_layout Standard
6316 \change_inserted 564990737 1670794716
6319 In addition to these topics, the macros use three additional \SpecialChar LaTeX
6321 have no counterpart in \SpecialChar LyX
6325 \begin_layout Itemize
6327 \change_inserted 564990737 1670794716
6335 to separate different names for more than one author and institute, respectivel
6339 \begin_layout Itemize
6341 \change_inserted 564990737 1670794716
6349 to mark corresponding author/institute pairs.
6350 The institutes are numbered sequentially as they appear in the
6354 field, so you have to put a marker to each author.
6357 \begin_layout Itemize
6359 \change_inserted 564990737 1670794716
6367 to supply an email address for fast contact.
6370 \begin_layout Standard
6372 \change_inserted 564990737 1671642374
6375 In all cases, the appropriate command has to be entered as \SpecialChar TeX
6376 code in \SpecialChar LyX
6378 See the examples in the template and in
6381 File\SpecialChar menuseparator
6382 Open Example\SpecialChar menuseparator
6383 Articles\SpecialChar menuseparator
6384 Astronomy & Astrophysics
6392 \begin_layout Subsubsection
6394 \change_inserted 564990737 1670794716
6400 \begin_layout Standard
6402 \change_inserted 564990737 1670794716
6405 The abstract should immediately follow the header block and must contain
6415 \begin_layout Enumerate
6417 \change_inserted 564990737 1670794716
6423 (optional) {} leave it empty if necessary
6426 \begin_layout Enumerate
6428 \change_inserted 564990737 1670794716
6437 \begin_layout Enumerate
6439 \change_inserted 564990737 1670794716
6448 \begin_layout Enumerate
6450 \change_inserted 564990737 1670794716
6459 \begin_layout Enumerate
6461 \change_inserted 564990737 1670794716
6467 (optional) {} leave it empty if necessary
6470 \begin_layout Standard
6472 \change_inserted 564990737 1670794716
6476 This structure not shown in
6483 \begin_layout Subsubsection
6485 \change_inserted 564990737 1670794716
6488 Supported environments
6491 \begin_layout Standard
6493 \change_inserted 564990737 1670794716
6496 The A&A paper layout supports the following environments for structuring
6500 \begin_layout Itemize
6502 \change_inserted 564990737 1670794716
6509 \begin_layout Itemize
6511 \change_inserted 564990737 1670794716
6518 \begin_layout Itemize
6520 \change_inserted 564990737 1670794716
6527 \begin_layout Itemize
6529 \change_inserted 564990737 1670794716
6536 \begin_layout Itemize
6538 \change_inserted 564990737 1670794716
6545 \begin_layout Itemize
6547 \change_inserted 564990737 1670794716
6554 \begin_layout Itemize
6556 \change_inserted 564990737 1670794716
6563 \begin_layout Itemize
6565 \change_inserted 564990737 1670794716
6572 \begin_layout Itemize
6574 \change_inserted 564990737 1670794716
6581 \begin_layout Itemize
6583 \change_inserted 564990737 1670794716
6590 \begin_layout Itemize
6592 \change_inserted 564990737 1670794716
6599 \begin_layout Itemize
6601 \change_inserted 564990737 1670794716
6609 \begin_layout Subsubsection
6611 \change_inserted 564990737 1670794716
6614 Commands not supported by \SpecialChar LyX
6618 \begin_layout Standard
6620 \change_inserted 564990737 1670794716
6623 Some commands are not yet supported by the
6627 layout for \SpecialChar LyX
6629 Some have already been mentioned.
6630 For the sake of completeness, they are listed all together here:
6633 \begin_layout Itemize
6635 \change_inserted 564990737 1670794716
6644 \begin_layout Itemize
6646 \change_inserted 564990737 1670794716
6655 \begin_layout Itemize
6657 \change_inserted 564990737 1670794716
6666 \begin_layout Itemize
6668 \change_inserted 564990737 1670794716
6677 \begin_layout Itemize
6679 \change_inserted 564990737 1670794716
6688 \begin_layout Standard
6690 \change_inserted 564990737 1670794716
6693 If you want to use any of these commands, you have to enter them yourself.
6696 Do not forget to use
6702 nsert\SpecialChar menuseparator
6705 \begin_inset space ~
6714 \begin_layout Subsubsection
6716 \change_inserted 564990737 1670794716
6719 Figure and Table Floats
6722 \begin_layout Standard
6724 \change_inserted 564990737 1670794716
6728 provides support for the necessary float environments
6730 figure, figure*, table
6736 , therefore we won't tell much about it here.
6740 \begin_inset space ~
6746 Just remember that tables should be left-aligned.
6747 For that, select the table and change the alignment in
6752 dit\SpecialChar menuseparator
6758 \begin_inset space ~
6764 \begin_layout Standard
6766 \change_inserted 564990737 1670794716
6769 There is only one special thing: the figures with a caption beside the figure.
6770 To create such a figure, you have to do the following:
6773 \begin_layout Enumerate
6775 \change_inserted 564990737 1670794716
6778 Create a wide figure float:
6783 nsert\SpecialChar menuseparator
6788 t\SpecialChar menuseparator
6791 , then, from within the float, use the menu
6796 dit\SpecialChar menuseparator
6802 \begin_inset space ~
6813 \begin_inset space ~
6825 \begin_layout Enumerate
6827 \change_inserted 564990737 1670794716
6830 Enter your caption text.
6833 \begin_layout Enumerate
6835 \change_inserted 564990737 1670794716
6842 to move the cursor above the caption.
6845 \begin_layout Enumerate
6847 \change_inserted 564990737 1670794716
6853 \begin_layout Enumerate
6855 \change_inserted 564990737 1670794716
6858 Position the cursor after the figure and insert a horizontal fill by using
6864 nsert\SpecialChar menuseparator
6869 rmatting\SpecialChar menuseparator
6875 \begin_inset space ~
6884 dialog and select the
6898 \begin_layout Enumerate
6900 \change_inserted 564990737 1670794716
6903 Switch to \SpecialChar LaTeX
6907 \begin_inset space ~
6915 \begin_layout Enumerate
6917 \change_inserted 564990737 1670794716
6928 Do not close the brace!
6931 \begin_layout Enumerate
6933 \change_inserted 564990737 1670794716
6936 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
6941 \begin_inset space ~
6953 \begin_layout Standard
6955 \change_inserted 564990737 1671642458
6958 Also, refer to the figures in the file in
6961 File\SpecialChar menuseparator
6962 Open Example\SpecialChar menuseparator
6963 Articles\SpecialChar menuseparator
6964 Astronomy & Astrophysics
6970 \begin_layout Subsubsection
6972 \change_inserted 564990737 1670794716
6978 \begin_layout Standard
6980 \change_inserted 564990737 1670794716
6983 For submission, the paper has to be formatted in a special double-spacing
6985 For this purpose, you have to add the option
6996 \begin_inset space ~
7006 ocument\SpecialChar menuseparator
7011 ettings\SpecialChar menuseparator
7013 \begin_inset space ~
7022 \begin_layout Subsubsection
7024 \change_inserted 564990737 1670794716
7030 \begin_layout Standard
7032 \change_inserted 564990737 1671642520
7038 File\SpecialChar menuseparator
7039 Open Example\SpecialChar menuseparator
7040 Articles\SpecialChar menuseparator
7041 Astronomy & Astrophysics
7044 was written with \SpecialChar LyX
7046 It is the example paper from the original macro package,
7051 \begin_inset CommandInset href
7054 target "http://ftp.edpsciences.org/pub/aa/aa-package.zip"
7059 , but translated to \SpecialChar LyX
7060 using the older unstructured abstract type.
7061 Use it for inspiration, and compare the \SpecialChar LaTeX
7066 with the \SpecialChar LyX
7070 \begin_layout Subsection
7075 \begin_layout Standard
7081 \begin_layout Subsubsection
7085 \begin_layout Standard
7087 is a set of macros produced by the American Astronomical Society to
7088 facilitate electronic manuscript submission to the three journals they
7089 publish: the Astrophysical Journal (including the Letters and Supplement),
7090 the Astronomical Journal, and the Publications of the Astronomical Society
7093 has proven to be an excellent tool for generating these documents, especially
7094 given its equation, citation, and figure handling capabilities.
7096 requires version 5.0 (or higher) of these macros; preferably 6.0, which
7097 is the version described here, or higher.
7098 Versions prior to 5.0 are intended for use with \SpecialChar LaTeX
7099 2.09 and are fundamentally
7100 incompatible with \SpecialChar LyX
7102 The AAS\SpecialChar TeX
7103 package may be downloaded from the AAS\SpecialChar TeX
7107 \begin_layout Standard
7108 \begin_inset VSpace medskip
7114 \begin_layout Standard
7116 \begin_inset Flex URL
7119 \begin_layout Plain Layout
7121 https://aas.org/aastex/aastex-downloads
7129 \begin_layout Standard
7130 \begin_inset VSpace medskip
7136 \begin_layout Standard
7137 A complete user guide is contained in that package and you should familiarize
7138 yourself with it thoroughly before embarking on writing a paper in \SpecialChar LyX
7141 will not reduce the need to figure out all the AAS\SpecialChar TeX
7142 commands, it will only
7143 reduce the drudgery of typing everything in.
7144 It is your responsibility to ensure that the final exported \SpecialChar LaTeX
7146 completely to the requirements of the journal to which you are submitting
7150 \begin_layout Subsubsection
7151 Starting a New Paper
7154 \begin_layout Standard
7155 I strongly suggest that you start with the AAS\SpecialChar TeX
7159 File\SpecialChar menuseparator
7165 \change_inserted 564990737 1671617265
7166 \SpecialChar menuseparator
7167 Articles\SpecialChar menuseparator
7168 American Astronomical Society
7169 \change_deleted 564990737 1671617310
7172 , enter the new file name, then choose the
7179 This will show the most common fields found in a manuscript.
7180 Simply overwrite the existing text (including the brackets,
7184 ) with the correct information.
7185 Many of the AAS\SpecialChar TeX
7186 commands and environments can be implemented directly in
7189 For commands such as these, the \SpecialChar LaTeX
7190 code must be entered directly and marked
7192 Such commands are referred to as \SpecialChar TeX
7193 code, or Evil Red Text.
7194 I tried to minimize the amount of \SpecialChar TeX
7195 code needed in an AAS\SpecialChar TeX
7199 \begin_layout Subsubsection
7200 Finishing Your Paper
7203 \begin_layout Standard
7204 When the paper is finished to your satisfaction and previews/prints correctly,
7206 \begin_inset Quotes eld
7210 \begin_inset Quotes erd
7213 actions which need to be done before you submit it to the journals.
7217 \begin_layout Enumerate
7218 Export your paper as a \SpecialChar LaTeX
7221 File\SpecialChar menuseparator
7222 Export\SpecialChar menuseparator
7230 \begin_layout Enumerate
7235 file with your favorite text editor
7239 \begin_layout Enumerate
7240 remove the comment lines before the
7249 \begin_layout Enumerate
7254 usepackage...{fontenc}
7256 line if it appears (usually just after
7271 \begin_layout Enumerate
7272 remove everything between (and including) the
7284 commands, except for any commands you specifically put into the \SpecialChar LaTeX
7286 (which should appear immediately after the
7287 \begin_inset Quotes eld
7290 User specified \SpecialChar LaTeX
7292 \begin_inset Quotes erd
7303 \begin_layout Enumerate
7304 Run the resulting file through \SpecialChar LaTeX
7305 to make sure it still processes correctly.
7308 \begin_layout Enumerate
7309 Reread the journal requirements to make sure your filenames and formats
7313 \begin_layout Enumerate
7317 \begin_layout Subsubsection
7318 Comments On Specific Commands
7321 \begin_layout Standard
7322 I will not describe the detailed usage of the individual AAS\SpecialChar TeX
7329 ) gives a good description of each.
7330 Thus it's probably easiest for me to go down the list as found in the guide
7331 and offer comments where necessary.
7332 So let's begin \SpecialChar ldots
7336 \begin_layout Paragraph
7337 Things that work as expected
7340 \begin_layout Standard
7341 Because they work as you might expect, I simply list them and the section
7442 begin{thebibliography}
7450 (2.13.2), all the cite commands and their variations (2.13.2), the generic
7451 graphicx figure commands (2.14.1),
7475 (2.15.4, amongst other places),
7502 \begin_layout Standard
7503 The following style options also work correctly:
7524 Simply put them in the
7530 Layout\SpecialChar menuseparator
7536 \begin_layout Paragraph
7537 Things that work, but require more comment
7540 \begin_layout Standard
7541 The following items work, but require a little more discussion:
7544 \begin_layout Itemize
7545 These items are reserved for use by the journal editors, but you can put
7546 them into the \SpecialChar LaTeX
7547 preamble if you feel compelled to do so:
7580 \begin_layout Itemize
7581 These items may be placed in the \SpecialChar LaTeX
7582 preamble, and are included as blanks in
7604 \begin_layout Itemize
7611 (2.3) – can only be used
7612 \begin_inset Quotes eld
7616 \begin_inset Quotes erd
7619 , not in the middle of a paragraph.
7620 Use \SpecialChar TeX
7621 code if you need to embed it.
7624 \begin_layout Itemize
7631 (2.3) – will have extra {} after it.
7632 This should not cause an error.
7635 \begin_layout Itemize
7642 (2.6) – can only be used
7643 \begin_inset Quotes eld
7647 \begin_inset Quotes erd
7650 , not in the middle of a paragraph.
7651 Use \SpecialChar TeX
7652 code if you need to embed it.
7655 \begin_layout Itemize
7662 (2.8) – can't insert a cross-reference tag, you must type the tag name by
7666 \begin_layout Itemize
7680 \begin_layout Itemize
7687 (2.9) – will have extra {} after it.
7688 This should not cause an error.
7691 \begin_layout Itemize
7698 (2.11) – will have extra {} after it.
7699 This should not cause an error.
7702 \begin_layout Itemize
7709 (2.14.2) – you can insert an optional filename argument by placing the cursor
7710 at the beginning of the text and selecting
7712 Insert\SpecialChar menuseparator
7717 \begin_inset Quotes eld
7721 \begin_inset Quotes erd
7724 inserts an optional argument of the type needed by
7731 Hopefully it will be renamed someday.
7734 \begin_layout Itemize
7747 for the catalog ID optional parameter
7750 \begin_layout Itemize
7763 for the catalog ID optional parameter
7766 \begin_layout Paragraph
7767 Things not implemented, use \SpecialChar TeX
7771 \begin_layout Standard
7782 setcounter{equation}
7784 (2.12), Journal name abbreviations (2.13.4),
7820 (2.15.4, insert it as the first element in the lefthand cell after where
7822 Don't use any of \SpecialChar LyX
7823 's rules in the table),
7835 (2.15.5), much of Misc (2.17, except
7886 \begin_layout Paragraph
7887 Things that cannot be implemented
7890 \begin_layout Standard
7892 at least in any meaningful sort of way, so I suggest ignoring them.
7893 They are the references environment (2.13.3), and the deluxetable environment
7895 If you really, really need to use deluxetable, I suggest editing it in
7896 a separate file with a text editor, then using
7898 Insert\SpecialChar menuseparator
7900 \begin_inset space ~
7905 to include it in your \SpecialChar LyX
7908 \change_deleted 564990737 1671642564
7914 \change_inserted 564990737 1671642618
7918 File\SpecialChar menuseparator
7919 Open Example\SpecialChar menuseparator
7920 Articles\SpecialChar menuseparator
7921 American Astronomical Society
7927 \change_inserted 564990737 1671642621
7933 \begin_layout Subsubsection
7934 FAQs, Tips, Tricks, and Other Ruminations
7937 \begin_layout Paragraph
7938 Getting \SpecialChar LyX
7939 and AAS\SpecialChar TeX
7943 \begin_layout Standard
7944 It can be a bit tricky to get \SpecialChar LyX
7945 to recognize a new layout and document class.
7946 When all else fails, do this:
7949 \begin_layout Enumerate
7950 Make certain that \SpecialChar LaTeX
7951 can find AAS\SpecialChar TeX
7953 Copy sample.tex (and perhaps table.tex) from the AAS\SpecialChar TeX
7955 directory completely unrelated to \SpecialChar LaTeX
7956 or AAS\SpecialChar TeX
7957 and run \SpecialChar LaTeX
7965 \begin_layout Enumerate
7970 appears in \SpecialChar LyX
7978 \begin_layout Enumerate
7981 Tools\SpecialChar menuseparator
7985 , then restart \SpecialChar LyX
7989 \begin_layout Enumerate
7990 Open a regular new file, not from a template.
7991 Does AAS\SpecialChar TeX
7992 appear in the class list in
7994 Document\SpecialChar menuseparator
8000 \begin_layout Standard
8001 If you get a warning from an existing AAS\SpecialChar TeX
8002 document about not being able
8003 to find the AAS\SpecialChar TeX
8004 layout or a message about
8005 \begin_inset Quotes eld
8008 You should not mix title layouts with normal ones
8009 \begin_inset Quotes erd
8012 , things haven't been installed correctly.
8015 \begin_layout Paragraph
8017 error processing a table
8020 \begin_layout Standard
8022 , by default, attempts to center the table caption/title.
8023 This seems to produce a bad interaction in AAS\SpecialChar TeX
8024 so you should click somewhere
8025 in the caption/title, then select
8027 Edit\SpecialChar menuseparator
8029 \begin_inset space ~
8043 This took care of it for me.
8046 \begin_layout Paragraph
8050 \begin_layout Standard
8051 A couple of things: 1) I have noticed some funny spacing in the reference
8052 entries in the text.
8053 When you enter the bibliography item data, make sure their is
8057 space between the last author and the parenthesis setting off the year;
8061 \begin_inset space \thinspace{}
8065 \begin_inset space \space{}
8079 2) Entering the references at all is not obvious.
8080 The easiest thing is to start typing your first reference at the end of
8081 the document, then mark it as type
8086 That will put a small gray box in front of what you just typed.
8087 Click on the box to fill in the rest of the information.
8088 For new references, go to the end of an existing reference and press return.
8089 That will create a new line with its own box, etc.
8092 \begin_layout Paragraph
8096 \begin_layout Standard
8097 Even though AAS\SpecialChar TeX
8098 provides its own figure commands (
8104 , for example), I much prefer \SpecialChar LaTeX
8105 's standard figure commands (with the default
8114 \begin_inset space ~
8117 commands as \SpecialChar TeX
8118 code into a Figure Float box if you desire, but I never have
8119 much luck getting the layout right.
8120 With the standard graphics, \SpecialChar LyX
8125 usepackage{graphicx}
8127 command into the \SpecialChar LaTeX
8128 preamble and handle the figures in the standard \SpecialChar LaTeX2e
8130 interspersing the figures in the text.
8131 I believe ApJ accepts figures exactly this way now; AJ might still use
8133 \begin_inset Quotes eld
8136 stack everything at the end
8137 \begin_inset Quotes erd
8143 \begin_layout Paragraph
8144 Things I could have done, but didn't
8147 \begin_layout Standard
8149 \begin_inset Quotes eld
8153 \begin_inset Quotes erd
8156 things I could have implemented, but chose not to.
8157 For instance, I saw no point in double-spacing the text in the \SpecialChar LyX
8159 even though it is double-spaced in the paper manuscript.
8160 Also, I chose not to make separate layouts for the preprint and preprint2
8162 Since I assume you will spend most of your time in the plain manuscript
8163 mode anyway, I decided not to chew up more disk space with this.
8167 \begin_layout Subsubsection
8171 \begin_layout Standard
8172 Your mileage may vary.
8173 I've now had papers published by both ApJ and AJ that have had 98% of the
8174 effort done in \SpecialChar LyX
8175 ; the last 2% was the \SpecialChar LaTeX
8176 post-processing and a few cleanups.
8177 I have had no trouble with the submission process, and I'm sure the journals
8178 were never aware that there might be a difference.
8179 So, go forth and publish!
8182 \begin_layout Subsection
8184 \change_inserted 564990737 1671442131
8190 \begin_layout Standard
8192 \change_inserted 564990737 1671642768
8198 \begin_inset space \thinspace{}
8207 document class together with the style
8211 to facilitate the description of chess games.
8215 File\SpecialChar menuseparator
8218 \SpecialChar menuseparator
8219 Articles\SpecialChar menuseparator
8238 \begin_layout Subsection
8240 \change_inserted 564990737 1671042028
8246 \begin_layout Standard
8248 \change_inserted 564990737 1671617396
8254 \begin_inset space \thinspace{}
8264 This provides the following additional environments:
8267 \begin_inset space ~
8275 \begin_inset space ~
8283 \begin_inset space ~
8301 A template is available in the menu
8306 ile\SpecialChar menuseparator
8308 \begin_inset space ~
8316 \begin_inset space ~
8321 \SpecialChar menuseparator
8322 Articles\SpecialChar menuseparator
8327 It has been customized with further environments and contains all the informati
8329 However, the documentation is also available from
8330 \begin_inset CommandInset href
8333 target "http://mirrors.ctan.org/macros/latex/contrib/elsarticle/doc/elsdoc.pdf"
8341 \begin_layout Subsection
8343 \change_inserted 564990737 1671042046
8349 \begin_layout Standard
8351 \change_inserted 564990737 1671042046
8357 \begin_inset space \thinspace{}
8362 provides an alternative to the
8367 It provides similar functionality, but you might prefer this layout with
8368 sans serif sections, headings, and more.
8371 \begin_layout Subsection
8376 \begin_layout Standard
8382 \begin_layout Standard
8383 \begin_inset VSpace bigskip
8389 \begin_layout Standard
8394 \begin_inset space ~
8399 textclass works with the American Physical Sociey's Rev\SpecialChar TeX
8401 \begin_inset Formula $\beta$
8404 release of May, 1999) class.
8407 \begin_layout Standard
8413 textclass, which works with Rev\SpecialChar TeX
8415 However, v3.1 is basically obsolete, as it works with \SpecialChar LaTeX
8417 That means that it doesn't interact very well with \SpecialChar LyX
8418 , which requires \SpecialChar LaTeX2e
8420 it has been kludged to work.
8421 Since Rev\SpecialChar TeX
8422 4.0 has been designed to work much more cleanly with \SpecialChar LaTeX2e
8429 \begin_inset space ~
8434 textclass should also be pretty easy to use.
8437 \begin_layout Standard
8438 These documents are supposed to be used in
8442 to the Rev\SpecialChar TeX
8443 4.0 documents, so we don't describe any of the special Rev\SpecialChar TeX
8445 and assume you'll know what to put in the preamble if necessary.
8448 \begin_layout Subsubsection
8452 \begin_layout Standard
8453 All you need to do is install Rev\SpecialChar TeX
8454 4, as described in the package's README
8456 The package can be found at The Rev\SpecialChar TeX
8458 \begin_inset Flex URL
8461 \begin_layout Plain Layout
8463 http://publish.aps.org/revtex4/
8469 Install it somewhere that \SpecialChar LaTeX
8471 Test it by trying to \SpecialChar LaTeX
8472 a short Rev\SpecialChar TeX
8473 4 document in some random directory (i.
8474 \begin_inset space \thinspace{}
8478 \begin_inset space \space{}
8481 not the directory where you installed the class file.) Then, if you reconfigure
8483 , it will find the class file and let you use the Rev\SpecialChar TeX
8487 \begin_layout Standard
8488 Probably the easiest way to get started is either to import a Rev\SpecialChar TeX
8497 \begin_inset space ~
8502 template, found in the templates directory.
8505 \begin_layout Subsubsection
8509 \begin_layout Standard
8510 Optional arguments to
8517 \begin_inset Quotes eld
8521 \begin_inset Quotes erd
8525 \begin_inset Quotes eld
8529 \begin_inset Quotes erd
8535 \begin_inset space ~
8543 \begin_inset space ~
8549 Remember that in Rev\SpecialChar TeX
8550 , at least one optional argument is required!
8553 \begin_layout Standard
8554 Other preamble matter, like
8561 \begin_inset space ~
8568 \begin_inset space ~
8573 dialog, also as usual.
8576 \begin_layout Subsubsection
8580 \begin_layout Standard
8581 The layouts basically correspond to the commands in Rev\SpecialChar TeX
8583 For example, the Email layout corresponds to
8590 Note that (at least as of Rev\SpecialChar TeX
8599 layouts are exactly equivalent, so you shouldn't need to use both.
8603 \begin_layout Plain Layout
8604 In case you're curious, both were included so that
8608 would be able to translate both
8628 \begin_layout Subsubsection
8632 \begin_layout Standard
8633 There are a couple of important unique aspects of Rev\SpecialChar TeX
8635 bugs that will be even more confusing in \SpecialChar LyX
8639 \begin_layout Standard
8640 In Rev\SpecialChar TeX
8658 The \SpecialChar LyX
8659 equivalent is that there is a separate Thanks layout.
8664 write footnotes in the
8668 layout, or weird things may happen.
8669 See the Rev\SpecialChar TeX
8670 4 documentation for more details.
8673 \begin_layout Standard
8677 \begin_inset space ~
8685 \begin_inset space ~
8694 layouts must be placed
8702 layout and the corresponding
8719 , the \SpecialChar LaTeX
8723 \begin_layout Subsection
8725 \change_inserted 564990737 1671042072
8731 \begin_layout Standard
8733 \change_inserted 564990737 1671042072
8740 classes were replaced in 2013 with a completely new
8745 This package provides a \SpecialChar LaTeX
8746 class and templates for books to be published
8747 at Springer Gabler Research, Springer Vieweg Research, Springer Spektrum
8748 Research, Springer VS Research, or Springer VS Forschung.
8749 The documentation is available in German from
8750 \begin_inset CommandInset href
8753 target "http://mirrors.ctan.org/macros/latex/contrib/springer/sr-vorl/sr-vorl.pdf"
8761 \begin_layout Section
8763 \change_inserted 564990737 1670439560
8767 \begin_layout Standard
8769 \change_inserted 564990737 1670439581
8770 See also the document classes in the Collections (section
8771 \begin_inset space ~
8775 \begin_inset CommandInset ref
8777 reference "sec:Collections"
8784 \begin_layout Subsection
8788 \begin_layout Standard
8794 \begin_layout Subsubsection
8798 \begin_layout Standard
8799 Memoir is a very powerful and constantly evolving class.
8800 It has been designed with regard to fictional and non-fictional literature.
8801 Its aim is to let the user have maximum control over the typesetting of
8803 Memoir is based on the standard book class, but it can also emulate the
8804 article class (see below).
8807 \begin_layout Standard
8808 Peter Wilson, the developer of Memoir, is known as the author of lots of
8809 useful packages in the \SpecialChar LaTeX
8811 Most of them have been merged with Memoir.
8812 Therefore, it is much easier to layout the table of contents, appendices,
8813 chapter designs and such.
8815 , though, does not support all of these goodies natively.
8816 Some of them might be added to forthcoming releases
8820 \begin_layout Plain Layout
8821 You are invited to send suggestions to
8822 \begin_inset Flex URL
8825 \begin_layout Plain Layout
8827 lyx-devel@lists.lyx.org
8837 , lots will probably never be supported, due to the limitations of \SpecialChar LyX
8839 Of course you can still use all features with the help of some native \SpecialChar LaTeX
8841 commands (\SpecialChar TeX
8846 \begin_layout Plain Layout
8851 \begin_layout Plain Layout
8861 \begin_inset space ~
8865 \begin_inset CommandInset ref
8867 reference "sec:Inserting-TeX-Code"
8877 In this section, we can only list those features that are natively supported
8880 For detailed descriptions (and for the rest of features) we recommend you
8881 have a look at the detailed manual of the Memoir class
8885 \begin_layout Plain Layout
8890 \begin_layout Plain Layout
8900 \begin_inset Flex URL
8903 \begin_layout Plain Layout
8905 CTAN:/macros/latex/memoir/memman.pdf
8915 , which is not only a user guide for the class, but also both a comprehensive
8916 description on good typesetting and a superb example for good typesetting
8920 \begin_layout Subsubsection
8921 Basic features and restrictions
8924 \begin_layout Standard
8925 Memoir supports basically all features of the standard book classes.
8926 There are, however, some differences, as follows:
8929 \begin_layout Description
8931 \begin_inset space ~
8934 sizes: Memoir has a broader range of font sizes: 9, 10, 11, 12, 14, 17
8937 \begin_layout Description
8939 \begin_inset space ~
8942 style: The fancy page style is not supported, due to a command clash between
8943 Memoir and the fancyhdr package (they both define a command with the same
8944 name, which confuses \SpecialChar LaTeX
8946 Instead, Memoir comes with a number of its own page styles (see
8948 Document\SpecialChar menuseparator
8949 Settings\SpecialChar menuseparator
8951 \begin_inset space ~
8957 If you want to use these for the chapter pages, you have to use the command
8964 in the main text or in preamble (e.
8965 \begin_inset space \thinspace{}
8969 \begin_inset space \space{}
8976 chapterstyle{companion}
8981 \begin_layout Description
8982 Sectioning: Sectionings (chapter, section, subsection etc.) come with an
8983 optional argument in the standard classes.
8984 With this, you can specify an alternative version of the title for the
8985 table of contents and the headers (for instance, if the title is too long).
8987 , you can do this via
8989 Insert\SpecialChar menuseparator
8991 \begin_inset space ~
8996 at the beginning of a chapter/section.
8997 Memoir features a second optional argument and thus separates the table
8998 of contents from the header.
8999 You can define three variants of a title with this: one for the main text,
9000 one for the table of contents, and one for the headers.
9002 makes these available in form of specific
9013 \begin_layout Description
9014 TOC/LOT/LOF: In the standard classes (and in many other classes), the table
9015 of contents, the list of figures and the list of table start a new page
9017 Memoir does not follow this route.
9018 You have to insert a page break yourself, if you want to have one.
9021 \begin_layout Description
9022 Titlepage: For some unknown reason, Memoir uses pagination on the title
9023 page (in the standard classes, title pages are
9024 \begin_inset Quotes eld
9028 \begin_inset Quotes erd
9032 If you want an empty title page, type
9036 aliaspagestyle{title}{empty}
9041 \begin_layout Description
9042 Article: With the class option
9048 Document\SpecialChar menuseparator
9049 Settings\SpecialChar menuseparator
9050 Class Settings\SpecialChar menuseparator
9052 \begin_inset space ~
9057 ), you can emulate article style.
9058 That is, counters (footnotes, figures, tables etc.) will not be reset on
9059 new chapters, chapters don't start a new page (but are—in contrary to
9060 \begin_inset Quotes eld
9064 \begin_inset Quotes erd
9067 article classes—still allowed), parts, though, use their own page, as in
9071 \begin_layout Description
9072 Oldfontcommands: By default, Memoir does not allow the use of the deprecated
9073 font commands, which have been used in the old \SpecialChar LaTeX
9075 \begin_inset space \thinspace{}
9079 \begin_inset space \space{}
9095 It produces an error and stops \SpecialChar LaTeX
9096 whenever such a command appears.
9101 reallows the commands and spits out warnings instead (which does at least
9102 not stop \SpecialChar LaTeX
9104 Since a lot of packages and particularly Bib\SpecialChar TeX
9105 style files are still using
9106 those commands, we have decided to use this option by default.
9109 \begin_layout Subsubsection
9113 \begin_layout Standard
9114 We will only describe the features supported by \SpecialChar LyX
9115 (which is not much currently).
9116 Please consult the Memoir manual
9120 \begin_layout Plain Layout
9125 \begin_layout Plain Layout
9135 \begin_inset Flex URL
9138 \begin_layout Plain Layout
9140 CTAN:/macros/latex/memoir/memman.pdf
9153 \begin_layout Description
9154 Abstract: You may wonder why an abstract is an extra feature.
9155 Well, it is in book class.
9156 Usually books don't have abstracts.
9157 Memoir, however, has.
9158 You can use it wherever and how often you like.
9161 \begin_layout Description
9162 Chapterprecis: You may know this older typesetting style: The contents of
9163 a chapter are summarized below the title and also in the table of contents
9165 \begin_inset space \thinspace{}
9169 \begin_inset space \space{}
9174 Our hero arrives in Troia; he loses some friends; he finds others
9177 Chapterprecis does exactly this.
9178 It is therefore only sensible below a chapter.
9181 \begin_layout Description
9182 Epigraph: An epigraph is a smart slogan or motto at the beginning of a chapter.
9183 The epigraph environment provides an elegant way of typesetting such a
9185 The motto itself (text) and its (optional) author (source) are divided
9187 The author (source) can be inserted via
9189 Insert\SpecialChar menuseparator
9196 \begin_layout Description
9197 Poemtitle: Memoir has lots of possibilities to typeset poetry (up to very
9198 complex figurative poems).
9200 can only support a few of them.
9201 One is poemtitle, which is a centered title for poems, which will also
9202 be added to the table of contents (verse is the standard environment for
9204 Memoir has some enhanced versions of verse, but you need to use \SpecialChar TeX
9206 because they have to be nested inside regular verse environments, which
9207 is not possible with \SpecialChar LyX
9211 \begin_layout Description
9212 Poemtitle*: Same as poemtitle, but it adds no entry to the table of contents.
9215 \begin_layout Subsection
9217 \change_inserted 564990737 1671442175
9223 \begin_layout Standard
9225 \change_inserted 564990737 1671442175
9235 \begin_inset space \thinspace{}
9240 document class but adds two environments:
9243 \begin_layout Description
9245 \change_inserted 564990737 1671442175
9248 Recipe a numbered section environment at the
9252 level which generates a bold centered heading above a double horizontal
9256 \begin_layout Description
9258 \change_inserted 564990737 1671442175
9271 are what are being described and the environment ends with a horizontal
9275 \begin_layout Standard
9277 \change_inserted 564990737 1671642866
9281 File\SpecialChar menuseparator
9282 Open Example\SpecialChar menuseparator
9283 Books\SpecialChar menuseparator
9287 illustrates its use.
9290 \begin_layout Standard
9292 \change_inserted 564990737 1671442175
9295 It is designed for typesetting one or two recipes per page, with dimensions
9297 \begin_inset Quotes qrd
9301 \begin_inset Quotes qrd
9305 The hyperlinked table of contents (ToC) and page numbers make browsing
9306 recipes convenient, and the pages can be joined together or printed 2 per
9307 page to normal letterpaper easily.
9308 The size was chosen to work in half-page 3-ring binder cover sheets, because
9309 un-laminated paper just doesn't last in the kitchen.
9312 \begin_layout Standard
9314 \change_inserted 564990737 1671442175
9317 The half-letter pages can be printed two per page using your printer driver,
9318 or bound together using
9320 pdfjam --nup 2x1 --papersize '{11in,8.5in}'
9330 is the compiled version of your recipes.
9333 \begin_layout Section
9335 \change_inserted 564990737 1671442207
9339 \begin_layout Subsection
9341 \change_inserted 564990737 1671442208
9347 \begin_layout Standard
9349 \change_inserted 564990737 1671642942
9355 \begin_inset space \space{}
9359 \begin_inset space \thinspace{}
9368 document class, an unofficial implementation of the ‘Europass CV’ recommended
9369 by the European Commission in 2013.
9373 File\SpecialChar menuseparator
9374 Open Example\SpecialChar menuseparator
9375 Curricula Vitae\SpecialChar menuseparator
9379 offers guidance on its use.
9380 Its documentation is available from
9381 \begin_inset CommandInset href
9384 target "http://mirrors.ctan.org/macros/latex/contrib/europasscv/europasscv.pdf"
9392 \begin_layout Subsection
9394 \change_inserted 564990737 1671442208
9400 \begin_layout Standard
9402 \change_inserted 564990737 1671642984
9408 \begin_inset space \space{}
9412 \begin_inset space \thinspace{}
9421 document class, an unofficial implementation of the “Europass CV” recommended
9422 by the European Commission in 2002.
9426 File\SpecialChar menuseparator
9427 Open Example\SpecialChar menuseparator
9428 Curricula Vitae\SpecialChar menuseparator
9432 offers guidance on its use.
9433 Its documentation is available from
9434 \begin_inset CommandInset href
9437 target "http://mirrors.ctan.org/macros/latex/contrib/europecv/europecv.pdf"
9445 \begin_layout Subsection
9447 \change_inserted 564990737 1671442208
9453 \begin_layout Standard
9455 \change_inserted 564990737 1671643003
9461 \begin_inset space \space{}
9465 \begin_inset space \thinspace{}
9475 This allows the creation of customizable CVs.
9479 File\SpecialChar menuseparator
9480 Open Example\SpecialChar menuseparator
9481 Curricula Vitae\SpecialChar menuseparator
9485 offers guidance on its use.
9486 Its documentation is available from
9487 \begin_inset CommandInset href
9490 target "http://mirrors.ctan.org/macros/latex/contrib/moderncv/manual/moderncv_userguide.pdf"
9498 \begin_layout Subsection
9500 \change_inserted 564990737 1671442208
9506 \begin_layout Standard
9508 \change_inserted 564990737 1671643024
9514 \begin_inset space \space{}
9518 \begin_inset space \thinspace{}
9527 document class, originally developed for use with \SpecialChar LyX
9532 File\SpecialChar menuseparator
9533 Open Example\SpecialChar menuseparator
9534 Curricula Vitae\SpecialChar menuseparator
9538 offers guidance on its use.
9539 Its documentation is available from
9540 \begin_inset CommandInset href
9543 target "http://mirrors.ctan.org/macros/latex/contrib/simplecv/simplecv.pdf"
9551 \begin_layout Section
9553 \change_inserted 564990737 1672652454
9557 \begin_layout Standard
9559 \change_inserted 564990737 1672652455
9565 \begin_inset space \space{}
9571 \begin_inset space ~
9575 \begin_inset CommandInset ref
9577 reference "subsec:The-new-letter"
9584 \begin_inset space \space{}
9587 (with extra font sizes)
9590 \begin_inset space ~
9594 \begin_inset CommandInset ref
9596 reference "subsec:Extra-font-sizes"
9600 ) document classes .
9603 \begin_layout Subsection
9605 \change_inserted 564990737 1671041970
9611 \begin_layout Standard
9613 \change_inserted 564990737 1671617528
9624 document class for writing letters according to the
9626 Deutsches Institut für Normung
9629 The file in the menu
9634 ile\SpecialChar menuseparator
9636 \begin_inset space ~
9644 \begin_inset space ~
9647 Template\SpecialChar menuseparator
9648 Letters\SpecialChar menuseparator
9651 offers guidance on its use.
9652 The documentation is available from
9653 \begin_inset CommandInset href
9656 target "http://mirrors.ctan.org/macros/latex/contrib/dinbrief/liesmich"
9664 \begin_layout Subsection
9666 \change_inserted 564990737 1672652499
9672 \begin_layout Standard
9674 \change_inserted 564990737 1672652499
9680 \begin_inset space \space{}
9689 document class for writing letters according to French conventions.
9690 The file in the menu
9695 ile\SpecialChar menuseparator
9697 \begin_inset space ~
9705 \begin_inset space ~
9708 Template\SpecialChar menuseparator
9709 Letters\SpecialChar menuseparator
9711 \begin_inset space \space{}
9716 offers guidance on its use.
9719 \begin_layout Subsection
9721 \change_inserted 564990737 1672652499
9727 \begin_layout Standard
9729 \change_inserted 564990737 1672652499
9735 \begin_inset space \thinspace{}
9744 document class for writing letters in German.
9745 The file in the menu
9750 ile\SpecialChar menuseparator
9752 \begin_inset space ~
9760 \begin_inset space ~
9763 Template\SpecialChar menuseparator
9764 Letters\SpecialChar menuseparator
9766 \begin_inset space \thinspace{}
9771 offers guidance on its use.
9772 The documentation is available from
9773 \begin_inset CommandInset href
9776 target "http://mirrors.ctan.org/macros/latex/contrib/g-brief/g-brief.pdf"
9784 \begin_layout Subsection
9786 \change_inserted 564990737 1671458835
9792 \begin_layout Standard
9794 \change_inserted 564990737 1671617591
9805 document class for English letters and to create mailing labels.
9806 The file in the menu
9811 ile\SpecialChar menuseparator
9813 \begin_inset space ~
9821 \begin_inset space ~
9824 Template\SpecialChar menuseparator
9825 Letters\SpecialChar menuseparator
9826 Letter (Standard Class)
9828 offers guidance on its use.
9831 \begin_layout Subsection
9833 \change_inserted 564990737 1672652527
9839 \begin_layout Standard
9841 \change_inserted 564990737 1672652527
9847 \begin_inset space \space{}
9856 document class for writing letters, faxes and envelopes in French.
9857 The file in the menu
9862 ile\SpecialChar menuseparator
9864 \begin_inset space ~
9872 \begin_inset space ~
9875 Template\SpecialChar menuseparator
9876 Letters\SpecialChar menuseparator
9878 \begin_inset space \space{}
9883 offers guidance on its use.
9884 The documentation is available from
9885 \begin_inset CommandInset href
9888 target "http://mirrors.ctan.org/macros/latex/contrib/lettre/lettre.pdf"
9896 \begin_layout Section
9898 \change_inserted 564990737 1670439660
9902 \begin_layout Subsection
9904 \change_inserted 564990737 1671458922
9910 \begin_layout Standard
9912 \change_inserted 564990737 1671617655
9918 \begin_inset space \thinspace{}
9927 document class for creating presentations.
9928 The file in the menu
9933 ile\SpecialChar menuseparator
9935 \begin_inset space ~
9943 \begin_inset space ~
9946 Template\SpecialChar menuseparator
9947 Presentations\SpecialChar menuseparator
9950 offers guidance on its use.
9951 The documentation is available from
9952 \begin_inset CommandInset href
9955 target "http://mirrors.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf"
9963 \begin_layout Subsection
9966 Foil\SpecialChar TeX
9970 \begin_inset CommandInset label
9979 \begin_layout Standard
9981 \change_inserted 564990737 1672743383
9988 ; updated by the \SpecialChar LyX
9992 \begin_layout Subsubsection
9994 \change_inserted 564990737 1672743383
10000 \begin_layout Standard
10002 \change_inserted 564990737 1672743396
10008 \begin_inset space \thinspace{}
10011 (Foil\SpecialChar TeX
10018 document class to make slides for overhead projectors.
10019 There are two document classes that can do this: the
10022 \begin_inset space \thinspace{}
10027 document class (section
10028 \begin_inset space ~
10032 \begin_inset CommandInset ref
10034 reference "sec:slitex"
10043 Foil\SpecialChar TeX
10047 As of 2023 the former has continued to be maintained whereas
10049 Foil\SpecialChar TeX
10052 has not been maintained since 2008.
10053 This section documents the latter.
10054 If your machine doesn’t have the
10057 \begin_inset space \thinspace{}
10060 (Foil\SpecialChar TeX
10063 document class installed, you’ll probably have to use the
10066 \begin_inset space \thinspace{}
10072 If you want to install the
10076 document class, it is available from
10077 \begin_inset CommandInset href
10080 target "https://www.ctan.org/pkg/foiltex"
10086 You should also read the
10088 Installing New Document Classes
10095 \change_deleted 564990737 1672743436
10103 \begin_layout Standard
10105 \change_deleted 564990737 1672743383
10109 \begin_layout Standard
10111 \change_deleted 564990737 1672743383
10112 This section describes how to use \SpecialChar LyX
10113 to make slides for overhead projectors.
10114 There are two document classes that can do this: the default slides class
10117 Foil\SpecialChar TeX
10121 This section documents the latter.
10124 \begin_layout Standard
10126 \change_deleted 564990737 1672743383
10127 I'm going to say this again, nice and clear, so that there's no misunderstanding
10131 \begin_layout Standard
10133 \change_deleted 564990737 1672743383
10134 \begin_inset VSpace bigskip
10140 \begin_layout Standard
10143 \change_deleted 564990737 1672743383
10146 This section documents the class
10147 \begin_inset Quotes eld
10155 \begin_inset Quotes erd
10163 \begin_layout Standard
10165 \change_deleted 564990737 1672743383
10166 \begin_inset VSpace bigskip
10172 \begin_layout Standard
10174 \change_deleted 564990737 1672743383
10175 If you're looking for the documentation for
10176 \begin_inset Quotes eld
10184 \begin_inset Quotes erd
10187 , check out section
10188 \begin_inset space ~
10192 \begin_inset CommandInset ref
10194 reference "sec:slitex"
10199 If your machine doesn't have the
10207 installed, you'll probably have to use the default
10211 class, which isn't quite as good as
10216 \begin_layout Standard
10218 \change_deleted 564990737 1672743383
10223 class is designed for use with version
10224 \begin_inset space ~
10232 class file which is now an integral part of \SpecialChar LaTeX2e
10238 \begin_layout Subsubsection
10242 \begin_layout Standard
10243 Obviously, to use this document class, you need to select
10254 \begin_inset space ~
10260 There are some settings in the
10263 \begin_inset space ~
10268 dialog that you should know about that are specific to this class:
10271 \begin_layout Itemize
10272 Don't change the options
10283 \begin_inset space ~
10289 They're ignored by the
10296 \begin_layout Itemize
10297 The default font size is 20
10298 \begin_inset space \thinspace{}
10301 pt with the other options being 17
10302 \begin_inset space \thinspace{}
10306 \begin_inset space \thinspace{}
10310 \begin_inset space \thinspace{}
10316 \begin_layout Itemize
10317 The default font is
10325 but all math equations are still typeset in the usual roman font.
10328 \begin_layout Itemize
10331 Foil\SpecialChar TeX
10334 supports A4 and Letter paper sizes as well as a special size for working
10336 \begin_inset space \thinspace{}
10340 It doesn't support A5, B5, legal or executive paper sizes.
10343 \begin_layout Itemize
10344 Don't bother changing the
10348 settings because they are ignored anyway.
10349 All floats appear where they are defined in the text.
10352 \begin_layout Itemize
10357 setting behaves a bit differently for this class.
10360 Foil\SpecialChar TeX
10363 provides extensive footer and header capabilities including a user-defined
10366 \begin_inset space ~
10370 \begin_inset CommandInset ref
10372 reference "sec:foilfoot"
10377 The title page is treated differently to all other pages in the document
10386 has the logo centered at the bottom of the page (if one is defined).
10387 The possible page style choices and what they do are as follows:
10391 \begin_layout Labeling
10392 \labelwidthstring MMMMMMM
10399 The final output contains no page numbers, or other headers or footers
10400 (except footnotes of course).
10404 \begin_layout Labeling
10405 \labelwidthstring MMMMMMM
10412 The final output contains page numbers centered at the bottom of the page.
10413 No other headings or footers (other than footnotes).
10416 \begin_layout Labeling
10417 \labelwidthstring MMMMMMM
10422 Page numbers in lower right corner.
10423 Additional headers and footers are also shown.
10424 This is also the default.
10427 \begin_layout Labeling
10428 \labelwidthstring MMMMMMM
10433 Gives you access to the
10437 package although its use with
10439 Foil\SpecialChar TeX
10442 is discouraged by the writer of the
10444 Foil\SpecialChar TeX
10447 package because of some potential page layout clashes.
10451 \begin_layout Paragraph
10455 \begin_layout Standard
10456 The following options may be used in the extra class options in the
10458 Document\SpecialChar menuseparator
10464 \begin_layout Labeling
10465 \labelwidthstring MMMMMMx
10470 This sets up the page layout for 7.33
10471 \begin_inset space \thinspace{}
10475 \begin_inset space \thinspace{}
10478 in paper, which is about the same aspect ratio as a 35
10479 \begin_inset space \thinspace{}
10482 mm slide, making it a bit easier to work with this medium.
10485 \begin_layout Labeling
10486 \labelwidthstring MMMMMMx
10491 Places a rule across the page below the header on every page except the
10495 \begin_layout Labeling
10496 \labelwidthstring MMMMMMx
10501 Places a rule across the page above the footer on every page except the
10505 \begin_layout Labeling
10506 \labelwidthstring MMMMMMx
10511 This is automatically set each time you create a new
10518 Foil\SpecialChar TeX
10521 to use the dvips driver to rotate those pages that are set as landscape
10525 \begin_layout Labeling
10526 \labelwidthstring MMMMMMx
10531 Simply changes the page dimensions to those of a landscape page but doesn't
10533 Thus if you use this option you need to use an external program to rotate
10534 each page or feed your paper through your printer as landscape.
10535 Note that this option effectively reverses the roles of the
10543 environments (don't worry these are described in the next section).
10546 \begin_layout Labeling
10547 \labelwidthstring MMMMMMx
10552 Equation numbers on the left.
10555 \begin_layout Labeling
10556 \labelwidthstring MMMMMMx
10561 Flush-left equations.
10564 \begin_layout Subsubsection
10565 Supported Environments
10568 \begin_layout Standard
10569 Most of the environments commonly supported in other classes are also supported
10575 There are several additional environments provided by
10577 Foil\SpecialChar TeX
10580 as well as a couple added by \SpecialChar LyX
10582 The following environments are shared with other classes:
10585 \begin_layout Standard
10586 \begin_inset Flex Multiple Columns
10589 \begin_layout Itemize
10595 \begin_layout Itemize
10601 \begin_layout Itemize
10607 \begin_layout Itemize
10613 \begin_layout Itemize
10619 \begin_layout Itemize
10626 \begin_layout Itemize
10632 \begin_layout Itemize
10638 \begin_layout Itemize
10644 \begin_layout Itemize
10650 \begin_layout Itemize
10656 \begin_layout Itemize
10662 \begin_layout Itemize
10668 \begin_layout Itemize
10674 \begin_layout Itemize
10685 \begin_layout Standard
10686 That is, all the major environments apart from the sectioning environments.
10687 Since foils are essentially self-contained sections, with a title and body,
10690 Foil\SpecialChar TeX
10693 provides specific commands for starting new foils and these are:
10696 \begin_layout Itemize
10702 \begin_layout Itemize
10708 \begin_layout Standard
10710 also provides slightly modified versions of these two environments called:
10713 \begin_layout Itemize
10719 \begin_layout Itemize
10722 ShortRotatefoilhead
10725 \begin_layout Standard
10726 and the differences will be explained in the next section.
10729 \begin_layout Standard
10730 Since foils are often used in presenting ideas or new theorems and such
10733 Foil\SpecialChar TeX
10736 also provides a comprehensive box of goodies for presenting them:
10739 \begin_layout Standard
10740 \begin_inset Flex Multiple Columns
10743 \begin_layout Itemize
10749 \begin_layout Itemize
10755 \begin_layout Itemize
10761 \begin_layout Itemize
10767 \begin_layout Itemize
10773 \begin_layout Itemize
10779 \begin_layout Itemize
10785 \begin_layout Itemize
10791 \begin_layout Itemize
10797 \begin_layout Itemize
10803 \begin_layout Itemize
10814 \begin_layout Standard
10815 The starred versions are unnumbered while the unstarred versions are numbered.
10816 There are also two list environments added by \SpecialChar LyX
10820 \begin_layout Itemize
10826 \begin_layout Itemize
10832 \begin_layout Standard
10835 Foil\SpecialChar TeX
10838 provides some powerful header and footer capabilities that are best set
10839 in the preamble although they may be set at any point in a document.
10840 If you want to change these settings in your document the best place to
10841 do so is at the very top of a foil, i.
10842 \begin_inset space \thinspace{}
10848 \begin_inset space \space{}
10853 straight after the foilhead.
10856 \begin_layout Standard
10857 For this purpose, the following command styles are provided [
10864 \begin_layout Standard
10865 \begin_inset Flex Multiple Columns
10868 \begin_layout Itemize
10872 \begin_inset space ~
10878 \begin_layout Itemize
10884 \begin_layout Itemize
10888 \begin_inset space ~
10894 \begin_layout Itemize
10898 \begin_inset space ~
10904 \begin_layout Itemize
10908 \begin_inset space ~
10915 \begin_layout Plain Layout
10916 \begin_inset space ~
10928 \begin_layout Standard
10929 There are also a few commands provided by
10931 Foil\SpecialChar TeX
10934 that aren't directly supported by \SpecialChar LyX
10935 but I'll tell you what they do and how
10936 to use them in section
10937 \begin_inset space ~
10941 \begin_inset CommandInset ref
10943 reference "sec:unsuppfoils"
10950 \begin_layout Subsubsection
10951 Building a Set of Foils
10954 \begin_layout Standard
10955 This section will give a simple introduction to using the different environments
10956 to build a set of foils.
10957 If you want to see an example set of foils, take a look at
10958 \change_deleted 564990737 1671643085
10963 file you find in \SpecialChar LyX
10969 \change_inserted 564990737 1671643099
10973 File\SpecialChar menuseparator
10976 \SpecialChar menuseparator
10977 Presentations\SpecialChar menuseparator
10985 \begin_layout Paragraph
10986 Give It a Title Page
10989 \begin_layout Standard
10990 Unlike other classes that provide
11010 creates the title on a page of its own.
11011 If you leave out the
11015 environment \SpecialChar LaTeX
11016 will substitute the current date (every time you regenerate
11020 \begin_layout Paragraph
11024 \begin_layout Standard
11025 As I mentioned earlier, there are four ways of starting a new foil.
11026 For portrait foils you should use
11035 The difference between these two environments is the amount of space between
11036 the title of the foil (the foilhead) and the body of the foil.
11039 \begin_layout Standard
11040 Landscape foils are generated using the
11046 ShortRotatefoilhead
11049 Again the only difference is the spacing between foilhead and body.
11050 Both of the short versions have 0.5
11051 \begin_inset space ~
11054 inches less separation between the foilhead and the body.
11058 \begin_layout Standard
11059 One problem with the support for landscape foils is the requirement that
11060 you have to use the
11064 driver to generate the PostScript output otherwise the foils won't be rotated.
11065 It is possible to get landscape foils even if you haven't got the
11069 driver provided you can feed your foils sideways through your printer ;-)
11072 \begin_layout Paragraph
11073 Theorems, Lemmas, Proofs and more
11076 \begin_layout Standard
11077 You can't have two of the same type of these environments directly following
11079 If you use a normal paragraph break, , you will just be extending the previous
11080 environment as if you had merged the two environments together.
11081 Rather than that, you need to insert a so-called separator.
11082 Please refer to the section entitled
11093 \begin_layout Paragraph
11097 \begin_layout Standard
11098 You get all the commonly supported list styles found in other classes as
11099 well as two new ones.
11100 I'll only describe the new ones here.
11101 If you want to find out more about the other list environments check out
11107 If you intend to use itemized lists you might also want to read about the
11111 \begin_inset space ~
11115 \begin_inset space ~
11120 dialog described above in section
11121 \begin_inset space ~
11125 \change_inserted 564990737 1671355684
11127 \begin_inset CommandInset ref
11129 reference "chap:bullets"
11134 \change_deleted 564990737 1671355684
11136 \begin_inset CommandInset ref
11138 reference "sec:bullet"
11147 \begin_layout Standard
11148 The two new list styles,
11156 , are designed to make it easier for you to create lists of do's and don'ts
11157 or right and wrong by providing dedicated environments that use a tick
11158 or a cross as the label of the list.
11159 These lists are in fact dedicated variants of the
11164 They do however require that you have the
11168 packages installed.
11171 \begin_layout Paragraph
11175 \begin_layout Standard
11178 Foil\SpecialChar TeX
11181 redefines the floating tables and figures so that they appear exactly where
11182 they are in the text rather than pushing them to the top of the page or
11183 to some user specified location.
11184 In fact if you change the float placement settings they are simply ignored.
11187 \begin_layout Paragraph
11188 Page Headers and Footers
11189 \begin_inset CommandInset label
11191 name "sec:foilfoot"
11198 \begin_layout Standard
11202 \begin_inset space ~
11211 are two commands used to control the left-footer text string.
11212 The first is meant to allow you to include a graphic logo on your foils
11214 \begin_inset Quotes eld
11219 Foil\SpecialChar TeX
11223 \begin_inset Quotes erd
11227 While the second is meant to provide a classification for the audience,
11231 \begin_inset space \thinspace{}
11237 \begin_inset space \space{}
11241 It is empty by default.
11244 \begin_layout Standard
11245 The remaining page corners can be filled by
11248 \begin_inset space ~
11253 (which defaults to page numbers),
11256 \begin_inset space ~
11264 \begin_inset space ~
11272 \begin_layout Subsubsection
11275 Foil\SpecialChar TeX
11279 \begin_inset CommandInset label
11281 name "sec:unsuppfoils"
11288 \begin_layout Standard
11289 All the commands mentioned below need to be set in a
11299 within another environment.
11302 \begin_layout Paragraph
11306 \begin_layout Standard
11307 All lengths are adjusted using the
11330 should be replaced by the name given to the length you want to change and
11335 is the length value.
11336 All lengths should be specified in units of length such as inches (
11348 ) or relative to some document or font-based length such as
11358 \begin_layout Standard
11359 It's possible to change the spacing between a foilhead and the body of the
11360 foil by adjusting the length specified by
11367 For example, to make
11372 \begin_inset space \space{}
11375 in closer to their bodies put the following in the preamble:
11381 foilheadskip}{-0.5in}
11384 \begin_layout Standard
11385 The spacings around floats can be adjusted by setting these lengths:
11388 \begin_layout Labeling
11389 \labelwidthstring MMMMMMMMMMM
11396 Separation between the text and the top of the float
11399 \begin_layout Labeling
11400 \labelwidthstring MMMMMMMMMMM
11407 Separation between the float and the caption
11410 \begin_layout Labeling
11411 \labelwidthstring MMMMMMMMMMM
11418 Separation between the caption and the following text
11421 \begin_layout Labeling
11422 \labelwidthstring MMMMMMMMMMM
11429 You can make the captions narrower than the surrounding text by adjusting
11431 Best done relative to
11440 \begin_layout Standard
11441 There are also several title page related lengths that you may find useful
11442 if you have a long title or several authors:
11445 \begin_layout Labeling
11446 \labelwidthstring MMMMMMMMMMM
11453 Separation from headers to
11458 \begin_layout Labeling
11459 \labelwidthstring MMMMMMMMMMM
11477 \begin_layout Labeling
11478 \labelwidthstring MMMMMMMMMMM
11492 \begin_layout Labeling
11493 \labelwidthstring MMMMMMMMMMM
11509 \begin_layout Labeling
11510 \labelwidthstring MMMMMMMMMMM
11526 \begin_layout Standard
11527 The last length related command affects all the list environments.
11538 a list environment then all the vertical spacing between the list items
11540 Note that this is a command not a length so it doesn't require
11546 like the stuff mentioned above.
11549 \begin_layout Paragraph
11550 Headers and Footers
11553 \begin_layout Standard
11566 commands control whether the logo in the
11570 definition appear on a given page.
11577 in the preamble then none of the foils will have the logo on them.
11578 If you don't want the logo on a particular page place the
11584 directly after the foilhead of that page and the
11590 directly after the next foilhead.
11593 \begin_layout Standard
11594 If you decide to use the
11598 page style setting in the
11601 \begin_inset space ~
11606 dialog you should probably add
11616 to your preamble so headers and footers on landscape pages are correctly
11617 placed when rotated.
11618 This is due to some clashes between the page layouts provided by the
11629 \begin_layout Subsection
11631 \change_inserted 564990737 1671459032
11637 \begin_layout Standard
11639 \change_inserted 564990737 1671643165
11645 \begin_inset space \thinspace{}
11654 document class for creating presentations.
11658 File\SpecialChar menuseparator
11659 Open Example\SpecialChar menuseparator
11660 Presentations\SpecialChar menuseparator
11664 offers guidance on its use.
11665 The documentation is available from
11666 \begin_inset CommandInset href
11669 target "http://mirrors.ctan.org/macros/latex/contrib/powerdot/doc/powerdot.pdf"
11677 \begin_layout Subsection
11679 \change_inserted 564990737 1671459032
11682 \begin_inset CommandInset label
11684 name "subsec:Seminar"
11693 \begin_layout Standard
11695 \change_inserted 564990737 1671643194
11701 \begin_inset space \thinspace{}
11710 document class for creating presentations.
11714 File\SpecialChar menuseparator
11715 Open Example\SpecialChar menuseparator
11716 Presentations\SpecialChar menuseparator
11720 offers guidance on its use.
11721 The documentation is available from
11722 \begin_inset CommandInset href
11725 target "http://mirrors.ctan.org/macros/latex/contrib/seminar/doc/seminar-doc.pdf"
11733 \begin_layout Subsection
11736 Sli\SpecialChar TeX
11740 \begin_inset CommandInset label
11749 \begin_layout Standard
11751 \change_inserted 564990737 1672743492
11758 ; updated by the \SpecialChar LyX
11762 \begin_layout Subsubsection
11764 \change_inserted 564990737 1672743492
11770 \begin_layout Standard
11772 \change_inserted 564990737 1672743492
11775 This section describes how to use \SpecialChar LyX
11776 to make slides for overhead projectors.
11777 There are two document classes that can do this: the
11780 \begin_inset space \thinspace{}
11785 document class and the
11788 \begin_inset space \thinspace{}
11791 (Foil\SpecialChar TeX
11795 This section documents the former.
11796 If you’re looking for the documentation for
11799 \begin_inset space \thinspace{}
11802 (Foil\SpecialChar TeX
11805 , check out section
11806 \begin_inset space ~
11810 \begin_inset CommandInset ref
11812 reference "sec:Foiltex"
11817 As of 2023 the former has continued to be maintained whereas
11819 Foil\SpecialChar TeX
11822 has not been maintained since 2008.
11824 \change_deleted 564990737 1672743492
11834 \begin_layout Standard
11836 \change_deleted 564990737 1672743492
11840 \begin_layout Standard
11842 \change_deleted 564990737 1672743492
11843 This section describes how to use \SpecialChar LyX
11844 to make slides for overhead projectors.
11845 There are two document classes that can do this: the default slides class
11848 Foil\SpecialChar TeX
11852 This section documents the former.
11855 \begin_layout Standard
11857 \change_deleted 564990737 1672743492
11858 I'm going to say this again, nice and clear, so that there's no misunderstanding
11862 \begin_layout Standard
11864 \change_deleted 564990737 1672743492
11865 \begin_inset VSpace bigskip
11871 \begin_layout Standard
11874 \change_deleted 564990737 1672743492
11877 This section documents the class
11878 \begin_inset Quotes eld
11886 \begin_inset Quotes erd
11894 \begin_layout Standard
11896 \change_deleted 564990737 1672743492
11897 \begin_inset VSpace bigskip
11903 \begin_layout Standard
11905 \change_deleted 564990737 1672743492
11906 If you're looking for the documentation for
11907 \begin_inset Quotes eld
11912 slides (Foil\SpecialChar TeX
11916 \begin_inset Quotes erd
11919 , check out section
11920 \begin_inset space ~
11924 \begin_inset CommandInset ref
11926 reference "sec:foiltex"
11936 \begin_inset Quotes eld
11941 slides (Foil\SpecialChar TeX
11945 \begin_inset Quotes erd
11948 ] is actually somewhat better than the default
11956 \begin_layout Plain Layout
11958 or so I've been told repeatedly by its advocates.
11959 Having never used it, I have no idea if this claim is true or not.
11964 which this section documents.
11967 \begin_layout Standard
11969 \change_deleted 564990737 1672743492
11970 This class is the \SpecialChar LaTeX2e
11971 improvement of the old
11973 Sli\SpecialChar TeX
11977 Every \SpecialChar LaTeX2e
11978 distribution includes this class [which I'll just refer to as
11979 \begin_inset Quotes eld
11987 \begin_inset Quotes erd
11990 from now on], so you're bound to have it.
11991 As I noted earlier, there are other classes, such as
11995 , which also produce slides for overhead projectors and do a better job
11997 However, there are some things which
12001 can do which the others can't, such as generate overlays.
12002 Read on to learn more!
12007 \begin_layout Subsubsection
12009 \begin_inset CommandInset label
12011 name "sec:slidesetup"
12018 \begin_layout Standard
12019 Obviously, to use this document class, you need to select
12020 \begin_inset Quotes eld
12028 \begin_inset Quotes erd
12031 from the class list in the
12033 Document\SpecialChar menuseparator
12037 There are some other special things you should know about this class:
12040 \begin_layout Itemize
12041 Don't bother changing the options
12046 They're not supported by the
12053 \begin_layout Itemize
12057 \begin_inset space ~
12062 behaves a bit differently for this class.
12063 The possible choices and what they do are as follows:
12067 \begin_layout Description
12072 The final output contains page numbers in the lower right corner.
12075 \begin_layout Description
12084 , but also prints out any time markers you've put in.
12085 This is the default.
12088 \begin_layout Description
12093 The final output contains no page numbers, time markers, or alignment markers.
12097 \begin_layout Itemize
12102 class has an extra option:
12108 \begin_inset Quotes eld
12116 \begin_inset Quotes erd
12119 in the extra class options.
12123 \begin_layout Standard
12124 Using this options allows you to add time markers to
12130 \begin_inset space ~
12134 \begin_inset CommandInset ref
12136 reference "sec:slideNote"
12144 \begin_layout Standard
12145 You can also use the template file
12146 \change_deleted 564990737 1671617694
12148 \begin_inset Quotes eld
12156 \begin_inset Quotes erd
12161 to automatically set up a document to use the
12166 \change_deleted 564990737 1671617699
12171 File\SpecialChar menuseparator
12173 \begin_inset space ~
12177 \begin_inset space ~
12181 \change_inserted 564990737 1671617723
12182 \SpecialChar menuseparator
12183 Presentations\SpecialChar menuseparator
12188 to open your new document
12189 \change_deleted 564990737 1671617728
12193 The template file also contains some examples of the special paragraph
12194 environments used by this class.
12195 I'll describe those next.
12198 \begin_layout Subsubsection
12199 Paragraph Environments
12202 \begin_layout Paragraph
12203 Supported Environments
12206 \begin_layout Standard
12207 The first thing you'll notice when you start up a new
12211 document is the font size and type: it's the equivalent of the size
12212 \begin_inset Quotes eld
12220 \begin_inset Quotes erd
12226 \begin_inset space ~
12232 This is also what's used in the output.
12234 \begin_inset Quotes eld
12238 \begin_inset Quotes erd
12241 to remind you that this is a slide.
12242 Your final slides will use a larger font; ergo, you'll have less space.
12243 Of course, the larger default screen font isn't WYSIWYG, only a reminder.
12246 \begin_layout Standard
12247 The next thing that becomes obvious is the changes to the paragraph environment
12248 pull-down box [at the far-left end of the toolbar].
12249 Most of the paragraph environments you're used to seeing are missing.
12250 There are also five new ones.
12255 class itself only supports certain paragraph environments:
12258 \begin_layout Itemize
12264 \begin_layout Itemize
12270 \begin_layout Itemize
12276 \begin_layout Itemize
12282 \begin_layout Itemize
12288 \begin_layout Itemize
12294 \begin_layout Itemize
12300 \begin_layout Itemize
12306 \begin_layout Itemize
12312 \begin_layout Itemize
12319 \begin_layout Standard
12320 All of the other standard environments, including the section-heading environmen
12321 ts, aren't used in the
12328 \begin_layout Standard
12329 On the other hand, you'll notice the following new environments:
12332 \begin_layout Itemize
12338 \begin_layout Itemize
12344 \begin_layout Itemize
12350 \begin_layout Itemize
12356 \begin_layout Itemize
12362 \begin_layout Standard
12363 These five are kind of quirky, due to a
12364 \begin_inset Quotes eld
12368 \begin_inset Quotes erd
12371 in \SpecialChar LyX
12373 You see, \SpecialChar LyX
12374 doesn't permit you to nest any other paragraph environment into
12375 an empty environment.
12376 Now, that's fine and dandy, but it means that you wouldn't be able to start
12377 a slide with anything except plain text.
12378 To deal with this, I've performed a little
12379 \begin_inset Quotes eld
12384 \begin_inset Quotes erd
12390 \begin_layout Paragraph
12391 Quirks of the New Environments
12392 \begin_inset CommandInset label
12394 name "sec:slideQuirk"
12401 \begin_layout Standard
12402 All five of the new paragraph environments are somewhat quirky due to inherent
12403 limitiations in the current version of \SpecialChar LyX
12405 As I just mentioned, \SpecialChar LyX
12406 forbids environments that begin with another environment.
12407 To get around this, the
12411 environment isn't a paragraph environment as described in the
12419 \begin_layout Standard
12420 You should consider
12433 \begin_inset Quotes eld
12436 pseudo-environments.
12437 \begin_inset Quotes erd
12440 They look like a section heading or a
12441 \begin_inset Quotes eld
12449 \begin_inset Quotes erd
12452 but really begin a [and, if necessary, end the previous] paragraph environment.
12462 \begin_inset Quotes eld
12466 \begin_inset Quotes erd
12469 These two perform some action.
12472 \begin_layout Standard
12473 A common feature of all five environments,
12493 , is a rather long-ish label.
12494 The text following this label — ordinarily the contents of the paragraph
12495 environment — is utterly irrelevant for
12517 completely ignores it.
12518 In fact, you can leave these five environments completely empty.
12522 \begin_layout Standard
12527 to put any text after the rather long-ish label, you might want to.
12528 This could be a short description of the contents of the
12533 In that case, enter your descriptive comment and hit
12537 as you normally would.
12540 \begin_layout Standard
12541 If, on the other hand, you don't want to enter any descriptive text, you'll
12542 hit another \SpecialChar LyX
12545 , like nature, abhors a vacuum, and will not let you start a new paragraph
12546 environment until you put something in the old one.
12550 \begin_layout Itemize
12551 Start entering the text that will
12579 \begin_layout Itemize
12580 Now move to the beginning of that paragraph.
12584 \begin_layout Itemize
12593 \begin_layout Itemize
12594 Finally, change this new, empty paragraph to a
12618 \begin_layout Standard
12619 Some future version of \SpecialChar LyX
12620 will, hopefully, resolve this quirkiness\SpecialChar ldots
12624 \begin_layout Subsubsection
12625 Making a Presentation with
12638 \begin_layout Paragraph
12646 \begin_layout Standard
12647 If you're expecting this section to teach you how to actually make a presentatio
12648 n, you'll be sorely disappointed.
12649 Naturally, I'll describe all of the ways the
12653 class can assist you in preparing the materials for a presentation.
12654 Filling in the contents, however, is up to you.
12659 the \SpecialChar LyX
12663 \begin_layout Standard
12668 environment [in the manner described in section
12669 \begin_inset space ~
12673 \begin_inset CommandInset ref
12675 reference "sec:slideQuirk"
12679 ] tells \SpecialChar LyX
12680 to begin a new slide [duh].
12681 The label for this environment/
12682 \begin_inset Quotes erd
12686 \begin_inset Quotes erd
12690 \begin_inset Quotes eld
12694 \begin_inset Quotes erd
12697 in cool blue, followed by the label,
12698 \begin_inset Quotes eld
12702 \begin_inset Quotes erd
12706 Any text or paragraph environments that follow this one go on the new slide.
12710 \begin_layout Standard
12711 Slides are probably the only time you'll need to forcibly end pages in \SpecialChar LyX
12713 (this can be specified in the
12718 In fact, you'll want to, once you finish entering the contents of one slide.
12719 If you've entered more text than can physically fit on a slide, the extra
12720 overflows onto a new slide.
12721 I don't recommend doing this, however, since the overflow slide won't have
12722 any page number on it.
12723 Furthermore, it may interfere with any
12727 you've made to accompany the oversized
12734 \begin_layout Standard
12743 environments work the same way as the
12748 They both create an
12749 \begin_inset Quotes eld
12753 \begin_inset Quotes erd
12756 followed by a label [
12757 \begin_inset Quotes eld
12761 \begin_inset Quotes erd
12765 \begin_inset Quotes eld
12769 \begin_inset Quotes erd
12773 The color is a stunning magenta instead of blue, and the
12774 \begin_inset Quotes eld
12778 \begin_inset Quotes erd
12781 will look different, in style and in length.
12782 The label fonts of all three also differ from one another.
12785 \begin_layout Standard
12790 , if the contents of a
12798 exceed the physical size of a slide or sheet of paper, the extra will overflow
12800 Again, you should avoid this.
12801 It defeats the whole purpose of
12812 \begin_layout Paragraph
12822 \begin_layout Standard
12827 is a slide that sits atop another slide.
12828 Perhaps you wish to discuss a figure on the main
12832 before displaying the text associated with it.
12833 One way to accomplish this is tape a flap of dark paper over the part of
12838 you want to display later.
12839 This method fails, however, if you wish to overlap one graph with another,
12841 You would then have to fumble while speaking to align the two separate,
12846 s to align the two graphs.
12851 environment in both cases makes life much easier.
12854 \begin_layout Standard
12859 receives the page number of its
12860 \begin_inset Quotes eld
12864 \begin_inset Quotes erd
12872 \begin_inset Quotes eld
12880 \begin_inset Quotes erd
12887 \begin_layout Plain Layout
12888 Presumably, mutliple
12893 \begin_inset Quotes eld
12901 \begin_inset Quotes erd
12905 \begin_inset Quotes eld
12913 \begin_inset Quotes erd
12917 \begin_inset Quotes eld
12925 \begin_inset Quotes erd
12929 \begin_inset space ~
12932 appended to the page number of the parent
12942 Clearly, you want the contents of both the
12950 to each fit on a single physical slide! You should probably consider an
12956 \begin_inset Quotes eld
12960 \begin_inset Quotes erd
12968 Indeed, the \SpecialChar LyX
12973 class provides a visual cue for this: the label at the start of an
12977 is shorter than that at the start of a
12982 Lastly, when you generate printable output, you'll find alignment markers
12983 in all four corners of both the
12987 page and its parent
12992 These will assist you in lining up the two physical slides.
12995 \begin_layout Standard
12996 The major problem in overlaying two slides is aligning the contents of the
12997 two transparencies.
12998 How much space should you leave for that graph on the second slide? Worse
12999 still, what if you want a graph and a sentence on second slide, but there
13000 is text on the main transparency that goes in between them? You could try
13001 and insert vertical space of the right size.
13002 The better way is to use
13013 \begin_layout Standard
13014 As their names imply,
13022 are two command-like paragraph environments that make all subsequent text
13023 invisible and visible, respectively.
13025 \begin_inset space ~
13029 \begin_inset CommandInset ref
13031 reference "sec:slideQuirk"
13035 that you don't place anything
13039 these two environments, however.
13044 , it inserts a centered, sky-blue label into the page reading
13045 \begin_inset Quotes eld
13048 <Invisible Text Follows>
13049 \begin_inset Quotes erd
13053 For paragraphs following this label, the parts of the
13061 ; it doesn't matter which] where they would be contain instead blank space.
13065 \begin_layout Standard
13070 , the corresponding centered label is
13071 \begin_inset Quotes eld
13074 <Visible Text Follows>
13075 \begin_inset Quotes erd
13079 Paragraphs following this label behave normally.
13080 Note that the beginning of a new
13092 automatically shuts off an
13097 It's therefore not necessary to use
13108 \begin_layout Standard
13109 By now, it should be obvious how to create overlay transparencies using
13110 the proper combination of
13129 \begin_layout Enumerate
13134 , including everything that will appear on it, whether on the main slide
13142 \begin_layout Enumerate
13143 Before each figure or paragraph that will appear only on the
13152 If necessary, insert a
13156 environment after the
13163 \begin_layout Enumerate
13168 immediately following the
13175 \begin_layout Enumerate
13176 Copy the contents of this
13187 \begin_layout Enumerate
13192 , change all of the
13203 \begin_layout Standard
13205 You've just made an
13212 \begin_layout Standard
13213 There's one problem with the way I've designed the \SpecialChar LyX
13218 class: you can't make text in the middle of a paragraph invisible, nor
13219 make text in the middle of an invisible paragraph visible again.
13220 To accomplish this feat, you'll need to use some inlined \SpecialChar LaTeX
13225 \begin_layout Plain Layout
13226 The commands of interest are:
13229 \begin_layout Itemize
13234 invisible \SpecialChar ldots
13238 \begin_layout Itemize
13243 visible \SpecialChar ldots
13247 \begin_layout Plain Layout
13249 and need to be marked as \SpecialChar TeX
13252 \begin_inset Quotes eld
13256 \begin_inset Quotes erd
13259 you wish to change goes in between the brackets [and after the
13272 If you don't know how to mark text as \SpecialChar TeX
13273 , see the appropriate section of
13286 \begin_layout Paragraph
13296 \begin_inset CommandInset label
13298 name "sec:slideNote"
13305 \begin_layout Standard
13314 is associated with a
13315 \begin_inset Quotes eld
13319 \begin_inset Quotes erd
13327 Here, too, the \SpecialChar LyX
13332 class provides visual cues.
13337 is shorter than that of a
13341 [yet longer than that of an
13345 ] and, like the label of an
13349 is shockingly magenta.
13350 Additionally, the printed
13354 has the page number of its
13355 \begin_inset Quotes eld
13359 \begin_inset Quotes erd
13367 \begin_inset Quotes eld
13375 \begin_inset Quotes erd
13379 \begin_inset Quotes eld
13387 \begin_inset Quotes erd
13391 \begin_inset Quotes eld
13399 \begin_inset Quotes erd
13403 You can have multiple
13407 s associated with a single
13419 , you'll probably want to break up long
13423 s so that they fit on a single sheet of paper.
13426 \begin_layout Standard
13431 is obvious: it contains anything additional you might want to say about
13437 It could also be used as a sheet of reminders for a particular
13442 In the case of the latter, you might want to make use of time markers.
13443 Currently, the \SpecialChar LyX
13449 \begin_inset Quotes eld
13453 \begin_inset Quotes erd
13456 support for time markers, a
13458 Sli\SpecialChar TeX
13462 So, you'll have to resort to using the \SpecialChar LaTeX
13466 \begin_layout Standard
13467 To use time markers, you'll need to specify the extra class option
13468 \begin_inset Quotes eld
13476 \begin_inset Quotes erd
13480 \begin_inset space ~
13484 \begin_inset CommandInset ref
13486 reference "sec:slidesetup"
13491 This option turns on timing marks, which will appear in the lower-left-hand
13497 To set what appears in the time marker, you use the \SpecialChar LaTeX
13499 \begin_inset Quotes eld
13509 \begin_inset Quotes erd
13513 \begin_inset Quotes eld
13523 \begin_inset Quotes erd
13527 The arguments of both commands are time measured in seconds.
13529 \begin_inset Quotes eld
13539 \begin_inset Quotes erd
13542 sets the time marker to a given time.
13544 \begin_inset Quotes eld
13554 \begin_inset Quotes erd
13557 increments the time marker by the specified amount.
13558 Using time markers and
13562 s in this fashion, you can remind yourself how much time to spend on a particula
13570 \begin_layout Standard
13571 There's one last feature to describe.
13572 Clearly, you'd like to print out all of your
13580 s on transparencies while printing all of your
13597 with which it is associated.
13598 What's a person to do?
13601 \begin_layout Standard
13602 Luckily, there are two \SpecialChar LaTeX
13603 commands that allow you to select what to print
13605 Both must be placed into the preamble of your document.
13607 \begin_inset Quotes eld
13619 \begin_inset Quotes erd
13622 will cause the output to contain only the
13631 Correspondingly, the command
13632 \begin_inset Quotes eld
13644 \begin_inset Quotes erd
13647 prevents the output of anything but
13652 I'd advise placing both commands in the preamble and initially comment
13654 You can then preview your entire presentation as you write.
13655 When you're done writing, you can then uncomment one of the two to select
13656 what you want to print.
13657 I like to uncomment
13658 \begin_inset Quotes eld
13670 \begin_inset Quotes erd
13673 , print to a file with
13674 \begin_inset Quotes eld
13682 \begin_inset Quotes erd
13685 in its name, comment it back out, then uncomment
13686 \begin_inset Quotes eld
13698 \begin_inset Quotes erd
13702 \begin_inset Quotes eld
13710 \begin_inset Quotes erd
13714 I can then send either file to a printer, loading transparencies or plain
13715 paper as appropriate.
13718 \begin_layout Standard
13719 You can also provide other arguments to the
13720 \begin_inset Quotes eld
13730 \begin_inset Quotes erd
13734 \begin_inset Quotes eld
13744 \begin_inset Quotes erd
13748 See a good \SpecialChar LaTeX
13752 \begin_layout Subsubsection
13757 Class Template File
13760 \begin_layout Standard
13761 I have also provided a template file
13762 \change_deleted 564990737 1671617750
13764 \begin_inset Quotes eld
13772 \begin_inset Quotes erd
13782 To use it, begin your new presentation with
13784 File\SpecialChar menuseparator
13786 \begin_inset space ~
13790 \begin_inset space ~
13794 \change_inserted 564990737 1671616988
13795 \SpecialChar menuseparator
13796 Presentations\SpecialChar menuseparator
13802 Your new \SpecialChar LyX
13803 presentation file will contain an example
13824 additionally contain an example of the use of
13833 Lastly, the preamble will contain:
13836 \begin_layout LyX-Code
13837 % Uncomment to print out only slides and overlays
13840 \begin_layout LyX-Code
13844 \begin_layout LyX-Code
13850 \begin_inset Newline newline
13856 \begin_layout LyX-Code
13857 % Uncomment to print out only notes
13860 \begin_layout LyX-Code
13864 \begin_layout LyX-Code
13872 \begin_layout Standard
13873 One final thing: I created this class to support the \SpecialChar LaTeX2e
13875 \begin_inset Quotes eld
13880 Sli\SpecialChar TeX
13884 \begin_inset Quotes erd
13887 class, one of the built-in \SpecialChar LaTeX2e
13889 Neither I nor the rest of the \SpecialChar LyX
13890 Team endorse or oppose the use of this built-in
13892 It's here if you want it or need it.
13893 There exist other \SpecialChar LaTeX2e
13894 classes for creating presentations, such as the
13899 \begin_inset space ~
13903 \begin_inset CommandInset ref
13905 reference "sec:foiltex"
13910 \begin_inset Quotes eld
13918 \begin_inset Quotes erd
13921 package [present on some \SpecialChar TeX
13923 The latter is not yet supported under \SpecialChar LyX
13928 \begin_layout Plain Layout
13929 Perhaps you can take on the task\SpecialChar ldots
13935 I know nothing about these other classes.
13936 Try them out to see what sort of alternative they provide.
13939 \begin_layout Section
13941 \change_inserted 564990737 1670439661
13945 \begin_layout Subsection
13947 \change_inserted 564990737 1670439661
13951 \begin_layout Standard
13953 \change_inserted 564990737 1670439661
13962 document class for preparing reports.
13967 document class, this provides parts, chapters and sections but does not
13968 provide the paragraph styles needed for a book; like the
13972 document class, it provides the abstract paragraph style.
13973 In two-sided mode, it does not start a new chapter on the right hand page.
13976 \begin_layout Standard
13978 \change_inserted 564990737 1672743528
13983 document classes are described in the Collections (section
13984 \begin_inset space ~
13988 \begin_inset CommandInset ref
13990 reference "sec:Collections"
13997 \begin_layout Standard
13999 \change_inserted 564990737 1672743530
14005 \begin_inset space \thinspace{}
14008 (Japanese in vertical writing)
14013 \begin_inset space \thinspace{}
14019 \begin_inset space ~
14023 \begin_inset CommandInset ref
14025 reference "subsec:Japanese"
14032 \begin_layout Standard
14034 \change_inserted 564990737 1672743530
14040 \begin_inset space \thinspace{}
14046 \begin_inset space ~
14050 \begin_inset CommandInset ref
14052 reference "subsec:KOMA-Script"
14059 \begin_layout Standard
14061 \change_inserted 564990737 1672743530
14067 \begin_inset space \thinspace{}
14070 (with extra font sizes)
14073 \begin_inset space ~
14077 \begin_inset CommandInset ref
14079 reference "subsec:Extra-font-sizes"
14086 \begin_layout Standard
14088 \change_inserted 564990737 1672743569
14094 \begin_inset space \thinspace{}
14097 (Polish version by M.
14098 \begin_inset space \thinspace{}
14104 \begin_inset space ~
14108 \begin_inset CommandInset ref
14110 reference "subsec:Polish-M.W.collection"
14120 \begin_layout Section
14122 \change_inserted 564990737 1670439674
14126 \begin_layout Subsection
14130 \begin_layout Standard
14136 \begin_layout Subsubsection
14140 \begin_layout Standard
14141 Broadway is for writing plays.
14142 The format is more decorative than Hollywood, and much less standardized.
14143 This format should be suitable for workshops.
14146 \begin_layout Subsubsection
14150 \begin_layout Standard
14151 The same as in Hollywood.
14154 \begin_layout Subsubsection
14158 \begin_layout Standard
14163 names as labels then cross-reference the label to insert the name.
14164 The cross-reference dialog will show the current cast of characters.
14167 \begin_layout Subsubsection
14168 Paper size and Margins
14171 \begin_layout Standard
14172 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
14175 \begin_layout Subsubsection
14179 \begin_layout Standard
14180 The following environments are available.
14181 You can use broadway.bind to get the bind keys shown at the right.
14184 \begin_layout Itemize
14188 \begin_inset Newline newline
14193 You should not have to use this, but it is here for anything that does not
14197 \begin_layout Itemize
14201 \begin_inset space \hfill{}
14205 \begin_inset Newline newline
14210 Used to describe stage setting and the action.
14211 First use of speaker names in all CAPs.
14214 \begin_layout Itemize
14218 \begin_inset space \hfill{}
14222 \begin_inset Newline newline
14227 Automatically numbered.
14228 On screen it will be arabic, but will print as Roman.
14231 \begin_layout Itemize
14235 \begin_inset space \hfill{}
14239 \begin_inset Newline newline
14249 It is just centered text.
14252 \begin_layout Itemize
14256 \begin_inset space \hfill{}
14260 \begin_inset Newline newline
14265 Not automatically numbered.
14266 You supply the number.
14267 This is because I couldn't figure out how.
14270 \begin_layout Itemize
14274 \begin_inset space \hfill{}
14278 \begin_inset Newline newline
14283 A special case of Narrative to describe the setting and action as the curtain
14287 \begin_layout Itemize
14291 \begin_inset space \hfill{}
14295 \begin_inset Newline newline
14300 The speaker's (actor's) title, centered in all CAPS.
14303 \begin_layout Itemize
14307 \begin_inset space \hfill{}
14311 \begin_inset Newline newline
14316 Instructions to the speaker.
14317 The parentheses are automatically inserted.
14318 The ( will appear on screen, but both will be in the printed play.
14319 This environment is only used within
14326 \begin_layout Itemize
14330 \begin_inset space \hfill{}
14334 \begin_inset Newline newline
14339 What the Speaker says.
14342 \begin_layout Itemize
14346 \begin_inset space \hfill{}
14350 \begin_inset Newline newline
14355 The curtain comes down.
14358 \begin_layout Itemize
14362 \begin_inset space \hfill{}
14368 \begin_layout Itemize
14372 \begin_inset space \hfill{}
14378 \begin_layout Itemize
14382 \begin_inset space \hfill{}
14388 \begin_layout Standard
14392 \begin_layout Subsection
14393 Hollywood (Hollywood spec scripts)
14396 \begin_layout Standard
14402 \begin_layout Subsubsection
14406 \begin_layout Standard
14407 Getting the format of a Hollywood script right is a
14408 \begin_inset Quotes eld
14412 \begin_inset Quotes erd
14415 It is designed to make the readers focus on content and to be easy and
14416 familiar for the actors to read.
14417 Each page of a script should be one minute of film.
14418 Nothing goes in a script that you cannot see or hear on screen.
14419 The courier 12 pt font should be used throughout.
14423 \begin_layout Subsubsection
14427 \begin_layout Standard
14428 Speakers' lines should NEVER break in mid-sentence.
14429 If a speaker's lines continue over a page break, repeat the
14433 title followed by (Cont'd).
14436 \begin_layout Subsubsection
14440 \begin_layout Standard
14445 names as labels then cross-reference the label to insert the name.
14446 The cross-reference dialog will show the current cast of characters.
14447 You can use this to insert the speaker name in narratives also.
14450 \begin_layout Subsubsection
14451 Paper size and Margins
14454 \begin_layout Standard
14455 USLetter, left 1.6in, right 0.75in, top 0.5in, bottom 0.75in
14458 \begin_layout Subsubsection
14462 \begin_layout Standard
14463 The following environments are available.
14464 You can use hollywood.bind to get the bind keys shown at the right.
14467 \begin_layout Itemize
14471 \begin_inset Newline newline
14476 Used where nothing else works.
14480 \begin_layout Itemize
14486 \begin_inset space \hfill{}
14494 \begin_inset Newline newline
14497 Usually followed by something like
14498 \begin_inset Quotes eld
14501 on Sally waking up.
14502 \begin_inset Quotes erd
14508 \begin_layout Itemize
14512 \begin_inset space \hfill{}
14516 \begin_inset Newline newline
14521 Introduces a new INTERIOR camera set-up.
14522 Always followed by DAY or NIGHT, or something similar to define the lighting
14524 Everthing on this line in CAPS.
14527 \begin_layout Itemize
14531 \begin_inset space \hfill{}
14535 \begin_inset Newline newline
14540 Introduces a new EXTERIOR camera set-up.
14541 Everthing on this line in CAPS.
14544 \begin_layout Itemize
14548 \begin_inset space \hfill{}
14552 \begin_inset Newline newline
14557 The character speaking.
14560 \begin_layout Itemize
14564 \begin_inset space \hfill{}
14568 \begin_inset Newline newline
14573 Instructions to the speaker.
14574 The () are automatically inserted.
14577 \begin_layout Itemize
14581 \begin_inset space \hfill{}
14585 \begin_inset Newline newline
14597 \begin_layout Itemize
14601 \begin_inset space \hfill{}
14605 \begin_inset Newline newline
14610 Camera movement instruction.
14612 \begin_inset space \thinspace{}
14616 \begin_inset space \space{}
14622 \begin_layout Itemize
14626 \begin_inset space \hfill{}
14632 \begin_layout Itemize
14636 \begin_inset space \hfill{}
14642 \begin_layout Itemize
14646 \begin_inset space \hfill{}
14652 \begin_layout Itemize
14656 \begin_inset space \hfill{}
14662 \begin_layout Subsubsection
14666 \begin_layout Itemize
14670 \begin_layout Itemize
14674 \begin_layout Itemize
14676 \begin_inset space \thinspace{}
14683 \begin_layout Itemize
14688 \begin_layout Itemize
14689 PAN — camera movement
14692 \begin_layout Itemize
14693 INSERT — cut to close-up of
14696 \begin_layout Chapter
14698 \change_inserted 564990737 1671185876
14702 \begin_layout Section
14704 \change_inserted 564990737 1671716212
14707 Academic Field Specifics
14710 \begin_layout Subsection
14712 \change_inserted 564990737 1671716212
14715 Chemistry: Hazard and Precautionary Statements
14718 \begin_layout Standard
14720 \change_inserted 564990737 1671716212
14723 This module provides two insets to typeset numbers and phrases of chemical
14724 hazard and precautionary statements.
14725 For a description see
14728 File\SpecialChar menuseparator
14729 Open Example\SpecialChar menuseparator
14730 Modules\SpecialChar menuseparator
14731 Hazard and Precautionary Statements
14735 Help\SpecialChar menuseparator
14736 Specific Manuals\SpecialChar menuseparator
14737 Hazard and Precautionary Statements
14743 \begin_layout Subsection
14745 \change_inserted 564990737 1671716212
14749 Chemistry: Risk and Safety Statements
14752 \begin_layout Standard
14754 \change_inserted 564990737 1671716212
14757 This module provides two insets,
14765 , accessible via the menu
14770 nsert\SpecialChar menuseparator
14772 \begin_inset space ~
14777 and an environment to typeset numbers and phrases of chemical risk and
14781 \begin_layout Subsection
14783 \change_inserted 564990737 1671716212
14789 \begin_layout Standard
14791 \change_inserted 564990737 1671716212
14794 This module uses the
14798 package to add environments useful for linguistics (numbered examples,
14799 glosses, semantic markup, tableau floats).
14800 You can obtain information about this module in
14805 elp\SpecialChar menuseparator
14811 \begin_inset space ~
14814 Manuals\SpecialChar menuseparator
14824 File\SpecialChar menuseparator
14825 Open Example\SpecialChar menuseparator
14828 Modules\SpecialChar menuseparator
14834 \begin_layout Section
14836 \change_inserted 564990737 1671788778
14842 \begin_layout Subsection
14844 \change_inserted 564990737 1671788778
14850 \begin_layout Standard
14852 \change_inserted 564990737 1671788778
14855 This module supports the Braille writing system.
14856 It requires the \SpecialChar LaTeX
14862 This and its documentation can be obtained from
14863 \begin_inset CommandInset href
14866 target "https://www.ctan.org/pkg/braille"
14872 You do not have to reconfigure your system after installing it.
14878 elp\SpecialChar menuseparator
14884 \begin_inset space ~
14887 Manuals\SpecialChar menuseparator
14896 File\SpecialChar menuseparator
14897 Open Example\SpecialChar menuseparator
14898 Modules\SpecialChar menuseparator
14904 \begin_layout Section
14906 \change_inserted 564990737 1671788778
14909 Annotation & Revision
14912 \begin_layout Subsection
14914 \change_inserted 564990737 1671788778
14920 \begin_layout Standard
14922 \change_inserted 564990737 1671788778
14925 This module provides “FiXme” (marginal) annotations for document revision
14927 A list of annotations can be produced by using the “List of FIXMEs” paragraph
14929 The annotations are customizable via the LaTeX preamble.
14930 See the FiXme documentation which can be obtained from
14931 \begin_inset CommandInset href
14934 target "http://mirrors.ctan.org/macros/latex/contrib/fixme/fixme.pdf"
14943 \begin_layout Paragraph
14945 \change_inserted 564990737 1671788778
14951 \begin_layout Standard
14953 \change_inserted 564990737 1671788778
14956 by default, the notes are only displayed in “draft” mode (if the option
14957 “draft” has been inserted in
14959 Document\SpecialChar menuseparator
14960 Settings\SpecialChar menuseparator
14961 Document Class\SpecialChar menuseparator
14962 Class Options\SpecialChar menuseparator
14966 To display them always, insert
14974 Document\SpecialChar menuseparator
14975 Settings\SpecialChar menuseparator
14983 \begin_layout Subsection
14985 \change_inserted 564990737 1671788778
14991 \begin_layout Standard
14993 \change_inserted 564990737 1671788778
14996 This module provides various kinds of annotations for PDF output.
14999 Help\SpecialChar menuseparator
15000 Specific Manuals\SpecialChar menuseparator
15001 PDF comments and File\SpecialChar menuseparator
15002 Open Example\SpecialChar menuseparator
15003 Modules\SpecialChar menuseparator
15009 \begin_layout Subsection
15011 \change_inserted 564990737 1671788778
15018 \begin_layout Standard
15020 \change_inserted 564990737 1671788778
15023 This module provides fields and buttons for PDF forms.
15025 \begin_inset CommandInset href
15027 name "hyperref documentation"
15028 target "http://mirrors.ctan.org/macros/latex/contrib/hyperref/doc/hyperref-doc.pdf"
15035 Help\SpecialChar menuseparator
15036 Specific Manuals\SpecialChar menuseparator
15037 PDF forms and File\SpecialChar menuseparator
15038 Open Example\SpecialChar menuseparator
15039 Modules\SpecialChar menuseparator
15045 \begin_layout Subsection
15047 \change_inserted 564990737 1671788778
15054 \begin_layout Standard
15056 \change_inserted 564990737 1671788778
15059 This module defines an inset to typeset reading aids (ruby, furigana) to
15060 Chinese characters.
15061 It uses the “okumakro,” “luatexja-ruby” or “ruby” package (depending on
15062 the TeX engine) or a fallback definition.
15066 \begin_layout Subsection
15068 \change_inserted 564990737 1671788778
15075 \begin_layout Standard
15077 \change_inserted 564990737 1671788778
15080 This module provides custom insets to insert TODO items in your document.
15081 In order to generate a “List of TODOs,” the module provides a paragraph
15083 Inserting “final” in
15085 Document\SpecialChar menuseparator
15086 Settings\SpecialChar menuseparator
15087 Document Class\SpecialChar menuseparator
15088 Class Options\SpecialChar menuseparator
15091 ) suppresses the output of TODO notes.
15093 \begin_inset CommandInset href
15095 name "todonotes documentation"
15096 target "http://mirrors.ctan.org/macros/latex/contrib/todonotes/todonotes.pdf"
15104 \begin_layout Section
15106 \change_inserted 564990737 1671829045
15112 \begin_layout Subsection
15114 \change_inserted 564990737 1671829045
15117 APA Style with NatBib
15120 \begin_layout Standard
15122 \change_inserted 564990737 1671829045
15125 This module adds support for using natbib together with apacite (the bibliograph
15126 y style need not be apacite — it could be apacite, apacitex, or any bibliography
15127 that works with both the natbib and apacite packages.)
15130 \begin_layout Section
15132 \change_inserted 564990737 1671829045
15138 \begin_layout Subsection
15140 \change_inserted 564990737 1671829045
15143 Fancy Colored Boxes
15146 \begin_layout Standard
15148 \change_inserted 564990737 1671829045
15151 This module adds ten custom insets that support colored boxes via the tcolorbox
15155 Help\SpecialChar menuseparator
15156 Specific Manuals\SpecialChar menuseparator
15161 File\SpecialChar menuseparator
15162 Open Example\SpecialChar menuseparator
15163 Modules\SpecialChar menuseparator
15167 \begin_inset CommandInset href
15169 name "tcolorbox documentation"
15170 target "http://mirrors.ctan.org/macros/latex/contrib/tcolorbox/tcolorbox.pdf"
15179 \begin_layout Subsection
15181 \change_inserted 564990737 1671829045
15187 \begin_layout Standard
15189 \change_inserted 564990737 1671829045
15192 This provides the custom insets
15208 to scale and rotate its content.
15211 \begin_layout Standard
15213 \change_inserted 564990737 1671829045
15219 is a simple way of reversing text without any other enhancement:
15222 \begin_layout Standard
15224 \change_inserted 564990737 1671829045
15227 \begin_inset Flex Reflectbox
15230 \begin_layout Plain Layout
15232 \change_inserted 564990737 1671829045
15235 Great Western Railway
15245 \begin_layout Standard
15247 \change_inserted 564990737 1671829045
15250 (You will need to use Ctrl-R to see any of these examples.)
15253 \begin_layout Standard
15255 \change_inserted 564990737 1671829045
15261 allows you to specify the dimensions of the text or image; permissible
15262 units are em, ex, in, pt, pc, cm, mm, dd, cc, nd, nc, bp, or sp; if you
15271 it scales by the width factor:
15274 \begin_layout Standard
15276 \change_inserted 564990737 1671829045
15279 \begin_inset Flex Resizebox
15282 \begin_layout Plain Layout
15284 \change_inserted 564990737 1671829045
15287 \begin_inset Argument 1
15290 \begin_layout Plain Layout
15292 \change_inserted 564990737 1671829045
15303 \begin_inset Argument 2
15306 \begin_layout Plain Layout
15308 \change_inserted 564990737 1671829045
15318 Great Western Railway
15328 \begin_layout Standard
15330 \change_inserted 564990737 1671829045
15336 allows you to rotate text around the reference point of the box.
15337 If you wish to rotate the box around a different origin, place the cursor
15338 inside the box and select Insert\SpecialChar menuseparator
15363 or meaningful combinations of these and the counterclockwise rotation angle
15364 is expressed in degrees.
15368 \begin_layout Standard
15370 \change_inserted 564990737 1671829045
15373 \begin_inset Flex Rotatebox
15376 \begin_layout Plain Layout
15378 \change_inserted 564990737 1671829045
15381 \begin_inset Argument 1
15384 \begin_layout Plain Layout
15386 \change_inserted 564990737 1671829045
15397 \begin_inset Argument 2
15400 \begin_layout Plain Layout
15402 \change_inserted 564990737 1671829045
15412 Great Western Railway
15422 \begin_layout Standard
15424 \change_inserted 564990737 1671829045
15427 You can combine boxes as in:
15430 \begin_layout Standard
15432 \change_inserted 564990737 1671829045
15435 \begin_inset Flex Rotatebox
15438 \begin_layout Plain Layout
15440 \change_inserted 564990737 1671829045
15443 \begin_inset Argument 1
15446 \begin_layout Plain Layout
15448 \change_inserted 564990737 1671829045
15459 \begin_inset Argument 2
15462 \begin_layout Plain Layout
15464 \change_inserted 564990737 1671829045
15475 \begin_inset Flex Resizebox
15478 \begin_layout Plain Layout
15480 \change_inserted 564990737 1671829045
15483 \begin_inset Argument 1
15486 \begin_layout Plain Layout
15488 \change_inserted 564990737 1671829045
15499 \begin_inset Argument 2
15502 \begin_layout Plain Layout
15504 \change_inserted 564990737 1671829045
15515 \begin_inset Flex Reflectbox
15518 \begin_layout Plain Layout
15520 \change_inserted 564990737 1671829045
15523 Great Western Railway
15547 \begin_layout Standard
15549 \change_inserted 564990737 1671829045
15555 scales text; select Insert\SpecialChar menuseparator
15556 V-Factor to add a vertical factor.
15557 If the vertical factor is omitted, the horizontal is used.
15558 Adding different horizontal and vertical values creates distortion as in
15562 \begin_layout Standard
15564 \change_inserted 564990737 1671829045
15568 \begin_inset Flex Scalebox
15571 \begin_layout Plain Layout
15573 \change_inserted 564990737 1671829045
15576 \begin_inset Argument 1
15579 \begin_layout Plain Layout
15581 \change_inserted 564990737 1671829045
15592 \begin_inset Argument 2
15595 \begin_layout Plain Layout
15597 \change_inserted 564990737 1671829045
15609 Great Western Railway
15619 \begin_layout Standard
15621 \change_inserted 564990737 1671829045
15624 A negative horizontal value reverses the text and a negative vertical value
15625 inverts it so that you get
15628 \begin_layout Standard
15630 \change_inserted 564990737 1671829045
15633 \begin_inset Flex Scalebox
15636 \begin_layout Plain Layout
15638 \change_inserted 564990737 1671829045
15641 \begin_inset Argument 1
15644 \begin_layout Plain Layout
15646 \change_inserted 564990737 1671829045
15657 \begin_inset Argument 2
15660 \begin_layout Plain Layout
15662 \change_inserted 564990737 1671829045
15672 Great Western Railway
15680 \begin_inset Flex Scalebox
15683 \begin_layout Plain Layout
15685 \change_inserted 564990737 1671829045
15688 \begin_inset Argument 1
15691 \begin_layout Plain Layout
15693 \change_inserted 564990737 1671829045
15704 \begin_inset Argument 2
15707 \begin_layout Plain Layout
15709 \change_inserted 564990737 1671829045
15719 Great Western Railway
15729 \begin_layout Subsection
15731 \change_inserted 564990737 1671884699
15737 \begin_layout Standard
15739 \change_inserted 564990737 1671884699
15742 This module defines Boxes with section header.
15743 It is mainly intended for the SciPoster Document class.
15747 \begin_layout Subsection
15749 \change_inserted 564990737 1671884699
15752 Variable-width Minipages
15755 \begin_layout Standard
15757 \change_inserted 564990737 1671884699
15763 \begin_inset space \thinspace{}
15770 Insert\SpecialChar menuseparator
15782 package provides a variable-width minipage, whose resulting width is the
15783 width of its contents (if this does not exceed the specified maximum width).
15784 The inset has two optional arguments which can be added by placing the
15785 cursor inside the minipage and entering
15787 Insert\SpecialChar menuseparator
15789 \begin_inset space \thinspace{}
15800 Insert\SpecialChar menuseparator
15802 \begin_inset space \thinspace{}
15816 File\SpecialChar menuseparator
15817 Open Example\SpecialChar menuseparator
15818 Variable-width Minipages
15824 \begin_layout Section
15826 \change_inserted 564990737 1671884699
15832 \begin_layout Subsection
15834 \change_inserted 564990737 1671884699
15837 Fix Computer Modern Fonts
15840 \begin_layout Standard
15842 \change_inserted 564990737 1671884699
15845 This module uses the
15849 package to improve the appearance of Computer Modern fonts and make them
15850 available with arbitrary sizes.
15852 \begin_inset CommandInset href
15854 name "fix-cm documentation"
15855 target "http://mirrors.ctan.org/macros/latex/base/fix-cm.pdf"
15864 \begin_layout Subsection
15866 \change_inserted 564990737 1671884699
15870 Kernel Fixes (Obsolete)
15873 \begin_layout Standard
15875 \change_inserted 564990737 1671884699
15878 This module loads the \SpecialChar LaTeX
15883 which contains some bug fixes for \SpecialChar LaTeX
15885 If you use this module your typeset document may look different when you
15886 process it, depending on the respective version of
15894 \begin_layout Paragraph
15896 \change_inserted 564990737 1671884699
15902 \begin_layout Standard
15904 \change_inserted 564990737 1671884699
15907 recent \SpecialChar LaTeX
15908 kernels (as of 2015/01/01) include the functionality of
15916 module is obsolete with newer \SpecialChar LaTeX
15921 \begin_layout Subsection
15923 \change_inserted 564990737 1671884699
15926 Minimalistic Insets
15929 \begin_layout Standard
15931 \change_inserted 564990737 1671884699
15934 This module redefines several insets (Index, Branch, URL) as being Minimalistic.
15937 \begin_layout Subsection
15939 \change_inserted 564990737 1671884699
15942 Title and Preamble Hacks
15945 \begin_layout Standard
15947 \change_inserted 564990737 1671884699
15950 This module provides two new paragraph styles:
15953 \begin_layout Enumerate
15955 \change_inserted 564990737 1671884699
15961 which puts whatever is entered into it into the preamble.
15962 This can be used, if one wishes, to include preamble code in the body of
15967 \begin_layout Enumerate
15969 \change_inserted 564990737 1671884699
15975 which that will put its contents into the body of the LaTeX document, but
15983 This is useful for making branches and notes in title-related material.
15984 (However, if you put these in a Standard layout, this signals to LyX to
15991 , which may then come too early.)
15994 \begin_layout Section
15996 \change_inserted 564990737 1672081439
16002 \begin_layout Subsection
16004 \change_inserted 564990737 1672081439
16010 \begin_layout Standard
16012 \change_inserted 564990737 1672081439
16015 This module uses the
16019 package for algorithm floats rather than LyX’s home-brewed algorithm floats.
16020 Use the Algorithm paragraph style to enter and indent the algorithm.
16022 \begin_inset CommandInset href
16024 name "algorithm2e documentation"
16025 target "http://mirrors.ctan.org/macros/latex/contrib/algorithm2e/doc/algorithm2e.pdf"
16033 \begin_layout Subsection
16035 \change_inserted 564990737 1672081439
16038 Bilingual Captions AKA Multilingual Captions
16041 \begin_layout Standard
16043 \change_inserted 564990737 1672081439
16046 This module provides the paragraph style
16049 \begin_inset space ~
16054 with which to typeset multilingual captions.
16055 Within this paragraph style
16057 Insert\SpecialChar menuseparator
16060 allows you to enter the desired language using one of the babel names.
16063 File\SpecialChar menuseparator
16064 Open Example\SpecialChar menuseparator
16065 Multilingual Captions
16069 Help\SpecialChar menuseparator
16070 Specific Manuals\SpecialChar menuseparator
16071 Multilingual Captions
16073 further information on its use.
16076 \begin_layout Subsection
16078 \change_inserted 564990737 1672081439
16081 Number Figures by Section
16084 \begin_layout Standard
16086 \change_inserted 564990737 1672081439
16089 This module resets the figure number at section start and prepends the section
16090 number to the figure number, as in “Figure 2.1.” (By default book and report
16091 document classes number by Chapter and article document classes have a
16095 \begin_layout Subsection
16097 \change_inserted 564990737 1672081439
16100 Number Tables by Section
16103 \begin_layout Standard
16105 \change_inserted 564990737 1672081439
16108 This module resets the table number at section start and prepends the section
16109 number to the table number, as in “Table 2.1.” (By default book and report
16110 document classes number by Chapter and article document classes have a
16114 \begin_layout Section
16116 \change_inserted 564990737 1672081439
16122 \begin_layout Subsection
16124 \change_inserted 564990737 1672081439
16130 \begin_layout Standard
16132 \change_inserted 564990737 1672081439
16135 This module adds an endnote inset, in addition to footnotes.
16140 package, which has some limitations but works with older LaTeX distributions
16144 Insert\SpecialChar menuseparator
16145 Custom Inset\SpecialChar menuseparator
16148 to insert an endnote and
16150 Insert\SpecialChar menuseparator
16151 List/Contents/References\SpecialChar menuseparator
16154 to insert the endnotes list where you want the endnotes to appear.
16157 Help\SpecialChar menuseparator
16158 Embedded\SpecialChar menuseparator
16159 Objects\SpecialChar menuseparator
16160 Notes\SpecialChar menuseparator
16166 \begin_layout Subsection
16168 \change_inserted 564990737 1672081439
16171 Endnotes (Extended)
16174 \begin_layout Standard
16176 \change_inserted 564990737 1672081439
16179 This module adds an endnote inset, in addition to footnotes.
16184 package which is more powerful and customizable than the
16188 package, but requires a fairly modern LaTeX distribution (with LaTeX3).
16191 Insert\SpecialChar menuseparator
16192 Custom Inset\SpecialChar menuseparator
16195 to insert an endnote and
16197 Insert\SpecialChar menuseparator
16198 List/Contents/References\SpecialChar menuseparator
16201 to insert the endnotes list where you want the endnotes to appear.
16204 Help\SpecialChar menuseparator
16205 Embedded\SpecialChar menuseparator
16206 Objects\SpecialChar menuseparator
16207 Notes\SpecialChar menuseparator
16213 \begin_layout Subsection
16215 \change_inserted 564990737 1672081439
16218 Footnotes as Endnotes (Basic)
16221 \begin_layout Standard
16223 \change_inserted 564990737 1672081439
16226 This module sets all footnotes as endnotes.
16231 package, which has some limitations but works with older LaTeX distributions
16235 Insert\SpecialChar menuseparator
16236 List/Contents/References\SpecialChar menuseparator
16239 to insert the endnotes list where you want the endnotes to appear.
16242 Help\SpecialChar menuseparator
16243 Embedded\SpecialChar menuseparator
16244 Objects\SpecialChar menuseparator
16245 Notes\SpecialChar menuseparator
16251 \begin_layout Subsection
16253 \change_inserted 564990737 1672081439
16256 Footnotes as Endnotes (Extended)
16259 \begin_layout Standard
16261 \change_inserted 564990737 1672081439
16264 This module sets all footnotes as endnotes.
16269 package which is more powerful and customizable than then
16273 package, but requires a fairly modern LaTeX distribution (with LaTeX3).
16276 Insert\SpecialChar menuseparator
16277 List/Contents/References\SpecialChar menuseparator
16280 to insert the endnotes list where you want the endnotes to appear.
16283 Help\SpecialChar menuseparator
16284 Embedded\SpecialChar menuseparator
16285 Objects\SpecialChar menuseparator
16286 Notes\SpecialChar menuseparator
16292 \begin_layout Section
16294 \change_inserted 564990737 1672081439
16297 Leisure, Sports and Music
16300 \begin_layout Subsection
16302 \change_inserted 564990737 1672081439
16308 \begin_layout Standard
16310 \change_inserted 564990737 1672081439
16313 This module provides support for the
16317 package to print chess games.
16320 File\SpecialChar menuseparator
16321 Open Example\SpecialChar menuseparator
16322 Articles\SpecialChar menuseparator
16325 where you will find
16334 \begin_inset CommandInset href
16336 name "chessboard documentation"
16337 target "http://mirrors.ctan.org/macros/latex/contrib/chessboard/chessboard.pdf"
16345 \begin_layout Subsection
16347 \change_inserted 564990737 1672081439
16350 Lilypond Music Notation
16353 \begin_layout Standard
16355 \change_inserted 564990737 1672081439
16358 This module provides an inset via
16363 nsert\SpecialChar menuseparator
16364 Custom Inset\SpecialChar menuseparator
16367 in which to enter code for the LilyPond music editor.
16368 It will then be processed in the output.
16371 Help\SpecialChar menuseparator
16372 Specific Manuals\SpecialChar menuseparator
16377 File\SpecialChar menuseparator
16378 Open Example\SpecialChar menuseparator
16379 Modules\SpecialChar menuseparator
16383 It cannot be used if the modules
16386 \begin_inset space \thinspace{}
16394 \begin_layout Section
16396 \change_inserted 564990737 1672138150
16402 \begin_layout Subsection
16404 \change_inserted 564990737 1672138150
16408 \begin_inset CommandInset label
16410 name "subsec:Customizable-Lists"
16417 \begin_layout Standard
16419 \change_inserted 564990737 1672138150
16422 This module uses the
16426 package to enable the customization of various list environments.
16429 \begin_layout Subsubsection
16431 \change_inserted 564990737 1672138150
16434 Custom Enumerate Lists
16437 \begin_layout Standard
16440 \change_inserted 564990737 1672138150
16443 The default numbering of numbered lists can be changed by adding an optional
16449 nsert\SpecialChar menuseparator
16456 ) to the first item of each level in the list.
16457 There you add the command
16460 \begin_layout Standard
16462 \change_inserted 564990737 1672138150
16471 \begin_layout Standard
16473 \change_inserted 564990737 1672138150
16476 in \SpecialChar TeX
16486 \begin_layout Standard
16488 \change_inserted 564990737 1672138150
16494 is the first level counter of the enumeration.
16495 To change the numbering for the list sublevels, replace the “
16499 ” in the command by the small Roman numeral of the level (
16518 \begin_layout Standard
16520 \change_inserted 564990737 1672138150
16529 outputs the counter as a small Roman numeral.
16530 For capital Roman numerals replace
16542 in the command above.
16543 For Arabic numerals use
16551 \begin_inset Quotes eld
16555 \begin_inset Quotes erd
16558 items with capital or small Latin letters use
16573 \begin_layout Standard
16576 \change_inserted 564990737 1672138150
16579 \begin_inset Note Greyedout
16582 \begin_layout Plain Layout
16584 \change_inserted 564990737 1672138150
16590 You can only number 26
16591 \begin_inset space ~
16594 items with Latin letters, because this numbering is limited to single letters.
16602 \begin_layout Standard
16604 \change_inserted 564990737 1672138150
16607 Here is a list with custom numbering:
16610 \begin_layout Enumerate
16612 \change_inserted 564990737 1672138150
16615 \begin_inset Argument 1
16618 \begin_layout Plain Layout
16620 \change_inserted 564990737 1672138150
16626 \begin_layout Plain Layout
16628 \change_inserted 564990737 1672138150
16649 \begin_inset Separator latexpar
16656 \begin_layout Enumerate
16658 \change_inserted 564990737 1672138150
16661 \begin_inset Argument 1
16664 \begin_layout Plain Layout
16666 \change_inserted 564990737 1672138150
16672 \begin_layout Plain Layout
16674 \change_inserted 564990737 1672138150
16695 \begin_layout Enumerate
16697 \change_inserted 564990737 1672138150
16701 \begin_inset Separator latexpar
16708 \begin_layout Enumerate
16710 \change_inserted 564990737 1672138150
16713 \begin_inset Argument 1
16716 \begin_layout Plain Layout
16718 \change_inserted 564990737 1672138150
16724 \begin_layout Plain Layout
16726 \change_inserted 564990737 1672138150
16745 \begin_inset Separator latexpar
16752 \begin_layout Enumerate
16754 \change_inserted 564990737 1672138150
16757 \begin_inset Argument 1
16760 \begin_layout Plain Layout
16762 \change_inserted 564990737 1672138150
16768 \begin_layout Plain Layout
16770 \change_inserted 564990737 1672138150
16794 \begin_layout Standard
16796 \change_inserted 564990737 1672138150
16799 For this list these commands were used:
16802 \begin_layout Standard
16805 \change_inserted 564990737 1672138150
16816 \begin_inset Newline newline
16824 \begin_inset Newline newline
16832 \begin_inset Newline newline
16842 \begin_layout Standard
16844 \change_inserted 564990737 1672138150
16853 makes the label emphasized and
16862 \begin_layout Standard
16864 \change_inserted 564990737 1672138150
16867 \begin_inset Note Greyedout
16870 \begin_layout Plain Layout
16872 \change_inserted 564990737 1672138150
16878 When you change the label of a list level, it will be used for all following
16879 lists until you change the definition.
16887 \begin_layout Standard
16889 \change_inserted 564990737 1672138150
16895 \begin_layout Plain Layout
16897 \change_inserted 564990737 1672138150
16915 \begin_layout Subsubsection
16917 \change_inserted 564990737 1672138150
16920 Numbered Paragraphs in Reports
16923 \begin_layout Enumerate
16925 \change_inserted 564990737 1672138213
16928 Official reports often include numbered paragraphs; you can achieve this
16929 with a variation on the approach outlined in the footnote
16930 \begin_inset space ~
16934 \begin_inset CommandInset ref
16936 reference "fn:If-you-really"
16948 in each command with
16955 \begin_layout Enumerate
16957 \change_inserted 564990737 1672138150
16960 These numbered paragraphs were generated by inserting the \SpecialChar TeX
16962 \begin_inset Separator latexpar
16969 \begin_layout Standard
16971 \change_inserted 564990737 1672138150
16986 \begin_layout Standard
16988 \change_inserted 564990737 1672138150
16991 before the start of the section;
16997 uses the \SpecialChar LaTeX
16998 section counter to generate the first part of the number.
17002 \begin_layout Enumerate
17004 \change_inserted 564990737 1672138150
17007 I have ignored the subsection heading in this example because, with paragraphs
17008 numbered in this way, subsections are less likely to be used.
17011 \begin_layout Subsubsection
17013 \change_inserted 564990737 1672138150
17016 Resumed Enumeration
17019 \begin_layout Standard
17021 \change_inserted 564990737 1672138150
17027 \begin_layout Plain Layout
17029 \change_inserted 564990737 1672138150
17045 \begin_layout Standard
17047 \change_inserted 564990737 1672138150
17050 Enumerations can be resumed after intermediate paragraphs:
17053 \begin_layout Enumerate
17055 \change_inserted 564990737 1672138150
17058 \begin_inset Argument 1
17061 \begin_layout Plain Layout
17063 \change_inserted 564990737 1672138150
17069 \begin_layout Plain Layout
17071 \change_inserted 564990737 1672138150
17088 \begin_inset Note Note
17091 \begin_layout Plain Layout
17093 \change_inserted 564990737 1672138150
17096 goes back to default numbering
17104 \begin_layout Enumerate
17106 \change_inserted 564990737 1672138150
17112 \begin_layout Standard
17114 \change_inserted 564990737 1672138150
17120 \begin_layout Enumerate-Resume
17122 \change_inserted 564990737 1672138150
17128 \begin_layout Standard
17130 \change_inserted 564990737 1672138150
17133 To resume an enumeration, use the style
17138 Its numbering appears in blue within \SpecialChar LyX
17139 to indicate that it is a resumed
17140 list and that the numbering will not be correct in \SpecialChar LyX
17141 , but in the output.
17144 \begin_layout Standard
17146 \change_inserted 564990737 1672138150
17149 \begin_inset Note Greyedout
17152 \begin_layout Plain Layout
17154 \change_inserted 564990737 1672138150
17160 If there is no previous enumeration to resume, you will get a \SpecialChar LaTeX
17169 \begin_layout Standard
17171 \change_inserted 564990737 1672138150
17174 Perhaps you might want to resume the list with a different number from the
17176 Or you want to start a new enumeration with a defined number.
17177 This is possible by adding an optional argument to the first list item
17178 of a normal enumeration.
17179 There, insert the command
17182 \begin_layout Standard
17184 \change_inserted 564990737 1672138150
17191 \begin_layout Standard
17193 \change_inserted 564990737 1672138150
17200 is the number with which you want to resume the list.
17204 \begin_layout Enumerate
17206 \change_inserted 564990737 1672138150
17212 \begin_layout Enumerate
17214 \change_inserted 564990737 1672138150
17220 \begin_layout Standard
17222 \change_inserted 564990737 1672138150
17225 Enumeration starting at a given value:
17228 \begin_layout Enumerate
17230 \change_inserted 564990737 1672138150
17233 \begin_inset Argument 1
17236 \begin_layout Plain Layout
17238 \change_inserted 564990737 1672138150
17244 \begin_layout Plain Layout
17246 \change_inserted 564990737 1672138150
17260 This enumeration starts at 4
17263 \begin_layout Subsubsection
17265 \change_inserted 564990737 1672138150
17269 \begin_inset Index idx
17274 \begin_layout Plain Layout
17276 \change_inserted 564990737 1672138150
17289 \begin_layout Standard
17291 \change_inserted 564990737 1672138150
17294 In some cases you might want less or more vertical space between the items
17296 For example if the default space is too much in your opinion in this case:
17299 \begin_layout Itemize
17301 \change_inserted 564990737 1672138150
17307 \begin_layout Itemize
17309 \change_inserted 564990737 1672138150
17312 with standard spacing
17315 \begin_layout Standard
17317 \change_inserted 564990737 1672138150
17320 You can decrease the space by adding an optional argument to the first item
17322 Add there the command
17326 to get no additional list space like in this example:
17329 \begin_layout Itemize
17331 \change_inserted 564990737 1672138150
17334 \begin_inset Argument 1
17337 \begin_layout Plain Layout
17339 \change_inserted 564990737 1672138150
17345 \begin_layout Plain Layout
17347 \change_inserted 564990737 1672138150
17364 \begin_layout Itemize
17366 \change_inserted 564990737 1672138150
17372 \begin_layout Itemize
17374 \change_inserted 564990737 1672138150
17380 \begin_layout Standard
17382 \change_inserted 564990737 1672138150
17385 To add space you can use several other commands provided by the
17390 \begin_inset Index idx
17395 \begin_layout Plain Layout
17397 \change_inserted 564990737 1672138150
17401 -packages ! enumitem
17409 For more information see the
17410 \begin_inset CommandInset href
17412 name "enumitem documentation"
17413 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
17421 \begin_layout Standard
17423 \change_inserted 564990737 1672138150
17426 There are also many commands available to change the horizontal spacing
17428 Here is an example where the indentation was changed to that of the paragraphs
17429 in the document and the label separation was set to 2
17430 \begin_inset space \thinspace{}
17433 cm so that the number is in the page margin:
17436 \begin_layout Enumerate
17438 \change_inserted 564990737 1672138150
17441 \begin_inset Argument 1
17444 \begin_layout Plain Layout
17446 \change_inserted 564990737 1672138150
17452 \begin_layout Plain Layout
17454 \change_inserted 564990737 1672138150
17458 parindent, labelsep=2cm
17473 \begin_layout Enumerate
17475 \change_inserted 564990737 1672138150
17478 with negative indentation
17481 \begin_layout Subsubsection
17483 \change_inserted 564990737 1672138150
17486 Further Customization
17487 \begin_inset Index idx
17492 \begin_layout Plain Layout
17494 \change_inserted 564990737 1672138150
17497 Lists ! Customization
17507 \begin_layout Standard
17509 \change_inserted 564990737 1672138150
17512 You can also change the style of description lists.
17516 \begin_layout Standard
17518 \change_inserted 564990737 1672138150
17525 \begin_layout Standard
17527 \change_inserted 564990737 1672138150
17530 changes the description label font, the command
17533 \begin_layout Standard
17535 \change_inserted 564990737 1672138150
17545 \begin_layout Standard
17547 \change_inserted 564990737 1672138150
17550 sets the list style.
17553 \begin_layout Standard
17555 \change_inserted 564990737 1672138150
17558 An example where the command
17561 \begin_layout Standard
17563 \change_inserted 564990737 1672138150
17569 itshape, style=nextline
17572 \begin_layout Standard
17574 \change_inserted 564990737 1672138150
17580 \begin_layout Description
17582 \change_inserted 564990737 1672138150
17586 \begin_inset space ~
17590 \begin_inset Argument 1
17593 \begin_layout Plain Layout
17595 \change_inserted 564990737 1672138150
17601 \begin_layout Plain Layout
17603 \change_inserted 564990737 1672138150
17605 labelindent=0pt, labelsep=1cm, font=
17607 itshape, style=nextline
17619 Ionizing radiation consists of particles or electromagnetic waves that are
17620 energetic enough to detach electrons from atoms or molecules, therefore
17624 \begin_layout Description
17626 \change_inserted 564990737 1672138150
17630 \begin_inset space ~
17633 counting: In computer science, reference counting is a technique of storing
17634 the number of references, pointers, or handles to a resource such as an
17635 object, block of memory, disk space or other resource.
17638 \begin_layout Standard
17640 \change_inserted 564990737 1672138150
17643 There are many more commands and features provided by the
17648 \begin_inset Index idx
17653 \begin_layout Plain Layout
17655 \change_inserted 564990737 1672138150
17659 -packages ! enumitem
17667 For more information see the
17668 \begin_inset CommandInset href
17670 name "enumitem documentation"
17671 target "http://mirrors.ctan.org/macros/latex/contrib/enumitem/enumitem.pdf"
17679 \begin_layout Subsection
17681 \change_inserted 564990737 1672138150
17688 \begin_layout Standard
17690 \change_inserted 564990737 1672138150
17693 This module uses the package
17697 to provide nine new list environments.
17698 Itemized and enumerated lists can be typeset within paragraphs, as paragraphs
17699 and in a compact version.
17700 Most environments have optional arguments to format the labels.
17701 Additionally, the \SpecialChar LaTeX
17702 list environments itemize and enumerate are extended
17703 to use a similar optional argument.
17704 For further details see
17706 File\SpecialChar menuseparator
17707 Open Example\SpecialChar menuseparator
17708 Modules\SpecialChar menuseparator
17709 Paragraph Lists (paralist)
17713 Help\SpecialChar menuseparator
17714 Specific Manuals\SpecialChar menuseparator
17718 \begin_inset CommandInset href
17720 name "paralist documentation"
17721 target "http://mirrors.ctan.org/macros/latex/contrib/paralist/paralist.pdf"
17729 \begin_layout Section
17731 \change_inserted 564990737 1672161542
17734 Literate Programming
17737 \begin_layout Subsection
17739 \change_inserted 564990737 1672161542
17745 \begin_layout Standard
17747 \change_inserted 564990737 1672161542
17750 This module allows the use of Noweb as a literate programming tool.
17751 The files and the documentation for Noweb can be obtained from
17752 \begin_inset CommandInset href
17755 target "https://www.ctan.org/pkg/noweb"
17761 Literate programming is described in section
17762 \begin_inset space ~
17766 \begin_inset CommandInset ref
17768 reference "sec:Literate-Programming"
17772 and there are three example files:
17774 File\SpecialChar menuseparator
17775 Open Example\SpecialChar menuseparator
17776 Modules\SpecialChar menuseparator
17781 File\SpecialChar menuseparator
17782 Open Example\SpecialChar menuseparator
17783 Modules\SpecialChar menuseparator
17788 File\SpecialChar menuseparator
17789 Open Example\SpecialChar menuseparator
17790 Modules\SpecialChar menuseparator
17791 Noweb2\SpecialChar LyX
17797 \begin_layout Subsection
17799 \change_inserted 564990737 1672161542
17805 \begin_layout Standard
17807 \change_inserted 564990737 1672161542
17810 This module uses the
17820 \begin_inset Flex Code
17823 \begin_layout Plain Layout
17825 \change_inserted 564990737 1672161542
17835 package in R for dynamic report generation has to be installed for this
17837 \begin_inset Flex Code
17840 \begin_layout Plain Layout
17842 \change_inserted 564990737 1672161542
17845 install.packages(“knitr”)
17856 \begin_layout Paragraph
17858 \change_inserted 564990737 1672161542
17864 \begin_layout Standard
17866 \change_inserted 564990737 1672161542
17869 it depends on R >= 2.14.1.
17871 \begin_inset Flex URL
17874 \begin_layout Plain Layout
17876 \change_inserted 564990737 1672161542
17878 http://yihui.name/knitr
17889 \begin_layout Standard
17891 \change_inserted 564990737 1672161542
17898 also has to be installed.
17899 It cannot be used if the modules
17902 \begin_inset space ~
17914 Help\SpecialChar menuseparator
17915 Specific Manuals\SpecialChar menuseparator
17920 File\SpecialChar menuseparator
17921 Open Example\SpecialChar menuseparator
17922 Modules\SpecialChar menuseparator
17926 \begin_inset space ~
17930 \begin_inset CommandInset ref
17932 reference "sec:Literate-Programming"
17936 for information about literate programming.
17939 \begin_layout Subsection
17941 \change_inserted 564990737 1672161542
17947 \begin_layout Standard
17949 \change_inserted 564990737 1672161542
17952 This module allows the use of the statistical language S/R as a literate
17964 \begin_inset CommandInset href
17967 target "https://www.ctan.org/pkg/includernw"
17973 \begin_inset CommandInset href
17976 target "https://www.ctan.org/pkg/fancyvrb"
17981 are available from CTAN.
17982 It cannot be used if the module
17985 \begin_inset space ~
17993 Help\SpecialChar menuseparator
17994 Specific Manuals\SpecialChar menuseparator
17999 File\SpecialChar menuseparator
18000 Open Example\SpecialChar menuseparator
18001 Modules\SpecialChar menuseparator
18005 \begin_inset space ~
18009 \begin_inset CommandInset ref
18011 reference "sec:Literate-Programming"
18015 for information about literate programming.
18018 \begin_layout Section
18020 \change_inserted 564990737 1672224959
18026 \begin_layout Subsection
18028 \change_inserted 564990737 1672224959
18034 \begin_layout Standard
18036 \change_inserted 564990737 1672224959
18039 This modules defines theorem environments and the proof environment using
18040 the extended AMS machinery.
18041 Both numbered and unnumbered types are provided.
18042 By default, the theorems are numbered consecutively throughout the document.
18043 This can be changed by loading one of the
18045 AMS Theorems (Numbered by \SpecialChar ldots
18049 It cannot be used if the modules
18055 Standard Theorems (Unnumbered)
18060 \begin_layout Subsection
18062 \change_inserted 564990737 1672224959
18065 AMS Theorems (Extended)
18068 \begin_layout Standard
18070 \change_inserted 564990737 1672224959
18073 This module defines some additional theorem environments for use with the
18078 package (which must be loaded).
18079 It includes Criterion, Algorithm, Axiom, Condition, Note, Notation, Summary,
18080 Acknowledgement, Conclusion, Fact, Assumption, Case and Question in both
18081 numbered and unnumbered forms.
18084 \begin_layout Subsection
18086 \change_inserted 564990737 1672224959
18089 AMS Theorems (Extended, Numbered by Type within Chapters)
18092 \begin_layout Standard
18094 \change_inserted 564990737 1672224959
18097 This module defines some additional theorem environments for use with the
18100 AMS Theorems (Numbered by Type within Chapters)
18102 package (which must be loaded).
18103 It includes Criterion, Algorithm, Axiom, Condition, Note, Notation, Summary,
18104 Acknowledgement, Conclusion, Assumption and Case in both numbered and unnumbere
18108 AMS Theorems (Extended)
18110 module, the different theorem types provided here each have a separate
18111 counter, restarted with each new chapter (e.g., criterion 1.1, criterion 1.2,
18112 axiom 1.1, assumption 1.1, criterion 2.1, criterion 2.2, axiom 2.1\SpecialChar ldots
18114 to criterion 1, criterion 2, axiom 3, assumption 4...).
18117 \begin_layout Subsection
18119 \change_inserted 564990737 1672224959
18122 AMS Theorems (Extended, Numbered by Type)
18125 \begin_layout Standard
18127 \change_inserted 564990737 1672224959
18130 This module defines some additional theorem environments for use with the
18133 AMS Theorems (Numbered by Type)
18135 package (which must be loaded).
18136 It includes Criterion, Algorithm, Axiom, Condition, Note, Notation, Summary,
18137 Acknowledgement, Conclusion, Assumption and Case in both numbered and unnumbere
18141 AMS Theorems (Extended)
18143 module, the different theorem types provided here each have a separate
18144 counter (e.g., criterion 1, criterion 2, axiom 1, assumption 1, criterion
18145 3, \SpecialChar ldots
18146 , as opposed to criterion 1, criterion 2, axiom 3, assumption 4, \SpecialChar ldots
18150 \begin_layout Subsection
18152 \change_inserted 564990737 1672224959
18155 AMS Theorems (Numbered by Type within Chapters)
18158 \begin_layout Standard
18160 \change_inserted 564990737 1672224959
18163 This module defines theorem environments and the proof environment using
18164 the extended AMS machinery.
18165 Both numbered and unnumbered types are provided.
18170 module, the different theorem types provided here each have a separate
18171 counter (e.g., theorem 1.1, theorem 1.2, lemma 1.1, proposition 1.1, theorem
18172 1.3, lemma 1.2, \SpecialChar ldots
18173 , as opposed to theorem 1, theorem 2, lemma 3, proposition
18174 4, \SpecialChar ldots
18176 The numbering restarts for each chapter: theorem 1.1, theorem 2.1, \SpecialChar ldots
18178 be used if the modules
18188 Standard Theorems (Numbered by Type)
18192 Standard Theorems (Unnumbered)
18197 \begin_layout Subsection
18199 \change_inserted 564990737 1672224959
18202 AMS Theorems (Numbered by Type)
18205 \begin_layout Standard
18207 \change_inserted 564990737 1672224959
18210 This module defines theorem environments and the proof environment using
18211 the extended AMS machinery.
18212 Both numbered and unnumbered types are provided.
18217 module, the different theorem types provided here each have a separate
18218 counter (e.g., theorem 1, theorem 2, lemma 1, proposition 1, theorem 3, lemma
18219 2, \SpecialChar ldots
18220 , as opposed to theorem 1, theorem 2, lemma 3, proposition 4, \SpecialChar ldots
18222 The numbering’s scope is the whole document.
18223 For chapter- and section-wide numbering, use one of the ‘within Sections’/‘with
18224 in Chapters’ modules, respectively.
18225 It cannot be used if the modules
18235 Standard Theorems (Numbered by Type)
18239 Standard Theorems (Unnumbered)
18244 \begin_layout Subsection
18246 \change_inserted 564990737 1672224959
18249 Number Equations by Section
18252 \begin_layout Standard
18254 \change_inserted 564990737 1672224959
18257 This module resets the equation number at section start and prepends the
18258 section number to the equation number, as in “(2.1).”
18261 \begin_layout Subsection
18263 \change_inserted 564990737 1672224959
18269 \begin_layout Standard
18271 \change_inserted 564990737 1672224959
18274 This module defines some theorem environments for use with non-AMS classes.
18275 By default, the theorems are numbered consecutively throughout the document.
18276 This can be changed by loading one of the
18278 Standard Theorems (Numbered by \SpecialChar ldots
18282 It cannot be used if the modules
18288 Standard Theorems (Unnumbered)
18294 \begin_layout Subsection
18296 \change_inserted 564990737 1672224959
18299 Standard Theorems (Nameable)
18302 \begin_layout Standard
18304 \change_inserted 564990737 1672224959
18307 This module facilitates the use of named theorems.
18308 The name of the theorem goes into the “Additional Theorem Text” argument.
18312 \begin_layout Subsection
18314 \change_inserted 564990737 1672224959
18317 Standard Theorems (Numbered by Chapter)
18320 \begin_layout Standard
18322 \change_inserted 564990737 1672224959
18325 This module numbers theorems and the like by chapter (i.e., the counter is
18326 reset at each chapter start).
18327 Use this module only with document classes that provide a chapter environment.
18337 It cannot be used if the module
18339 Standard Theorems (Numbered by Section)
18344 \begin_layout Subsection
18346 \change_inserted 564990737 1672224959
18349 Standard Theorems (Numbered by Section)
18352 \begin_layout Standard
18354 \change_inserted 564990737 1672224959
18357 This module numbers theorems and the like by section (i.e., the counter is
18358 reset at each section start).
18368 It cannot be used if the module
18370 Standard Theorems (Numbered by Chapter)
18375 \begin_layout Subsection
18377 \change_inserted 564990737 1672224959
18380 Standard Theorems (Numbered by Type within Chapters)
18383 \begin_layout Standard
18385 \change_inserted 564990737 1672224959
18388 This module defines some theorem environments for use with non-AMS classes.
18397 modules, the different theorem types provided here each have a separate
18398 counter (e.g., theorem 1, theorem 2, lemma 1, proposition 1, theorem 3, lemma
18399 2, \SpecialChar ldots
18400 , as opposed to theorem 1, theorem 2, lemma 3, proposition 4, \SpecialChar ldots
18402 The numbering is reset at each chapter start.
18405 AMS Theorems (Numbered by Type)
18409 Standard Theorems (Numbered by Type)
18412 It cannot be used if any of the modules
18422 Standard Theorems (Unnumbered)
18426 Standard Theorems (Numbered by Sections)
18430 Standard Theorems (Numbered by Type within Sections)
18435 \begin_layout Subsection
18437 \change_inserted 564990737 1672224959
18440 Standard Theorems (Numbered by Type within Sections)
18443 \begin_layout Standard
18445 \change_inserted 564990737 1672224959
18448 This module defines some theorem environments for use with non-AMS classes.
18457 modules, the different theorem types provided here each have a separate
18458 counter (e.g., theorem 1, theorem 2, lemma 1, proposition 1, theorem 3, lemma
18459 2, \SpecialChar ldots
18460 , as opposed to theorem 1, theorem 2, lemma 3, proposition 4, \SpecialChar ldots
18462 The numbering is reset at each section start.
18465 AMS Theorems (Numbered by Type)
18469 Standard Theorems (Numbered by Type)
18472 It cannot be used if any of the modules
18482 Standard Theorems (Unnumbered)
18486 Standard Theorems (Numbered by Chapters)
18490 Standard Theorems (Numbered by Type within Chapters)
18495 \begin_layout Subsection
18497 \change_inserted 564990737 1672224959
18500 Standard Theorems (Numbered by Type)
18503 \begin_layout Standard
18505 \change_inserted 564990737 1672224959
18508 This module defines some theorem environments for use with non-AMS classes.
18517 modules, the different theorem types provided here each have a separate
18518 counter (e.g., theorem 1, theorem 2, lemma 1, proposition 1, theorem 3, lemma
18519 2, \SpecialChar ldots
18520 , as opposed to theorem 1, theorem 2, lemma 3, proposition 4, \SpecialChar ldots
18522 The numbering’s scope is the whole document.
18523 For chapter- and section-wide numbering, use one of the “within Chapters”/“with
18524 in Sections” modules, respectively.
18525 It cannot be used if any of the modules
18535 Standard Theorems (Unnumbered)
18539 AMS Theorems (Numbered by Type)
18544 \begin_layout Subsection
18546 \change_inserted 564990737 1672224959
18549 Standard Theorems (Unnumbered)
18552 \begin_layout Standard
18554 \change_inserted 564990737 1672224959
18557 This module defines only unnumbered theorem environments and the proof environme
18558 nt, using the extended AMS machinery.
18559 It cannot be used if either of the modules
18570 \begin_layout Subsection
18572 \change_inserted 564990737 1672224959
18578 \begin_layout Standard
18580 \change_inserted 564990737 1672224959
18583 This module provides a straightforward way to segregate subequations in
18587 Help\SpecialChar menuseparator
18588 Math\SpecialChar menuseparator
18595 \begin_layout Section
18597 \change_inserted 564990737 1672236008
18603 \begin_layout Subsection
18605 \change_inserted 564990737 1672236008
18608 Custom Header/Footer Text
18611 \begin_layout Standard
18613 \change_inserted 564990737 1672236008
18616 This module requires the
18619 \begin_inset space ~
18633 ocument\SpecialChar menuseparator
18638 ettings\SpecialChar menuseparator
18640 \begin_inset space ~
18645 dialog to be set to
18650 It adds six environments to document classes which support the
18657 \begin_layout Itemize
18659 \change_inserted 564990737 1672236008
18666 \begin_layout Itemize
18668 \change_inserted 564990737 1672236008
18675 \begin_layout Itemize
18677 \change_inserted 564990737 1672236008
18684 \begin_layout Itemize
18686 \change_inserted 564990737 1672236008
18693 \begin_layout Itemize
18695 \change_inserted 564990737 1672236008
18702 \begin_layout Itemize
18704 \change_inserted 564990737 1672236008
18711 \begin_layout Subsubsection
18713 \change_inserted 564990737 1672236008
18716 Fancy Headers and Footers
18719 \begin_layout Standard
18721 \change_inserted 564990737 1672236008
18724 The default page layout is rather plain; for an
18725 \begin_inset Flex Code
18728 \begin_layout Plain Layout
18730 \change_inserted 564990737 1672236008
18740 document class, all you get is a centered page number at the bottom of
18742 This document uses KOMA-script’s book class; so it appears to be a bit
18747 \begin_inset space ~
18761 ocument\SpecialChar menuseparator
18766 ettings\SpecialChar menuseparator
18770 \begin_inset Quotes eld
18774 \begin_inset Quotes erd
18777 , you will find that the page header is divided into three fields, not surprisin
18779 \begin_inset Quotes eld
18783 \begin_inset Quotes erd
18787 \begin_inset Quotes eld
18791 \begin_inset Quotes erd
18795 \begin_inset Quotes eld
18799 \begin_inset Quotes erd
18803 The footer is also divided into these three fields.
18804 The \SpecialChar LaTeX
18805 commands to set these fields in the simplest manner are
18830 Suppose you wish to put your name in the upper left hand corner of each
18832 Simply insert the following command in the preamble:
18835 \begin_layout Standard
18837 \change_inserted 564990737 1672236008
18854 \begin_layout Standard
18856 \change_inserted 564990737 1672236008
18859 You will now see your name in the upper left.
18860 If a field has a default entry that you would like to get rid of (often
18861 the page number appears in the central footer) simply include a command
18862 with a blank argument, e.
18863 \begin_inset space \thinspace{}
18869 \begin_layout Standard
18871 \change_inserted 564990737 1672236008
18880 \begin_layout Standard
18882 \change_inserted 564990737 1672236008
18885 There is, however, an easier way to make simple changes.
18891 ocument\SpecialChar menuseparator
18896 ettings\SpecialChar menuseparator
18897 Modules\SpecialChar menuseparator
18898 Page Layout\SpecialChar menuseparator
18899 Custom Header/Footer Text
18901 module, you will find you have six new environments corresponding to the
18902 six fields described above.
18905 \begin_layout Standard
18907 \change_inserted 564990737 1672236008
18910 Let's get really fancy: lets put the section number with the word
18911 \begin_inset Quotes eld
18915 \begin_inset Quotes erd
18919 \begin_inset space \thinspace{}
18923 \begin_inset space \space{}
18926 Section 3) in the upper left, the page number (e.
18927 \begin_inset space \thinspace{}
18931 \begin_inset space \space{}
18934 Page 4) in the upper right, your name in the lower left, and the date in
18936 Use your newly enabled environments to add these entries:
18939 \begin_layout Standard
18941 \change_inserted 564990737 1672236008
18944 \begin_inset VSpace defskip
18950 \begin_layout Standard
18952 \change_inserted 564990737 1672236008
18957 \begin_inset space ~
18974 \begin_layout Standard
18976 \change_inserted 564990737 1672236008
18983 \begin_layout Standard
18985 \change_inserted 564990737 1672236008
19000 \begin_layout Standard
19002 \change_inserted 564990737 1672236008
19012 \begin_layout Standard
19014 \change_inserted 564990737 1672236008
19021 \begin_layout Standard
19023 \change_inserted 564990737 1672236008
19038 \begin_layout Standard
19040 \change_inserted 564990737 1672236008
19043 \begin_inset VSpace defskip
19049 \begin_layout Standard
19051 \change_inserted 564990737 1672236008
19054 Make sure you enter the commands
19072 as \SpecialChar TeX
19090 access \SpecialChar LaTeX
19091 ’s section and page counters, and so print out the current section
19099 simply prints out today’s date.
19102 \begin_layout Standard
19104 \change_inserted 564990737 1672236008
19107 The thicknesses of the horizontal rules drawn beneath the header and above
19108 the footer can also be modified.
19109 If you don't want one of the rules, set its thickness to 0.
19110 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
19111 For this you will need to use \SpecialChar TeX
19115 \begin_layout Standard
19117 \change_inserted 564990737 1672236008
19125 headrulewidth}{0.4pt}
19130 \begin_layout Standard
19132 \change_inserted 564990737 1672236008
19140 footrulewidth}{0.4pt}
19142 to set the thicknesses.
19145 \begin_layout Standard
19147 \change_inserted 564990737 1672236008
19150 You can switch the header/footer settings on and off for individual pages
19151 using \SpecialChar TeX
19156 thispagestyle{empty}
19162 thispagestyle{plain}
19168 thispagestyle{fancy}
19171 Simply insert them in the text on the page you want changed and mark them
19172 as \SpecialChar TeX
19174 In fact, title pages are marked as plain by default, while following pages
19175 are marked fancy when using the global fancy setting.
19179 \begin_layout Standard
19181 \change_inserted 564990737 1672236008
19184 If you want a header or footer to be on the outer side of a two sided document,
19185 you need to use something like:
19188 \begin_layout Standard
19190 \change_inserted 564990737 1672236008
19194 \begin_inset Flex Strong
19197 \begin_layout Plain Layout
19199 \change_inserted 564990737 1672236008
19216 \begin_layout Standard
19218 \change_inserted 564990737 1672236008
19222 \begin_inset Flex Strong
19225 \begin_layout Plain Layout
19227 \change_inserted 564990737 1672236008
19246 \begin_layout Standard
19248 \change_inserted 564990737 1672236008
19251 The first command clears all existing footers avoiding any conflicts with
19255 \begin_layout Standard
19257 \change_inserted 564990737 1672236008
19260 You can enter any of these commands, the simpler ones in any of your new
19261 environments, the more complex ones as \SpecialChar TeX
19262 Code commands, at any point in
19263 your document and they will take effect on the next page.
19266 \begin_layout Standard
19268 \change_inserted 564990737 1672236008
19271 As a final example, it is possible to include an image in the header or
19273 Suppose you want to put a company logo in the upper left hand corner.
19274 You might try something like
19277 \begin_layout Standard
19279 \change_inserted 564990737 1672236008
19289 includegraphics{logo.eps}}}
19292 \begin_layout Standard
19295 \change_inserted 564990737 1672236008
19298 (you may need to preface this with
19302 usepackage{graphics}
19304 if you don't include graphics elsewhere in your document).
19307 \begin_layout Standard
19309 \change_inserted 564990737 1672236008
19312 For more information on fancy headers, you can get the
19313 \begin_inset Flex Code
19316 \begin_layout Plain Layout
19318 \change_inserted 564990737 1672236008
19329 \begin_inset CommandInset href
19332 target "http://www.ctan.org/pkg/fancyhdr"
19341 \begin_layout Subsection
19343 \change_inserted 564990737 1672236008
19346 Landscape Document Parts
19349 \begin_layout Standard
19351 \change_inserted 564990737 1672236008
19354 This module outputs parts of the document in landscape mode using
19356 Insert\SpecialChar menuseparator
19357 Custom Insets\SpecialChar menuseparator
19362 Insert\SpecialChar menuseparator
19363 Custom Insets\SpecialChar menuseparator
19364 Landscape (Floating)
19369 \begin_layout Subsection
19371 \change_inserted 564990737 1672236008
19374 \begin_inset CommandInset label
19376 name "sec:Multiple-Columns"
19383 \begin_layout Standard
19385 \change_inserted 564990737 1672236008
19388 This module uses the
19393 \begin_inset Index idx
19398 \begin_layout Plain Layout
19400 \change_inserted 564990737 1672236008
19404 -packages ! multicol
19411 package and is independent of the option
19424 ocument\SpecialChar menuseparator
19429 ettings\SpecialChar menuseparator
19431 \begin_inset space ~
19437 If you want to have two columns for the whole document, you are recommended
19447 For all other cases use this module.
19448 \change_deleted 564990737 1672236008
19451 Multiple Text Columns
19454 \begin_layout Standard
19456 \change_deleted 564990737 1672236008
19457 This feature is independent of the option
19459 Two-column document
19461 in the document settings under
19466 If you want to have 2
19467 \begin_inset space ~
19470 columns for the whole document, it is recommended to use the
19472 Two-column document
19475 For all other cases use this feature.
19478 \begin_layout Standard
19480 \change_deleted 564990737 1672236008
19481 To use multiple text columns in your document, you have to load the module
19488 Document\SpecialChar menuseparator
19489 Settings\SpecialChar menuseparator
19492 ) and must have the \SpecialChar LaTeX
19494 \begin_inset Flex Code
19497 \begin_layout Plain Layout
19508 \begin_layout Standard
19509 Footnotes within multiple columns will be placed at the bottom of the page
19510 and not under each column.
19511 Within the different columns you can use everything, with the limitation
19512 that for floats you need to
19513 \change_deleted 564990737 1672236179
19514 use the float option
19517 \change_inserted 564990737 1672236179
19527 \begin_inset space ~
19537 dit\SpecialChar menuseparator
19543 \begin_inset space ~
19554 \begin_layout Subsubsection
19558 \begin_layout Standard
19559 If you want to have 2
19560 \begin_inset space ~
19563 columns in your text, insert a multicolumn inset via the menu
19565 Insert\SpecialChar menuseparator
19567 \begin_inset space ~
19570 Insets\SpecialChar menuseparator
19572 \begin_inset space ~
19577 where the columns should start.
19578 Write all text that should be printed in 2
19579 \begin_inset space ~
19582 columns into this inset.
19585 \begin_layout Standard
19586 Here is an example:
19589 \begin_layout Standard
19591 \begin_inset Flex Multiple Columns
19594 \begin_layout Plain Layout
19599 The Adventure of the Empty House
19602 \begin_inset Newline newline
19605 by Sir Arthur Conan Doyle
19608 \begin_layout Plain Layout
19611 It was in the spring of the year 1894 that all London was interested, and
19612 the fashionable world dismayed, by the murder of the Honourable Ronald
19613 Adair under most unusual and inexplicable circumstances.
19614 The public has already learned those particulars of the crime which came
19615 out in the police investigation, but a good deal was suppressed upon that
19616 occasion, since the case for the prosecution was so overwhelmingly strong
19617 that it was not necessary to bring forward all the facts.
19618 Only now, at the end of nearly ten years, am I allowed to supply those
19619 missing links which make up the whole of that remarkable chain.
19620 The crime was of interest in itself, but that interest was as nothing to
19621 me compared to the inconceivable sequel, which afforded me the greatest
19622 shock and surprise of any event in my adventurous life.
19623 Even now, after this long interval, I find myself thrilling as I think
19624 of it, and feeling once more that sudden flood of joy, amazement, and increduli
19625 ty which utterly submerged my mind.
19626 Let me say to that public, which has shown some interest in those glimpses
19627 which I have occasionally given them of the thoughts and actions of a very
19628 remarkable man, that they are not to blame me if I have not shared my knowledge
19629 with them, for I should have considered it my first duty to do so, had
19630 I not been barred by a positive prohibition from his own lips, which was
19631 only withdrawn upon the third of last month.
19639 \begin_layout Standard
19640 To get 3 or more columns, set the cursor into the multicolumn inset and
19643 Insert\SpecialChar menuseparator
19645 \begin_inset space ~
19649 \begin_inset space ~
19655 The number of the desired columns is written into that inset (for 3
19656 \begin_inset space ~
19660 \begin_inset Quotes eld
19664 \begin_inset Quotes erd
19668 \begin_inset Newline newline
19671 Here is an example with 3
19672 \begin_inset space ~
19678 \begin_layout Standard
19679 \begin_inset Flex Multiple Columns
19682 \begin_layout Plain Layout
19685 \begin_inset Argument 1
19688 \begin_layout Plain Layout
19695 It can be imagined that my close intimacy with Sherlock Holmes had interested
19696 me deeply in crime, and that after his disappearance I never failed to
19697 read with care the various problems which came before the public.
19698 And I even attempted, more than once, for my own private satisfaction,
19699 to employ his methods in their solution, though with indifferent success.
19700 There was none, however, which appealed to me like this tragedy of Ronald
19702 As I read the evidence at the inquest, which led up to a verdict of willful
19703 murder against some person or persons unknown, I realized more clearly
19704 than I had ever done the loss which the community had sustained by the
19705 death of Sherlock Holmes.
19706 There were points about this strange business which would, I was sure,
19707 have specially appealed to him, and the efforts of the police would have
19708 been supplemented, or more probably anticipated, by the trained observation
19709 and the alert mind of the first criminal agent in Europe.
19710 All day, as I drove upon my round, I turned over the case in my mind and
19711 found no explanation which appeared to me to be adequate.
19712 At the risk of telling a twice-told tale, I will recapitulate the facts
19713 as they were known to the public at the conclusion of the inquest.
19721 \begin_layout Standard
19722 You can have up to 10
19723 \begin_inset space ~
19726 columns if you want to, but that might not be very pleasant for the readers
19730 \begin_layout Standard
19732 \change_deleted 564990737 1672236245
19733 \begin_inset Newpage newpage
19741 \begin_layout Subsubsection
19742 Columns inside Columns
19745 \begin_layout Standard
19746 You can also have columns inside columns:
19749 \begin_layout Standard
19750 \begin_inset Flex Multiple Columns
19753 \begin_layout Plain Layout
19756 The Honourable Ronald Adair was the second son of the Earl of Maynooth,
19757 at that time governor of one of the Australian colonies.
19758 Adair's mother had returned from Australia to undergo the operation for
19759 cataract, and she, her son Ronald, and her daughter Hilda were living together
19763 \begin_layout Plain Layout
19764 \begin_inset Flex Multiple Columns
19767 \begin_layout Plain Layout
19770 The youth moved in the best society
19771 \begin_inset space ~
19774 – had, so far as was known, no enemies and no particular vices.
19775 He had been engaged to Miss Edith Woodley, of Carstairs, but the engagement
19776 had been broken off by mutual consent some months before, and there was
19777 no sign that it had left any very profound feeling behind it.
19778 For the rest {sic} the man's life moved in a narrow and conventional circle,
19779 for his habits were quiet and his nature unemotional.
19780 Yet it was upon this easy-going young aristocrat that death came, in most
19781 strange and unexpected form, between the hours of ten and eleven-twenty
19782 on the night of March 30, 1894.
19790 \begin_layout Plain Layout
19793 Ronald Adair was fond of cards
19794 \begin_inset space ~
19797 – playing continually, but never for such stakes as would hurt him.
19798 He was a member of the Baldwin, the Cavendish, and the Bagatelle card clubs.
19799 It was shown that, after dinner on the day of his death, he had played
19800 a rubber of whist at the latter club.
19801 He had also played there in the afternoon.
19806 The evidence of those who had played with him
19807 \begin_inset space ~
19811 Murray, Sir John Hardy, and Colonel Moran
19812 \begin_inset space ~
19815 – showed that the game was whist, and that there was a fairly equal fall
19817 Adair might have lost five pounds, but not more.
19818 His fortune was a considerable one, and such a loss could not in any way
19820 He had played nearly every day at one club or other, but he was a cautious
19821 player, and usually rose a winner.
19822 It came out in evidence that, in partnership with Colonel Moran, he had
19823 actually won as much as four hundred and twenty pounds in a sitting, some
19824 weeks before, from Godfrey Milner and Lord Balmoral.
19825 So much for his recent history as it came out at the inquest.
19833 \begin_layout Subsubsection
19837 \begin_layout Standard
19838 The examples in this section show some more special features of multiple
19842 \begin_layout Standard
19843 For more features of multiple columns, have a look at the
19844 \begin_inset CommandInset href
19846 name "documentation"
19847 target "http://mirror.ctan.org/macros/latex/required/tools/multicol.pdf"
19852 of the \SpecialChar LaTeX
19854 \begin_inset Flex Code
19857 \begin_layout Plain Layout
19866 \begin_layout Paragraph
19870 \begin_layout Standard
19871 To add a preface text for multiple columns, set the cursor into the multicolumn
19872 inset and use the menu
19874 Insert\SpecialChar menuseparator
19878 Write your preface text into that inset.
19879 \begin_inset Newline newline
19882 This is an example with some preface text:
19885 \begin_layout Standard
19886 \begin_inset VSpace bigskip
19892 \begin_layout Standard
19893 \begin_inset Flex Multiple Columns
19896 \begin_layout Plain Layout
19897 \begin_inset Argument 2
19900 \begin_layout Plain Layout
19901 And the story continues and continues and continues and continues\SpecialChar ldots
19909 On the evening of the crime, he returned from the club exactly at ten.
19910 His mother and sister were out spending the evening with a relation.
19911 The servant deposed that she heard him enter the front room on the second
19912 floor, generally used as his sitting-room.
19913 She had lit a fire there, and as it smoked she had opened the window.
19914 No sound was heard from the room until eleven-twenty, the hour of the return
19915 of Lady Maynooth and her daughter.
19916 Desiring to say good-night, she attempted to enter her son's room.
19917 The door was locked on the inside, and no answer could be got to their
19918 cries and knocking.
19919 Help was obtained, and the door forced.
19920 The unfortunate young man was found lying near the table.
19921 His head had been horribly mutilated by an expanding revolver bullet, but
19922 no weapon of any sort was to be found in the room.
19930 \begin_layout Standard
19931 You can also use a section heading as the preface if you use a section command
19932 as \SpecialChar TeX
19934 For example the command
19937 \begin_layout LyX-Code
19940 subsection{subsection title}
19943 \begin_layout Standard
19944 creates a subsection.
19945 In this example the preface is a subsubsection:
19948 \begin_layout Standard
19949 \begin_inset Flex Multiple Columns
19952 \begin_layout Plain Layout
19953 \begin_inset Argument 2
19956 \begin_layout Plain Layout
19960 \begin_layout Plain Layout
19969 This is a subsubsection heading as a preface
19973 \begin_layout Plain Layout
19987 A minute examination of the circumstances served only to make the case more
19989 In the first place, no reason could be given why the young man should have
19990 fastened the door upon the inside.
19991 There was the possibility that the murderer had done this, and had afterwards
19992 escaped by the window.
19993 The drop was at least twenty feet, however, and a bed of crocuses in full
19995 Neither the flowers nor the earth showed any sign of having been disturbed,
19996 nor were there any marks upon the narrow strip of grass which separated
19997 the house from the road.
19998 Apparently, therefore, it was the young man himself who had fastened the
20000 But how did he come by his death? No one could have climbed up to the window
20001 without leaving traces.
20002 Suppose a man had fired through the window, he would indeed be a remarkable
20003 shot who could with a revolver inflict so deadly a wound.
20004 Again, Park Lane is a frequented thoroughfare; there is a cab stand within
20005 a hundred yards of the house.
20006 No one had heard a shot.
20014 \begin_layout Standard
20015 If there is less vertical space than 6
20016 \begin_inset space ~
20019 text lines is left on the page at the beginning of the multiple columns,
20020 a page break will be inserted before the multiple columns.
20021 Depending on the number of lines of the preface text, you might want to
20023 This is done by setting the cursor into the mulitcolumn inset behind the
20024 preface (if there is any) and using the menu
20026 Insert\SpecialChar menuseparator
20028 \begin_inset space ~
20032 \begin_inset space ~
20036 \begin_inset space ~
20042 Insert into that inset the amount of space like e.
20043 \begin_inset space \thinspace{}
20047 \begin_inset space \space{}
20051 \begin_inset Quotes eld
20055 \begin_inset Quotes erd
20059 \begin_inset Newline newline
20062 In this example the space is set to 7
20063 \begin_inset space ~
20066 text lines by using
20067 \begin_inset Flex Code
20070 \begin_layout Plain Layout
20079 \begin_inset Flex Code
20082 \begin_layout Plain Layout
20090 needs to be inserted as \SpecialChar TeX
20094 \begin_layout Standard
20095 \begin_inset Flex Multiple Columns
20098 \begin_layout Plain Layout
20099 \begin_inset Argument 3
20102 \begin_layout Plain Layout
20107 \begin_layout Plain Layout
20123 On the evening of the crime, he returned from the club exactly at ten.
20124 His mother and sister were out spending the evening with a relation.
20125 The servant deposed that she heard him enter the front room on the second
20126 floor, generally used as his sitting-room.
20127 She had lit a fire there, and as it smoked she had opened the window.
20128 No sound was heard from the room until eleven-twenty, the hour of the return
20129 of Lady Maynooth and her daughter.
20130 Desiring to say good-night, she attempted to enter her son's room.
20131 The door was locked on the inside, and no answer could be got to their
20132 cries and knocking.
20133 Help was obtained, and the door forced.
20134 The unfortunate young man was found lying near the table.
20135 His head had been horribly mutilated by an expanding revolver bullet, but
20136 no weapon of any sort was to be found in the room.
20144 \begin_layout Paragraph
20148 \begin_layout Standard
20149 The amount of space before and after multiple columns can be changed by
20150 changing the length
20151 \begin_inset Flex Code
20154 \begin_layout Plain Layout
20163 For example the command
20166 \begin_layout LyX-Code
20174 \begin_layout Standard
20175 in \SpecialChar TeX
20176 Code changes its value to 3
20177 \begin_inset space \thinspace{}
20181 The change must be made before the multiple columns' start.
20182 The predefined value is 13
20183 \begin_inset space \thinspace{}
20189 \begin_layout Standard
20191 \begin_inset Flex Code
20194 \begin_layout Plain Layout
20203 \begin_inset space \thinspace{}
20209 \begin_layout Standard
20213 \begin_layout Plain Layout
20219 multicolsep}{2.5cm}
20227 \begin_layout Standard
20228 \begin_inset Flex Multiple Columns
20231 \begin_layout Plain Layout
20234 All day I turned these facts over in my mind, endeavouring to hit upon some
20235 theory which could reconcile them all, and to find that line of least resistanc
20236 e which my poor friend had declared to be the starting-point of every investigat
20238 I confess that I made little progress.
20239 In the evening I strolled across the Park, and found myself about six o'clock
20240 at the Oxford Street end of Park Lane.
20241 A group of loafers upon the pavements, all staring up at a particular window,
20242 directed me to the house which I had come to see.
20243 A tall, thin man with coloured glasses, whom I strongly suspected of being
20244 a plain-clothes detective, was pointing out some theory of his own, while
20245 the others crowded round to listen to what he said.
20246 I got as near him as I could, but his observations seemed to me to be absurd,
20247 so I withdrew again in some disgust.
20248 As I did so I struck against an elderly, deformed man, who had been behind
20249 me, and I knocked down several books which he was carrying.
20257 \begin_layout Standard
20258 \begin_inset Note Greyedout
20261 \begin_layout Plain Layout
20266 The values you set with
20267 \begin_inset Flex Code
20270 \begin_layout Plain Layout
20278 will be used for all following multiple columns until you change them again.
20286 \begin_layout Standard
20290 \begin_layout Plain Layout
20302 \begin_inset Note Note
20305 \begin_layout Plain Layout
20306 go back to the default
20314 \begin_layout Standard
20316 \change_deleted 564990737 1672236355
20317 \begin_inset Newpage newpage
20325 \begin_layout Paragraph
20329 \begin_layout Standard
20330 A column break can be forced by inserting the command
20331 \begin_inset Flex Code
20334 \begin_layout Plain Layout
20342 as \SpecialChar TeX
20343 Code to that position in the text where the column should be broken.
20344 Note that this leads in most cases to whitespace in the text.
20345 \begin_inset Newline newline
20348 Here is an example:
20351 \begin_layout Standard
20352 \begin_inset Flex Multiple Columns
20355 \begin_layout Plain Layout
20358 \begin_inset Quotes eld
20361 You're surprised to see me, sir,
20362 \begin_inset Quotes erd
20365 said he, in a strange, croaking voice.
20368 \begin_layout Plain Layout
20371 I acknowledged that I was.
20374 \begin_layout Plain Layout
20377 \begin_inset Quotes eld
20380 Well, I've a conscience, sir, and when I chanced to see you go into this
20381 house, as I came hobbling after you, I thought to myself, I'll just step
20382 in and see that kind gentleman, and tell him that if I was a bit gruff
20383 in my manner there was not any harm meant, and that I am much obliged to
20384 him for picking up my books.
20385 \begin_inset Quotes erd
20391 \begin_layout Plain Layout
20394 \begin_inset Quotes eld
20397 You make too much of a trifle,
20398 \begin_inset Quotes erd
20403 \begin_inset Quotes eld
20406 May I ask how you knew who I was?
20407 \begin_inset Quotes erd
20410 AFTER THIS SENTENCE THE COLUMN BREAK IS FORCED.
20414 \begin_layout Plain Layout
20426 \begin_layout Plain Layout
20429 \begin_inset Quotes eld
20432 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
20433 you'll find my little bookshop at the corner of Church Street, and very
20434 happy to see you, I am sure.
20435 Maybe you collect yourself, sir.
20439 \begin_inset space ~
20453 \begin_inset space ~
20456 – a bargain, every one of them.
20457 With five volumes you could just fill that gap on that second shelf.
20458 It looks untidy, does it not, sir?
20459 \begin_inset Quotes erd
20470 \begin_layout Paragraph
20474 \begin_layout Standard
20475 The width of the columns is automatically calculated, but you can modify
20476 the space between the columns.
20477 This is done by changing the length
20478 \begin_inset Flex Code
20481 \begin_layout Plain Layout
20490 Its predefined value is 10
20491 \begin_inset space \thinspace{}
20495 Here is an example where
20496 \begin_inset Flex Code
20499 \begin_layout Plain Layout
20508 \begin_inset space \thinspace{}
20514 \begin_layout Standard
20518 \begin_layout Plain Layout
20532 \begin_layout Standard
20533 \begin_inset Flex Multiple Columns
20536 \begin_layout Plain Layout
20539 My observations of No.
20540 \begin_inset space \space{}
20543 427 Park Lane did little to clear up the problem in which I was interested.
20544 The house was separated from the street by a low wall and railing, the
20545 whole not more than five feet high.
20546 It was perfectly easy, therefore, for anyone to get into the garden, but
20547 the window was entirely inaccessible, since there was no water pipe or
20548 anything which could help the most active man to climb it.
20549 More puzzled than ever, I retraced my steps to Kensington.
20550 I had not been in my study five minutes when the maid entered to say that
20551 a person desired to see me.
20552 To my astonishment it was none other than my strange old book collector,
20553 his sharp, wizened face peering out from a frame of white hair, and his
20554 precious volumes, a dozen of them at least, wedged under his right arm.
20562 \begin_layout Standard
20566 \begin_layout Plain Layout
20578 \begin_inset Note Note
20581 \begin_layout Plain Layout
20582 go back to the default
20590 \begin_layout Paragraph
20594 \begin_layout Standard
20595 Between the columns a rule with a width of the length
20596 \begin_inset Flex Code
20599 \begin_layout Plain Layout
20608 If this rule width is set to 0
20609 \begin_inset space \thinspace{}
20612 pt (this is the default), the rule is suppressed.
20613 In the following example the rule is 2
20614 \begin_inset space \thinspace{}
20620 \begin_layout Standard
20624 \begin_layout Plain Layout
20630 columnseprule}{2pt}
20638 \begin_layout Standard
20639 \begin_inset Flex Multiple Columns
20642 \begin_layout Plain Layout
20645 \begin_inset Quotes eld
20648 You're surprised to see me, sir,
20649 \begin_inset Quotes erd
20652 said he, in a strange, croaking voice.
20655 \begin_layout Plain Layout
20658 I acknowledged that I was.
20661 \begin_layout Plain Layout
20664 \begin_inset Quotes eld
20667 Well, I've a conscience, sir, and when I chanced to see you go into this
20668 house, as I came hobbling after you, I thought to myself, I'll just step
20669 in and see that kind gentleman, and tell him that if I was a bit gruff
20670 in my manner there was not any harm meant, and that I am much obliged to
20671 him for picking up my books.
20672 \begin_inset Quotes erd
20678 \begin_layout Plain Layout
20681 \begin_inset Quotes eld
20684 You make too much of a trifle,
20685 \begin_inset Quotes erd
20690 \begin_inset Quotes eld
20693 May I ask how you knew who I was?
20694 \begin_inset Quotes erd
20700 \begin_layout Plain Layout
20703 \begin_inset Quotes eld
20706 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
20707 you'll find my little bookshop at the corner of Church Street, and very
20708 happy to see you, I am sure.
20709 Maybe you collect yourself, sir.
20713 \begin_inset space ~
20727 \begin_inset space ~
20730 – a bargain, every one of them.
20731 With five volumes you could just fill that gap on that second shelf.
20732 It looks untidy, does it not, sir?
20733 \begin_inset Quotes erd
20744 \begin_layout Standard
20745 \begin_inset VSpace defskip
20751 \begin_layout Standard
20752 The rule can be colored by redefining the command
20753 \begin_inset Flex Code
20756 \begin_layout Plain Layout
20765 This is done by inserting the command
20768 \begin_layout LyX-Code
20773 columnseprulecolor}{
20778 \begin_layout Standard
20779 as \SpecialChar TeX
20780 Code before the multicolumn inset.
20782 \begin_inset Flex Code
20785 \begin_layout Plain Layout
20791 in this command by a color of your choice.
20792 You can use all pre- and self-defined colors.
20800 \begin_inset space ~
20805 for more information about pre- and self-defined colors.
20806 To go back to the default color insert the command
20809 \begin_layout LyX-Code
20814 columnseprulecolor}{
20819 \begin_layout Standard
20820 Here is the example with a cyan rule and 1
20821 \begin_inset space \thinspace{}
20824 cm column separation:
20827 \begin_layout Standard
20831 \begin_layout Plain Layout
20840 \begin_layout Plain Layout
20846 columnseprulecolor}{
20856 \begin_layout Standard
20857 \begin_inset Flex Multiple Columns
20860 \begin_layout Plain Layout
20863 \begin_inset Quotes eld
20866 You're surprised to see me, sir,
20867 \begin_inset Quotes erd
20870 said he, in a strange, croaking voice.
20873 \begin_layout Plain Layout
20876 I acknowledged that I was.
20879 \begin_layout Plain Layout
20882 \begin_inset Quotes eld
20885 Well, I've a conscience, sir, and when I chanced to see you go into this
20886 house, as I came hobbling after you, I thought to myself, I'll just step
20887 in and see that kind gentleman, and tell him that if I was a bit gruff
20888 in my manner there was not any harm meant, and that I am much obliged to
20889 him for picking up my books.
20890 \begin_inset Quotes erd
20896 \begin_layout Plain Layout
20899 \begin_inset Quotes eld
20902 You make too much of a trifle,
20903 \begin_inset Quotes erd
20908 \begin_inset Quotes eld
20911 May I ask how you knew who I was?
20912 \begin_inset Quotes erd
20918 \begin_layout Plain Layout
20921 \begin_inset Quotes eld
20924 Well, sir, if it isn't too great a liberty, I am a neighbour of yours, for
20925 you'll find my little bookshop at the corner of Church Street, and very
20926 happy to see you, I am sure.
20927 Maybe you collect yourself, sir.
20931 \begin_inset space ~
20945 \begin_inset space ~
20948 – a bargain, every one of them.
20949 With five volumes you could just fill that gap on that second shelf.
20950 It looks untidy, does it not, sir?
20951 \begin_inset Quotes erd
20962 \begin_layout Standard
20966 \begin_layout Plain Layout
20972 columnseprule}{0pt}
20975 \begin_layout Plain Layout
20981 columnseprulecolor}{
20989 \begin_inset Note Note
20992 \begin_layout Plain Layout
20993 go back to the default
21001 \begin_layout Section
21003 \change_inserted 564990737 1671270380
21007 \begin_layout Subsection
21009 \change_inserted 564990737 1671270398
21011 \change_deleted 564990737 1671270396
21017 \begin_layout Standard
21020 as well as any other text processor uses by default rectangular paragraphs.
21021 For special cases like for example posters, invitation cards or poems you
21022 can modify the paragraph shape to one of your choice.
21024 \change_deleted 564990737 1672311802
21025 This can be done by using the \SpecialChar LaTeX
21027 \begin_inset Flex Code
21030 \begin_layout Plain Layout
21036 which is loaded by using in the document settings the module
21038 Custom paragraph shapes
21041 \change_inserted 564990737 1672311802
21044 This module uses the
21048 package to provide over a dozen paragraph shapes as well as commands to
21049 define custom shapes.
21055 \begin_layout Subsubsection
21059 \begin_layout Standard
21064 provides the following shapes:
21067 \begin_layout Standard
21068 \begin_inset Tabular
21069 <lyxtabular version="3" rows="13" columns="3">
21070 <features booktabs="true" islongtable="true" longtabularalignment="center">
21071 <column alignment="left" valignment="middle" width="16col%">
21072 <column alignment="left" valignment="middle" width="40col%">
21073 <column alignment="left" valignment="middle" width="35col%">
21074 <row endhead="true">
21075 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21078 \begin_layout Plain Layout
21087 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
21090 \begin_layout Plain Layout
21099 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
21102 \begin_layout Plain Layout
21112 <row interlinespace="default">
21113 <cell alignment="left" valignment="top" usebox="none">
21116 \begin_layout Plain Layout
21124 <cell alignment="left" valignment="top" usebox="none">
21127 \begin_layout Plain Layout
21130 Circle with circular hole (in the size of a CD/DVD)
21135 <cell alignment="left" valignment="top" usebox="none">
21138 \begin_layout Plain Layout
21141 Cannot be scaled, take care there is not too much text
21147 <row interlinespace="default">
21148 <cell alignment="left" valignment="top" usebox="none">
21151 \begin_layout Plain Layout
21159 <cell alignment="left" valignment="top" usebox="none">
21162 \begin_layout Plain Layout
21170 <cell alignment="left" valignment="top" usebox="none">
21173 \begin_layout Plain Layout
21176 Fragile, calculation might fail
21182 <row interlinespace="default">
21183 <cell alignment="left" valignment="top" usebox="none">
21186 \begin_layout Plain Layout
21194 <cell alignment="left" valignment="top" usebox="none">
21197 \begin_layout Plain Layout
21200 Rhomboid (symbolizing a
21201 \begin_inset Quotes eld
21205 \begin_inset Quotes erd
21213 <cell alignment="left" valignment="top" usebox="none">
21216 \begin_layout Plain Layout
21225 <row interlinespace="default">
21226 <cell alignment="left" valignment="top" usebox="none">
21229 \begin_layout Plain Layout
21237 <cell alignment="left" valignment="top" usebox="none">
21240 \begin_layout Plain Layout
21248 <cell alignment="left" valignment="top" usebox="none">
21251 \begin_layout Plain Layout
21260 <row interlinespace="default">
21261 <cell alignment="left" valignment="top" usebox="none">
21264 \begin_layout Plain Layout
21272 <cell alignment="left" valignment="top" usebox="none">
21275 \begin_layout Plain Layout
21283 <cell alignment="left" valignment="top" usebox="none">
21286 \begin_layout Plain Layout
21295 <row interlinespace="default">
21296 <cell alignment="left" valignment="top" usebox="none">
21299 \begin_layout Plain Layout
21307 <cell alignment="left" valignment="top" usebox="none">
21310 \begin_layout Plain Layout
21313 Nut for bolt (hexagon with circular hole)
21318 <cell alignment="left" valignment="top" usebox="none">
21321 \begin_layout Plain Layout
21330 <row interlinespace="default">
21331 <cell alignment="left" valignment="top" usebox="none">
21334 \begin_layout Plain Layout
21342 <cell alignment="left" valignment="top" usebox="none">
21345 \begin_layout Plain Layout
21353 <cell alignment="left" valignment="top" usebox="none">
21356 \begin_layout Plain Layout
21365 <row interlinespace="default">
21366 <cell alignment="left" valignment="top" usebox="none">
21369 \begin_layout Plain Layout
21377 <cell alignment="left" valignment="top" usebox="none">
21380 \begin_layout Plain Layout
21388 <cell alignment="left" valignment="top" usebox="none">
21391 \begin_layout Plain Layout
21400 <row interlinespace="default">
21401 <cell alignment="left" valignment="top" usebox="none">
21404 \begin_layout Plain Layout
21412 <cell alignment="left" valignment="top" usebox="none">
21415 \begin_layout Plain Layout
21423 <cell alignment="left" valignment="top" usebox="none">
21426 \begin_layout Plain Layout
21435 <row interlinespace="default">
21436 <cell alignment="left" valignment="top" usebox="none">
21439 \begin_layout Plain Layout
21447 <cell alignment="left" valignment="top" usebox="none">
21450 \begin_layout Plain Layout
21453 Normal/reversed rain drop
21458 <cell alignment="left" valignment="top" usebox="none">
21461 \begin_layout Plain Layout
21464 Fragile, calculation might fail
21470 <row interlinespace="default">
21471 <cell alignment="left" valignment="top" usebox="none">
21474 \begin_layout Plain Layout
21483 <cell alignment="left" valignment="top" usebox="none">
21486 \begin_layout Plain Layout
21489 The \SpecialChar TeX
21495 <cell alignment="left" valignment="top" usebox="none">
21498 \begin_layout Plain Layout
21507 <row interlinespace="default">
21508 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
21511 \begin_layout Plain Layout
21515 \begin_inset Newline newline
21523 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
21526 \begin_layout Plain Layout
21529 Triangles in different orientations
21534 <cell alignment="left" valignment="top" bottomline="true" usebox="none">
21537 \begin_layout Plain Layout
21553 \begin_layout Standard
21554 To use a shape for your paragraph, simply select it in \SpecialChar LyX
21556 for environments in the toolbar.
21559 \begin_layout Standard
21560 \begin_inset Newpage newpage
21566 \begin_layout Standard
21567 Here is an example paragraph in the shape of a nut:
21570 \begin_layout Standard
21571 \begin_inset VSpace bigskip
21580 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
21581 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
21583 At vero eos et accusam et justo duo dolores et ea rebum.
21584 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
21586 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
21587 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
21591 \begin_layout Standard
21592 \begin_inset VSpace bigskip
21598 \begin_layout Standard
21599 \begin_inset Note Greyedout
21602 \begin_layout Plain Layout
21611 paragraphs cannot run over a page break.
21619 \begin_layout Standard
21620 \begin_inset VSpace bigskip
21626 \begin_layout Standard
21628 \begin_inset Flex Code
21631 \begin_layout Plain Layout
21637 takes care that the shape will always be preserved, no matter how much
21638 text is in the paragraph.
21639 Therefore the paragraph size changes with the amount of contained text.
21640 This can lead to paragraph sizes exceeding the page margins.
21641 To demonstrate the size scaling, here is the same example paragraph but
21642 with twice as much text:
21645 \begin_layout Standard
21646 \begin_inset Newpage newpage
21655 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
21656 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
21658 At vero eos et accusam et justo duo dolores et ea rebum.
21659 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
21661 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
21662 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
21664 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
21665 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
21667 At vero eos et accusam et justo duo dolores et ea rebum.
21668 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
21670 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
21671 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
21675 \begin_layout Standard
21676 \begin_inset VSpace bigskip
21682 \begin_layout Standard
21683 An exception is the shape
21688 It cannot be scaled because it must fit the size of a CD/DVD.
21689 Therefore the amount of text that fits into the shape is limited.
21690 \begin_inset Newline newline
21701 shape are fragile, meaning that the calculation of their size can fail,
21702 depending on the amount of text.
21703 You will then get the \SpecialChar LaTeX
21705 \begin_inset Quotes eld
21708 Arithmetic overflow
21709 \begin_inset Quotes erd
21713 In this case one can try to remove or add some text; if nothing works one
21714 has to use another shape.
21717 \begin_layout Standard
21718 \begin_inset VSpace bigskip
21724 \begin_layout Standard
21725 For shapes with tips you will maybe see that \SpecialChar LaTeX
21726 's hyphenation routine fails
21727 for text in the tips.
21728 Therefore it is often necessary to add hyphenation points
21733 arg "specialchar-insert hyphenation"
21738 ) to the corresponding text parts.
21741 \begin_layout Standard
21742 \begin_inset VSpace bigskip
21748 \begin_layout Standard
21749 Shapepar paragraphs are either always centered or placed on the page so
21750 that their left border touches the left page margin.
21751 You can therefore not use the paragraph dialog to align such paragraphs.
21752 A solution is to put the paragraph into a minipage or parbox and align
21754 The problem is hereby to find the right width for the box.
21755 Because if it is too wide and you center the box, the paragraph is not
21756 centered too because it sticks at the left side of the box.
21757 So you might have to play a bit with the width until it fits.
21758 Here are two heart-shaped paragraphs, the first one is not aligned, the
21759 second one is right-aligned:
21762 \begin_layout Standard
21763 \begin_inset Newpage newpage
21769 \begin_layout Heart
21773 Lo\SpecialChar softhyphen
21774 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
21775 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
21777 At vero eos et accusam et justo duo dolores et ea rebum.
21778 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
21782 \begin_layout Standard
21783 \begin_inset VSpace bigskip
21789 \begin_layout Standard
21792 \begin_inset Box Frameless
21802 height_special "totalheight"
21807 backgroundcolor "none"
21810 \begin_layout Heart
21814 Lo\SpecialChar softhyphen
21815 rem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
21816 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
21818 At vero eos et accusam et justo duo dolores et ea rebum.
21819 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
21828 \begin_layout Subsubsection
21832 \begin_layout Standard
21833 You can define any shape you want.
21834 Doing this manually is a lot of work because every coordinate must be specified.
21835 But there is a way to let the computer calculate the coordinates:
21838 \begin_layout Enumerate
21839 Install the program
21840 \begin_inset CommandInset href
21843 target "https://www.ctan.org/tex-archive/graphics/jpgfdraw"
21851 \begin_layout Enumerate
21858 TeX/LaTeX\SpecialChar menuseparator
21859 Settings\SpecialChar menuseparator
21862 and select the font size you are using in your document.
21863 For example this document uses the size 12
21864 \begin_inset space \thinspace{}
21870 \begin_layout Enumerate
21874 \begin_layout Enumerate
21877 TeX/LaTeX\SpecialChar menuseparator
21880 to export the shape to coordinates.
21881 In the appearing dialog use either the outline of your shape for the coordinate
21882 s or the path itself.
21886 \begin_layout Plain Layout
21887 For more information see
21888 \begin_inset CommandInset href
21890 target "http://www.dickimaw-books.com/apps/jpgfdraw/manual/shapepar.html"
21903 \begin_layout Standard
21904 The coordinates are written into a \SpecialChar TeX
21906 To use it for your \SpecialChar LyX
21910 \begin_layout Enumerate
21911 Place the cursor before the first character of your paragraph (or into a
21915 \begin_layout Enumerate
21916 Open in \SpecialChar LyX
21919 Insert\SpecialChar menuseparator
21920 File\SpecialChar menuseparator
21922 \begin_inset space ~
21927 , select the file and use
21936 \begin_layout Standard
21937 \begin_inset VSpace defskip
21943 \begin_layout Standard
21944 \begin_inset Note Greyedout
21947 \begin_layout Plain Layout
21952 : The changed shape only applies to the current paragraph; everything is
21953 reset to normal for the next paragraph.
21954 Therefore the shape definition file must be input into every paragraph
21955 with the desired shape.
21963 \begin_layout Standard
21964 \begin_inset VSpace bigskip
21970 \begin_layout Standard
21971 Here is an example:
21974 \begin_layout Standard
21975 \begin_inset VSpace bigskip
21981 \begin_layout Standard
21982 \begin_inset CommandInset include
21984 filename "SpecialParagraphShape.tex"
21991 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
21992 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
21994 At vero eos et accusam et justo duo dolores et ea rebum.
21995 Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor
21997 Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy
21998 eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam
22002 \begin_layout Standard
22003 \begin_inset VSpace bigskip
22009 \begin_layout Standard
22014 to draw complexer shapes in
22018 you can draw the shape in a program of your choice and import the resulting
22024 Then you only need to draw a line or spline along the outline of the image.
22027 \begin_layout Standard
22028 \begin_inset VSpace bigskip
22034 \begin_layout Standard
22037 Custom paragraph shapes
22039 also provides the two commands
22047 which can be used to define custom shapes coordinate by coordinate.
22051 \begin_layout Plain Layout
22052 These commands are internally used for all shapes described here.
22057 For information how these styles are used and about further customization
22058 possibilities, have a look at the
22059 \begin_inset CommandInset href
22061 name "documentation"
22062 target "https://www.ctan.org/tex-archive/macros/latex/contrib/shapepar/shapepar.pdf"
22068 \begin_inset Flex Code
22071 \begin_layout Plain Layout
22080 \begin_layout Subsection
22082 \change_inserted 564990737 1672311925
22088 \begin_layout Hanging
22090 \change_inserted 564990737 1672311925
22093 This module adds the
22097 paragraph style, that is, one where all but the first line of the paragraph
22099 This may not appear in your \SpecialChar LyX
22100 document but will appear in the final output.
22103 \begin_layout Subsection
22105 \change_inserted 564990737 1672311925
22108 \begin_inset CommandInset label
22110 name "subsec:Initials"
22114 Initials (Drop Caps)
22117 \begin_layout Initial
22119 \change_inserted 564990737 1672311925
22122 \begin_inset Argument 2
22125 \begin_layout Plain Layout
22127 \change_inserted 564990737 1672311925
22138 \begin_inset Argument 3
22141 \begin_layout Plain Layout
22143 \change_inserted 564990737 1672311925
22153 module adds a drop capitals paragraph style
22157 for paragraph environments which you can use wherever you want to have
22159 You then have three more items in the
22166 \begin_layout Itemize
22168 \change_inserted 564990737 1672311925
22174 which creates an inset for the drop capital
22177 \begin_layout Itemize
22179 \change_inserted 564990737 1672311925
22185 which creates an inset for the rest of the word
22188 \begin_layout Itemize
22190 \change_inserted 564990737 1672311925
22196 which allow you configure the formatting of the drop capital.
22199 \begin_layout Standard
22201 \change_inserted 564990737 1672311925
22204 To customize the appearance of the style, see
22206 Help\SpecialChar menuseparator
22207 Embedded Objects\SpecialChar menuseparator
22208 Objects Surrounded by Text\SpecialChar menuseparator
22214 \begin_layout Section
22216 \change_inserted 564990737 1672312011
22222 \begin_layout Subsection
22224 \change_inserted 564990737 1672312011
22227 Hyphenatable Text Markup
22230 \begin_layout Standard
22232 \change_inserted 564990737 1672312011
22235 This package defines text styles to highlight, space-out, strike-through,
22236 underline and capitalize/small-cap text by means of the
22241 As opposed to the markup provided by the Text Properties dialog, words
22248 \begin_inset CommandInset href
22250 name "soul documentation"
22251 target "http://mirrors.ctan.org/macros/generic/soul/soul.pdf"
22259 \begin_layout Subsection
22261 \change_inserted 564990737 1672312011
22267 \begin_layout Standard
22269 \change_inserted 564990737 1672312011
22272 This module defines some character styles for logical markup:
22275 \begin_inset Flex Noun
22278 \begin_layout Plain Layout
22280 \change_inserted 564990737 1672312011
22296 \begin_inset Flex Emph
22299 \begin_layout Plain Layout
22301 \change_inserted 564990737 1672312011
22315 \begin_inset Flex Strong
22318 \begin_layout Plain Layout
22320 \change_inserted 564990737 1672312011
22331 \begin_inset Flex Code
22334 \begin_layout Plain Layout
22336 \change_inserted 564990737 1672312011
22346 which are accessed via the
22351 dit\SpecialChar menuseparator
22353 \begin_inset space ~
22357 \begin_inset space ~
22369 \begin_layout Chapter
22371 \change_deleted 564990737 1671304317
22375 \change_inserted 564990737 1671304322
22377 \change_deleted 564990737 1671304331
22378 ies with Bib\SpecialChar TeX
22384 \begin_layout Standard
22385 The most basic information about how to use Bib\SpecialChar TeX
22390 with \SpecialChar LyX
22391 is contained in the section
22393 Bibliography databases
22400 The following subsections explain special bibliography features supported
22401 by \SpecialChar LyX
22405 \begin_layout Section
22406 Alternative Citation Styles
22409 \begin_layout Standard
22410 Standard Bib\SpecialChar TeX
22412 \begin_inset space \thinspace{}
22416 \begin_inset space \space{}
22420 \begin_inset Quotes eld
22424 \begin_inset Quotes erd
22427 ) to refer to a cited work.
22428 However, in many scientific disciplines, other citation styles are in use.
22429 The most common one is the author-year style (e.
22430 \begin_inset space \thinspace{}
22434 \begin_inset space \space{}
22438 \begin_inset Quotes eld
22442 \begin_inset Quotes erd
22447 supports three packages that provide this style,
22448 \begin_inset Flex Code
22451 \begin_layout Plain Layout
22458 \begin_inset Flex Code
22461 \begin_layout Plain Layout
22468 \begin_inset Flex Code
22471 \begin_layout Plain Layout
22478 Each of these packages has their pros and cons, which cannot be listed
22480 If you only want to have simple author-year (or author-numerical) style,
22481 or if you want to use one of the countless style files for
22482 \begin_inset Flex Code
22485 \begin_layout Plain Layout
22491 , then the established
22492 \begin_inset Flex Code
22495 \begin_layout Plain Layout
22501 package is probably your choice.
22502 If you look for specific citation styles common in law studies, you might
22504 \begin_inset Flex Code
22507 \begin_layout Plain Layout
22514 If you want to have full control over the formatting or look for advanced
22515 features such as ibidem, footnote citations, full title citations, advanced
22516 date formats (such as 400 BC) or full localization to other languages than
22517 English, you should definitely consider
22518 \begin_inset Flex Code
22521 \begin_layout Plain Layout
22527 , which exceeds all other packages in terms of features, but is also quite
22528 heavy and more resource-hungry.
22531 \begin_layout Standard
22532 The handling of these packages in \SpecialChar LyX
22533 is basically the same.
22535 \begin_inset Flex Noun
22538 \begin_layout Plain Layout
22539 Document\SpecialChar menuseparator
22546 \begin_inset Flex Noun
22549 \begin_layout Plain Layout
22556 \begin_inset Flex Noun
22559 \begin_layout Plain Layout
22566 \begin_inset Flex Noun
22569 \begin_layout Plain Layout
22576 \begin_inset Flex Noun
22579 \begin_layout Plain Layout
22586 \begin_inset Flex Noun
22589 \begin_layout Plain Layout
22590 Biblatex (Natbib mode)
22596 \begin_inset Flex Noun
22599 \begin_layout Plain Layout
22606 \begin_inset Flex Noun
22609 \begin_layout Plain Layout
22616 \begin_inset space ~
22619 6.5.3 in the User's Guide for more information on these choices).
22620 With all these packages, you will get some extra features in the citation
22621 dialog and you can select the style of the reference (
22622 \begin_inset Quotes eld
22626 \begin_inset Quotes erd
22630 \begin_inset Quotes eld
22634 \begin_inset Quotes erd
22638 \begin_inset Quotes eld
22642 \begin_inset Quotes erd
22646 \begin_inset Quotes eld
22650 \begin_inset Quotes erd
22654 Note that either package needs specifically designed style files.
22655 They all ship their own, but there are lots of additional style files,
22656 and there is even an interactive style file builder
22660 \begin_layout Plain Layout
22662 \begin_inset Flex URL
22665 \begin_layout Plain Layout
22667 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/custom-bib/
22678 \begin_inset Flex Code
22681 \begin_layout Plain Layout
22690 \begin_layout Section
22691 Subdivided Bibliographies
22694 \begin_layout Standard
22695 Sometimes you might need to divide your bibliography into several sections.
22696 If you are for instance a historian, the possibility to separate sources
22697 and scientific works is most likely a
22698 \begin_inset Quotes eld
22702 \begin_inset Quotes erd
22706 Unfortunately, Bib\SpecialChar TeX
22707 itself does not allow you to do this.
22708 But with the help of some \SpecialChar LaTeX
22709 packages, Bib\SpecialChar TeX
22710 can be extended to fit your needs.
22713 \begin_layout Standard
22715 provides native support for one of these packages,
22723 \begin_layout Plain Layout
22725 \begin_inset Flex URL
22728 \begin_layout Plain Layout
22730 ftp://ctan.tug.org/tex-archive/macros/latex/contrib/bibtopic/
22740 The advantage of this package (compared to other packages such as
22744 ) is that you don't need to define new citation commands.
22745 Instead, you need to prepare different bibliographic databases which include
22746 the entries for the different sections of the bibliography.
22747 For example: If you want to divide your bibliography into the sections
22749 \begin_inset Quotes eld
22753 \begin_inset Quotes erd
22757 \begin_inset Quotes eld
22761 \begin_inset Quotes erd
22764 , you first need to create two bibliographic databases, e.
22765 \begin_inset space \thinspace{}
22769 \begin_inset space \space{}
22773 \begin_inset Flex Code
22776 \begin_layout Plain Layout
22783 \begin_inset Flex Code
22786 \begin_layout Plain Layout
22796 \begin_layout Standard
22798 \begin_inset Flex Noun
22801 \begin_layout Plain Layout
22802 Document\SpecialChar menuseparator
22809 \begin_inset Flex Noun
22812 \begin_layout Plain Layout
22819 \begin_inset Flex Noun
22822 \begin_layout Plain Layout
22823 Subdivided bibliography
22829 Now you can insert multiple Bib\SpecialChar TeX
22830 bibliographies, one for each section of
22832 Returning to our example: Insert the Bib\SpecialChar TeX
22834 \begin_inset Flex Code
22837 \begin_layout Plain Layout
22843 and a second one for the database
22844 \begin_inset Flex Code
22847 \begin_layout Plain Layout
22854 You are free to use the same or different styles for each section.
22855 Additionally, you can choose if the bibliography section should contain
22857 \begin_inset Quotes eld
22860 all cited references
22861 \begin_inset Quotes erd
22864 of the specified database(s) (which is the default),
22865 \begin_inset Quotes eld
22868 all uncited references
22869 \begin_inset Quotes erd
22873 \begin_inset Quotes eld
22877 \begin_inset Quotes erd
22881 This might be useful if you would like to separate your bibliography into
22883 \begin_inset Quotes eld
22887 \begin_inset Quotes erd
22891 \begin_inset Quotes eld
22895 \begin_inset Quotes erd
22899 \begin_inset Quotes eld
22903 \begin_inset Quotes erd
22907 The titles for the sections can be added as ordinary sections or subsections.
22909 \begin_inset Flex Code
22912 \begin_layout Plain Layout
22918 removes the bibliography title, you have to manually re-add that, too (as
22919 a chapter* or section*, for instance).
22922 \begin_layout Standard
22927 , the procedure is a bit different.
22936 , the aforementioned
22937 \begin_inset Flex Noun
22940 \begin_layout Plain Layout
22941 Subdivided bibliography
22946 option is disabled if you use
22955 provides its own means to generate subdivided bibliographies.
22956 You can either add keywords to bibliography entries via the
22957 \begin_inset Flex Code
22960 \begin_layout Plain Layout
22966 entry option and then filter bibliography sections by keyword (by adding
22968 \begin_inset Flex Code
22971 \begin_layout Plain Layout
22978 \begin_inset Flex Noun
22981 \begin_layout Plain Layout
22987 field of the dialog that opens if you left-click on the
22988 \begin_inset Flex Noun
22991 \begin_layout Plain Layout
22992 Biblatex Generated Bibliography
22997 button), or you can filter by entry types (such as
23006 \begin_inset space \thinspace{}
23011 \begin_inset Flex Code
23014 \begin_layout Plain Layout
23021 \begin_inset Flex Code
23024 \begin_layout Plain Layout
23031 \begin_inset Flex Noun
23034 \begin_layout Plain Layout
23040 field, or you can create so-called
23041 \begin_inset Quotes eld
23044 Bibliography Categories
23045 \begin_inset Quotes erd
23048 to which you can assign individual entries.
23049 Please refer to the Biblatex manual, section
23051 Subdivided Bibliographies
23056 \begin_layout Section
23057 Multiple Bibliographies
23058 \begin_inset CommandInset label
23060 name "subsec:Multiple-Bibliographies"
23067 \begin_layout Standard
23068 Multiple bibliographies, e.
23069 \begin_inset space \thinspace{}
23073 \begin_inset space \space{}
23076 a bibliography for each part, chapter, section, subsection or child (sub-documen
23077 t) of the document, are also supported by \SpecialChar LyX
23079 In order to enable it, go to
23080 \begin_inset Flex Noun
23083 \begin_layout Plain Layout
23084 Document\SpecialChar menuseparator
23085 Settings\SpecialChar menuseparator
23091 and select the relevant unit (e.
23092 \begin_inset space \thinspace{}
23096 \begin_inset Quotes eld
23100 \begin_inset Quotes erd
23104 \begin_inset Flex Noun
23107 \begin_layout Plain Layout
23108 Multiple Bibliographies
23114 Then add a Bib(la)\SpecialChar TeX
23115 bibliography to each unit (e.
23116 \begin_inset space \thinspace{}
23119 g., section) of your document.
23120 In the output, a separate bibliography, containing only the references
23121 done in the current unit is generated.
23124 \begin_layout Standard
23125 If you use Bib\SpecialChar TeX
23127 \begin_inset Flex Code
23130 \begin_layout Plain Layout
23137 \begin_inset Flex Code
23140 \begin_layout Plain Layout
23146 package is used to create multiple bibliographies.
23147 The former package is used if you select
23148 \begin_inset Quotes eld
23152 \begin_inset Quotes erd
23160 \begin_inset Flex Noun
23163 \begin_layout Plain Layout
23164 Sectioned Bibliography
23170 In all other cases,
23171 \begin_inset Flex Code
23174 \begin_layout Plain Layout
23184 \begin_layout Plain Layout
23185 An alternative approach, if you are willing to use some
23186 \begin_inset Flex Noun
23189 \begin_layout Plain Layout
23197 \begin_inset space ~
23201 \begin_inset CommandInset ref
23203 reference "sec:Inserting-TeX-Code"
23208 \begin_inset Flex Code
23211 \begin_layout Plain Layout
23223 \begin_inset Flex Code
23226 \begin_layout Plain Layout
23232 is used, \SpecialChar LyX
23233 encloses the specified units in
23234 \begin_inset Flex Code
23237 \begin_layout Plain Layout
23244 \begin_inset Flex Code
23247 \begin_layout Plain Layout
23256 \begin_inset Flex Code
23259 \begin_layout Plain Layout
23267 in order to create the units.
23268 Note that this approach has some limitations.
23269 First, every citation reference has to be inside some
23270 \begin_inset Flex Code
23273 \begin_layout Plain Layout
23280 So citations outside a defined unit (e.
23281 \begin_inset space \thinspace{}
23284 g., before the first section if you use
23285 \begin_inset Quotes eld
23289 \begin_inset Quotes erd
23293 \begin_inset Quotes eld
23297 \begin_inset Quotes erd
23301 You can also create your own units by entering
23302 \begin_inset Flex Code
23305 \begin_layout Plain Layout
23314 \begin_inset Flex Code
23317 \begin_layout Plain Layout
23325 as \SpecialChar TeX
23326 code (for instance to work around the mentioned limitation).
23328 \begin_inset Flex Code
23331 \begin_layout Plain Layout
23337 s cannot be nested.
23338 A second limitation is that
23339 \begin_inset Flex Code
23342 \begin_layout Plain Layout
23348 always processes all references of a bibliography database, even if they
23350 This can result in odd labels (e.
23351 \begin_inset space \thinspace{}
23356 \begin_inset Quotes eld
23360 \begin_inset Quotes erd
23363 if two works of this author from 2014 are in the database, even if only
23367 \begin_layout Standard
23373 \begin_inset Flex Code
23376 \begin_layout Plain Layout
23382 option is used instead.
23383 If you need specific units, you can start them with the \SpecialChar TeX
23385 \begin_inset Flex Code
23388 \begin_layout Plain Layout
23397 \begin_inset Flex Code
23400 \begin_layout Plain Layout
23409 If you also want to control the end of the unit, use the environment
23410 \begin_inset Flex Code
23413 \begin_layout Plain Layout
23423 \begin_inset Flex Code
23426 \begin_layout Plain Layout
23436 \begin_inset Flex Code
23439 \begin_layout Plain Layout
23445 s cannot be nested.
23446 In addition to the individual bibliography of the current unit,
23450 also provides an easy way to output all bibliographies, subsequently, at
23452 \begin_inset space \thinspace{}
23455 g., at the end of the document).
23457 \begin_inset Quotes eld
23460 all reference units
23461 \begin_inset Quotes erd
23464 from the Content combo box of the Bib(la)TeX inset dialog in order to achieve
23466 Please refer to the
23470 manual for more information on this topic.
23473 \begin_layout Chapter
23475 \change_deleted 564990737 1671355654
23479 \change_inserted 564990737 1671355667
23481 \change_deleted 564990737 1671355661
23483 \change_inserted 564990737 1671355684
23485 \begin_inset CommandInset label
23487 name "chap:bullets"
23492 \change_deleted 564990737 1671355684
23494 \begin_inset CommandInset label
23505 \begin_layout Standard
23511 \begin_layout Section
23515 \begin_layout Standard
23517 provides 216 bullet shapes that can be accessed from a simple dialog.
23518 Using this dialog you can easily specify what bullet shape to use at each
23519 level of an itemized list.
23520 These settings are document-wide so you won't be able to specify different
23521 sets of bullets for different paragraphs.
23525 \begin_layout Plain Layout
23526 Well, actually you can but you'll have to do it by hand.
23534 \begin_layout Section
23538 \begin_layout Standard
23539 Open the dialog by selecting the
23540 \begin_inset Flex Noun
23543 \begin_layout Plain Layout
23544 Document\SpecialChar menuseparator
23550 menu item and then select the
23551 \begin_inset Flex Noun
23554 \begin_layout Plain Layout
23563 \begin_layout Standard
23564 The dialog provides you with a table of bullet shapes.
23565 A column of buttons on the left of the table provides access to the six
23566 different panels of bullet shapes.
23567 The row of buttons across the top is used to select which bullet depth
23570 \change_deleted 244031559 1603875981
23571 A text entry under the table shows the currently selected bullet shape's
23573 equivalent and this can be edited if desired.
23574 If you do modify the text you will also need to specify any needed packages
23575 in the \SpecialChar LaTeX
23581 \begin_layout Standard
23582 The six panels are divided up by the packages they require.
23583 The following table shows the mappings from button name to \SpecialChar LaTeX
23587 \begin_layout Standard
23589 \begin_inset Tabular
23590 <lyxtabular version="3" rows="7" columns="2">
23591 <features tabularvalignment="middle">
23592 <column alignment="center" valignment="top" width="0pt">
23593 <column alignment="center" valignment="top" width="0pt">
23595 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
23598 \begin_layout Plain Layout
23613 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
23616 \begin_layout Plain Layout
23633 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23636 \begin_layout Plain Layout
23651 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23654 \begin_layout Plain Layout
23663 base \SpecialChar LaTeX
23671 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23674 \begin_layout Plain Layout
23689 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23692 \begin_layout Plain Layout
23709 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23712 \begin_layout Plain Layout
23727 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23730 \begin_layout Plain Layout
23747 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23750 \begin_layout Plain Layout
23765 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23768 \begin_layout Plain Layout
23785 <cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
23788 \begin_layout Plain Layout
23803 <cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
23806 \begin_layout Plain Layout
23823 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
23826 \begin_layout Plain Layout
23841 <cell alignment="center" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
23844 \begin_layout Plain Layout
23867 \begin_layout Standard
23869 doesn't stop you using bullets from packages you don't have.
23870 If you get errors from \SpecialChar LaTeX
23871 when you try to view or print the file, then it
23872 is likely you are missing a package.
23876 \begin_layout Plain Layout
23878 doesn't restrict your use since you may be editing locally and exporting
23887 \begin_layout Section
23891 \begin_layout Standard
23892 Select which bullet depth you want to change then select the bullet shape
23894 Any changes will not be visible in \SpecialChar LyX
23895 , but are visible when viewing the document.
23898 \begin_layout Standard
23899 You can reset a bullet shape to the default simply by clicking your right
23900 mouse button on the appropriate bullet depth button.
23904 \begin_layout Plain Layout
23906 \change_inserted 564990737 1672138075
23907 \begin_inset CommandInset label
23909 name "fn:If-you-really"
23919 want to have multiple sets of paragraphs with different sets of bullets
23920 in each, then you're going to have to get your hands dirty with \SpecialChar TeX
23922 The bullet selection dialog can help though because it provides you with
23923 the \SpecialChar LaTeX
23924 code for a wide range of bullet shapes.
23925 To make your own custom paragraphs you have the following options:
23928 \begin_layout Plain Layout
23932 \begin_layout Plain Layout
23948 \begin_layout Plain Layout
23952 \begin_layout Plain Layout
23974 \begin_layout Itemize
23975 Use the \SpecialChar LaTeX
23977 \begin_inset Flex Code
23980 \begin_layout Plain Layout
23988 to specify a new bullet shape for a given depth.
23989 You'll also need to save the current bullet shape so you can restore it
23991 In this itemized list the following \SpecialChar LaTeX
23992 code was used to change the bullet
23993 used for the first depth.
23997 \begin_layout LyX-Code
24007 \begin_layout LyX-Code
24024 \begin_layout Itemize
24025 Note that the itemize depth is specified in Roman numerals as part of the
24035 \begin_layout Itemize
24036 \begin_inset Argument item:1
24039 \begin_layout Plain Layout
24043 \begin_layout Plain Layout
24061 Specify each individual entry by starting each item with the bullet shape
24063 \begin_inset Quotes eld
24067 \begin_inset Quotes erd
24070 inset (available at
24072 Insert\SpecialChar menuseparator
24076 \begin_inset Flex Noun
24079 \begin_layout Plain Layout
24087 For example, this item was started with
24088 \begin_inset Flex Code
24091 \begin_layout Plain Layout
24106 \begin_layout Plain Layout
24110 \begin_layout Plain Layout
24126 \begin_layout Plain Layout
24127 You'll also need to revert the labelitem back to its previous setting for
24128 the global bullet shape settings to remain in effect.
24129 The way used here was:
24132 \begin_layout LyX-Code
24147 \begin_layout Chapter
24151 \begin_layout Section
24152 Multipart Documents
24155 \begin_layout Subsection
24159 \begin_layout Standard
24160 When you are working on a large file with many sections, it is often convenient
24161 to break up the document into several files, or perhaps you have something
24162 where a table may change from time to time, but the preceding text does
24164 In these cases, you should seriously consider using multipart documents.
24165 For example, scientific papers often have five major sections: the introduction
24166 , observations, results, discussion, and conclusion.
24167 Each of these could be its own separate \SpecialChar LyX
24169 \begin_inset Quotes eld
24173 \begin_inset Quotes erd
24176 file which contains the title, authors, abstract, references, etc., plus
24177 the five included files.
24178 It is important to note that each of these files is a full \SpecialChar LyX
24180 can be formatted and printed on its own, as well as included in a master
24182 Each of these files must have the same document class, however—don't attempt
24183 to mix book classes with article classes.
24184 You may also include \SpecialChar LaTeX
24185 files; however, these files must not have their own
24187 \begin_inset space \thinspace{}
24191 \begin_inset space \space{}
24194 everything up to and including the
24195 \begin_inset Flex Code
24198 \begin_layout Plain Layout
24206 line as well as the
24207 \begin_inset Flex Code
24210 \begin_layout Plain Layout
24218 line must be deleted) or else errors will be generated when you try to
24222 \begin_layout Standard
24224 allows you to include files quite easily with
24225 \begin_inset Flex Noun
24228 \begin_layout Plain Layout
24229 Insert\SpecialChar menuseparator
24231 \begin_inset space ~
24240 When you click on this selection a small box is inserted into the file
24241 at the current cursor location.
24242 Clicking on the box raises a dialog which allows you to select the file
24243 to be included, and the method of its inclusion.
24247 \begin_layout Standard
24248 The file selection box should by now be obvious.
24249 The three inclusion methods are
24250 \begin_inset Quotes eld
24254 \begin_inset Quotes erd
24258 \begin_inset Quotes eld
24262 \begin_inset Quotes erd
24266 \begin_inset Quotes eld
24270 \begin_inset Quotes erd
24275 \begin_inset Quotes eld
24279 \begin_inset Quotes erd
24283 \begin_inset Quotes eld
24287 \begin_inset Quotes erd
24290 are similar in many ways, but there are also some notable differences:
24293 \begin_layout Enumerate
24295 \begin_inset Quotes eld
24299 \begin_inset Quotes erd
24302 are typeset beginning on a new page, while files that are
24303 \begin_inset Quotes eld
24307 \begin_inset Quotes erd
24310 are typeset starting on the current page.
24313 \begin_layout Enumerate
24314 \begin_inset Quotes eld
24318 \begin_inset Quotes erd
24321 files cannot themselves
24322 \begin_inset Quotes eld
24326 \begin_inset Quotes erd
24330 \begin_inset Quotes eld
24334 \begin_inset Quotes erd
24339 \begin_inset Quotes eld
24343 \begin_inset Quotes erd
24346 , on the other hand, infinite sub-inputting is possible.
24349 \begin_layout Enumerate
24350 \begin_inset Quotes eld
24354 \begin_inset Quotes erd
24357 allow for the output of only selected
24358 \begin_inset Quotes eld
24362 \begin_inset Quotes erd
24365 files, while maintaining the actual counters (pagination etc.) and references
24366 (please refer to the section
24369 \begin_inset space ~
24377 \begin_inset space ~
24382 manual for details).
24385 \begin_layout Standard
24387 \begin_inset Quotes eld
24391 \begin_inset Quotes erd
24394 is the preferred method for chapters that are outsourced to child documents,
24396 \begin_inset Quotes eld
24400 \begin_inset Quotes erd
24403 is more suitable for arbitrary file inheritance.
24406 \begin_layout Standard
24408 \begin_inset Quotes eld
24412 \begin_inset Quotes erd
24415 included file allows you to include a file typeset exactly as it appears
24417 \begin_inset space \thinspace{}
24421 \begin_inset space \space{}
24425 \begin_inset Flex Code
24428 \begin_layout Plain Layout
24434 mode, with the characters set in a fixed-width typewriter font.
24435 Normally, spaces in this file are invisible, though two consecutive spaces
24436 are conserved, unlike \SpecialChar LyX
24437 's normal treatment of spaces.
24438 However, setting the
24439 \begin_inset Flex Noun
24442 \begin_layout Plain Layout
24444 \begin_inset space ~
24448 \begin_inset space ~
24452 \begin_inset space ~
24460 checkbox typesets a mark to unambiguously define the presence of a space.
24464 \begin_layout Standard
24465 Generally, the master file is converted into a full \SpecialChar LaTeX
24466 file before typesetting,
24467 while the included files are converted to \SpecialChar LaTeX
24468 files that do not have all the
24469 preamble information.
24472 \begin_layout Subsection
24473 Cross-References Between Files
24476 \begin_layout Standard
24477 \begin_inset Box Shadowbox
24487 height_special "totalheight"
24492 backgroundcolor "none"
24495 \begin_layout Plain Layout
24496 This section is somewhat out of date.
24497 Need to describe default master documents and how children are opened when
24507 \begin_layout Standard
24508 It is possible to set up cross-references between the different files.
24509 First, open all the files in question: let's call them A and B in a two
24510 file example, where B is included in A.
24511 Let's say you insert a label in A, then want to reference it in B.
24512 Open the cross-reference dialog whilst in document B, and you can select
24514 \begin_inset Quotes eld
24518 \begin_inset Quotes erd
24524 \begin_layout Subsection
24525 Bibliography Lists in all Subdocuments
24528 \begin_layout Standard
24529 If you work with child documents, you might want to have only one main bibliogra
24530 phy at the end, but still be able to have a selected bibliography for the
24531 child if you output it on its own.
24532 Here is how to achieve this.
24535 \begin_layout Standard
24536 For the main document, you just insert a bibliography inset at the place
24537 where the main bibliography has to appear (within the master file or within
24539 If the bibliography inset is in the master file, the references will be
24540 inherited by all children, so they are available in the citation dialog
24544 \begin_layout Standard
24545 For child-specific bibliographies, insert bibliography insets within the
24546 child documents, at the place where the bibliography should appear when
24547 the child is compiled separately.
24548 However, the trick is to insert them into a branch (
24550 Insert\SpecialChar menuseparator
24551 Branch\SpecialChar menuseparator
24552 Insert New Branch...
24555 \begin_inset space \thinspace{}
24560 \begin_inset Quotes eld
24564 \begin_inset Quotes erd
24568 Within the children, activate the branch (
24570 Document\SpecialChar menuseparator
24571 Settings...\SpecialChar menuseparator
24575 Within the master, deactivate the branch (
24577 Document\SpecialChar menuseparator
24578 Settings...\SpecialChar menuseparator
24582 Now the child's bibliography will be ignored by the master, but considered
24586 \begin_layout Standard
24587 If you need multiple bibliographies (e.
24588 \begin_inset space \thinspace{}
24591 g., one per child in the
24595 ), please refer to sec.
24596 \begin_inset space ~
24600 \begin_inset CommandInset ref
24602 reference "subsec:Multiple-Bibliographies"
24609 \begin_layout Section
24614 \begin_layout Standard
24615 Users sometimes need to be able to
24616 \begin_inset Quotes eld
24620 \begin_inset Quotes erd
24624 file together with all the images (and other files) on which it depends,
24625 either for sending to a publisher or for sharing with a co-author.
24627 includes a Python script (
24628 \begin_inset Flex Code
24631 \begin_layout Plain Layout
24637 ) that automates this process.
24638 To use it, you must have either the
24639 \begin_inset Flex Code
24642 \begin_layout Plain Layout
24649 \begin_inset Flex Code
24652 \begin_layout Plain Layout
24658 python modules installed on your system.
24659 By default, the script prefers the
24660 \begin_inset Flex Code
24663 \begin_layout Plain Layout
24670 \begin_inset Flex Code
24673 \begin_layout Plain Layout
24679 format on Unix-like systems and the
24680 \begin_inset Flex Code
24683 \begin_layout Plain Layout
24692 \begin_layout Standard
24694 's configuration process will set the script up to export a `\SpecialChar LyX
24696 and this format will then be available under
24697 \begin_inset Flex Code
24700 \begin_layout Plain Layout
24701 File\SpecialChar menuseparator
24710 \begin_layout Standard
24711 Independently of the platform, the generation of a particular archive format
24712 can be forced by adding either the
24713 \begin_inset Flex Code
24716 \begin_layout Plain Layout
24723 \begin_inset Flex Code
24726 \begin_layout Plain Layout
24733 \begin_inset Flex Code
24736 \begin_layout Plain Layout
24743 \begin_inset Flex Code
24746 \begin_layout Plain Layout
24752 format) switch to the
24753 \begin_inset Flex Code
24756 \begin_layout Plain Layout
24758 \SpecialChar menuseparator
24766 \begin_inset Flex Code
24769 \begin_layout Plain Layout
24770 Tools\SpecialChar menuseparator
24771 Preferences\SpecialChar menuseparator
24772 File Handling\SpecialChar menuseparator
24779 (Make sure you add the switch after the script name, not before it.)
24782 \begin_layout Section
24783 Fancy Headers and Footers
24786 \begin_layout Standard
24787 The default page layout is rather plain; for an
24788 \begin_inset Flex Code
24791 \begin_layout Plain Layout
24797 document class, all you get is a centered page number at the bottom of
24799 This document uses KOMA-script's book class, so it appears to be a bit
24801 But to really put on a show, you need to set the document page style to
24803 \begin_inset Quotes eld
24807 \begin_inset Quotes erd
24810 , as mentioned in the
24815 This section describes the \SpecialChar LaTeX
24816 code you need to insert in your \SpecialChar LaTeX
24818 order to get the desired effects.
24821 \begin_layout Standard
24822 For more information on fancy headers, see the
24823 \begin_inset Flex Code
24826 \begin_layout Plain Layout
24832 package documentation.
24834 \begin_inset Flex URL
24837 \begin_layout Plain Layout
24839 https://www.ctan.org/tex-archive/help/Catalogue/entries/fancyhdr.html
24847 \begin_layout Standard
24848 The page header is divided into three fields, not surprisingly labeled
24849 \begin_inset Quotes eld
24853 \begin_inset Quotes erd
24857 \begin_inset Quotes eld
24861 \begin_inset Quotes erd
24865 \begin_inset Quotes eld
24869 \begin_inset Quotes erd
24873 The footer is also divided into these three fields.
24874 The \SpecialChar LaTeX
24875 commands to set these fields in the simplest manner are
24876 \begin_inset Flex Code
24879 \begin_layout Plain Layout
24888 \begin_inset Flex Code
24891 \begin_layout Plain Layout
24900 \begin_inset Flex Code
24903 \begin_layout Plain Layout
24912 \begin_inset Flex Code
24915 \begin_layout Plain Layout
24924 Suppose you wish to put your name in the upper left hand corner of each
24926 Simply insert the following command in the preamble:
24929 \begin_layout Standard
24938 \begin_layout Standard
24939 You will now see your name in the upper left.
24940 If a field has a default entry that you would like to get rid of (often
24941 the page number appears in the central footer) simply include a command
24942 with a blank argument, e.
24943 \begin_inset space \thinspace{}
24949 \begin_layout Standard
24957 \begin_layout Standard
24958 Let's get really fancy: lets put the section number with the word
24959 \begin_inset Quotes eld
24963 \begin_inset Quotes erd
24967 \begin_inset space \thinspace{}
24971 \begin_inset space \space{}
24974 Section 3) in the upper left, the page number (e.
24975 \begin_inset space \thinspace{}
24979 \begin_inset space \space{}
24982 Page 4) in the upper right, your name in the lower left, and the date in
24984 The following commands should now appear in the preamble:
24987 \begin_layout Standard
24997 \begin_layout Standard
25005 \begin_layout Standard
25015 \begin_layout Standard
25024 \begin_layout Standard
25032 \begin_layout Standard
25042 \begin_layout Standard
25044 \begin_inset Flex Code
25047 \begin_layout Plain Layout
25056 \begin_inset Flex Code
25059 \begin_layout Plain Layout
25067 access \SpecialChar LaTeX
25068 's section and page counters, and so print out the current section
25071 \begin_inset Flex Code
25074 \begin_layout Plain Layout
25082 simply prints out today's date.
25085 \begin_layout Standard
25086 The thicknesses of the horizontal rules drawn beneath the header and above
25087 the footer can also be modified.
25088 If you don't want one of the rules, set its thickness to 0.
25089 The header rule has a default thickness of 0.4pt, the footer rule is 0pt.
25095 \begin_inset Flex Code
25098 \begin_layout Plain Layout
25103 headrulewidth}{0.4pt}
25109 \begin_inset Flex Code
25112 \begin_layout Plain Layout
25117 footrulewidth}{0.4pt}
25122 to set the thicknesses.
25125 \begin_layout Standard
25126 You can switch the header/footer settings on and off for individual pages
25127 using commands like
25128 \begin_inset Flex Code
25131 \begin_layout Plain Layout
25134 thispagestyle{empty}
25140 \begin_inset Flex Code
25143 \begin_layout Plain Layout
25146 thispagestyle{plain}
25152 \begin_inset Flex Code
25155 \begin_layout Plain Layout
25158 thispagestyle{fancy}
25164 Simply insert them in the text on the page you want changed and mark them
25165 as \SpecialChar TeX
25167 In fact, title pages are marked as plain by default, while following pages
25168 are marked fancy when using the global fancy setting.
25171 \begin_layout Standard
25172 As a final example, it is possible to include an image in the header or
25174 Suppose you want to put a company logo in the upper lefthand corner.
25175 You might try something like
25178 \begin_layout Standard
25187 includegraphics{logo.eps}}}
25190 \begin_layout Standard
25192 (you may need to preface this with
25193 \begin_inset Flex Code
25196 \begin_layout Plain Layout
25199 usepackage{graphics}
25204 if you don't include graphics elsewhere in your document).
25207 \begin_layout Chapter
25209 and the World Wide Web
25212 \begin_layout Standard
25214 has long supported the export of documents to various web-friendly formats,
25216 Before version 2.0, however, HTML export was always accomplished by the
25217 use of external converters.
25221 \begin_layout Plain Layout
25222 For details on the use of external converters with \SpecialChar LyX
25227 section of the Customization manual.
25232 These fall into two large groups: there are converters that use \SpecialChar LaTeX
25234 intermediate format, such as
25235 \begin_inset Flex Code
25238 \begin_layout Plain Layout
25245 \begin_inset Flex Code
25248 \begin_layout Plain Layout
25255 \begin_inset Flex Code
25258 \begin_layout Plain Layout
25264 , relying upon \SpecialChar LyX
25265 to produce the \SpecialChar LaTeX
25266 ; and there is a converter that works directly
25267 on \SpecialChar LyX
25269 \begin_inset Flex Code
25272 \begin_layout Plain Layout
25280 All of these have different advantages and disadvantages.
25284 \begin_layout Standard
25285 The \SpecialChar LaTeX
25286 -based converters have the advantage that, in principle, they know everythin
25287 g about the exported document that \SpecialChar LaTeX
25289 Such converters do not care, for example, if a certain block of code was
25290 produced by \SpecialChar LyX
25291 or was Evil Red Text.
25292 These converters know about
25293 \begin_inset Flex Code
25296 \begin_layout Plain Layout
25302 files, counters, and references, and can often make use of the
25303 \begin_inset Flex Code
25306 \begin_layout Plain Layout
25312 files generated by Bib\SpecialChar TeX
25314 On the other hand, \SpecialChar LaTeX
25315 is a very hard language to parse—it is sometimes said
25316 that only \SpecialChar TeX
25317 itself understands \SpecialChar TeX
25318 —and \SpecialChar LaTeX
25319 -based converters will often choke on
25320 what seem to be quite simple constructs; complex ones can throw them completely
25321 , and as of this writing, for example, the
25325 manual will not export with
25326 \begin_inset Flex Code
25329 \begin_layout Plain Layout
25335 , though the others will.
25336 The other issue concerns how math is handled.
25337 These converters typically convert the formulae into little pictures that
25338 are then linked from the HTML document.
25339 Since these are actually generated by \SpecialChar LaTeX
25340 , they are accurate.
25341 But they do not scale well, and just getting them to look as if they are
25342 actually meant to be in your document—so that the font sizes seem to be
25343 roughly the same—can be a challenge.
25346 \begin_layout Standard
25348 \begin_inset Flex Code
25351 \begin_layout Plain Layout
25359 \begin_inset CommandInset href
25361 name "http://pinchito.es/elyxer/"
25362 target "http://pinchito.es/elyxer/"
25367 ) solves some of these problems.
25368 In particular, the formulae it produces scale perfectly, since it renders
25369 math using a combination of HTML and CSS rather than converting the formulae
25371 But even moderately complex formula are rendered less well than with
25372 \begin_inset Flex Code
25375 \begin_layout Plain Layout
25381 ; this reflects the limitations of HTML.
25385 \begin_layout Plain Layout
25387 \begin_inset Flex Code
25390 \begin_layout Plain Layout
25397 can also use jsMath and MathJax for equations, but this setting is only
25398 available globally and requires one to have access to a server that runs
25404 More importantly (as of version 1.1.1, at least),
25405 \begin_inset Flex Code
25408 \begin_layout Plain Layout
25415 has limited support for math macros and no support for user-defined paragraph
25416 or character styles.
25417 These limitations make
25418 \begin_inset Flex Code
25421 \begin_layout Plain Layout
25428 unsuitable for many of the documents \SpecialChar LyX
25430 In principle, of course, these problems could be solved, but the \SpecialChar LyX
25432 have decided to follow a different path and have made \SpecialChar LyX
25434 writing XHTML, just as it is capable of writing \SpecialChar LaTeX
25435 , DocBook, and plaintext.
25438 \begin_layout Standard
25439 As of this writing, XHTML output remains under development and should probably
25441 \begin_inset Quotes eld
25445 \begin_inset Quotes erd
25452 \begin_layout Plain Layout
25454 \begin_inset Flex Code
25457 \begin_layout Plain Layout
25458 development/HTML/HTML.notes
25463 , which can be found in the \SpecialChar LyX
25465 \begin_inset CommandInset href
25467 name "accessed online"
25468 target "https://www.lyx.org/trac/browser/lyxgit/development/HTML/HTML.notes?rev=master"
25473 , usually contains up-to-date information about the state of XHTML output.
25474 See also the list of XHTML bugs on
25475 \begin_inset CommandInset href
25477 name "the bug tracker"
25478 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"
25488 Still, the developers have chosen this approach because it has several
25489 potential advantages over the other two.
25492 \begin_layout Standard
25493 These advantages are primarily due to the fact that the XHTML output routines,
25494 since they are part of \SpecialChar LyX
25495 , know everything \SpecialChar LyX
25496 knows about the document being
25501 \begin_layout Plain Layout
25502 Another advantage is that, since these routines are internal to \SpecialChar LyX
25504 immune to changes in \SpecialChar LyX
25505 's file format, or to changes in the semantics of
25511 So they know about the table of contents (as displayed in the outline),
25512 about the counters associated with different paragraph styles, and about
25513 user-defined styles.
25514 The XHTML output routines know what \SpecialChar LyX
25515 knows about internationalization,
25516 too, so they will output
25517 \begin_inset Quotes eld
25521 \begin_inset Quotes erd
25525 \begin_inset Quotes eld
25533 \begin_inset Quotes erd
25536 , depending upon the language in effect at the time.
25540 \begin_layout Standard
25541 Quite generally, the output routines know what \SpecialChar LyX
25542 knows about document layout,
25543 that is, about how the document is to be rendered on screen.
25544 We use this information when we output the document as XHTML.
25545 In particular, \SpecialChar LyX
25550 generates CSS style information corresponding to the layout information
25551 it uses to render the document on screen: if section headings are supposed
25552 to be sans-serif and bold as seen in \SpecialChar LyX
25553 , then (by default) they will be sans-seri
25554 f and bold when viewed in a web browser, too.
25555 And this is true not just for pre-defined styles, like Section, but for
25556 any style, including user-defined styles.
25557 Indeed, the XHTML output routines make no distinction between user-defined
25559 \change_deleted 244031559 1603876931
25561 \change_inserted 244031559 1603876940
25564 styles and \SpecialChar LyX
25565 's own pre-defined styles: in each case, everything \SpecialChar LyX
25567 the styles is contained in the layout files.
25568 And much the same is true as regards pre-defined textual insets, such as
25569 footnotes, and various custom insets.
25573 \begin_layout Standard
25574 The result is that XHTML output can be customized and extended in exactly
25575 the same way \SpecialChar LaTeX
25576 output can be customized and extended: through layout files
25578 See chapter five of the
25582 manual for the details.
25585 \begin_layout Standard
25586 The remainder of this chapter contains more detailed information on XHTML
25587 output, its limitations, and ways to work around those limitations.
25590 \begin_layout Section
25591 Math Output in XHTML
25594 \begin_layout Standard
25596 offers four choices for how math is rendered.
25597 These have various advantages and disadvantages:
25600 \begin_layout Itemize
25602 \begin_inset Newline newline
25605 MathML is a dialect of XML designed specifically for mathematics on the
25606 web, and it typically renders very well in browsers that support it.
25607 The disadvantage is that not all browsers support MathML, and support is
25608 not complete even in the Gecko-based browsers, such as Firefox.
25609 \begin_inset Newline newline
25612 If \SpecialChar LyX
25613 is unable to render a formula as MathML—for example, if the formula
25615 \begin_inset Flex Code
25618 \begin_layout Plain Layout
25624 package or ERT—then it will instead output the formula as an image.
25628 \begin_layout Itemize
25630 \begin_inset Newline newline
25633 As mentioned above,
25634 \begin_inset Flex Code
25637 \begin_layout Plain Layout
25643 outputs math as HTML, styled by CSS.
25647 \begin_layout Plain Layout
25649 has borrowed some of the CSS for its HTML output from
25650 \begin_inset Flex Code
25653 \begin_layout Plain Layout
25664 For simple formulae, this can work quite well, though with more complicated
25665 formulae it tends to break down.
25666 Still, this method has the advantage that it is very widely supported and
25667 so it may be appropriate for documents that contain only a little, fairly
25669 \begin_inset Newline newline
25672 If Lyx is unable to render a formula as HTML—for example, if the formula
25674 \begin_inset Flex Code
25677 \begin_layout Plain Layout
25683 package or ERT—then it will instead output the formula as an image.
25687 \begin_layout Itemize
25689 \begin_inset Newline newline
25693 \begin_inset Flex Code
25696 \begin_layout Plain Layout
25703 will output formulae as images, the very same images, in fact, that are
25704 used for instant preview.
25708 \begin_layout Plain Layout
25709 Instant preview does
25713 have to be on for images to be output, however.
25718 The advantage to this method is that the images are simply generated by
25720 , so they are very accurate.
25721 The disadvantage, as mentioned earlier, is that these are bitmapped images,
25722 so they do not scale terribly well, and one cannot copy them, etc.
25723 \begin_inset Newline newline
25726 The size of the images can be controlled by setting the
25727 \begin_inset Quotes eld
25730 Math Images Scaling
25731 \begin_inset Quotes erd
25735 \begin_inset Flex Noun
25738 \begin_layout Plain Layout
25739 Document\SpecialChar menuseparator
25740 Settings\SpecialChar menuseparator
25750 \begin_layout Plain Layout
25751 For those who want to know, this controls the resolution of the image in
25752 dots per inch and is based upon a default of 75 dpi.
25758 \begin_inset Newline newline
25761 If \SpecialChar LyX
25762 for some reason fails to create an image for a formula (e.g., if a required
25764 package is not installed), then it will fall back to outputing the raw
25769 \begin_layout Itemize
25772 \begin_inset Newline newline
25775 Finally, \SpecialChar LyX
25776 will happily output math as \SpecialChar LaTeX
25778 As well as being the output of last resort, this method can be used with
25780 \begin_inset CommandInset href
25783 target "http://www.math.union.edu/~dpvc/jsMath/"
25788 , which uses JavaScript to render \SpecialChar LaTeX
25789 embedded in HTML documents.
25791 wraps the \SpecialChar LaTeX
25793 \begin_inset Flex Code
25796 \begin_layout Plain Layout
25802 (for inline formulas) or
25803 \begin_inset Flex Code
25806 \begin_layout Plain Layout
25812 (for displayed formulas) with
25813 \begin_inset Flex Code
25816 \begin_layout Plain Layout
25822 , as is required for jsMath.
25825 \begin_layout Standard
25826 One of these output methods must be selected under
25827 \begin_inset Flex Noun
25830 \begin_layout Plain Layout
25831 Document\SpecialChar menuseparator
25832 Settings\SpecialChar menuseparator
25839 By default, \SpecialChar LyX
25841 This is a document-wide setting, therefore.
25844 \begin_layout Standard
25845 Eventually, \SpecialChar LyX
25846 will offer the user the option to select an alternate output
25847 method for a particular inset, say, one that isn't being rendered very
25852 \begin_layout Plain Layout
25853 That said, since \SpecialChar LyX
25854 falls back to images if the inset contains ERT, then one
25855 can force output as an image by putting some harmless ERT into the math,
25857 \begin_inset Formula $a=b\relax$
25868 \begin_layout Section
25869 Bibliography and Citations
25872 \begin_layout Standard
25873 XHTML output fully supports bibliographies and citations.
25877 \begin_layout Standard
25878 Citation labels are generated by the same machinery that generates \SpecialChar LyX
25880 labels, so the labels will look in the output much as they do in \SpecialChar LyX
25883 If you are using numerical citations, then \SpecialChar LyX
25884 will output numerical labels,
25885 such as [1] or [17], rather than simply showing the citation key in square
25886 brackets, as it does on-screen.
25887 If you are using author-year citations, then \SpecialChar LyX
25888 will add lowercase letters
25889 to the years, just as Bib\SpecialChar TeX
25890 does, if it finds more than one citation for
25891 a given author-year combination.
25892 The labels will be printed with the bibliography entries.
25893 Note that there is, at present, no way to customize the appearance of the
25894 labels, for example, to choose between square brackets and parentheses.
25897 \begin_layout Standard
25898 Bibliography output is handled by the same machinery that handles the presentati
25899 on of reference information in the citation dialog, so you will see in the
25900 XHTML output pretty much what you would see if you were to look at a given
25901 entry in the citation dialog.
25902 The formatting can be customized in your layout file or, preferably, in
25908 manual for the details.
25911 \begin_layout Standard
25912 The main defect at present is that cross-referenced information is printed
25913 with every entry with which it is associated.
25914 So you can see things like this:
25917 \begin_layout Quote
25919 \begin_inset Quotes eld
25922 Context and Logical Form
25923 \begin_inset Quotes erd
25928 Language in Context: Selected Essays
25930 (Oxford: Oxford University Press, 2007), pp.
25934 \begin_layout Quote
25936 \begin_inset Quotes eld
25939 Semantics in Context
25940 \begin_inset Quotes erd
25945 Language in Context: Selected Essays
25947 (Oxford: Oxford University Press, 2007), pp.
25951 \begin_layout Standard
25952 This should be fixed before long.
25955 \begin_layout Standard
25956 There is no support at present for sectioned bibliographies.
25957 If you have multiple bibliographies, then \SpecialChar LyX
25958 will print the same bibliography
25962 \begin_layout Section
25966 \begin_layout Standard
25968 will happily export indexes as XHTML, but with certain limitations at the
25972 \begin_layout Standard
25973 Index export will be most reliable when you do not attempt to use the fancy
25974 constructs that are described in the section on indexes in the
25982 \begin_layout Plain Layout
25983 The main issue here is that \SpecialChar LyX
25984 itself does not really handle these.
25985 It just lets you enter what you would have to enter in raw \SpecialChar LaTeX
25991 We'll describe how they are handled using the subsection headings from
25995 \begin_layout Itemize
25996 Grouping Index Entries (aka, sub-entries): \SpecialChar LyX
25997 makes an effort to support these,
25998 but the entries must be separated by
25999 \begin_inset Quotes eld
26003 \begin_inset Quotes erd
26006 , that is, there must be spaces around the exclamation point.
26007 This is because it is otherwise too difficult to check for escaped exclamation
26008 points, ones in math, and so forth.
26011 \begin_layout Itemize
26012 Page Ranges: There is no support at all for page ranges, since these make
26013 no sense with XHMTL.
26014 Instead, you will just get two index entries, one at either end.
26017 \begin_layout Itemize
26018 Cross-referencing: There is no support for cross-referencing.
26019 If \SpecialChar LyX
26020 finds an entry containing the
26021 \begin_inset Quotes eld
26024 |see\SpecialChar ldots
26026 \begin_inset Quotes erd
26029 construct, it is just dropped, and the rest is treated as an ordinary index
26033 \begin_layout Itemize
26034 Index Entry Order: \SpecialChar LyX
26035 does support attempts to fix the sorting order.
26036 It will take what is before the first `@' it finds and use that for sorting,
26037 taking what follows the first `@' to be the actual entry.
26038 At present, \SpecialChar LyX
26039 does not check for escaped `@', so do not try to index email
26043 \begin_layout Itemize
26044 Index Entry Layout: You can format entries by using the text style dialog,
26045 or by using any other method available within \SpecialChar LyX
26047 There is no support for constructs like:
26048 \begin_inset Quotes eld
26052 \begin_inset Quotes erd
26056 Indeed, if \SpecialChar LyX
26057 finds a pipe symbol, `|', in an entry, it will delete it and
26058 everything that follows it.
26061 \begin_layout Itemize
26062 Multiple Indexes: There is no support for multiple indexes.
26063 Rather, all index entries will be printed as one large index.
26064 To avoid our printing several versions of the index, we print only the
26065 main index, so make sure you have one.
26068 \begin_layout Section
26069 Nomenclature and Glossary
26072 \begin_layout Standard
26073 There is at present no support for glossaries.
26074 Adding it would be fairly trivial, and welcome.
26077 \begin_layout Chapter
26079 \change_inserted 1075283030 1616534180
26083 \begin_layout Standard
26085 \change_inserted 1075283030 1616534386
26086 Apart from HTML, \SpecialChar LyX
26087 can generate documents in the DocBook XML vocabulary.
26088 With versions 2.3 and before, only select templates could be used to generate
26089 DocBook documents (only version 4).
26090 Starting with \SpecialChar LyX
26091 2.4, most \SpecialChar LyX
26092 layouts can generate valid DocBook documents (only
26094 This feature is built into \SpecialChar LyX
26095 and does not require the use of external tools.
26098 \begin_layout Standard
26100 \change_inserted 1075283030 1616534437
26101 The result is that the DocBook output can be customized and extended in
26102 exactly the same way \SpecialChar LaTeX
26103 output can be customized and extended: through layout
26105 See chapter five of the
26109 manual for the details.
26112 \begin_layout Standard
26114 \change_inserted 1075283030 1616534475
26115 Most \SpecialChar LyX
26116 features are supported with DocBook, like math output.
26119 \begin_layout Itemize
26121 \change_inserted 1075283030 1616534741
26122 Math output is performed mostly in MathML (the major exception being constructio
26123 ns not supported by \SpecialChar LyX
26126 All formulae are also available in raw \SpecialChar TeX
26127 in the DocBook output for further
26131 \begin_layout Itemize
26133 \change_inserted 1075283030 1616534852
26134 Bibliographies and citations are implemented, including with an external
26136 Bibliography entries are not prerendered when the detailed information
26137 are available, but rather output with the standard DocBook constructs.
26138 The external DocBook processor is expected to handle the rendering of entries.
26141 \begin_layout Itemize
26143 \change_inserted 1075283030 1616534863
26144 Indexes are supported, including multiple indices.
26149 ), page ranges, and cross-references (
26153 ) are supported, with the exception of the same symbols escaped.
26162 ) are not supported.
26163 There is no support for escaping of index entries.
26166 \begin_layout Itemize
26168 \change_inserted 1075283030 1616534884
26169 Glossaries are implemented.
26172 \begin_layout Standard
26174 \change_inserted 1075283030 1616534894
26175 Two major parameters can be set at the document level.
26178 \begin_layout Itemize
26180 \change_inserted 1075283030 1616534948
26181 Format for tables: \SpecialChar LyX
26182 can generate tables either as HTML (default value) or
26183 CALS, depending on the user's requirements.
26184 Most DocBook processors accept both formats.
26187 \begin_layout Itemize
26189 \change_inserted 1075283030 1616535006
26190 MathML prefix: in DocBook, MathML is included within its own name space,
26192 The implication is that there must be an indication of the tags belonging
26193 to the MathML standard.
26194 Three choices are offered:
26198 \begin_layout Itemize
26200 \change_inserted 1075283030 1616535044
26201 Inline: the MathML name space is defined for each formula (using the
26205 attribute on each formula)
26208 \begin_layout Itemize
26210 \change_inserted 1075283030 1616535090
26215 prefix (default): the MathML name space is defined at the document level
26220 attribute on the root element).
26221 Each MathML is prefixed with
26230 \begin_layout Itemize
26232 \change_inserted 1075283030 1616620405
26237 prefix: similar to the
26246 \begin_layout Standard
26248 \change_inserted 1075283030 1616620470
26249 This option is especially useful if you want \SpecialChar LyX
26250 to match your personal style
26251 or to work with buggy software that only accepts one prefix for MathML.
26257 \begin_layout Chapter
26258 The \SpecialChar LyX
26262 \begin_layout Section
26266 \begin_layout Standard
26267 The `\SpecialChar LyX
26268 server' allows other programs to talk to \SpecialChar LyX
26269 , invoke \SpecialChar LyX
26270 commands, and retrieve
26271 information about the \SpecialChar LyX
26273 This is only intended for advanced users, but they should find it useful.
26274 It is by writing to the \SpecialChar LyX
26275 server, for example, that bibliography managers,
26276 such as JabRef, are able to
26277 \begin_inset Quotes eld
26281 \begin_inset Quotes erd
26284 citations to \SpecialChar LyX
26288 \begin_layout Section
26289 Starting the \SpecialChar LyX
26291 \begin_inset CommandInset label
26293 name "sec:Starting-the-Server"
26300 \begin_layout Standard
26301 The \SpecialChar LyX
26302 server works through the use of a pair of named pipes.
26303 These are usually located in
26304 \begin_inset Flex Code
26307 \begin_layout Plain Layout
26313 , (except on Windows, where
26317 named pipes are special objects located in
26318 \begin_inset Flex Code
26321 \begin_layout Plain Layout
26333 ) and have the names
26334 \begin_inset Quotes eld
26338 \begin_inset Flex Code
26341 \begin_layout Plain Layout
26348 \begin_inset Quotes erd
26352 \begin_inset Quotes eld
26356 \begin_inset Flex Code
26359 \begin_layout Plain Layout
26366 \begin_inset Quotes erd
26370 External programs write into
26371 \begin_inset Flex Code
26374 \begin_layout Plain Layout
26380 and read back data from
26381 \begin_inset Flex Code
26384 \begin_layout Plain Layout
26391 The stem of the pipe names can be defined in the
26392 \begin_inset Flex Noun
26395 \begin_layout Plain Layout
26396 Tools\SpecialChar menuseparator
26402 dialog, for example
26403 \begin_inset Flex Code
26406 \begin_layout Plain Layout
26407 "/home/myhome/lyxpipe"
26413 \begin_inset Flex Code
26416 \begin_layout Plain Layout
26430 on Windows (where any working path instead of lyxpipe can be used, for
26432 \begin_inset Flex Code
26435 \begin_layout Plain Layout
26458 configure this manually in order for the server to start.
26461 \begin_layout Standard
26464 \begin_inset Flex Code
26467 \begin_layout Plain Layout
26474 \begin_inset Flex Code
26477 \begin_layout Plain Layout
26483 ' to create the pipes.
26484 If one of the pipes already exists, \SpecialChar LyX
26485 will assume that another \SpecialChar LyX
26487 is already running and will not start the server.
26488 On POSIX (Unix like) systems, if for some other reason, an unused
26489 \begin_inset Quotes eld
26493 \begin_inset Quotes erd
26496 pipe is left in existence when \SpecialChar LyX
26497 closes, then \SpecialChar LyX
26498 will try to delete it.
26499 If this fails for some reason, you will need to delete the pipes manually
26500 and then restart \SpecialChar LyX
26502 On Windows, pipes are deleted by the OS on program termination or crash,
26504 \begin_inset Quotes eld
26508 \begin_inset Quotes erd
26511 pipes should not be possible.
26514 \begin_layout Standard
26515 To have several \SpecialChar LyX
26516 processes with servers at the same time, you have to use
26517 different configurations, perhaps by using separate user directories, each
26519 \begin_inset Flex Code
26522 \begin_layout Plain Layout
26528 file, for each process.
26531 \begin_layout Standard
26532 If you are developing a client program, you might find it useful to enable
26533 debugging information from the \SpecialChar LyX
26535 Do this by starting \SpecialChar LyX
26537 \begin_inset Flex Code
26540 \begin_layout Plain Layout
26549 \begin_layout Standard
26550 You can find a complete example client written in C++ in the source distribution
26552 \begin_inset Flex Code
26555 \begin_layout Plain Layout
26556 development/lyxserver/server_monitor.cpp
26564 \begin_layout Standard
26565 Another useful tool is the command-line based client found in
26566 \begin_inset Flex Code
26569 \begin_layout Plain Layout
26570 src/client/lyxclient
26578 \begin_layout Section
26579 Normal communication
26582 \begin_layout Standard
26583 To issue a \SpecialChar LyX
26584 call, the client writes a line of ASCII text into the input
26586 This line has the following format:
26589 \begin_layout Quote
26603 \begin_layout Description
26604 clientname is a name that the client can choose arbitrarily.
26605 Its only use is that \SpecialChar LyX
26606 will echo it if it sends an answer—so a client can
26607 dispatch results from different requesters.
26610 \begin_layout Description
26611 function is the function you want \SpecialChar LyX
26613 It is the same as the commands you'd use in the minibuffer.
26616 \begin_layout Description
26617 argument is an optional argument which is meaningful only to some functions
26619 \begin_inset Quotes eld
26623 \begin_inset Quotes erd
26626 LFUN will insert the argument as text at the cursor position).
26629 \begin_layout Standard
26630 The answer from \SpecialChar LyX
26631 will arrive in the output pipe and be of the form
26634 \begin_layout Quote
26648 \begin_layout Standard
26657 are just echoed from the command request, while
26661 is more or less useful information filled according to how the command
26662 execution worked out.
26663 Some commands, such as
26664 \begin_inset Quotes eld
26668 \begin_inset Quotes erd
26671 , will return information about the internal state of \SpecialChar LyX
26673 return an empty data-response.
26674 This means that the command execution went fine.
26677 \begin_layout Standard
26678 In case of errors, the response from \SpecialChar LyX
26679 will have this form
26682 \begin_layout Quote
26696 \begin_layout Standard
26701 should contain an explanation of why the command failed.
26704 \begin_layout Standard
26708 \begin_layout LyX-Code
26709 echo "LYXCMD:test:beginning-of-buffer:" >~/.lyxpipe.in
26710 \begin_inset Newline newline
26713 echo "LYXCMD:test:get-xy:" >~/.lyxpipe.in
26714 \begin_inset Newline newline
26717 read a <~/.lyxpipe.out
26718 \begin_inset Newline newline
26724 \begin_layout Subsection
26725 AppleScript (Mac OS X)
26728 \begin_layout Standard
26729 Since \SpecialChar LyX
26730 2.1, \SpecialChar LyX
26731 supports basic interactions with AppleScript for normal communicatio
26732 n through the command run.
26733 This command takes a direct argument (the
26737 to perform) and an optional argument.
26738 It either returns the output of the function or triggers an error with
26739 the error message and code.
26742 \begin_layout Standard
26746 \begin_layout LyX-Code
26747 tell application "\SpecialChar LyX
26751 \begin_layout LyX-Code
26755 \begin_layout LyX-Code
26756 -- Stores the current file name into f
26759 \begin_layout LyX-Code
26760 set f to (run "server-get-filename" with argument "")
26763 \begin_layout LyX-Code
26764 on error the error_message number the error_number
26767 \begin_layout LyX-Code
26768 display dialog "Error: " & the error_number & ".
26772 \begin_layout LyX-Code
26773 & the error_message buttons {"OK"} default button 1
26776 \begin_layout LyX-Code
26780 \begin_layout LyX-Code
26784 \begin_layout Section
26788 \begin_layout Standard
26790 can notify clients of events going on asynchronously.
26791 Currently it will only do this if the user binds a key sequence with the
26793 \begin_inset Quotes eld
26797 \begin_inset Quotes erd
26801 The format of the string \SpecialChar LyX
26802 sends is as follows:
26805 \begin_layout Quote
26806 \begin_inset Flex Code
26809 \begin_layout Plain Layout
26820 \begin_layout Standard
26825 is the printed representation of the key sequence that was actually typed
26829 \begin_layout Standard
26830 This mechanism can be used to extend \SpecialChar LyX
26831 's command set and implement macros.
26832 Bind some key sequence to
26833 \begin_inset Quotes eld
26837 \begin_inset Quotes erd
26841 Then start a client that listens on the output pipe, dispatches the command
26842 according to the sequence, and starts a function that may use \SpecialChar LyX
26845 requests to issue a command or a series of commands to \SpecialChar LyX
26849 \begin_layout Section
26850 The simple \SpecialChar LyX
26854 \begin_layout Standard
26856 implements a simple protocol that can be used for session management.
26857 All messages are of the form
26860 \begin_layout Quote
26870 \begin_layout Standard
26876 \begin_inset Quotes eld
26880 \begin_inset Quotes erd
26884 \begin_inset Quotes eld
26888 \begin_inset Quotes erd
26893 \begin_inset Quotes eld
26897 \begin_inset Quotes erd
26900 is received from a client, \SpecialChar LyX
26901 will report back to inform the client that
26902 it's listening to it's messages, while
26903 \begin_inset Quotes eld
26907 \begin_inset Quotes erd
26910 sent from \SpecialChar LyX
26911 will inform clients that \SpecialChar LyX
26915 \begin_layout Section
26916 Reverse DVI/PDF search
26919 \begin_layout Standard
26920 Some DVI/PDF viewers
26924 \begin_layout Plain Layout
26925 The following viewers offer the reverse PDF search feature: Okular on KDE/Linux,
26926 Qpdfview on Unix, Skim on Mac OSX and SumatraPDF on Windows.
26935 facility (also called
26940 This means that you can tell \SpecialChar LyX
26941 to put the cursor to a specific line in the
26942 document by clicking at the respective position in the DVI/PDF output.
26943 To achieve this, the viewer must be able to communicate with \SpecialChar LyX
26945 This is done via the \SpecialChar LyX
26946 server either by using the named pipe (
26950 ), or the UNIX domain socket (
26954 ) that \SpecialChar LyX
26955 creates in its temporary directory (this is the way the
26956 \begin_inset Flex Code
26959 \begin_layout Plain Layout
26965 program communicates with \SpecialChar LyX
26967 In some cases, you need a helper script that mediates between the viewer
26968 and \SpecialChar LyX
26969 , in others, the viewer can communicate with \SpecialChar LyX
26971 This depends on the selected viewer and on your operating system.
26972 The same applies to the way viewers need to be configured and the way the
26973 reverse search is actually performed.
26974 In what follows, we will thus describe how to setup reverse search for
26976 Before we turn to this, though, we will explain what needs to be done generally
26977 to enable reverse search in the DVI/PDF output.
26980 \begin_layout Subsection
26982 \begin_inset CommandInset label
26984 name "subsec:rev-search"
26991 \begin_layout Standard
26992 In most cases \SpecialChar LyX
26993 will do the work for you by pressing the following button
26997 arg "buffer-toggle-output-sync"
27001 Alternatively, you can also enable the feature by checking
27003 Synchronize with Output
27006 \begin_inset Flex Noun
27009 \begin_layout Plain Layout
27010 Document\SpecialChar menuseparator
27011 Settings\SpecialChar menuseparator
27018 In such a case \SpecialChar LyX
27019 will automatically insert the necessary Sync\SpecialChar TeX
27021 PDF) or load the srcltx package (for DVI) respectively.
27022 This option can be easily reached also on
27023 \begin_inset Flex Code
27026 \begin_layout Plain Layout
27035 \begin_layout Standard
27036 If you need a different setting, you can select or input a custom macro
27037 from the drop down box just below
27038 \begin_inset Flex Noun
27041 \begin_layout Plain Layout
27042 Document\SpecialChar menuseparator
27043 Settings\SpecialChar menuseparator
27044 Output\SpecialChar menuseparator
27045 Synchronize with Output
27053 \begin_layout Standard
27054 Note that the method
27055 \begin_inset Flex Code
27058 \begin_layout Plain Layout
27066 enables gzip compression.
27067 If your viewer does not support it, you should instead use
27068 \begin_inset Flex Code
27071 \begin_layout Plain Layout
27082 \begin_layout Standard
27083 Please also note that including the
27084 \begin_inset Flex Code
27087 \begin_layout Plain Layout
27094 \begin_inset Flex Code
27097 \begin_layout Plain Layout
27103 sometimes has an undesired impact on the typesetting.
27104 Thus, you should switch output synchronization off for the final typesetting
27106 \begin_inset Flex Code
27109 \begin_layout Plain Layout
27116 \begin_inset Flex Code
27119 \begin_layout Plain Layout
27129 \begin_layout Standard
27130 In case you need some more special settings that are not covered by the
27131 automatic settings, read the next section about how to set up output synchroniz
27133 If the automatic setup suits your needs, you can readily jump to section
27134 \begin_inset space ~
27138 \begin_inset CommandInset ref
27140 reference "subsec:configuring-viewers"
27144 , where the necessary configuration steps in your viewer – needed both with
27145 the automatic and the manual setup – are described.
27148 \begin_layout Subsection
27152 \begin_layout Standard
27154 provides several different methods for reverse search.
27155 Some are built-in in the
27156 \begin_inset Flex Code
27159 \begin_layout Plain Layout
27165 program, some are provided by external packages.
27166 Your choice depends on whether your \SpecialChar LaTeX
27167 distribution already provides a given
27168 method (the built-in methods are rather new) and whether your viewer can
27170 The available methods are described in the following.
27173 \begin_layout Subsubsection*
27174 Built-in DVI-search via src-specials (DVI only)
27177 \begin_layout Standard
27178 This method provides the DVI file with the necessary information for reverse
27180 It is available in \SpecialChar LaTeX
27181 since quite some time (any somewhat recent \SpecialChar LaTeX
27183 should include it), and it works reliably.
27184 To enable it, change the
27185 \begin_inset Flex Noun
27188 \begin_layout Plain Layout
27199 \begin_inset Flex Noun
27202 \begin_layout Plain Layout
27213 \begin_inset Flex Noun
27216 \begin_layout Plain Layout
27217 Preferences\SpecialChar menuseparator
27218 File Handling\SpecialChar menuseparator
27225 \begin_inset Flex Code
27228 \begin_layout Plain Layout
27229 latex -src-specials $$i
27235 If this doesn't work, check if your \SpecialChar TeX
27236 engine needs different options (the
27237 syntax might differ in some distributions).
27240 \begin_layout Subsubsection*
27241 External Packages (PDFSync and scrltx)
27244 \begin_layout Standard
27253 provide reverse search facility for PDF output (via pdflatex) and DVI output,
27255 In order to enable it, load the packages in the \SpecialChar LyX
27259 \begin_layout Itemize
27260 \begin_inset Flex Code
27263 \begin_layout Plain Layout
27266 usepackage{pdfsync}
27271 for reverse PDF search,
27274 \begin_layout Itemize
27275 \begin_inset Flex Code
27278 \begin_layout Plain Layout
27281 usepackage[active]{srcltx}
27286 for reverse DVI search.
27289 \begin_layout Standard
27290 If you want to be able to perform both DVI and PDF reverse searches, you
27291 can also insert in the preamble the following lines
27294 \begin_layout LyX-Code
27298 \begin_inset Newline newline
27304 \begin_inset Newline newline
27309 usepackage{pdfsync}
27310 \begin_inset Newline newline
27316 \begin_inset Newline newline
27321 usepackage[active]{srcltx}
27322 \begin_inset Newline newline
27330 \begin_layout Standard
27331 This way, you can preview the file as either DVI or PDF (pdflatex) and the
27332 right package will be used.
27335 \begin_layout Standard
27336 Note that PDFSync might affect the output layout of your document.
27337 It is therefore advised to disable PDFsync for final documents.
27340 \begin_layout Subsubsection*
27341 Built-in reverse search via Sync\SpecialChar TeX
27345 \begin_layout Standard
27347 \begin_inset Flex Code
27350 \begin_layout Plain Layout
27356 have built-in support for both PDF and DVI reverse search.
27359 Sync\SpecialChar TeX
27362 facility is basically the result of the integration of the PDFSync package
27363 to the pdftex program and its merge with the
27368 You need at least \SpecialChar TeX
27369 Live 2008 or a recent Mik\SpecialChar TeX
27370 distribution in order to use
27375 \begin_layout Plain Layout
27376 For some reason, Mik\SpecialChar TeX
27377 does not understand/obey the command \SpecialChar LyX
27379 the preamble when you check the "Enable Forward/Reverse Search" button
27380 in the toolbar and does not generate the necessary info.
27383 \begin_layout Plain Layout
27384 The generation of the required info can be forced by changing the converter
27385 "\SpecialChar LaTeX
27386 (pdflatex) -> PDF (pdflatex)" in Preferences->File handling->Converters
27387 from the default "pdflatex $$i" to "pdflatex -synctex=1 $$i" (i.e., by adding
27388 the -synctex=1 switch).
27393 Also note that only a few PDF viewers (such as Okular and Qpdfview on Unix,
27394 Skim on the Mac, SumatraPDF on Windows; see the next section for details)
27395 already provide Sync\SpecialChar TeX
27399 \begin_layout Standard
27400 To enable Sync\SpecialChar TeX
27401 for DVI output, change the
27402 \begin_inset Flex Noun
27405 \begin_layout Plain Layout
27416 \begin_inset Flex Noun
27419 \begin_layout Plain Layout
27424 (plain) -> DraftDVI
27430 \begin_inset Flex Noun
27433 \begin_layout Plain Layout
27434 Preferences\SpecialChar menuseparator
27435 File Handling\SpecialChar menuseparator
27442 \begin_inset Flex Code
27445 \begin_layout Plain Layout
27446 latex -synctex=1 $$i
27451 , and for PDF output, change the
27452 \begin_inset Flex Noun
27455 \begin_layout Plain Layout
27460 (pdflatex) -> PDF (pdflatex)
27466 \begin_inset Flex Code
27469 \begin_layout Plain Layout
27470 pdflatex -synctex=1 $$i
27476 Should your viewer not be considered in the following description, or in
27477 case of missing success, please check the documentation of your viewer
27478 whether the viewer needs to be configured for the use with Sync\SpecialChar TeX
27483 \begin_layout Plain Layout
27484 Note that the option
27485 \begin_inset Flex Code
27488 \begin_layout Plain Layout
27494 option enables gzip compression.
27495 If your viewer does not support it, you should instead use
27496 \begin_inset Flex Code
27499 \begin_layout Plain Layout
27513 \begin_layout Subsection
27514 Configuring and using specific viewers
27515 \begin_inset CommandInset label
27517 name "subsec:configuring-viewers"
27524 \begin_layout Subsubsection*
27525 Xdvi (all platforms)
27528 \begin_layout Standard
27530 \begin_inset Flex Code
27533 \begin_layout Plain Layout
27539 , you don't need to do anything else for performing a reverse DVI search,
27540 as \SpecialChar LyX
27541 already provides the necessary hooks for automatically using the
27542 \begin_inset Flex Code
27545 \begin_layout Plain Layout
27552 Just setup your document as described above (reverse search is triggered
27553 by Ctrl-click or Alt-click on Mac OSX, respectively).
27556 \begin_layout Standard
27557 However, if for whatever reason you want to use the named pipe instead of
27558 the socket for communicating with \SpecialChar LyX
27559 , simply change the DVI viewer in
27560 \begin_inset Flex Noun
27563 \begin_layout Plain Layout
27564 Preferences\SpecialChar menuseparator
27565 File Handling\SpecialChar menuseparator
27575 \begin_layout Plain Layout
27576 On Mac OSX you have to use
27577 \begin_inset Flex Code
27580 \begin_layout Plain Layout
27581 DISPLAY=:0.0 xdvi -editor "lyxeditor.sh %f %l"
27592 \begin_inset Flex Code
27595 \begin_layout Plain Layout
27596 xdvi -editor "lyxeditor.sh %f %l"
27602 \begin_inset Flex Code
27605 \begin_layout Plain Layout
27611 is a suitable script.
27612 For example, a minimal shell script is the following one:
27615 \begin_layout LyX-Code
27617 \begin_inset Newline newline
27620 LYXPIPE="/path/to/lyxpipe"
27621 \begin_inset Newline newline
27624 COMMAND="LYXCMD:revdvi:server-goto-file-row:$1 $2"
27625 \begin_inset Newline newline
27628 echo "$COMMAND" > "${LYXPIPE}".in || exit
27629 \begin_inset Newline newline
27632 read TMP < "${LYXPIPE}".out || exit
27635 \begin_layout Standard
27637 \begin_inset Flex Code
27640 \begin_layout Plain Layout
27646 is the LyXServer pipe path specified in
27647 \begin_inset Flex Noun
27650 \begin_layout Plain Layout
27651 Preferences\SpecialChar menuseparator
27661 \begin_layout Plain Layout
27663 \begin_inset Flex Code
27666 \begin_layout Plain Layout
27672 folder of a source distribution you can find a
27673 \begin_inset Flex Code
27676 \begin_layout Plain Layout
27682 script which is able to locate the
27686 based on your preferences.
27694 \begin_layout Subsubsection*
27698 \begin_layout Standard
27700 \begin_inset Flex Code
27703 \begin_layout Plain Layout
27704 /Applications/MacDviX_Folder/calleditor.script
27709 , add the following lines:
27712 \begin_layout LyX-Code
27713 /Applications/LyX.app/Contents/MacOS/lyxeditor "$2" $1
27714 \begin_inset Newline newline
27720 \begin_layout Standard
27721 Modify the lines accordingly if you install \SpecialChar LyX
27722 somewhere else than in the
27723 Applications folder.
27726 \begin_layout Standard
27727 Reverse search is triggered by Alt-click (OPTION-click).
27730 \begin_layout Subsubsection*
27734 \begin_layout Standard
27736 \begin_inset Flex Code
27739 \begin_layout Plain Layout
27740 open -a Skim.app $$i
27745 to the viewer setting in
27746 \begin_inset Flex Noun
27749 \begin_layout Plain Layout
27750 Preferences\SpecialChar menuseparator
27751 File Handling\SpecialChar menuseparator
27752 File formats\SpecialChar menuseparator
27759 \begin_inset Flex Noun
27762 \begin_layout Plain Layout
27763 Skim\SpecialChar menuseparator
27764 Preferences\SpecialChar menuseparator
27771 \begin_inset Flex Noun
27774 \begin_layout Plain Layout
27780 preset and enter command
27781 \begin_inset Flex Noun
27784 \begin_layout Plain Layout
27785 /Applications/\SpecialChar LyX
27786 .app/Contents/MacOS/lyxeditor
27794 \begin_layout Standard
27795 Reverse search is triggered by COMMAND-SHIFT-click
27798 \begin_layout Subsubsection*
27802 \begin_layout Standard
27803 Reverse search with evince does not work out of the box, but it can be achieved
27804 by means of some third party helper scripts.
27806 \begin_inset CommandInset href
27808 target "https://wiki.lyx.org/LyX/SyncTeX"
27816 \begin_layout Subsubsection*
27820 \begin_layout Standard
27822 \begin_inset Flex Noun
27825 \begin_layout Plain Layout
27826 Settings\SpecialChar menuseparator
27827 Configure Okular\SpecialChar menuseparator
27834 \begin_inset Quotes erd
27838 This inserts the appropriate command (
27839 \begin_inset Flex Code
27842 \begin_layout Plain Layout
27851 \begin_layout Standard
27852 Reverse search is triggered by SHIFT-click.
27854 \change_inserted -712698321 1578211026
27855 Note that this only works if Okular is in
27856 \begin_inset Quotes eld
27860 \begin_inset Quotes erd
27864 \begin_inset space \thinspace{}
27867 e., the hand symbol is clicked).
27872 \begin_layout Subsubsection*
27876 \begin_layout Standard
27877 Qpdfview supports Sync\SpecialChar TeX
27878 since version 0.3.5.
27880 \begin_inset Flex Noun
27883 \begin_layout Plain Layout
27884 Edit\SpecialChar menuseparator
27885 Settings\SpecialChar menuseparator
27891 , click on the input field of the
27892 \begin_inset Quotes eld
27896 \begin_inset Quotes erd
27899 item and add the command
27900 \begin_inset Flex Code
27903 \begin_layout Plain Layout
27912 \begin_layout Standard
27913 Reverse search is triggered by double-click or, in more recent versions,
27917 \begin_layout Subsubsection*
27921 \begin_layout Standard
27922 Launch yap, choose its
27923 \begin_inset Flex Noun
27926 \begin_layout Plain Layout
27927 View\SpecialChar menuseparator
27933 menu and select the
27934 \begin_inset Quotes eld
27938 \begin_inset Quotes erd
27943 \begin_inset Quotes eld
27946 New\SpecialChar ldots
27948 \begin_inset Quotes erd
27951 button and, in the window that opens, enter
27952 \begin_inset Quotes eld
27957 \begin_inset Quotes erd
27960 (or any other name you like) in the
27961 \begin_inset Quotes eld
27965 \begin_inset Quotes erd
27969 Now click on the button labeled
27970 \begin_inset Quotes eld
27975 \begin_inset Quotes erd
27978 to open a file dialog and navigate to the directory containing the batch
27980 \begin_inset Flex Code
27983 \begin_layout Plain Layout
27991 \begin_inset Flex Code
27994 \begin_layout Plain Layout
28000 and then specify the program arguments as
28001 \begin_inset Flex Code
28004 \begin_layout Plain Layout
28012 \begin_inset Flex Code
28015 \begin_layout Plain Layout
28021 wrapper is used for communicating with \SpecialChar LyX
28029 \begin_layout LyX-Code
28031 \begin_inset Newline newline
28034 echo LYXCMD:revdvi:server-goto-file-row:%~1 %2>
28043 \begin_inset Newline newline
28057 \begin_layout Standard
28058 Make sure that the \SpecialChar LyX
28059 Server pipe path you specified in \SpecialChar LyX
28061 \begin_inset Flex Code
28064 \begin_layout Plain Layout
28078 , otherwise change the
28079 \begin_inset Flex Code
28082 \begin_layout Plain Layout
28088 wrapper accordingly.
28091 \begin_layout Standard
28092 In yap, reverse search is triggered by double-click.
28095 \begin_layout Subsubsection*
28096 SumatraPDF (Windows)
28099 \begin_layout Standard
28100 In order to use SumatraPDF for inverse search, enter
28101 \begin_inset Flex Code
28104 \begin_layout Plain Layout
28105 SumatraPDF -inverse-search "lyxeditor.bat "%f" %l"
28110 in the viewer setting in
28111 \begin_inset Flex Noun
28114 \begin_layout Plain Layout
28115 Preferences\SpecialChar menuseparator
28116 File Handling\SpecialChar menuseparator
28117 File formats\SpecialChar menuseparator
28124 \begin_inset Flex Code
28127 \begin_layout Plain Layout
28133 is the previous wrapper.
28134 If SumatraPDF.exe is not in your command PATH, use its full file name.
28137 \begin_layout Standard
28138 Reverse search is triggered by double-click.
28141 \begin_layout Subsubsection*
28145 \begin_layout Standard
28146 First of all, make sure that yap is your default DVI viewer in the Windows
28147 environment, then launch it, choose its
28148 \begin_inset Flex Noun
28151 \begin_layout Plain Layout
28152 View\SpecialChar menuseparator
28158 menu and select the
28159 \begin_inset Quotes eld
28163 \begin_inset Quotes erd
28168 \begin_inset Quotes eld
28171 New\SpecialChar ldots
28173 \begin_inset Quotes erd
28176 button and, in the window that opens, enter
28177 \begin_inset Quotes eld
28182 \begin_inset Quotes erd
28185 (or any other name you like) in the
28186 \begin_inset Quotes eld
28190 \begin_inset Quotes erd
28194 Now click on the button labeled
28195 \begin_inset Quotes eld
28200 \begin_inset Quotes erd
28203 to open a file dialog and navigate to the directory containing the
28204 \begin_inset Flex Code
28207 \begin_layout Plain Layout
28213 program (which is installed by default on Cygwin along with the \SpecialChar LyX
28216 \begin_inset Flex Code
28219 \begin_layout Plain Layout
28225 and then specify the program arguments as
28226 \begin_inset Flex Code
28229 \begin_layout Plain Layout
28236 In this way, you will be using the
28240 for communicating with \SpecialChar LyX
28242 If, for whatever reason, you want to use the
28247 \begin_inset Flex Code
28250 \begin_layout Plain Layout
28256 option and be sure to specify the \SpecialChar LyX
28257 Server pipe path in the \SpecialChar LyX
28261 \begin_layout Standard
28262 In yap, reverse search is triggered by double-click.
28265 \begin_layout Subsubsection*
28266 SumatraPDF (Cygwin)
28269 \begin_layout Standard
28270 In order to use SumatraPDF for inverse search, enter
28271 \begin_inset Flex Code
28274 \begin_layout Plain Layout
28275 SumatraPDF -inverse-search "lyxeditor -g %f %l"
28280 in the viewer setting in
28281 \begin_inset Flex Noun
28284 \begin_layout Plain Layout
28285 Preferences\SpecialChar menuseparator
28286 File Handling\SpecialChar menuseparator
28287 File formats\SpecialChar menuseparator
28294 If SumatraPDF.exe is not in your command PATH, use its full posix path.
28296 \begin_inset Flex Code
28299 \begin_layout Plain Layout
28305 enables communication via the
28311 \begin_inset Flex Code
28314 \begin_layout Plain Layout
28320 option if you want to use the
28324 , and be sure to specify the \SpecialChar LyX
28325 Server pipe path in the \SpecialChar LyX
28329 \begin_layout Standard
28330 Reverse search is triggered by double-click.
28333 \begin_layout Section
28337 \begin_layout Standard
28338 Forward search is, as the name implies, in a sense the
28339 \begin_inset Quotes eld
28343 \begin_inset Quotes erd
28347 It allows you to let the viewer jump to a given position from within \SpecialChar LyX
28349 If forward search is set up (as described in what follows), you can put
28350 the cursor anywhere in your \SpecialChar LyX
28352 \begin_inset Flex Noun
28355 \begin_layout Plain Layout
28356 Navigate\SpecialChar menuseparator
28363 \begin_inset Flex Noun
28366 \begin_layout Plain Layout
28372 in the context menu via right mouse click), and then the viewer will jump
28373 to that position as well.
28374 This implies, of course, that your viewer supports this function.
28377 \begin_layout Standard
28378 To make forward search possible, you first need to provide the generated
28379 output PDF/DVI file with additional information about the \SpecialChar TeX
28381 This can be done via the methods described in the section
28382 \begin_inset CommandInset ref
28384 reference "subsec:rev-search"
28391 \begin_layout Standard
28392 Additionally, you need to configure \SpecialChar LyX
28393 for using your viewers in
28394 \begin_inset Flex Noun
28397 \begin_layout Plain Layout
28398 Tools\SpecialChar menuseparator
28399 Preferences\SpecialChar menuseparator
28400 Output\SpecialChar menuseparator
28407 We provide a range of tested configurations for some viewers, which you
28408 can select from the drop down list.
28409 If none of these configurations suits you, you have to find out and enter
28410 a suitable configuration yourself.
28411 The definition syntax uses the following placeholders:
28414 \begin_layout Itemize
28416 \begin_inset Flex Code
28419 \begin_layout Plain Layout
28428 \begin_layout Itemize
28430 \begin_inset Flex Code
28433 \begin_layout Plain Layout
28439 : name of the (temporary) exported .tex file (without path)
28442 \begin_layout Itemize
28444 \begin_inset Flex Code
28447 \begin_layout Plain Layout
28453 : name of the (temporary) exported .tex file (including path)
28456 \begin_layout Itemize
28458 \begin_inset Flex Code
28461 \begin_layout Plain Layout
28467 : name of the exported output file (either dvi or pdf, depending on which
28468 one exists in the temporary directory)
28471 \begin_layout Standard
28472 Note that only some of the viewers provide full and usable forward search
28473 functionality out of the box, among them yap, xdvi, okular
28477 \begin_layout Plain Layout
28478 You might want to set
28479 \begin_inset Flex Code
28482 \begin_layout Plain Layout
28489 \begin_inset Flex Noun
28492 \begin_layout Plain Layout
28493 Tools\SpecialChar menuseparator
28494 Preferences\SpecialChar menuseparator
28495 File Handling\SpecialChar menuseparator
28497 \begin_inset space ~
28510 , qpdfview, and SumatraPDF
28514 \begin_layout Plain Layout
28515 SumatraPDF can also use DDE commands through the external program CMCDDE
28516 — downloadable from
28517 \begin_inset CommandInset href
28519 target "http://www.istri.fr/spip/zip/CMCDDE.zip"
28530 Others, such as evince
28534 \begin_layout Plain Layout
28535 Forward search with evince can be achieved by means of third party helper
28538 \begin_inset CommandInset href
28540 target "https://wiki.lyx.org/LyX/SyncTeX"
28550 , require some extra tools in order to use forward search.
28551 While many of the widespread PDF viewers (most notably Adobe Reader) do
28552 not support forward search at all, some other viewers – e.
28553 \begin_inset space \thinspace{}
28557 xpdf – allow at least to reload the document and jump to a specific page
28558 of the file, so you can at least navigate
28559 \begin_inset Quotes eld
28563 \begin_inset Quotes erd
28567 This latter functionality is provided by an external call of synctex (see
28568 the predefined example configurations).
28572 \begin_layout Standard
28573 Forward search works both with DVI and PDF output.
28575 simply checks which preview format you have used before (i.
28576 \begin_inset space \thinspace{}
28579 e., which format is already there in the temporary directory) and chooses
28580 the appropriate configuration for the respective format.
28581 \change_deleted 564990737 1672743015
28585 \begin_layout Standard
28587 \change_deleted 564990737 1672743015
28588 Special Document Classes
28591 \begin_layout Standard
28593 \change_deleted 564990737 1669742044
28597 \begin_layout Standard
28599 \change_deleted 564990737 1669742044
28605 \begin_layout Standard
28607 \change_deleted 564990737 1669742044
28611 \begin_layout Standard
28613 \change_deleted 564990737 1669742044
28614 This section describes how \SpecialChar LyX
28615 can be used to write articles for submission
28616 to the scientific journal
28618 Astronomy and Astrophysics
28621 \begin_inset Flex URL
28624 \begin_layout Plain Layout
28626 https://www.aanda.org/
28631 ) using Version 5.01 of the document class
28636 This package can be downloaded from the ftp site
28639 \begin_layout Standard
28641 \change_deleted 564990737 1669742044
28642 \begin_inset VSpace medskip
28648 \begin_layout Standard
28651 \change_deleted 564990737 1669742044
28652 \begin_inset Flex URL
28655 \begin_layout Plain Layout
28657 ftp://ftp.edpsciences.org/pub/aa/readme.html
28665 \begin_layout Standard
28667 \change_deleted 564990737 1669742044
28668 \begin_inset VSpace medskip
28674 \begin_layout Standard
28676 \change_deleted 564990737 1669742044
28677 A manual comes together with that package, and this text is not meant to
28678 replace the original manual but is merely a short guide in how to realize
28679 the correct form of your paper.
28683 \begin_layout Standard
28685 \change_deleted 564990737 1669742044
28686 Please note that the publisher of the journal was changed from Springer
28687 to EDP Sciences starting January 1, 2001.
28688 That change involved also some slight changes to the style files, namely
28689 the removal of the thesaurus command.
28690 The \SpecialChar LyX
28691 class aa supports the newest version of these style files, V 5.01.
28692 If you have an older version installed, please upgrade.
28693 For compatibility, the old (version 4) layout has been kept as
28698 Please refer to the comments in
28701 Dir/layouts/aapaper.layout
28706 \begin_layout Standard
28708 \change_deleted 564990737 1669742044
28712 \begin_layout Standard
28714 \change_deleted 564990737 1669742044
28715 It is recommended you start from the example template distributed with \SpecialChar LyX
28717 If you are not using a template, note the following settings:
28720 \begin_layout Itemize
28722 \change_deleted 564990737 1669742044
28729 Document\SpecialChar menuseparator
28732 dialog (OK, that one was obvious).
28735 \begin_layout Itemize
28737 \change_deleted 564990737 1669742044
28738 Don't change the option
28741 \begin_inset space ~
28751 The whole layout is done by the macros, you shouldn't change anything.
28754 \begin_layout Standard
28756 \change_deleted 564990737 1669742044
28760 \begin_layout Standard
28762 \change_deleted 564990737 1669742044
28763 First thing to enter is the header information.
28764 It consists of seven entries, of which some are optional.
28768 \begin_layout Itemize
28770 \change_deleted 564990737 1669742044
28778 \begin_layout Itemize
28780 \change_deleted 564990737 1669742044
28788 \begin_layout Itemize
28790 \change_deleted 564990737 1669742044
28798 \begin_layout Itemize
28800 \change_deleted 564990737 1669742044
28808 \begin_layout Itemize
28810 \change_deleted 564990737 1669742044
28815 : [optional] if more than one author: whom to contact for offprint requests.
28818 \begin_layout Itemize
28820 \change_deleted 564990737 1669742044
28825 : [optional] mail address for contacts.
28828 \begin_layout Itemize
28830 \change_deleted 564990737 1669742044
28836 Suggested format is
28838 Received: <date>; Accepted <date>
28841 \begin_layout Standard
28843 \change_deleted 564990737 1669742044
28844 There is no need to issue the
28850 command, this is done automatically by \SpecialChar LyX
28851 when the header is finished.
28852 Although the order of the single header entries doesn't matter it is advised
28853 to keep the above sequence, just to get the best optics and meets the layout
28854 of the real document.
28857 \begin_layout Standard
28859 \change_deleted 564990737 1669742044
28860 If you want to place footnotes in the header block, e.
28861 \begin_inset space \thinspace{}
28865 \begin_inset space \space{}
28868 to state your present address, just use the standard footnote via the menu
28871 Insert\SpecialChar menuseparator
28876 will automagically use the term
28885 \begin_layout Standard
28887 \change_deleted 564990737 1669742044
28890 Edit\SpecialChar menuseparator
28893 , you'll find two insets which are relevant for the titling:
28896 \begin_layout Itemize
28898 \change_deleted 564990737 1669742044
28905 to mark corresponding author\SpecialChar breakableslash
28907 The institutes are numbered sequentially as they appear in the
28911 field, so you have to put a marker to each author.
28914 \begin_layout Itemize
28916 \change_deleted 564990737 1669742044
28921 to supply an email address for fast contact.
28924 \begin_layout Standard
28926 \change_deleted 564990737 1669742044
28927 In addition to these topics, the macros use one additional \SpecialChar LaTeX
28929 has no counterpart in \SpecialChar LyX
28933 \begin_layout Itemize
28935 \change_deleted 564990737 1669742044
28942 to separate different names for more than one author and institute, respectivel
28946 \begin_layout Standard
28948 \change_deleted 564990737 1669742044
28949 The appropriate command has to be entered in \SpecialChar LyX
28950 and marked as \SpecialChar LaTeX
28956 \begin_layout Standard
28958 \change_deleted 564990737 1669742044
28962 \begin_layout Standard
28964 \change_deleted 564990737 1669742044
28965 The abstract should immediately follow the header block.
28966 With version 5 the abstract environment was changed to a command, and there
28967 is now a restriction to only one paragraph.
28968 In addition, it should contain an entry with the keywords.
28969 This is done via the paragraph style
28974 Refer to the example paper.
28977 \begin_layout Standard
28979 \change_deleted 564990737 1669742044
28980 Supported environments
28983 \begin_layout Standard
28985 \change_deleted 564990737 1669742044
28986 The A&A paper layout supports the following environments for structuring
28990 \begin_layout Itemize
28992 \change_deleted 564990737 1669742044
28998 \begin_layout Itemize
29000 \change_deleted 564990737 1669742044
29006 \begin_layout Itemize
29008 \change_deleted 564990737 1669742044
29014 \begin_layout Itemize
29016 \change_deleted 564990737 1669742044
29022 \begin_layout Itemize
29024 \change_deleted 564990737 1669742044
29030 \begin_layout Itemize
29032 \change_deleted 564990737 1669742044
29038 \begin_layout Itemize
29040 \change_deleted 564990737 1669742044
29046 \begin_layout Itemize
29048 \change_deleted 564990737 1669742044
29054 \begin_layout Itemize
29056 \change_deleted 564990737 1669742044
29062 \begin_layout Itemize
29064 \change_deleted 564990737 1669742044
29070 \begin_layout Itemize
29072 \change_deleted 564990737 1669742044
29078 \begin_layout Itemize
29080 \change_deleted 564990737 1669742044
29087 \begin_layout Standard
29089 \change_deleted 564990737 1669742044
29090 Commands not supported by \SpecialChar LyX
29094 \begin_layout Standard
29096 \change_deleted 564990737 1669742044
29097 Some commands are not yet supported by the
29101 layout for \SpecialChar LyX
29103 Some have already been mentioned.
29104 For the sake of completeness, they are listed all together here:
29107 \begin_layout Itemize
29109 \change_deleted 564990737 1669742044
29117 \begin_layout Itemize
29119 \change_deleted 564990737 1669742044
29127 \begin_layout Itemize
29129 \change_deleted 564990737 1669742044
29137 \begin_layout Itemize
29139 \change_deleted 564990737 1669742044
29147 \begin_layout Standard
29149 \change_deleted 564990737 1669742044
29150 If you want to use any of these commands, you have to enter them yourself.
29153 Do not forget to mark them as \SpecialChar LaTeX
29157 \begin_layout Standard
29159 \change_deleted 564990737 1669742044
29160 Figure and Table Floats
29163 \begin_layout Standard
29165 \change_deleted 564990737 1669742044
29167 provides support for the necessary float environments
29169 figure, figure*, table
29175 , therefore we won't tell much about it here.
29179 \begin_inset space ~
29185 Just remember that tables should be left-aligned.
29186 For that, select the table and change the alignment in
29188 Edit\SpecialChar menuseparator
29190 \begin_inset space ~
29196 \begin_layout Standard
29198 \change_deleted 564990737 1669742044
29199 There is only one special thing: the figures with caption besides the figure.
29200 To create such a figure, you have to do the following:
29203 \begin_layout Enumerate
29205 \change_deleted 564990737 1669742044
29206 Create a wide figure float:
29208 Insert\SpecialChar menuseparator
29209 Float\SpecialChar menuseparator
29212 , then right click in the figure and select
29215 \begin_inset space ~
29223 \begin_layout Enumerate
29225 \change_deleted 564990737 1669742044
29226 Enter your caption text.
29229 \begin_layout Enumerate
29231 \change_deleted 564990737 1669742044
29236 to move the cursor above the caption.
29239 \begin_layout Enumerate
29241 \change_deleted 564990737 1669742044
29245 \begin_layout Enumerate
29247 \change_deleted 564990737 1669742044
29248 Position the cursor behind the figure and insert a horizontal fill:
29250 Insert\SpecialChar menuseparator
29252 \begin_inset space ~
29255 Character\SpecialChar menuseparator
29257 \begin_inset space ~
29265 \begin_layout Enumerate
29267 \change_deleted 564990737 1669742044
29268 Switch to \SpecialChar LaTeX
29272 \begin_inset space ~
29280 \begin_layout Enumerate
29282 \change_deleted 564990737 1669742044
29292 Do not close the brace!
29295 \begin_layout Enumerate
29297 \change_deleted 564990737 1669742044
29298 Position the cursor behind the caption text, switch to \SpecialChar LaTeX
29303 \begin_inset space ~
29315 \begin_layout Standard
29317 \change_deleted 564990737 1669742044
29318 Also, refer to the figures in the example paper.
29321 \begin_layout Standard
29323 \change_deleted 564990737 1669742044
29327 \begin_layout Standard
29329 \change_deleted 564990737 1669742044
29330 For submission, the paper has to be formated in a special double-spacing
29332 For this purpose, you have to give the option
29336 to the document class.
29337 This must be done using the custom class options field in the
29339 Document\SpecialChar menuseparator
29343 Just enter the string
29350 \begin_layout Standard
29352 \change_deleted 564990737 1669742044
29356 \begin_layout Standard
29358 \change_deleted 564990737 1669742044
29363 directory contains an example paper written with \SpecialChar LyX
29365 It is the example paper from the original macro package, translated to
29368 Use it for inspiration, and compare the original \SpecialChar LaTeX
29369 code with \SpecialChar LyX
29373 \begin_layout Standard
29375 \change_deleted 564990737 1671097429
29379 \begin_layout Standard
29381 \change_deleted 564990737 1671097429
29386 can be used to type letters according to German conventions.
29387 A template file is included in
29389 .../lyx/share/templates
29391 for you to use as a starting point.
29394 \begin_layout Standard
29396 \change_deleted 564990737 1671097429
29400 \begin_layout Standard
29402 \change_deleted 564990737 1671097429
29403 See the \SpecialChar LyX
29409 It contains all infos you need.
29412 \begin_layout Standard
29414 \change_deleted 564990737 1669755802
29418 \begin_layout Standard
29420 \change_deleted 564990737 1669755802
29423 Panayotis Papasotiriou
29426 \begin_layout Standard
29428 \change_deleted 564990737 1669755802
29432 \begin_layout Standard
29434 \change_deleted 564990737 1669755802
29435 The ijmpc package is a set of macros that facilitates electronic manuscript
29438 International Journal of Modern Physics C
29441 Similarly, the ijmpd package is for creating manuscripts to be submitted
29444 International Journal of Modern Physics D
29447 Both journals are published by World Scientific.
29448 The corresponding document classes are named
29457 These files, together with instructions for the authors, can be downloaded
29459 \begin_inset Flex URL
29462 \begin_layout Plain Layout
29464 http://www.worldscinet.com/ijmpc/mkt/guidelines.shtml
29470 \begin_inset Flex URL
29473 \begin_layout Plain Layout
29475 http://www.worldscinet.com/ijmpd/mkt/guidelines.shtml
29481 Both packages are modified versions of the standard
29482 \begin_inset Quotes eld
29486 \begin_inset Quotes erd
29489 package, and they are almost (but not exactly) identical.
29490 Most of their features are supported by \SpecialChar LyX
29492 I have used \SpecialChar LyX
29493 successfully to write articles submitted to both journals
29494 without any problem.
29497 \begin_layout Standard
29499 \change_deleted 564990737 1669755802
29503 \begin_layout Standard
29505 \change_deleted 564990737 1669755802
29506 As usual, the easiest way to write a paper is to start with a template.
29509 File\SpecialChar menuseparator
29525 This will give an (almost) empty document that includes the most common
29526 fields found in a manuscript.
29527 Simply overwrite the existing text (including the brackets,
29532 You should keep in mind the following remarks.
29535 \begin_layout Enumerate
29537 \change_deleted 564990737 1669755802
29539 won't let you change the font size and the page style of the document,
29540 because such modifications are not allowed by both packages.
29543 \begin_layout Enumerate
29545 \change_deleted 564990737 1669755802
29546 The language of the document should not be changed.
29547 Before previewing your paper, be sure that the babel package is not used.
29548 To do this, click on
29551 arg "dialog-show document"
29556 \SpecialChar menuseparator
29560 \begin_inset Quotes eld
29564 \begin_inset Quotes erd
29574 \begin_layout Enumerate
29576 \change_deleted 564990737 1669755802
29578 \begin_inset Quotes eld
29582 \begin_inset Quotes erd
29585 style must be used to define keywords.
29588 \begin_layout Enumerate
29590 \change_deleted 564990737 1669755802
29591 The ijmpc package provides a style named
29592 \begin_inset Quotes eld
29595 Classification Codes
29596 \begin_inset Quotes erd
29599 , which can be used to define classification codes, such as PACS numbers.
29600 Note that this facility is not supported by the ijmpd package.
29603 \begin_layout Enumerate
29605 \change_deleted 564990737 1669755802
29606 Several new environments are available:
29607 \begin_inset Quotes eld
29611 \begin_inset Quotes erd
29615 \begin_inset Quotes eld
29619 \begin_inset Quotes erd
29623 \begin_inset Quotes eld
29627 \begin_inset Quotes erd
29631 \begin_inset Quotes eld
29635 \begin_inset Quotes erd
29639 \begin_inset Quotes eld
29643 \begin_inset Quotes erd
29647 \begin_inset Quotes eld
29651 \begin_inset Quotes erd
29655 \begin_inset Quotes eld
29659 \begin_inset Quotes erd
29663 \begin_inset Quotes eld
29667 \begin_inset Quotes erd
29671 \begin_inset Quotes eld
29675 \begin_inset Quotes erd
29679 \begin_inset Quotes eld
29683 \begin_inset Quotes erd
29687 \begin_inset Quotes eld
29691 \begin_inset Quotes erd
29695 \begin_inset Quotes eld
29699 \begin_inset Quotes erd
29703 \begin_inset Quotes eld
29707 \begin_inset Quotes erd
29711 \begin_inset Quotes eld
29715 \begin_inset Quotes erd
29719 Their use is more or less obvious.
29721 supports all these environments; it will use the proper label, text style,
29722 and numbering scheme for each of them.
29725 \begin_layout Enumerate
29727 \change_deleted 564990737 1669755802
29728 Both packages use basic citations; the natbib package should not be used.
29729 In \SpecialChar LyX
29730 , citation references are shown as usual; in the output, citations are
29731 shown as superscripts.
29732 If you want to use a citation as normal text, you should use the
29737 \begin_inset space \thinspace{}
29741 \begin_inset space \space{}
29745 \begin_inset Quotes eld
29749 \begin_inset space \space{}
29759 \begin_inset Quotes erd
29765 \begin_layout Enumerate
29767 \change_deleted 564990737 1669755802
29769 \begin_inset Quotes eld
29773 \begin_inset Quotes erd
29776 section in both packages.
29777 To put acknowledgments, just use the
29778 \begin_inset Quotes eld
29782 \begin_inset Quotes erd
29788 \begin_layout Enumerate
29790 \change_deleted 564990737 1669755802
29791 Appendices may be added to the paper,
29795 the Acknowledgments and
29801 provides a special environment, called
29802 \begin_inset Quotes eld
29806 \begin_inset Quotes erd
29809 which marks the beginning of the appendices.
29810 This environment should be left blank; it just sends a \SpecialChar LaTeX
29811 command, but nothing
29813 In \SpecialChar LyX
29815 \begin_inset Quotes eld
29819 \begin_inset Quotes erd
29822 is printed with blue letters, as a signal that all sections after that
29823 point are appendices.
29824 To write an appendix, use the
29825 \begin_inset Quotes eld
29829 \begin_inset Quotes erd
29834 will number each appendix with capital letters, as required by both journals.
29836 \begin_inset Quotes eld
29840 \begin_inset Quotes erd
29847 be present before the first appendix; if not, all appendices will be numbered
29848 as normal sections in the output.
29851 \begin_layout Enumerate
29853 \change_deleted 564990737 1669755802
29854 The ijmpc and the ijmpd packages use the
29858 command to implement table captions.
29859 As a result, a table created by \SpecialChar LyX
29860 is printed correctly, but its caption
29862 However, you can use some \SpecialChar TeX
29863 code to overcome this problem, so that captions
29864 are printed as expected.
29865 To do so, create a float table as usual, remove the caption, and replace
29866 it with the \SpecialChar TeX
29877 (sic); you must also the \SpecialChar TeX
29882 immediately after the tabular material.
29883 Study the example table included in the template files to see how this
29884 trick is implemented.
29885 Alternatively, If you need table captions, you should implement the whole
29890 file, then include this file to the \SpecialChar LyX
29893 Insert\SpecialChar menuseparator
29894 File\SpecialChar menuseparator
29896 \begin_inset space ~
29902 Details on how to create a table float can be found in the files
29910 , included in the corresponding packages.
29913 \begin_layout Standard
29915 \change_deleted 564990737 1669755802
29916 Preparing a paper for submission
29919 \begin_layout Standard
29921 \change_deleted 564990737 1669755802
29922 Before you submit your paper you must export the \SpecialChar LyX
29923 document as a \SpecialChar LaTeX
29926 File\SpecialChar menuseparator
29927 Export\SpecialChar menuseparator
29935 \begin_layout Plain Layout
29936 Actually you have the choice between \SpecialChar LaTeX
29937 (plain) and pdflatex.
29938 If you intend to use pdflatex to prepare the paper, you should use the
29939 pdflatex option so that included graphics are converted to PDF format,
29940 ready for use by pdflatex.
29945 , then make the following changes to the resulting
29952 \begin_layout Enumerate
29954 \change_deleted 564990737 1669755802
29955 Remove the comment lines before the
29964 \begin_layout Enumerate
29966 \change_deleted 564990737 1669755802
29967 Remove everything between (and including) the
29979 commands, except for any commands you specifically put into the \SpecialChar LaTeX
29983 \begin_layout Standard
29985 \change_deleted 564990737 1672743015
29990 file should be saved and processed through \SpecialChar LaTeX
29991 as many times as necessary.
29992 You may also want to check the resulting
29999 \begin_layout Standard
30001 \change_deleted 564990737 1669801478
30005 \begin_layout Standard
30007 \change_deleted 564990737 1669801478
30013 \begin_layout Standard
30015 \change_deleted 564990737 1669801478
30019 \begin_layout Standard
30021 \change_deleted 564990737 1669801478
30022 The iopart package provides a document class to create electronic manuscript
30023 submission to the journals published by the Institute of Physics.
30024 Instructions for the authors how to create a paper using the iopart class
30025 can be downloaded together with the iopart package from the site
30026 \begin_inset Flex URL
30029 \begin_layout Plain Layout
30031 ftp://ftp.iop.org/pub/journals/latex2e
30039 \begin_layout Standard
30041 \change_deleted 564990737 1669801478
30045 \begin_layout Standard
30047 \change_deleted 564990737 1669801478
30048 The easiest way to write a paper is to start with the template
30052 that is available via
30054 File\SpecialChar menuseparator
30057 The template explains how to use the special text environments.
30058 Here are the most important advices:
30061 \begin_layout Itemize
30063 \change_deleted 564990737 1669801478
30064 To be able to compile your document to a PDF, PS, or DVI, ensure that the
30065 no AMS packages are loaded in
30067 Document\SpecialChar menuseparator
30068 Settings\SpecialChar menuseparator
30074 \begin_layout Itemize
30076 \change_deleted 564990737 1669801478
30079 The title environment defines the kind of your paper.
30080 So use one of the following environments for the title:
30084 \begin_layout Itemize
30086 \change_deleted 564990737 1669801478
30095 \begin_layout Itemize
30097 \change_deleted 564990737 1669801478
30106 \begin_layout Itemize
30108 \change_deleted 564990737 1669801478
30114 for a Topical review
30117 \begin_layout Itemize
30119 \change_deleted 564990737 1669801478
30128 \begin_layout Itemize
30130 \change_deleted 564990737 1669801478
30139 \begin_layout Itemize
30141 \change_deleted 564990737 1669801478
30147 for a Paper (same as Title)
30150 \begin_layout Itemize
30152 \change_deleted 564990737 1669801478
30158 for a Preliminary communication
30161 \begin_layout Itemize
30163 \change_deleted 564990737 1669801478
30169 for a Rapid communication
30172 \begin_layout Itemize
30174 \change_deleted 564990737 1669801478
30180 for a Letter to the editor
30184 \begin_layout Itemize
30186 \change_deleted 564990737 1669801478
30189 All title environments except of
30193 can have an optional short title.
30196 \begin_layout Itemize
30198 \change_deleted 564990737 1669801478
30199 There is a general title environment
30203 which is not directly supported by \SpecialChar LyX
30205 This can be used as \SpecialChar TeX
30206 code when your document doesn't fit into one of the
30210 \begin_layout Standard
30212 \change_deleted 564990737 1672743015
30213 For more informations like hints for special table and formula formatting,
30214 look at the IOP author guidelines.
30217 \begin_layout Standard
30219 \change_deleted 564990737 1670317155
30223 \begin_layout Standard
30225 \change_deleted 564990737 1670317155
30228 Panayotis Papasotiriou
30231 \begin_layout Standard
30233 \change_deleted 564990737 1670317155
30237 \begin_layout Standard
30239 \change_deleted 564990737 1670317155
30240 The Kluwer package is a set of macros produced by Kluwer Academic Publishers
30241 that facilitates electronic manuscript submission to the journals they
30243 Most known of them (at least in my domain of interest) are
30245 Astrophysics and Space Science
30251 , but there are many others (see a complete list at
30252 \begin_inset Flex URL
30255 \begin_layout Plain Layout
30257 http://www.wkap.nl/jrnllist.htm/JRNLHOME
30263 The Kluwer package may be downloaded from the site
30264 \begin_inset Flex URL
30267 \begin_layout Plain Layout
30269 http://www.wkap.nl/kaphtml.htm/STYLEFILES
30275 A complete user guide is contained in that package (but it can also be
30276 downloaded separately).
30279 \begin_layout Standard
30281 \change_deleted 564990737 1670317155
30283 supports many features of the package but not everything.
30284 However, the \SpecialChar TeX
30285 code needed is reduced to some
30286 \begin_inset Quotes eld
30290 \begin_inset Quotes erd
30293 commands of the package (see
30294 \begin_inset space ~
30298 \begin_inset CommandInset ref
30300 reference "subsec:kluwer_peculiarities"
30305 I have recently used \SpecialChar LyX
30306 to write an article submitted to the
30308 Astrophysics and Space Science
30310 without any problem.
30313 \begin_layout Standard
30315 \change_deleted 564990737 1670317155
30319 \begin_layout Standard
30321 \change_deleted 564990737 1670317155
30322 The easiest way to write a paper is to start with the Kluwer template file.
30325 File\SpecialChar menuseparator
30337 This will give an (almost) empty document that includes the most common
30338 fields found in a manuscript and a short description of their use.
30339 As in most templates, simply overwrite the existing text (including the
30344 ) with the correct information.
30347 \begin_layout Standard
30349 \change_deleted 564990737 1670317155
30350 Preparing a paper for submission
30353 \begin_layout Standard
30355 \change_deleted 564990737 1670317155
30356 As in the AAS\SpecialChar TeX
30357 package, before you submit your paper to a journal you must
30359 \begin_inset Quotes eld
30363 \begin_inset Quotes erd
30369 \begin_layout Enumerate
30371 \change_deleted 564990737 1670317155
30372 Export your paper as a \SpecialChar LaTeX
30374 To do this, click on
30376 File\SpecialChar menuseparator
30377 Export\SpecialChar menuseparator
30385 \begin_layout Enumerate
30387 \change_deleted 564990737 1670317155
30392 file with a text editor and make the following changes
30396 \begin_layout Enumerate
30398 \change_deleted 564990737 1670317155
30399 remove the comment lines before the
30408 \begin_layout Enumerate
30410 \change_deleted 564990737 1670317155
30411 remove everything between (and including) the
30423 commands, except for any commands you specifically put into the \SpecialChar LaTeX
30427 \begin_layout Standard
30429 \change_deleted 564990737 1670317155
30438 \begin_layout Enumerate
30440 \change_deleted 564990737 1670317155
30445 file through \SpecialChar LaTeX
30446 as many times as necessary (usually up to three).
30449 \begin_layout Enumerate
30451 \change_deleted 564990737 1670317155
30457 \begin_inset space \thinspace{}
30461 \begin_inset space \space{}
30468 , and check if everything is OK (it should, if you didn't make any mistake).
30471 \begin_layout Standard
30473 \change_deleted 564990737 1670317155
30474 \begin_inset Quotes eld
30478 \begin_inset Quotes erd
30481 of the Kluwer package
30482 \begin_inset CommandInset label
30484 name "subsec:kluwer_peculiarities"
30491 \begin_layout Standard
30493 \change_deleted 564990737 1670317155
30494 The Kluwer package has the following
30495 \begin_inset Quotes eld
30499 \begin_inset Quotes erd
30505 \begin_layout Enumerate
30507 \change_deleted 564990737 1670317155
30508 It is possible to write multiple articles in the same \SpecialChar LaTeX
30513 \begin_layout Plain Layout
30514 I can't imagine any good reason to do this.
30520 Each article must be included in the environment
30521 \begin_inset Quotes eld
30525 \begin_inset Quotes erd
30529 Unfortunately, this environment cannot be omitted, even if you write just
30531 Therefore, each article starts with the command
30537 and, obviously, ends with the command
30544 Although this can be implemented in \SpecialChar LyX
30545 , I didn't included it, since it looks
30546 ugly and can confuse the novice user.
30547 Therefore, you need to enter them directly and mark them as \SpecialChar LaTeX
30550 \begin_inset Quotes eld
30555 \begin_inset Quotes erd
30561 \begin_layout Enumerate
30563 \change_deleted 564990737 1670317155
30564 Information given at the beginning of the article (i.
30565 \begin_inset space \thinspace{}
30569 \begin_inset space \space{}
30572 title, subtitle, author, institution, running title, running author, abstract
30573 and keywords) must be included in an environment called
30574 \begin_inset Quotes eld
30578 \begin_inset Quotes erd
30582 This is not implemented in \SpecialChar LyX
30583 , so you must enter title, subtitle etc.
30584 \begin_inset space ~
30587 between two \SpecialChar TeX
30603 \begin_layout Enumerate
30605 \change_deleted 564990737 1670317155
30606 According to the user manual, the label of each bibliography item must be
30630 \begin_layout Standard
30632 \change_deleted 564990737 1670317155
30637 template takes care of all these
30638 \begin_inset Quotes eld
30642 \begin_inset Quotes erd
30646 If you start a new paper using this template you don't need to do anything
30651 \begin_layout Enumerate
30653 \change_deleted 564990737 1670317155
30654 don't delete the \SpecialChar TeX
30655 code included in the template, and
30658 \begin_layout Enumerate
30660 \change_deleted 564990737 1670317155
30661 copy the example bibliography item included in the template and modify it
30662 as necessary to enter new bibliography items.
30665 \begin_layout Standard
30667 \change_deleted 564990737 1671097446
30671 \begin_layout Standard
30673 \change_deleted 564990737 1671097446
30678 provides an alternative to the standard
30683 It provides similar functionality, but you might prefer this layout with
30684 sans serif sections, headings, and more.
30687 \begin_layout Standard
30689 \change_deleted 564990737 1671097446
30690 Springer Journals (
30697 \begin_layout Standard
30699 \change_deleted 564990737 1671097446
30705 \begin_layout Standard
30707 \change_deleted 564990737 1671097446
30711 \begin_layout Standard
30713 \change_deleted 564990737 1671097446
30714 These are the layout files for some of the journal formats used by Springer
30715 Verlag and listed on
30716 \begin_inset Flex URL
30719 \begin_layout Plain Layout
30721 http://www.springer.de/author/tex/help-journals.html
30726 , where you should also go to fetch the class files (yes, these are \SpecialChar LaTeX2e
30728 It is a modular system: the things common to all journals are implemented
30733 , which journal-specific layout files (such as, e.
30734 \begin_inset space \thinspace{}
30738 \begin_inset space \space{}
30745 for Journal of Geodesy) can include.
30748 \begin_layout Standard
30750 \change_deleted 564990737 1671097446
30751 This means that implementing support for any other Springer journal on this
30752 list is as simple as writing your own
30760 file following the outline given in
30768 \begin_layout Standard
30770 \change_deleted 564990737 1671097446
30771 It is reasonably well tested only for the Journal of Geodesy.
30780 come with the standard \SpecialChar LyX
30782 Install the relevant class file (downloaded from Springer) in a proper
30783 directory, reconfigure \SpecialChar LaTeX
30784 (in the te\SpecialChar TeX
30789 , as root if necessary — doesn't \SpecialChar LyX
30790 take care of this?), reconfigure \SpecialChar LyX
30795 \begin_layout Standard
30797 \change_deleted 564990737 1671097446
30801 \begin_layout Standard
30803 \change_deleted 564990737 1671097446
30804 A large number of theorem-like styles —
30816 \begin_layout Standard
30818 \change_deleted 564990737 1671097446
30821 Headnote, Dedication, Subtitle, Running_\SpecialChar LaTeX
30822 _Title, Author_Running, Institute,
30823 Mail, Offprints, Keywords, Acknowledgements, Acknowledgement
30826 See the Springer class file documentation for details.
30829 \begin_layout Standard
30831 \change_deleted 564990737 1671097446
30835 \begin_layout Itemize
30837 \change_deleted 564990737 1671097446
30849 \begin_layout Itemize
30851 \change_deleted 564990737 1671097446
30854 Probability Theory and Related Fields
30860 — Jean-Marc Lasgouttes
30863 \begin_layout Standard
30865 \change_deleted 564990737 1671097446
30866 Add your own, it isn't so hard!
30869 \begin_layout Standard
30871 \change_deleted 564990737 1671097446
30875 \begin_layout Standard
30877 \change_deleted 564990737 1671097446
30878 These files are partly based on the older
30882 , which was again based on a tinkered-with version of an old \SpecialChar LaTeX
30884 file from Springer.
30889 layout, are now defunct.
30890 Jean-Marc Lasgouttes helped out big in making me find my way around the
30892 layout file mechanism.
30895 \begin_layout Standard
30897 \change_deleted 564990737 1671097446
30901 \begin_layout Standard
30903 \change_deleted 564990737 1671097446
30905 But probably less than in the old hacked-\SpecialChar LaTeX
30913 \begin_layout Chapter
30915 Features needing Extra Software
30918 \begin_layout Section
30919 Checking \SpecialChar TeX
30923 \begin_layout Standard
30929 \begin_layout Subsection
30933 \begin_layout Standard
30942 \begin_layout Plain Layout
30947 is not yet available when you are using the \SpecialChar LaTeX
30948 distribution MiK\SpecialChar TeX
30954 , you'll find in the
30961 \begin_inset space ~
30972 \begin_inset Newline newline
30976 \begin_inset CommandInset href
30978 target "https://www.ctan.org/tex-archive/help/Catalogue/entries/chktex.html"
30986 \begin_layout Standard
30989 Chk\SpecialChar TeX
30992 package is a program that was written by
30993 \begin_inset Flex Noun
30996 \begin_layout Plain Layout
30998 \begin_inset space ~
31006 in frustration because some constructs in \SpecialChar LaTeX
31007 are sometimes non-intuitive,
31008 and easy to forget.
31009 The program runs over your \SpecialChar LaTeX
31010 file, checks the integrity of the file, and
31011 flags some common errors.
31012 In other technical words, it is
31016 for \SpecialChar LaTeX
31020 \begin_layout Standard
31021 Well, what is a syntax checker doing in \SpecialChar LyX
31022 which is supposed to produce correct
31024 anyways? The answer is simple: Just as
31028 not only checks the
31032 of C programs, but also does
31036 checks for type-errors,
31038 Chk\SpecialChar TeX
31041 catches some common
31045 errors, in addition to the syntactical ones.
31048 Chk\SpecialChar TeX
31051 is capable of detecting several common errors, such as
31054 \begin_layout Itemize
31055 Ellipsis detection:
31056 \begin_inset Newline newline
31059 Use \SpecialChar ldots
31063 \begin_layout Itemize
31064 No space in front of/after parenthesis:
31065 \begin_inset Newline newline
31071 \begin_layout Itemize
31072 Enforcement of normal space after common abbreviations:
31073 \begin_inset Newline newline
31077 \begin_inset space \thinspace{}
31081 \begin_inset space \space{}
31084 is too wide spacing.
31087 \begin_layout Itemize
31088 Enforcement of end-of-sentence space when the last sentence ends with a
31090 \begin_inset Newline newline
31094 And this is wrong spacing.
31097 \begin_layout Itemize
31098 Space in front of labels and similar commands:
31099 \begin_inset Newline newline
31102 The label should stick right up to the text to avoid falling to a wrong
31105 \begin_inset CommandInset label
31115 \begin_layout Plain Layout
31116 This footnote is in danger of falling off to a wrong page
31121 The label is separated too much.
31124 \begin_layout Itemize
31125 Space in front of references, instead of hard spaces:
31126 \begin_inset Newline newline
31129 If you have bad luck, the text will break right between the referenced text
31130 and reference number, and that's a pity.
31132 \begin_inset CommandInset ref
31134 reference "sec:chktex"
31141 \begin_layout Itemize
31143 \begin_inset Quotes eld
31147 \begin_inset Quotes erd
31151 \begin_inset Formula $\times$
31155 \begin_inset Newline newline
31158 2x2 looks cheap compared to
31159 \begin_inset Formula $2\times2$
31165 \begin_layout Standard
31166 and more \SpecialChar ldots
31167 It is an invaluable tool when you are
31168 \begin_inset Quotes eld
31172 \begin_inset Quotes erd
31175 your document before printing, and you should run it right after the obligatory
31176 spelling check, and before you go fine tuning the typesetting.
31179 \begin_layout Subsection
31183 \begin_layout Standard
31184 If you have the program installed, usage is as simple as choosing
31186 Tools\SpecialChar menuseparator
31188 \begin_inset space ~
31194 This will make \SpecialChar LyX
31195 generate a \SpecialChar LaTeX
31196 file of your document, start
31198 Chk\SpecialChar TeX
31201 to check it, and then make \SpecialChar LyX
31203 \begin_inset Quotes eld
31207 \begin_inset Quotes erd
31210 with the warnings from
31212 Chk\SpecialChar TeX
31215 , if there were any.
31216 The warnings will be placed close to the point of the mistake, and you
31217 can quickly find them by using the
31219 Navigate\SpecialChar menuseparator
31222 menu item, or the shortcut key
31231 Open the error boxes by clicking on them with the mouse, or use the shortcut
31240 bindings, or the corresponding
31249 Read the warning and correct the mistake, if it is a mistake.
31250 If you have trouble understanding what the warning is about, you can safely
31252 Remember that there is a hidden layer between the document on screen and
31253 the technical details in invoking
31255 Chk\SpecialChar TeX
31258 , and this gap can make some warnings seem arcane or just plain silly.
31261 \begin_layout Standard
31262 This document is an excellent testing bed for the feature, and it should
31263 provide quite a few warnings for you to fiddle with.
31264 Since computers are only so smart, expect most of the warnings to be false
31268 \begin_layout Subsection
31269 How to fine tune it
31272 \begin_layout Standard
31273 Sometimes, you'll find that
31275 Chk\SpecialChar TeX
31278 makes more noise than suits your mood.
31279 Then you can choose not to use it, wait until your mood changes, or try
31282 Chk\SpecialChar TeX
31285 to get better along with you.
31288 \begin_layout Standard
31291 Chk\SpecialChar TeX
31298 very configurable and extensible, you should not expect to solve all problems
31301 Chk\SpecialChar TeX
31304 in \SpecialChar LyX
31306 Since \SpecialChar LyX
31307 has to generate a somewhat special \SpecialChar LaTeX
31308 file to be able to match the
31309 line numbers from the
31311 Chk\SpecialChar TeX
31318 \begin_layout Plain Layout
31319 You can inspect the specific output from
31325 Document\SpecialChar menuseparator
31328 \begin_inset space ~
31342 to the internal document structure, some of the warnings will not appear
31344 There are two things you can do about this:
31347 \begin_layout Itemize
31350 Chk\SpecialChar TeX
31353 invocation command line in
31354 \begin_inset Flex Noun
31357 \begin_layout Plain Layout
31358 Tools\SpecialChar menuseparator
31359 Preferences\SpecialChar menuseparator
31360 Output\SpecialChar menuseparator
31361 LaTeX\SpecialChar menuseparator
31369 Chk\SpecialChar TeX
31372 installation configuration file (usually with the file
31377 See below to learn what warnings can be enabled and disabled on the command
31381 \begin_layout Itemize
31382 Export your document as a raw \SpecialChar LaTeX
31385 File\SpecialChar menuseparator
31386 Export\SpecialChar menuseparator
31395 Invoked in this way, it can be a hassle to find the corresponding place
31396 in the document inside \SpecialChar LyX
31397 , but with a little patience, you should be able
31401 \begin_layout Standard
31402 Here follows the warning messages that can be enabled and disabled in
31411 to disable a warning, and
31415 to enable a warning.
31416 The emphasized entries are disabled by default, because the default is
31419 chktex -n1 -n3 -n6 -n9 -n22 -n25 -n30 -n38
31424 \begin_layout Standard
31425 Notice that you should only use the options that enable and disable warnings,
31426 because \SpecialChar LyX
31427 relies on some of the other command line parameters to be set
31428 in a specific way to have a chance to communicate with
31435 \begin_layout Enumerate
31439 Command terminated with space.
31442 \begin_layout Enumerate
31445 Non-breaking space (
31446 \begin_inset Quotes eld
31454 \begin_inset Quotes erd
31457 ) should have been used.
31460 \begin_layout Enumerate
31464 You should enclose the previous parenthesis with
31465 \begin_inset Quotes eld
31473 \begin_inset Quotes erd
31479 \begin_layout Enumerate
31482 Italic correction (
31483 \begin_inset Quotes eld
31493 \begin_inset Quotes erd
31496 ) found in non-italic buffer.
31499 \begin_layout Enumerate
31502 Italic correction (
31503 \begin_inset Quotes eld
31513 \begin_inset Quotes erd
31516 ) found more than once.
31519 \begin_layout Enumerate
31523 No italic correction (
31524 \begin_inset Quotes eld
31534 \begin_inset Quotes erd
31540 \begin_layout Enumerate
31544 \begin_inset Quotes eld
31552 \begin_inset Quotes erd
31556 \begin_inset Quotes eld
31564 \begin_inset Quotes erd
31570 \begin_layout Enumerate
31573 Wrong length of dash may have been used.
31576 \begin_layout Enumerate
31580 \begin_inset Quotes eld
31588 \begin_inset Quotes erd
31592 \begin_inset Quotes eld
31600 \begin_inset Quotes erd
31606 \begin_layout Enumerate
31610 \begin_inset Quotes eld
31618 \begin_inset Quotes erd
31624 \begin_layout Enumerate
31628 \begin_inset Quotes eld
31636 \begin_inset Quotes erd
31639 to achieve an ellipsis.
31642 \begin_layout Enumerate
31645 Inter-word spacing (
31646 \begin_inset Quotes eld
31656 \begin_inset Quotes eld
31659 ) should perhaps be used.
31662 \begin_layout Enumerate
31665 Inter-sentence spacing (
31666 \begin_inset Quotes eld
31676 \begin_inset Quotes erd
31679 ) should perhaps be used.
31682 \begin_layout Enumerate
31685 Could not find argument for command.
31688 \begin_layout Enumerate
31692 \begin_inset Quotes eld
31700 \begin_inset Quotes erd
31706 \begin_layout Enumerate
31709 Math mode still on at end of \SpecialChar LaTeX
31713 \begin_layout Enumerate
31717 \begin_inset Quotes eld
31725 \begin_inset Quotes erd
31728 doesn't match the number of
31729 \begin_inset Quotes eld
31737 \begin_inset Quotes erd
31743 \begin_layout Enumerate
31746 You should use either
31749 \begin_inset Quotes eld
31757 \begin_inset Quotes erd
31762 as an alternative to
31763 \begin_inset Quotes eld
31771 \begin_inset Quotes erd
31777 \begin_layout Enumerate
31784 " (ASCII 39) instead of "
31791 \begin_layout Enumerate
31794 User-specified pattern found.
31797 \begin_layout Enumerate
31800 This command might not be intended.
31803 \begin_layout Enumerate
31810 \begin_layout Enumerate
31828 \begin_layout Enumerate
31831 Delete this space to maintain correct page references.
31834 \begin_layout Enumerate
31838 You might wish to put this between a pair of
31839 \begin_inset Quotes eld
31847 \begin_inset Quotes erd
31853 \begin_layout Enumerate
31856 You ought to remove spaces in front of punctuation.
31859 \begin_layout Enumerate
31862 Could not execute \SpecialChar LaTeX
31866 \begin_layout Enumerate
31875 in front of small punctuation.
31878 \begin_layout Enumerate
31886 may look prettier here.
31889 \begin_layout Enumerate
31893 Multiple spaces detected in output.
31896 \begin_layout Enumerate
31899 This text may be ignored.
31902 \begin_layout Enumerate
31908 \begin_inset Quotes eld
31913 to begin quotation, not
31920 \begin_layout Enumerate
31927 to end quotation, not
31930 \begin_inset Quotes eld
31938 \begin_layout Enumerate
31944 \begin_layout Enumerate
31947 You should perhaps use
31948 \begin_inset Quotes eld
31956 \begin_inset Quotes erd
31962 \begin_layout Enumerate
31965 You should put a space in front of/after parenthesis.
31968 \begin_layout Enumerate
31971 You should avoid spaces in front of/after parenthesis.
31974 \begin_layout Enumerate
31978 You should not use punctuation in front of/after quotes.
31981 \begin_layout Enumerate
31984 Double space found.
31987 \begin_layout Enumerate
31990 You should put punctuation outside inner/inside display math mode.
31993 \begin_layout Enumerate
31996 You ought to not use primitive \SpecialChar TeX
31997 in \SpecialChar LaTeX
32001 \begin_layout Enumerate
32004 You should remove spaces in front of
32005 \begin_inset Quotes eld
32013 \begin_inset Quotes erd
32019 \begin_layout Enumerate
32022 \begin_inset Quotes eld
32030 \begin_inset Quotes erd
32033 is normally not followed by
32034 \begin_inset Quotes eld
32042 \begin_inset Quotes erd
32048 \begin_layout Standard
32049 In later versions of \SpecialChar LyX
32050 , we hope to provide a more complete interface to this
32051 tool (and it's smaller cousin
32055 ) to exploit the full power of it.
32056 But it's not exactly useless as it is now: go try it on one of your existing
32057 documents of a certain length and be surprised.
32060 \begin_layout Section
32061 Version Control in \SpecialChar LyX
32065 \begin_layout Standard
32068 Lars Gullik Bjønnes
32075 \begin_layout Subsection
32079 \begin_layout Standard
32081 supports some of the most basic RCS/CVS/SVN/GIT commands.
32082 If you need something a bit more sophisticated you will have to do that
32083 manually in a terminal.
32086 \begin_layout Standard
32087 Also note that CVS support is not as good as subversion support, so we advise
32089 A good place to start learning Subversion is the SVN Book
32093 \begin_layout Plain Layout
32094 \begin_inset CommandInset href
32096 target "http://svnbook.red-bean.com/"
32107 In the case of RCS you should read
32108 \begin_inset Quotes eld
32112 \begin_inset Quotes erd
32115 (a man file, read it with
32120 This file describes all the basic features of RCS.
32121 You should especially notice the comment about a RCS directory, and the
32122 notion of a master RCS file (the file ending in
32129 \begin_layout Standard
32130 Before you begin to use the version control features in \SpecialChar LyX
32132 familiar with RCS/CVS/SVN/GIT usage.
32133 The implementation in \SpecialChar LyX
32134 assumes a recent version of the GNU RCS or CVS/SVN
32135 package — no guarantees are made for older versions.
32136 Most of the log messages are not currently displayed after operations —
32137 you can check them in the Messages pane if you are unsure.
32138 Regular users of version control will appreciate the VC toolbar, which
32141 View\SpecialChar menuseparator
32142 Toolbars\SpecialChar menuseparator
32144 \begin_inset space ~
32152 \begin_layout Standard
32153 For introducing your own external commands consult
32154 \begin_inset Flex Code
32157 \begin_layout Plain Layout
32171 \begin_layout Standard
32172 It is strongly recommended to store documents in uncompressed format if
32173 using version control (uncheck
32175 Document\SpecialChar menuseparator
32178 if it is checked): Uncompressed LyX documents are text files and therefore
32179 for merging two different versions by version control systems.
32180 Compressed LyX documents are binary files, which cannot be merged by version
32184 \begin_layout Subsection
32185 RCS commands in \SpecialChar LyX
32189 \begin_layout Standard
32190 The following sections describe the RCS commands supported by \SpecialChar LyX
32192 You can find them in the
32194 File\SpecialChar menuseparator
32196 \begin_inset space ~
32203 was tested against RCS 5.7/5.8.
32206 \begin_layout Subsubsection
32212 \begin_layout Standard
32213 If your document is not under revision control, this is the only item shown
32215 And if it is under revision control, the
32219 item is not visible.
32223 \begin_layout Standard
32224 This command registers your document with RCS (unless you are under the
32225 directory managed by CVS)\SpecialChar endofsentence
32226 You are asked interactively to supply an initial
32227 description of the document.
32228 The document is now set in Read-Only mode and you have to
32231 \begin_inset space ~
32235 \begin_inset space ~
32239 \begin_inset space ~
32244 , before making any changes to it.
32245 A document under revision control has a
32246 \begin_inset Quotes eld
32249 [RCS:<version> <locker>]
32250 \begin_inset Quotes erd
32253 item tagged to the filename in the minibuffer.
32256 \begin_layout Standard
32257 RCS command that is run:
32260 \begin_layout LyX-Code
32263 ci -q -u -i -t-"<initial description>" <file-name>
32266 \begin_layout Standard
32271 to understand the switches.
32275 \begin_layout Subsubsection
32281 \begin_layout Standard
32282 When you are finished editing a file, you check in your changes.
32283 When you do this, you are asked for a description of the changes.
32284 This is stored in the history log.
32285 The version number is bumped, your changes are applied to the master RCS
32286 file, the document is unlocked and set to Read-Only mode.
32289 \begin_layout Itemize
32292 ci -q -u -m"<description>" <file-name>
32295 \begin_layout Subsubsection
32301 \begin_layout Standard
32302 By doing this you lock the document so that only you can edit it.
32303 This will also make the document Read-Write only for you.
32304 You will usually continue editing for a while and when you are finished
32305 you check in your changes.
32306 The status line is changed to reflect that you have locked the file.
32309 \begin_layout Itemize
32312 co -q -l <file-name>
32315 \begin_layout Subsubsection
32318 Revert To Repository Version
32321 \begin_layout Standard
32322 This will discard all changes made to the document since the last check
32324 You get a warning before changes are discarded.
32327 \begin_layout Itemize
32330 co -f -u<version> <file-name>
32333 \begin_layout Subsubsection
32339 \begin_layout Standard
32340 This will create a copy of the current document.
32341 Since RCS does not support copy operations natively, the version history
32342 is not preserved, and the copy is added as a new file.
32343 It requires a clean document without any changes since the last checkin.
32344 You are asked for a file name and a description of the copy operation.
32345 After that the copy is created, both locally and in the repository.
32346 If the parent directories of the copied and original document differ, all
32347 relative paths of included files of the copy are adjusted (like in
32349 File\SpecialChar menuseparator
32354 Finally, the copy is loaded instead of the original document.
32357 \begin_layout Labeling
32358 \labelwidthstring 00.00.0000
32360 \begin_inset space ~
32364 \begin_inset space ~
32368 \begin_inset Newline newline
32372 \begin_inset Flex Code
32375 \begin_layout Plain Layout
32378 \begin_inset Quotes qld
32382 \begin_inset Quotes qld
32391 \begin_inset Flex Code
32394 \begin_layout Plain Layout
32397 \begin_inset Quotes qld
32401 \begin_inset Quotes qld
32410 \begin_inset Newline newline
32414 \begin_inset Flex Code
32417 \begin_layout Plain Layout
32421 \begin_inset Quotes qld
32425 \begin_inset Quotes qld
32436 \begin_layout Subsubsection
32442 \begin_layout Standard
32443 This makes as if the last check in never happened.
32444 No changes are made to the document loaded into \SpecialChar LyX
32445 , but the last version
32446 is removed from the master RCS file.
32449 \begin_layout Itemize
32452 rcs -o<version> <file-name>
32455 \begin_layout Subsubsection
32461 \begin_layout Standard
32462 This shows the complete history of the RCS document.
32467 is shown in a browser.
32475 \begin_layout Subsubsection
32479 \begin_layout Standard
32481 supports RCS version number, author name, date and time of last commit.
32482 All those are extracted from
32484 rlog -r <file-name>
32488 \begin_inset CommandInset ref
32490 reference "subsec:VCS-Revision-Information"
32497 \begin_layout Subsection
32498 CVS commands in \SpecialChar LyX
32502 \begin_layout Standard
32503 A subset of CVS operations is supported by \SpecialChar LyX
32505 You can find the commands in the
32507 File\SpecialChar menuseparator
32509 \begin_inset space ~
32515 The version control system SVN is more powerful, so please use it instead
32516 of CVS if possible.
32519 \begin_layout Subsubsection
32525 \begin_layout Standard
32526 If you start from scratch with CVS you have to create your repository and
32527 checkout the working copy with external tools.
32528 If you're using a client-server setup you may need to login before doing
32529 the first repository checkout.
32532 \begin_layout Standard
32533 If your documents are under revision control and others are using the same
32534 repository problems arise when different changes to the same document at
32535 the same location happen.
32536 Standard CVS repositories don't operate with a file locking mechanism.
32537 This may be surprising, but conflicts only occur if people disagree on
32538 the proper content of the same part of a document.
32539 So, if co-workers are used to communicate regularly, these conflicts occur
32541 If they don't communicate they have a fundamental problem anyway.
32542 Nevertheless some people like to work with so called
32543 \begin_inset Quotes eld
32547 \begin_inset Quotes erd
32551 If they do so the working copy of all files is readonly when checked out
32552 first and the user starts editing after using a special command to make
32553 the working copy writable.
32554 When the changes are checked in the working copy returns to readonly state.
32555 With \SpecialChar LyX
32556 one has to edit the
32557 \begin_inset Flex Code
32560 \begin_layout Plain Layout
32566 file and add the line
32567 \begin_inset Flex Code
32570 \begin_layout Plain Layout
32576 to work with reserved checkouts.
32577 The benefit is the possibility to see who is using a writable copy of some
32579 It's not guaranteed only one user makes a copy writable.
32582 \begin_layout Standard
32584 tries to guess if you're using reserved or non-reserved checkouts.
32585 If your working copy is readonly or it is writable and an additional copy
32586 of your document exists in the CVS/Base sub-directory a reserved otherwise
32587 a non-reserved checkout is assumed.
32588 When a reserved checkout is detected you have to use
32589 \begin_inset Flex Noun
32592 \begin_layout Plain Layout
32598 to make your working copy writable if it's readonly.
32600 \begin_inset Flex Noun
32603 \begin_layout Plain Layout
32609 operation is possible and that makes your working copy readonly again after
32610 transferring your changes to the repository.
32613 \begin_layout Standard
32614 More information about CVS can be found here
32615 \begin_inset Flex URL
32618 \begin_layout Plain Layout
32620 http://www.nongnu.org/cvs
32626 \begin_inset Flex URL
32629 \begin_layout Plain Layout
32631 http://ximbiot.com/cvs
32639 \begin_layout Standard
32644 to understand the sub-commands and the switches mentioned below.
32647 \begin_layout Subsubsection
32653 \begin_layout Standard
32654 If your document is not under revision control, this is the only item shown
32656 And if it is under revision control, the
32660 item is not visible.
32664 \begin_layout Standard
32665 This command registers in CVS your document
32666 \begin_inset Flex Strong
32669 \begin_layout Plain Layout
32677 in the case you have already the documents directory under CVS control
32683 This means you have to create or checkout the archive by yourself using
32685 (In case you forget that step \SpecialChar LyX
32686 registers the document with RCS.)
32689 \begin_layout Standard
32690 Then you are asked interactively to supply an initial description of the
32692 Don't forget that registered file is not yet checked in.
32695 \begin_layout Standard
32696 CVS command that is run:
32698 cvs -q add -m"<entered message>" "<file-name>"
32701 \begin_layout Standard
32706 above and for all other CVS commands is an abbreviation for
32707 \begin_inset Quotes eld
32710 change the current working directory to file location and use the file name
32711 without path component as argument
32712 \begin_inset Quotes erd
32718 \begin_layout Subsubsection
32724 \begin_layout Standard
32725 When you are finished editing a file, you commit your changes.
32726 When you do this and you had changed the document, you are asked for a
32727 description of the changes.
32728 After that changes are written to the repository.
32729 In case you didn't change the document and a reserved checkout is detected
32730 the reservation made on
32731 \begin_inset Flex Noun
32734 \begin_layout Plain Layout
32743 \begin_layout Labeling
32744 \labelwidthstring 00.00.0000
32746 \begin_inset space ~
32750 \begin_inset space ~
32754 \begin_inset Newline newline
32758 \begin_inset Flex Code
32761 \begin_layout Plain Layout
32764 -q commit -m"<description>" "<file-name>"
32770 \begin_inset Newline newline
32774 \begin_inset Flex Code
32777 \begin_layout Plain Layout
32788 \begin_layout Subsubsection
32794 \begin_layout Standard
32795 When you are sharing a repository with others, you may have to incorporate
32796 their changes into your working copy.
32799 \begin_layout Standard
32802 cvs -q update "<file-name>"
32805 \begin_layout Standard
32806 If a readonly checkout is detected the working copy is made writable and
32810 \begin_layout Standard
32813 cvs -q edit "<file-name>"
32816 \begin_layout Subsubsection
32819 Revert To Repository Version
32822 \begin_layout Standard
32823 This will discard all changes made to the document since the last check
32825 You get a warning before changes are discarded.
32826 Firstly the file is deleted, secondly CVS update command is run.
32829 \begin_layout Standard
32832 cvs -q update "<file-name>"
32835 \begin_layout Standard
32836 If a reserved checkout is detected and the working copy has no changes only
32837 the reservation is undone.
32840 \begin_layout Standard
32843 cvs -q unedit "<file-name>"
32846 \begin_layout Subsubsection
32852 \begin_layout Standard
32853 This will create a copy of the current document.
32854 Since CVS does not support copy operations natively, the version history
32855 is not preserved, and the copy is added as a new file.
32856 It requires a clean document without any changes since the last checkin.
32857 You are asked for a file name and a description of the copy operation.
32858 After that the copy is created, both locally and in the repository.
32859 If the parent directories of the copied and original document differ, all
32860 relative paths of included files of the copy are adjusted (like in
32862 File\SpecialChar menuseparator
32867 Finally, the copy is loaded instead of the original document.
32870 \begin_layout Labeling
32871 \labelwidthstring 00.00.0000
32873 \begin_inset space ~
32877 \begin_inset space ~
32881 \begin_inset Newline newline
32885 \begin_inset Flex Code
32888 \begin_layout Plain Layout
32895 \begin_inset Flex Code
32898 \begin_layout Plain Layout
32905 \begin_inset Newline newline
32909 \begin_inset Flex Code
32912 \begin_layout Plain Layout
32913 cvs -q add "<new-file-name>"
32921 \begin_layout Subsubsection
32927 \begin_layout Standard
32928 This will rename the current document.
32929 Since CVS does not support rename operations natively, the version history
32930 is not preserved, the renamed document is added as a new file, and the
32931 original document is deleted.
32932 It requires a clean document without any changes since the last checkin.
32933 You are asked for a file name and a description of the rename operation.
32934 After that the document is renamed, both locally and in the repository.
32935 If the parent directories of the new and old file names differ, all relative
32936 paths of included files are adjusted (like in
32938 File\SpecialChar menuseparator
32943 Finally, the document is reloaded using the new name.
32946 \begin_layout Labeling
32947 \labelwidthstring 00.00.0000
32949 \begin_inset space ~
32953 \begin_inset space ~
32957 \begin_inset Newline newline
32961 \begin_inset Flex Code
32964 \begin_layout Plain Layout
32971 \begin_inset Flex Code
32974 \begin_layout Plain Layout
32981 \begin_inset Newline newline
32985 \begin_inset Flex Code
32988 \begin_layout Plain Layout
32989 cvs -q add "<new-file-name>"
32995 \begin_inset Newline newline
32999 \begin_inset Flex Code
33002 \begin_layout Plain Layout
33003 cvs -q remove "<file-name>"
33011 \begin_layout Subsubsection
33012 Update of the local directory checkout from repository
33015 \begin_layout Standard
33016 Once your documents gets more complex, containing sub-documents and pictures,
33018 \begin_inset Flex Code
33021 \begin_layout Plain Layout
33027 files and so on using version control becomes more complicated.
33029 supports updating the whole tree in which resides the document.
33030 This become especially useful once you cooperate with people which neither
33031 have detailed knowledge about CVS usage nor they have ambition to commit
33032 additional material to the repository.
33033 You have to organize the files structure so that all external files are
33034 in the same directory or subdirectories of the document.
33035 It's good practice anyway to store multipart documents in an extra directory.
33038 \begin_layout Standard
33040 \begin_inset Flex Code
33043 \begin_layout Plain Layout
33044 Update local directory from repository
33049 command updates the whole directory.
33050 If local changes are detected user is warned before update starts.
33051 In case of merge conflicts both versions of the conflicting document parts
33052 are placed in the final document.
33053 You have to review and correct the result of the merge.
33054 You'll find the conflicts enclosed in pairs of
33055 \begin_inset Flex Code
33058 \begin_layout Plain Layout
33065 \begin_inset Flex Code
33068 \begin_layout Plain Layout
33075 \begin_inset Flex Code
33078 \begin_layout Plain Layout
33085 The first part is your version as before the update operation with the
33086 document name prepended.
33087 The second one is the repository version with the version number after
33089 \begin_inset Flex Code
33092 \begin_layout Plain Layout
33101 \begin_layout Labeling
33102 \labelwidthstring 00.00.0000
33104 \begin_inset space ~
33108 \begin_inset space ~
33112 \begin_inset Newline newline
33116 \begin_inset Flex Code
33119 \begin_layout Plain Layout
33127 (Ask if changes are detected.)
33128 \begin_inset Newline newline
33132 \begin_inset Flex Code
33135 \begin_layout Plain Layout
33136 cd $path; cvs -q update
33146 \begin_layout Standard
33148 \begin_inset Flex Code
33151 \begin_layout Plain Layout
33157 stands for the path to the document.
33160 \begin_layout Subsubsection
33166 \begin_layout Standard
33167 This shows the complete history of the CVS document.
33170 cvs log "<file-name>"
33172 is shown in a browser.
33175 \begin_layout Subsubsection
33179 \begin_layout Standard
33181 supports CVS version number, author name, date and time of last commit.
33182 All those are extracted from
33184 cvs log -r <file-name>
33188 \begin_inset CommandInset ref
33190 reference "subsec:VCS-Revision-Information"
33197 \begin_layout Subsection
33198 SVN commands in \SpecialChar LyX
33202 \begin_layout Standard
33203 SVN is now partially supported by \SpecialChar LyX
33205 You can find the commands in the
33207 File\SpecialChar menuseparator
33209 \begin_inset space ~
33215 Please note that if you use password protected access to repository via
33216 ssh, you will be asked in terminal window.
33218 was tested against SVN 1.5, 1.6, 1.7 and 1.8
33222 \begin_layout Plain Layout
33223 Most of the commands will work with 1.4 too, see
33224 \begin_inset CommandInset ref
33226 reference "subsec:SVN-Repo-Update"
33231 There seems to be currently unresolved permissions problem under SVN 1.8
33232 with reverting changes when file is locked.
33240 \begin_layout Subsubsection
33246 \begin_layout Standard
33247 If your document is not under revision control, this is the only item shown
33249 And if it is under revision control, the
33253 item is not visible.
33256 \begin_layout Standard
33257 This command registers in SVN your document ONLY in case you have already
33258 the documents directory under SVN control (in particular
33263 This means you have to checkout the archive by yourself.
33266 \begin_layout Standard
33267 Then you are asked interactively to supply an initial description of the
33269 Don't forget that registered file is not yet commited.
33272 \begin_layout Standard
33273 SVN command that is run:
33276 \begin_inset Quotes qld
33280 \begin_inset Quotes qld
33286 \begin_layout Standard
33291 to understand the switches.
33294 \begin_layout Subsubsection
33300 \begin_layout Standard
33301 When you are finished editing a file, you commit your changes.
33302 When you do this, you are asked for a description of the changes.
33303 After that changes are commited.
33306 \begin_layout Standard
33311 \begin_layout Plain Layout
33312 In case locking is not enabled.
33314 \begin_inset CommandInset ref
33316 reference "subsec:SVN-File-Locking"
33327 svn commit -q -m"<description>" <file-name>
33330 \begin_layout Subsubsection
33336 \begin_layout Standard
33337 Updates the changes of this file from the repository.
33338 Be sure you understand SVN merging and conflicts resolving before using
33339 this function, because all conflicts has to be resolved manually by you!
33342 \begin_layout Standard
33347 \begin_layout Plain Layout
33355 svn update --non-interactive
33356 \begin_inset Quotes qld
33360 \begin_inset Quotes qld
33366 \begin_layout Subsubsection
33369 Revert To Repository Version
33372 \begin_layout Standard
33373 This will discard all changes made to the document since the last check
33375 You get a warning before changes are discarded.
33378 \begin_layout Standard
33382 \begin_inset Quotes qld
33386 \begin_inset Quotes qld
33392 \begin_layout Subsubsection
33398 \begin_layout Standard
33399 This will create a copy of the current document including the version history.
33400 It requires a clean document without any changes since the last checkin.
33401 You are asked for a file name and a description of the copy operation.
33402 After that the copy is created, both locally and in the repository.
33403 If the parent directories of the copied and original document differ, all
33404 relative paths of included files of the copy are adjusted (like in
33406 File\SpecialChar menuseparator
33411 Finally, the copy is loaded instead of the original document.
33414 \begin_layout Labeling
33415 \labelwidthstring 00.00.0000
33417 \begin_inset space ~
33421 \begin_inset space ~
33425 \begin_inset Newline newline
33429 \begin_inset Flex Code
33432 \begin_layout Plain Layout
33436 \begin_inset Quotes qld
33440 \begin_inset Quotes qld
33444 \begin_inset Quotes qld
33448 \begin_inset Quotes qld
33457 \begin_inset Newline newline
33461 \begin_inset Flex Code
33464 \begin_layout Plain Layout
33473 \begin_layout Subsubsection
33479 \begin_layout Standard
33480 This will rename the current document including the version history.
33481 It requires a clean document without any changes since the last checkin.
33482 You are asked for a file name and a description of the rename operation.
33483 After that the document is renamed, both locally and in the repository.
33484 If the parent directories of the new and old file names differ, all relative
33485 paths of included files are adjusted (like in
33487 File\SpecialChar menuseparator
33492 Finally, the document is reloaded using the new name.
33495 \begin_layout Labeling
33496 \labelwidthstring 00.00.0000
33498 \begin_inset space ~
33502 \begin_inset space ~
33506 \begin_inset Newline newline
33510 \begin_inset Flex Code
33513 \begin_layout Plain Layout
33517 \begin_inset Quotes qld
33521 \begin_inset Quotes qld
33525 \begin_inset Quotes qld
33529 \begin_inset Quotes qld
33538 \begin_inset Newline newline
33542 \begin_inset Flex Code
33545 \begin_layout Plain Layout
33554 \begin_layout Subsubsection
33555 \begin_inset CommandInset label
33557 name "subsec:SVN-Repo-Update"
33561 Update of the local directory checkout from repository
33565 \begin_layout Plain Layout
33566 Note that this command will work only with subversion
33567 \begin_inset Formula $\geqq1.5$
33578 \begin_layout Standard
33579 All the commands above have one shortcoming – they deal with the current
33581 Once your document contains pictures, includes external
33582 \begin_inset Flex Code
33585 \begin_layout Plain Layout
33591 files and so on administration becomes more complicated.
33593 now supports updating the whole tree in which resides the document
33597 \begin_layout Plain Layout
33598 One need to organize the files structure so that all external files are
33599 in the same directory or subdirectories of the document.
33606 This become especially useful once you cooperate with people which neither
33607 know about subversion management nor they have ambition to commit additional
33608 material to the repository.
33612 \begin_layout Standard
33613 \begin_inset Flex Code
33616 \begin_layout Plain Layout
33617 Update local directory from repository
33622 command updates the whole directory and in case of merge conflicts local
33623 version of the files are left, so no unintended data loss occurs.
33624 If local changes are detected user is warned before update starts.
33627 \begin_layout Labeling
33628 \labelwidthstring 00.00.0000
33630 \begin_inset space ~
33634 \begin_inset space ~
33638 \begin_inset Newline newline
33642 \begin_inset Flex Code
33645 \begin_layout Plain Layout
33651 (Ask if changes are detected.)
33652 \begin_inset Newline newline
33656 \begin_inset Flex Code
33659 \begin_layout Plain Layout
33660 svn update --accept mine-full $path
33668 \begin_layout Standard
33670 \begin_inset Flex Code
33673 \begin_layout Plain Layout
33679 stands for the path to the document.
33682 \begin_layout Subsubsection
33688 \begin_layout Standard
33689 This shows the complete history of the SVN document.
33693 \begin_inset Quotes qld
33697 \begin_inset Quotes qld
33702 is shown in a browser.
33705 \begin_layout Subsubsection
33707 \begin_inset CommandInset label
33709 name "subsec:SVN-File-Locking"
33716 \begin_layout Standard
33717 The file exchange through various revision control systems brings the problem
33718 of merge conflicts in case two different users try to edit the same (parts
33720 When such a conflict happens it needs manual resolving and one reasonable
33721 alternative is to provide some kind of locking mechanism, which guarantees
33722 that only one user is allowed to edit file at the given time.
33725 \begin_layout Standard
33726 SVN has two such mechanisms to provide mutual exclusivity for file access
33727 – locks and automatic setting of write permissions (see sec.
33729 \begin_inset CommandInset ref
33731 reference "subsec:Automatical-Locking-Property"
33736 \begin_inset Flex Code
33739 \begin_layout Plain Layout
33749 \begin_layout Plain Layout
33750 \begin_inset Flex URL
33753 \begin_layout Plain Layout
33755 http://svnbook.red-bean.com/en/1.2/svn.advanced.locking.html
33766 If this property is detected for a given document \SpecialChar LyX
33767 starts to use SVN locks
33768 for document editing automatically and the whole check-in/out mechanism
33769 switches to the same regimen as for RCS.
33770 This in particular means there are two different modes of file use in \SpecialChar LyX
33774 \begin_layout Itemize
33776 The loaded file is in the read-only mode.
33777 For editing on needs to check-out.
33782 consists of updating from the repository and gaining write lock.
33783 If the lock is not possible to obtain, we remain in unlocked state.
33786 \begin_layout Itemize
33788 The loaded file is in the
33789 \begin_inset Quotes els
33793 \begin_inset Quotes ers
33797 No other user is allowed to edit the file.
33802 consists of commiting changes and releasing write-lock.
33803 If no changes have been made to the document, no commit will be produced
33807 \begin_layout Plain Layout
33808 Don't be puzzled by the fact that you will be asked for commit message anyway.
33813 and only the write-lock will be released.
33816 \begin_layout Standard
33820 \begin_layout Labeling
33821 \labelwidthstring 00.00.0000
33824 svn commit -q -m"<description>" "<file-name>"
33825 \begin_inset Newline newline
33828 svn unlock "<file-name>"
33831 \begin_layout Labeling
33832 \labelwidthstring 00.00.0000
33835 svn update "<file-name>"
33836 \begin_inset Newline newline
33839 svn lock "<file-name>"
33842 \begin_layout Subsubsection
33845 \begin_inset CommandInset label
33847 name "subsec:Automatical-Locking-Property"
33853 Automatic Locking Property
33856 \begin_layout Standard
33857 The above mentioned automatic setting of write permissions of the .lyx file
33860 File\SpecialChar menuseparator
33862 \begin_inset space ~
33865 Control\SpecialChar menuseparator
33866 Use Locking Property
33869 This command is active only when the file is not locked on the svn server
33871 you need to check-out before proceeding).
33874 \begin_layout Labeling
33875 \labelwidthstring 00.00.0000
33877 \begin_inset space ~
33883 \begin_layout Labeling
33884 \labelwidthstring 00.00.0000
33887 svn propset svn:needs-lock ON "<file-name>"
33890 \begin_layout Labeling
33891 \labelwidthstring 00.00.0000
33894 svn propdel svn:needs-lock "<file-name>"
33897 \begin_layout Subsubsection
33898 \begin_inset CommandInset label
33900 name "subsec:VCS-Revision-Information"
33904 Revision Information in Documents
33907 \begin_layout Standard
33908 There are more possibilities how to activate revision information in our
33912 \begin_layout Itemize
33918 \begin_layout Itemize
33919 tree revision information (
33920 \begin_inset Flex Code
33923 \begin_layout Plain Layout
33930 The result is the output of the
33931 \begin_inset Flex Code
33934 \begin_layout Plain Layout
33940 command, the following table gives you an idea, how to read the results.
33943 \begin_layout Standard
33945 \begin_inset Tabular
33946 <lyxtabular version="3" rows="6" columns="2">
33947 <features tabularvalignment="middle">
33948 <column alignment="left" valignment="top">
33949 <column alignment="left" valignment="top">
33951 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
33954 \begin_layout Plain Layout
33962 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
33965 \begin_layout Plain Layout
33975 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
33978 \begin_layout Plain Layout
33984 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
33987 \begin_layout Plain Layout
33988 mixed revision working copy
33995 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
33998 \begin_layout Plain Layout
34004 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
34007 \begin_layout Plain Layout
34008 modified working copy
34015 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
34018 \begin_layout Plain Layout
34024 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
34027 \begin_layout Plain Layout
34028 switched working copy
34035 <cell alignment="left" valignment="top" topline="true" leftline="true" usebox="none">
34038 \begin_layout Plain Layout
34044 <cell alignment="left" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
34047 \begin_layout Plain Layout
34048 partial working copy, from a sparse checkout
34055 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" usebox="none">
34058 \begin_layout Plain Layout
34064 <cell alignment="left" valignment="top" topline="true" bottomline="true" leftline="true" rightline="true" usebox="none">
34067 \begin_layout Plain Layout
34068 mixed revision, modified, switched working copy
34081 \begin_layout Itemize
34082 file revision information.
34083 The result comes from parsing the output of
34084 \begin_inset Flex Code
34087 \begin_layout Plain Layout
34089 \begin_inset space ~
34093 \begin_inset space ~
34097 \begin_inset space ~
34106 Supported flags are:
34110 \begin_layout Itemize
34111 version number of the last commit (
34112 \begin_inset Flex Code
34115 \begin_layout Plain Layout
34124 \begin_layout Itemize
34125 author of the last commit (
34126 \begin_inset Flex Code
34129 \begin_layout Plain Layout
34138 \begin_layout Itemize
34139 date of the last commit (
34140 \begin_inset Flex Code
34143 \begin_layout Plain Layout
34152 \begin_layout Itemize
34153 time of the last commit (
34154 \begin_inset Flex Code
34157 \begin_layout Plain Layout
34167 \begin_layout Standard
34168 You can obtain this info via InsetInfo (
34169 \change_inserted 5863208 1564400022
34172 Insert\SpecialChar menuseparator
34173 Field\SpecialChar menuseparator
34174 Version Control Revision
34175 \change_deleted 5863208 1564399852
34180 \begin_inset Flex Code
34183 \begin_layout Plain Layout
34184 info-insert buffer vcs-date
34192 The information will be available only when you have the file stored under
34193 svn managment (i.e.
34195 \begin_inset Flex Code
34198 \begin_layout Plain Layout
34204 directory is available with your document).
34208 \begin_layout Itemize
34209 Another—a hacking one—possibility is to use svn keywords
34213 \begin_layout Plain Layout
34214 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.special.keywords.html
34220 In short – you set file keywords property (e.g.
34223 svn propset svn:keywords 'Rev' file.lyx
34225 ) and then paste keyword \SpecialChar TeX
34230 \begin_layout Plain Layout
34231 This is an easy way how to ensure that \SpecialChar LyX
34232 won't break the line in the middle
34238 tag in your document (e.g.
34240 \begin_inset Flex Code
34243 \begin_layout Plain Layout
34250 This way svn client will automatically substitute revision number (e.g.
34252 \begin_inset Flex Code
34255 \begin_layout Plain Layout
34261 ) after each update and commit.
34262 There are more problems with this approach.
34263 Firstly, the '$' character is used in \SpecialChar TeX
34264 world for math equations, so any
34265 occurence of math formula
34266 \begin_inset Formula $Rev$
34270 \begin_inset Formula $Rev:59$
34273 in your \SpecialChar LyX
34275 Similarly for other keywords like Id, Date, Author, etc.
34276 Secondly svn output is dependent on your locales, so its very easy that
34277 svn would produce some problematic strings once Date is used.
34278 Thirdly you get the whole 'Rev: 59' string in your document instead of
34280 Until subversion implements user's custom keywords it will be hard to use
34281 this approach reliably or let \SpecialChar LyX
34282 to support it directly.
34285 \begin_layout Subsection
34286 SVN and Windows Environment
34289 \begin_layout Quote
34290 My inclination is to say that if the user cannot figure out the command
34291 line operations on their own fairly quickly, they would be well advised
34292 to use TortoiseSVN.
34298 \begin_layout Subsubsection
34302 \begin_layout Standard
34303 In addition to installing \SpecialChar LyX
34304 , and having access to a Subversion repository,
34305 the user will need to install the Subversion client program.
34306 A Windows installer for the client program is available from
34307 \begin_inset CommandInset href
34310 target "http://www.collab.net/nonav/downloads/subversion/"
34316 The user may also want to install
34317 \begin_inset CommandInset href
34320 target "http://tortoisesvn.tigris.org/"
34325 , which integrates Subversion operations into the context (rightclick) menu
34326 of Windows Explorer.
34327 Operations done outside \SpecialChar LyX
34328 will typically be more convenient using the Explorer
34330 Note that TortoiseSVN is not a replacement for the client program, which
34331 is what \SpecialChar LyX
34335 \begin_layout Subsubsection
34336 Bringing a document under Subversion control
34339 \begin_layout Standard
34340 Before a \SpecialChar LyX
34341 document can be brought under version control in Subversion, its
34342 parent directory needs to be under version control.
34343 If the document is being added to a project already in the repository,
34344 this is accomplished by checking the project out to the directory where
34345 the new document will be placed.
34346 If the project itself is not yet under version control (for instance, if
34347 this document starts a new project), the directory must be imported into
34349 This is done outside \SpecialChar LyX
34351 Both import and checkout are easily accomplished from the Explorer context
34352 menu using TortoiseSVN, or alternatively can be done using the command
34353 line client at a DOS prompt.
34354 The procedure for importing the project using TortoiseSVN is described
34355 below, assuming an existing repository and a new project being started
34363 For information on using the Subversion client program, run
34370 \begin_layout Enumerate
34377 in Windows Explorer, right click it, and select
34379 TortoiseSVN\SpecialChar menuseparator
34383 If necessary, adjust the URL for the repository, then click OK.
34386 \begin_layout Enumerate
34387 Right click the level of the repository under which you want to place the
34388 new project folder (typically the top level) and click
34392 Supply a name for the project folder and click OK.
34393 Add a message for the log file if desired, then click OK again.
34394 The new project folder should appear in the repository.
34395 Finally, click OK again to exit the repository browser.
34398 \begin_layout Enumerate
34399 Once again right click
34405 , this time selecting SVN Checkout\SpecialChar ldots
34406 Select the URL of the project folder
34407 you just created in the repository, and set the checkout directory to
34415 You will be warned about a non-empty folder; click OK to proceed.
34416 You should now have a
34427 \begin_layout Enumerate
34428 Create or open your document in \SpecialChar LyX
34431 File\SpecialChar menuseparator
34433 \begin_inset space ~
34436 Control\SpecialChar menuseparator
34440 Add a log message and click OK to commit the document to version control.
34443 \begin_layout Standard
34444 From this point onward, you should have full functionality in the
34446 File\SpecialChar menuseparator
34448 \begin_inset space ~
34454 You also have the option of checking the document in and out, viewing its
34456 using the TortoiseSVN context menu in Windows Explorer or the Subversion
34457 client program from a command prompt.
34460 \begin_layout Subsubsection
34461 SSH tunnel used with SVN under Windows
34464 \begin_layout Standard
34465 Compared with Linux setting up an svn client to communicate over ssh under
34466 Windows is a rather troublesome task.
34467 We will at least offer some hints how to setup the client side but prior
34468 knowledge about ssh and the Windows command line is needed, also be prepared
34469 for a great deal of frustration\SpecialChar ldots
34473 \begin_layout Enumerate
34474 Get an svn client for windows, as described in the previous sections.
34475 When it is a fresh install run some svn command (e.g.
34477 \begin_inset Flex Code
34480 \begin_layout Plain Layout
34486 ) to create config files, which you will need to change later on.
34489 \begin_layout Enumerate
34490 Choose an ssh client for Windows.
34491 There are several possibilities, we will use the one from Putty tools
34495 \begin_layout Plain Layout
34496 \begin_inset Flex URL
34499 \begin_layout Plain Layout
34501 http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html
34512 You will need to set the connection up so that the client doesn't ask for
34513 any password from you.
34514 To keep things easy we will use only keys without any additional password
34519 \begin_layout Enumerate
34521 \begin_inset Flex Code
34524 \begin_layout Plain Layout
34531 Save your private .ppk key file and put the public one on the server side.
34532 If the SVN server runs on Linux, note that the format of the public key
34533 is not compatible with Linux openssh and you will need to direcly copy-paste
34535 \begin_inset Quotes eld
34540 Public key for pasting into OpenSSH authorized_keys file
34543 \begin_inset Quotes erd
34546 edit field into the server's
34547 \begin_inset Flex Code
34550 \begin_layout Plain Layout
34551 ~/.ssh/authorized_keys
34557 \begin_inset Flex Code
34560 \begin_layout Plain Layout
34569 \begin_layout Enumerate
34571 \begin_inset Flex Code
34574 \begin_layout Plain Layout
34581 In the SVN config file
34585 \begin_layout Plain Layout
34586 Exact path depends on Windows version, usually somewhere around
34587 \begin_inset Flex Code
34590 \begin_layout Plain Layout
34593 Documents and Settings
34607 \begin_inset Flex Code
34610 \begin_layout Plain Layout
34625 , section [tunnels], setup ssh command, e.g.
34627 \begin_inset Flex Code
34630 \begin_layout Plain Layout
34631 ssh=c:/path/plink.exe -i c:/path/private_key.ppk
34640 \begin_layout Plain Layout
34641 It will usually take a lot of time to get exact command right and it depends
34643 For example do not have some remote server saved as a default session in
34645 If things fail, try to connect via plink without SVN first.
34654 \begin_layout Enumerate
34655 Checkout the SVN archive, e.
34656 \begin_inset space \thinspace{}
34660 \begin_inset Newline newline
34664 \begin_inset Flex Code
34667 \begin_layout Plain Layout
34668 svn co svn+ssh://user@server/repository_path
34676 \begin_layout Subsubsection
34677 End-of-Line Conversions
34680 \begin_layout Standard
34681 When the collaborators are mixing Linux and Windows environments, \SpecialChar LyX
34683 use different line endings inside the .lyx files.
34684 This is not a problem as far as \SpecialChar LyX
34685 functionality is concerned, but the commit
34686 diffs will be huge and merge-conflicts prone.
34687 Fortunately SVN itself knows
34691 \begin_layout Plain Layout
34692 \begin_inset Flex URL
34695 \begin_layout Plain Layout
34697 http://svnbook.red-bean.com/en/1.4/svn.advanced.props.file-portability.html
34707 how to deal with CR/LF problems when switching .lyx files to the
34708 \begin_inset Flex Code
34711 \begin_layout Plain Layout
34721 \begin_layout Plain Layout
34723 \begin_inset Flex Code
34726 \begin_layout Plain Layout
34727 svn propset svn:eol-style native FILE_NAME
34740 \begin_layout Subsection
34741 GIT commands in \SpecialChar LyX
34745 \begin_layout Standard
34746 A minimal subset of GIT commands is now supported by \SpecialChar LyX
34748 You can find the commands in the
34750 File\SpecialChar menuseparator
34752 \begin_inset space ~
34758 Please note that if you use password protected access to repository via
34759 ssh, you will be asked in terminal window.
34761 was tested against GIT 1.7.
34765 \begin_layout Plain Layout
34766 Windows users please note that you need to ensure that git is on the path.
34767 This can be set from within \SpecialChar LyX
34770 Tools\SpecialChar menuseparator
34771 Preferences\SpecialChar menuseparator
34772 Paths\SpecialChar menuseparator
34783 \begin_layout Standard
34784 One big difference of GIT and the other supported version control systems
34785 is the distributed nature of GIT: With traditional version control systems
34786 there is one central server which hosts the repository.
34787 Users commit their changes to the server, and get updates made by other
34789 With GIT, users commit to a local repository.
34790 The local repository can be synchronized with one or more remote repositories
34792 \begin_inset Flex Code
34795 \begin_layout Plain Layout
34802 \begin_inset Flex Code
34805 \begin_layout Plain Layout
34813 does not interact in any way with remote GIT repositories.
34814 It works exclusively with the local repository in a very similar way as
34815 with a central CVS or SVN repository.
34816 If you use remote GIT repositories you need to do the
34817 \begin_inset Flex Code
34820 \begin_layout Plain Layout
34827 \begin_inset Flex Code
34830 \begin_layout Plain Layout
34836 operations with your favourite GIT client.
34839 \begin_layout Subsubsection
34845 \begin_layout Standard
34846 If your document is not under revision control, this is the only item shown
34848 And if it is under revision control, the
34852 item is not visible.
34855 \begin_layout Standard
34856 This command registers in GIT your document ONLY in case you have already
34857 the documents directory under GIT control (in particular
34862 This means you have to checkout the archive by yourself.
34865 \begin_layout Standard
34866 Then you are asked interactively to supply an initial description of the
34868 Don't forget that registered file is not yet committed.
34871 \begin_layout Standard
34872 GIT command that is run:
34875 \begin_inset Quotes qld
34879 \begin_inset Quotes qld
34885 \begin_layout Standard
34890 to understand the switches.
34893 \begin_layout Subsubsection
34899 \begin_layout Standard
34900 When you are finished editing a file, you commit your changes.
34901 When you do this, you are asked for a description of the changes.
34902 After that changes are committed.
34905 \begin_layout Standard
34908 git commit -q -m"<description>" <file-name>
34911 \begin_layout Subsubsection
34914 Revert To Repository Version
34917 \begin_layout Standard
34918 This will discard all changes made to the document since the last check
34920 You get a warning before changes are discarded.
34923 \begin_layout Standard
34927 \begin_inset Quotes qld
34931 \begin_inset Quotes qld
34937 \begin_layout Subsubsection
34943 \begin_layout Standard
34944 This will rename the current document including the version history.
34945 It requires a clean document without any changes since the last checkin.
34946 You are asked for a file name and a description of the rename operation.
34947 After that the document is renamed, both locally and in the repository.
34948 If the parent directories of the new and old file names differ, all relative
34949 paths of included files are adjusted (like in
34951 File\SpecialChar menuseparator
34956 Finally, the document is reloaded using the new name.
34959 \begin_layout Labeling
34960 \labelwidthstring 00.00.0000
34962 \begin_inset space ~
34966 \begin_inset space ~
34970 \begin_inset Newline newline
34974 \begin_inset Flex Code
34977 \begin_layout Plain Layout
34981 \begin_inset Quotes qld
34985 \begin_inset Quotes qld
34989 \begin_inset Quotes qld
34993 \begin_inset Quotes qld
35002 \begin_inset Newline newline
35006 \begin_inset Flex Code
35009 \begin_layout Plain Layout
35018 \begin_layout Subsubsection
35024 \begin_layout Standard
35025 This shows the complete history of the GIT document.
35029 \begin_inset Quotes qld
35033 \begin_inset Quotes qld
35038 is shown in a browser.
35041 \begin_layout Subsubsection
35045 \begin_layout Standard
35047 supports GIT hash number of the last commit to the file,
35048 \change_inserted 1119979965 1564297456
35049 its abbreviated form,
35051 author name, date and time of last commit.
35052 All those are extracted from
35054 git log -n 1 --pretty=format:%H%n
35055 \change_inserted 1119979965 1564297427
35061 Tree version information is obtained via
35063 git describe --abbrev --dirty --long
35067 \begin_inset CommandInset ref
35069 reference "subsec:VCS-Revision-Information"
35076 \begin_layout Subsection
35080 \begin_layout Standard
35081 With the recent addition of the
35082 \begin_inset Flex Code
35085 \begin_layout Plain Layout
35091 function \SpecialChar LyX
35092 power users are allowed to create their own commands for revision
35096 \begin_layout Standard
35097 As an example you can see how two TortoiseSVN commands could be integrated
35101 \begin_layout Description
35103 \begin_inset Flex Code
35106 \begin_layout Plain Layout
35107 vc-command DR "." "TortoiseProc /command:commit /path:$$p"
35115 \begin_layout Description
35117 \begin_inset Flex Code
35120 \begin_layout Plain Layout
35121 vc-command DR "." "TortoiseProc /command:revert /path:$$p"
35129 \begin_layout Subsection
35130 Version control and Document comparison
35133 \begin_layout Standard
35134 One of the typical uses of version control is to inspect the changes between
35135 revisions, usually by creating
35136 \begin_inset Flex Code
35139 \begin_layout Plain Layout
35146 While this is useful for plain text files, it is much less useful in the
35147 case of \SpecialChar LyX
35148 files, which have more a complicated structure.
35149 Hence we provide binding to the Document comparison feature.
35150 There are two ways of calling this feature – either by direct call of
35151 \begin_inset Flex Code
35154 \begin_layout Plain Layout
35161 function (for details see \SpecialChar LyX
35162 functions manual) or by the toolbar icon
35175 One can either compare two chosen revisions of the document or he can simply
35176 compare the current version of edited text with older revisions (where
35178 \begin_inset Flex Noun
35181 \begin_layout Plain Layout
35187 ' revisions back means comparison of the edited file with last commited
35192 \begin_layout Standard
35193 This feature is supported for SVN and RCS though due to the more complicated
35194 versioning scheme of RCS there is a constraint – when addressing the revisions
35195 in dialog, numbers always point to the last number in RCS revision number,
35198 We don't currently support GIT addressing of revisions, one can just compare
35199 edited document with its revision X steps backs, where X is addressed as
35201 \begin_inset Flex Code
35204 \begin_layout Plain Layout
35213 \begin_layout Section
35215 \change_inserted 564990737 1672161575
35216 \begin_inset CommandInset label
35218 name "sec:Literate-Programming"
35224 Literate Programming
35227 \begin_layout Standard
35232 (kayvan@sylvan.com)
35236 original documentation written by
35238 Edmar Wienskoski Jr.
35241 (edmar-w-jr@technologist.com)
35244 \begin_layout Subsection
35248 \begin_layout Standard
35249 The main purpose of this documentation is to show you how to use \SpecialChar LyX
35251 programming, where it is assumed that you are familiar with this programming
35252 technique, and know what
35253 \begin_inset Quotes eld
35257 \begin_inset Quotes erd
35261 \begin_inset Quotes eld
35265 \begin_inset Quotes erd
35269 If that is not the case, please follow the web links provided in the following
35271 There is a lot of good documentation out there covering old development
35272 history to the latest tools tips.
35275 \begin_layout Standard
35276 It is also assumed that you are familiar with \SpecialChar LyX
35277 itself to a point that you
35278 are comfortable changing your \SpecialChar LyX
35279 preferences, and X resources file.
35280 If that is not the case please refer to other \SpecialChar LyX
35281 documentation to cover your
35285 \begin_layout Subsection
35286 Literate Programming
35289 \begin_layout Standard
35290 From the Literate Programming FAQ:
35293 \begin_layout Quotation
35294 Literate programming is the combination of documentation and source together
35295 in a fashion suited for reading by human beings.
35296 In fact, literate programs should be enjoyable reading, even inviting!
35297 (Sorry Bob, I couldn't resist!) In general, literate programs combine source
35298 and documentation in a single file.
35299 Literate programming tools then parse the file to produce either readable
35300 documentation or compilable source.
35301 The WEB style of literate programming was created by D.
35302 \begin_inset space \thinspace{}
35306 Knuth during the development of his \SpecialChar TeX
35307 typesetting software.
35311 \begin_layout Standard
35312 Another excerpt says:
35315 \begin_layout Quotation
35318 How is literate programming different from verbose commenting?
35321 \begin_layout Quotation
35322 There are three distinguishing characteristics.
35323 In order of importance, they are:
35327 \begin_layout Itemize
35328 flexible order of elaboration
35331 \begin_layout Itemize
35332 automatic support for browsing
35335 \begin_layout Itemize
35336 typeset documentation, especially diagrams and mathematics
35340 \begin_layout Standard
35341 Now that I sparked your curiosity, take a look in the references.
35344 \begin_layout Subsubsection
35348 \begin_layout Standard
35349 The complete Literate Programming FAQ can be found at:
35352 \begin_layout Quote
35353 Literate Programming FAQ
35354 \begin_inset Flex URL
35357 \begin_layout Plain Layout
35359 http://www.literateprogramming.com/lpfaq.pdf
35367 \begin_layout Standard
35368 The FAQ lists 23 (twenty three!) different literate programming tools.
35369 Where some are specialized or
35370 \begin_inset Quotes eld
35374 \begin_inset Quotes erd
35377 for particular programming languages, while other have general scope.
35382 for my own use for several reasons:
35385 \begin_layout Itemize
35386 It can generate the documentation either in \SpecialChar LaTeX
35390 \begin_layout Itemize
35391 It has a open architecture, i.
35392 \begin_inset space \thinspace{}
35396 \begin_inset space \space{}
35399 it is easy to plug in new filters
35403 \begin_layout Plain Layout
35408 are programs that read a given data stream and output a manipulated data
35410 That way, a WEB file (consisting of literate code) can be turned into a
35411 file consisting only of C program code or \SpecialChar LaTeX
35417 and to perform special processing that you may need.
35421 \begin_layout Itemize
35422 There is a good selection of filters available already (the HTML is one
35426 \begin_layout Itemize
35430 \begin_layout Standard
35431 The Noweb web page can be found at:
35434 \begin_layout Quote
35436 \begin_inset Flex URL
35439 \begin_layout Plain Layout
35441 https://www.cs.tufts.edu/~nr/noweb/
35449 \begin_layout Standard
35450 Starting from there you can reach many other interesting links and even
35451 some literate program examples.
35454 \begin_layout Subsection
35456 and Literate Programming with Noweb
35459 \begin_layout Standard
35460 The \SpecialChar LyX
35461 support for Literate Programming is provided by using the generic \SpecialChar LyX
35463 converters mechanism.
35464 This support is provided in a
35465 \begin_inset Quotes eld
35469 \begin_inset Quotes erd
35473 \begin_inset space \thinspace{}
35477 \begin_inset space \space{}
35480 you will be able to use this new \SpecialChar LyX
35481 feature with some other literate programming
35482 tool of your choice by just changing your \SpecialChar LyX
35486 \begin_layout Subsubsection
35487 Generating documents and code (weaving and tangling)
35490 \begin_layout Paragraph
35491 Using the noweb module
35494 \begin_layout Standard
35495 If you have installed Noweb and \SpecialChar LyX
35496 successfully, whenever you open a new document,
35497 after you have chosen its document class, use the
35499 Document\SpecialChar menuseparator
35503 \begin_inset Quotes eld
35507 \begin_inset Quotes erd
35511 If Noweb is correctly installed, when you click on the
35512 \begin_inset Quotes eld
35516 \begin_inset Quotes erd
35519 link, you will see the
35520 \begin_inset Quotes eld
35524 \begin_inset Quotes erd
35527 module in the available list and you can add it to your document.
35530 \begin_layout Paragraph
35534 \begin_layout Standard
35536 enables you to write code with a custom inset named
35537 \begin_inset Flex Noun
35540 \begin_layout Plain Layout
35547 Noweb delimits chunks like this:
35550 \begin_layout LyX-Code
35554 \begin_layout LyX-Code
35558 \begin_layout LyX-Code
35562 \begin_layout LyX-Code
35566 \begin_layout LyX-Code
35570 \begin_layout Standard
35571 The problem is that whatever is written in between the << and the
35575 must be taken literally, i.
35576 \begin_inset space \thinspace{}
35580 \begin_inset space \space{}
35584 should be prevented from making any special interpretation of what has
35586 This is also handled by
35587 \begin_inset Flex Noun
35590 \begin_layout Plain Layout
35596 , that works like a normal text inset but has a free spacing capability.
35599 \begin_layout Standard
35600 As a special note, you can also use the
35601 \begin_inset Quotes eld
35605 \begin_inset Quotes erd
35608 construct of Noweb in your chunks to add items to Noweb's identifier cross-refe
35612 \begin_layout LyX-Code
35616 \begin_layout LyX-Code
35617 def some_function(args):
35620 \begin_layout LyX-Code
35621 "This is the doc string for this function."
35624 \begin_layout LyX-Code
35625 print "My args: ", args
35628 \begin_layout LyX-Code
35629 @ %def some_function
35632 \begin_layout Standard
35633 For an example of this usage and the resulting cross-reference output, look
35634 at the Literate python program in
35636 LIBDIR/examples/listerrors.lyx
35638 which should make this all clear.
35641 \begin_layout Paragraph
35642 Generating the documentation
35645 \begin_layout Standard
35646 At this point you already have a new document file with a proper document
35647 class, and with some code and text on it.
35648 How do I print it? The answer is simple, you select
35650 View\SpecialChar menuseparator
35654 Just like you would do for a plain document.
35655 No special procedure is required.
35658 \begin_layout Standard
35659 To help orientate you, I will now explain what happens inside \SpecialChar LyX
35663 \begin_layout Enumerate
35666 Update\SpecialChar menuseparator
35669 menu option is chosen, a \SpecialChar LaTeX
35675 \begin_layout Standard
35676 If the document is of any literate class the generated file will be named
35677 with an extension name defined by the
35678 \begin_inset Quotes eld
35682 \begin_inset Quotes erd
35685 format (defined in the Preferences panel), otherwise the file will have
35694 \begin_layout Enumerate
35695 Note that the only difference so far is in the name of the file, no special
35696 processing is required by \SpecialChar LyX
35698 Given that you formatted the code using the
35699 \begin_inset Flex Noun
35702 \begin_layout Plain Layout
35708 inset that, by itself, takes care of the business.
35711 \begin_layout Enumerate
35712 If the document is of any literate class \SpecialChar LyX
35713 will then use the internal \SpecialChar LyX
35715 Noweb converter, followed by the Noweb to \SpecialChar LaTeX
35720 \begin_layout Plain Layout
35721 The converters are defined in the
35723 Tools\SpecialChar menuseparator
35727 \begin_inset Quotes eld
35731 \begin_inset Quotes erd
35743 manual for general information about converters.
35748 to generate the \SpecialChar LaTeX
35753 \begin_layout Standard
35754 Otherwise it will just skip this step.
35758 \begin_layout Enumerate
35759 Finally, \SpecialChar LaTeX
35760 is invoked and the regular post processing continues as in a plain
35764 \begin_layout Standard
35765 Independence from a particular
35766 \begin_inset Quotes eld
35770 \begin_inset Quotes erd
35773 is easily achieved by changing the commands that are run by the various
35777 \begin_layout Paragraph
35778 Generating the code
35781 \begin_layout Standard
35782 When the build menu option is chosen or the corresponding button in the
35783 toolbar is pressed, a \SpecialChar LaTeX
35784 file is generated just like step 1 above.
35785 Next, \SpecialChar LyX
35791 This converter needs to be defined by the user and is not installed by
35792 default, though the Program format is.
35793 This converter (like any other converter) will have two parts:
35796 \begin_layout Enumerate
35797 The converter program itself.
35798 This program performs the conversion from the one format to the other (in
35799 this case, from the Noweb format to the Program pseudo-format).
35802 \begin_layout Enumerate
35803 The error log parser.
35804 This is a program whose sole purpose is to rewrite error messages in a
35805 format that \SpecialChar LyX
35807 This makes it possible for \SpecialChar LyX
35808 to place error boxes in the right places in
35812 \begin_layout Standard
35813 The first part, the
35814 \begin_inset Quotes eld
35818 \begin_inset Quotes erd
35821 setting, should be set to
35824 \begin_layout LyX-Code
35832 \begin_layout Standard
35833 This basically means that \SpecialChar LyX
35835 \begin_inset Quotes eld
35839 \begin_inset Quotes erd
35842 (a program or script) with the name of the Noweb file (normally a file
35843 in the \SpecialChar LyX
35844 temp directory) and the directory path of the original \SpecialChar LyX
35849 \begin_layout Standard
35850 This is an implementation of
35851 \begin_inset Quotes eld
35855 \begin_inset Quotes erd
35858 that you can place in a directory on your path:
35861 \begin_layout LyX-Code
35867 \begin_layout LyX-Code
35873 \begin_layout LyX-Code
35876 notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$2 sh
35879 \begin_layout Standard
35880 The next part of the converter setting is the
35881 \begin_inset Quotes eld
35885 \begin_inset Quotes erd
35888 which is to be set to
35891 \begin_layout LyX-Code
35894 parselog=$$s/scripts/listerrors
35897 \begin_layout Standard
35898 This will run any errors that are generated by the
35899 \begin_inset Quotes eld
35903 \begin_inset Quotes erd
35906 process through the
35907 \begin_inset Quotes eld
35911 \begin_inset Quotes erd
35917 \begin_layout Standard
35918 The build will normally take place in \SpecialChar LyX
35919 's temporary directory, so the files
35920 produced by the conversion will be in that directory.
35922 will copy out what it regards as the `main' file, but the
35926 conversion may produce several files, and so most of these would then be
35927 deleted when \SpecialChar LyX
35929 This is why we pass in the NOWEB_OUTPUT_DIR environment variable so that
35930 the build-script chunk can place the generated files in that location.
35933 \begin_layout Paragraph
35934 Build instructions in the document
35937 \begin_layout Standard
35938 The last piece of the integration between \SpecialChar LyX
35940 \begin_inset Quotes eld
35944 \begin_inset Quotes erd
35948 Generally, the instructions for building your program should be embedded
35949 in a chunk of its own.
35951 \begin_inset Quotes eld
35955 \begin_inset Quotes erd
35958 above uses the notangle command to look for this chunk (called
35959 \begin_inset Quotes eld
35963 \begin_inset Quotes erd
35966 ) and runs its contents through
35967 \begin_inset Quotes eld
35971 \begin_inset Quotes erd
35977 \begin_layout Standard
35978 Typically, such a chunk would look something like this:
35981 \begin_layout LyX-Code
35985 \begin_layout LyX-Code
35987 \begin_inset Newline newline
35990 if [ -z "${NOWEB_SOURCE}" ]
35991 \begin_inset Newline newline
35997 \begin_layout LyX-Code
35998 NOWEB_SOURCE=myfile.nw
35999 \begin_inset Newline newline
36003 \begin_inset Newline newline
36007 code to extract files ...
36008 use NOWEB_OUTPUT_DIR here ...]
36009 \begin_inset Newline newline
36013 code to compile files ...]
36014 \begin_inset Newline newline
36020 \begin_layout Standard
36022 \change_deleted 564990737 1672161716
36025 LIBDIR/examples/listerrors.lyx
36029 LIBDIR/examples/Literate.lyx
36030 \change_inserted 564990737 1672161716
36035 File\SpecialChar menuseparator
36036 Open Example\SpecialChar menuseparator
36037 Modules\SpecialChar menuseparator
36044 \change_deleted 564990737 1672161729
36048 \begin_inset Quotes eld
36052 \begin_inset Quotes erd
36055 program for some illustrations of how all of these pieces go together or
36057 \change_deleted 564990737 1672161756
36060 LIBDIR/examples/noweb2lyx.lyx
36061 \change_inserted 564990737 1672161756
36066 File\SpecialChar menuseparator
36067 Open Example\SpecialChar menuseparator
36068 Modules\SpecialChar menuseparator
36069 Noweb2\SpecialChar LyX
36079 Interestingly, these
36080 \change_deleted 564990737 1672161767
36083 files show off the language-indepence of the \SpecialChar LyX
36084 literate programming support
36085 since they are written in Python
36086 \change_deleted 564990737 1672161782
36089 and Perl respectively.
36092 \begin_layout Subsubsection
36093 Configuring \SpecialChar LyX
36097 \begin_layout Standard
36098 All the Literate Programming support is configured by the
36100 Tools\SpecialChar menuseparator
36104 \begin_inset Quotes eld
36108 \begin_inset Quotes erd
36112 The important parts are:
36115 \begin_layout Description
36117 \begin_inset space ~
36121 \begin_inset Quotes eld
36125 \begin_inset Quotes erd
36129 \begin_inset space ~
36132 format Set up via the File Formats tab, this is where the Noweb-specific
36142 , the file extension is set to
36147 This tells \SpecialChar LyX
36148 to create a file with a
36152 extension in the first step of the conversion process.
36155 \begin_layout Description
36157 \begin_inset space ~
36165 \begin_inset space ~
36168 format This is an empty format whose sole purpose is to be the endpoint
36169 of a conversion (which then allows us to set up a converter for it).
36172 \begin_layout Description
36182 This converter performs the
36183 \begin_inset Quotes eld
36187 \begin_inset Quotes erd
36190 of the literate document.
36191 For Noweb, it is set to
36192 \begin_inset Quotes eld
36197 noweave -delay -index $$i > $$o
36200 \begin_inset Quotes erd
36206 \begin_layout Description
36216 \begin_inset Quotes eld
36220 \begin_inset Quotes erd
36224 As stated above, the Converter is set to
36225 \begin_inset Quotes eld
36233 \begin_inset Quotes erd
36236 , with Flags set to
36237 \begin_inset Newline newline
36241 \begin_inset Quotes eld
36246 parselog=$$s/scripts/listerrors
36249 \begin_inset Quotes erd
36255 \begin_layout Subsubsection
36259 \begin_layout Standard
36260 There is also a new function implemented in the \SpecialChar LyX
36262 \begin_inset Quotes eld
36265 server-goto-file-row" function, to be used with ddd/gdb or other debugger.
36269 \begin_layout Standard
36270 When debugging code with ddd/gdb, it is possible to invoke a text editor
36271 at the current execution position with a single key stroke.
36272 The default ddd configuration for that is shift-ctrl-V.
36273 It happens that you can define the editor command line invocation in ddd
36276 Edit\SpecialChar menuseparator
36277 Preferences\SpecialChar menuseparator
36280 dialog and changing the "Edit Sources" entry.
36283 \begin_layout Standard
36284 I take advantage of the newly created \SpecialChar LyX
36285 server function and this ddd feature,
36287 \begin_inset Quotes eld
36291 \begin_inset Quotes erd
36297 \begin_layout LyX-Code
36298 echo "LYXCMD:monitor:server-goto-file-row:@FILE@ @LINE@" >~/.lyxpipe.in
36301 \begin_layout Standard
36302 With this, whenever you are using ddd and find a point in the program that
36303 you want to edit, you just press shift-ctrl-V (in the ddd window), and
36304 ddd will forward this information to \SpecialChar LyX
36305 through the \SpecialChar LyX
36306 server and then the
36308 window will show the same file with the cursor at the same position ddd
36310 No more guessing or long scrolling to locate a point in the program back
36314 \begin_layout Standard
36315 Note however that you must enable the \SpecialChar LyX
36316 server to get this feature working
36317 (it is disabled by default).
36319 \begin_inset space ~
36323 \begin_inset CommandInset ref
36325 reference "sec:Starting-the-Server"
36329 explains how to do that.
36332 \begin_layout Subsubsection
36336 \begin_layout Standard
36337 There are six new buttons that can be added to your \SpecialChar LyX
36339 Four of these buttons are short cuts to layout styles:
36357 , one for the custom inset
36362 The last one is a short cut to the
36363 \begin_inset Quotes eld
36367 \begin_inset Quotes erd
36374 \begin_layout Standard
36376 has a range of buttons that are available for tool bar customization.
36377 In my toolbar I like to combine the six short cuts above with two more:
36382 \SpecialChar menuseparator
36387 \SpecialChar menuseparator
36394 Document\SpecialChar menuseparator
36395 View\SpecialChar menuseparator
36399 Here is how it looks like:
36402 \begin_layout LyX-Code
36406 \begin_layout LyX-Code
36410 \begin_layout LyX-Code
36411 Icon "layout Standard"
36414 \begin_layout LyX-Code
36415 Icon "layout Section"
36418 \begin_layout LyX-Code
36419 Icon "layout \SpecialChar LaTeX
36423 \begin_layout LyX-Code
36424 Icon "layout \SpecialChar LyX
36428 \begin_layout LyX-Code
36429 Icon "flex.insert Chunk"
36432 \begin_layout LyX-Code
36436 \begin_layout LyX-Code
36440 \begin_layout LyX-Code
36441 Icon "buffer-typeset"
36444 \begin_layout LyX-Code
36445 Icon "build-program"
36448 \begin_layout LyX-Code
36452 \begin_layout LyX-Code
36456 \begin_layout LyX-Code
36460 \begin_layout LyX-Code
36464 \begin_layout LyX-Code
36468 \begin_layout Subsubsection
36469 Colors customization
36472 \begin_layout Standard
36473 There are a number of colors in \SpecialChar LyX
36474 that can be customized in
36479 One of the things that bothers people is the \SpecialChar LaTeX
36481 The default color is red, since the chunks uses \SpecialChar LaTeX
36482 font, and there is a lot
36483 of chunks in literate documents, you may get tired of seeing everything
36485 You can change it by going to the tabs
36494 \begin_layout Standard
36495 The next thing is the visible presence of the newline character in the screen.
36496 You can choose the color of this particular character and make it blend
36498 I recommend you choosing a color that is close to the background but not
36499 equal, that way you still can see it is there, but it is not bothering
36503 \begin_layout Subsection
36508 \begin_layout Standard
36518 \change_inserted 564990737 1672161863
36522 Help\SpecialChar menuseparator
36523 Specific Manuals\SpecialChar menuseparator
36531 \change_deleted 564990737 1671643409
36537 \change_inserted 564990737 1672161856
36541 File\SpecialChar menuseparator
36542 Open Example\SpecialChar menuseparator
36543 Modules\SpecialChar menuseparator
36550 \change_deleted 564990737 1671643461
36551 the Sweave manual (menu
36553 Help\SpecialChar menuseparator
36557 \change_inserted 564990737 1672161856
36561 Help\SpecialChar menuseparator
36562 Specific Manuals\SpecialChar menuseparator
36564 \change_deleted 564990737 1672161921
36570 \change_inserted 564990737 1672161917
36574 File\SpecialChar menuseparator
36575 Open Example\SpecialChar menuseparator
36576 Modules\SpecialChar menuseparator
36580 \change_deleted 564990737 1672742969
36584 \begin_layout Standard
36586 \change_deleted 564990737 1671355343
36590 \begin_layout Standard
36592 \change_deleted 564990737 1671355343
36593 You can do everything with \SpecialChar LyX
36594 that you can do with \SpecialChar LaTeX
36596 However, \SpecialChar LyX
36597 cannot support every \SpecialChar LaTeX
36599 But you can always use \SpecialChar TeX
36601 This chapter shows you some more special things you might want to use.
36602 For other special things you can do with figures, tables, floats, boxes
36603 and notes, have a look at the
36606 \begin_inset space ~